chore: generate CreateClientConfig type with ClientOptions

mrlubos · mrlubos · commit ccc7ae40b68b · 2025-02-02T04:22:00.000Z
diff --git a/packages/client-axios/src/utils.ts b/packages/client-axios/src/utils.ts
@@ -281,7 +281,7 @@ export const mergeHeaders = (
 };
 
 export const createConfig = <T extends ClientOptions = ClientOptions>(
-  override: Config<ClientOptions & T> = {},
-): Config<Required<ClientOptions> & T> => ({
+  override: Config<Omit<ClientOptions, keyof T> & T> = {},
+): Config<Omit<ClientOptions, keyof T> & T> => ({
   ...override,
 });
diff --git a/packages/client-fetch/src/utils.ts b/packages/client-fetch/src/utils.ts
@@ -393,8 +393,8 @@ const defaultHeaders = {
 };
 
 export const createConfig = <T extends ClientOptions = ClientOptions>(
-  override: Config<ClientOptions & T> = {},
-): Config<Required<ClientOptions> & T> => ({
+  override: Config<Omit<ClientOptions, keyof T> & T> = {},
+): Config<Omit<ClientOptions, keyof T> & T> => ({
   ...jsonBodySerializer,
   headers: defaultHeaders,
   parseAs: 'auto',
diff --git a/packages/client-next/src/utils.ts b/packages/client-next/src/utils.ts
@@ -382,8 +382,8 @@ const defaultHeaders = {
 };
 
 export const createConfig = <T extends ClientOptions = ClientOptions>(
-  override: Config<ClientOptions & T> = {},
-): Config<Required<ClientOptions> & T> => ({
+  override: Config<Omit<ClientOptions, keyof T> & T> = {},
+): Config<Omit<ClientOptions, keyof T> & T> => ({
   ...jsonBodySerializer,
   headers: defaultHeaders,
   parseAs: 'auto',
diff --git a/packages/client-nuxt/src/utils.ts b/packages/client-nuxt/src/utils.ts
@@ -303,8 +303,8 @@ const defaultHeaders = {
 };
 
 export const createConfig = <T extends ClientOptions = ClientOptions>(
-  override: Config<ClientOptions & T> = {},
-): Config<Required<ClientOptions> & T> => ({
+  override: Config<Omit<ClientOptions, keyof T> & T> = {},
+): Config<Omit<ClientOptions, keyof T> & T> => ({
   ...jsonBodySerializer,
   headers: defaultHeaders,
   querySerializer: defaultQuerySerializer,
diff --git a/packages/openapi-ts/src/plugins/@hey-api/client-axios/config.ts b/packages/openapi-ts/src/plugins/@hey-api/client-axios/config.ts
@@ -3,6 +3,7 @@ import { handler } from '../client-core/plugin';
 import type { Config } from './types';
 
 export const defaultConfig: Plugin.Config<Config> = {
+  _dependencies: ['@hey-api/typescript'],
   _handler: handler,
   _handlerLegacy: () => {},
   _tags: ['client'],
diff --git a/packages/openapi-ts/src/plugins/@hey-api/client-core/plugin.ts b/packages/openapi-ts/src/plugins/@hey-api/client-core/plugin.ts
@@ -1,19 +1,102 @@
 import { compiler } from '../../../compiler';
 import { clientModulePath } from '../../../generate/client';
+import type { IR } from '../../../ir/types';
 import { clientId } from '../client-core/utils';
+import { typesId } from '../typescript/ref';
 import type { PluginHandler } from './types';
 
+const createClientConfigType = ({ context }: { context: IR.Context }) => {
+  const file = context.file({ id: clientId })!;
+
+  const clientModule = clientModulePath({
+    config: context.config,
+    sourceOutput: file.nameWithoutExtension(),
+  });
+  const clientOptions = file.import({
+    asType: true,
+    module: file.relativePathToFile({ context, id: typesId }),
+    name: 'ClientOptions',
+  });
+  const configType = file.import({
+    asType: true,
+    module: clientModule,
+    name: 'Config',
+  });
+  const defaultClientOptions = file.import({
+    alias: 'DefaultClientOptions',
+    asType: true,
+    module: clientModule,
+    name: 'ClientOptions',
+  });
+
+  const defaultClientOptionsType = compiler.typeReferenceNode({
+    typeName: defaultClientOptions.name,
+  });
+  const tType = compiler.typeReferenceNode({ typeName: 'T' });
+
+  const typeCreateClientConfig = compiler.typeAliasDeclaration({
+    comment: [
+      'The `createClientConfig()` function will be called on client initialization',
+      "and the returned object will become the client's initial configuration.",
+      '',
+      'You may want to initialize your client this way instead of calling',
+      "`setConfig()`. This is useful for example if you're using Next.js",
+      'to ensure your client always has the correct values.',
+    ],
+    exportType: true,
+    name: 'CreateClientConfig',
+    type: compiler.functionTypeNode({
+      parameters: [
+        compiler.parameterDeclaration({
+          name: 'override',
+          required: false,
+          type: compiler.typeReferenceNode({
+            typeArguments: [
+              compiler.typeIntersectionNode({
+                types: [defaultClientOptionsType, tType],
+              }),
+            ],
+            typeName: configType.name,
+          }),
+        }),
+      ],
+      returnType: compiler.typeReferenceNode({
+        typeArguments: [
+          compiler.typeIntersectionNode({
+            types: [
+              compiler.typeReferenceNode({
+                typeArguments: [defaultClientOptionsType],
+                typeName: 'Required',
+              }),
+              tType,
+            ],
+          }),
+        ],
+        typeName: configType.name,
+      }),
+    }),
+    typeParameters: [
+      {
+        default: compiler.typeReferenceNode({ typeName: clientOptions.name }),
+        extends: defaultClientOptionsType,
+        name: 'T',
+      },
+    ],
+  });
+
+  file.add(typeCreateClientConfig);
+};
+
 export const handler: PluginHandler = ({ context, plugin }) => {
   const file = context.createFile({
     exportFromIndex: plugin.exportFromIndex,
     id: clientId,
     path: plugin.output,
   });
-  const clientOutput = file.nameWithoutExtension();
 
   const clientModule = clientModulePath({
     config: context.config,
-    sourceOutput: clientOutput,
+    sourceOutput: file.nameWithoutExtension(),
   });
   const createClient = file.import({
     module: clientModule,
@@ -23,6 +106,11 @@ export const handler: PluginHandler = ({ context, plugin }) => {
     module: clientModule,
     name: 'createConfig',
   });
+  const clientOptions = file.import({
+    asType: true,
+    module: file.relativePathToFile({ context, id: typesId }),
+    name: 'ClientOptions',
+  });
 
   const createClientConfig = plugin.runtimeConfigPath
     ? file.import({
@@ -49,9 +137,14 @@ export const handler: PluginHandler = ({ context, plugin }) => {
             })
           : undefined,
       ],
+      types: [compiler.typeReferenceNode({ typeName: clientOptions.name })],
     }),
   ];
 
+  createClientConfigType({
+    context,
+  });
+
   const statement = compiler.constVariable({
     exportConst: true,
     expression: compiler.callExpression({
diff --git a/packages/openapi-ts/src/plugins/@hey-api/client-core/utils.ts b/packages/openapi-ts/src/plugins/@hey-api/client-core/utils.ts
@@ -5,6 +5,17 @@ export const clientId = 'client';
 
 type Plugins = Required<Config>['plugins'];
 
+export const getClientBaseUrlKey = (config: Config) => {
+  const client = getClientPlugin(config);
+  if (
+    client.name === '@hey-api/client-axios' ||
+    client.name === '@hey-api/client-nuxt'
+  ) {
+    return 'baseURL';
+  }
+  return 'baseUrl';
+};
+
 export const getClientPlugin = (
   config: Config,
 ): Required<Plugins>[PluginClientNames] => {
diff --git a/packages/openapi-ts/src/plugins/@hey-api/client-fetch/config.ts b/packages/openapi-ts/src/plugins/@hey-api/client-fetch/config.ts
@@ -3,6 +3,7 @@ import { handler } from '../client-core/plugin';
 import type { Config } from './types';
 
 export const defaultConfig: Plugin.Config<Config> = {
+  _dependencies: ['@hey-api/typescript'],
   _handler: handler,
   _handlerLegacy: () => {},
   _tags: ['client'],
diff --git a/packages/openapi-ts/src/plugins/@hey-api/client-next/config.ts b/packages/openapi-ts/src/plugins/@hey-api/client-next/config.ts
@@ -3,6 +3,7 @@ import { handler } from '../client-core/plugin';
 import type { Config } from './types';
 
 export const defaultConfig: Plugin.Config<Config> = {
+  _dependencies: ['@hey-api/typescript'],
   _handler: handler,
   _handlerLegacy: () => {},
   _tags: ['client'],
diff --git a/packages/openapi-ts/src/plugins/@hey-api/client-nuxt/config.ts b/packages/openapi-ts/src/plugins/@hey-api/client-nuxt/config.ts
@@ -3,6 +3,7 @@ import { handler } from '../client-core/plugin';
 import type { Config } from './types';
 
 export const defaultConfig: Plugin.Config<Config> = {
+  _dependencies: ['@hey-api/typescript'],
   _handler: handler,
   _handlerLegacy: () => {},
   _tags: ['client'],
diff --git a/packages/openapi-ts/src/plugins/@hey-api/typescript/plugin.ts b/packages/openapi-ts/src/plugins/@hey-api/typescript/plugin.ts
@@ -12,6 +12,7 @@ import { stringCase } from '../../../utils/stringCase';
 import { fieldName } from '../../shared/utils/case';
 import { operationIrRef } from '../../shared/utils/ref';
 import type { Plugin } from '../../types';
+import { getClientBaseUrlKey } from '../client-core/utils';
 import { typesId } from './ref';
 import type { Config } from './types';
 
@@ -1019,6 +1020,53 @@ export const schemaToType = ({
   return type;
 };
 
+const createClientOptions = ({
+  context,
+}: {
+  context: IR.Context;
+  plugin: Plugin.Instance<Config>;
+}) => {
+  const file = context.file({ id: typesId })!;
+
+  const clientOptions = file.identifier({
+    $ref: 'ClientOptions',
+    create: true,
+    namespace: 'type',
+  });
+
+  if (!clientOptions.name) {
+    return;
+  }
+
+  const typeClientOptions = compiler.typeAliasDeclaration({
+    exportType: true,
+    name: clientOptions.name,
+    type: compiler.typeInterfaceNode({
+      properties: [
+        {
+          name: getClientBaseUrlKey(context.config),
+          type: compiler.typeUnionNode({
+            types: [
+              compiler.literalTypeNode({
+                literal: compiler.stringLiteral({ text: '/' }),
+              }),
+              compiler.typeIntersectionNode({
+                types: [
+                  compiler.keywordTypeNode({ keyword: 'string' }),
+                  ts.factory.createTypeLiteralNode([]),
+                ],
+              }),
+            ],
+          }),
+        },
+      ],
+      useLegacyResolution: false,
+    }),
+  });
+
+  file.add(typeClientOptions);
+};
+
 export const handler: Plugin.Handler<Config> = ({ context, plugin }) => {
   context.createFile({
     exportFromIndex: plugin.exportFromIndex,
@@ -1027,6 +1075,13 @@ export const handler: Plugin.Handler<Config> = ({ context, plugin }) => {
     path: plugin.output,
   });
 
+  context.subscribe('before', () => {
+    createClientOptions({
+      context,
+      plugin,
+    });
+  });
+
   context.subscribe('schema', ({ $ref, schema }) => {
     schemaToType({
       $ref,
diff --git a/packages/openapi-ts/src/plugins/@tanstack/query-core/client.ts b/packages/openapi-ts/src/plugins/@tanstack/query-core/client.ts
diff --git a/packages/openapi-ts/src/plugins/@tanstack/query-core/plugin-legacy.ts b/packages/openapi-ts/src/plugins/@tanstack/query-core/plugin-legacy.ts
@@ -20,7 +20,10 @@ import type { Config } from '../../../types/config';
 import type { Files } from '../../../types/utils';
 import { getConfig, isLegacyClient } from '../../../utils/config';
 import { transformServiceName } from '../../../utils/transform';
-import { getClientPlugin } from '../../@hey-api/client-core/utils';
+import {
+  getClientBaseUrlKey,
+  getClientPlugin,
+} from '../../@hey-api/client-core/utils';
 import {
   generateImport,
   operationDataTypeName,
@@ -101,12 +104,6 @@ const queryKeyName = 'QueryKey';
 const queryOptionsFn = 'queryOptions';
 const TOptionsType = 'TOptions';
 
-const getClientBaseUrlKey = () => {
-  const config = getConfig();
-  const clientPlugin = getClientPlugin(config);
-  return clientPlugin.name === '@hey-api/client-axios' ? 'baseURL' : 'baseUrl';
-};
-
 const createInfiniteParamsFunction = ({
   file,
 }: {
@@ -329,9 +326,9 @@ const createQueryKeyFunction = ({ file }: { file: Files[keyof Files] }) => {
                 value: compiler.identifier({ text: 'id' }),
               },
               {
-                key: getClientBaseUrlKey(),
+                key: getClientBaseUrlKey(getConfig()),
                 value: compiler.identifier({
-                  text: `(options?.client ?? _heyApiClient).getConfig().${getClientBaseUrlKey()}`,
+                  text: `(options?.client ?? _heyApiClient).getConfig().${getClientBaseUrlKey(getConfig())}`,
                 }),
               },
             ],
@@ -491,7 +488,7 @@ const createQueryKeyType = ({ file }: { file: Files[keyof Files] }) => {
         compiler.typeIntersectionNode({
           types: [
             compiler.typeReferenceNode({
-              typeName: `Pick<${TOptionsType}, '${getClientBaseUrlKey()}' | 'body' | 'headers' | 'path' | 'query'>`,
+              typeName: `Pick<${TOptionsType}, '${getClientBaseUrlKey(getConfig())}' | 'body' | 'headers' | 'path' | 'query'>`,
             }),
             compiler.typeInterfaceNode({
               properties,
diff --git a/packages/openapi-ts/src/plugins/@tanstack/query-core/queryKey.ts b/packages/openapi-ts/src/plugins/@tanstack/query-core/queryKey.ts
@@ -2,8 +2,8 @@ import { compiler, type Property } from '../../../compiler';
 import { clientApi } from '../../../generate/client';
 import { hasOperationDataRequired } from '../../../ir/operation';
 import type { IR } from '../../../ir/types';
+import { getClientBaseUrlKey } from '../../@hey-api/client-core/utils';
 import { serviceFunctionIdentifier } from '../../@hey-api/sdk/plugin-legacy';
-import { getClientBaseUrlKey } from './client';
 import type { PluginInstance } from './types';
 import { useTypeData } from './useType';
 
@@ -69,9 +69,9 @@ export const createQueryKeyFunction = ({
                 value: compiler.identifier({ text: 'id' }),
               },
               {
-                key: getClientBaseUrlKey(),
+                key: getClientBaseUrlKey(context.config),
                 value: compiler.identifier({
-                  text: `(options?.client ?? _heyApiClient).getConfig().${getClientBaseUrlKey()}`,
+                  text: `(options?.client ?? _heyApiClient).getConfig().${getClientBaseUrlKey(context.config)}`,
                 }),
               },
             ],
@@ -271,7 +271,7 @@ export const createQueryKeyType = ({
         compiler.typeIntersectionNode({
           types: [
             compiler.typeReferenceNode({
-              typeName: `Pick<${TOptionsType}, '${getClientBaseUrlKey()}' | 'body' | 'headers' | 'path' | 'query'>`,
+              typeName: `Pick<${TOptionsType}, '${getClientBaseUrlKey(context.config)}' | 'body' | 'headers' | 'path' | 'query'>`,
             }),
             compiler.typeInterfaceNode({
               properties,
