Merge pull request #2287 from MaxwellAt/fix/allof-additionalProperties-false

Fix/allof additional properties false

Author: mrlubos

.changeset/sweet-swans-shout.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix(zod): improve handling of additional properties

README.md

@@ -1 +1 @@
-packages/openapi-ts/README.md
+packages/openapi-ts/README.md

packages/openapi-ts-tests/main/test/2.0.x.test.ts

@@ -44,6 +44,13 @@ describe(`OpenAPI ${version}`, () => {
   };
 
   const scenarios = [
+    {
+      config: createConfig({
+        input: 'additional-properties-false.json',
+        output: 'additional-properties-false',
+      }),
+      description: 'forbids arbitrary properties on objects',
+    },
     {
       config: createConfig({
         input: 'additional-properties-true.json',

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/additional-properties-false/index.ts

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/additional-properties-false/types.gen.ts

@@ -0,0 +1,15 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type Foo = {
+    foo: string;
+};
+
+export type Bar = Foo & {};
+
+export type Baz = Foo & {
+    bar: string;
+};
+
+export type ClientOptions = {
+    baseUrl: string;
+};

packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/additional-properties-false/types.gen.ts

@@ -4,9 +4,7 @@ export type Foo = {
     foo: string;
 };
 
-export type Bar = Foo & {
-    [key: string]: never;
-};
+export type Bar = Foo & {};
 
 export type Baz = Foo & {
     bar: string;

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/additional-properties-false/types.gen.ts

@@ -4,9 +4,7 @@ export type Foo = {
     foo: string;
 };
 
-export type Bar = Foo & {
-    [key: string]: never;
-};
+export type Bar = Foo & {};
 
 export type Baz = Foo & {
     bar: string;

packages/openapi-ts-tests/specs/2.0.x/additional-properties-false.json

@@ -0,0 +1,47 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "OpenAPI 2.0 additional properties false example",
+    "version": "1"
+  },
+  "definitions": {
+    "Foo": {
+      "required": ["foo"],
+      "type": "object",
+      "properties": {
+        "foo": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "Bar": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/Foo"
+        },
+        {
+          "type": "object",
+          "additionalProperties": false
+        }
+      ]
+    },
+    "Baz": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/Foo"
+        },
+        {
+          "required": ["bar"],
+          "type": "object",
+          "properties": {
+            "bar": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    }
+  }
+}

packages/openapi-ts-tests/test/__snapshots__/2.0.x/additional-properties-false/index.ts

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';

packages/openapi-ts-tests/test/__snapshots__/2.0.x/additional-properties-false/types.gen.ts

@@ -0,0 +1,15 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type Foo = {
+    foo: string;
+};
+
+export type Bar = Foo & {};
+
+export type Baz = Foo & {
+    bar: string;
+};
+
+export type ClientOptions = {
+    baseUrl: string;
+};