Upgrade typegen

README.md

@@ -94,7 +94,7 @@ EXAMPLES
   $ openapi auth --security BasicAuth --username admin --password password
 ```
 
-_See code: [src/commands/auth.ts](https://github.com/openapistack/openapicmd/blob/v2.4.0/src/commands/auth.ts)_
+_See code: [src/commands/auth.ts](https://github.com/openapistack/openapicmd/blob/v2.5.0/src/commands/auth.ts)_
 
 ## `openapi call [DEFINITION]`
 
@@ -149,7 +149,7 @@ EXAMPLES
   $ openapi call -o createPet -d '{ "name": "Garfield" }'
 ```
 
-_See code: [src/commands/call.ts](https://github.com/openapistack/openapicmd/blob/v2.4.0/src/commands/call.ts)_
+_See code: [src/commands/call.ts](https://github.com/openapistack/openapicmd/blob/v2.5.0/src/commands/call.ts)_
 
 ## `openapi help [COMMAND]`
 
@@ -213,7 +213,7 @@ EXAMPLES
   $ openapi info ./openapi.yml
 ```
 
-_See code: [src/commands/info.ts](https://github.com/openapistack/openapicmd/blob/v2.4.0/src/commands/info.ts)_
+_See code: [src/commands/info.ts](https://github.com/openapistack/openapicmd/blob/v2.5.0/src/commands/info.ts)_
 
 ## `openapi init`
 
@@ -246,7 +246,7 @@ EXAMPLES
   $ openapi init --title 'My API' > openapi.yml
 ```
 
-_See code: [src/commands/init.ts](https://github.com/openapistack/openapicmd/blob/v2.4.0/src/commands/init.ts)_
+_See code: [src/commands/init.ts](https://github.com/openapistack/openapicmd/blob/v2.5.0/src/commands/init.ts)_
 
 ## `openapi load DEFINITION`
 
@@ -273,7 +273,7 @@ EXAMPLES
   $ openapi load https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml
 ```
 
-_See code: [src/commands/load.ts](https://github.com/openapistack/openapicmd/blob/v2.4.0/src/commands/load.ts)_
+_See code: [src/commands/load.ts](https://github.com/openapistack/openapicmd/blob/v2.5.0/src/commands/load.ts)_
 
 ## `openapi mock [DEFINITION]`
 
@@ -312,7 +312,7 @@ EXAMPLES
   $ openapi mock https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml
 ```
 
-_See code: [src/commands/mock.ts](https://github.com/openapistack/openapicmd/blob/v2.4.0/src/commands/mock.ts)_
+_See code: [src/commands/mock.ts](https://github.com/openapistack/openapicmd/blob/v2.5.0/src/commands/mock.ts)_
 
 ## `openapi read [DEFINITION]`
 
@@ -357,7 +357,7 @@ EXAMPLES
   $ openapi read ./openapi.yml -f json > openapi.json
 ```
 
-_See code: [src/commands/read.ts](https://github.com/openapistack/openapicmd/blob/v2.4.0/src/commands/read.ts)_
+_See code: [src/commands/read.ts](https://github.com/openapistack/openapicmd/blob/v2.5.0/src/commands/read.ts)_
 
 ## `openapi redoc [DEFINITION]`
 
@@ -397,7 +397,7 @@ EXAMPLES
   $ openapi redoc ./openapi.yml --bundle outDir
 ```
 
-_See code: [src/commands/redoc.ts](https://github.com/openapistack/openapicmd/blob/v2.4.0/src/commands/redoc.ts)_
+_See code: [src/commands/redoc.ts](https://github.com/openapistack/openapicmd/blob/v2.5.0/src/commands/redoc.ts)_
 
 ## `openapi swagger-editor [DEFINITION]`
 
@@ -425,7 +425,7 @@ EXAMPLES
   $ openapi swagger-editor ./openapi.yml
 ```
 
-_See code: [src/commands/swagger-editor.ts](https://github.com/openapistack/openapicmd/blob/v2.4.0/src/commands/swagger-editor.ts)_
+_See code: [src/commands/swagger-editor.ts](https://github.com/openapistack/openapicmd/blob/v2.5.0/src/commands/swagger-editor.ts)_
 
 ## `openapi swagger-ui [DEFINITION]`
 
@@ -476,7 +476,7 @@ EXAMPLES
   $ openapi swagger-ui ./openapi.yml --bundle outDir
 ```
 
-_See code: [src/commands/swagger-ui.ts](https://github.com/openapistack/openapicmd/blob/v2.4.0/src/commands/swagger-ui.ts)_
+_See code: [src/commands/swagger-ui.ts](https://github.com/openapistack/openapicmd/blob/v2.5.0/src/commands/swagger-ui.ts)_
 
 ## `openapi swagger2openapi [DEFINITION]`
 
@@ -519,7 +519,7 @@ EXAMPLES
   $ openapi swagger2openapi --yaml ./swagger.json > openapi.yml
 ```
 
-_See code: [src/commands/swagger2openapi.ts](https://github.com/openapistack/openapicmd/blob/v2.4.0/src/commands/swagger2openapi.ts)_
+_See code: [src/commands/swagger2openapi.ts](https://github.com/openapistack/openapicmd/blob/v2.5.0/src/commands/swagger2openapi.ts)_
 
 ## `openapi test`
 
@@ -565,7 +565,7 @@ EXAMPLES
   $ openapi test -o getPets
 ```
 
-_See code: [src/commands/test/index.ts](https://github.com/openapistack/openapicmd/blob/v2.4.0/src/commands/test/index.ts)_
+_See code: [src/commands/test/index.ts](https://github.com/openapistack/openapicmd/blob/v2.5.0/src/commands/test/index.ts)_
 
 ## `openapi test add [DEFINITION]`
 
@@ -620,7 +620,7 @@ EXAMPLES
   $ openapi test add -o getPet --checks all
 ```
 
-_See code: [src/commands/test/add.ts](https://github.com/openapistack/openapicmd/blob/v2.4.0/src/commands/test/add.ts)_
+_See code: [src/commands/test/add.ts](https://github.com/openapistack/openapicmd/blob/v2.5.0/src/commands/test/add.ts)_
 
 ## `openapi typegen [DEFINITION]`
 
@@ -629,12 +629,15 @@ Generate types from openapi definition
 ```
 USAGE
   $ openapi typegen [DEFINITION] [-h] [-D] [-B] [-R /] [-H <value>...] [-V] [-S http://localhost:9000...] [-I
-    {"info":{"version":"1.0.0"}}...] [-E x-internal] [-C default|all|openapi_client_axios|openapi_backend] [-U]
+    {"info":{"version":"1.0.0"}}...] [-E x-internal] [-C default|all|openapi_client_axios|openapi_backend] [-U] [-b
+    <value>] [-A]
 
 ARGUMENTS
   DEFINITION  input definition file
 
 FLAGS
+  -A, --[no-]type-aliases                                       Generate module level type aliases for schema components
+                                                                defined in spec
   -B, --bundle                                                  resolve remote $ref pointers
   -C, --strip=default|all|openapi_client_axios|openapi_backend  Strip optional metadata such as examples and
                                                                 descriptions from definition
@@ -649,6 +652,8 @@ FLAGS
                                                                 component being removed by setting x-openapicmd-keep to
                                                                 true
   -V, --validate                                                validate against openapi schema
+  -b, --banner=<value>                                          include a banner comment at the top of the generated
+                                                                file
   -h, --help                                                    Show CLI help.
 
 DESCRIPTION
@@ -658,7 +663,7 @@ EXAMPLES
   $ openapi typegen ./openapi.yml > openapi.d.ts
 ```
 
-_See code: [src/commands/typegen.ts](https://github.com/openapistack/openapicmd/blob/v2.4.0/src/commands/typegen.ts)_
+_See code: [src/commands/typegen.ts](https://github.com/openapistack/openapicmd/blob/v2.5.0/src/commands/typegen.ts)_
 
 ## `openapi unload`
 
@@ -678,7 +683,7 @@ EXAMPLES
   $ openapi unload
 ```
 
-_See code: [src/commands/unload.ts](https://github.com/openapistack/openapicmd/blob/v2.4.0/src/commands/unload.ts)_
+_See code: [src/commands/unload.ts](https://github.com/openapistack/openapicmd/blob/v2.5.0/src/commands/unload.ts)_
 <!-- commandsstop -->
 
 ## Commercial support

package.json

@@ -39,7 +39,7 @@
     "koa-static": "^5.0.0",
     "openapi-backend": "^5.6.2",
     "openapi-client-axios": "^7.5.5",
-    "openapi-client-axios-typegen": "^7.6.2",
+    "openapi-client-axios-typegen": "^7.7.0",
     "swagger-editor-dist": "^4.11.2",
     "swagger-ui-dist": "^5.9.0",
     "swagger2openapi": "^7.0.8",

src/commands/typegen.test.ts

@@ -39,6 +39,13 @@ describe('typegen', () => {
         expect(ctx.stdout).to.match(/getPetById/);
       });
 
+    test
+      .stdout()
+      .command(['typegen', resourcePath('openapi.json'), '-A'])
+      .it('generates module level schema aliases', (ctx) => {
+        expect(ctx.stdout).to.match(/export type Pet = Components.Schemas.Pet/);
+      });
+
     test
       .stdout()
       .command(['typegen', resourcePath('openapi.json')])

src/commands/typegen.ts

@@ -1,3 +1,4 @@
+import { Flags } from '@oclif/core';
 import { Command, Args } from '@oclif/core';
 import { parseDefinition, resolveDefinition } from '../common/definition';
 import * as commonFlags from '../common/flags';
@@ -14,6 +15,16 @@ export class Typegen extends Command {
   public static flags = {
     ...commonFlags.help(),
     ...commonFlags.parseOpts(),
+    banner: Flags.string({ 
+      char: 'b',
+      description: 'include a banner comment at the top of the generated file' 
+    }),
+    ['type-aliases']: Flags.boolean({ 
+      char: 'A',
+      description: 'Generate module level type aliases for schema components defined in spec', 
+      default: true,
+      allowNo: true,
+    }),
   };
 
   public static args = {
@@ -50,11 +61,20 @@ export class Typegen extends Command {
       this.error(err, { exit: 1 });
     }
 
-    const [imports, ...restTypes] = await generateTypesForDocument(document, { transformOperationName: (name) => name });
+    const [imports, schemaTypes, operationTypings, banner, aliases] = await generateTypesForDocument(document, { transformOperationName: (name) => name });
+
+    if (flags.banner && banner) {
+      this.log(banner + '\n');
+    }
 
     this.log([
-      imports + '\n',
-      ...restTypes,
+      imports,
+      schemaTypes,
+      operationTypings,
     ].join('\n'));
+
+    if (flags['type-aliases'] && aliases) {
+      this.log(`\n${aliases}`);
+    }
   }
 }