Merge pull request #3780 from hey-api/copilot/generate-discriminated-union-types

feat(zod,valibot): generate discriminated unions for oneOf/anyOf with discriminator mapping

Author: mrlubos

.changeset/hip-foxes-count.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+**plugin(zod)**: add support for `.discriminatedUnion()`

.changeset/moody-wings-punch.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+**plugin(valibot)**: add support for `.variant()`

packages/openapi-ts-tests/valibot/v1/__snapshots__/3.1.x/discriminator-all-of/valibot.gen.ts

@@ -0,0 +1,59 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import * as v from 'valibot';
+
+export const vFoo = v.object({
+    id: v.string()
+});
+
+export const vBar = v.intersect([vFoo, v.object({
+        bar: v.optional(v.string()),
+        id: v.literal('Bar')
+    })]);
+
+export const vBaz = v.intersect([vFoo, v.object({
+        baz: v.optional(v.string()),
+        id: v.literal('Baz')
+    })]);
+
+export const vQux = v.intersect([vFoo, v.object({
+        qux: v.optional(v.boolean()),
+        id: v.literal('Qux')
+    })]);
+
+export const vFooMapped = v.object({
+    id: v.string()
+});
+
+export const vBarMapped = v.intersect([vFooMapped, v.object({
+        bar: v.optional(v.string()),
+        id: v.literal('bar')
+    })]);
+
+export const vBazMapped = v.intersect([vFooMapped, v.object({
+        baz: v.optional(v.string()),
+        id: v.literal('baz')
+    })]);
+
+export const vQuxMapped = v.intersect([vFooMapped, v.object({
+        qux: v.optional(v.boolean()),
+        id: v.literal('QuxMapped')
+    })]);
+
+export const vBarUnion = v.object({
+    id: v.optional(v.string()),
+    bar: v.optional(v.string())
+});
+
+export const vBazUnion = v.object({
+    id: v.optional(v.string()),
+    baz: v.optional(v.string())
+});
+
+export const vFooUnion = v.union([v.intersect([v.object({
+            id: v.literal('bar')
+        }), vBarUnion]), v.intersect([v.object({
+            id: v.literal('baz')
+        }), vBazUnion])]);
+
+export const vQuxExtend = vFooUnion;

packages/openapi-ts-tests/valibot/v1/__snapshots__/3.1.x/discriminator-any-of/valibot.gen.ts

@@ -0,0 +1,34 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import * as v from 'valibot';
+
+export const vQuux = v.picklist(['Bar', 'Baz']);
+
+export const vQux = v.object({
+    id: v.string(),
+    type: vQuux
+});
+
+export const vBaz = vQux;
+
+export const vBar = vQux;
+
+export const vFoo = v.union([v.intersect([v.object({
+            type: v.optional(v.literal('Bar'))
+        }), vBar]), v.intersect([v.object({
+            type: v.optional(v.literal('Baz'))
+        }), vBaz])]);
+
+export const vSpæcial = vQux;
+
+export const vQuuz = v.union([
+    v.intersect([v.object({
+            type: v.optional(v.literal('bar'))
+        }), vBar]),
+    v.intersect([v.object({
+            type: v.optional(v.literal('baz'))
+        }), vBaz]),
+    v.intersect([v.object({
+            type: v.optional(v.literal('non-ascii'))
+        }), vSpæcial])
+]);

packages/openapi-ts-tests/valibot/v1/__snapshots__/3.1.x/discriminator-one-of/valibot.gen.ts

@@ -0,0 +1,34 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import * as v from 'valibot';
+
+export const vQuux = v.picklist(['Bar', 'Baz']);
+
+export const vQux = v.object({
+    id: v.string(),
+    type: vQuux
+});
+
+export const vBaz = vQux;
+
+export const vBar = vQux;
+
+export const vFoo = v.union([v.intersect([v.object({
+            type: v.literal('Bar')
+        }), vBar]), v.intersect([v.object({
+            type: v.literal('Baz')
+        }), vBaz])]);
+
+export const vSpæcial = vQux;
+
+export const vQuuz = v.union([
+    v.intersect([v.object({
+            type: v.literal('bar')
+        }), vBar]),
+    v.intersect([v.object({
+            type: v.literal('baz')
+        }), vBaz]),
+    v.intersect([v.object({
+            type: v.literal('non-ascii')
+        }), vSpæcial])
+]);

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

@@ -130,6 +130,27 @@ describe(`OpenAPI ${version}`, () => {
       }),
       description: 'anyOf string and binary string',
     },
+    {
+      config: createConfig({
+        input: 'discriminator-all-of.yaml',
+        output: 'discriminator-all-of',
+      }),
+      description: 'generates discriminated union for oneOf with discriminator mapping',
+    },
+    {
+      config: createConfig({
+        input: 'discriminator-any-of.yaml',
+        output: 'discriminator-any-of',
+      }),
+      description: 'generates discriminated union for anyOf with discriminator mapping',
+    },
+    {
+      config: createConfig({
+        input: 'discriminator-one-of.yaml',
+        output: 'discriminator-one-of',
+      }),
+      description: 'generates discriminated union for oneOf discriminator mapping',
+    },
     {
       config: createConfig({
         input: 'time-format.yaml',

packages/openapi-ts-tests/zod/v3/__snapshots__/3.0.x/mini/default/zod.gen.ts

@@ -423,13 +423,9 @@ export const zModelSquare = z.object({
 /**
  * This is a model with one property with a 'one of' relationship where the options are not $ref
  */
-export const zCompositionWithOneOfDiscriminator = z.union([
-    z.intersection(z.object({
-        kind: z.literal('circle')
-    }), zModelCircle),
-    z.intersection(z.object({
-        kind: z.literal('square')
-    }), zModelSquare)
+export const zCompositionWithOneOfDiscriminator = z.discriminatedUnion('kind', [
+    z.extend(zModelCircle, { kind: z.literal('circle') }),
+    z.extend(zModelSquare, { kind: z.literal('square') })
 ]);
 
 /**

packages/openapi-ts-tests/zod/v3/__snapshots__/3.0.x/v3/default/zod.gen.ts

@@ -423,13 +423,9 @@ export const zModelSquare = z.object({
 /**
  * This is a model with one property with a 'one of' relationship where the options are not $ref
  */
-export const zCompositionWithOneOfDiscriminator = z.union([
-    z.object({
-        kind: z.literal('circle')
-    }).and(zModelCircle),
-    z.object({
-        kind: z.literal('square')
-    }).and(zModelSquare)
+export const zCompositionWithOneOfDiscriminator = z.discriminatedUnion('kind', [
+    zModelCircle.extend({ kind: z.literal('circle') }),
+    zModelSquare.extend({ kind: z.literal('square') })
 ]);
 
 /**

packages/openapi-ts-tests/zod/v3/__snapshots__/3.0.x/v4/default/zod.gen.ts

@@ -423,13 +423,9 @@ export const zModelSquare = z.object({
 /**
  * This is a model with one property with a 'one of' relationship where the options are not $ref
  */
-export const zCompositionWithOneOfDiscriminator = z.union([
-    z.object({
-        kind: z.literal('circle')
-    }).and(zModelCircle),
-    z.object({
-        kind: z.literal('square')
-    }).and(zModelSquare)
+export const zCompositionWithOneOfDiscriminator = z.discriminatedUnion('kind', [
+    zModelCircle.extend({ kind: z.literal('circle') }),
+    zModelSquare.extend({ kind: z.literal('square') })
 ]);
 
 /**

packages/openapi-ts-tests/zod/v3/__snapshots__/3.1.x/mini/default/zod.gen.ts

@@ -423,13 +423,9 @@ export const zModelSquare = z.object({
 /**
  * This is a model with one property with a 'one of' relationship where the options are not $ref
  */
-export const zCompositionWithOneOfDiscriminator = z.union([
-    z.intersection(z.object({
-        kind: z.literal('circle')
-    }), zModelCircle),
-    z.intersection(z.object({
-        kind: z.literal('square')
-    }), zModelSquare)
+export const zCompositionWithOneOfDiscriminator = z.discriminatedUnion('kind', [
+    z.extend(zModelCircle, { kind: z.literal('circle') }),
+    z.extend(zModelSquare, { kind: z.literal('square') })
 ]);
 
 /**