@travetto/openapi 3.1.4 → 3.1.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/openapi",
-  "version": "3.1.4",
+  "version": "3.1.6",
   "description": "OpenAPI integration support for the Travetto framework",
   "keywords": [
     "rest",
@@ -27,17 +27,21 @@
   },
   "dependencies": {
     "@travetto/config": "^3.1.2",
-    "@travetto/rest": "^3.1.2",
+    "@travetto/rest": "^3.1.3",
     "@travetto/schema": "^3.1.2",
     "@travetto/yaml": "^3.1.1",
     "openapi3-ts": "^3.1.2"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.1.2"
+    "@travetto/cli": "^3.1.2",
+    "@travetto/command": "^3.1.2"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {
       "optional": true
+    },
+    "@travetto/command": {
+      "optional": true
     }
   },
   "travetto": {

package/src/controller.ts

@@ -1,4 +1,4 @@
-import { Controller, Get, SetHeaders } from '@travetto/rest';
+import { Controller, Get, SetHeaders, Undocumented } from '@travetto/rest';
 import { Inject } from '@travetto/di';
 import { YamlUtil } from '@travetto/yaml';
 
@@ -7,6 +7,7 @@ import { OpenApiService } from './service';
 /**
  * Basic controller for surfacing the api spec
  */
+@Undocumented()
 @Controller('/')
 export class OpenApiController {
 

package/src/spec-generate.ts

@@ -11,7 +11,6 @@ import { SchemaRegistry, FieldConfig } from '@travetto/schema';
 import { AllViewⲐ } from '@travetto/schema/src/internal/types';
 
 import { ApiSpecConfig } from './config';
-import { OpenApiController } from './controller';
 
 const DEFINITION = '#/components/schemas';
 
@@ -354,29 +353,20 @@ export class SpecGenerator {
     };
   }
 
-  /**
-   * Process each controller
-   */
-  processController(cls: Class): void {
-    const ctrl = ControllerRegistry.get(cls);
-
-    this.#tags.push({
-      name: this.#getTypeTag(ctrl.class),
-      description: ctrl.description || ctrl.title
-    });
-
-    for (const ep of ctrl.endpoints) {
-      this.processEndpoint(ctrl, ep);
-    }
-  }
-
   /**
    * Generate full specification
    */
   generate(config: Partial<ApiSpecConfig> = {}): GeneratedSpec {
 
     for (const cls of ControllerRegistry.getClasses()) {
-      for (const ep of ControllerRegistry.get(cls).endpoints) {
+      const controller = ControllerRegistry.get(cls);
+      if (controller.documented === false) {
+        continue;
+      }
+      for (const ep of controller.endpoints) {
+        if (ep.documented === false) {
+          continue;
+        }
         if (ep.requestType) {
           this.#processSchema(ep.requestType.type);
         }
@@ -391,8 +381,20 @@ export class SpecGenerator {
 
     if (!config.skipRoutes) {
       for (const cls of ControllerRegistry.getClasses()) {
-        if (cls.Ⲑid !== OpenApiController.Ⲑid) {
-          this.processController(cls);
+        const controller = ControllerRegistry.get(cls);
+        if (controller.documented === false) {
+          continue;
+        }
+        this.#tags.push({
+          name: this.#getTypeTag(controller.class),
+          description: controller.description || controller.title
+        });
+
+        for (const ep of controller.endpoints) {
+          if (ep.documented === false) {
+            continue;
+          }
+          this.processEndpoint(controller, ep);
         }
       }
     }

package/support/cli.openapi_client.ts

@@ -1,8 +1,7 @@
-import fs from 'fs/promises';
-
 import { path } from '@travetto/manifest';
-import { ExecUtil, ShutdownManager } from '@travetto/base';
+import { ShutdownManager } from '@travetto/base';
 import { CliCommandShape, CliCommand, CliFlag } from '@travetto/cli';
+import { DockerContainer } from '@travetto/command';
 
 import { OpenApiClientHelp } from './bin/help';
 import { OpenApiClientPresets } from './bin/presets';
@@ -25,6 +24,27 @@ export class OpenApiClientCommand implements CliCommandShape {
   @CliFlag({ desc: 'Watch for file changes' })
   watch?: boolean;
 
+  async getPropList(format: string): Promise<string> {
+    let propMap = Object.fromEntries(this.props?.map(p => p.split('=')) ?? []);
+
+    if (format.startsWith('@travetto/')) {
+      const key = format.split('@travetto/')[1];
+      const [, props] = (await OpenApiClientPresets.getPresets())[key];
+      propMap = { ...props, ...propMap };
+    }
+
+    return OpenApiClientPresets.presetMap(propMap);
+  }
+
+  async getResolvedFormat(format: string): Promise<string> {
+    if (format.startsWith('@travetto/')) {
+      const key = format.split('@travetto/')[1];
+      const [fmt] = (await OpenApiClientPresets.getPresets())[key];
+      return fmt;
+    }
+    return format;
+  }
+
   async help(): Promise<string[]> {
     return OpenApiClientHelp.help(this.dockerImage, this.extendedHelp ?? false);
   }
@@ -33,39 +53,30 @@ export class OpenApiClientCommand implements CliCommandShape {
     this.output = path.resolve(this.output);
     this.input = path.resolve(this.input);
 
-    // Ensure its there
-    await fs.mkdir(this.output, { recursive: true });
+    const cmd = new DockerContainer(this.dockerImage)
+      .setUser(process.geteuid?.() ?? 0, process.getgid?.() ?? 0)
+      .addVolume(this.output, '/workspace')
+      .addVolume(path.dirname(this.input), '/input')
+      .setInteractive(true)
+      .setTTY(false)
+      .setDeleteOnFinish(true);
 
-    let propMap = Object.fromEntries(this.props?.map(p => p.split('=')) ?? []);
+    const propList = await this.getPropList(format);
 
-    if (format.startsWith('@travetto/')) {
-      const key = format.split('@travetto/')[1];
-      const [fmt, props] = (await OpenApiClientPresets.getPresets())[key];
-      format = fmt;
-      propMap = { ...props, ...propMap };
-    }
-
-    const propList = OpenApiClientPresets.presetMap(propMap);
-
-    const args = [
-      'run',
-      '--user', `${process.geteuid?.()}:${process.getgid?.()}`,
-      '-v', `${this.output}:/workspace`,
-      '-v', `${path.dirname(this.input)}:/input`,
-      '-it',
-      '--rm',
-      this.dockerImage,
+    const res = cmd.run([
       'generate',
       '--skip-validate-spec',
       '--remove-operation-id-prefix',
-      '-g', format,
+      '-g', await this.getResolvedFormat(format),
       '-o', '/workspace',
       '-i', `/input/${path.basename(this.input)}`,
       ...(this.watch ? ['-w'] : []),
       ...(propList ? ['--additional-properties', propList] : [])
-    ];
+    ]);
 
-    const { result } = ExecUtil.spawn('docker', args, { stdio: [0, 1, 2] });
-    await result.catch(err => ShutdownManager.exit(1));
+    const result = await res;
+    if (!result.valid) {
+      ShutdownManager.exit(1);
+    }
   }
 }