Merge pull request #3813 from hey-api/copilot/fix-typescript-errors-zod-schemas

mrlubos · web-flow · commit 7b5359343be6 · 2026-04-25T20:13:31.000-04:00
fix(zod): fall back to `z.union()` when discriminated union members are `ZodIntersection`
diff --git a/.changeset/mean-paths-tell.md b/.changeset/mean-paths-tell.md
@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+**plugin(zod)**: fix: fallback `.discriminatedUnion` to `.union` if members contain intersection
diff --git a/packages/openapi-ts-tests/zod/v4/__snapshots__/3.0.x/mini/discriminator-allof-member/zod.gen.ts b/packages/openapi-ts-tests/zod/v4/__snapshots__/3.0.x/mini/discriminator-allof-member/zod.gen.ts
@@ -0,0 +1,37 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import * as z from 'zod/mini';
+
+export const zUserNotificationDeleteContentBase = z.object({
+    name: z.string()
+});
+
+export const zUserNotificationDeleteContentError = z.intersection(zUserNotificationDeleteContentBase, z.object({
+    finishedAt: z.iso.datetime(),
+    error: z.string()
+}));
+
+export const zUserNotificationDeleteContentRunning = z.intersection(zUserNotificationDeleteContentBase, z.object({
+    startedAt: z.iso.datetime()
+}));
+
+export const zUserNotificationDeleteContentSuccess = z.intersection(zUserNotificationDeleteContentBase, z.object({
+    finishedAt: z.iso.datetime()
+}));
+
+export const zUserNotificationDeleteContent = z.union([
+    z.intersection(z.object({
+        status: z.literal('running')
+    }), zUserNotificationDeleteContentRunning),
+    z.intersection(z.object({
+        status: z.literal('success')
+    }), zUserNotificationDeleteContentSuccess),
+    z.intersection(z.object({
+        status: z.literal('error')
+    }), zUserNotificationDeleteContentError)
+]);
+
+/**
+ * success
+ */
+export const zGetNotificationResponse = zUserNotificationDeleteContent;
diff --git a/packages/openapi-ts-tests/zod/v4/__snapshots__/3.0.x/v3/discriminator-allof-member/zod.gen.ts b/packages/openapi-ts-tests/zod/v4/__snapshots__/3.0.x/v3/discriminator-allof-member/zod.gen.ts
@@ -0,0 +1,37 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import { z } from 'zod/v3';
+
+export const zUserNotificationDeleteContentBase = z.object({
+    name: z.string()
+});
+
+export const zUserNotificationDeleteContentError = zUserNotificationDeleteContentBase.and(z.object({
+    finishedAt: z.string().datetime(),
+    error: z.string()
+}));
+
+export const zUserNotificationDeleteContentRunning = zUserNotificationDeleteContentBase.and(z.object({
+    startedAt: z.string().datetime()
+}));
+
+export const zUserNotificationDeleteContentSuccess = zUserNotificationDeleteContentBase.and(z.object({
+    finishedAt: z.string().datetime()
+}));
+
+export const zUserNotificationDeleteContent = z.union([
+    z.object({
+        status: z.literal('running')
+    }).and(zUserNotificationDeleteContentRunning),
+    z.object({
+        status: z.literal('success')
+    }).and(zUserNotificationDeleteContentSuccess),
+    z.object({
+        status: z.literal('error')
+    }).and(zUserNotificationDeleteContentError)
+]);
+
+/**
+ * success
+ */
+export const zGetNotificationResponse = zUserNotificationDeleteContent;
diff --git a/packages/openapi-ts-tests/zod/v4/__snapshots__/3.0.x/v4/discriminator-allof-member/zod.gen.ts b/packages/openapi-ts-tests/zod/v4/__snapshots__/3.0.x/v4/discriminator-allof-member/zod.gen.ts
@@ -0,0 +1,37 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import * as z from 'zod';
+
+export const zUserNotificationDeleteContentBase = z.object({
+    name: z.string()
+});
+
+export const zUserNotificationDeleteContentError = zUserNotificationDeleteContentBase.and(z.object({
+    finishedAt: z.iso.datetime(),
+    error: z.string()
+}));
+
+export const zUserNotificationDeleteContentRunning = zUserNotificationDeleteContentBase.and(z.object({
+    startedAt: z.iso.datetime()
+}));
+
+export const zUserNotificationDeleteContentSuccess = zUserNotificationDeleteContentBase.and(z.object({
+    finishedAt: z.iso.datetime()
+}));
+
+export const zUserNotificationDeleteContent = z.union([
+    z.object({
+        status: z.literal('running')
+    }).and(zUserNotificationDeleteContentRunning),
+    z.object({
+        status: z.literal('success')
+    }).and(zUserNotificationDeleteContentSuccess),
+    z.object({
+        status: z.literal('error')
+    }).and(zUserNotificationDeleteContentError)
+]);
+
+/**
+ * success
+ */
+export const zGetNotificationResponse = zUserNotificationDeleteContent;
diff --git a/packages/openapi-ts-tests/zod/v4/__snapshots__/3.1.x/mini/discriminator-allof-member/zod.gen.ts b/packages/openapi-ts-tests/zod/v4/__snapshots__/3.1.x/mini/discriminator-allof-member/zod.gen.ts
@@ -0,0 +1,37 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import * as z from 'zod/mini';
+
+export const zUserNotificationDeleteContentBase = z.object({
+    name: z.string()
+});
+
+export const zUserNotificationDeleteContentError = z.intersection(zUserNotificationDeleteContentBase, z.object({
+    finishedAt: z.iso.datetime(),
+    error: z.string()
+}));
+
+export const zUserNotificationDeleteContentRunning = z.intersection(zUserNotificationDeleteContentBase, z.object({
+    startedAt: z.iso.datetime()
+}));
+
+export const zUserNotificationDeleteContentSuccess = z.intersection(zUserNotificationDeleteContentBase, z.object({
+    finishedAt: z.iso.datetime()
+}));
+
+export const zUserNotificationDeleteContent = z.union([
+    z.intersection(z.object({
+        status: z.literal('running')
+    }), zUserNotificationDeleteContentRunning),
+    z.intersection(z.object({
+        status: z.literal('success')
+    }), zUserNotificationDeleteContentSuccess),
+    z.intersection(z.object({
+        status: z.literal('error')
+    }), zUserNotificationDeleteContentError)
+]);
+
+/**
+ * success
+ */
+export const zGetNotificationResponse = zUserNotificationDeleteContent;
diff --git a/packages/openapi-ts-tests/zod/v4/__snapshots__/3.1.x/v3/discriminator-allof-member/zod.gen.ts b/packages/openapi-ts-tests/zod/v4/__snapshots__/3.1.x/v3/discriminator-allof-member/zod.gen.ts
@@ -0,0 +1,37 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import { z } from 'zod/v3';
+
+export const zUserNotificationDeleteContentBase = z.object({
+    name: z.string()
+});
+
+export const zUserNotificationDeleteContentError = zUserNotificationDeleteContentBase.and(z.object({
+    finishedAt: z.string().datetime(),
+    error: z.string()
+}));
+
+export const zUserNotificationDeleteContentRunning = zUserNotificationDeleteContentBase.and(z.object({
+    startedAt: z.string().datetime()
+}));
+
+export const zUserNotificationDeleteContentSuccess = zUserNotificationDeleteContentBase.and(z.object({
+    finishedAt: z.string().datetime()
+}));
+
+export const zUserNotificationDeleteContent = z.union([
+    z.object({
+        status: z.literal('running')
+    }).and(zUserNotificationDeleteContentRunning),
+    z.object({
+        status: z.literal('success')
+    }).and(zUserNotificationDeleteContentSuccess),
+    z.object({
+        status: z.literal('error')
+    }).and(zUserNotificationDeleteContentError)
+]);
+
+/**
+ * success
+ */
+export const zGetNotificationResponse = zUserNotificationDeleteContent;
diff --git a/packages/openapi-ts-tests/zod/v4/__snapshots__/3.1.x/v4/discriminator-allof-member/zod.gen.ts b/packages/openapi-ts-tests/zod/v4/__snapshots__/3.1.x/v4/discriminator-allof-member/zod.gen.ts
@@ -0,0 +1,37 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import * as z from 'zod';
+
+export const zUserNotificationDeleteContentBase = z.object({
+    name: z.string()
+});
+
+export const zUserNotificationDeleteContentError = zUserNotificationDeleteContentBase.and(z.object({
+    finishedAt: z.iso.datetime(),
+    error: z.string()
+}));
+
+export const zUserNotificationDeleteContentRunning = zUserNotificationDeleteContentBase.and(z.object({
+    startedAt: z.iso.datetime()
+}));
+
+export const zUserNotificationDeleteContentSuccess = zUserNotificationDeleteContentBase.and(z.object({
+    finishedAt: z.iso.datetime()
+}));
+
+export const zUserNotificationDeleteContent = z.union([
+    z.object({
+        status: z.literal('running')
+    }).and(zUserNotificationDeleteContentRunning),
+    z.object({
+        status: z.literal('success')
+    }).and(zUserNotificationDeleteContentSuccess),
+    z.object({
+        status: z.literal('error')
+    }).and(zUserNotificationDeleteContentError)
+]);
+
+/**
+ * success
+ */
+export const zGetNotificationResponse = zUserNotificationDeleteContent;
diff --git a/packages/openapi-ts-tests/zod/v4/test/3.0.x.test.ts b/packages/openapi-ts-tests/zod/v4/test/3.0.x.test.ts
@@ -34,6 +34,14 @@ for (const zodVersion of zodVersions) {
         }),
         description: 'generates circular schemas',
       },
+      {
+        config: createConfig({
+          input: 'discriminator-allof-member.yaml',
+          output: 'discriminator-allof-member',
+        }),
+        description:
+          'falls back to z.union() when discriminated union members have allOf (intersection)',
+      },
       {
         config: createConfig({
           input: 'enum-null.json',
diff --git a/packages/openapi-ts-tests/zod/v4/test/3.1.x.test.ts b/packages/openapi-ts-tests/zod/v4/test/3.1.x.test.ts
@@ -163,6 +163,14 @@ for (const zodVersion of zodVersions) {
         }),
         description: 'generates discriminated union for oneOf with discriminator mapping',
       },
+      {
+        config: createConfig({
+          input: 'discriminator-allof-member.yaml',
+          output: 'discriminator-allof-member',
+        }),
+        description:
+          'falls back to z.union() when discriminated union members have allOf (intersection)',
+      },
       {
         config: createConfig({
           input: 'discriminator-any-of.yaml',
diff --git a/packages/openapi-ts/src/plugins/zod/mini/processor.ts b/packages/openapi-ts/src/plugins/zod/mini/processor.ts
@@ -56,7 +56,12 @@ export function createProcessor(plugin: ZodPlugin['Instance']): ProcessorResult
       }) as ZodFinal;
 
       if (shouldExport) {
-        exportAst({ ...ctx, final, plugin });
+        exportAst({
+          ...ctx,
+          final,
+          meta: result.meta.isIntersection ? { ...ctx.meta, isIntersection: true } : ctx.meta,
+          plugin,
+        });
         return;
       }
 
diff --git a/packages/openapi-ts/src/plugins/zod/mini/walker.ts b/packages/openapi-ts/src/plugins/zod/mini/walker.ts
@@ -152,6 +152,7 @@ export function createVisitor(
           default: parentSchema.default,
           format: parentSchema.format,
           hasLazy: hasAnyLazy,
+          isIntersection: true,
           isLazy: false,
           nullable: items.some((i) => i.meta.nullable),
           readonly: items.some((i) => i.meta.readonly),
@@ -328,6 +329,7 @@ export function createVisitor(
           default: parentSchema.default,
           format: parentSchema.format,
           hasLazy: hasAnyLazy,
+          isIntersection: false,
           isLazy: false,
           nullable: hasNull,
           readonly: items.some((i) => i.meta.readonly),
diff --git a/packages/openapi-ts/src/plugins/zod/shared/discriminated-union.ts b/packages/openapi-ts/src/plugins/zod/shared/discriminated-union.ts
@@ -4,7 +4,7 @@ import type { IR } from '@hey-api/shared';
 import { $ } from '../../../ts-dsl';
 import type { ZodPlugin } from '../types';
 import type { Chain } from './chain';
-import type { ZodResult } from './types';
+import type { ZodMeta, ZodResult } from './types';
 
 export interface DiscriminatedUnionMember {
   discriminatedValue: unknown;
@@ -47,6 +47,7 @@ export function tryBuildDiscriminatedUnion({
 
     let refExpression: Chain;
     if (refPart.symbolRef) {
+      if ((refPart.symbolRef.meta as unknown as ZodMeta)?.isIntersection) return null;
       refExpression = $(refPart.symbolRef);
     } else if (refPart.$ref) {
       const query: SymbolMeta = {
@@ -55,6 +56,7 @@ export function tryBuildDiscriminatedUnion({
         resourceId: refPart.$ref,
         tool: 'zod',
       };
+      if ((plugin.querySymbol(query)?.meta as unknown as ZodMeta)?.isIntersection) return null;
       refExpression = $(plugin.referenceSymbol(query));
     } else {
       return null;
diff --git a/packages/openapi-ts/src/plugins/zod/shared/meta.ts b/packages/openapi-ts/src/plugins/zod/shared/meta.ts
@@ -10,6 +10,7 @@ export function defaultMeta(schema: IR.SchemaObject): ZodMeta {
     default: schema.default,
     format: schema.format,
     hasLazy: false,
+    isIntersection: false,
     isLazy: false,
     isObject: false,
     nullable: false,
@@ -31,6 +32,7 @@ export function composeMeta(
     default: overrides?.default,
     format: overrides?.format,
     hasLazy: overrides?.hasLazy ?? children.some((c) => c.meta.hasLazy),
+    isIntersection: overrides?.isIntersection ?? false,
     isLazy: overrides?.isLazy ?? children.some((c) => c.meta.isLazy),
     isObject: overrides?.isObject ?? children.some((c) => c.meta.isObject),
     nullable: overrides?.nullable ?? children.some((c) => c.meta.nullable),
diff --git a/packages/openapi-ts/src/plugins/zod/shared/types.ts b/packages/openapi-ts/src/plugins/zod/shared/types.ts
@@ -28,6 +28,8 @@ export interface ZodMeta {
   format?: string;
   /** Whether this or any child contains a lazy reference. */
   hasLazy: boolean;
+  /** Whether this schema generates a ZodIntersection (e.g. via allOf). */
+  isIntersection: boolean;
   /** Whether this schema itself is emitted as lazy. */
   isLazy: boolean;
   /** Whether this schema resolves to an object shape. */
diff --git a/packages/openapi-ts/src/plugins/zod/v3/processor.ts b/packages/openapi-ts/src/plugins/zod/v3/processor.ts
@@ -56,7 +56,12 @@ export function createProcessor(plugin: ZodPlugin['Instance']): ProcessorResult
       }) as ZodFinal;
 
       if (shouldExport) {
-        exportAst({ ...ctx, final, plugin });
+        exportAst({
+          ...ctx,
+          final,
+          meta: result.meta.isIntersection ? { ...ctx.meta, isIntersection: true } : ctx.meta,
+          plugin,
+        });
         return;
       }
 
diff --git a/packages/openapi-ts/src/plugins/zod/v3/walker.ts b/packages/openapi-ts/src/plugins/zod/v3/walker.ts
@@ -156,6 +156,7 @@ export function createVisitor(
           default: parentSchema.default,
           format: parentSchema.format,
           hasLazy: hasAnyLazy,
+          isIntersection: true,
           isLazy: false,
           nullable: items.some((i) => i.meta.nullable),
           readonly: items.some((i) => i.meta.readonly),
@@ -316,6 +317,7 @@ export function createVisitor(
           default: parentSchema.default,
           format: parentSchema.format,
           hasLazy: hasAnyLazy,
+          isIntersection: false,
           isLazy: false,
           nullable: hasNull,
           readonly: items.some((i) => i.meta.readonly),
diff --git a/packages/openapi-ts/src/plugins/zod/v4/processor.ts b/packages/openapi-ts/src/plugins/zod/v4/processor.ts
@@ -56,7 +56,12 @@ export function createProcessor(plugin: ZodPlugin['Instance']): ProcessorResult
       }) as ZodFinal;
 
       if (shouldExport) {
-        exportAst({ ...ctx, final, plugin });
+        exportAst({
+          ...ctx,
+          final,
+          meta: result.meta.isIntersection ? { ...ctx.meta, isIntersection: true } : ctx.meta,
+          plugin,
+        });
         return;
       }
 
diff --git a/packages/openapi-ts/src/plugins/zod/v4/walker.ts b/packages/openapi-ts/src/plugins/zod/v4/walker.ts
diff --git a/specs/3.0.x/discriminator-allof-member.yaml b/specs/3.0.x/discriminator-allof-member.yaml
diff --git a/specs/3.1.x/discriminator-allof-member.yaml b/specs/3.1.x/discriminator-allof-member.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@hey-api/openapi-ts": patch
 +---
++
 +**plugin(zod)**: fix: fallback `.discriminatedUnion` to `.union` if members contain intersection