@travetto/openapi 8.0.0-alpha.0 → 8.0.0-alpha.10

package/README.md

@@ -31,6 +31,7 @@ import type { ServerObject, ContactObject, LicenseObject } from 'openapi3-ts/oas
 import { Config } from '@travetto/config';
 import { Runtime } from '@travetto/runtime';
 import { Required } from '@travetto/schema';
+import { PostConstruct } from '@travetto/di';
 
 /**
  * API Information, infers as much as possible from the package.json
@@ -50,7 +51,8 @@ export class ApiInfoConfig {
   @Required(false)
   version: string;
 
-  postConstruct(): void {
+  @PostConstruct()
+  finalizeConfig(): void {
     this.title ??= Runtime.main.name;
     this.version ??= Runtime.main.version;
     this.description ??= Runtime.main.description;
@@ -94,7 +96,8 @@ export class ApiSpecConfig {
    */
   exposeAllSchemas: boolean = false;
 
-  async postConstruct(): Promise<void> {
+  @PostConstruct()
+  async finalizeConfig(): Promise<void> {
     if (!this.output || this.output === '-') {
       this.persist = false;
     } else {
@@ -125,7 +128,7 @@ Usage: openapi:spec [options]
 Options:
   -o, --output <string>  Output files
   -m, --module <module>  Module to run for
-  -h, --help             display help for command
+  --help                 display help for command
 ```
 
 The command will run your application, in non-server mode, to collect all the endpoints and model information, to produce the `openapi.yml`.  Once produced, the code will store the output in the specified location.
@@ -147,7 +150,7 @@ Options:
   -i, --input <string>                  Input file (default: "./openapi.yml")
   -o, --output <string>                 Output folder (default: "./api-client")
   -d, --docker-image <string>           Docker Image to user (default: "openapitools/openapi-generator-cli:latest")
-  -h, --help                            display help for command
+  --help                                display help for command
 ```
 
 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,6 +1,6 @@
 {
   "name": "@travetto/openapi",
-  "version": "8.0.0-alpha.0",
+  "version": "8.0.0-alpha.10",
   "type": "module",
   "description": "OpenAPI integration support for the Travetto framework",
   "keywords": [
@@ -27,14 +27,14 @@
     "directory": "module/openapi"
   },
   "dependencies": {
-    "@travetto/config": "^8.0.0-alpha.0",
-    "@travetto/schema": "^8.0.0-alpha.0",
-    "@travetto/web": "^8.0.0-alpha.0",
+    "@travetto/config": "^8.0.0-alpha.9",
+    "@travetto/schema": "^8.0.0-alpha.9",
+    "@travetto/web": "^8.0.0-alpha.10",
     "openapi3-ts": "^4.5.0",
     "yaml": "^2.8.2"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.0"
+    "@travetto/cli": "^8.0.0-alpha.14"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/config.ts

@@ -5,6 +5,7 @@ import type { ServerObject, ContactObject, LicenseObject } from 'openapi3-ts/oas
 import { Config } from '@travetto/config';
 import { Runtime } from '@travetto/runtime';
 import { Required } from '@travetto/schema';
+import { PostConstruct } from '@travetto/di';
 
 /**
  * API Information, infers as much as possible from the package.json
@@ -24,7 +25,8 @@ export class ApiInfoConfig {
   @Required(false)
   version: string;
 
-  postConstruct(): void {
+  @PostConstruct()
+  finalizeConfig(): void {
     this.title ??= Runtime.main.name;
     this.version ??= Runtime.main.version;
     this.description ??= Runtime.main.description;
@@ -68,7 +70,8 @@ export class ApiSpecConfig {
    */
   exposeAllSchemas: boolean = false;
 
-  async postConstruct(): Promise<void> {
+  @PostConstruct()
+  async finalizeConfig(): Promise<void> {
     if (!this.output || this.output === '-') {
       this.persist = false;
     } else {

package/src/service.ts

@@ -4,7 +4,7 @@ import { stringify } from 'yaml';
 
 import { ManifestFileUtil } from '@travetto/manifest';
 import { BinaryMetadataUtil, JSONUtil } from '@travetto/runtime';
-import { Injectable, Inject } from '@travetto/di';
+import { Injectable, Inject, PostConstruct } from '@travetto/di';
 import { ControllerVisitUtil, type WebConfig } from '@travetto/web';
 
 import type { ApiHostConfig, ApiInfoConfig, ApiSpecConfig } from './config.ts';
@@ -43,7 +43,8 @@ export class OpenApiService {
   /**
    * Initialize after schemas are readied
    */
-  async postConstruct(): Promise<void> {
+  @PostConstruct()
+  async finalizeConfig(): Promise<void> {
     if (!this.apiHostConfig.servers && this.webConfig.baseUrl) {
       this.apiHostConfig.servers = [{ url: this.webConfig.baseUrl }];
     }

package/support/bin/help.ts

@@ -12,7 +12,7 @@ export class OpenApiClientHelp {
 
   static async getListOfFormats(dockerImage: string): Promise<string[]> {
     const formatCache = Runtime.toolPath('openapi-formats.json');
-    if (!await fs.stat(formatCache).catch(() => false)) {
+    if (!await fs.stat(formatCache, { throwIfNoEntry: false })) {
       const { stdout } = await ExecUtil.getResult(spawn('docker', ['run', '--rm', dockerImage, 'list']));
       const lines = stdout
         .split('DOCUMENTATION')[0]

package/support/cli.openapi_spec.ts

@@ -1,7 +1,7 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
 
-import { type CliCommandShape, CliCommand } from '@travetto/cli';
+import { type CliCommandShape, CliCommand, CliModuleFlag } from '@travetto/cli';
 import { JSONUtil, Env } from '@travetto/runtime';
 import { Registry } from '@travetto/registry';
 import { DependencyRegistryIndex } from '@travetto/di';
@@ -9,13 +9,16 @@ import { DependencyRegistryIndex } from '@travetto/di';
 /**
  * CLI for outputting the open api spec to a local file
  */
-@CliCommand({ with: { module: true } })
+@CliCommand()
 export class OpenApiSpecCommand implements CliCommandShape {
 
   /** Output files */
   output?: string;
 
-  preMain(): void {
+  @CliModuleFlag({ short: 'm' })
+  module: string;
+
+  finalize(): void {
     Env.DEBUG.set(false);
   }