Merge pull request #2180 from hey-api/refactor/plugin-config

refactor: namespace plugin configs

Author: mrlubos

docs/openapi-ts/plugins/custom.md

@@ -73,7 +73,9 @@ export const defaultConfig: Plugin.Config<Config> = {
   _dependencies: ['@hey-api/typescript'],
   _handler: handler,
   _handlerLegacy: () => {},
-  myOption: false, // implements default value from types
+  config: {
+    myOption: false, // implements default value from types
+  },
   name: 'my-plugin',
   output: 'my-plugin',
 };

packages/custom-client/src/plugin.ts

@@ -1,7 +1,9 @@
 import {
   type Client,
   clientDefaultConfig,
+  clientDefaultMeta,
   clientPluginHandler,
+  definePluginConfig,
   type Plugin,
 } from '@hey-api/openapi-ts';
 
@@ -13,17 +15,17 @@ export interface Config extends Client.Config {
 }
 
 export const defaultConfig: Plugin.Config<Config> = {
-  ...clientDefaultConfig,
+  ...clientDefaultMeta,
   _handler: clientPluginHandler,
   _handlerLegacy: () => {},
-  bundle: false,
+  config: {
+    ...clientDefaultConfig,
+    bundle: false,
+  },
   name: '@hey-api/custom-client',
 };
 
 /**
  * Type helper for `@hey-api/custom-client` plugin, returns {@link Plugin.Config} object
  */
-export const customClientPlugin: Plugin.DefineConfig<Config> = (config) => ({
-  ...defaultConfig,
-  ...config,
-});
+export const customClientPlugin = definePluginConfig(defaultConfig);

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

@@ -1,7 +1,9 @@
 import {
   type Client,
   clientDefaultConfig,
+  clientDefaultMeta,
   clientPluginHandler,
+  definePluginConfig,
   type Plugin,
 } from '@hey-api/openapi-ts';
 
@@ -13,16 +15,13 @@ export interface Config extends Client.Config {
 }
 
 export const defaultConfig: Plugin.Config<Config> = {
-  ...clientDefaultConfig,
+  ...clientDefaultMeta,
   _handler: clientPluginHandler,
-  _handlerLegacy: () => {},
+  config: clientDefaultConfig,
   name: __filename,
 };
 
 /**
  * Type helper for `my-client` plugin, returns {@link Plugin.Config} object
  */
-export const myClientPlugin: Plugin.DefineConfig<Config> = (config) => ({
-  ...defaultConfig,
-  ...config,
-});
+export const myClientPlugin = definePluginConfig(defaultConfig);

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

@@ -1,7 +1,9 @@
 import {
   type Client,
   clientDefaultConfig,
+  clientDefaultMeta,
   clientPluginHandler,
+  definePluginConfig,
   type Plugin,
 } from '@hey-api/openapi-ts';
 
@@ -13,16 +15,13 @@ export interface Config extends Client.Config {
 }
 
 export const defaultConfig: Plugin.Config<Config> = {
-  ...clientDefaultConfig,
+  ...clientDefaultMeta,
   _handler: clientPluginHandler,
-  _handlerLegacy: () => {},
+  config: clientDefaultConfig,
   name: __filename,
 };
 
 /**
  * Type helper for `my-client` plugin, returns {@link Plugin.Config} object
  */
-export const myClientPlugin: Plugin.DefineConfig<Config> = (config) => ({
-  ...defaultConfig,
-  ...config,
-});
+export const myClientPlugin = definePluginConfig(defaultConfig);

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

@@ -1,7 +1,9 @@
 import {
   type Client,
   clientDefaultConfig,
+  clientDefaultMeta,
   clientPluginHandler,
+  definePluginConfig,
   type Plugin,
 } from '@hey-api/openapi-ts';
 
@@ -13,16 +15,13 @@ export interface Config extends Client.Config {
 }
 
 export const defaultConfig: Plugin.Config<Config> = {
-  ...clientDefaultConfig,
+  ...clientDefaultMeta,
   _handler: clientPluginHandler,
-  _handlerLegacy: () => {},
+  config: clientDefaultConfig,
   name: __filename,
 };
 
 /**
  * Type helper for `my-client` plugin, returns {@link Plugin.Config} object
  */
-export const myClientPlugin: Plugin.DefineConfig<Config> = (config) => ({
-  ...defaultConfig,
-  ...config,
-});
+export const myClientPlugin = definePluginConfig(defaultConfig);

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

@@ -1,7 +1,9 @@
 import {
   type Client,
   clientDefaultConfig,
+  clientDefaultMeta,
   clientPluginHandler,
+  definePluginConfig,
   type Plugin,
 } from '@hey-api/openapi-ts';
 
@@ -13,16 +15,13 @@ export interface Config extends Client.Config {
 }
 
 export const defaultConfig: Plugin.Config<Config> = {
-  ...clientDefaultConfig,
+  ...clientDefaultMeta,
   _handler: clientPluginHandler,
-  _handlerLegacy: () => {},
+  config: clientDefaultConfig,
   name: __filename,
 };
 
 /**
  * Type helper for `my-client` plugin, returns {@link Plugin.Config} object
  */
-export const myClientPlugin: Plugin.DefineConfig<Config> = (config) => ({
-  ...defaultConfig,
-  ...config,
-});
+export const myClientPlugin = definePluginConfig(defaultConfig);

packages/openapi-ts-tests/test/__snapshots__/3.1.x/clients/my-client/bundle/client/plugin.ts

@@ -1,7 +1,9 @@
 import {
   type Client,
   clientDefaultConfig,
+  clientDefaultMeta,
   clientPluginHandler,
+  definePluginConfig,
   type Plugin,
 } from '@hey-api/openapi-ts';
 
@@ -13,16 +15,13 @@ export interface Config extends Client.Config {
 }
 
 export const defaultConfig: Plugin.Config<Config> = {
-  ...clientDefaultConfig,
+  ...clientDefaultMeta,
   _handler: clientPluginHandler,
-  _handlerLegacy: () => {},
+  config: clientDefaultConfig,
   name: __filename,
 };
 
 /**
  * Type helper for `my-client` plugin, returns {@link Plugin.Config} object
  */
-export const myClientPlugin: Plugin.DefineConfig<Config> = (config) => ({
-  ...defaultConfig,
-  ...config,
-});
+export const myClientPlugin = definePluginConfig(defaultConfig);

packages/openapi-ts-tests/test/__snapshots__/3.1.x/clients/my-client/default/client/plugin.ts

@@ -1,7 +1,9 @@
 import {
   type Client,
   clientDefaultConfig,
+  clientDefaultMeta,
   clientPluginHandler,
+  definePluginConfig,
   type Plugin,
 } from '@hey-api/openapi-ts';
 
@@ -13,16 +15,13 @@ export interface Config extends Client.Config {
 }
 
 export const defaultConfig: Plugin.Config<Config> = {
-  ...clientDefaultConfig,
+  ...clientDefaultMeta,
   _handler: clientPluginHandler,
-  _handlerLegacy: () => {},
+  config: clientDefaultConfig,
   name: __filename,
 };
 
 /**
  * Type helper for `my-client` plugin, returns {@link Plugin.Config} object
  */
-export const myClientPlugin: Plugin.DefineConfig<Config> = (config) => ({
-  ...defaultConfig,
-  ...config,
-});
+export const myClientPlugin = definePluginConfig(defaultConfig);

packages/openapi-ts-tests/test/__snapshots__/3.1.x/clients/my-client/sdk-client-optional/client/plugin.ts

@@ -1,7 +1,9 @@
 import {
   type Client,
   clientDefaultConfig,
+  clientDefaultMeta,
   clientPluginHandler,
+  definePluginConfig,
   type Plugin,
 } from '@hey-api/openapi-ts';
 
@@ -13,16 +15,13 @@ export interface Config extends Client.Config {
 }
 
 export const defaultConfig: Plugin.Config<Config> = {
-  ...clientDefaultConfig,
+  ...clientDefaultMeta,
   _handler: clientPluginHandler,
-  _handlerLegacy: () => {},
+  config: clientDefaultConfig,
   name: __filename,
 };
 
 /**
  * Type helper for `my-client` plugin, returns {@link Plugin.Config} object
  */
-export const myClientPlugin: Plugin.DefineConfig<Config> = (config) => ({
-  ...defaultConfig,
-  ...config,
-});
+export const myClientPlugin = definePluginConfig(defaultConfig);

packages/openapi-ts-tests/test/__snapshots__/3.1.x/clients/my-client/sdk-client-required/client/plugin.ts

@@ -1,7 +1,9 @@
 import {
   type Client,
   clientDefaultConfig,
+  clientDefaultMeta,
   clientPluginHandler,
+  definePluginConfig,
   type Plugin,
 } from '@hey-api/openapi-ts';
 
@@ -13,16 +15,13 @@ export interface Config extends Client.Config {
 }
 
 export const defaultConfig: Plugin.Config<Config> = {
-  ...clientDefaultConfig,
+  ...clientDefaultMeta,
   _handler: clientPluginHandler,
-  _handlerLegacy: () => {},
+  config: clientDefaultConfig,
   name: __filename,
 };
 
 /**
  * Type helper for `my-client` plugin, returns {@link Plugin.Config} object
  */
-export const myClientPlugin: Plugin.DefineConfig<Config> = (config) => ({
-  ...defaultConfig,
-  ...config,
-});
+export const myClientPlugin = definePluginConfig(defaultConfig);