zod schema and ts type don't match when bigint is generated

[aldirrix]

Description

First of all, let me thank you for all the effort. The progress of this package is stunning.
We were trying to use the zod plugin and realised that when we have a property that is int64 it generates a schema with a property of z.coerce.bigint().optional() however the generated type is not matching as it's only generated as number.
This is not ideal as we would like to pass the parsed object to another function and then types are incompatible.

Using the provided openapi schema we get the following

// Current generated schema

// This file is auto-generated by @hey-api/openapi-ts

import { z } from 'zod';

export const zGetHelloResponse = z.object({
    someBigInt: z.coerce.bigint().optional()
});

// types
export type GetHelloResponses = {
    /**
     * A successful response
     */
    200: {
        /**
         * Amount of adults in
         */
        someBigInt?: number;
    };
};

export type GetHelloResponse = GetHelloResponses[keyof GetHelloResponses];

Let me know if that's clear and if I can assist in any form. Again thanks for providing an amazing package

Reproducible example or configuration

import { defineConfig } from '@hey-api/openapi-ts';

export default defineConfig({
  input: './openapi-spec.json',
  output: {
    path: './src/generated',
  },
  plugins: [
    {
      name: '@hey-api/typescript',
      style: 'PascalCase',
    },
    '@hey-api/sdk',
    'zod',
    '@hey-api/client-fetch',
    {
      exportFromIndex: true,
      name: '@hey-api/client-fetch',
    },
    {
      exportFromIndex: true,
      name: 'zod',
    },
  ],
});

OpenAPI specification (optional)

{
"openapi": "3.1.0",
"info": {
"title": "Minimal API",
"description": "A minimal OpenAPI specification example",
"version": "1.0.0"
},
"paths": {
"/hello": {
"get": {
"summary": "Returns a greeting message",
"responses": {
"200": {
"description": "A successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"someBigInt": {
"type" : "integer",
"format" : "int64",
"description" : "some amount",
"example" : 3
}
}
}
}
}
}
}
}
}
}
}

System information (optional)

using latest version of everything

[aldirrix]

While trying to maybe push some changes I think I found out how to do it with my openapi-ts config. I will close and leave how to fix it in case someone looks for this

 plugins: [
    ...
    {
      name: '@hey-api/transformers',
      bigInt: true,
      dates: false,
    },

[Jtcruthers]

I think this bug still exists. Just using the zod plugin without transforming the data, you get incompatible types. The types.gen.ts file uses number, while the zod.gen.ts uses z.coerce.bigint().

I'd expect somehow to work around this. I wish there was a way to transform the zod schema to just use number instead of bigint. I saw #1074 actually changed it from using number to the current bigint, but having it match my types.gen.ts would be beneficial.

But at the very least, without using transformers, the zod and types files have diverged.

[v-kessler]

I still have number instead of bigint

here is my config:
package.json
"@hey-api/client-fetch": "^0.10.0",
"@hey-api/openapi-ts": "^0.66.3",

open-api.yaml
current-snapshot-id:
type: integer
format: int64

openapi-ts.config.ts

import { defineConfig, defaultPlugins } from '@hey-api/openapi-ts';

export default defineConfig({
  input: 'https://get.heyapi.dev/hey-api/backend',
  output: 'src/client',
  plugins: [
    ...defaultPlugins,
    '@hey-api/client-fetch',
    '@hey-api/transformers',
    {
      name: '@hey-api/sdk',
      transformer: true,
    },
    {
      name: '@hey-api/transformers',
      bigInt: true,
    },
  ],
});

generated result
'current-snapshot-id'?: number;

GET response is "current-snapshot-id": 858199504583861995, but in serialization I see current-snapshot-id: 858199504583862000

[dirkluijk]

Checked all official options for numeric types

• type: number gives number with z.number() ✅
• type: number with format: float gives number with z.number() ✅
• type: number with format: double gives number with z.number() ✅
• type: integer gives number with z.number() ✅
• type: integer with format: int32 gives number with z.number() ✅
• type: integer with format: int64 gives number with z.coerce.bigint() ❗

So the issue is only in the last case, and I believe we should reopen this issue.

[blubito-jan-brueggmann-01]

I second @dirkluijk in his belief that this should be reopened. We've ran into the same issue in which we cant use int64 format with zod schemas due to very weird behaviour/generated code.

[shipurjan]

I just ran into this problem:

      "SandboxContentItem" : {
        "type" : "object",
        "properties" : {
          "size" : {
            "type" : "integer",
            "description" : "The size of the file in bytes",
            "format" : "int64",
            "example" : 1024
          }
        },
        "description" : "Content item in a sandbox"
      },

	plugins: [
		{
			name: "@hey-api/typescript",
			enums: "javascript",
			exportFromIndex: true,
		},
		{
			name: "zod",
			exportFromIndex: true,
			metadata: true,
		},
	],

export const zSandboxContentItem = z
	.object({
		size: z.optional(
			z.coerce
				.bigint()
				.min(BigInt("-9223372036854775808"), {
					error: "Invalid value: Expected int64 to be >= -9223372036854775808",
				})
				.max(BigInt("9223372036854775807"), {
					error: "Invalid value: Expected int64 to be <= 9223372036854775807",
				})
				.register(z.globalRegistry, {
					description: "The size of the file in bytes",
				}),
		),
	})

export type SandboxContentItem = {
	/**
	 * The size of the file in bytes
	 */
	size?: number;
};

The types of _output.size are incompatible between these types.
Type bigint | undefined is not assignable to type number | undefined
Type bigint is not assignable to type number

[shipurjan]

Adding the transformer to my plugin list indeed fixed it:

	plugins: [
		{
			name: "@hey-api/typescript",
			enums: "javascript",
			exportFromIndex: true,
		},
		{
			name: "zod",
			exportFromIndex: true,
			metadata: true,
		},
		{
			name: "@hey-api/transformers",
			bigInt: true,
		},
	],