Merge pull request #1552 from hey-api/fix/zod-bigint-coerce

fix: zod plugin coerces bigint
hey-api · Jan 12, 2025 · 9c9e9c5 · 9c9e9c5
2 parents a22d34f + ceb8bd7
commit 9c9e9c5
Show file tree

Hide file tree

Showing 13 changed files with 137 additions and 125 deletions.
diff --git a/.changeset/poor-queens-crash.md b/.changeset/poor-queens-crash.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: use z.coerce before calling z.bigint
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -53,4 +53,4 @@ jobs:
 
       - name: Publish previews
         if: matrix.node-version == '22.11.0' && matrix.os == 'ubuntu-latest'
-        run: pnpx pkg-pr-new publish --compact --pnpm './packages/*'
+        run: pnpx pkg-pr-new publish --pnpm './packages/*'
diff --git a/packages/client-axios/src/types.ts b/packages/client-axios/src/types.ts
@@ -135,46 +135,46 @@ export interface RequestOptions<
 }
 
 export type RequestResult<
-  Data = unknown,
+  TData = unknown,
   TError = unknown,
   ThrowOnError extends boolean = boolean,
 > = ThrowOnError extends true
-  ? Promise<AxiosResponse<Data>>
+  ? Promise<AxiosResponse<TData>>
   : Promise<
-      | (AxiosResponse<Data> & { error: undefined })
+      | (AxiosResponse<TData> & { error: undefined })
       | (AxiosError<TError> & { data: undefined; error: TError })
     >;
 
 type MethodFn = <
-  Data = unknown,
+  TData = unknown,
   TError = unknown,
   ThrowOnError extends boolean = false,
 >(
   options: Omit<RequestOptions<ThrowOnError>, 'method'>,
-) => RequestResult<Data, TError, ThrowOnError>;
+) => RequestResult<TData, TError, ThrowOnError>;
 
 type RequestFn = <
-  Data = unknown,
+  TData = unknown,
   TError = unknown,
   ThrowOnError extends boolean = false,
 >(
   options: Omit<RequestOptions<ThrowOnError>, 'method'> &
     Pick<Required<RequestOptions<ThrowOnError>>, 'method'>,
-) => RequestResult<Data, TError, ThrowOnError>;
+) => RequestResult<TData, TError, ThrowOnError>;
 
 export interface Client {
   /**
    * Returns the final request URL. This method works only with experimental parser.
    */
   buildUrl: <
-    Data extends {
+    TData extends {
       body?: unknown;
       path?: Record<string, unknown>;
       query?: Record<string, unknown>;
       url: string;
     },
   >(
-    options: Pick<Data, 'url'> & Omit<Options<Data>, 'axios'>,
+    options: Pick<TData, 'url'> & Omit<Options<TData>, 'axios'>,
   ) => string;
   delete: MethodFn;
   get: MethodFn;
@@ -198,22 +198,22 @@ interface DataShape {
 }
 
 export type Options<
-  Data extends DataShape = DataShape,
+  TData extends DataShape = DataShape,
   ThrowOnError extends boolean = boolean,
 > = OmitKeys<RequestOptions<ThrowOnError>, 'body' | 'path' | 'query' | 'url'> &
-  Omit<Data, 'url'>;
+  Omit<TData, 'url'>;
 
 export type OptionsLegacyParser<
-  Data = unknown,
+  TData = unknown,
   ThrowOnError extends boolean = boolean,
-> = Data extends { body?: any }
-  ? Data extends { headers?: any }
-    ? OmitKeys<RequestOptions<ThrowOnError>, 'body' | 'headers' | 'url'> & Data
+> = TData extends { body?: any }
+  ? TData extends { headers?: any }
+    ? OmitKeys<RequestOptions<ThrowOnError>, 'body' | 'headers' | 'url'> & TData
     : OmitKeys<RequestOptions<ThrowOnError>, 'body' | 'url'> &
-        Data &
+        TData &
         Pick<RequestOptions<ThrowOnError>, 'headers'>
-  : Data extends { headers?: any }
+  : TData extends { headers?: any }
     ? OmitKeys<RequestOptions<ThrowOnError>, 'headers' | 'url'> &
-        Data &
+        TData &
         Pick<RequestOptions<ThrowOnError>, 'body'>
-    : OmitKeys<RequestOptions<ThrowOnError>, 'url'> & Data;
+    : OmitKeys<RequestOptions<ThrowOnError>, 'url'> & TData;
diff --git a/packages/client-fetch/src/types.ts b/packages/client-fetch/src/types.ts
@@ -145,18 +145,18 @@ export interface RequestOptions<
 }
 
 export type RequestResult<
-  Data = unknown,
+  TData = unknown,
   TError = unknown,
   ThrowOnError extends boolean = boolean,
 > = ThrowOnError extends true
   ? Promise<{
-      data: Data;
+      data: TData;
       request: Request;
       response: Response;
     }>
   : Promise<
       (
-        | { data: Data; error: undefined }
+        | { data: TData; error: undefined }
         | { data: undefined; error: TError }
       ) & {
         request: Request;
@@ -165,21 +165,21 @@ export type RequestResult<
     >;
 
 type MethodFn = <
-  Data = unknown,
+  TData = unknown,
   TError = unknown,
   ThrowOnError extends boolean = false,
 >(
   options: Omit<RequestOptions<ThrowOnError>, 'method'>,
-) => RequestResult<Data, TError, ThrowOnError>;
+) => RequestResult<TData, TError, ThrowOnError>;
 
 type RequestFn = <
-  Data = unknown,
+  TData = unknown,
   TError = unknown,
   ThrowOnError extends boolean = false,
 >(
   options: Omit<RequestOptions<ThrowOnError>, 'method'> &
     Pick<Required<RequestOptions<ThrowOnError>>, 'method'>,
-) => RequestResult<Data, TError, ThrowOnError>;
+) => RequestResult<TData, TError, ThrowOnError>;
 
 export interface Client<
   Req = Request,
@@ -191,14 +191,14 @@ export interface Client<
    * Returns the final request URL. This method works only with experimental parser.
    */
   buildUrl: <
-    Data extends {
+    TData extends {
       body?: unknown;
       path?: Record<string, unknown>;
       query?: Record<string, unknown>;
       url: string;
     },
   >(
-    options: Pick<Data, 'url'> & Options<Data>,
+    options: Pick<TData, 'url'> & Options<TData>,
   ) => string;
   connect: MethodFn;
   delete: MethodFn;
@@ -224,22 +224,22 @@ interface DataShape {
 }
 
 export type Options<
-  Data extends DataShape = DataShape,
+  TData extends DataShape = DataShape,
   ThrowOnError extends boolean = boolean,
 > = OmitKeys<RequestOptions<ThrowOnError>, 'body' | 'path' | 'query' | 'url'> &
-  Omit<Data, 'url'>;
+  Omit<TData, 'url'>;
 
 export type OptionsLegacyParser<
-  Data = unknown,
+  TData = unknown,
   ThrowOnError extends boolean = boolean,
-> = Data extends { body?: any }
-  ? Data extends { headers?: any }
-    ? OmitKeys<RequestOptions<ThrowOnError>, 'body' | 'headers' | 'url'> & Data
+> = TData extends { body?: any }
+  ? TData extends { headers?: any }
+    ? OmitKeys<RequestOptions<ThrowOnError>, 'body' | 'headers' | 'url'> & TData
     : OmitKeys<RequestOptions<ThrowOnError>, 'body' | 'url'> &
-        Data &
+        TData &
         Pick<RequestOptions<ThrowOnError>, 'headers'>
-  : Data extends { headers?: any }
+  : TData extends { headers?: any }
     ? OmitKeys<RequestOptions<ThrowOnError>, 'headers' | 'url'> &
-        Data &
+        TData &
         Pick<RequestOptions<ThrowOnError>, 'body'>
-    : OmitKeys<RequestOptions<ThrowOnError>, 'url'> & Data;
+    : OmitKeys<RequestOptions<ThrowOnError>, 'url'> & TData;
diff --git a/packages/openapi-ts/src/plugins/zod/plugin.ts b/packages/openapi-ts/src/plugins/zod/plugin.ts
@@ -22,6 +22,7 @@ interface Result {
 export const zodId = 'zod';
 
 // frequently used identifiers
+const coerceIdentifier = compiler.identifier({ text: 'coerce' });
 const defaultIdentifier = compiler.identifier({ text: 'default' });
 const intersectionIdentifier = compiler.identifier({ text: 'intersection' });
 const lazyIdentifier = compiler.identifier({ text: 'lazy' });
@@ -263,12 +264,18 @@ const numberTypeToZodSchema = ({
   }
 
   let numberExpression = compiler.callExpression({
-    functionName: compiler.propertyAccessExpression({
-      expression: zIdentifier,
-      name: isBigInt
-        ? compiler.identifier({ text: 'bigint' })
-        : compiler.identifier({ text: 'number' }),
-    }),
+    functionName: isBigInt
+      ? compiler.propertyAccessExpression({
+          expression: compiler.propertyAccessExpression({
+            expression: zIdentifier,
+            name: coerceIdentifier,
+          }),
+          name: compiler.identifier({ text: 'bigint' }),
+        })
+      : compiler.propertyAccessExpression({
+          expression: zIdentifier,
+          name: compiler.identifier({ text: 'number' }),
+        }),
   });
 
   if (!isBigInt && schema.type === 'integer') {

diff --git a/.../openapi-ts/test/__snapshots__/2.0.x/plugins/@hey-api/transformers/type-format/zod.gen.ts b/.../openapi-ts/test/__snapshots__/2.0.x/plugins/@hey-api/transformers/type-format/zod.gen.ts
@@ -4,7 +4,7 @@ import { z } from 'zod';
 
 export const zFoo = z.object({
     bar: z.number().int().optional(),
-    foo: z.bigint(),
+    foo: z.coerce.bigint(),
     id: z.string()
 });
 

diff --git a/.../openapi-ts/test/__snapshots__/3.0.x/plugins/@hey-api/transformers/type-format/zod.gen.ts b/.../openapi-ts/test/__snapshots__/3.0.x/plugins/@hey-api/transformers/type-format/zod.gen.ts
@@ -4,7 +4,7 @@ import { z } from 'zod';
 
 export const zFoo = z.object({
     bar: z.number().int().optional(),
-    foo: z.bigint(),
+    foo: z.coerce.bigint(),
     id: z.string()
 });
 

diff --git a/.../openapi-ts/test/__snapshots__/3.1.x/plugins/@hey-api/transformers/type-format/zod.gen.ts b/.../openapi-ts/test/__snapshots__/3.1.x/plugins/@hey-api/transformers/type-format/zod.gen.ts
@@ -4,7 +4,7 @@ import { z } from 'zod';
 
 export const zFoo = z.object({
     bar: z.number().int().optional(),
-    foo: z.bigint(),
+    foo: z.coerce.bigint(),
     id: z.string()
 });
 

diff --git a/packages/openapi-ts/test/__snapshots__/3.1.x/schema-const/zod.gen.ts b/packages/openapi-ts/test/__snapshots__/3.1.x/schema-const/zod.gen.ts
@@ -15,5 +15,5 @@ export const zFoo = z.object({
         z.literal(true)
     ]).optional(),
     corge: z.object({}).optional(),
-    garply: z.bigint().optional()
+    garply: z.coerce.bigint().optional()
 });
diff --git a/...-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios-bundle/client/types.ts.snap b/...-ts/test/__snapshots__/test/generated/v3-hey-api-client-axios-bundle/client/types.ts.snap
@@ -135,46 +135,46 @@ export interface RequestOptions<
 }
 
 export type RequestResult<
-  Data = unknown,
+  TData = unknown,
   TError = unknown,
   ThrowOnError extends boolean = boolean,
 > = ThrowOnError extends true
-  ? Promise<AxiosResponse<Data>>
+  ? Promise<AxiosResponse<TData>>
   : Promise<
-      | (AxiosResponse<Data> & { error: undefined })
+      | (AxiosResponse<TData> & { error: undefined })
       | (AxiosError<TError> & { data: undefined; error: TError })
     >;
 
 type MethodFn = <
-  Data = unknown,
+  TData = unknown,
   TError = unknown,
   ThrowOnError extends boolean = false,
 >(
   options: Omit<RequestOptions<ThrowOnError>, 'method'>,
-) => RequestResult<Data, TError, ThrowOnError>;
+) => RequestResult<TData, TError, ThrowOnError>;
 
 type RequestFn = <
-  Data = unknown,
+  TData = unknown,
   TError = unknown,
   ThrowOnError extends boolean = false,
 >(
   options: Omit<RequestOptions<ThrowOnError>, 'method'> &
     Pick<Required<RequestOptions<ThrowOnError>>, 'method'>,
-) => RequestResult<Data, TError, ThrowOnError>;
+) => RequestResult<TData, TError, ThrowOnError>;
 
 export interface Client {
   /**
    * Returns the final request URL. This method works only with experimental parser.
    */
   buildUrl: <
-    Data extends {
+    TData extends {
       body?: unknown;
       path?: Record<string, unknown>;
       query?: Record<string, unknown>;
       url: string;
     },
   >(
-    options: Pick<Data, 'url'> & Omit<Options<Data>, 'axios'>,
+    options: Pick<TData, 'url'> & Omit<Options<TData>, 'axios'>,
   ) => string;
   delete: MethodFn;
   get: MethodFn;
@@ -198,22 +198,22 @@ interface DataShape {
 }
 
 export type Options<
-  Data extends DataShape = DataShape,
+  TData extends DataShape = DataShape,
   ThrowOnError extends boolean = boolean,
 > = OmitKeys<RequestOptions<ThrowOnError>, 'body' | 'path' | 'query' | 'url'> &
-  Omit<Data, 'url'>;
+  Omit<TData, 'url'>;
 
 export type OptionsLegacyParser<
-  Data = unknown,
+  TData = unknown,
   ThrowOnError extends boolean = boolean,
-> = Data extends { body?: any }
-  ? Data extends { headers?: any }
-    ? OmitKeys<RequestOptions<ThrowOnError>, 'body' | 'headers' | 'url'> & Data
+> = TData extends { body?: any }
+  ? TData extends { headers?: any }
+    ? OmitKeys<RequestOptions<ThrowOnError>, 'body' | 'headers' | 'url'> & TData
     : OmitKeys<RequestOptions<ThrowOnError>, 'body' | 'url'> &
-        Data &
+        TData &
         Pick<RequestOptions<ThrowOnError>, 'headers'>
-  : Data extends { headers?: any }
+  : TData extends { headers?: any }
     ? OmitKeys<RequestOptions<ThrowOnError>, 'headers' | 'url'> &
-        Data &
+        TData &
         Pick<RequestOptions<ThrowOnError>, 'body'>
-    : OmitKeys<RequestOptions<ThrowOnError>, 'url'> & Data;
+    : OmitKeys<RequestOptions<ThrowOnError>, 'url'> & TData;