fix: handle discriminator with multiple mappings to the same schema

mrlubos · mrlubos · commit dbebff8dcba4 · 2025-04-28T03:55:40.000+02:00
diff --git a/.changeset/twenty-gifts-battle.md b/.changeset/twenty-gifts-battle.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: handle discriminator with multiple mappings to the same schema
diff --git a/packages/openapi-ts-tests/test/3.0.x.test.ts b/packages/openapi-ts-tests/test/3.0.x.test.ts
@@ -166,6 +166,13 @@ describe(`OpenAPI ${version}`, () => {
       }),
       description: 'handles discriminator with and without mapping',
     },
+    {
+      config: createConfig({
+        input: 'discriminator-mapped-many.yaml',
+        output: 'discriminator-mapped-many',
+      }),
+      description: 'handles discriminator with multiple mappings',
+    },
     {
       config: createConfig({
         input: 'discriminator-one-of.yaml',
diff --git a/packages/openapi-ts-tests/test/3.1.x.test.ts b/packages/openapi-ts-tests/test/3.1.x.test.ts
@@ -173,6 +173,13 @@ describe(`OpenAPI ${version}`, () => {
       }),
       description: 'handles discriminator with and without mapping',
     },
+    {
+      config: createConfig({
+        input: 'discriminator-mapped-many.yaml',
+        output: 'discriminator-mapped-many',
+      }),
+      description: 'handles discriminator with multiple mappings',
+    },
     {
       config: createConfig({
         input: 'discriminator-one-of.yaml',
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.0.x/discriminator-mapped-many/index.ts b/packages/openapi-ts-tests/test/__snapshots__/3.0.x/discriminator-mapped-many/index.ts
@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.0.x/discriminator-mapped-many/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.0.x/discriminator-mapped-many/types.gen.ts
@@ -0,0 +1,19 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type Foo = ({
+    foo?: 'one' | 'two';
+} & Bar) | ({
+    foo?: 'three';
+} & Baz);
+
+export type Bar = {
+    foo?: 'one' | 'two';
+};
+
+export type Baz = {
+    foo?: 'three';
+};
+
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.1.x/discriminator-mapped-many/index.ts b/packages/openapi-ts-tests/test/__snapshots__/3.1.x/discriminator-mapped-many/index.ts
@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.1.x/discriminator-mapped-many/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.1.x/discriminator-mapped-many/types.gen.ts
@@ -0,0 +1,19 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type Foo = ({
+    foo?: 'one' | 'two';
+} & Bar) | ({
+    foo?: 'three';
+} & Baz);
+
+export type Bar = {
+    foo?: 'one' | 'two';
+};
+
+export type Baz = {
+    foo?: 'three';
+};
+
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};
diff --git a/packages/openapi-ts-tests/test/openapi-ts.config.ts b/packages/openapi-ts-tests/test/openapi-ts.config.ts
@@ -36,7 +36,12 @@ export default defineConfig(() => {
       //   openapi: '3.1.0',
       //   paths: {},
       // },
-      path: path.resolve(__dirname, 'spec', '3.1.x', 'enum-null.json'),
+      path: path.resolve(
+        __dirname,
+        'spec',
+        '3.1.x',
+        'discriminator-mapped-many.yaml',
+      ),
       // path: 'http://localhost:4000/',
       // path: 'https://get.heyapi.dev/',
       // path: 'https://get.heyapi.dev/hey-api/backend?branch=main&version=1.0.0',
diff --git a/packages/openapi-ts-tests/test/spec/3.0.x/discriminator-mapped-many.yaml b/packages/openapi-ts-tests/test/spec/3.0.x/discriminator-mapped-many.yaml
@@ -0,0 +1,31 @@
+openapi: 3.0.0
+info:
+  title: OpenAPI 3.0.0 discriminator mapped many example
+  version: 1
+components:
+  schemas:
+    Foo:
+      oneOf:
+        - $ref: '#/components/schemas/Bar'
+        - $ref: '#/components/schemas/Baz'
+      discriminator:
+        propertyName: foo
+        mapping:
+          one: '#/components/schemas/Bar'
+          two: '#/components/schemas/Bar'
+          three: '#/components/schemas/Baz'
+    Bar:
+      type: object
+      properties:
+        foo:
+          type: string
+          enum:
+            - one
+            - two
+    Baz:
+      type: object
+      properties:
+        foo:
+          type: string
+          enum:
+            - three
diff --git a/packages/openapi-ts-tests/test/spec/3.1.x/discriminator-mapped-many.yaml b/packages/openapi-ts-tests/test/spec/3.1.x/discriminator-mapped-many.yaml
@@ -0,0 +1,31 @@
+openapi: 3.1.0
+info:
+  title: OpenAPI 3.1.0 discriminator mapped many example
+  version: 1
+components:
+  schemas:
+    Foo:
+      oneOf:
+        - $ref: '#/components/schemas/Bar'
+        - $ref: '#/components/schemas/Baz'
+      discriminator:
+        propertyName: foo
+        mapping:
+          one: '#/components/schemas/Bar'
+          two: '#/components/schemas/Bar'
+          three: '#/components/schemas/Baz'
+    Bar:
+      type: object
+      properties:
+        foo:
+          type: string
+          enum:
+            - one
+            - two
+    Baz:
+      type: object
+      properties:
+        foo:
+          type: string
+          enum:
+            - three
diff --git a/packages/openapi-ts/src/openApi/2.0.x/parser/schema.ts b/packages/openapi-ts/src/openApi/2.0.x/parser/schema.ts
@@ -6,7 +6,7 @@ import type {
   SchemaType,
   SchemaWithRequired,
 } from '../../shared/types/schema';
-import { discriminatorValue } from '../../shared/utils/discriminator';
+import { discriminatorValues } from '../../shared/utils/discriminator';
 import { mergeSchemaAccessScopes } from '../../shared/utils/schema';
 import type { SchemaObject } from '../types/spec';
 
@@ -335,12 +335,22 @@ const parseAllOf = ({
       const ref = context.resolveRef<SchemaObject>(compositionSchema.$ref);
       // `$ref` should be passed from the root `parseSchema()` call
       if (ref.discriminator && state.$ref) {
+        const values = discriminatorValues(state.$ref);
+        const valueSchemas: ReadonlyArray<IR.SchemaObject> = values.map(
+          (value) => ({
+            const: value,
+            type: 'string',
+          }),
+        );
         const irDiscriminatorSchema: IR.SchemaObject = {
           properties: {
-            [ref.discriminator]: {
-              const: discriminatorValue(state.$ref),
-              type: 'string',
-            },
+            [ref.discriminator]:
+              valueSchemas.length > 1
+                ? {
+                    items: valueSchemas,
+                    logicalOperator: 'or',
+                  }
+                : valueSchemas[0]!,
           },
           type: 'object',
         };
diff --git a/packages/openapi-ts/src/openApi/3.0.x/parser/schema.ts b/packages/openapi-ts/src/openApi/3.0.x/parser/schema.ts
@@ -6,7 +6,7 @@ import type {
   SchemaType,
   SchemaWithRequired,
 } from '../../shared/types/schema';
-import { discriminatorValue } from '../../shared/utils/discriminator';
+import { discriminatorValues } from '../../shared/utils/discriminator';
 import { mergeSchemaAccessScopes } from '../../shared/utils/schema';
 import type { ReferenceObject, SchemaObject } from '../types/spec';
 
@@ -345,12 +345,25 @@ const parseAllOf = ({
       const ref = context.resolveRef<SchemaObject>(compositionSchema.$ref);
       // `$ref` should be passed from the root `parseSchema()` call
       if (ref.discriminator && state.$ref) {
+        const values = discriminatorValues(
+          state.$ref,
+          ref.discriminator.mapping,
+        );
+        const valueSchemas: ReadonlyArray<IR.SchemaObject> = values.map(
+          (value) => ({
+            const: value,
+            type: 'string',
+          }),
+        );
         const irDiscriminatorSchema: IR.SchemaObject = {
           properties: {
-            [ref.discriminator.propertyName]: {
-              const: discriminatorValue(state.$ref, ref.discriminator.mapping),
-              type: 'string',
-            },
+            [ref.discriminator.propertyName]:
+              valueSchemas.length > 1
+                ? {
+                    items: valueSchemas,
+                    logicalOperator: 'or',
+                  }
+                : valueSchemas[0]!,
           },
           type: 'object',
         };
@@ -502,15 +515,25 @@ const parseAnyOf = ({
 
     // `$ref` should be defined with discriminators
     if (schema.discriminator && '$ref' in compositionSchema) {
+      const values = discriminatorValues(
+        compositionSchema.$ref,
+        schema.discriminator.mapping,
+      );
+      const valueSchemas: ReadonlyArray<IR.SchemaObject> = values.map(
+        (value) => ({
+          const: value,
+          type: 'string',
+        }),
+      );
       const irDiscriminatorSchema: IR.SchemaObject = {
         properties: {
-          [schema.discriminator.propertyName]: {
-            const: discriminatorValue(
-              compositionSchema.$ref,
-              schema.discriminator.mapping,
-            ),
-            type: 'string',
-          },
+          [schema.discriminator.propertyName]:
+            valueSchemas.length > 1
+              ? {
+                  items: valueSchemas,
+                  logicalOperator: 'or',
+                }
+              : valueSchemas[0]!,
         },
         type: 'object',
       };
@@ -667,15 +690,25 @@ const parseOneOf = ({
 
     // `$ref` should be defined with discriminators
     if (schema.discriminator && '$ref' in compositionSchema) {
+      const values = discriminatorValues(
+        compositionSchema.$ref,
+        schema.discriminator.mapping,
+      );
+      const valueSchemas: ReadonlyArray<IR.SchemaObject> = values.map(
+        (value) => ({
+          const: value,
+          type: 'string',
+        }),
+      );
       const irDiscriminatorSchema: IR.SchemaObject = {
         properties: {
-          [schema.discriminator.propertyName]: {
-            const: discriminatorValue(
-              compositionSchema.$ref,
-              schema.discriminator.mapping,
-            ),
-            type: 'string',
-          },
+          [schema.discriminator.propertyName]:
+            valueSchemas.length > 1
+              ? {
+                  items: valueSchemas,
+                  logicalOperator: 'or',
+                }
+              : valueSchemas[0]!,
         },
         type: 'object',
       };
diff --git a/packages/openapi-ts/src/openApi/3.1.x/parser/schema.ts b/packages/openapi-ts/src/openApi/3.1.x/parser/schema.ts
diff --git a/packages/openapi-ts/src/openApi/shared/utils/discriminator.ts b/packages/openapi-ts/src/openApi/shared/utils/discriminator.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@hey-api/openapi-ts': patch
 +---
++
 +fix: handle discriminator with multiple mappings to the same schema
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// This file is auto-generated by @hey-api/openapi-ts`
	`2`	`+export * from './types.gen';`