Merge pull request #2280 from hey-api/fix/zod-dates-offset

fix(zod): add dates.offset option

Author: mrlubos

.changeset/wicked-tables-shout.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix(zod): add `dates.offset` option

packages/openapi-ts-tests/test/3.1.x.test.ts

@@ -764,6 +764,25 @@ describe(`OpenAPI ${version}`, () => {
       }),
       description: 'generates validator schemas',
     },
+    {
+      config: createConfig({
+        input: 'validators.yaml',
+        output: 'validators-dates',
+        plugins: [
+          // Valibot doesn't allow configuring offset
+          // {
+          //   name: 'valibot',
+          // },
+          {
+            dates: {
+              offset: true,
+            },
+            name: 'zod',
+          },
+        ],
+      }),
+      description: 'generates validator schemas with any offset',
+    },
     {
       config: createConfig({
         input: 'validators.yaml',

packages/openapi-ts-tests/test/__snapshots__/3.1.x/validators-dates/zod.gen.ts

@@ -0,0 +1,66 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import { z } from 'zod';
+
+/**
+ * This is Bar schema.
+ */
+export const zBar: z.AnyZodObject = z.object({
+    foo: z.lazy(() => {
+        return zFoo;
+    }).optional()
+});
+
+/**
+ * This is Foo schema.
+ */
+export const zFoo: z.ZodTypeAny = z.union([
+    z.object({
+        foo: z.string().regex(/^\d{3}-\d{2}-\d{4}$/).optional(),
+        bar: zBar.optional(),
+        baz: z.array(z.lazy(() => {
+            return zFoo;
+        })).optional(),
+        qux: z.number().int().gt(0).optional().default(0)
+    }),
+    z.null()
+]).default(null);
+
+export const zBaz = z.string().regex(/foo\nbar/).readonly().default('baz');
+
+export const zQux = z.record(z.object({
+    qux: z.string().optional()
+}));
+
+/**
+ * This is Foo parameter.
+ */
+export const zFoo2 = z.string();
+
+export const zFoo3 = z.object({
+    foo: zBar.optional()
+});
+
+export const zPatchFooData = z.object({
+    body: z.object({
+        foo: z.string().optional()
+    }),
+    path: z.never().optional(),
+    query: z.object({
+        foo: z.string().optional(),
+        bar: zBar.optional(),
+        baz: z.object({
+            baz: z.string().optional()
+        }).optional(),
+        qux: z.string().date().optional(),
+        quux: z.string().datetime({
+            offset: true
+        }).optional()
+    }).optional()
+});
+
+export const zPostFooData = z.object({
+    body: zFoo3,
+    path: z.never().optional(),
+    query: z.never().optional()
+});

packages/openapi-ts-tests/test/openapi-ts.config.ts

@@ -37,7 +37,7 @@ export default defineConfig(() => {
       //   'invalid',
       //   'servers-entry.yaml',
       // ),
-      path: path.resolve(__dirname, 'spec', '3.1.x', 'full.yaml'),
+      path: path.resolve(__dirname, 'spec', '3.1.x', 'validators.yaml'),
       // path: path.resolve(__dirname, 'spec', 'v3-transforms.json'),
       // path: path.resolve(__dirname, 'spec', 'v3.json'),
       // path: 'http://localhost:4000/',
@@ -206,6 +206,9 @@ export default defineConfig(() => {
       {
         // case: 'snake_case',
         // comments: false,
+        // dates: {
+        //   // offset: false,
+        // },
         definitions: 'z{{name}}Definition',
         // exportFromIndex: true,
         // metadata: true,

packages/openapi-ts/src/config/utils.ts

@@ -3,26 +3,37 @@ type ObjectType<T> =
     ? Record<string, any>
     : Extract<T, Record<string, any>>;
 
+type MappersType<T> = {
+  boolean: T extends boolean
+    ? (value: boolean) => Partial<ObjectType<T>>
+    : never;
+  number: T extends number ? (value: number) => Partial<ObjectType<T>> : never;
+  object?: (value: Partial<ObjectType<T>>) => Partial<ObjectType<T>>;
+  string: T extends string ? (value: string) => Partial<ObjectType<T>> : never;
+} extends infer U
+  ? { [K in keyof U as U[K] extends never ? never : K]: U[K] }
+  : never;
+
+type IsObjectOnly<T> = T extends Record<string, any> | undefined
+  ? Extract<T, string | boolean | number> extends never
+    ? true
+    : false
+  : false;
+
 export type ValueToObject = <
   T extends undefined | string | boolean | number | Record<string, any>,
->(args: {
-  defaultValue: ObjectType<T>;
-  mappers: {
-    boolean: T extends boolean
-      ? (value: boolean) => Partial<ObjectType<T>>
-      : never;
-    number: T extends number
-      ? (value: number) => Partial<ObjectType<T>>
-      : never;
-    object?: (value: Partial<ObjectType<T>>) => Partial<ObjectType<T>>;
-    string: T extends string
-      ? (value: string) => Partial<ObjectType<T>>
-      : never;
-  } extends infer U
-    ? { [K in keyof U as U[K] extends never ? never : K]: U[K] }
-    : never;
-  value: T;
-}) => ObjectType<T>;
+>(
+  args: {
+    defaultValue: ObjectType<T>;
+    value: T;
+  } & (IsObjectOnly<T> extends true
+    ? {
+        mappers?: MappersType<T>;
+      }
+    : {
+        mappers: MappersType<T>;
+      }),
+) => ObjectType<T>;
 
 const mergeResult = <T>(
   result: ObjectType<T>,
@@ -45,28 +56,32 @@ export const valueToObject: ValueToObject = ({
 
   switch (typeof value) {
     case 'boolean':
-      if ('boolean' in mappers) {
+      if (mappers && 'boolean' in mappers) {
         const mapper = mappers.boolean as (
           value: boolean,
         ) => Record<string, any>;
         result = mergeResult(result, mapper(value));
       }
       break;
     case 'number':
-      if ('number' in mappers) {
+      if (mappers && 'number' in mappers) {
         const mapper = mappers.number as (value: number) => Record<string, any>;
         result = mergeResult(result, mapper(value));
       }
       break;
     case 'string':
-      if ('string' in mappers) {
+      if (mappers && 'string' in mappers) {
         const mapper = mappers.string as (value: string) => Record<string, any>;
         result = mergeResult(result, mapper(value));
       }
       break;
     case 'object':
       if (value !== null) {
-        if ('object' in mappers && typeof mappers.object === 'function') {
+        if (
+          mappers &&
+          'object' in mappers &&
+          typeof mappers.object === 'function'
+        ) {
           const mapper = mappers.object as (
             value: Record<string, any>,
           ) => Partial<ObjectType<any>>;

packages/openapi-ts/src/plugins/zod/config.ts

@@ -15,6 +15,13 @@ export const defaultConfig: ZodPlugin['Config'] = {
   name: 'zod',
   output: 'zod',
   resolveConfig: (plugin, context) => {
+    plugin.config.dates = context.valueToObject({
+      defaultValue: {
+        offset: false,
+      },
+      value: plugin.config.dates,
+    });
+
     plugin.config.definitions = context.valueToObject({
       defaultValue: {
         case: plugin.config.case ?? 'camelCase',

packages/openapi-ts/src/plugins/zod/plugin.ts

@@ -455,8 +455,10 @@ const objectTypeToZodSchema = ({
 };
 
 const stringTypeToZodSchema = ({
+  plugin,
   schema,
 }: {
+  plugin: ZodPlugin['Instance'];
   schema: SchemaWithType<'string'>;
 }) => {
   if (typeof schema.const === 'string') {
@@ -485,6 +487,18 @@ const stringTypeToZodSchema = ({
             expression: stringExpression,
             name: compiler.identifier({ text: 'datetime' }),
           }),
+          parameters: plugin.config.dates.offset
+            ? [
+                compiler.objectExpression({
+                  obj: [
+                    {
+                      key: 'offset',
+                      value: true,
+                    },
+                  ],
+                }),
+              ]
+            : [],
         });
         break;
       case 'ipv4':
@@ -718,6 +732,7 @@ const schemaTypeToZodSchema = ({
     case 'string':
       return {
         expression: stringTypeToZodSchema({
+          plugin,
           schema: schema as SchemaWithType<'string'>,
         }),
       };

packages/openapi-ts/src/plugins/zod/types.d.ts

@@ -15,6 +15,23 @@ export type Config = Plugin.Name<'zod'> & {
    * @default true
    */
   comments?: boolean;
+  /**
+   * Configuration for date handling in generated Zod schemas.
+   *
+   * Controls how date values are processed and validated using Zod's
+   * date validation features.
+   */
+  dates?: {
+    /**
+     * Whether to include timezone offset information when handling dates.
+     *
+     * When enabled, date strings will preserve timezone information.
+     * When disabled, dates will be treated as local time.
+     *
+     * @default false
+     */
+    offset?: boolean;
+  };
   /**
    * Configuration for reusable schema definitions.
    *
@@ -156,6 +173,23 @@ export type ResolvedConfig = Plugin.Name<'zod'> & {
    * @default true
    */
   comments: boolean;
+  /**
+   * Configuration for date handling in generated Zod schemas.
+   *
+   * Controls how date values are processed and validated using Zod's
+   * date validation features.
+   */
+  dates: {
+    /**
+     * Whether to include timezone offset information when handling dates.
+     *
+     * When enabled, date strings will preserve timezone information.
+     * When disabled, dates will be treated as local time.
+     *
+     * @default false
+     */
+    offset: boolean;
+  };
   /**
    * Configuration for reusable schema definitions.
    *