Merge branch 'ferdikoomen:master' into master

Author: loganbenjamin

CHANGELOG.md

@@ -1,6 +1,22 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.22.0] - 2022-04-26
+### Fixed
+- Upgraded dependencies
+- Fixed issue with `null` value inside comments for OpenAPI v2 enums
+- Fixed issue with compatibility for latest version of Axios (0.27.x)
+### Removed
+- Removed deprecated enum model generation
+
+## [0.21.0] - 2022-04-06
+### Fixed
+- Return `undefined` to match `noImplicitReturns` rule
+- Made `BaseHttpRequest` class abstract
+- Removed private fields using `#` inside `CancelablePromise`
+- Removed unneeded import `AbortController` from `node-fetch` client
+- Filter out wrong enum values
+
 ## [0.20.1] - 2022-02-25
 ### Fixed
 - Support enums with single quotes in names for V2

docs/axios-support.md

@@ -14,5 +14,13 @@ npm install axios --save-dev
 npm install [email protected] --save-dev
 ```
 
-In order to compile the project and resolve the imports, you will need to enable the `allowSyntheticDefaultImports`
-in your `tsconfig.json` file.
+In order to compile the project and resolve the imports, you will need to add the following properties
+in your `tsconfig.json` file:
+```json
+{
+    "compilerOptions": {
+        "lib": ["...", "dom"],
+        "allowSyntheticDefaultImports": true
+    }
+}
+```

docs/client-instances.md

@@ -7,7 +7,7 @@ The generated client uses an instance of the server configuration and not the gl
 To generate a client instance, set a custom name to the client class, use `--name` option.
 
 ```
-openapi --input ./spec.json --output ./generated ---name AppClient
+openapi --input ./spec.json --output ./generated --name AppClient
 ```
 
 The generated client will be exported from the `index` file and can be used as shown below:

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "openapi-typescript-codegen",
-    "version": "0.20.1",
+    "version": "0.22.0",
     "description": "Library that generates Typescript clients based on the OpenAPI specification.",
     "author": "Ferdi Koomen",
     "homepage": "https://github.com/ferdikoomen/openapi-typescript-codegen",
@@ -60,63 +60,63 @@
     },
     "dependencies": {
         "camelcase": "^6.3.0",
-        "commander": "^9.0.0",
+        "commander": "^9.2.0",
         "handlebars": "^4.7.7",
         "json-schema-ref-parser": "^9.0.9"
     },
     "devDependencies": {
-        "@angular-devkit/build-angular": "13.2.5",
-        "@angular/animations": "13.2.4",
-        "@angular/cli": "13.2.5",
-        "@angular/common": "13.2.4",
-        "@angular/compiler": "13.2.4",
-        "@angular/compiler-cli": "13.2.4",
-        "@angular/core": "13.2.4",
-        "@angular/forms": "13.2.4",
-        "@angular/platform-browser": "13.2.4",
-        "@angular/platform-browser-dynamic": "13.2.4",
-        "@angular/router": "13.2.4",
+        "@angular-devkit/build-angular": "13.3.3",
+        "@angular/animations": "13.3.4",
+        "@angular/cli": "13.3.3",
+        "@angular/common": "13.3.4",
+        "@angular/compiler": "13.3.4",
+        "@angular/compiler-cli": "13.3.4",
+        "@angular/core": "13.3.4",
+        "@angular/forms": "13.3.4",
+        "@angular/platform-browser": "13.3.4",
+        "@angular/platform-browser-dynamic": "13.3.4",
+        "@angular/router": "13.3.4",
         "@babel/cli": "7.17.6",
-        "@babel/core": "7.17.5",
+        "@babel/core": "7.17.9",
         "@babel/preset-env": "7.16.11",
         "@babel/preset-typescript": "7.16.7",
-        "@rollup/plugin-commonjs": "21.0.2",
-        "@rollup/plugin-node-resolve": "13.1.3",
-        "@rollup/plugin-typescript": "8.3.1",
+        "@rollup/plugin-commonjs": "22.0.0",
+        "@rollup/plugin-node-resolve": "13.2.1",
+        "@rollup/plugin-typescript": "8.3.2",
         "@types/cross-spawn": "6.0.2",
         "@types/express": "4.17.13",
         "@types/glob": "7.2.0",
         "@types/jest": "27.4.1",
-        "@types/node": "17.0.21",
+        "@types/node": "17.0.27",
         "@types/node-fetch": "2.6.1",
         "@types/qs": "6.9.7",
-        "@typescript-eslint/eslint-plugin": "5.13.0",
-        "@typescript-eslint/parser": "5.13.0",
+        "@typescript-eslint/eslint-plugin": "5.21.0",
+        "@typescript-eslint/parser": "5.21.0",
         "abort-controller": "3.0.0",
-        "axios": "0.26.0",
+        "axios": "0.27.1",
         "codecov": "3.8.3",
         "cross-spawn": "7.0.3",
-        "eslint": "8.10.0",
-        "eslint-config-prettier": "8.4.0",
+        "eslint": "8.14.0",
+        "eslint-config-prettier": "8.5.0",
         "eslint-plugin-prettier": "4.0.0",
         "eslint-plugin-simple-import-sort": "7.0.0",
-        "express": "4.17.3",
+        "express": "4.18.0",
         "form-data": "4.0.0",
-        "glob": "7.2.0",
-        "jest": "27.5.1",
-        "jest-cli": "27.5.1",
+        "glob": "8.0.1",
+        "jest": "28.0.1",
+        "jest-cli": "28.0.1",
         "node-fetch": "2.6.7",
-        "prettier": "2.5.1",
-        "puppeteer": "13.4.0",
+        "prettier": "2.6.2",
+        "puppeteer": "13.6.0",
         "qs": "6.10.3",
         "rimraf": "3.0.2",
-        "rollup": "2.68.0",
+        "rollup": "2.70.2",
         "rollup-plugin-node-externals": "4.0.0",
         "rollup-plugin-terser": "7.0.2",
-        "rxjs": "7.5.4",
-        "ts-node": "10.5.0",
-        "tslib": "2.3.1",
-        "typescript": "4.5.5",
-        "zone.js": "0.11.4"
+        "rxjs": "7.5.5",
+        "ts-node": "10.7.0",
+        "tslib": "2.4.0",
+        "typescript": "4.6.3",
+        "zone.js": "0.11.5"
     }
 }

package.json

@@ -14,7 +14,7 @@ export const extendEnum = (enumerators: Enum[], definition: WithEnumExtension):
 
     return enumerators.map((enumerator, index) => ({
         name: names?.[index] || enumerator.name,
-        description: JSON.stringify(descriptions?.[index] || enumerator.description),
+        description: descriptions?.[index] || enumerator.description,
         value: enumerator.value,
         type: enumerator.type,
     }));

src/openApi/v2/parser/extendEnum.ts

@@ -1,13 +1,14 @@
 import type { Enum } from '../../../client/interfaces/Enum';
-import { isDefined } from '../../../utils/isDefined';
 
 export const getEnum = (values?: (string | number)[]): Enum[] => {
     if (Array.isArray(values)) {
         return values
             .filter((value, index, arr) => {
                 return arr.indexOf(value) === index;
             })
-            .filter(isDefined)
+            .filter((value: any) => {
+                return typeof value === 'number' || typeof value === 'string';
+            })
             .map(value => {
                 if (typeof value === 'number') {
                     return {

src/openApi/v2/parser/getEnum.ts

@@ -4,7 +4,6 @@ import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import { extendEnum } from './extendEnum';
 import { getEnum } from './getEnum';
-import { getEnumFromDescription } from './getEnumFromDescription';
 import { getModelComposition } from './getModelComposition';
 import { getModelProperties } from './getModelProperties';
 import { getType } from './getType';
@@ -69,17 +68,6 @@ export const getModel = (
         }
     }
 
-    if ((definition.type === 'int' || definition.type === 'integer') && definition.description) {
-        const enumerators = getEnumFromDescription(definition.description);
-        if (enumerators.length) {
-            model.export = 'enum';
-            model.type = 'number';
-            model.base = 'number';
-            model.enum.push(...enumerators);
-            return model;
-        }
-    }
-
     if (definition.type === 'array' && definition.items) {
         if (definition.items.$ref) {
             const arrayItems = getType(definition.items.$ref);

src/openApi/v2/parser/getEnumFromDescription.ts

@@ -5,7 +5,6 @@ import type { OpenApiParameter } from '../interfaces/OpenApiParameter';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import { extendEnum } from './extendEnum';
 import { getEnum } from './getEnum';
-import { getEnumFromDescription } from './getEnumFromDescription';
 import { getModel } from './getModel';
 import { getOperationParameterDefault } from './getOperationParameterDefault';
 import { getOperationParameterName } from './getOperationParameterName';
@@ -70,18 +69,6 @@ export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParame
         }
     }
 
-    if ((parameter.type === 'int' || parameter.type === 'integer') && parameter.description) {
-        const enumerators = getEnumFromDescription(parameter.description);
-        if (enumerators.length) {
-            operationParameter.export = 'enum';
-            operationParameter.type = 'number';
-            operationParameter.base = 'number';
-            operationParameter.enum.push(...enumerators);
-            operationParameter.default = getOperationParameterDefault(parameter, operationParameter);
-            return operationParameter;
-        }
-    }
-
     if (parameter.type === 'array' && parameter.items) {
         const items = getType(parameter.items.type, parameter.items.format);
         operationParameter.export = 'array';