@travetto/openapi 3.0.0-rc.9 → 3.0.0

package/README.md

@@ -1,11 +1,15 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
 <!-- Please modify https://github.com/travetto/travetto/tree/main/module/openapi/DOC.ts and execute "npx trv doc" to rebuild -->
 # OpenAPI Specification
-## OpenAPI integration support for the travetto framework
+## OpenAPI integration support for the Travetto framework
 
 **Install: @travetto/openapi**
 ```bash
 npm install @travetto/openapi
+
+# or
+
+yarn add @travetto/openapi
 ```
 
 In the [RESTful API](https://github.com/travetto/travetto/tree/main/module/rest#readme "Declarative api for RESTful APIs with support for the dependency injection module.") module, the controllers and endpoints can be described via decorators, comments, or typings. This only provides the general metadata internally. This is not sufficient to generate a usable API doc, and so this module exists to bridge that gap.
@@ -19,9 +23,9 @@ All of the high level configurations can be found in the following structure:
 
 **Code: Config: OpenAPI Configuration**
 ```typescript
-import { ServerObject, ContactObject, LicenseObject } from 'openapi3-ts/src/model/OpenApi';
+import type { ServerObject, ContactObject, LicenseObject } from 'openapi3-ts/src/model/OpenApi';
 
-import { Config } from '@travetto/config';
+import { Config, EnvVar } from '@travetto/config';
 import { path, RootIndex } from '@travetto/manifest';
 import { GlobalEnv } from '@travetto/base';
 import { Required } from '@travetto/schema';
@@ -77,10 +81,12 @@ export class ApiSpecConfig {
   /**
    * Where to output file to
    */
+  @EnvVar('TRV_OPENAPI_OUTPUT')
   output: string = 'openapi.yml';
   /**
    * Should file be generated at runtime
    */
+  @EnvVar('TRV_OPENAPI_PERSIST')
   persist?: boolean;
   /**
    * Skip emitting all routes
@@ -112,7 +118,7 @@ The framework, when in watch mode, will generate the [OpenAPI](https://github.co
 
 ## CLI - openapi:spec
 
-The module provides a command for the [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for travetto framework") to allow scripting file generation.
+The module provides a command for the [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for Travetto framework") to allow scripting file generation.
 
 **Terminal: OpenAPI usage**
 ```bash
@@ -123,8 +129,6 @@ Usage:  openapi:spec [options]
 Options:
   -o, --output <output>  Output files (default: "./openapi.yml")
   -h, --help             display help for command
-
-
 ```
 
 The command will run your application, in non-server mode, to collect all the routes and model information, to produce the `openapi.yml`.  Once produced, the code will store the output in the specified location.
@@ -133,13 +137,32 @@ The command will run your application, in non-server mode, to collect all the ro
 
 ## CLI - openapi:client
 
-The module provides a command for the [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for travetto framework") to allow client generation from the API structure.
+The module provides a command for the [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for Travetto framework") to allow client generation from the API structure.
 
 **Terminal: OpenAPI usage**
 ```bash
 $ trv openapi:client --help
 
-
+Usage:  openapi:client [options] <format-or-preset>
+
+Options:
+  -x, --extended-help                                  Show Extended Help
+  -a, --additional-properties <additional-properties>  Additional Properties (default: [])
+  -i, --input <input>                                  Input file (default:
+                                                       "./openapi.yml")
+  -o, --output <output>                                Output folder (default:
+                                                       "./api-client")
+  -d, --docker-image <docker-image>                    Docker Image to use (default:
+                                                       "arcsine/openapi-generator:latest")
+  -w, --watch                                          Watch for file changes
+  -h, --help                                           display help for command
+
+Available Presets
+----------------------------------
+* @travetto/angular10 -- typescript-angular supportsES6=true,ngVersion=10.0
+* @travetto/angular11 -- typescript-angular supportsES6=true,ngVersion=11.0
+* @travetto/angular12 -- typescript-angular supportsES6=true,ngVersion=11.0
+* @travetto/fetch -- typescript-fetch
 ```
 
 This tool relies upon a custom build of [OpenAPI client generation tools](https://github.com/OpenAPITools/openapi-generator), which supports watching.  This allows for fast responsive client generation as the shape of the API changes.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/openapi",
-  "version": "3.0.0-rc.9",
-  "description": "OpenAPI integration support for the travetto framework",
+  "version": "3.0.0",
+  "description": "OpenAPI integration support for the Travetto framework",
   "keywords": [
     "rest",
     "travetto",
@@ -26,14 +26,14 @@
     "directory": "module/openapi"
   },
   "dependencies": {
-    "@travetto/config": "^3.0.0-rc.9",
-    "@travetto/rest": "^3.0.0-rc.9",
-    "@travetto/schema": "^3.0.0-rc.9",
-    "@travetto/yaml": "^3.0.0-rc.7",
-    "openapi3-ts": "^2.0.2"
+    "@travetto/config": "^3.0.0",
+    "@travetto/rest": "^3.0.0",
+    "@travetto/schema": "^3.0.0",
+    "@travetto/yaml": "^3.0.0",
+    "openapi3-ts": "^3.1.2"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.0.0-rc.7"
+    "@travetto/cli": "^3.0.0"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/config.ts

@@ -1,6 +1,6 @@
-import { ServerObject, ContactObject, LicenseObject } from 'openapi3-ts/src/model/OpenApi';
+import type { ServerObject, ContactObject, LicenseObject } from 'openapi3-ts/src/model/OpenApi';
 
-import { Config } from '@travetto/config';
+import { Config, EnvVar } from '@travetto/config';
 import { path, RootIndex } from '@travetto/manifest';
 import { GlobalEnv } from '@travetto/base';
 import { Required } from '@travetto/schema';
@@ -57,10 +57,12 @@ export class ApiSpecConfig {
   /**
    * Where to output file to
    */
+  @EnvVar('TRV_OPENAPI_OUTPUT')
   output: string = 'openapi.yml';
   /**
    * Should file be generated at runtime
    */
+  @EnvVar('TRV_OPENAPI_PERSIST')
   persist?: boolean;
   /**
    * Skip emitting all routes

package/src/service.ts

@@ -1,5 +1,5 @@
 import fs from 'fs/promises';
-import { OpenAPIObject } from 'openapi3-ts';
+import type { OpenAPIObject } from 'openapi3-ts';
 
 import { path } from '@travetto/manifest';
 import { Injectable, Inject } from '@travetto/di';

package/src/spec-generate.ts

@@ -85,8 +85,7 @@ export class SpecGenerator {
             ...this.#getType(sub)
           } : this.#getType(sub),
           required: !!(rootField?.required?.active && sub.required?.active),
-          in: location,
-          extract: undefined
+          in: location
         });
       }
     }
@@ -245,7 +244,7 @@ export class SpecGenerator {
     } else if (body.type === Readable || body.type === Buffer) {
       return {
         content: {
-          [mime ?? 'application/octet-stream']: { type: 'string', format: 'binary' }
+          [mime ?? 'application/octet-stream']: { schema: { type: 'string', format: 'binary' } }
         },
         description: ''
       };

package/support/{main.generate.ts → bin/generate.ts}

@@ -1,7 +1,7 @@
 import { DependencyRegistry } from '@travetto/di';
 import { RootRegistry } from '@travetto/registry';
 
-import { OpenApiService } from '../src/service';
+import { OpenApiService } from '../../src/service';
 
 export async function main(): Promise<unknown> {
   await RootRegistry.init();

package/support/cli.openapi_client.ts

@@ -2,7 +2,7 @@ import fs from 'fs/promises';
 import { existsSync, readFileSync, writeFileSync } from 'fs';
 import cp from 'child_process';
 
-import { path } from '@travetto/manifest';
+import { path, RootIndex } from '@travetto/manifest';
 import { ExecUtil, FileResourceProvider } from '@travetto/base';
 import { CliCommand, cliTpl, OptionConfig, ListOptionConfig } from '@travetto/cli';
 
@@ -20,7 +20,7 @@ type Options = {
 export class OpenApiClientCommand extends CliCommand<Options> {
   #presets: Record<string, [string, object] | [string]>;
   name = 'openapi:client';
-  #resources = new FileResourceProvider(['@travetto/openapi']);
+  #resources = new FileResourceProvider(['@travetto/openapi#support/resources']);
 
   async getPresets(): Promise<Record<string, [string, object] | [string]>> {
     if (!this.#presets) {
@@ -35,7 +35,7 @@ export class OpenApiClientCommand extends CliCommand<Options> {
   }
 
   getListOfFormats(): string[] {
-    const formatCache = path.resolve('.trv-openapi-formats.json');
+    const formatCache = path.resolve(RootIndex.manifest.workspacePath, RootIndex.manifest.outputFolder, 'trv-openapi-formats.json');
     if (!existsSync(formatCache)) {
       const stdout = cp.execSync(`docker run --rm ${this.cmd.dockerImage} list`, { stdio: ['pipe', 'pipe'], encoding: 'utf8' }).trim();
       const lines = stdout
@@ -84,12 +84,12 @@ ${this.getListOfFormats().map(x => cliTpl`* ${{ input: x }}`).join('\n')} `;
   }
 
   getArgs(): string {
-    return '[format-or-preset]';
+    return '<format-or-preset>';
   }
 
   async action(format: string): Promise<void> {
     if (!format) {
-      return this.showHelp(new Error('Format is required'));
+      return this.showHelp('Format is required');
     }
 
     // Ensure its there

package/support/cli.openapi_spec.ts

@@ -24,7 +24,11 @@ export class OpenApiSpecCommand extends CliCommand<Options> {
   }
 
   async action(): Promise<void> {
-    const result = await ExecUtil.worker(RootIndex.resolveFileImport('@travetto/openapi/support/main.generate.ts')).message;
+    const result = await ExecUtil.worker(
+      RootIndex.resolveFileImport('@travetto/cli/support/cli.ts'),
+      ['main', '@travetto/openapi/support/bin/generate.ts'],
+      { env: { TRV_OPENAPI_OUTPUT: this.cmd.output, TRV_OPENAPI_PERSIST: '1' } }
+    ).message;
 
     if (this.cmd.output === '-' || !this.cmd.output) {
       console.log!(result);