feat: multiple configs functionality

.changeset/dry-jeans-ring.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+feat: support multiple configurations

docs/openapi-ts/configuration.md

@@ -38,31 +38,6 @@ export default {
 
 Alternatively, you can use `openapi-ts.config.js` and configure the export statement depending on your project setup.
 
-<!--
-TODO: uncomment after c12 supports multiple configs
-see https://github.com/unjs/c12/issues/92
--->
-<!-- ### Multiple Clients
-
-If you want to generate multiple clients with a single `openapi-ts` command, you can provide an array of configuration objects.
-
-```js
-import { defineConfig } from '@hey-api/openapi-ts';
-
-export default defineConfig([
-  {
-    input: 'path/to/openapi_one.json',
-    output: 'src/client_one',
-    plugins: ['legacy/fetch'],
-  },
-  {
-    input: 'path/to/openapi_two.json',
-    output: 'src/client_two',
-    plugins: ['legacy/axios'],
-  },
-])
-``` -->
-
 ## Input
 
 You must provide an input so we can load your OpenAPI specification.
@@ -163,6 +138,108 @@ Plugins are responsible for generating artifacts from your input. By default, He
 
 You can learn more on the [Output](/openapi-ts/output) page.
 
+## Advanced
+
+More complex configuration scenarios can be handled by providing an array of inputs, outputs, or configurations.
+
+### Multiple jobs
+
+Throughout this documentation, we generally reference single job configurations. However, you can easily run multiple jobs by providing an array of configuration objects.
+
+::: code-group
+
+```js [config]
+export default [
+  {
+    input: 'foo.yaml',
+    output: 'src/foo',
+  },
+  {
+    input: 'bar.yaml',
+    output: 'src/bar',
+  },
+];
+```
+
+```md [example]
+src/
+├── foo/
+│ ├── client/
+│ ├── core/
+│ ├── client.gen.ts
+│ ├── index.ts
+│ ├── sdk.gen.ts
+│ └── types.gen.ts
+└── bar/
+├── client/
+├── core/
+├── client.gen.ts
+├── index.ts
+├── sdk.gen.ts
+└── types.gen.ts
+```
+
+:::
+
+### Job matrix
+
+Reusing configuration across multiple jobs is possible by defining a job matrix. You can create a job matrix by providing `input` and `output` arrays of matching length.
+
+::: code-group
+
+```js [config]
+export default {
+  input: ['foo.yaml', 'bar.yaml'],
+  output: ['src/foo', 'src/bar'],
+};
+```
+
+```md [example]
+src/
+├── foo/
+│ ├── client/
+│ ├── core/
+│ ├── client.gen.ts
+│ ├── index.ts
+│ ├── sdk.gen.ts
+│ └── types.gen.ts
+└── bar/
+├── client/
+├── core/
+├── client.gen.ts
+├── index.ts
+├── sdk.gen.ts
+└── types.gen.ts
+```
+
+:::
+
+### Merging inputs
+
+You can merge inputs by defining multiple inputs and a single output.
+
+::: code-group
+
+```js [config]
+export default {
+  input: ['foo.yaml', 'bar.yaml'],
+  output: 'src/client',
+};
+```
+
+```md [example]
+src/
+└── client/
+├── client/
+├── core/
+├── client.gen.ts
+├── index.ts
+├── sdk.gen.ts
+└── types.gen.ts
+```
+
+:::
+
 ## API
 
 You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/types/config.d.ts) interface.

docs/openapi-ts/configuration/input.md

@@ -54,6 +54,8 @@ export default {
 
 :::
 
+You can learn more about complex use cases in the [Advanced](/openapi-ts/configuration#advanced) section.
+
 ::: info
 If you use an HTTPS URL with a self-signed certificate in development, you will need to set [`NODE_TLS_REJECT_UNAUTHORIZED=0`](https://github.com/hey-api/openapi-ts/issues/276#issuecomment-2043143501) in your environment.
 :::

docs/openapi-ts/configuration/output.md

@@ -34,6 +34,8 @@ export default {
 
 :::
 
+You can learn more about complex use cases in the [Advanced](/openapi-ts/configuration#advanced) section.
+
 ## File Name
 
 You can customize the naming and casing pattern for files using the `fileName` option.

package.json

@@ -65,7 +65,7 @@
     "rollup": "4.31.0",
     "rollup-plugin-dts": "6.1.1",
     "tsup": "8.4.0",
-    "turbo": "2.5.6",
+    "turbo": "2.5.8",
     "typescript": "5.8.3",
     "typescript-eslint": "8.29.1",
     "vitest": "3.1.1"

packages/nuxt/src/module.ts

@@ -60,9 +60,11 @@ export default defineNuxtModule<ModuleOptions>({
       config.watch = false;
     }
 
+    const output =
+      config.output instanceof Array ? config.output[0] : config.output;
     const folder = path.resolve(
       nuxt.options.rootDir,
-      typeof config.output === 'string' ? config.output : config.output.path,
+      typeof output === 'string' ? output : (output?.path ?? ''),
     );
 
     nuxt.options.alias[options.alias!] = folder;

packages/openapi-ts-tests/main/test/2.0.x.test.ts

@@ -15,13 +15,15 @@ const version = '2.0.x';
 const outputDir = path.join(__dirname, 'generated', version);
 
 describe(`OpenAPI ${version}`, () => {
-  const createConfig = (userConfig: UserConfig): UserConfig => {
+  const createConfig = (userConfig: UserConfig) => {
+    const input =
+      userConfig.input instanceof Array
+        ? userConfig.input[0]
+        : userConfig.input;
     const inputPath = path.join(
       getSpecsPath(),
       version,
-      typeof userConfig.input === 'string'
-        ? userConfig.input
-        : (userConfig.input.path as string),
+      typeof input === 'string' ? input : ((input?.path as string) ?? ''),
     );
     return {
       plugins: ['@hey-api/typescript'],
@@ -40,7 +42,7 @@ describe(`OpenAPI ${version}`, () => {
         outputDir,
         typeof userConfig.output === 'string' ? userConfig.output : '',
       ),
-    };
+    } as const satisfies UserConfig;
   };
 
   const scenarios = [
@@ -391,9 +393,7 @@ describe(`OpenAPI ${version}`, () => {
   it.each(scenarios)('$description', async ({ config }) => {
     await createClient(config);
 
-    const outputPath =
-      typeof config.output === 'string' ? config.output : config.output.path;
-    const filePaths = getFilePaths(outputPath);
+    const filePaths = getFilePaths(config.output);
 
     await Promise.all(
       filePaths.map(async (filePath) => {

packages/openapi-ts-tests/main/test/3.0.x.test.ts

@@ -15,13 +15,15 @@ const version = '3.0.x';
 const outputDir = path.join(__dirname, 'generated', version);
 
 describe(`OpenAPI ${version}`, () => {
-  const createConfig = (userConfig: UserConfig): UserConfig => {
+  const createConfig = (userConfig: UserConfig) => {
+    const input =
+      userConfig.input instanceof Array
+        ? userConfig.input[0]
+        : userConfig.input;
     const inputPath = path.join(
       getSpecsPath(),
       version,
-      typeof userConfig.input === 'string'
-        ? userConfig.input
-        : (userConfig.input.path as string),
+      typeof input === 'string' ? input : ((input?.path as string) ?? ''),
     );
     return {
       plugins: ['@hey-api/typescript'],
@@ -40,7 +42,7 @@ describe(`OpenAPI ${version}`, () => {
         outputDir,
         typeof userConfig.output === 'string' ? userConfig.output : '',
       ),
-    };
+    } as const satisfies UserConfig;
   };
 
   const scenarios = [
@@ -668,9 +670,7 @@ describe(`OpenAPI ${version}`, () => {
   it.each(scenarios)('$description', async ({ config }) => {
     await createClient(config);
 
-    const outputPath =
-      typeof config.output === 'string' ? config.output : config.output.path;
-    const filePaths = getFilePaths(outputPath);
+    const filePaths = getFilePaths(config.output);
 
     await Promise.all(
       filePaths.map(async (filePath) => {

packages/openapi-ts-tests/main/test/3.1.x.test.ts

@@ -15,14 +15,20 @@ const version = '3.1.x';
 const outputDir = path.join(__dirname, 'generated', version);
 
 describe(`OpenAPI ${version}`, () => {
-  const createConfig = (userConfig: UserConfig): UserConfig => {
+  const createConfig = (userConfig: UserConfig) => {
+    const input =
+      userConfig.input instanceof Array
+        ? userConfig.input[0]
+        : userConfig.input;
     const inputPath = path.join(
       getSpecsPath(),
       version,
-      typeof userConfig.input === 'string'
-        ? userConfig.input
-        : (userConfig.input.path as string),
+      typeof input === 'string' ? input : ((input?.path as string) ?? ''),
     );
+    const output =
+      userConfig.output instanceof Array
+        ? userConfig.output[0]
+        : userConfig.output;
     return {
       plugins: ['@hey-api/typescript'],
       ...userConfig,
@@ -38,9 +44,9 @@ describe(`OpenAPI ${version}`, () => {
       },
       output: path.join(
         outputDir,
-        typeof userConfig.output === 'string' ? userConfig.output : '',
+        typeof output === 'string' ? output : (output?.path ?? ''),
       ),
-    };
+    } as const satisfies UserConfig;
   };
 
   const scenarios = [
@@ -969,9 +975,7 @@ describe(`OpenAPI ${version}`, () => {
   it.each(scenarios)('$description', async ({ config }) => {
     await createClient(config);
 
-    const outputPath =
-      typeof config.output === 'string' ? config.output : config.output.path;
-    const filePaths = getFilePaths(outputPath);
+    const filePaths = getFilePaths(config.output);
 
     await Promise.all(
       filePaths.map(async (filePath) => {