Merge pull request #1390 from hey-api/fix/experimental-parser-additio…

…nal-properties-undefined fix: allow arbitrary object properties when additionalProperties is undefined
hey-api · Dec 4, 2024 · 311b863 · 311b863
2 parents 7ee3960 + 8388c47
commit 311b863
Show file tree

Hide file tree

Showing 50 changed files with 631 additions and 206 deletions.
diff --git a/.changeset/clean-worms-sing.md b/.changeset/clean-worms-sing.md
@@ -2,7 +2,7 @@
 '@hey-api/openapi-ts': minor
 ---
 
-feat: add logs.level option
+feat: add `logs.level` option
 
 ### Added `logs.level` option
 

diff --git a/.changeset/hungry-dolphins-clap.md b/.changeset/hungry-dolphins-clap.md
@@ -2,4 +2,4 @@
 '@hey-api/openapi-ts': patch
 ---
 
-fix: add --silent or -s CLI option for silent log level
+fix: add `--silent` or `-s` CLI option for silent log level
diff --git a/.changeset/moody-falcons-pay.md b/.changeset/moody-falcons-pay.md
@@ -2,4 +2,4 @@
 '@hey-api/openapi-ts': patch
 ---
 
-feat: add logs configuration option to customize log directory
+feat: add `logs` configuration option to customize log directory
diff --git a/.changeset/proud-socks-dance.md b/.changeset/proud-socks-dance.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: allow arbitrary object properties when additionalProperties is undefined
diff --git a/.changeset/twelve-doors-look.md b/.changeset/twelve-doors-look.md
@@ -2,4 +2,4 @@
 '@hey-api/openapi-ts': patch
 ---
 
-fix: support DEBUG environment variable
+fix: support `DEBUG` environment variable
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
@@ -216,23 +216,27 @@ const parseObject = ({
     irSchema.properties = schemaProperties;
   }
 
-  if (schema.additionalProperties !== undefined) {
-    if (typeof schema.additionalProperties === 'boolean') {
+  if (schema.additionalProperties === undefined) {
+    if (!irSchema.properties) {
       irSchema.additionalProperties = {
-        type: schema.additionalProperties ? 'unknown' : 'never',
+        type: 'unknown',
       };
-    } else {
-      const irAdditionalPropertiesSchema = schemaToIrSchema({
-        context,
-        schema: schema.additionalProperties,
-      });
-      // no need to add "any" additional properties if there are no defined properties
-      if (
-        irSchema.properties ||
-        irAdditionalPropertiesSchema.type !== 'unknown'
-      ) {
-        irSchema.additionalProperties = irAdditionalPropertiesSchema;
-      }
+    }
+  } else if (typeof schema.additionalProperties === 'boolean') {
+    irSchema.additionalProperties = {
+      type: schema.additionalProperties ? 'unknown' : 'never',
+    };
+  } else {
+    const irAdditionalPropertiesSchema = schemaToIrSchema({
+      context,
+      schema: schema.additionalProperties,
+    });
+    // no need to add "any" additional properties if there are no defined properties
+    if (
+      irSchema.properties ||
+      irAdditionalPropertiesSchema.type !== 'unknown'
+    ) {
+      irSchema.additionalProperties = irAdditionalPropertiesSchema;
     }
   }
 

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
@@ -269,23 +269,27 @@ const parseObject = ({
     irSchema.properties = schemaProperties;
   }
 
-  if (schema.additionalProperties !== undefined) {
-    if (typeof schema.additionalProperties === 'boolean') {
+  if (schema.additionalProperties === undefined) {
+    if (!irSchema.properties) {
       irSchema.additionalProperties = {
-        type: schema.additionalProperties ? 'unknown' : 'never',
+        type: 'unknown',
       };
-    } else {
-      const irAdditionalPropertiesSchema = schemaToIrSchema({
-        context,
-        schema: schema.additionalProperties,
-      });
-      // no need to add "any" additional properties if there are no defined properties
-      if (
-        irSchema.properties ||
-        irAdditionalPropertiesSchema.type !== 'unknown'
-      ) {
-        irSchema.additionalProperties = irAdditionalPropertiesSchema;
-      }
+    }
+  } else if (typeof schema.additionalProperties === 'boolean') {
+    irSchema.additionalProperties = {
+      type: schema.additionalProperties ? 'unknown' : 'never',
+    };
+  } else {
+    const irAdditionalPropertiesSchema = schemaToIrSchema({
+      context,
+      schema: schema.additionalProperties,
+    });
+    // no need to add "any" additional properties if there are no defined properties
+    if (
+      irSchema.properties ||
+      irAdditionalPropertiesSchema.type !== 'unknown'
+    ) {
+      irSchema.additionalProperties = irAdditionalPropertiesSchema;
     }
   }
 

diff --git a/packages/openapi-ts/test/3.0.x.test.ts b/packages/openapi-ts/test/3.0.x.test.ts
@@ -48,6 +48,13 @@ describe(`OpenAPI ${VERSION}`, () => {
       }),
       description: 'allows arbitrary properties on objects',
     },
+    {
+      config: createConfig({
+        input: 'additional-properties-undefined.json',
+        output: 'additional-properties-undefined',
+      }),
+      description: 'allows arbitrary properties on objects',
+    },
     {
       config: createConfig({
         input: 'array-items-one-of-length-1.json',

diff --git a/packages/openapi-ts/test/3.1.x.test.ts b/packages/openapi-ts/test/3.1.x.test.ts
@@ -48,6 +48,13 @@ describe(`OpenAPI ${VERSION}`, () => {
       }),
       description: 'allows arbitrary properties on objects',
     },
+    {
+      config: createConfig({
+        input: 'additional-properties-undefined.json',
+        output: 'additional-properties-undefined',
+      }),
+      description: 'allows arbitrary properties on objects',
+    },
     {
       config: createConfig({
         input: 'array-items-one-of-length-1.json',

diff --git a/packages/openapi-ts/test/__snapshots__/3.0.x/additional-properties-undefined/index.ts b/packages/openapi-ts/test/__snapshots__/3.0.x/additional-properties-undefined/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/test/__snapshots__/3.0.x/additional-properties-undefined/types.gen.ts b/packages/openapi-ts/test/__snapshots__/3.0.x/additional-properties-undefined/types.gen.ts
@@ -0,0 +1,7 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type Foo = {
+    foo: {
+        [key: string]: unknown;
+    };
+};
diff --git a/packages/openapi-ts/test/__snapshots__/3.0.x/plugins/@hey-api/sdk/default/types.gen.ts b/packages/openapi-ts/test/__snapshots__/3.0.x/plugins/@hey-api/sdk/default/types.gen.ts
@@ -642,7 +642,9 @@ export type Pageable = {
 /**
  * This is a free-form object without additionalProperties.
  */
-export type FreeFormObjectWithoutAdditionalProperties = {};
+export type FreeFormObjectWithoutAdditionalProperties = {
+    [key: string]: unknown;
+};
 
 /**
  * This is a free-form object with additionalProperties: true.
@@ -1124,7 +1126,9 @@ export type CallWithParametersData = {
     /**
      * This is the parameter that goes into the body
      */
-    body: {} | null;
+    body: {
+        [key: string]: unknown;
+    } | null;
     headers: {
         /**
          * This is the parameter that goes into the header
@@ -1599,15 +1603,19 @@ export type TypesData = {
         /**
          * This is an object parameter
          */
-        parameterObject: {} | null;
+        parameterObject: {
+            [key: string]: unknown;
+        } | null;
         /**
          * This is an array parameter
          */
         parameterArray: Array<string> | null;
         /**
          * This is a dictionary parameter
          */
-        parameterDictionary: {} | null;
+        parameterDictionary: {
+            [key: string]: unknown;
+        } | null;
         /**
          * This is an enum parameter
          */
@@ -1632,7 +1640,9 @@ export type TypesResponses = {
     /**
      * Response is a simple object
      */
-    203: {};
+    203: {
+        [key: string]: unknown;
+    };
 };
 
 export type TypesResponse = TypesResponses[keyof TypesResponses];

diff --git a/...est/__snapshots__/3.0.x/plugins/@tanstack/angular-query-experimental/asClass/types.gen.ts b/...est/__snapshots__/3.0.x/plugins/@tanstack/angular-query-experimental/asClass/types.gen.ts
@@ -642,7 +642,9 @@ export type Pageable = {
 /**
  * This is a free-form object without additionalProperties.
  */
-export type FreeFormObjectWithoutAdditionalProperties = {};
+export type FreeFormObjectWithoutAdditionalProperties = {
+    [key: string]: unknown;
+};
 
 /**
  * This is a free-form object with additionalProperties: true.
@@ -1124,7 +1126,9 @@ export type CallWithParametersData = {
     /**
      * This is the parameter that goes into the body
      */
-    body: {} | null;
+    body: {
+        [key: string]: unknown;
+    } | null;
     headers: {
         /**
          * This is the parameter that goes into the header
@@ -1599,15 +1603,19 @@ export type TypesData = {
         /**
          * This is an object parameter
          */
-        parameterObject: {} | null;
+        parameterObject: {
+            [key: string]: unknown;
+        } | null;
         /**
          * This is an array parameter
          */
         parameterArray: Array<string> | null;
         /**
          * This is a dictionary parameter
          */
-        parameterDictionary: {} | null;
+        parameterDictionary: {
+            [key: string]: unknown;
+        } | null;
         /**
          * This is an enum parameter
          */
@@ -1632,7 +1640,9 @@ export type TypesResponses = {
     /**
      * Response is a simple object
      */
-    203: {};
+    203: {
+        [key: string]: unknown;
+    };
 };
 
 export type TypesResponse = TypesResponses[keyof TypesResponses];

diff --git a/.../test/__snapshots__/3.0.x/plugins/@tanstack/angular-query-experimental/axios/types.gen.ts b/.../test/__snapshots__/3.0.x/plugins/@tanstack/angular-query-experimental/axios/types.gen.ts
@@ -642,7 +642,9 @@ export type Pageable = {
 /**
  * This is a free-form object without additionalProperties.
  */
-export type FreeFormObjectWithoutAdditionalProperties = {};
+export type FreeFormObjectWithoutAdditionalProperties = {
+    [key: string]: unknown;
+};
 
 /**
  * This is a free-form object with additionalProperties: true.
@@ -1124,7 +1126,9 @@ export type CallWithParametersData = {
     /**
      * This is the parameter that goes into the body
      */
-    body: {} | null;
+    body: {
+        [key: string]: unknown;
+    } | null;
     headers: {
         /**
          * This is the parameter that goes into the header
@@ -1599,15 +1603,19 @@ export type TypesData = {
         /**
          * This is an object parameter
          */
-        parameterObject: {} | null;
+        parameterObject: {
+            [key: string]: unknown;
+        } | null;
         /**
          * This is an array parameter
          */
         parameterArray: Array<string> | null;
         /**
          * This is a dictionary parameter
          */
-        parameterDictionary: {} | null;
+        parameterDictionary: {
+            [key: string]: unknown;
+        } | null;
         /**
          * This is an enum parameter
          */
@@ -1632,7 +1640,9 @@ export type TypesResponses = {
     /**
      * Response is a simple object
      */
-    203: {};
+    203: {
+        [key: string]: unknown;
+    };
 };
 
 export type TypesResponse = TypesResponses[keyof TypesResponses];

diff --git a/.../test/__snapshots__/3.0.x/plugins/@tanstack/angular-query-experimental/fetch/types.gen.ts b/.../test/__snapshots__/3.0.x/plugins/@tanstack/angular-query-experimental/fetch/types.gen.ts
@@ -642,7 +642,9 @@ export type Pageable = {
 /**
  * This is a free-form object without additionalProperties.
  */
-export type FreeFormObjectWithoutAdditionalProperties = {};
+export type FreeFormObjectWithoutAdditionalProperties = {
+    [key: string]: unknown;
+};
 
 /**
  * This is a free-form object with additionalProperties: true.
@@ -1124,7 +1126,9 @@ export type CallWithParametersData = {
     /**
      * This is the parameter that goes into the body
      */
-    body: {} | null;
+    body: {
+        [key: string]: unknown;
+    } | null;
     headers: {
         /**
          * This is the parameter that goes into the header
@@ -1599,15 +1603,19 @@ export type TypesData = {
         /**
          * This is an object parameter
          */
-        parameterObject: {} | null;
+        parameterObject: {
+            [key: string]: unknown;
+        } | null;
         /**
          * This is an array parameter
          */
         parameterArray: Array<string> | null;
         /**
          * This is a dictionary parameter
          */
-        parameterDictionary: {} | null;
+        parameterDictionary: {
+            [key: string]: unknown;
+        } | null;
         /**
          * This is an enum parameter
          */
@@ -1632,7 +1640,9 @@ export type TypesResponses = {
     /**
      * Response is a simple object
      */
-    203: {};
+    203: {
+        [key: string]: unknown;
+    };
 };
 
 export type TypesResponse = TypesResponses[keyof TypesResponses];
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// This file is auto-generated by @hey-api/openapi-ts
		export * from './types.gen';