Merge pull request #1699 from hey-api/fix/sdk-meta-field

fix: allow passing arbitrary values to SDK functions via meta field
hey-api · Feb 10, 2025 · 19f6749 · 19f6749
2 parents 5cd3d9e + 8ff188f
commit 19f6749
Show file tree

Hide file tree

Showing 100 changed files with 612 additions and 103 deletions.
diff --git a/.changeset/four-rings-sniff.md b/.changeset/four-rings-sniff.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: allow passing arbitrary values to SDK functions via `meta` field
diff --git a/packages/openapi-ts/src/plugins/@hey-api/sdk/plugin.ts b/packages/openapi-ts/src/plugins/@hey-api/sdk/plugin.ts
@@ -3,7 +3,7 @@ import type ts from 'typescript';
 import { compiler } from '../../../compiler';
 import type { ObjectValue } from '../../../compiler/types';
 import { clientApi, clientModulePath } from '../../../generate/client';
-import type { FileImportResult, TypeScriptFile } from '../../../generate/files';
+import type { TypeScriptFile } from '../../../generate/files';
 import {
   hasOperationDataRequired,
   statusCodeToGroup,
@@ -26,6 +26,7 @@ import {
   importIdentifierResponse,
 } from '../typescript/ref';
 import { serviceFunctionIdentifier } from './plugin-legacy';
+import { createTypeOptions } from './typeOptions';
 import type { Config } from './types';
 
 // copy-pasted from @hey-api/client-core
@@ -673,105 +674,6 @@ const generateFlatSdk = ({
   });
 };
 
-const createTypeOptions = ({
-  clientOptions,
-  context,
-  plugin,
-}: {
-  clientOptions: FileImportResult;
-  context: IR.Context;
-  plugin: Plugin.Instance<Config>;
-}) => {
-  const file = context.file({ id: sdkId })!;
-  const client = getClientPlugin(context.config);
-  const isNuxtClient = client.name === '@hey-api/client-nuxt';
-
-  const clientModule = clientModulePath({
-    config: context.config,
-    sourceOutput: file.nameWithoutExtension(),
-  });
-  const tDataShape = file.import({
-    asType: true,
-    module: clientModule,
-    name: 'TDataShape',
-  });
-  const clientType = file.import({
-    asType: true,
-    module: clientModule,
-    name: 'Client',
-  });
-
-  const typeOptions = compiler.typeAliasDeclaration({
-    exportType: true,
-    name: 'Options',
-    type: compiler.typeIntersectionNode({
-      types: [
-        compiler.typeReferenceNode({
-          typeArguments: isNuxtClient
-            ? [
-                compiler.typeReferenceNode({ typeName: 'TComposable' }),
-                compiler.typeReferenceNode({ typeName: 'TData' }),
-              ]
-            : [
-                compiler.typeReferenceNode({ typeName: 'TData' }),
-                compiler.typeReferenceNode({ typeName: 'ThrowOnError' }),
-              ],
-          typeName: clientOptions.name,
-        }),
-        compiler.typeInterfaceNode({
-          properties: [
-            {
-              comment: [
-                'You can provide a client instance returned by `createClient()` instead of',
-                'individual options. This might be also useful if you want to implement a',
-                'custom client.',
-              ],
-              isRequired: !plugin.client,
-              name: 'client',
-              type: compiler.typeReferenceNode({ typeName: clientType.name }),
-            },
-          ],
-          useLegacyResolution: false,
-        }),
-      ],
-    }),
-    typeParameters: isNuxtClient
-      ? [
-          compiler.typeParameterDeclaration({
-            constraint: compiler.typeReferenceNode({ typeName: 'Composable' }),
-            name: 'TComposable',
-          }),
-          compiler.typeParameterDeclaration({
-            constraint: compiler.typeReferenceNode({
-              typeName: tDataShape.name,
-            }),
-            defaultType: compiler.typeReferenceNode({
-              typeName: tDataShape.name,
-            }),
-            name: 'TData',
-          }),
-        ]
-      : [
-          compiler.typeParameterDeclaration({
-            constraint: compiler.typeReferenceNode({
-              typeName: tDataShape.name,
-            }),
-            defaultType: compiler.typeReferenceNode({
-              typeName: tDataShape.name,
-            }),
-            name: 'TData',
-          }),
-          compiler.typeParameterDeclaration({
-            constraint: compiler.keywordTypeNode({ keyword: 'boolean' }),
-            defaultType: compiler.keywordTypeNode({ keyword: 'boolean' }),
-            name: 'ThrowOnError',
-          }),
-        ],
-  });
-
-  file.add(typeOptions);
-};
-
 export const handler: Plugin.Handler<Config> = ({ context, plugin }) => {
   const file = context.createFile({
     exportFromIndex: plugin.exportFromIndex,

diff --git a/packages/openapi-ts/src/plugins/@hey-api/sdk/typeOptions.ts b/packages/openapi-ts/src/plugins/@hey-api/sdk/typeOptions.ts
@@ -0,0 +1,122 @@
+import { compiler } from '../../../compiler';
+import { clientModulePath } from '../../../generate/client';
+import type { FileImportResult } from '../../../generate/files';
+import type { IR } from '../../../ir/types';
+import type { Plugin } from '../../types';
+import { getClientPlugin } from '../client-core/utils';
+import { sdkId } from './plugin';
+import type { Config } from './types';
+
+export const createTypeOptions = ({
+  clientOptions,
+  context,
+  plugin,
+}: {
+  clientOptions: FileImportResult;
+  context: IR.Context;
+  plugin: Plugin.Instance<Config>;
+}) => {
+  const file = context.file({ id: sdkId })!;
+  const client = getClientPlugin(context.config);
+  const isNuxtClient = client.name === '@hey-api/client-nuxt';
+
+  const clientModule = clientModulePath({
+    config: context.config,
+    sourceOutput: file.nameWithoutExtension(),
+  });
+  const tDataShape = file.import({
+    asType: true,
+    module: clientModule,
+    name: 'TDataShape',
+  });
+  const clientType = file.import({
+    asType: true,
+    module: clientModule,
+    name: 'Client',
+  });
+
+  const typeOptions = compiler.typeAliasDeclaration({
+    exportType: true,
+    name: 'Options',
+    type: compiler.typeIntersectionNode({
+      types: [
+        compiler.typeReferenceNode({
+          typeArguments: isNuxtClient
+            ? [
+                compiler.typeReferenceNode({ typeName: 'TComposable' }),
+                compiler.typeReferenceNode({ typeName: 'TData' }),
+              ]
+            : [
+                compiler.typeReferenceNode({ typeName: 'TData' }),
+                compiler.typeReferenceNode({ typeName: 'ThrowOnError' }),
+              ],
+          typeName: clientOptions.name,
+        }),
+        compiler.typeInterfaceNode({
+          properties: [
+            {
+              comment: [
+                'You can provide a client instance returned by `createClient()` instead of',
+                'individual options. This might be also useful if you want to implement a',
+                'custom client.',
+              ],
+              isRequired: !plugin.client,
+              name: 'client',
+              type: compiler.typeReferenceNode({ typeName: clientType.name }),
+            },
+            {
+              comment: [
+                'You can pass arbitrary values through the `meta` object. This can be',
+                "used to access values that aren't defined as part of the SDK function.",
+              ],
+              isRequired: false,
+              name: 'meta',
+              type: compiler.typeReferenceNode({
+                typeArguments: [
+                  compiler.keywordTypeNode({ keyword: 'string' }),
+                  compiler.keywordTypeNode({ keyword: 'unknown' }),
+                ],
+                typeName: 'Record',
+              }),
+            },
+          ],
+          useLegacyResolution: false,
+        }),
+      ],
+    }),
+    typeParameters: isNuxtClient
+      ? [
+          compiler.typeParameterDeclaration({
+            constraint: compiler.typeReferenceNode({ typeName: 'Composable' }),
+            name: 'TComposable',
+          }),
+          compiler.typeParameterDeclaration({
+            constraint: compiler.typeReferenceNode({
+              typeName: tDataShape.name,
+            }),
+            defaultType: compiler.typeReferenceNode({
+              typeName: tDataShape.name,
+            }),
+            name: 'TData',
+          }),
+        ]
+      : [
+          compiler.typeParameterDeclaration({
+            constraint: compiler.typeReferenceNode({
+              typeName: tDataShape.name,
+            }),
+            defaultType: compiler.typeReferenceNode({
+              typeName: tDataShape.name,
+            }),
+            name: 'TData',
+          }),
+          compiler.typeParameterDeclaration({
+            constraint: compiler.keywordTypeNode({ keyword: 'boolean' }),
+            defaultType: compiler.keywordTypeNode({ keyword: 'boolean' }),
+            name: 'ThrowOnError',
+          }),
+        ],
+  });
+
+  file.add(typeOptions);
+};
diff --git a/packages/openapi-ts/test/__snapshots__/2.0.x/body-response-text-plain/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/2.0.x/body-response-text-plain/sdk.gen.ts
@@ -11,6 +11,11 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      * custom client.
      */
     client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
 };
 
 export const postFoo = <ThrowOnError extends boolean = false>(options: Options<PostFooData, ThrowOnError>) => {

diff --git a/packages/openapi-ts/test/__snapshots__/2.0.x/form-data/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/2.0.x/form-data/sdk.gen.ts
@@ -11,6 +11,11 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      * custom client.
      */
     client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
 };
 
 export const postV1Foo = <ThrowOnError extends boolean = false>(options: Options<PostV1FooData, ThrowOnError>) => {

diff --git a/packages/openapi-ts/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/default/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/default/sdk.gen.ts
@@ -11,6 +11,11 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      * custom client.
      */
     client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
 };
 
 export const serviceWithEmptyTag = <ThrowOnError extends boolean = false>(options?: Options<ServiceWithEmptyTagData, ThrowOnError>) => {

diff --git a/packages/openapi-ts/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/throwOnError/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/throwOnError/sdk.gen.ts
@@ -11,6 +11,11 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      * custom client.
      */
     client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
 };
 
 export const serviceWithEmptyTag = <ThrowOnError extends boolean = true>(options?: Options<ServiceWithEmptyTagData, ThrowOnError>) => {

diff --git a/.../openapi-ts/test/__snapshots__/2.0.x/plugins/@hey-api/transformers/type-format/sdk.gen.ts b/.../openapi-ts/test/__snapshots__/2.0.x/plugins/@hey-api/transformers/type-format/sdk.gen.ts
@@ -13,6 +13,11 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      * custom client.
      */
     client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
 };
 
 export const postFoo = <ThrowOnError extends boolean = false>(options?: Options<PostFooData, ThrowOnError>) => {

diff --git a/.../test/__snapshots__/2.0.x/plugins/@tanstack/angular-query-experimental/asClass/sdk.gen.ts b/.../test/__snapshots__/2.0.x/plugins/@tanstack/angular-query-experimental/asClass/sdk.gen.ts
@@ -11,6 +11,11 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      * custom client.
      */
     client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
 };
 
 export class DefaultService {

diff --git a/...ts/test/__snapshots__/2.0.x/plugins/@tanstack/angular-query-experimental/axios/sdk.gen.ts b/...ts/test/__snapshots__/2.0.x/plugins/@tanstack/angular-query-experimental/axios/sdk.gen.ts
@@ -11,6 +11,11 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      * custom client.
      */
     client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
 };
 
 export const serviceWithEmptyTag = <ThrowOnError extends boolean = false>(options?: Options<ServiceWithEmptyTagData, ThrowOnError>) => {

diff --git a/...ts/test/__snapshots__/2.0.x/plugins/@tanstack/angular-query-experimental/fetch/sdk.gen.ts b/...ts/test/__snapshots__/2.0.x/plugins/@tanstack/angular-query-experimental/fetch/sdk.gen.ts
@@ -11,6 +11,11 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      * custom client.
      */
     client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
 };
 
 export const serviceWithEmptyTag = <ThrowOnError extends boolean = false>(options?: Options<ServiceWithEmptyTagData, ThrowOnError>) => {

diff --git a/...ages/openapi-ts/test/__snapshots__/2.0.x/plugins/@tanstack/react-query/asClass/sdk.gen.ts b/...ages/openapi-ts/test/__snapshots__/2.0.x/plugins/@tanstack/react-query/asClass/sdk.gen.ts
@@ -11,6 +11,11 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      * custom client.
      */
     client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
 };
 
 export class DefaultService {

diff --git a/packages/openapi-ts/test/__snapshots__/2.0.x/plugins/@tanstack/react-query/axios/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/2.0.x/plugins/@tanstack/react-query/axios/sdk.gen.ts
@@ -11,6 +11,11 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      * custom client.
      */
     client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
 };
 
 export const serviceWithEmptyTag = <ThrowOnError extends boolean = false>(options?: Options<ServiceWithEmptyTagData, ThrowOnError>) => {

diff --git a/packages/openapi-ts/test/__snapshots__/2.0.x/plugins/@tanstack/react-query/fetch/sdk.gen.ts b/packages/openapi-ts/test/__snapshots__/2.0.x/plugins/@tanstack/react-query/fetch/sdk.gen.ts
@@ -11,6 +11,11 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      * custom client.
      */
     client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
 };
 
 export const serviceWithEmptyTag = <ThrowOnError extends boolean = false>(options?: Options<ServiceWithEmptyTagData, ThrowOnError>) => {

diff --git a/...ages/openapi-ts/test/__snapshots__/2.0.x/plugins/@tanstack/solid-query/asClass/sdk.gen.ts b/...ages/openapi-ts/test/__snapshots__/2.0.x/plugins/@tanstack/solid-query/asClass/sdk.gen.ts
@@ -11,6 +11,11 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      * custom client.
      */
     client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
 };
 
 export class DefaultService {