@travetto/openapi 7.1.4 → 8.0.0-alpha.1

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 {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/openapi",
-  "version": "7.1.4",
+  "version": "8.0.0-alpha.1",
   "type": "module",
   "description": "OpenAPI integration support for the Travetto framework",
   "keywords": [
@@ -27,14 +27,14 @@
     "directory": "module/openapi"
   },
   "dependencies": {
-    "@travetto/config": "^7.1.4",
-    "@travetto/schema": "^7.1.4",
-    "@travetto/web": "^7.1.4",
+    "@travetto/config": "^8.0.0-alpha.1",
+    "@travetto/schema": "^8.0.0-alpha.1",
+    "@travetto/web": "^8.0.0-alpha.1",
     "openapi3-ts": "^4.5.0",
     "yaml": "^2.8.2"
   },
   "peerDependencies": {
-    "@travetto/cli": "^7.1.4"
+    "@travetto/cli": "^8.0.0-alpha.1"
   },
   "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/generate.ts

@@ -1,11 +1,10 @@
-import { Readable } from 'node:stream';
 import type {
   SchemaObject, SchemasObject, ParameterObject, OperationObject,
   RequestBodyObject, TagObject, PathsObject, PathItemObject
 } from 'openapi3-ts/oas31';
 
 import { type EndpointConfig, type ControllerConfig, type EndpointParameterConfig, type ControllerVisitor, HTTP_METHODS } from '@travetto/web';
-import { AppError, type Class, describeFunction } from '@travetto/runtime';
+import { RuntimeError, castTo, type Class, describeFunction } from '@travetto/runtime';
 import {
   type SchemaFieldConfig, type SchemaClassConfig, SchemaNameResolver,
   type SchemaInputConfig, SchemaRegistryIndex, type SchemaBasicType, type SchemaParameterConfig
@@ -48,7 +47,7 @@ export class OpenapiVisitor implements ControllerVisitor<GeneratedSpec> {
    */
   #schemaToDotParams(location: 'query' | 'header', input: SchemaInputConfig, prefix: string = '', rootField: SchemaInputConfig = input): ParameterObject[] {
     if (!SchemaRegistryIndex.has(input.type)) {
-      throw new AppError(`Unknown class, not registered as a schema: ${input.type.Ⲑid}`);
+      throw new RuntimeError(`Unknown class, not registered as a schema: ${input.type.Ⲑid}`);
     }
 
     const fields = SchemaRegistryIndex.get(input.type).getFields(input.view);
@@ -78,7 +77,7 @@ export class OpenapiVisitor implements ControllerVisitor<GeneratedSpec> {
    * Get the type for a given class
    */
   #getType(inputOrClass: SchemaInputConfig | Class): Record<string, unknown> {
-    let field: { type: Class<unknown>, precision?: [number, number | undefined] };
+    let field: { type: Class, precision?: [number, number | undefined] };
     if (!isInputConfig(inputOrClass)) {
       field = { type: inputOrClass };
     } else {
@@ -94,6 +93,10 @@ export class OpenapiVisitor implements ControllerVisitor<GeneratedSpec> {
     } else {
       switch (field.type) {
         case String: out.type = 'string'; break;
+        case castTo(BigInt):
+          out.type = 'integer';
+          out.format = 'int64';
+          break;
         case Number: {
           if (field.precision) {
             const [, decimals] = field.precision;
@@ -150,10 +153,10 @@ export class OpenapiVisitor implements ControllerVisitor<GeneratedSpec> {
       config.minLength = input.minlength.limit;
     }
     if (input.min) {
-      config.minimum = typeof input.min.limit === 'number' ? input.min.limit : input.min.limit.getTime();
+      config.minimum = input.min.limit instanceof Date ? input.min.limit.getTime() : castTo(input.min.limit);
     }
     if (input.max) {
-      config.maximum = typeof input.max.limit === 'number' ? input.max.limit : input.max.limit.getTime();
+      config.maximum = input.max.limit instanceof Date ? input.max.limit.getTime() : castTo(input.max.limit);
     }
     if (input.enum) {
       config.enum = input.enum.values;
@@ -238,7 +241,7 @@ export class OpenapiVisitor implements ControllerVisitor<GeneratedSpec> {
   #getEndpointBody(body?: SchemaBasicType, mime?: string | null): RequestBodyObject {
     if (!body || body.type === undefined) {
       return { content: {}, description: '' };
-    } else if (body.type === Readable || body.type === Buffer) {
+    } else if (body.binary) {
       return {
         content: {
           [mime ?? 'application/octet-stream']: { schema: { type: 'string', format: 'binary' } },

package/src/service.ts

@@ -1,8 +1,10 @@
+import { createReadStream, existsSync } from 'node:fs';
 import type { OpenAPIObject } from 'openapi3-ts/oas31';
 import { stringify } from 'yaml';
 
-import { BinaryUtil } from '@travetto/runtime';
-import { Injectable, Inject } from '@travetto/di';
+import { ManifestFileUtil } from '@travetto/manifest';
+import { BinaryMetadataUtil, JSONUtil } from '@travetto/runtime';
+import { Injectable, Inject, PostConstruct } from '@travetto/di';
 import { ControllerVisitUtil, type WebConfig } from '@travetto/web';
 
 import type { ApiHostConfig, ApiInfoConfig, ApiSpecConfig } from './config.ts';
@@ -41,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 }];
     }
@@ -73,10 +76,20 @@ export class OpenApiService {
       const spec = await this.getSpec();
 
       const output = this.apiSpecConfig.output.endsWith('.json') ?
-        JSON.stringify(spec, undefined, 2) :
+        JSONUtil.toUTF8Pretty(spec) :
         stringify(spec);
 
-      await BinaryUtil.bufferedFileWrite(this.apiSpecConfig.output, output, true);
+      if (existsSync(this.apiSpecConfig.output)) {
+        const existing = await BinaryMetadataUtil.hash(createReadStream(this.apiSpecConfig.output));
+        const toWrite = BinaryMetadataUtil.hash(output);
+
+        if (existing === toWrite) {
+          console.debug('OpenAPI spec unchanged, skipping write');
+          return;
+        }
+      }
+
+      await ManifestFileUtil.bufferedFileWrite(this.apiSpecConfig.output, output);
     } catch (error) {
       console.error('Unable to persist openapi spec', error);
     }

package/support/bin/help.ts

@@ -2,7 +2,7 @@ import fs from 'node:fs/promises';
 import { spawn } from 'node:child_process';
 import path from 'node:path';
 
-import { ExecUtil, JSONUtil, Runtime } from '@travetto/runtime';
+import { JSONUtil, ExecUtil, Runtime } from '@travetto/runtime';
 import { cliTpl } from '@travetto/cli';
 
 /**
@@ -22,10 +22,9 @@ export class OpenApiClientHelp {
         .map(line => line.replace(/^\s+-\s+/, '').trim());
 
       await fs.mkdir(path.dirname(formatCache), { recursive: true });
-      await fs.writeFile(formatCache, JSON.stringify([...lines.toSorted(),]));
+      await fs.writeFile(formatCache, JSONUtil.toUTF8([...lines.toSorted(),]));
     }
-    const list: string[] = await JSONUtil.readFile(formatCache);
-    return list;
+    return await fs.readFile(formatCache).then(JSONUtil.fromBinaryArray<string[]>);
   }
 
   static async help(dockerImage: string, extendedHelp: boolean): Promise<string[]> {

package/support/cli.openapi_spec.ts

@@ -1,21 +1,24 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
 
-import { type CliCommandShape, CliCommand } from '@travetto/cli';
-import { Env } from '@travetto/runtime';
+import { type CliCommandShape, CliCommand, CliModuleFlag } from '@travetto/cli';
+import { JSONUtil, Env } from '@travetto/runtime';
 import { Registry } from '@travetto/registry';
 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);
   }
 
@@ -26,12 +29,13 @@ export class OpenApiSpecCommand implements CliCommandShape {
 
     const instance = await DependencyRegistryIndex.getInstance(OpenApiService);
     const result = await instance.getSpec();
+    const text = JSONUtil.toUTF8Pretty(result);
 
     if (this.output === '-' || !this.output) {
-      console.log!(JSON.stringify(result, null, 2));
+      console.log!(text);
     } else {
       await fs.mkdir(path.dirname(this.output), { recursive: true });
-      await fs.writeFile(this.output, JSON.stringify(result, null, 2), 'utf8');
+      await fs.writeFile(this.output, text, 'utf8');
     }
   }
 }