@travetto/openapi 3.4.5 → 4.0.0-rc.0

package/README.md

@@ -27,8 +27,8 @@ All of the high level configurations can be found in the following structure:
 import type { ServerObject, ContactObject, LicenseObject } from 'openapi3-ts/oas31';
 
 import { Config } from '@travetto/config';
-import { path, RootIndex } from '@travetto/manifest';
-import { GlobalEnv } from '@travetto/base';
+import { path, RuntimeIndex, RuntimeContext } from '@travetto/manifest';
+import { Env } from '@travetto/base';
 import { Required } from '@travetto/schema';
 
 /**
@@ -50,10 +50,9 @@ export class ApiInfoConfig {
   version: string;
 
   postConstruct(): void {
-    const info = RootIndex.manifest;
-    this.title ??= info.mainModule;
-    this.version ??= info.version;
-    this.description ??= info.description;
+    this.title ??= RuntimeContext.main.name;
+    this.version ??= RuntimeContext.main.version;
+    this.description ??= RuntimeContext.main.description;
   }
 }
 
@@ -98,8 +97,8 @@ export class ApiSpecConfig {
     if (!this.output || this.output === '-') {
       this.persist = false;
     } else {
-      this.output = path.resolve(RootIndex.mainModule.sourcePath, this.output);
-      this.persist ??= GlobalEnv.dynamic;
+      this.output = path.resolve(RuntimeIndex.mainModule.sourcePath, this.output);
+      this.persist ??= Env.dynamic;
     }
     if (this.persist) {
       if (!/[.](json|ya?ml) $/.test(this.output)) { // Assume a folder
@@ -124,7 +123,7 @@ Usage: openapi:spec [options]
 
 Options:
   -o, --output <string>  Output files
-  -m, --module <string>  Module to run for
+  -m, --module <module>  Module to run for
   -h, --help             display help for command
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/openapi",
-  "version": "3.4.5",
+  "version": "4.0.0-rc.0",
   "description": "OpenAPI integration support for the Travetto framework",
   "keywords": [
     "rest",
@@ -26,15 +26,15 @@
     "directory": "module/openapi"
   },
   "dependencies": {
-    "@travetto/config": "^3.4.4",
-    "@travetto/rest": "^3.4.5",
-    "@travetto/schema": "^3.4.4",
-    "@travetto/yaml": "^3.4.2",
+    "@travetto/config": "^4.0.0-rc.0",
+    "@travetto/rest": "^4.0.0-rc.0",
+    "@travetto/schema": "^4.0.0-rc.0",
+    "@travetto/yaml": "^4.0.0-rc.0",
     "openapi3-ts": "^4.1.2"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.4.7",
-    "@travetto/command": "^3.4.3"
+    "@travetto/cli": "^4.0.0-rc.0",
+    "@travetto/command": "^4.0.0-rc.0"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/config.ts

@@ -1,8 +1,8 @@
 import type { ServerObject, ContactObject, LicenseObject } from 'openapi3-ts/oas31';
 
 import { Config } from '@travetto/config';
-import { path, RootIndex } from '@travetto/manifest';
-import { GlobalEnv } from '@travetto/base';
+import { path, RuntimeIndex, RuntimeContext } from '@travetto/manifest';
+import { Env } from '@travetto/base';
 import { Required } from '@travetto/schema';
 
 /**
@@ -24,10 +24,9 @@ export class ApiInfoConfig {
   version: string;
 
   postConstruct(): void {
-    const info = RootIndex.manifest;
-    this.title ??= info.mainModule;
-    this.version ??= info.version;
-    this.description ??= info.description;
+    this.title ??= RuntimeContext.main.name;
+    this.version ??= RuntimeContext.main.version;
+    this.description ??= RuntimeContext.main.description;
   }
 }
 
@@ -72,8 +71,8 @@ export class ApiSpecConfig {
     if (!this.output || this.output === '-') {
       this.persist = false;
     } else {
-      this.output = path.resolve(RootIndex.mainModule.sourcePath, this.output);
-      this.persist ??= GlobalEnv.dynamic;
+      this.output = path.resolve(RuntimeIndex.mainModule.sourcePath, this.output);
+      this.persist ??= Env.dynamic;
     }
     if (this.persist) {
       if (!/[.](json|ya?ml)$/.test(this.output)) { // Assume a folder

package/src/spec-generate.ts

@@ -1,11 +1,11 @@
-import { Readable } from 'stream';
+import { Readable } from 'node:stream';
 import type {
   SchemaObject, SchemasObject, ParameterObject, OperationObject,
   RequestBodyObject, TagObject, PathsObject, PathItemObject
 } from 'openapi3-ts/oas31';
 
 import { EndpointConfig, ControllerConfig, ParamConfig, EndpointIOType, ControllerVisitor } from '@travetto/rest';
-import { RootIndex } from '@travetto/manifest';
+import { RuntimeIndex } from '@travetto/manifest';
 import { Class } from '@travetto/base';
 import { SchemaRegistry, FieldConfig, ClassConfig, SchemaNameResolver } from '@travetto/schema';
 import { AllViewⲐ } from '@travetto/schema/src/internal/types';
@@ -218,11 +218,11 @@ export class OpenapiVisitor implements ControllerVisitor<GeneratedSpec> {
         }
 
         const extra: Record<string, unknown> = {};
-        if (RootIndex.getFunctionMetadata(cls)?.abstract) {
+        if (RuntimeIndex.getFunctionMetadata(cls)?.abstract) {
           const map = SchemaRegistry.getSubTypesForClass(cls);
           if (map) {
             extra.oneOf = map
-              .filter(x => !RootIndex.getFunctionMetadata(x)?.abstract)
+              .filter(x => !RuntimeIndex.getFunctionMetadata(x)?.abstract)
               .map(c => {
                 this.onSchema(SchemaRegistry.get(c));
                 return this.#getType(c);

package/support/bin/help.ts

@@ -1,6 +1,6 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
 
-import { ManifestFileUtil, path, RootIndex } from '@travetto/manifest';
+import { ManifestFileUtil, path, RuntimeIndex } from '@travetto/manifest';
 import { cliTpl } from '@travetto/cli';
 import { OpenApiClientPresets } from './presets';
 import { ExecUtil } from '@travetto/base';
@@ -11,7 +11,7 @@ import { ExecUtil } from '@travetto/base';
 export class OpenApiClientHelp {
 
   static async getListOfFormats(dockerImage: string): Promise<string[]> {
-    const formatCache = ManifestFileUtil.toolPath(RootIndex, 'openapi-formats.json');
+    const formatCache = ManifestFileUtil.toolPath(RuntimeIndex, 'openapi-formats.json');
     if (!await fs.stat(formatCache).catch(() => false)) {
       const stdout = ExecUtil.spawn('docker', ['run', '--rm', dockerImage, 'list']);
       const res = await stdout.result;

package/support/cli.openapi_client.ts

@@ -1,5 +1,4 @@
 import { path } from '@travetto/manifest';
-import { ShutdownManager } from '@travetto/base';
 import { CliCommandShape, CliCommand, CliFlag } from '@travetto/cli';
 import { DockerContainer } from '@travetto/command';
 
@@ -76,7 +75,7 @@ export class OpenApiClientCommand implements CliCommandShape {
 
     const result = await res;
     if (!result.valid) {
-      ShutdownManager.exit(1);
+      process.exitCode = 1;
     }
   }
 }

package/support/cli.openapi_spec.ts

@@ -1,7 +1,7 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
 
 import { CliCommandShape, CliCommand } from '@travetto/cli';
-import { defineEnv } from '@travetto/base';
+import { Env } from '@travetto/base';
 import { RootRegistry } from '@travetto/registry';
 import { DependencyRegistry } from '@travetto/di';
 import { path } from '@travetto/manifest';
@@ -16,7 +16,7 @@ export class OpenApiSpecCommand implements CliCommandShape {
   output?: string;
 
   preMain(): void {
-    defineEnv({ debug: false });
+    Env.DEBUG.set(false);
   }
 
   async main(): Promise<void> {