Merge pull request #48 from nicolas-chaulet/feat/remove-union-types-flag

feat(parser): remove useUnionTypes flag

Author: mrlubos

.npmrc

@@ -0,0 +1 @@
+save-exact=true

README.md

@@ -50,7 +50,6 @@ $ openapi --help
     -c, --client <value>      HTTP client to generate [fetch, xhr, node, axios, angular] (default: "fetch")
     --name <value>            Custom client class name
     --useOptions <value>      Use options instead of arguments (default: false)
-    --useUnionTypes           Use union types instead of enums
     --exportCore <value>      Write core files to disk (default: true)
     --exportServices <value>  Write services to disk [true, false, regexp] (default: true)
     --exportModels <value>    Write models to disk [true, false, regexp] (default: true)

bin/index.js

@@ -15,7 +15,6 @@ const params = program
     .option('-c, --client <value>', 'HTTP client to generate [fetch, xhr, node, axios, angular]', 'fetch')
     .option('--name <value>', 'Custom client class name')
     .option('--useOptions [value]', 'Use options instead of arguments', false)
-    .option('--useUnionTypes', 'Use union types instead of enums')
     .option('--autoformat', 'Process generated files with autoformatter', false)
     .option('--base [value]', 'Manually set base in OpenAPI config instead of inferring from server value')
     .option('--exportCore <value>', 'Write core files to disk', true)

bin/index.spec.js

@@ -23,7 +23,6 @@ describe('bin', () => {
             '--client',
             'fetch',
             '--useOptions',
-            '--useUnionTypes',
             '--exportCore',
             'true',
             '--exportServices',

package-lock.json

@@ -60,11 +60,12 @@
         "docker": "docker build -t eeelenbaas/openapi-typescript-codegen ."
     },
     "dependencies": {
-        "@apidevtools/json-schema-ref-parser": "^11.1.0",
-        "camelcase": "^6.3.0",
-        "commander": "^11.1.0",
-        "fs-extra": "^11.2.0",
-        "handlebars": "^4.7.8"
+        "@apidevtools/json-schema-ref-parser": "11.5.4",
+        "camelcase": "6.3.0",
+        "commander": "11.1.0",
+        "fs-extra": "11.2.0",
+        "handlebars": "4.7.8",
+        "node-fetch": "2.7.0"
     },
     "devDependencies": {
         "@angular-devkit/build-angular": "17.0.9",
@@ -92,7 +93,7 @@
         "@types/glob": "8.1.0",
         "@types/jest": "29.5.12",
         "@types/node": "20.11.17",
-        "@types/node-fetch": "2.6.10",
+        "@types/node-fetch": "2.6.11",
         "@types/qs": "6.9.11",
         "@typescript-eslint/eslint-plugin": "6.21.0",
         "@typescript-eslint/parser": "6.21.0",
@@ -109,9 +110,8 @@
         "glob": "10.3.10",
         "jest": "29.7.0",
         "jest-cli": "29.7.0",
-        "node-fetch": "2.7.0",
         "prettier": "3.2.5",
-        "puppeteer": "21.11.0",
+        "puppeteer": "22.4.1",
         "qs": "6.11.2",
         "rimraf": "5.0.5",
         "rollup": "4.7.0",

package.json

@@ -30,20 +30,24 @@ const handlebarsPlugin = () => ({
                 knownHelpersOnly: true,
                 knownHelpers: {
                     camelCase: true,
-                    containsSpaces: true,
-                    enumerator: true,
+                    debugThis: true,
+                    enumKey: true,
+                    enumName: true,
+                    enumUnionType: true,
+                    enumValue: true,
                     equals: true,
                     escapeComment: true,
                     escapeDescription: true,
-                    escapeEnumName: true,
                     escapeNewline: true,
                     exactArray: true,
                     ifdef: true,
                     ifOperationDataOptional: true,
+                    inlineEnum: true,
                     intersection: true,
+                    modelImports: true,
+                    modelUnionType: true,
                     nameOperationDataType: true,
                     notEquals: true,
-                    union: true,
                     useDateType: true,
                 },
             });

rollup.config.mjs

@@ -1,6 +1,6 @@
 export interface Enum {
-    name: string;
-    value: string;
-    type: string;
-    description: string | null;
+    'x-enum-description'?: string;
+    'x-enum-varname'?: string;
+    description?: string;
+    value: string | number;
 }

src/client/interfaces/Enum.d.ts

@@ -2,27 +2,33 @@ import type { Enum } from './Enum';
 import type { Schema } from './Schema';
 
 export interface Model extends Schema {
-    name: string;
+    /**
+     * **Experimental.** Contains list of original refs so they can be used
+     * to access the schema from anywhere instead of relying on string name.
+     * This allows us to do things like detect type of ref.
+     */
+    $refs: string[];
+    base: string;
+    default?: string;
+    deprecated?: boolean;
+    description: string | null;
+    enum: Enum[];
+    enums: Model[];
     export:
-        | 'reference'
-        | 'generic'
-        | 'enum'
+        | 'all-of'
+        | 'any-of'
         | 'array'
+        | 'const'
         | 'dictionary'
+        | 'enum'
+        | 'generic'
         | 'interface'
         | 'one-of'
-        | 'any-of'
-        | 'all-of'
-        | 'const';
-    type: string;
-    base: string;
-    template: string | null;
-    link: Model | null;
-    description: string | null;
-    deprecated?: boolean;
-    default?: string;
+        | 'reference';
     imports: string[];
-    enum: Enum[];
-    enums: Model[];
+    link: Model | null;
+    name: string;
     properties: Model[];
+    template: string | null;
+    type: string;
 }

src/client/interfaces/Model.d.ts

@@ -1,8 +1,5 @@
 import type { Model } from './Model';
 
-export interface ModelComposition {
-    enums: Model[];
-    export: 'one-of' | 'any-of' | 'all-of';
-    imports: string[];
-    properties: Model[];
+export interface ModelComposition extends Pick<Model, '$refs' | 'enums' | 'imports' | 'properties'> {
+    export: Extract<Model['export'], 'all-of' | 'any-of' | 'one-of'>;
 }