bigint with max and min produces incorrect schema

[adrienlo]

Bug description

We have a field that has a type of bigint with min/max. But the output doesn't produce a correct schema.

Input

  /**
   * @minimum -999999999 scale must be greater than or equal to -999999999
   * @maximum 999999999 scale must be less than or equal to 999999999
   */
type Foo = {
  scale: bigint
}

Expected output

const fooSchema = z.object({
  scale:  z.bigint()
    .min(BigInt(-999999999), 'scale must be greater than or equal to -999999999')
    .max(BigInt(999999999), 'scale must be less than or equal to 999999999'),
})

Actual output

const fooSchema = z.object({
  scale: z.bigint()
    .min(-999999999, 'scale must be greater than or equal to -999999999')
    .max(999999999, 'scale must be less than or equal to 999999999'),
})

This is also a Typescript error

Versions

• Typescript: ^5.5.4
• Zod: ^3.23.8
• ts-to-zod: '^3.13.0'

[adrienlo]

I did try this but it did not work

  /**
   * @minimum BigInt(-999999999) scale must be greater than or equal to -999999999
   * @maximum BigInt999999999) scale must be less than or equal to 999999999
   */

[tvillaren]

Hello,

Indeed, the bigInt type it not detected.
Not an easy fix given the way JSDoc tags are handled (they're unaware of the underlying property)

A workaround can be implemented using the @schema annotation:

type Foo = {
  /**
   * @schema .min(BigInt(-999999999), "scale must be greater than or equal to -999999999").max(BigInt(999999999), "scale must be less than or equal to 999999999")
   */
  scale: bigint;
};

This will append whatever is behind the @schema at generation time:

// Generated by ts-to-zod
import { z } from "zod";

const fooSchema = z.object({
  scale: z
    .bigint()
    .min(
      BigInt(-999999999),
      "scale must be greater than or equal to -999999999"
    )
    .max(BigInt(999999999), "scale must be less than or equal to 999999999"),
});

[adrienlo]

This worked great. Thank you. Looks like @schema is where we'll be spending a lot of our time.