Merge pull request #1697 from hey-api/fix/export-from-index

fix: add ability to export any plugin output from index.ts

Author: mrlubos

.changeset/clever-plums-return.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: add exportFromIndex option to all plugins

docs/openapi-ts/custom-plugin.md

@@ -94,7 +94,7 @@ In the file above, we define a `my-plugin` plugin which will generate a `my-plug
 By default, your plugin output won't be re-exported from the `index.ts` file. To enable this feature, add `exportFromIndex: true` to your `config.ts` file.
 
 ::: warning
-Re-exporting your plugin from `index.ts` may result in broken output due to naming conflicts. Ensure your exported identifiers are unique.
+Re-exporting your plugin from index file may result in broken output due to naming conflicts. Ensure your exported identifiers are unique.
 :::
 
 ## Handler

docs/openapi-ts/output.md

@@ -45,13 +45,56 @@ export * from './types.gen';
 
 :::
 
-We recommend importing artifacts from their files to avoid ambiguity, but we leave this choice up to you.
+### Disable index file
+
+We recommend importing artifacts from their respective files to avoid ambiguity, but we leave this choice up to you.
 
 ```ts
-import type { Pet } from './client'; // 👎 // [!code --]
-import type { Pet } from './client/types.gen'; // 👍 // [!code ++]
+import type { Pet } from './client';
+// or
+import type { Pet } from './client/types.gen';
+```
+
+If you're not importing artifacts from the index file, you can skip generating it altogether by setting the `output.indexFile` option to `false`.
+
+```js
+import { defaultPlugins } from '@hey-api/openapi-ts';
+
+export default {
+  input: 'path/to/openapi.json',
+  output: {
+    indexFile: false, // [!code ++]
+    path: 'src/client',
+  },
+  plugins: ['@hey-api/client-fetch'],
+};
 ```
 
+### Re-export more files
+
+You can choose which files should be re-exported by setting the `exportFromIndex` option to `true` on any plugin. For example, here's how you would re-export [Zod](/openapi-ts/plugins/zod) plugin exports.
+
+```js
+import { defaultPlugins } from '@hey-api/openapi-ts';
+
+export default {
+  input: 'path/to/openapi.json',
+  output: 'src/client',
+  plugins: [
+    ...defaultPlugins,
+    '@hey-api/client-fetch',
+    {
+      exportFromIndex: true, // [!code ++]
+      name: 'zod',
+    },
+  ],
+};
+```
+
+::: warning
+Re-exporting additional files from index file may result in broken output due to naming conflicts.
+:::
+
 ## Client
 
 `client.gen.ts` is generated by [client plugins](/openapi-ts/clients). If you choose to generate SDKs (enabled by default), you must specify a client which will create this file.

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

@@ -3,5 +3,6 @@ export const clientDefaultConfig = {
   _tags: ['client'],
   baseUrl: true,
   bundle: false,
+  exportFromIndex: false,
   output: 'client',
 } as const;

packages/openapi-ts/src/plugins/@hey-api/client-core/types.d.ts

@@ -42,6 +42,13 @@ export namespace Client {
      * @default false
      */
     bundle?: boolean;
+    /**
+     * Should the exports from the generated files be re-exported in the index
+     * barrel file?
+     *
+     * @default false
+     */
+    exportFromIndex?: boolean;
     /**
      * Name of the generated file.
      *

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

@@ -6,6 +6,7 @@ import type { Config } from './types';
 export const defaultConfig: Plugin.Config<Config> = {
   _handler: handler,
   _handlerLegacy: handlerLegacy,
+  exportFromIndex: false,
   name: '@hey-api/schemas',
   nameBuilder: (name) => `${name}Schema`,
   output: 'schemas',

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

@@ -8,6 +8,13 @@ import type { SchemaObject as OpenApiV3_1_XSchemaObject } from '../../../openApi
 import type { Plugin } from '../../types';
 
 export interface Config extends Plugin.Name<'@hey-api/schemas'> {
+  /**
+   * Should the exports from the generated files be re-exported in the index
+   * barrel file?
+   *
+   * @default false
+   */
+  exportFromIndex?: boolean;
   /**
    * Customise the schema name. By default, `{{name}}Schema` is used. `name` is a
    * valid JavaScript/TypeScript identifier, e.g. if your schema name is

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

@@ -39,6 +39,13 @@ export interface Config extends Plugin.Name<'@hey-api/sdk'> {
    * @default true
    */
   client?: PluginClientNames | boolean;
+  /**
+   * Should the exports from the generated files be re-exported in the index
+   * barrel file?
+   *
+   * @default true
+   */
+  exportFromIndex?: boolean;
   /**
    * @deprecated
    *

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

@@ -10,6 +10,7 @@ export const defaultConfig: Plugin.Config<Config> = {
   _tags: ['transformer'],
   bigInt: true,
   dates: true,
+  exportFromIndex: false,
   name: '@hey-api/transformers',
   output: 'transformers',
 };

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

@@ -13,6 +13,13 @@ export interface Config extends Plugin.Name<'@hey-api/transformers'> {
    * @default true
    */
   dates?: boolean;
+  /**
+   * Should the exports from the generated files be re-exported in the index
+   * barrel file?
+   *
+   * @default false
+   */
+  exportFromIndex?: boolean;
   /**
    * Name of the generated file.
    *