fix: additionalProperties problem

Author: js2me

CHANGELOG.md

@@ -1,6 +1,8 @@
 # next release
 
-fix: problems with missing type imports in `.d.ts` files with using option `--js`  
+fix: problems with missing type imports in `.d.ts` files with using option `--js`    
+internal: add extra spec tests  
+fix: additionalProperties management problem in Swagger 2 (#343)  
 
 # 11.1.1  
 fix: `--api-class-name` option has no default value (#433)  

package.json

@@ -55,6 +55,7 @@
     "test:deprecated": "node tests/spec/deprecated/test.js",
     "test:nullableRefTest3.0": "node tests/spec/nullable-3.0/test.js",
     "test:nullableRefTest2.0": "node tests/spec/nullable-2.0/test.js",
+    "test:additionalProperties2.0": "node tests/spec/additional-properties-2.0/test.js",
     "test:enums2.0": "node tests/spec/enums-2.0/test.js"
   },
   "author": "acacode",

src/schema-parser/schema-parser.js

@@ -149,7 +149,7 @@ class SchemaParser {
       });
     },
     [SCHEMA_TYPES.OBJECT]: (schema, typeName) => {
-      const content = this.getObjectSchemaContent(schema);
+      const contentProperties = this.getObjectSchemaContent(schema);
 
       return this.attachParsedRef(schema, {
         ...(_.isObject(schema) ? schema : {}),
@@ -159,8 +159,8 @@ class SchemaParser {
         typeIdentifier: this.config.Ts.Keyword.Interface,
         name: typeName,
         description: this.schemaFormatters.formatDescription(schema.description),
-        allFieldsAreOptional: !_.some(_.values(content), (part) => part.isRequired),
-        content: content,
+        allFieldsAreOptional: !_.some(_.values(contentProperties), (part) => part.isRequired),
+        content: contentProperties,
       });
     },
     [SCHEMA_TYPES.COMPLEX]: (schema, typeName) => {
@@ -424,7 +424,7 @@ class SchemaParser {
       };
     });
 
-    if (additionalProperties === true) {
+    if (additionalProperties) {
       propertiesContent.push({
         $$raw: { additionalProperties },
         description: "",

tests/generated/v3.0/full-swagger-scheme.ts

@@ -3164,6 +3164,7 @@ export interface Integration {
     metadata?: string;
     contents?: string;
     deployments?: string;
+    [key: string]: any;
   };
   /**
    * The slug name of the GitHub app

tests/spec/additional-properties-2.0/expected.ts

@@ -0,0 +1,33 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+export interface MyObject1 {
+  id?: string;
+  [key: string]: any;
+}
+
+export interface MyObject2 {
+  id?: string;
+  [key: string]: any;
+}
+
+export interface MyObject3 {
+  id?: string;
+  [key: string]: any;
+}
+
+export type MyObject4 = Record<
+  string,
+  {
+    content?: string;
+    filename?: string | null;
+  }
+>;

tests/spec/additional-properties-2.0/schema.json

@@ -0,0 +1,54 @@
+{
+  "swagger": "2.0",
+  "schemes": ["https"],
+  "host": "ffff.com",
+  "basePath": "/",
+  "info": {},
+  "definitions": {
+    "MyObject1": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": {
+        "type": "object"
+      }
+    },
+    "MyObject2": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": {}
+    },
+    "MyObject3": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": true
+    },
+    "MyObject4": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "nullable": true,
+        "properties": {
+          "content": {
+            "type": "string"
+          },
+          "filename": {
+            "type": "string",
+            "nullable": true
+          }
+        }
+      }
+    }
+  }
+}

tests/spec/additional-properties-2.0/schema.ts

@@ -0,0 +1,33 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+export interface MyObject1 {
+  id?: string;
+  [key: string]: any;
+}
+
+export interface MyObject2 {
+  id?: string;
+  [key: string]: any;
+}
+
+export interface MyObject3 {
+  id?: string;
+  [key: string]: any;
+}
+
+export type MyObject4 = Record<
+  string,
+  {
+    content?: string;
+    filename?: string | null;
+  }
+>;

tests/spec/additional-properties-2.0/test.js

@@ -0,0 +1,22 @@
+const { generateApiForTest } = require("../../helpers/generateApiForTest");
+const { resolve } = require("path");
+const validateGeneratedModule = require("../../helpers/validateGeneratedModule");
+const assertGeneratedModule = require("../../helpers/assertGeneratedModule");
+const createSchemaInfos = require("../../helpers/createSchemaInfos");
+
+const schemas = createSchemaInfos({ absolutePathToSchemas: resolve(__dirname, "./") });
+
+schemas.forEach(({ absolutePath, apiFileName }) => {
+  generateApiForTest({
+    testName: "additional properties 2.0 test",
+    silent: true,
+    name: apiFileName,
+    input: absolutePath,
+    output: resolve(__dirname, "./"),
+    addReadonly: true,
+    generateClient: false,
+  }).then(() => {
+    validateGeneratedModule(resolve(__dirname, `./${apiFileName}`));
+    assertGeneratedModule(resolve(__dirname, `./${apiFileName}`), resolve(__dirname, `./expected.ts`));
+  });
+});

tests/spec/jsSingleHttpClientModular/test.js

@@ -14,7 +14,6 @@ schemas.forEach(({ absolutePath, Exception }) => {
     output: resolve(__dirname, "./generated"),
     modular: true,
     toJS: true,
-    cleanOutput: true,
     singleHttpClient: true,
     generateClient: true,
     generateRouteTypes: true,

tests/spec/object-types/schema.ts

@@ -41,10 +41,12 @@ export type Test1 = {
 
 export interface AdditionalObjectProperties {
   id?: string;
+  [key: string]: any;
 }
 
 export interface AdditionalIntProperties {
   id?: string;
+  [key: string]: any;
 }
 
 export interface ABCOptional {