handle case where additionalRef is a ref (fixes #345)

Author: atlefren

src/types/OpenAPI2.ts

@@ -32,6 +32,12 @@ export type OpenAPI2Type =
 
 export type OpenAPI2Reference = { $ref: string };
 
+export function isOpenAPI2Reference(
+  additionalProperties: OpenAPI2SchemaObject | OpenAPI2Reference | boolean
+): additionalProperties is OpenAPI2Reference {
+  return (additionalProperties as OpenAPI2Reference).$ref !== undefined;
+}
+
 export interface OpenAPI2SchemaObject {
   additionalProperties?: OpenAPI2SchemaObject | OpenAPI2Reference | boolean;
   allOf?: OpenAPI2SchemaObject[];

src/v2.ts

@@ -1,5 +1,12 @@
 import propertyMapper from "./property-mapper";
-import { OpenAPI2, OpenAPI2SchemaObject, OpenAPI2Schemas, SwaggerToTSOptions } from "./types";
+import {
+  OpenAPI2,
+  OpenAPI2Reference,
+  OpenAPI2SchemaObject,
+  OpenAPI2Schemas,
+  SwaggerToTSOptions,
+  isOpenAPI2Reference,
+} from "./types";
 import { comment, nodeType, transformRef, tsArrayOf, tsIntersectionOf, tsUnionOf } from "./utils";
 
 export const PRIMITIVES: { [key: string]: "boolean" | "string" | "number" } = {
@@ -40,6 +47,14 @@ export default function generateTypesV2(input: OpenAPI2 | OpenAPI2Schemas, optio
   // propertyMapper
   const propertyMapped = options ? propertyMapper(definitions, options.propertyMapper) : definitions;
 
+  //this functionality could perhaps be added to the nodeType function, but I don't want to mess with that code
+  function getAdditionalPropertiesType(additionalProperties: OpenAPI2SchemaObject | OpenAPI2Reference | boolean) {
+    if (isOpenAPI2Reference(additionalProperties)) {
+      return transformRef(additionalProperties.$ref, rawSchema ? "definitions/" : "");
+    }
+    return nodeType(additionalProperties);
+  }
+
   // type conversions
   function transform(node: OpenAPI2SchemaObject): string {
     switch (nodeType(node)) {
@@ -67,7 +82,7 @@ export default function generateTypesV2(input: OpenAPI2 | OpenAPI2Schemas, optio
 
         // if additional properties, add to end of properties
         if (node.additionalProperties) {
-          properties += `[key: string]: ${nodeType(node.additionalProperties) || "any"};\n`;
+          properties += `[key: string]: ${getAdditionalPropertiesType(node.additionalProperties) || "any"};\n`;
         }
 
         return tsIntersectionOf([

tests/v2/index.test.ts

@@ -255,6 +255,38 @@ describe("transformation", () => {
       );
     });
 
+    it("additionalProperties 2 (issue #345)", () => {
+      const schema: OpenAPI2 = {
+        swagger: "2.0",
+        definitions: {
+          Messages: {
+            type: "object",
+            additionalProperties: {
+              $ref: "#/definitions/Message",
+            },
+          },
+          Message: {
+            type: "object",
+            properties: {
+              code: {
+                type: "integer",
+              },
+              text: {
+                type: "string",
+              },
+            },
+          },
+        },
+      };
+      expect(swaggerToTS(schema)).toBe(
+        format(`
+        export interface definitions {
+          Messages: { [key: string]: definitions["Message"] }
+          Message: { code?: number; text?: string }
+        }`)
+      );
+    });
+
     it("allOf", () => {
       const schema: OpenAPI2 = {
         swagger: "2.0",