Merge branch 'master' into non-ascii-identifiers

Author: mrlubos

.github/workflows/unittest.yml

@@ -0,0 +1,37 @@
+name: unittest
+
+on: [pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/[email protected]
+
+      - name: Setup Node environment
+        uses: actions/[email protected]
+        with:
+          node-version: 20
+
+      - name: Cache Modules
+        uses: actions/cache@v4
+        with:
+          path: "**/node_modules"
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build library
+        run: npm run release
+
+      - name: Run unit tests
+        run: npm run test
+
+      # - name: Run e2e tests
+      #   run: npm run test:e2e
+
+      # - name: Submit to Codecov
+      #   run: npm run codecov
+

.gitignore

@@ -15,3 +15,4 @@ test/e2e/generated
 samples/generated
 samples/swagger-codegen-cli-v2.jar
 samples/swagger-codegen-cli-v3.jar
+.env

README.md

@@ -43,8 +43,8 @@ $ openapi --help
     --useOptions              Use options instead of arguments
     --useUnionTypes           Use union types instead of enums
     --exportCore <value>      Write core files to disk (default: true)
-    --exportServices <value>  Write services to disk (default: true)
-    --exportModels <value>    Write models 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)
     --exportSchemas <value>   Write schemas to disk (default: false)
     --indent <value>          Indentation options [4, 2, tab] (default: "4")
     --postfixServices         Service name postfix (default: "Service")

bin/index.js

@@ -16,6 +16,7 @@ const params = program
     .option('--name <value>', 'Custom client class name')
     .option('--useOptions', 'Use options instead of arguments')
     .option('--useUnionTypes', 'Use union types instead of enums')
+    .option('--autoformat', 'Process generated files with autoformatter', false)
     .option('--exportCore <value>', 'Write core files to disk', true)
     .option('--exportServices <value>', 'Write services to disk', true)
     .option('--exportModels <value>', 'Write models to disk', true)
@@ -29,6 +30,14 @@ const params = program
 
 const OpenAPI = require(path.resolve(__dirname, '../dist/index.js'));
 
+const parseBooleanOrString = value => {
+    try {
+        return JSON.parse(value) === true;
+    } catch (error) {
+        return value;
+    }
+};
+
 if (OpenAPI) {
     OpenAPI.generate({
         input: params.input,
@@ -37,9 +46,10 @@ if (OpenAPI) {
         clientName: params.name,
         useOptions: params.useOptions,
         useUnionTypes: params.useUnionTypes,
+        autoformat: JSON.parse(params.autoformat) === true,
         exportCore: JSON.parse(params.exportCore) === true,
-        exportServices: JSON.parse(params.exportServices) === true,
-        exportModels: JSON.parse(params.exportModels) === true,
+        exportServices: parseBooleanOrString(params.exportServices),
+        exportModels: parseBooleanOrString(params.exportModels),
         exportSchemas: JSON.parse(params.exportSchemas) === true,
         indent: params.indent,
         postfixServices: params.postfixServices,

bin/index.spec.js

@@ -43,6 +43,35 @@ describe('bin', () => {
         expect(result.stderr.toString()).toBe('');
     });
 
+    it('it should support regexp params', async () => {
+        const result = crossSpawn.sync('node', [
+            './bin/index.js',
+            '--input',
+            './test/spec/v3.json',
+            '--output',
+            './test/generated/bin',
+            '--exportServices',
+            '^(Simple|Types)',
+            '--exportModels',
+            '^(Simple|Types)',
+        ]);
+        expect(result.stdout.toString()).toBe('');
+        expect(result.stderr.toString()).toBe('');
+    });
+
+    it('should autoformat with Prettier', async () => {
+        const result = crossSpawn.sync('node', [
+            './bin/index.js',
+            '--input',
+            './test/spec/v3.json',
+            '--output',
+            './test/generated/bin',
+            '--autoformat',
+        ]);
+        expect(result.stdout.toString()).toBe('');
+        expect(result.stderr.toString()).toBe('');
+    });
+
     it('it should throw error without params', async () => {
         const result = crossSpawn.sync('node', ['./bin/index.js']);
         expect(result.stdout.toString()).toBe('');

package-lock.json

@@ -1,12 +1,12 @@
 {
-    "name": "openapi-typescript-codegen",
-    "version": "0.27.0",
+    "name": "@nicolas-chaulet/openapi-typescript-codegen",
+    "version": "0.27.6",
     "description": "Library that generates Typescript clients based on the OpenAPI specification.",
     "author": "Ferdi Koomen",
-    "homepage": "https://github.com/ferdikoomen/openapi-typescript-codegen",
+    "homepage": "https://github.com/CanoaPBC/openapi-typescript-codegen",
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/ferdikoomen/openapi-typescript-codegen.git"
+        "url": "git+https://github.com/CanoaPBC/openapi-typescript-codegen.git"
     },
     "bugs": {
         "url": "https://github.com/ferdikoomen/openapi-typescript-codegen/issues"

package.json

@@ -3,7 +3,17 @@ import type { Schema } from './Schema';
 
 export interface Model extends Schema {
     name: string;
-    export: 'reference' | 'generic' | 'enum' | 'array' | 'dictionary' | 'interface' | 'one-of' | 'any-of' | 'all-of';
+    export:
+        | 'reference'
+        | 'generic'
+        | 'enum'
+        | 'array'
+        | 'dictionary'
+        | 'interface'
+        | 'one-of'
+        | 'any-of'
+        | 'all-of'
+        | 'const';
     type: string;
     base: string;
     template: string | null;

src/client/interfaces/Model.d.ts

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

src/client/interfaces/ModelComposition.d.ts

@@ -19,9 +19,10 @@ export type Options = {
     clientName?: string;
     useOptions?: boolean;
     useUnionTypes?: boolean;
+    autoformat?: boolean;
     exportCore?: boolean;
-    exportServices?: boolean;
-    exportModels?: boolean;
+    exportServices?: boolean | string;
+    exportModels?: boolean | string;
     exportSchemas?: boolean;
     indent?: Indent;
     postfixServices?: string;
@@ -57,6 +58,7 @@ export const generate = async ({
     clientName,
     useOptions = false,
     useUnionTypes = false,
+    autoformat = false,
     exportCore = true,
     exportServices = true,
     exportModels = true,
@@ -75,42 +77,32 @@ export const generate = async ({
         useOptions,
     });
 
+    let parser: typeof parseV2 | typeof parseV3;
+
     switch (openApiVersion) {
         case OpenApiVersion.V2: {
-            const client = parseV2(openApi);
-            const clientFinal = postProcessClient(client);
-            if (!write) break;
-            await writeClient(
-                clientFinal,
-                templates,
-                output,
-                httpClient,
-                useOptions,
-                useUnionTypes,
-                exportCore,
-                exportServices,
-                exportModels,
-                exportSchemas,
-                indent,
-                postfixServices,
-                postfixModels,
-                clientName,
-                request
-            );
+            parser = parseV2;
             break;
         }
 
         case OpenApiVersion.V3: {
-            const client = parseV3(openApi);
-            const clientFinal = postProcessClient(client);
-            if (!write) break;
+            parser = parseV3;
+            break;
+        }
+    }
+
+    if (parser) {
+        const client = parser(openApi);
+        const clientFinal = postProcessClient(client);
+        if (write) {
             await writeClient(
                 clientFinal,
                 templates,
                 output,
                 httpClient,
                 useOptions,
                 useUnionTypes,
+                autoformat,
                 exportCore,
                 exportServices,
                 exportModels,
@@ -121,7 +113,6 @@ export const generate = async ({
                 clientName,
                 request
             );
-            break;
         }
     }
 };