Merge pull request #2185 from hey-api/refactor/plugin-api

+10 -10

docs/openapi-ts/plugins/custom.md

··· 59 59 Reserved fields are prefixed with an underscore and are not exposed to the user. 60 60 ::: 61 61 62 - `config.ts` contains the runtime configuration for your plugin. It must implement the `Config` interface we created above and define `_handler()` and `_handlerLegacy()` functions from the `Plugin.Config` interface. 62 + `config.ts` contains the runtime configuration for your plugin. It must implement the `Config` interface we created above and define `handler()` and `handlerLegacy()` functions from the `Plugin.Config` interface. 63 63 64 64 ::: code-group 65 65 ··· 70 70 import type { Config } from './types'; 71 71 72 72 export const defaultConfig: Plugin.Config<Config> = { 73 - _dependencies: ['@hey-api/typescript'], 74 - _handler: handler, 75 - _handlerLegacy: () => {}, 76 73 config: { 77 74 myOption: false, // implements default value from types 78 75 }, 76 + dependencies: ['@hey-api/typescript'], 77 + handler, 78 + handlerLegacy: () => {}, 79 79 name: 'my-plugin', 80 80 output: 'my-plugin', 81 81 }; ··· 101 101 102 102 ## Handler 103 103 104 - Notice we defined `_handler` in our `config.ts` file. This method is responsible for generating the actual output. We recommend implementing it in `plugin.ts`. 104 + Notice we defined `handler` in our `config.ts` file. This method is responsible for generating the actual output. We recommend implementing it in `plugin.ts`. 105 105 106 106 ::: code-group 107 107 ··· 118 118 path: plugin.output, 119 119 }); 120 120 121 - context.subscribe('before', () => { 121 + plugin.subscribe('before', () => { 122 122 // do something before parsing the input 123 123 }); 124 124 125 - context.subscribe('operation', ({ operation }) => { 125 + plugin.subscribe('operation', ({ operation }) => { 126 126 // do something with the operation model 127 127 }); 128 128 129 - context.subscribe('schema', ({ operation }) => { 129 + plugin.subscribe('schema', ({ operation }) => { 130 130 // do something with the schema model 131 131 }); 132 132 133 - context.subscribe('after', () => { 133 + plugin.subscribe('after', () => { 134 134 // do something after parsing the input 135 135 }); 136 136 ··· 159 159 160 160 ### Legacy 161 161 162 - Notice we defined `_handlerLegacy` in our `config.ts` file. This method is responsible for generating the actual output when using the legacy parser. We do not recommend implementing this method unless you must use the legacy parser. You can use one of our [`plugin-legacy.ts`](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/%40hey-api/typescript/plugin-legacy.ts) files as an inspiration for potential implementation. 162 + Notice we defined `handlerLegacy` in our `config.ts` file. This method is responsible for generating the actual output when using the legacy parser. We do not recommend implementing this method unless you must use the legacy parser. You can use one of our [`plugin-legacy.ts`](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/%40hey-api/typescript/plugin-legacy.ts) files as an inspiration for potential implementation. 163 163 164 164 ## Usage 165 165

+2 -2

packages/custom-client/src/plugin.ts

··· 16 16 17 17 export const defaultConfig: Plugin.Config<Config> = { 18 18 ...clientDefaultMeta, 19 - _handler: clientPluginHandler, 20 - _handlerLegacy: () => {}, 21 19 config: { 22 20 ...clientDefaultConfig, 23 21 bundle: false, 24 22 }, 23 + handler: clientPluginHandler, 24 + handlerLegacy: () => {}, 25 25 name: '@hey-api/custom-client', 26 26 }; 27 27

+1 -1

packages/openapi-ts-tests/test/__snapshots__/3.1.x/clients/my-client/base-url-false/client/plugin.ts