Merge pull request #2034 from Le0Developer/feat/typeids

mrlubos · web-flow · commit f3d2d3244484 · 2025-07-21T21:22:11.000+08:00
diff --git a/.changeset/clean-kiwis-worry.md b/.changeset/clean-kiwis-worry.md
@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix(typescript): add support for TypeID types
diff --git a/packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/transformers/type-format-valibot/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/transformers/type-format-valibot/types.gen.ts
@@ -3,7 +3,7 @@
 export type Foo = {
     bar?: number;
     foo: bigint;
-    id: string;
+    id: UserId;
 };
 
 export type Bar = {
@@ -27,6 +27,10 @@ export type PostFooResponses = {
 
 export type PostFooResponse = PostFooResponses[keyof PostFooResponses];
 
+export type TypeID<T extends string> = `${T}_${string}`;
+
+export type UserId = TypeID<'user'>;
+
 export type ClientOptions = {
     baseUrl: string;
 };
diff --git a/packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/transformers/type-format-zod/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/transformers/type-format-zod/types.gen.ts
@@ -3,7 +3,7 @@
 export type Foo = {
     bar?: number;
     foo: bigint;
-    id: string;
+    id: UserId;
 };
 
 export type Bar = {
@@ -27,6 +27,10 @@ export type PostFooResponses = {
 
 export type PostFooResponse = PostFooResponses[keyof PostFooResponses];
 
+export type TypeID<T extends string> = `${T}_${string}`;
+
+export type UserId = TypeID<'user'>;
+
 export type ClientOptions = {
     baseUrl: string;
 };
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.0.x/plugins/@hey-api/transformers/type-format-valibot/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.0.x/plugins/@hey-api/transformers/type-format-valibot/types.gen.ts
@@ -3,7 +3,7 @@
 export type Foo = {
     bar?: number;
     foo: bigint;
-    id: string;
+    id: UserId;
 };
 
 export type Bar = {
@@ -27,6 +27,10 @@ export type PostFooResponses = {
 
 export type PostFooResponse = PostFooResponses[keyof PostFooResponses];
 
+export type TypeID<T extends string> = `${T}_${string}`;
+
+export type UserId = TypeID<'user'>;
+
 export type ClientOptions = {
     baseUrl: `${string}://${string}` | (string & {});
 };
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.0.x/plugins/@hey-api/transformers/type-format-zod/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.0.x/plugins/@hey-api/transformers/type-format-zod/types.gen.ts
@@ -3,7 +3,7 @@
 export type Foo = {
     bar?: number;
     foo: bigint;
-    id: string;
+    id: UserId;
 };
 
 export type Bar = {
@@ -27,6 +27,10 @@ export type PostFooResponses = {
 
 export type PostFooResponse = PostFooResponses[keyof PostFooResponses];
 
+export type TypeID<T extends string> = `${T}_${string}`;
+
+export type UserId = TypeID<'user'>;
+
 export type ClientOptions = {
     baseUrl: `${string}://${string}` | (string & {});
 };
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.1.x/plugins/@hey-api/transformers/type-format-valibot/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.1.x/plugins/@hey-api/transformers/type-format-valibot/types.gen.ts
@@ -3,7 +3,7 @@
 export type Foo = {
     bar?: number;
     foo: bigint;
-    id: string;
+    id: UserId;
 };
 
 export type Bar = {
@@ -27,6 +27,10 @@ export type PostFooResponses = {
 
 export type PostFooResponse = PostFooResponses[keyof PostFooResponses];
 
+export type TypeID<T extends string> = `${T}_${string}`;
+
+export type UserId = TypeID<'user'>;
+
 export type ClientOptions = {
     baseUrl: `${string}://${string}` | (string & {});
 };
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.1.x/plugins/@hey-api/transformers/type-format-zod/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.1.x/plugins/@hey-api/transformers/type-format-zod/types.gen.ts
@@ -3,7 +3,7 @@
 export type Foo = {
     bar?: number;
     foo: bigint;
-    id: string;
+    id: UserId;
 };
 
 export type Bar = {
@@ -27,6 +27,10 @@ export type PostFooResponses = {
 
 export type PostFooResponse = PostFooResponses[keyof PostFooResponses];
 
+export type TypeID<T extends string> = `${T}_${string}`;
+
+export type UserId = TypeID<'user'>;
+
 export type ClientOptions = {
     baseUrl: `${string}://${string}` | (string & {});
 };
diff --git a/packages/openapi-ts-tests/test/spec/2.0.x/type-format.yaml b/packages/openapi-ts-tests/test/spec/2.0.x/type-format.yaml
@@ -24,6 +24,8 @@ definitions:
         type: integer
       id:
         type: string
+        format: typeid
+        example: 'user_123'
     required:
       - id
       - foo
diff --git a/packages/openapi-ts-tests/test/spec/3.0.x/type-format.yaml b/packages/openapi-ts-tests/test/spec/3.0.x/type-format.yaml
@@ -25,6 +25,8 @@ components:
           type: integer
         id:
           type: string
+          format: typeid
+          example: 'user_123'
       required:
         - id
         - foo
diff --git a/packages/openapi-ts-tests/test/spec/3.1.x/type-format.yaml b/packages/openapi-ts-tests/test/spec/3.1.x/type-format.yaml
@@ -25,6 +25,8 @@ components:
           type: integer
         id:
           type: string
+          format: typeid
+          example: 'user_123'
       required:
         - id
         - foo
diff --git a/packages/openapi-ts/src/ir/types.d.ts b/packages/openapi-ts/src/ir/types.d.ts
@@ -139,6 +139,7 @@ interface IRSchemaObject
     | 'pattern'
     | 'required'
     | 'title'
+    | 'example'
   > {
   /**
    * If the schema is intended to be used as an object property, it can be
diff --git a/packages/openapi-ts/src/openApi/2.0.x/parser/schema.ts b/packages/openapi-ts/src/openApi/2.0.x/parser/schema.ts
@@ -34,6 +34,10 @@ const parseSchemaJsDoc = ({
   irSchema: IR.SchemaObject;
   schema: SchemaObject;
 }) => {
+  if (schema.example) {
+    irSchema.example = schema.example;
+  }
+
   if (schema.description) {
     irSchema.description = schema.description;
   }
diff --git a/packages/openapi-ts/src/openApi/3.0.x/parser/schema.ts b/packages/openapi-ts/src/openApi/3.0.x/parser/schema.ts
@@ -38,6 +38,10 @@ const parseSchemaJsDoc = ({
     irSchema.deprecated = schema.deprecated;
   }
 
+  if (schema.example) {
+    irSchema.example = schema.example;
+  }
+
   if (schema.description) {
     irSchema.description = schema.description;
   }
diff --git a/packages/openapi-ts/src/openApi/3.1.x/parser/schema.ts b/packages/openapi-ts/src/openApi/3.1.x/parser/schema.ts
@@ -41,6 +41,10 @@ const parseSchemaJsDoc = ({
     irSchema.deprecated = schema.deprecated;
   }
 
+  if (schema.example) {
+    irSchema.example = schema.example;
+  }
+
   if (schema.description) {
     irSchema.description = schema.description;
   }
diff --git a/packages/openapi-ts/src/plugins/@hey-api/sdk/operation.ts b/packages/openapi-ts/src/plugins/@hey-api/sdk/operation.ts
@@ -18,6 +18,7 @@ import {
   transformersId,
 } from '../transformers/plugin';
 import { typesId } from '../typescript/ref';
+import type { PluginState } from '../typescript/types';
 import { operationAuth } from './auth';
 import { nuxtTypeComposable, nuxtTypeDefault, sdkId } from './constants';
 import type { HeyApiSdkPlugin } from './types';
@@ -211,6 +212,9 @@ export const operationParameters = ({
   };
 
   const pluginTypeScript = plugin.getPlugin('@hey-api/typescript')!;
+  const typescriptState: PluginState = {
+    usedTypeIDs: new Set<string>(),
+  };
   const client = getClientPlugin(plugin.context.config);
   const isNuxtClient = client.name === '@hey-api/client-nuxt';
 
@@ -243,6 +247,7 @@ export const operationParameters = ({
             },
             plugin: pluginTypeScript,
             schema: parameter.schema,
+            state: typescriptState,
           }),
         });
       }
@@ -274,6 +279,7 @@ export const operationParameters = ({
             },
             plugin: pluginTypeScript,
             schema: parameter.schema,
+            state: typescriptState,
           }),
         });
       }
@@ -300,6 +306,7 @@ export const operationParameters = ({
           },
           plugin: pluginTypeScript,
           schema: operation.body.schema,
+          state: typescriptState,
         }),
       });
     }
diff --git a/packages/openapi-ts/src/plugins/@hey-api/typescript/operation.ts b/packages/openapi-ts/src/plugins/@hey-api/typescript/operation.ts
@@ -7,7 +7,7 @@ import type { IR } from '../../../ir/types';
 import { buildName } from '../../../openApi/shared/utils/name';
 import { schemaToType } from './plugin';
 import { typesId } from './ref';
-import type { HeyApiTypeScriptPlugin } from './types';
+import type { HeyApiTypeScriptPlugin, PluginState } from './types';
 
 const irParametersToIrSchema = ({
   parameters,
@@ -48,9 +48,11 @@ const irParametersToIrSchema = ({
 const operationToDataType = ({
   operation,
   plugin,
+  state,
 }: {
   operation: IR.OperationObject;
   plugin: HeyApiTypeScriptPlugin['Instance'];
+  state: PluginState;
 }) => {
   const file = plugin.context.file({ id: typesId })!;
   const data: IR.SchemaObject = {
@@ -138,6 +140,7 @@ const operationToDataType = ({
     onRef: undefined,
     plugin,
     schema: data,
+    state,
   });
   const node = compiler.typeAliasDeclaration({
     exportType: nodeInfo.exported,
@@ -150,11 +153,13 @@ const operationToDataType = ({
 export const operationToType = ({
   operation,
   plugin,
+  state,
 }: {
   operation: IR.OperationObject;
   plugin: HeyApiTypeScriptPlugin['Instance'];
+  state: PluginState;
 }) => {
-  operationToDataType({ operation, plugin });
+  operationToDataType({ operation, plugin, state });
 
   const file = plugin.context.file({ id: typesId })!;
 
@@ -177,6 +182,7 @@ export const operationToType = ({
       onRef: undefined,
       plugin,
       schema: errors,
+      state,
     });
     const node = compiler.typeAliasDeclaration({
       exportType: nodeInfo.exported,
@@ -232,6 +238,7 @@ export const operationToType = ({
       onRef: undefined,
       plugin,
       schema: responses,
+      state,
     });
     const node = compiler.typeAliasDeclaration({
       exportType: nodeInfo.exported,
diff --git a/packages/openapi-ts/src/plugins/@hey-api/typescript/plugin.ts b/packages/openapi-ts/src/plugins/@hey-api/typescript/plugin.ts
diff --git a/packages/openapi-ts/src/plugins/@hey-api/typescript/types.d.ts b/packages/openapi-ts/src/plugins/@hey-api/typescript/types.d.ts
diff --git a/packages/openapi-ts/src/plugins/@tanstack/query-core/infiniteQueryOptions.ts b/packages/openapi-ts/src/plugins/@tanstack/query-core/infiniteQueryOptions.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@hey-api/openapi-ts": patch
 +---
++
 +fix(typescript): add support for TypeID types