Merge branch 'master' of https://github.com/CanoaPBC/openapi-typescript-codegen into union-bugs

Author: mrlubos

.github/workflows/unittest.yml

@@ -6,15 +6,32 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - name: Checkout
+        uses: actions/checkout@v4.1.1
+
+      - name: Setup Node environment
+        uses: actions/setup-node@v4.0.1
         with:
           node-version: 20
+
       - name: Cache Modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: "**/node_modules"
           key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
-      - run: npm install
-      - run: npm run test
+
+      - 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
 

README.md

@@ -44,7 +44,7 @@ $ openapi --help
     --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 (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

@@ -29,13 +29,15 @@ const params = program
 
 const OpenAPI = require(path.resolve(__dirname, '../dist/index.js'));
 
-if (OpenAPI) {
-    let exportServices;
+const parseBooleanOrString = value => {
     try {
-        exportServices = JSON.parse(params.exportServices) === true;
+        return JSON.parse(value) === true;
     } catch (error) {
-        exportServices = params.exportServices;
+        return value;
     }
+};
+
+if (OpenAPI) {
     OpenAPI.generate({
         input: params.input,
         output: params.output,
@@ -44,8 +46,8 @@ if (OpenAPI) {
         useOptions: params.useOptions,
         useUnionTypes: params.useUnionTypes,
         exportCore: JSON.parse(params.exportCore) === true,
-        exportServices,
-        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,7 +43,7 @@ describe('bin', () => {
         expect(result.stderr.toString()).toBe('');
     });
 
-    it('it should support regexp in exportSchemas', async () => {
+    it('it should support regexp params', async () => {
         const result = crossSpawn.sync('node', [
             './bin/index.js',
             '--input',
@@ -52,6 +52,8 @@ describe('bin', () => {
             './test/generated/bin',
             '--exportServices',
             '^(Simple|Types)',
+            '--exportModels',
+            '^(Simple|Types)',
         ]);
         expect(result.stdout.toString()).toBe('');
         expect(result.stderr.toString()).toBe('');

package.json

@@ -1,5 +1,5 @@
 {
-    "name": "@canoapbc/openapi-typescript-codegen",
+    "name": "@nicolas-chaulet/openapi-typescript-codegen",
     "version": "0.27.2",
     "description": "Library that generates Typescript clients based on the OpenAPI specification.",
     "author": "Ferdi Koomen",

src/index.ts

@@ -21,7 +21,7 @@ export type Options = {
     useUnionTypes?: boolean;
     exportCore?: boolean;
     exportServices?: boolean | string;
-    exportModels?: boolean;
+    exportModels?: boolean | string;
     exportSchemas?: boolean;
     indent?: Indent;
     postfixServices?: string;

src/utils/writeClient.ts

@@ -42,7 +42,7 @@ export const writeClient = async (
     useUnionTypes: boolean,
     exportCore: boolean,
     exportServices: boolean | string,
-    exportModels: boolean,
+    exportModels: boolean | string,
     exportSchemas: boolean,
     indent: Indent,
     postfixServices: string,
@@ -65,6 +65,11 @@ export const writeClient = async (
         client.services = client.services.filter(service => regexp.test(service.name));
     }
 
+    if (typeof exportModels === 'string') {
+        const regexp = new RegExp(exportModels);
+        client.models = client.models.filter(model => regexp.test(model.name));
+    }
+
     if (exportCore) {
         await rmdir(outputPathCore);
         await mkdir(outputPathCore);

src/utils/writeClientIndex.ts

@@ -30,7 +30,7 @@ export const writeClientIndex = async (
     useUnionTypes: boolean,
     exportCore: boolean,
     exportServices: boolean | string,
-    exportModels: boolean,
+    exportModels: boolean | string,
     exportSchemas: boolean,
     postfixServices: string,
     postfixModels: string,

types/index.d.ts

@@ -21,7 +21,7 @@ export type Options = {
     useUnionTypes?: boolean;
     exportCore?: boolean;
     exportServices?: boolean | string;
-    exportModels?: boolean;
+    exportModels?: boolean | string;
     exportSchemas?: boolean;
     indent?: Indent | '4' | '2' | 'tab';
     postfixServices?: string;