feat(zod): add types option

Author: mrlubos

docs/openapi-ts/plugins/zod.md

@@ -72,7 +72,23 @@ The Zod plugin will generate the following artifacts, depending on the input spe
 
 A single request schema is generated for each endpoint. It may contain a request body, parameters, and headers.
 
-```ts
+::: code-group
+
+```js [config]
+export default {
+  input: 'https://get.heyapi.dev/hey-api/backend',
+  output: 'src/client',
+  plugins: [
+    // ...other plugins
+    {
+      name: 'zod',
+      requests: true, // [!code ++]
+    },
+  ],
+};
+```
+
+```ts [output]
 const zData = z.object({
   body: z
     .object({
@@ -87,6 +103,8 @@ const zData = z.object({
 });
 ```
 
+:::
+
 ::: tip
 If you need to access individual fields, you can do so using the [`.shape`](https://zod.dev/api?id=shape) API. For example, we can get the request body schema with `zData.shape.body`.
 :::
@@ -97,7 +115,23 @@ You can customize the naming and casing pattern for `requests` schemas using the
 
 A single Zod schema is generated for all endpoint's responses. If the endpoint describes multiple responses, the generated schema is a union of all possible response shapes.
 
-```ts
+::: code-group
+
+```js [config]
+export default {
+  input: 'https://get.heyapi.dev/hey-api/backend',
+  output: 'src/client',
+  plugins: [
+    // ...other plugins
+    {
+      name: 'zod',
+      responses: true, // [!code ++]
+    },
+  ],
+};
+```
+
+```ts [output]
 const zResponse = z.union([
   z.object({
     foo: z.string().optional(),
@@ -108,40 +142,103 @@ const zResponse = z.union([
 ]);
 ```
 
+:::
+
 You can customize the naming and casing pattern for `responses` schemas using the `.name` and `.case` options.
 
 ## Definitions
 
 A Zod schema is generated for every reusable definition from your input.
 
-```ts
+::: code-group
+
+```js [config]
+export default {
+  input: 'https://get.heyapi.dev/hey-api/backend',
+  output: 'src/client',
+  plugins: [
+    // ...other plugins
+    {
+      name: 'zod',
+      definitions: true, // [!code ++]
+    },
+  ],
+};
+```
+
+```ts [output]
 const zFoo = z.number().int();
 
 const zBar = z.object({
   bar: z.array(z.number().int()).optional(),
 });
 ```
 
+:::
+
 You can customize the naming and casing pattern for `definitions` schemas using the `.name` and `.case` options.
 
 ## Metadata
 
 It's often useful to associate a schema with some additional [metadata](https://zod.dev/metadata) for documentation, code generation, AI structured outputs, form validation, and other purposes. If this is your use case, you can set `metadata` to `true` to generate additional metadata about schemas.
 
-```js
+::: code-group
+
+```js [config]
 export default {
   input: 'https://get.heyapi.dev/hey-api/backend',
   output: 'src/client',
   plugins: [
     // ...other plugins
     {
+      name: 'zod',
       metadata: true, // [!code ++]
+    },
+  ],
+};
+```
+
+```ts [output]
+export const zFoo = z.string().describe('Additional metadata');
+```
+
+:::
+
+## Types
+
+In addition to Zod schemas, you can generate schema-specific types. These can be generated for all schemas or for specific resources.
+
+::: code-group
+
+```js [config]
+export default {
+  input: 'https://get.heyapi.dev/hey-api/backend',
+  output: 'src/client',
+  plugins: [
+    // ...other plugins
+    {
       name: 'zod',
+      types: {
+        infer: false, // by default, no `z.infer` types [!code ++]
+      },
+      responses: {
+        types: {
+          infer: true, // `z.infer` types only for response schemas [!code ++]
+        },
+      },
     },
   ],
 };
 ```
 
+```ts [output]
+export type ResponseZodType = z.infer<typeof zResponse>;
+```
+
+:::
+
+You can customize the naming and casing pattern for schema-specific `types` using the `.name` and `.case` options.
+
 ## Config API
 
 You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/zod/types.d.ts) interface.

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

@@ -782,6 +782,24 @@ describe(`OpenAPI ${version}`, () => {
       }),
       description: 'generates validator schemas with metadata',
     },
+    {
+      config: createConfig({
+        input: 'validators.yaml',
+        output: 'validators-types',
+        plugins: [
+          {
+            name: 'valibot',
+          },
+          {
+            name: 'zod',
+            types: {
+              infer: true,
+            },
+          },
+        ],
+      }),
+      description: 'generates validator schemas with types',
+    },
     {
       config: createConfig({
         input: 'validators-bigint-min-max.json',

packages/openapi-ts-tests/test/__snapshots__/3.1.x/validators-types/valibot.gen.ts

@@ -0,0 +1,64 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import * as v from 'valibot';
+
+/**
+ * This is Bar schema.
+ */
+export const vBar: v.GenericSchema = v.object({
+    foo: v.optional(v.lazy(() => {
+        return vFoo;
+    }))
+});
+
+/**
+ * This is Foo schema.
+ */
+export const vFoo: v.GenericSchema = v.optional(v.union([
+    v.object({
+        foo: v.optional(v.pipe(v.string(), v.regex(/^\d{3}-\d{2}-\d{4}$/))),
+        bar: v.optional(vBar),
+        baz: v.optional(v.array(v.lazy(() => {
+            return vFoo;
+        }))),
+        qux: v.optional(v.pipe(v.number(), v.integer(), v.gtValue(0)), 0)
+    }),
+    v.null()
+]), null);
+
+export const vBaz = v.optional(v.pipe(v.pipe(v.string(), v.regex(/foo\nbar/)), v.readonly()), 'baz');
+
+export const vQux = v.record(v.string(), v.object({
+    qux: v.optional(v.string())
+}));
+
+/**
+ * This is Foo parameter.
+ */
+export const vFoo2 = v.string();
+
+export const vFoo3 = v.object({
+    foo: v.optional(vBar)
+});
+
+export const vPatchFooData = v.object({
+    body: v.object({
+        foo: v.optional(v.string())
+    }),
+    path: v.optional(v.never()),
+    query: v.optional(v.object({
+        foo: v.optional(v.string()),
+        bar: v.optional(vBar),
+        baz: v.optional(v.object({
+            baz: v.optional(v.string())
+        })),
+        qux: v.optional(v.pipe(v.string(), v.isoDate())),
+        quux: v.optional(v.pipe(v.string(), v.isoTimestamp()))
+    }))
+});
+
+export const vPostFooData = v.object({
+    body: vFoo3,
+    path: v.optional(v.never()),
+    query: v.optional(v.never())
+});

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

@@ -0,0 +1,80 @@
+// 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()
+});
+
+export type BarZodType = z.infer<typeof zBar>;
+
+/**
+ * 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 type FooZodType = z.infer<typeof zFoo>;
+
+export const zBaz = z.string().regex(/foo\nbar/).readonly().default('baz');
+
+export type BazZodType = z.infer<typeof zBaz>;
+
+export const zQux = z.record(z.object({
+    qux: z.string().optional()
+}));
+
+export type QuxZodType = z.infer<typeof zQux>;
+
+/**
+ * This is Foo parameter.
+ */
+export const zFoo2 = z.string();
+
+export type FooZodType2 = z.infer<typeof zFoo2>;
+
+export const zFoo3 = z.object({
+    foo: zBar.optional()
+});
+
+export type FooZodType3 = z.infer<typeof zFoo3>;
+
+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().optional()
+    }).optional()
+});
+
+export type PatchFooDataZodType = z.infer<typeof zPatchFooData>;
+
+export const zPostFooData = z.object({
+    body: zFoo3,
+    path: z.never().optional(),
+    query: z.never().optional()
+});
+
+export type PostFooDataZodType = z.infer<typeof zPostFooData>;