Merge pull request #130 from manifoldco/dangodev/fix-hashmaps

DangoDev · web-flow · commit d0d09f2173bd · 2020-02-02T15:28:19.000-07:00
Fix HashMaps
diff --git a/README.md b/README.md
@@ -99,14 +99,13 @@ For anything more complicated, or for generating specs dynamically, you can also
 
 #### CLI Options
 
-| Option                | Alias |           Default            | Description                                                                   |
-| :-------------------- | :---- | :--------------------------: | :---------------------------------------------------------------------------- |
-| `--wrapper`           | `-w`  | `declare namespace OpenAPI2` | How should this export the types?                                             |
-| `--output [location]` | `-o`  |           (stdout)           | Where should the output file be saved?                                        |
-| `--swagger [version]` | `-s`  |             `2`              | Manually specify Swagger version (by default it will use `version` in schema) |
-| `--camelcase`         | `-c`  |           `false`            | Convert `snake_case` properties to `camelCase`                                |
-| `--nowarning`         |       |           `false`            | Disables “autogenerated file” warning at the top of generated files           |
-| `--nowrapper`         | `-nw` |           `false`            | Disables rendering a wrapper                                                  |
+| Option                | Alias |           Default            | Description                                                         |
+| :-------------------- | :---- | :--------------------------: | :------------------------------------------------------------------ |
+| `--wrapper`           | `-w`  | `declare namespace OpenAPI2` | How should this export the types?                                   |
+| `--output [location]` | `-o`  |           (stdout)           | Where should the output file be saved?                              |
+| `--camelcase`         | `-c`  |           `false`            | Convert `snake_case` properties to `camelCase`                      |
+| `--nowarning`         |       |           `false`            | Disables “autogenerated file” warning at the top of generated files |
+| `--nowrapper`         | `-nw` |           `false`            | Disables rendering a wrapper                                        |
 
 ### Node
 
@@ -131,20 +130,19 @@ If your specs are in YAML, you’ll have to convert them to JS objects using a l
 
 #### Node Options
 
-| Name             |       Type        |           Default            | Description                                                                  |
-| :--------------- | :---------------: | :--------------------------: | :--------------------------------------------------------------------------- |
-| `wrapper`        | `string \| false` | `declare namespace OpenAPI2` | How should this export the types? Pass false to disable rendering a wrapper  |
-| `swagger`        |     `number`      |             `2`              | Manully specify Swagger version (by default it will use `version` in schema) |
-| `camelcase`      |     `boolean`     |           `false`            | Convert `snake_case` properties to `camelCase`                               |
-| `propertyMapper` |    `function`     |         `undefined`          | Allows you to further manipulate how properties are parsed. See below.       |
+| Name             |       Type        |           Default            | Description                                                                 |
+| :--------------- | :---------------: | :--------------------------: | :-------------------------------------------------------------------------- |
+| `wrapper`        | `string \| false` | `declare namespace OpenAPI2` | How should this export the types? Pass false to disable rendering a wrapper |
+| `camelcase`      |     `boolean`     |           `false`            | Convert `snake_case` properties to `camelCase`                              |
+| `propertyMapper` |    `function`     |         `undefined`          | Allows you to further manipulate how properties are parsed. See below.      |
 
 #### PropertyMapper
 
 In order to allow more control over how properties are parsed, and to specifically handle
 `x-something`-properties, the `propertyMapper` option may be specified.
 
 This is a function that, if specified, is called for each property and allows you to change how
-swagger-to-ts handles parsing of swagger files.
+swagger-to-ts handles parsing of Swagger files.
 
 An example on how to use the `x-nullable` property to control if a property is optional:
 
diff --git a/bin/cli.js b/bin/cli.js
@@ -18,7 +18,6 @@ Options
   --wrapper, -w         specify wrapper (default: "declare namespace OpenAPI2")
   --output, -o          specify output file
   --camelcase, -c       convert snake_case properties to camelCase (default: off)
-  --swagger, -s         specify Swagger version (default: 2)
   --nowrapper -nw       disables rendering the wrapper
   --no-warning          hides the warning at the top of the generated file (default: off)
 `,
@@ -38,10 +37,6 @@ Options
         type: 'string',
         alias: 'o',
       },
-      swagger: {
-        type: 'number',
-        alias: 's',
-      },
       namespace: {
         type: 'string',
         alias: 'n',
diff --git a/example/basic.ts b/example/basic.ts
@@ -376,7 +376,7 @@ declare namespace OpenAPI2 {
     cost_ranges?: FeatureNumericRange[];
   }
   export interface FeatureMap {
-    [name: string]: any;
+    [key: string]: any;
   }
   export interface ExpandedProduct {
     id: string;
@@ -428,7 +428,7 @@ declare namespace OpenAPI2 {
     message: string[];
   }
   export interface Credentials {
-    [name: string]: string;
+    [key: string]: string;
   }
   export interface CreateRegion {
     body: RegionBody;
diff --git a/example/no-warning.ts b/example/no-warning.ts
@@ -371,7 +371,7 @@ declare namespace OpenAPI2 {
     cost_ranges?: FeatureNumericRange[];
   }
   export interface FeatureMap {
-    [name: string]: any;
+    [key: string]: any;
   }
   export interface ExpandedProduct {
     id: string;
@@ -423,7 +423,7 @@ declare namespace OpenAPI2 {
     message: string[];
   }
   export interface Credentials {
-    [name: string]: string;
+    [key: string]: string;
   }
   export interface CreateRegion {
     body: RegionBody;
diff --git a/example/no-wrapper.ts b/example/no-wrapper.ts
@@ -375,7 +375,7 @@ export interface FeatureNumericDetails {
   cost_ranges?: FeatureNumericRange[];
 }
 export interface FeatureMap {
-  [name: string]: any;
+  [key: string]: any;
 }
 export interface ExpandedProduct {
   id: string;
@@ -427,7 +427,7 @@ export interface Error {
   message: string[];
 }
 export interface Credentials {
-  [name: string]: string;
+  [key: string]: string;
 }
 export interface CreateRegion {
   body: RegionBody;
diff --git a/src/index.ts b/src/index.ts
@@ -2,15 +2,35 @@ import swagger2, { Swagger2, Swagger2Options } from './swagger-2';
 //re-export these from top-level as users may need thrm to create a propert5ymapper
 export { Swagger2Definition, Property } from './swagger-2';
 
-export interface Options extends Swagger2Options {
-  swagger?: number;
-}
+export type Options = Swagger2Options;
+
+export default function(spec: Swagger2, options?: Swagger2Options): string {
+  let version: number | undefined;
 
-export default function(spec: Swagger2, options?: Options): string {
-  const swagger = (options && options.swagger) || 2;
+  if (spec.swagger && parseInt(spec.swagger, 10) === 2) {
+    version = 2; // identify v3
+  } else if (spec.openapi && parseInt(spec.openapi, 10) === 3) {
+    version = 3; // identify v3
+  }
 
-  if (swagger !== 2) {
-    throw new Error(`Swagger version ${swagger} is not supported`);
+  switch (version) {
+    case undefined: {
+      console.warn(`Could not determine Swagger version. Assuming 2.0.`);
+      break;
+    }
+    case 2: {
+      // continue
+      break;
+    }
+    case 3: {
+      console.warn(
+        `Swagger version 3 is in beta. Please report any bugs you find to github.com/manifoldco/swagger-to-ts 🙏!`
+      );
+      break;
+    }
+    default: {
+      throw new Error(`Swagger version ${version} is not supported`);
+    }
   }
 
   return swagger2(spec, options);
diff --git a/src/swagger-2.ts b/src/swagger-2.ts
@@ -26,6 +26,8 @@ export interface Property {
 }
 
 export interface Swagger2 {
+  swagger?: string;
+  openapi?: string;
   definitions: {
     [index: string]: Swagger2Definition;
   };
@@ -142,6 +144,17 @@ function parse(spec: Swagger2, options: Swagger2Options = {}): string {
     return DEFAULT_TYPE;
   }
 
+  function handleAdditionalProperties(additionalProperties: boolean | Swagger2Definition): string {
+    if ((additionalProperties as Swagger2Definition).type) {
+      const interfaceType = getType(additionalProperties as Swagger2Definition, '', {
+        camelcase: shouldCamelCase,
+      });
+      return `[key: string]: ${interfaceType}`;
+    }
+
+    return '[key: string]: any;';
+  }
+
   function buildNextInterface(): void {
     const nextObject = queue.pop();
     if (!nextObject) return; // Geez TypeScript it’s going to be OK
@@ -203,20 +216,15 @@ function parse(spec: Swagger2, options: Swagger2Options = {}): string {
         output.push(`/**\n* ${property.description.replace(/\n$/, '').replace(/\n/g, '\n* ')}\n*/`);
       }
 
-      output.push(`${name}: ${interfaceType};`);
+      if (value.additionalProperties) {
+        output.push(`${name}: { ${handleAdditionalProperties(value.additionalProperties)} }`);
+      } else {
+        output.push(`${name}: ${interfaceType};`);
+      }
     });
 
     if (additionalProperties) {
-      if ((additionalProperties as boolean) === true) {
-        output.push('[name: string]: any');
-      }
-
-      if ((additionalProperties as Swagger2Definition).type) {
-        const interfaceType = getType(additionalProperties as Swagger2Definition, '', {
-          camelcase: shouldCamelCase,
-        });
-        output.push(`[name: string]: ${interfaceType}`);
-      }
+      output.push(handleAdditionalProperties(additionalProperties));
     }
 
     // Close interface
diff --git a/tests/index.test.ts b/tests/index.test.ts
@@ -2,21 +2,20 @@ import swaggerToTS, { Options } from '../src';
 
 describe('swaggerToTS', () => {
   it('is able to parse a Swagger 2 spec', () => {
-    const spec = { definitions: {} };
-    const options: Options = { swagger: 2, warning: false };
-
+    const spec = { swagger: '2.0', definitions: {} };
+    const options: Options = { warning: false };
     expect(swaggerToTS(spec, options)).toBe('declare namespace OpenAPI2 {}\n');
   });
 
-  it('errs on other options', () => {
+  it('assumes Swagger 2 if version missing', () => {
     const spec = { definitions: {} };
-    const options: Options = { swagger: 1, warning: false };
-    expect(() => swaggerToTS(spec, options)).toThrowError();
+    const options: Options = { warning: false };
+    expect(swaggerToTS(spec, options)).toBe('declare namespace OpenAPI2 {}\n');
   });
 
   it('should not render a wrapper when passing false', () => {
-    const spec = { definitions: {} };
-    const options: Options = { swagger: 2, wrapper: false, warning: false };
+    const spec = { swagger: '2.0', definitions: {} };
+    const options: Options = { wrapper: false, warning: false };
     expect(swaggerToTS(spec, options)).toBe('');
   });
 });
diff --git a/tests/swagger-2.test.ts b/tests/swagger-2.test.ts

Original file line number	Diff line number	Diff line change
`@@ -376,7 +376,7 @@ declare namespace OpenAPI2 {`
`376`	`376`	`cost_ranges?: FeatureNumericRange[];`
`377`	`377`	`}`
`378`	`378`	`export interface FeatureMap {`
`379`		`- [name: string]: any;`
	`379`	`+ [key: string]: any;`
`380`	`380`	`}`
`381`	`381`	`export interface ExpandedProduct {`
`382`	`382`	`id: string;`
`@@ -428,7 +428,7 @@ declare namespace OpenAPI2 {`
`428`	`428`	`message: string[];`
`429`	`429`	`}`
`430`	`430`	`export interface Credentials {`
`431`		`- [name: string]: string;`
	`431`	`+ [key: string]: string;`
`432`	`432`	`}`
`433`	`433`	`export interface CreateRegion {`
`434`	`434`	`body: RegionBody;`
Original file line number	Diff line number	Diff line change
`@@ -371,7 +371,7 @@ declare namespace OpenAPI2 {`
`371`	`371`	`cost_ranges?: FeatureNumericRange[];`
`372`	`372`	`}`
`373`	`373`	`export interface FeatureMap {`
`374`		`- [name: string]: any;`
	`374`	`+ [key: string]: any;`
`375`	`375`	`}`
`376`	`376`	`export interface ExpandedProduct {`
`377`	`377`	`id: string;`
`@@ -423,7 +423,7 @@ declare namespace OpenAPI2 {`
`423`	`423`	`message: string[];`
`424`	`424`	`}`
`425`	`425`	`export interface Credentials {`
`426`		`- [name: string]: string;`
	`426`	`+ [key: string]: string;`
`427`	`427`	`}`
`428`	`428`	`export interface CreateRegion {`
`429`	`429`	`body: RegionBody;`
Original file line number	Diff line number	Diff line change
`@@ -375,7 +375,7 @@ export interface FeatureNumericDetails {`
`375`	`375`	`cost_ranges?: FeatureNumericRange[];`
`376`	`376`	`}`
`377`	`377`	`export interface FeatureMap {`
`378`		`- [name: string]: any;`
	`378`	`+ [key: string]: any;`
`379`	`379`	`}`
`380`	`380`	`export interface ExpandedProduct {`
`381`	`381`	`id: string;`
`@@ -427,7 +427,7 @@ export interface Error {`
`427`	`427`	`message: string[];`
`428`	`428`	`}`
`429`	`429`	`export interface Credentials {`
`430`		`- [name: string]: string;`
	`430`	`+ [key: string]: string;`
`431`	`431`	`}`
`432`	`432`	`export interface CreateRegion {`
`433`	`433`	`body: RegionBody;`