Merge branch 'master' into feature/optionalDataTypeChange

Author: NicoVogel

.eslintrc.json

@@ -24,7 +24,8 @@
         "@typescript-eslint/explicit-module-boundary-types": 0,
         "sort-imports": "off",
         "import/order": "off",
-        "simple-import-sort/sort": "error",
+        "simple-import-sort/imports": "error",
+        "simple-import-sort/exports": "error",
         "prettier/prettier": ["error"]
     }
 }

README.md

@@ -130,7 +130,7 @@ The OpenAPI spec allows you to define [enums](https://swagger.io/docs/specificat
 data model. By default, we convert these enums definitions to [TypeScript enums](https://www.typescriptlang.org/docs/handbook/enums.html).
 However, these enums are merged inside the namespace of the model, this is unsupported by Babel, [see docs](https://babeljs.io/docs/en/babel-plugin-transform-typescript#impartial-namespace-support).
 Because we also want to support projects that use Babel [@babel/plugin-transform-typescript](https://babeljs.io/docs/en/babel-plugin-transform-typescript),
-we offer the flag `--useOptions` to generate [union types](https://www.typescriptlang.org/docs/handbook/unions-and-intersections.html#union-types)
+we offer the flag `--useUnionTypes` to generate [union types](https://www.typescriptlang.org/docs/handbook/unions-and-intersections.html#union-types)
 instead of the traditional enums. The difference can be seen below:
 
 **Enums:**
@@ -441,6 +441,16 @@ npm install node-fetch --save-dev
 npm install form-data --save-dev
 ```
 
+In order to compile the project and resolve the imports, you will need to enable the `allowSyntheticDefaultImports`
+in your `tsconfig.json` file.
+
+```json
+{
+    "allowSyntheticDefaultImports": true
+}
+```
+
+
 [npm-url]: https://npmjs.org/package/openapi-typescript-codegen
 [npm-image]: https://img.shields.io/npm/v/openapi-typescript-codegen.svg
 [license-url]: LICENSE

bin/index.js

@@ -20,6 +20,7 @@ program
     .option('--exportModels <value>', 'Write models to disk', true)
     .option('--exportSchemas <value>', 'Write schemas to disk', false)
     .option('--useDateType', 'Output Date instead of string for the format "date-time" in the models')
+    .option('--request <value>', 'Path to custom request file')
     .parse(process.argv);
 
 const OpenAPI = require(path.resolve(__dirname, '../dist/index.js'));
@@ -36,6 +37,7 @@ if (OpenAPI) {
         exportModels: JSON.parse(program.exportModels) === true,
         exportSchemas: JSON.parse(program.exportSchemas) === true,
         useDateType: program.useDateType,
+        request: program.request,
     })
         .then(() => {
             process.exit(0);

jest.config.js

@@ -1,3 +1,5 @@
+'use strict';
+
 module.exports = {
     projects: [
         {
@@ -7,6 +9,7 @@ module.exports = {
                 '<rootDir>/src/**/*.spec.ts',
                 '<rootDir>/test/index.spec.js',
             ],
+            moduleFileExtensions: ['js', 'ts', 'd.ts'],
             moduleNameMapper: {
                 '\\.hbs$': '<rootDir>/src/templates/__mocks__/index.js',
             },

logo.png

@@ -1,7 +1,7 @@
 {
     "name": "openapi-typescript-codegen",
-    "version": "0.5.3",
-    "description": "NodeJS library that generates Typescript or Javascript clients based on the OpenAPI specification.",
+    "version": "0.7.2",
+    "description": "Library that generates Typescript clients based on the OpenAPI specification.",
     "author": "Ferdi Koomen",
     "homepage": "https://github.com/ferdikoomen/openapi-typescript-codegen",
     "repository": {
@@ -19,7 +19,6 @@
         "generator",
         "client",
         "typescript",
-        "javascript",
         "yaml",
         "json",
         "fetch",
@@ -62,47 +61,45 @@
         "codecov": "codecov --token=66c30c23-8954-4892-bef9-fbaed0a2e42b"
     },
     "dependencies": {
-        "camelcase": "6.1.0",
-        "commander": "6.2.0",
-        "handlebars": "4.7.6",
-        "js-yaml": "3.14.0",
-        "mkdirp": "1.0.4",
-        "path": "0.12.7",
-        "rimraf": "3.0.2"
+        "camelcase": "^6.2.0",
+        "commander": "^6.2.0",
+        "handlebars": "^4.7.6",
+        "js-yaml": "^3.14.0",
+        "mkdirp": "^1.0.4",
+        "rimraf": "^3.0.2"
     },
     "devDependencies": {
-        "@babel/cli": "7.12.1",
-        "@babel/core": "7.11.6",
-        "@babel/preset-env": "7.11.5",
-        "@babel/preset-typescript": "7.10.4",
-        "@rollup/plugin-commonjs": "15.1.0",
-        "@rollup/plugin-node-resolve": "9.0.0",
-        "@types/express": "4.17.8",
-        "@types/jest": "26.0.14",
+        "@babel/cli": "7.12.10",
+        "@babel/core": "7.12.9",
+        "@babel/preset-env": "7.12.10",
+        "@babel/preset-typescript": "7.12.7",
+        "@rollup/plugin-commonjs": "17.0.0",
+        "@rollup/plugin-node-resolve": "11.0.0",
+        "@types/express": "4.17.9",
+        "@types/jest": "26.0.19",
         "@types/js-yaml": "3.12.5",
-        "@types/node": "14.11.8",
+        "@types/node": "14.14.13",
         "@types/node-fetch": "2.5.7",
-        "@typescript-eslint/eslint-plugin": "4.4.1",
-        "@typescript-eslint/parser": "4.6.0",
-        "codecov": "3.8.0",
-        "eslint": "7.11.0",
-        "eslint-config-prettier": "6.12.0",
-        "eslint-plugin-prettier": "3.1.4",
-        "eslint-plugin-simple-import-sort": "5.0.3",
+        "@types/qs": "6.9.4",
+        "@typescript-eslint/eslint-plugin": "4.9.1",
+        "@typescript-eslint/parser": "4.9.1",
+        "codecov": "3.8.1",
+        "eslint": "7.15.0",
+        "eslint-config-prettier": "7.0.0",
+        "eslint-plugin-prettier": "3.3.0",
+        "eslint-plugin-simple-import-sort": "7.0.0",
         "express": "4.17.1",
         "form-data": "3.0.0",
         "glob": "7.1.6",
-        "jest": "26.5.3",
-        "jest-cli": "26.5.3",
+        "jest": "26.6.3",
+        "jest-cli": "26.6.3",
         "node-fetch": "2.6.1",
-        "prettier": "2.1.2",
-        "puppeteer": "5.4.0",
-        "rollup": "2.29.0",
+        "prettier": "2.2.1",
+        "puppeteer": "5.5.0",
+        "qs": "6.9.4",
+        "rollup": "2.34.2",
         "rollup-plugin-terser": "7.0.2",
-        "rollup-plugin-typescript2": "0.28.0",
-        "typescript": "4.0.3"
-    },
-    "resolutions": {
-        "terser": "5.3.5"
+        "rollup-plugin-typescript2": "0.29.0",
+        "typescript": "4.1.3"
     }
 }

package.json

@@ -34,6 +34,8 @@ const handlebarsPlugin = () => ({
                 knownHelpers: {
                     equals: true,
                     notEquals: true,
+                    containsSpaces: true,
+                    union: true,
                 },
             });
             return `export default ${templateSpec};`;
@@ -65,6 +67,7 @@ module.exports = {
         'fs',
         'os',
         'util',
+        'path',
         'http',
         'https',
         'handlebars/runtime',

rollup.config.js

@@ -0,0 +1,5 @@
+export enum HttpClient {
+    FETCH = 'fetch',
+    XHR = 'xhr',
+    NODE = 'node',
+}

src/HttpClient.ts

@@ -3,18 +3,15 @@ import type { Schema } from './Schema';
 
 export interface Model extends Schema {
     name: string;
-    export: 'reference' | 'generic' | 'enum' | 'array' | 'dictionary' | 'interface';
+    export: 'reference' | 'generic' | 'enum' | 'array' | 'dictionary' | 'interface' | 'one-of' | 'any-of' | 'all-of';
     type: string;
     base: string;
     template: string | null;
     link: Model | null;
     description: string | null;
     default?: string;
     imports: string[];
-    extends: string[];
     enum: Enum[];
     enums: Model[];
     properties: Model[];
-    extendedFrom?: string[];
-    extendedBy?: string[];
 }

src/client/interfaces/Model.d.ts

@@ -0,0 +1,8 @@
+import type { Model } from './Model';
+
+export interface ModelComposition {
+    type: 'one-of' | 'any-of' | 'all-of';
+    imports: string[];
+    enums: Model[];
+    properties: Model[];
+}