Merge pull request #499 from hey-api/fix/additional-properties-union

fix: handle additional properties union
hey-api · Apr 27, 2024 · e24eece · e24eece
2 parents 0ca8b75 + 519b646
commit e24eece
Show file tree

Hide file tree

Showing 13 changed files with 68 additions and 20 deletions.
diff --git a/.changeset/light-ducks-cry.md b/.changeset/light-ducks-cry.md
@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix: handle additional properties union
diff --git a/examples/openapi-ts-fetch/src/client/types.gen.ts b/examples/openapi-ts-fetch/src/client/types.gen.ts
@@ -12,6 +12,11 @@ export type Order = {
   complete?: boolean;
 };
 
+/**
+ * Order Status
+ */
+export type status = 'placed' | 'approved' | 'delivered';
+
 export type Customer = {
   id?: number;
   username?: string;

diff --git a/packages/openapi-ts/src/openApi/v3/parser/getModelProperties.ts b/packages/openapi-ts/src/openApi/v3/parser/getModelProperties.ts
@@ -1,4 +1,5 @@
 import { escapeName } from '../../../utils/escape';
+import { unique } from '../../../utils/unique';
 import type { Model } from '../../common/interfaces/client';
 import { getDefault } from '../../common/parser/getDefault';
 import { getPattern } from '../../common/parser/getPattern';
@@ -38,6 +39,17 @@ export const getAdditionalPropertiesModel = (
   }
 
   if (definition.additionalProperties && definition.properties) {
+    const additionalPropertiesType =
+      typeof definition.additionalProperties === 'object' &&
+      definition.additionalProperties.type &&
+      !Array.isArray(definition.additionalProperties.type)
+        ? definition.additionalProperties.type
+        : apModel.base;
+    const additionalProperties = [
+      additionalPropertiesType,
+      ...model.properties.map((property) => property.base),
+    ];
+    apModel.base = additionalProperties.filter(unique).join(' | ');
     apModel.default = getDefault(definition, model);
     apModel.export = 'generic';
     apModel.isRequired = definition.additionalProperties === true;

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/schemas.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/schemas.gen.ts.snap
@@ -259,7 +259,10 @@ export const $DictionaryWithPropertiesAndAdditionalProperties = {
     type: 'object',
     properties: {
         foo: {
-            type: 'string'
+            type: 'number'
+        },
+        bar: {
+            type: 'boolean'
         }
     },
     additionalProperties: {

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/types.gen.ts.snap
@@ -170,8 +170,9 @@ export type DictionaryWithString = {
 };
 
 export type DictionaryWithPropertiesAndAdditionalProperties = {
-    foo?: string;
-    [key: string]: (string) | undefined;
+    foo?: number;
+    bar?: boolean;
+    [key: string]: (string | number | boolean) | undefined;
 };
 
 /**
@@ -677,7 +678,7 @@ export type ModelWithAdditionalPropertiesEqTrue = {
      * This is a simple string property
      */
     prop?: string;
-    [key: string]: unknown;
+    [key: string]: unknown | string;
 };
 
 export type NestedAnyOfArraysNullable = {

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/types.gen.ts.snap
@@ -170,8 +170,9 @@ export type DictionaryWithString = {
 };
 
 export type DictionaryWithPropertiesAndAdditionalProperties = {
-    foo?: string;
-    [key: string]: (string) | undefined;
+    foo?: number;
+    bar?: boolean;
+    [key: string]: (string | number | boolean) | undefined;
 };
 
 /**
@@ -677,7 +678,7 @@ export type ModelWithAdditionalPropertiesEqTrue = {
      * This is a simple string property
      */
     prop?: string;
-    [key: string]: unknown;
+    [key: string]: unknown | string;
 };
 
 export type NestedAnyOfArraysNullable = {

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/types.gen.ts.snap
@@ -170,8 +170,9 @@ export type DictionaryWithString = {
 };
 
 export type DictionaryWithPropertiesAndAdditionalProperties = {
-    foo?: string;
-    [key: string]: (string) | undefined;
+    foo?: number;
+    bar?: boolean;
+    [key: string]: (string | number | boolean) | undefined;
 };
 
 /**
@@ -677,7 +678,7 @@ export type ModelWithAdditionalPropertiesEqTrue = {
      * This is a simple string property
      */
     prop?: string;
-    [key: string]: unknown;
+    [key: string]: unknown | string;
 };
 
 export type NestedAnyOfArraysNullable = {

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/types.gen.ts.snap
@@ -170,8 +170,9 @@ export type DictionaryWithString = {
 };
 
 export type DictionaryWithPropertiesAndAdditionalProperties = {
-    foo?: string;
-    [key: string]: (string) | undefined;
+    foo?: number;
+    bar?: boolean;
+    [key: string]: (string | number | boolean) | undefined;
 };
 
 /**
@@ -677,7 +678,7 @@ export type ModelWithAdditionalPropertiesEqTrue = {
      * This is a simple string property
      */
     prop?: string;
-    [key: string]: unknown;
+    [key: string]: unknown | string;
 };
 
 export type NestedAnyOfArraysNullable = {

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_models/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_models/types.gen.ts.snap
@@ -170,8 +170,9 @@ export type DictionaryWithString = {
 };
 
 export type DictionaryWithPropertiesAndAdditionalProperties = {
-    foo?: string;
-    [key: string]: (string) | undefined;
+    foo?: number;
+    bar?: boolean;
+    [key: string]: (string | number | boolean) | undefined;
 };
 
 /**
@@ -677,7 +678,7 @@ export type ModelWithAdditionalPropertiesEqTrue = {
      * This is a simple string property
      */
     prop?: string;
-    [key: string]: unknown;
+    [key: string]: unknown | string;
 };
 
 export type NestedAnyOfArraysNullable = {

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_schemas_form/schemas.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_schemas_form/schemas.gen.ts.snap
@@ -222,7 +222,10 @@ export const $DictionaryWithPropertiesAndAdditionalProperties = {
     type: 'object',
     properties: {
         foo: {
-            type: 'string'
+            type: 'number'
+        },
+        bar: {
+            type: 'boolean'
         }
     },
     additionalProperties: {

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_schemas_json/schemas.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_schemas_json/schemas.gen.ts.snap
@@ -259,7 +259,10 @@ export const $DictionaryWithPropertiesAndAdditionalProperties = {
     type: 'object',
     properties: {
         foo: {
-            type: 'string'
+            type: 'number'
+        },
+        bar: {
+            type: 'boolean'
         }
     },
     additionalProperties: {

diff --git a/packages/openapi-ts/test/sample.cjs b/packages/openapi-ts/test/sample.cjs
@@ -7,10 +7,19 @@ const main = async () => {
     enums: 'javascript',
     input: './test/spec/v3.json',
     output: './test/generated/v3/',
+    schemas: {
+      export: false,
+    },
+    services: {
+      export: false,
+    },
+    types: {
+      include: '^DictionaryWithPropertiesAndAdditionalProperties',
+    },
   };
 
   const { createClient } = await import(
-    path.resolve(process.cwd(), 'dist/index.js')
+    path.resolve(process.cwd(), 'dist/node/index.cjs')
   );
   await createClient(config);
 };

diff --git a/packages/openapi-ts/test/spec/v3.json b/packages/openapi-ts/test/spec/v3.json
@@ -1867,7 +1867,10 @@
         "type": "object",
         "properties": {
           "foo": {
-            "type": "string"
+            "type": "number"
+          },
+          "bar": {
+            "type": "boolean"
           }
         },
         "additionalProperties": {