Merge pull request #3552 from erikwski/main

fix(zod): support `guid` format in Zod v4/mini

Author: mrlubos

.changeset/cyan-boats-type.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+**plugin(zod)**: handle `guid` string format

packages/openapi-ts-tests/zod/v4/__snapshots__/3.1.x/mini/string-with-guid-format/zod.gen.ts

@@ -0,0 +1,11 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import * as z from 'zod/mini';
+
+export const zGetFooData = z.object({
+    body: z.optional(z.never()),
+    path: z.object({
+        guidId: z.guid()
+    }),
+    query: z.optional(z.never())
+});

packages/openapi-ts-tests/zod/v4/__snapshots__/3.1.x/v3/string-with-guid-format/zod.gen.ts

@@ -0,0 +1,11 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import { z } from 'zod/v3';
+
+export const zGetFooData = z.object({
+    body: z.never().optional(),
+    path: z.object({
+        guidId: z.string()
+    }),
+    query: z.never().optional()
+});

packages/openapi-ts-tests/zod/v4/__snapshots__/3.1.x/v4/string-with-guid-format/zod.gen.ts

@@ -0,0 +1,11 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import * as z from 'zod';
+
+export const zGetFooData = z.object({
+    body: z.never().optional(),
+    path: z.object({
+        guidId: z.guid()
+    }),
+    query: z.never().optional()
+});

packages/openapi-ts-tests/zod/v4/test/formats.test.ts

@@ -46,6 +46,19 @@ for (const zodVersion of zodVersions) {
         }),
         description: 'generates anyOf string and binary string',
       },
+      {
+        config: createConfig({
+          input: 'string-with-guid-format.yaml',
+          output: 'string-with-guid-format',
+          plugins: [
+            {
+              compatibilityVersion: zodVersion.compatibilityVersion,
+              name: 'zod',
+            },
+          ],
+        }),
+        description: 'handles string guid format',
+      },
     ];
 
     it.each(scenarios)('$description', async ({ config }) => {

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

@@ -20,6 +20,7 @@ export const identifiers = {
   globalRegistry: 'globalRegistry',
   gt: 'gt',
   gte: 'gte',
+  guid: 'guid',
   infer: 'infer',
   int: 'int',
   intersection: 'intersection',

packages/openapi-ts/src/plugins/zod/mini/toAst/string.ts

@@ -36,6 +36,8 @@ function formatNode(ctx: StringResolverContext): ChainResult {
     }
     case 'email':
       return $(z).attr(identifiers.email).call();
+    case 'guid':
+      return $(z).attr(identifiers.guid).call();
     case 'ipv4':
       return $(z).attr(identifiers.ipv4).call();
     case 'ipv6':

packages/openapi-ts/src/plugins/zod/v4/toAst/string.ts

@@ -36,6 +36,8 @@ function formatNode(ctx: StringResolverContext): ChainResult {
     }
     case 'email':
       return $(z).attr(identifiers.email).call();
+    case 'guid':
+      return $(z).attr(identifiers.guid).call();
     case 'ipv4':
       return $(z).attr(identifiers.ipv4).call();
     case 'ipv6':

specs/3.1.x/string-with-guid-format.yaml

@@ -0,0 +1,18 @@
+openapi: 3.1.1
+info:
+  title: OpenAPI 3.1.1 string with GUID format example
+  version: '1'
+paths:
+  /foo/{guidId}:
+    get:
+      operationId: getFoo
+      parameters:
+        - name: guidId
+          in: path
+          required: true
+          schema:
+            type: string
+            format: guid
+      responses:
+        '200':
+          description: OK