@travetto/openapi 3.0.0-rc.2 → 3.0.0-rc.20

package/README.md

@@ -1,5 +1,5 @@
 <!-- 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 -->
+<!-- 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
 
@@ -10,7 +10,7 @@ npm install @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.
 
-The module is provides an [OpenAPI](https://github.com/OAI/OpenAPI-Specification) v3.x representation of the API metadata provided via 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.") and [Schema](https://github.com/travetto/travetto/tree/main/module/schema#readme "Data type registry for runtime validation, reflection and binding. ") modules.
+The module is provides an [OpenAPI](https://github.com/OAI/OpenAPI-Specification) v3.x representation of the API metadata provided via 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.") and [Schema](https://github.com/travetto/travetto/tree/main/module/schema#readme "Data type registry for runtime validation, reflection and binding.") modules.
 
 ## Configuration
 By installing the dependency, the [OpenAPI](https://github.com/OAI/OpenAPI-Specification) endpoint is automatically generated and exposed at the root of the application as `/openapi.yml` or `/openapi.json` (by default). 
@@ -19,31 +19,45 @@ All of the high level configurations can be found in the following structure:
 
 **Code: Config: OpenAPI Configuration**
 ```typescript
-import * as path from 'path';
-import * as fs from 'fs/promises';
-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 { PathUtil, EnvUtil } from '@travetto/boot';
-import { AppManifest } from '@travetto/base';
+import { Config, EnvVar } from '@travetto/config';
+import { path, RootIndex } from '@travetto/manifest';
+import { GlobalEnv } from '@travetto/base';
+import { Required } from '@travetto/schema';
 
 /**
  * API Information, infers as much as possible from the package.json
  */
-@Config('api.info', { internal: true })
+@Config('api.info')
 export class ApiInfoConfig {
-  contact: ContactObject = AppManifest.info.author ?? {};
-  description?: string = AppManifest.info.description;
-  license: LicenseObject = { name: AppManifest.info.license! };
+  @Required(false)
+  contact: ContactObject;
+  @Required(false)
+  description?: string;
+  @Required(false)
+  license: LicenseObject;
+  @Required(false)
   termsOfService?: string;
-  title: string = AppManifest.info.name;
-  version: string = AppManifest.info.version ?? '0.0.0';
+  @Required(false)
+  title: string;
+  @Required(false)
+  version: string;
+
+  postConstruct(): void {
+    const info = RootIndex.mainPackage;
+    this.contact ??= info.author ?? {};
+    this.description ??= info.description;
+    this.license ??= { name: info.license! };
+    this.title ??= info.name;
+    this.version ??= info.version;
+  }
 }
 
 /**
  * The API host, infers from rest host configuration
  */
-@Config('api.host', { internal: true })
+@Config('api.host')
 export class ApiHostConfig {
   /**
    * List of servers
@@ -58,16 +72,18 @@ export class ApiHostConfig {
 /**
  * The spec file configuration
  */
-@Config('api.spec', { internal: true })
+@Config('api.spec')
 export class ApiSpecConfig {
   /**
    * Where to output file to
    */
+  @EnvVar('TRV_OPENAPI_OUTPUT')
   output: string = 'openapi.yml';
   /**
    * Should file be generated at runtime
    */
-  persist: boolean = EnvUtil.isDynamic();
+  @EnvVar('TRV_OPENAPI_PERSIST')
+  persist?: boolean;
   /**
    * Skip emitting all routes
    */
@@ -78,15 +94,16 @@ export class ApiSpecConfig {
   exposeAllSchemas: boolean = false;
 
   async postConstruct(): Promise<void> {
-    this.output = PathUtil.toUnix(this.output);
+    this.output = path.toPosix(this.output);
     if (!this.output || this.output === '-') {
       this.persist = false;
+    } else {
+      this.persist ??= GlobalEnv.dynamic;
     }
     if (this.persist) {
       if (!/[.](json|ya?ml)$/.test(this.output)) { // Assume a folder
-        this.output = PathUtil.resolveUnix(this.output, 'openapi.yml');
+        this.output = path.resolve(this.output, 'openapi.yml');
       }
-      await fs.mkdir(path.dirname(this.output), { recursive: true });
     }
   }
 }
@@ -127,18 +144,21 @@ 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: "@trv:openapi/openapi.yml")
-  -o, --output <output>                                Output folder (default: "@trv:openapi/api-client")
-  -d, --docker-image <docker-image>                    Docker Image to use (default: "arcsine/openapi-generator:latest")
+  -i, --input <input>                                  Input file (default:
+                                                       "@travetto/openapi/openapi.yml")
+  -o, --output <output>                                Output folder (default:
+                                                       "@travetto/openapi/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
 ----------------------------------
-* @trv:angular10 -- typescript-angular supportsES6=true,ngVersion=10.0
-* @trv:angular11 -- typescript-angular supportsES6=true,ngVersion=11.0
-* @trv:angular12 -- typescript-angular supportsES6=true,ngVersion=11.0
-* @trv:fetch     -- typescript-fetch
+* @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,6 @@
 {
   "name": "@travetto/openapi",
-  "displayName": "OpenAPI Specification",
-  "version": "3.0.0-rc.2",
+  "version": "3.0.0-rc.20",
   "description": "OpenAPI integration support for the travetto framework",
   "keywords": [
     "rest",
@@ -17,31 +16,33 @@
     "name": "Travetto Framework"
   },
   "files": [
-    "index.ts",
+    "__index__.ts",
     "src",
-    "bin",
-    "resources"
+    "support"
   ],
-  "main": "index.ts",
+  "main": "__index__.ts",
   "repository": {
     "url": "https://github.com/travetto/travetto.git",
     "directory": "module/openapi"
   },
   "dependencies": {
-    "@travetto/config": "^3.0.0-rc.2",
-    "@travetto/rest": "^3.0.0-rc.2",
-    "@travetto/schema": "^3.0.0-rc.2",
-    "@travetto/yaml": "^3.0.0-rc.0",
-    "openapi3-ts": "^2.0.2"
+    "@travetto/config": "^3.0.0-rc.19",
+    "@travetto/rest": "^3.0.0-rc.20",
+    "@travetto/schema": "^3.0.0-rc.19",
+    "@travetto/yaml": "^3.0.0-rc.15",
+    "openapi3-ts": "^3.1.2"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.0.0-rc.0"
+    "@travetto/cli": "^3.0.0-rc.16"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {
       "optional": true
     }
   },
+  "travetto": {
+    "displayName": "OpenAPI Specification"
+  },
   "publishConfig": {
     "access": "public"
   }

package/src/config.ts

@@ -1,28 +1,43 @@
-import * as path from 'path';
-import * as fs from 'fs/promises';
-import { ServerObject, ContactObject, LicenseObject } from 'openapi3-ts/src/model/OpenApi';
+import type { ServerObject, ContactObject, LicenseObject } from 'openapi3-ts/src/model/OpenApi';
+
+import { Config, EnvVar } from '@travetto/config';
+import { path, RootIndex } from '@travetto/manifest';
+import { GlobalEnv } from '@travetto/base';
+import { Required } from '@travetto/schema';
 
-import { Config } from '@travetto/config';
-import { PathUtil, EnvUtil } from '@travetto/boot';
-import { AppManifest } from '@travetto/base';
 
 /**
  * API Information, infers as much as possible from the package.json
  */
-@Config('api.info', { internal: true })
+@Config('api.info')
 export class ApiInfoConfig {
-  contact: ContactObject = AppManifest.info.author ?? {};
-  description?: string = AppManifest.info.description;
-  license: LicenseObject = { name: AppManifest.info.license! };
+  @Required(false)
+  contact: ContactObject;
+  @Required(false)
+  description?: string;
+  @Required(false)
+  license: LicenseObject;
+  @Required(false)
   termsOfService?: string;
-  title: string = AppManifest.info.name;
-  version: string = AppManifest.info.version ?? '0.0.0';
+  @Required(false)
+  title: string;
+  @Required(false)
+  version: string;
+
+  postConstruct(): void {
+    const info = RootIndex.mainPackage;
+    this.contact ??= info.author ?? {};
+    this.description ??= info.description;
+    this.license ??= { name: info.license! };
+    this.title ??= info.name;
+    this.version ??= info.version;
+  }
 }
 
 /**
  * The API host, infers from rest host configuration
  */
-@Config('api.host', { internal: true })
+@Config('api.host')
 export class ApiHostConfig {
   /**
    * List of servers
@@ -37,16 +52,18 @@ export class ApiHostConfig {
 /**
  * The spec file configuration
  */
-@Config('api.spec', { internal: true })
+@Config('api.spec')
 export class ApiSpecConfig {
   /**
    * Where to output file to
    */
+  @EnvVar('TRV_OPENAPI_OUTPUT')
   output: string = 'openapi.yml';
   /**
    * Should file be generated at runtime
    */
-  persist: boolean = EnvUtil.isDynamic();
+  @EnvVar('TRV_OPENAPI_PERSIST')
+  persist?: boolean;
   /**
    * Skip emitting all routes
    */
@@ -57,15 +74,16 @@ export class ApiSpecConfig {
   exposeAllSchemas: boolean = false;
 
   async postConstruct(): Promise<void> {
-    this.output = PathUtil.toUnix(this.output);
+    this.output = path.toPosix(this.output);
     if (!this.output || this.output === '-') {
       this.persist = false;
+    } else {
+      this.persist ??= GlobalEnv.dynamic;
     }
     if (this.persist) {
       if (!/[.](json|ya?ml)$/.test(this.output)) { // Assume a folder
-        this.output = PathUtil.resolveUnix(this.output, 'openapi.yml');
+        this.output = path.resolve(this.output, 'openapi.yml');
       }
-      await fs.mkdir(path.dirname(this.output), { recursive: true });
     }
   }
 }

package/src/service.ts

@@ -1,6 +1,7 @@
-import { promises as fs } from 'fs';
-import { OpenAPIObject } from 'openapi3-ts';
+import fs from 'fs/promises';
+import type { OpenAPIObject } from 'openapi3-ts';
 
+import { path } from '@travetto/manifest';
 import { Injectable, Inject } from '@travetto/di';
 import { ControllerRegistry, RestConfig } from '@travetto/rest';
 import { SchemaRegistry } from '@travetto/schema';
@@ -78,6 +79,8 @@ export class OpenApiService {
         JSON.stringify(this.spec, undefined, 2) :
         YamlUtil.serialize(this.spec);
 
+      // TODO: Should use file abstraction
+      await fs.mkdir(path.dirname(this.apiSpecConfig.output), { recursive: true });
       await fs.writeFile(this.apiSpecConfig.output, output);
     } catch (err) {
       console.error('Unable to persist openapi spec', err);

package/src/spec-generate.ts

@@ -40,7 +40,7 @@ export class SpecGenerator {
    * @param cls
    */
   #getTypeId(cls: Class): string {
-    return cls.name?.replace('ᚕsyn', '');
+    return cls.name?.replace('Ⲑsyn', '');
   }
 
   /**
@@ -69,7 +69,7 @@ export class SpecGenerator {
     const viewConf = SchemaRegistry.has(field.type) && SchemaRegistry.getViewSchema(field.type, field.view);
     const schemaConf = viewConf && viewConf.schema;
     if (!schemaConf) {
-      throw new Error(`Unknown class, not registered as a schema: ${field.type.ᚕid}`);
+      throw new Error(`Unknown class, not registered as a schema: ${field.type.Ⲑid}`);
     }
     const params: ParameterObject[] = [];
     for (const sub of Object.values(schemaConf)) {
@@ -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: ''
       };
@@ -379,7 +378,7 @@ export class SpecGenerator {
 
     if (!config.skipRoutes) {
       for (const cls of ControllerRegistry.getClasses()) {
-        if (cls.ᚕid !== OpenApiController.ᚕid) {
+        if (cls.Ⲑid !== OpenApiController.Ⲑid) {
           this.processController(cls);
         }
       }

package/support/bin/generate.ts

@@ -0,0 +1,11 @@
+import { DependencyRegistry } from '@travetto/di';
+import { RootRegistry } from '@travetto/registry';
+
+import { OpenApiService } from '../../src/service';
+
+export async function main(): Promise<unknown> {
+  await RootRegistry.init();
+
+  const instance = await DependencyRegistry.getInstance(OpenApiService);
+  return instance.spec;
+}

package/{bin/cli-openapi_client.ts → support/cli.openapi_client.ts}

@@ -1,12 +1,10 @@
-import * as path from 'path';
-import * as fs from 'fs/promises';
-import { readFileSync } from 'fs';
+import fs from 'fs/promises';
+import { existsSync, readFileSync, writeFileSync } from 'fs';
+import cp from 'child_process';
 
-import { CliCommand, OptionConfig, ListOptionConfig } from '@travetto/cli/src/command';
-import { AppCache, ExecUtil, PathUtil } from '@travetto/boot';
-import { color } from '@travetto/cli/src/color';
-
-const presets: Record<string, [string, object] | [string]> = JSON.parse(readFileSync(PathUtil.resolveUnix(__dirname, '..', 'resources', 'presets.json'), 'utf8'));
+import { path, RootIndex } from '@travetto/manifest';
+import { ExecUtil, FileResourceProvider } from '@travetto/base';
+import { CliCommand, cliTpl, OptionConfig, ListOptionConfig } from '@travetto/cli';
 
 type Options = {
   extendedHelp: OptionConfig<boolean>;
@@ -20,26 +18,36 @@ type Options = {
  * CLI for generating the cli client
  */
 export class OpenApiClientCommand extends CliCommand<Options> {
+  #presets: Record<string, [string, object] | [string]>;
   name = 'openapi:client';
+  #resources = new FileResourceProvider(['@travetto/openapi#support/resources']);
+
+  async getPresets(): Promise<Record<string, [string, object] | [string]>> {
+    if (!this.#presets) {
+      const text = await this.#resources.read('presets.json');
+      this.#presets = JSON.parse(text);
+    }
+    return this.#presets;
+  }
 
   presetMap(prop?: object): string {
     return !prop || Object.keys(prop).length === 0 ? '' : Object.entries(prop).map(([k, v]) => `${k}=${v}`).join(',');
   }
 
   getListOfFormats(): string[] {
-    const json = AppCache.getOrSet('openapi-formats.json', () => {
-      const stdout = ExecUtil.execSync('docker', ['run', '--rm', this.cmd.dockerImage, 'list']);
+    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
         .split('DOCUMENTATION')[0]
         .trim()
         .split(/\n/g)
         .filter(x => /^\s+-/.test(x) && !/\((beta|experimental)\)/.test(x))
         .map(x => x.replace(/^\s+-\s+/, '').trim());
-      return JSON.stringify([
-        ...lines.sort(),
-      ]);
-    });
-    const list: string[] = JSON.parse(json);
+
+      writeFileSync(formatCache, JSON.stringify([...lines.sort(),]));
+    }
+    const list: string[] = JSON.parse(readFileSync(formatCache, 'utf8'));
     return list;
   }
 
@@ -47,40 +55,41 @@ export class OpenApiClientCommand extends CliCommand<Options> {
     return {
       extendedHelp: this.boolOption({ name: 'extended-help', short: 'x', desc: 'Show Extended Help' }),
       props: this.listOption({ name: 'additional-properties', short: 'a', desc: 'Additional Properties' }),
-      input: this.option({ desc: 'Input file', def: './openapi.yml', combine: v => PathUtil.resolveUnix(v), completion: true }),
-      output: this.option({ desc: 'Output folder', def: './api-client', combine: v => PathUtil.resolveUnix(v), completion: true }),
+      input: this.option({ desc: 'Input file', def: './openapi.yml', combine: v => path.resolve(v), completion: true }),
+      output: this.option({ desc: 'Output folder', def: './api-client', combine: v => path.resolve(v), completion: true }),
       dockerImage: this.option({ desc: 'Docker Image to use', def: 'arcsine/openapi-generator:latest' }),
       watch: this.boolOption({ desc: 'Watch for file changes' })
     };
   }
 
-  help(): string {
+  async help(): Promise<string> {
+    const presets = await this.getPresets();
     const presetLen = Math.max(...Object.keys(presets).map(x => x.length));
     const presetEntries = Object
       .entries(presets)
       .sort(([a], [b]) => a.localeCompare(b))
-      .map(([k, [cmd, v]]) => [`@trv:${k}`.padEnd(presetLen + 5), [cmd, this.presetMap(v)]] as const);
+      .map(([k, [cmd, v]]) => [`@travetto/${k}`.padEnd(presetLen + 5), [cmd, this.presetMap(v)]] as const);
 
-    const presetText = color`
+    const presetText = cliTpl`
 ${{ subtitle: 'Available Presets' }}
 ----------------------------------
-${presetEntries.map(([k, [cmd, param]]) => color`* ${{ input: k }} -- ${{ identifier: cmd }} ${{ param }}`).join('\n')}`;
+${presetEntries.map(([k, [cmd, param]]) => cliTpl`* ${{ input: k }} -- ${{ identifier: cmd }} ${{ param }}`).join('\n')}`;
 
-    const formatText = color`
+    const formatText = cliTpl`
 ${{ subtitle: 'Available Formats' }}
 ----------------------------------
-${this.getListOfFormats().map(x => color`* ${{ input: x }}`).join('\n')} `;
+${this.getListOfFormats().map(x => cliTpl`* ${{ input: x }}`).join('\n')} `;
 
     return this.cmd.extendedHelp ? `${presetText}\n${formatText}` : presetText;
   }
 
   getArgs(): string {
-    return '[format-or-preset]';
+    return '<format-or-preset>';
   }
 
   async action(format: string): Promise<void> {
     if (!format) {
-      this.showHelp(new Error('Format is required'));
+      return this.showHelp('Format is required');
     }
 
     // Ensure its there
@@ -88,9 +97,9 @@ ${this.getListOfFormats().map(x => color`* ${{ input: x }}`).join('\n')} `;
 
     let propMap = Object.fromEntries(this.cmd.props?.map(p => p.split('=')) ?? []);
 
-    if (format.startsWith('@trv:')) {
-      const key = format.split('@trv:')[1];
-      const [fmt, props] = presets[key];
+    if (format.startsWith('@travetto/')) {
+      const key = format.split('@travetto/')[1];
+      const [fmt, props] = (await this.getPresets())[key];
       format = fmt;
       propMap = { ...props, ...propMap };
     }
@@ -116,6 +125,6 @@ ${this.getListOfFormats().map(x => color`* ${{ input: x }}`).join('\n')} `;
     ];
 
     const { result } = ExecUtil.spawn('docker', args, { stdio: [0, 1, 2] });
-    await result.catch(err => process.exit(1));
+    await result.catch(err => this.exit(1));
   }
 }

package/support/cli.openapi_spec.ts

@@ -0,0 +1,37 @@
+import { CliCommand, OptionConfig } from '@travetto/cli';
+import { RootIndex } from '@travetto/manifest';
+import { ExecUtil, GlobalEnvConfig } from '@travetto/base';
+
+type Options = {
+  output: OptionConfig<string>;
+};
+
+/**
+ * CLI for outputting the open api spec to a local file
+ */
+export class OpenApiSpecCommand extends CliCommand<Options> {
+  name = 'openapi:spec';
+
+  getOptions(): Options {
+    return { output: this.option({ desc: 'Output files', def: './openapi.yml' }) };
+  }
+
+  envInit(): GlobalEnvConfig {
+    return {
+      debug: false,
+      set: { API_SPEC_OUTPUT: this.cmd.output }
+    };
+  }
+
+  async action(): Promise<void> {
+    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);
+    }
+  }
+}

package/bin/cli-openapi_spec.ts

@@ -1,33 +0,0 @@
-import { CliCommand, OptionConfig } from '@travetto/cli/src/command';
-import { ExecUtil } from '@travetto/boot';
-import { EnvInit } from '@travetto/base/bin/init';
-
-type Options = {
-  output: OptionConfig<string>;
-};
-
-/**
- * CLI for outputting the open api spec to a local file
- */
-export class OpenApiSpecCommand extends CliCommand<Options> {
-  name = 'openapi:spec';
-
-  getOptions(): Options {
-    return { output: this.option({ desc: 'Output files', def: './openapi.yml' }) };
-  }
-
-  envInit(): void {
-    EnvInit.init({
-      debug: '0',
-      set: { API_SPEC_OUTPUT: this.cmd.output }
-    });
-  }
-
-  async action(): Promise<void> {
-    const result = await ExecUtil.workerMain(require.resolve('./generate')).message;
-
-    if (this.cmd.output === '-' || !this.cmd.output) {
-      console.log!(result);
-    }
-  }
-}

package/bin/generate.ts

@@ -1,12 +0,0 @@
-import { ExecUtil } from '@travetto/boot';
-
-export async function main(): Promise<void> {
-  const { PhaseManager } = await import('@travetto/base');
-  await PhaseManager.run('init');
-
-  const { DependencyRegistry } = await import('@travetto/di');
-  const { OpenApiService } = await import('../src/service');
-
-  const instance = await DependencyRegistry.getInstance(OpenApiService);
-  ExecUtil.mainResponse(await instance.spec);
-}