chore: clean up

Author: mrlubos

.changeset/five-pianos-jump.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+**plugin(@hey-api/examples)**: initial release

packages/openapi-python/src/plugins/types.ts

@@ -4,7 +4,7 @@ export type PluginClientNames =
   | '@hey-api/client-requests'
   | '@hey-api/client-urllib3';
 
-export type PluginMockNames = 'factory_boy' | 'faker' | 'mimesis';
+export type PluginSourceNames = 'factory_boy' | 'faker' | 'mimesis';
 
 export type PluginTransformerNames = never;
 

packages/openapi-ts/src/index.ts

@@ -68,6 +68,7 @@ declare module '@hey-api/shared' {
     '@hey-api/client-next': Plugins.HeyApiClientNext.Types['Types'];
     '@hey-api/client-nuxt': Plugins.HeyApiClientNuxt.Types['Types'];
     '@hey-api/client-ofetch': Plugins.HeyApiClientOfetch.Types['Types'];
+    '@hey-api/examples': Plugins.HeyApiExamples.Types['Types'];
     '@hey-api/schemas': Plugins.HeyApiSchemas.Types['Types'];
     '@hey-api/sdk': Plugins.HeyApiSdk.Types['Types'];
     '@hey-api/transformers': Plugins.HeyApiTransformers.Types['Types'];
@@ -128,6 +129,7 @@ import type {
   HeyApiClientOfetchPlugin,
   OfetchClient as OfetchClientImp,
 } from './plugins/@hey-api/client-ofetch';
+import type { HeyApiExamplesPlugin } from './plugins/@hey-api/examples';
 import type { HeyApiSchemasPlugin } from './plugins/@hey-api/schemas';
 import type { HeyApiSdkPlugin } from './plugins/@hey-api/sdk';
 import type { HeyApiTransformersPlugin } from './plugins/@hey-api/transformers';
@@ -250,6 +252,10 @@ export namespace Plugins {
     export type Types = HeyApiClientOfetchPlugin;
   }
 
+  export namespace HeyApiExamples {
+    export type Types = HeyApiExamplesPlugin;
+  }
+
   export namespace HeyApiSchemas {
     export type Types = HeyApiSchemasPlugin;
   }

packages/openapi-ts/src/plugins/@faker-js/faker/config.ts

@@ -24,7 +24,7 @@ export const defaultConfig: FakerJsFakerPlugin['Config'] = {
       value: plugin.config.definitions,
     });
   },
-  tags: ['mocker'],
+  tags: ['source'],
 };
 
 /**

packages/openapi-ts/src/plugins/@hey-api/examples/config.ts

@@ -0,0 +1,20 @@
+import { definePluginConfig } from '@hey-api/shared';
+
+// import { handler } from './plugin';
+import type { HeyApiExamplesPlugin } from './types';
+
+export const defaultConfig: HeyApiExamplesPlugin['Config'] = {
+  config: {
+    case: 'camelCase',
+    includeInEntry: false,
+  },
+  // handler,
+  handler: () => {},
+  name: '@hey-api/examples',
+  tags: ['source'],
+};
+
+/**
+ * Type helper for `@hey-api/examples` plugin, returns {@link Plugin.Config} object
+ */
+export const defineConfig = definePluginConfig(defaultConfig);

packages/openapi-ts/src/plugins/@hey-api/examples/index.ts

@@ -0,0 +1,2 @@
+export { defaultConfig, defineConfig } from './config';
+export type { HeyApiExamplesPlugin } from './types';

packages/openapi-ts/src/plugins/@hey-api/examples/types.ts

@@ -0,0 +1,24 @@
+import type { Casing } from '@hey-api/shared';
+import type { DefinePlugin, Plugin } from '@hey-api/shared';
+
+export type UserConfig = Plugin.Name<'@hey-api/examples'> &
+  // Plugin.Hooks &
+  Plugin.UserExports & {
+    // Resolvers & {
+    /**
+     * Casing convention for generated names.
+     *
+     * @default 'camelCase'
+     */
+    case?: Casing;
+  };
+
+export type Config = Plugin.Name<'@hey-api/examples'> &
+  // Plugin.Hooks &
+  Plugin.Exports & {
+    // Resolvers & {
+    /** Casing convention for generated names. */
+    case: Casing;
+  };
+
+export type HeyApiExamplesPlugin = DefinePlugin<UserConfig, Config>;

packages/openapi-ts/src/plugins/config.ts

@@ -9,6 +9,7 @@ import { defaultConfig as heyApiClientKy } from '../plugins/@hey-api/client-ky';
 import { defaultConfig as heyApiClientNext } from '../plugins/@hey-api/client-next';
 import { defaultConfig as heyApiClientNuxt } from '../plugins/@hey-api/client-nuxt';
 import { defaultConfig as heyApiClientOfetch } from '../plugins/@hey-api/client-ofetch';
+import { defaultConfig as heyApiExamples } from '../plugins/@hey-api/examples';
 import { defaultConfig as heyApiSchemas } from '../plugins/@hey-api/schemas';
 import { defaultConfig as heyApiSdk } from '../plugins/@hey-api/sdk';
 import { defaultConfig as heyApiTransformers } from '../plugins/@hey-api/transformers';
@@ -41,6 +42,7 @@ export const defaultPluginConfigs: {
   '@hey-api/client-next': heyApiClientNext,
   '@hey-api/client-nuxt': heyApiClientNuxt,
   '@hey-api/client-ofetch': heyApiClientOfetch,
+  '@hey-api/examples': heyApiExamples,
   '@hey-api/schemas': heyApiSchemas,
   '@hey-api/sdk': heyApiSdk,
   '@hey-api/transformers': heyApiTransformers,

packages/openapi-ts/src/plugins/msw/config.ts

@@ -9,15 +9,23 @@ export const defaultConfig: MswPlugin['Config'] = {
     comments: true,
     includeInEntry: false,
     responseFallback: 'error',
-    valueSources: ['example'],
+    source: ['@hey-api/examples'],
   },
   dependencies: ['@hey-api/typescript'],
   handler,
   name: 'msw',
-  tags: ['mocker'],
+  resolveConfig: (plugin) => {
+    if (!(plugin.config.source instanceof Array)) {
+      plugin.config.source = plugin.config.source ? [plugin.config.source] : [];
+    }
+    for (const source of plugin.config.source) {
+      plugin.dependencies.add(source);
+    }
+  },
+  tags: ['handler'],
 };
 
 /**
- * Type helper for `msw` plugin, returns {@link Plugin.Config} object
+ * Type helper for MSW plugin, returns {@link Plugin.Config} object
  */
 export const defineConfig = definePluginConfig(defaultConfig);

packages/openapi-ts/src/plugins/msw/shared/handler.ts

@@ -153,12 +153,10 @@ function createHandlerNode({
 
 export function getHandler({
   baseUrl,
-  examples,
   operation,
   plugin,
 }: {
   baseUrl: string | undefined;
-  examples: boolean;
   operation: IR.OperationObject;
   plugin: MswPlugin['Instance'];
 }): Symbol {
@@ -212,8 +210,8 @@ export function getHandler({
     // omit response type to avoid DefaultBodyType constraint issues
   );
 
-  // When examples are disabled, strip the example from the dominant response
-  if (!examples) {
+  if (!plugin.config.source.includes('@hey-api/examples')) {
+    // examples are disabled, strip the example from the dominant response
     response.example = undefined;
   }