@travetto/openapi 2.0.5 → 2.1.1

package/README.md

@@ -67,7 +67,7 @@ export class ApiSpecConfig {
   /**
    * Should file be generated at runtime
    */
-  persist: boolean = !EnvUtil.isReadonly();
+  persist: boolean = EnvUtil.isDynamic();
   /**
    * Skip emitting all routes
    */
@@ -122,7 +122,7 @@ The module provides a plugin for the [Command Line Interface](https://github.com
 ```bash
 $ trv openapi:client --help
 
-Usage:  openapi:client [options] [forma]
+Usage:  openapi:client [options] [format-or-preset]
 
 Options:
   -x, --extended-help                                  Show Extended Help
@@ -135,10 +135,10 @@ Options:
 
 Available Presets
 ----------------------------------
-* @trv/angular10 -- typescript-angular supportsES6=true,ngVersion=10.0
-* @trv/angular11 -- typescript-angular supportsES6=true,ngVersion=11.0
-* @trv/angular12 -- typescript-angular supportsES6=true,ngVersion=11.0
-* @trv/fetch     -- typescript-fetch
+* @trv:angular10 -- typescript-angular supportsES6=true,ngVersion=10.0
+* @trv:angular11 -- typescript-angular supportsES6=true,ngVersion=11.0
+* @trv:angular12 -- typescript-angular supportsES6=true,ngVersion=11.0
+* @trv:fetch     -- typescript-fetch
 ```
 
 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/bin/cli-openapi_client.ts

@@ -1,11 +1,12 @@
 import * as path from 'path';
-import * as fs from 'fs';
+import * as fs from 'fs/promises';
+import { readFileSync } from 'fs';
 
 import { BasePlugin } from '@travetto/cli/src/plugin-base';
 import { AppCache, ExecUtil, PathUtil } from '@travetto/boot';
 import { color } from '@travetto/cli/src/color';
 
-const presets = JSON.parse(fs.readFileSync(PathUtil.resolveUnix(__dirname, '..', 'resources', 'presets.json'), 'utf8')) as Record<string, [string, object] | [string]>;
+const presets = JSON.parse(readFileSync(PathUtil.resolveUnix(__dirname, '..', 'resources', 'presets.json'), 'utf8')) as Record<string, [string, object] | [string]>;
 
 /**
  * CLI for generating the cli client
@@ -49,7 +50,7 @@ export class OpenApiClientPlugin extends BasePlugin {
     const presetEntries = Object
       .entries(presets)
       .sort(([a], [b]) => a.localeCompare(b))
-      .map(([k, [cmd, v]]) => [`@trv/${k}`.padEnd(presetLen + 5), [cmd, this.presetMap(v)]] as const);
+      .map(([k, [cmd, v]]) => [`@trv:${k}`.padEnd(presetLen + 5), [cmd, this.presetMap(v)]] as const);
 
     const presetText = color`
 ${{ subtitle: 'Available Presets' }}
@@ -65,7 +66,7 @@ ${this.getListOfFormats().map(x => color`* ${{ input: x }}`).join('\n')} `;
   }
 
   getArgs() {
-    return '[format or preset]';
+    return '[format-or-preset]';
   }
 
   async action(format: string) {
@@ -74,7 +75,7 @@ ${this.getListOfFormats().map(x => color`* ${{ input: x }}`).join('\n')} `;
     }
 
     // Ensure its there
-    await fs.promises.mkdir(this.cmd.output, { recursive: true });
+    await fs.mkdir(this.cmd.output, { recursive: true });
 
     let propMap = Object.fromEntries(this.cmd.props?.map(p => p.split('=')) ?? []);
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/openapi",
   "displayName": "OpenAPI Specification",
-  "version": "2.0.5",
+  "version": "2.1.1",
   "description": "OpenAPI integration support for the travetto framework",
   "keywords": [
     "rest",
@@ -28,14 +28,14 @@
     "directory": "module/openapi"
   },
   "dependencies": {
-    "@travetto/config": "^2.0.3",
-    "@travetto/rest": "^2.0.3",
-    "@travetto/schema": "^2.0.5",
-    "@travetto/yaml": "^2.0.2",
-    "openapi3-ts": "^2.0.1"
+    "@travetto/config": "^2.1.1",
+    "@travetto/rest": "^2.1.1",
+    "@travetto/schema": "^2.1.1",
+    "@travetto/yaml": "^2.1.1",
+    "openapi3-ts": "^2.0.2"
   },
   "optionalPeerDependencies": {
-    "@travetto/cli": "^2.0.2"
+    "@travetto/cli": "^2.1.1"
   },
   "publishConfig": {
     "access": "public"

package/src/config.ts

@@ -1,5 +1,5 @@
 import * as path from 'path';
-import * as fs from 'fs';
+import * as fs from 'fs/promises';
 import { ServerObject, ContactObject, LicenseObject } from 'openapi3-ts/src/model/OpenApi';
 
 import { Config } from '@travetto/config';
@@ -65,7 +65,7 @@ export class ApiSpecConfig {
       if (!/[.](json|ya?ml)$/.test(this.output)) { // Assume a folder
         this.output = PathUtil.resolveUnix(this.output, 'openapi.yml');
       }
-      await fs.promises.mkdir(path.dirname(this.output), { recursive: true });
+      await fs.mkdir(path.dirname(this.output), { recursive: true });
     }
   }
 }