@travetto/openapi 4.1.4 → 5.0.0-rc.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 ArcSine Technologies
+Copyright (c) 2023 ArcSine Technologies
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -24,11 +24,12 @@ All of the high level configurations can be found in the following structure:
 
 **Code: Config: OpenAPI Configuration**
 ```typescript
+import path from 'node:path';
+
 import type { ServerObject, ContactObject, LicenseObject } from 'openapi3-ts/oas31';
 
 import { Config } from '@travetto/config';
-import { path, RuntimeIndex, RuntimeContext } from '@travetto/manifest';
-import { Env } from '@travetto/base';
+import { Env, RuntimeContext } from '@travetto/base';
 import { Required } from '@travetto/schema';
 
 /**
@@ -97,7 +98,7 @@ export class ApiSpecConfig {
     if (!this.output || this.output === '-') {
       this.persist = false;
     } else {
-      this.output = path.resolve(RuntimeIndex.mainModule.sourcePath, this.output);
+      this.output = path.resolve(RuntimeContext.mainSourcePath, this.output);
       this.persist ??= Env.dynamic;
     }
     if (this.persist) {

package/package.json

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

package/src/config.ts

@@ -1,8 +1,9 @@
+import path from 'node:path';
+
 import type { ServerObject, ContactObject, LicenseObject } from 'openapi3-ts/oas31';
 
 import { Config } from '@travetto/config';
-import { path, RuntimeIndex, RuntimeContext } from '@travetto/manifest';
-import { Env } from '@travetto/base';
+import { Env, RuntimeContext } from '@travetto/base';
 import { Required } from '@travetto/schema';
 
 /**
@@ -71,7 +72,7 @@ export class ApiSpecConfig {
     if (!this.output || this.output === '-') {
       this.persist = false;
     } else {
-      this.output = path.resolve(RuntimeIndex.mainModule.sourcePath, this.output);
+      this.output = path.resolve(RuntimeContext.mainSourcePath, this.output);
       this.persist ??= Env.dynamic;
     }
     if (this.persist) {

package/src/controller.ts

@@ -1,6 +1,6 @@
 import { ConfigureInterceptor, Controller, CorsInterceptor, Get, SetHeaders, Undocumented } from '@travetto/rest';
 import { Inject } from '@travetto/di';
-import { YamlUtil } from '@travetto/yaml';
+import { stringify } from 'yaml';
 
 import { OpenApiService } from './service';
 
@@ -23,6 +23,6 @@ export class OpenApiController {
   @Get('openapi.yaml')
   @SetHeaders({ 'Content-Type': 'text/vnd.yaml' })
   async getYmlSpec(): Promise<string> {
-    return YamlUtil.serialize(await this.service.getSpec()); // Force output to be simple
+    return stringify(await this.service.getSpec()); // Force output to be simple
   }
 }

package/src/service.ts

@@ -4,7 +4,7 @@ import { Util } from '@travetto/base';
 import { Injectable, Inject } from '@travetto/di';
 import { ControllerRegistry, ControllerVisitUtil, RestConfig } from '@travetto/rest';
 import { SchemaRegistry } from '@travetto/schema';
-import { YamlUtil } from '@travetto/yaml';
+import { stringify } from 'yaml';
 
 import { ApiHostConfig, ApiInfoConfig, ApiSpecConfig } from './config';
 import { OpenapiVisitor } from './spec-generate';
@@ -78,7 +78,7 @@ export class OpenApiService {
 
       const output = this.apiSpecConfig.output.endsWith('.json') ?
         JSON.stringify(spec, undefined, 2) :
-        YamlUtil.serialize(spec);
+        stringify(spec);
 
       await Util.bufferedFileWrite(this.apiSpecConfig.output, output);
     } catch (err) {

package/src/spec-generate.ts

@@ -321,7 +321,7 @@ export class OpenapiVisitor implements ControllerVisitor<GeneratedSpec> {
 
     const pConf = this.#getEndpointBody(ep.responseType, this.#getHeaderValue(ep, 'content-type'));
     const code = Object.keys(pConf.content).length ? 200 : 201;
-    op.responses[code] = pConf;
+    op.responses![code] = pConf;
 
     const schema = SchemaRegistry.getMethodSchema(ep.class, ep.handlerName);
     for (const field of schema) {

package/support/bin/help.ts

@@ -1,8 +1,8 @@
 import fs from 'node:fs/promises';
 import { spawn } from 'node:child_process';
+import path from 'node:path';
 
-import { ExecUtil } from '@travetto/base';
-import { path, RuntimeContext } from '@travetto/manifest';
+import { ExecUtil, RuntimeContext } from '@travetto/base';
 import { cliTpl } from '@travetto/cli';
 
 /**

package/support/cli.openapi_client.ts

@@ -1,4 +1,5 @@
-import { path } from '@travetto/manifest';
+import path from 'node:path';
+
 import { CliCommandShape, CliCommand, CliFlag } from '@travetto/cli';
 import { DockerContainer } from '@travetto/command';
 import { ExecUtil } from '@travetto/base';

package/support/cli.openapi_spec.ts

@@ -1,10 +1,10 @@
 import fs from 'node:fs/promises';
+import path from 'node:path';
 
 import { CliCommandShape, CliCommand } from '@travetto/cli';
 import { Env } from '@travetto/base';
 import { RootRegistry } from '@travetto/registry';
 import { DependencyRegistry } from '@travetto/di';
-import { path } from '@travetto/manifest';
 
 /**
  * CLI for outputting the open api spec to a local file