@asyncapi/cli 2.9.0 → 2.10.0

package/assets/create-template/templates/default/package-lock.json

@@ -91,11 +91,11 @@
       }
     },
     "node_modules/@asyncapi/parser": {
-      "version": "3.2.2",
-      "resolved": "https://registry.npmjs.org/@asyncapi/parser/-/parser-3.2.2.tgz",
-      "integrity": "sha512-ved4ja3ANs6BcRhWLbK/A7JIhJyMQBYdV1GZwo6Ptf+qBkGIdvV3dt8M4T6TZqtIbUI2NOvmO2YUqtaPWTudgA==",
+      "version": "3.4.0",
+      "resolved": "https://registry.npmjs.org/@asyncapi/parser/-/parser-3.4.0.tgz",
+      "integrity": "sha512-Sxn74oHiZSU6+cVeZy62iPZMFMvKp4jupMFHelSICCMw1qELmUHPvuZSr+ZHDmNGgHcEpzJM5HN02kR7T4g+PQ==",
       "dependencies": {
-        "@asyncapi/specs": "^6.6.0",
+        "@asyncapi/specs": "^6.8.0",
         "@openapi-contrib/openapi-schema-to-json-schema": "~3.2.0",
         "@stoplight/json": "3.21.0",
         "@stoplight/json-ref-readers": "^1.2.2",
@@ -112,14 +112,14 @@
         "ajv-formats": "^2.1.1",
         "avsc": "^5.7.5",
         "js-yaml": "^4.1.0",
-        "jsonpath-plus": "^7.2.0",
+        "jsonpath-plus": "^10.0.0",
         "node-fetch": "2.6.7"
       }
     },
     "node_modules/@asyncapi/specs": {
-      "version": "6.7.1",
-      "resolved": "https://registry.npmjs.org/@asyncapi/specs/-/specs-6.7.1.tgz",
-      "integrity": "sha512-jEaW2vgAwD9GboCdO/TI1zN2k+iowL8YFYwiZwTIr4U4KDmsgo3BLypScl6Jl4+IvY9RdsWE67nuzVX7jooiqQ==",
+      "version": "6.8.0",
+      "resolved": "https://registry.npmjs.org/@asyncapi/specs/-/specs-6.8.0.tgz",
+      "integrity": "sha512-1i6xs8+IOh6U5T7yH+bCMGQBF+m7kP/NpwyAlt++XaDQutoGCgACf24mQBgcDVqDWWoY81evQv+9ABvw0BviVg==",
       "dependencies": {
         "@types/json-schema": "^7.0.11"
       }
@@ -1813,6 +1813,17 @@
         "@jridgewell/sourcemap-codec": "^1.4.14"
       }
     },
+    "node_modules/@jsep-plugin/assignment": {
+      "version": "1.3.0",
+      "resolved": "https://registry.npmjs.org/@jsep-plugin/assignment/-/assignment-1.3.0.tgz",
+      "integrity": "sha512-VVgV+CXrhbMI3aSusQyclHkenWSAm95WaiKrMxRFam3JSUiIaQjoMIw2sEs/OX4XifnqeQUN4DYbJjlA8EfktQ==",
+      "engines": {
+        "node": ">= 10.16.0"
+      },
+      "peerDependencies": {
+        "jsep": "^0.4.0||^1.0.0"
+      }
+    },
     "node_modules/@jsep-plugin/regex": {
       "version": "1.0.3",
       "resolved": "https://registry.npmjs.org/@jsep-plugin/regex/-/regex-1.0.3.tgz",
@@ -3344,11 +3355,20 @@
       "integrity": "sha512-o6/yDBYccGvTz1+QFevz6l6OBZ2+fMVu2JZ9CIhzsYRX4mjaK5IyX9eldUdCmga16zlgQxyrj5pt9kzuj2C02w=="
     },
     "node_modules/jsonpath-plus": {
-      "version": "7.2.0",
-      "resolved": "https://registry.npmjs.org/jsonpath-plus/-/jsonpath-plus-7.2.0.tgz",
-      "integrity": "sha512-zBfiUPM5nD0YZSBT/o/fbCUlCcepMIdP0CJZxM1+KgA4f2T206f6VAg9e7mX35+KlMaIc5qXW34f3BnwJ3w+RA==",
+      "version": "10.1.0",
+      "resolved": "https://registry.npmjs.org/jsonpath-plus/-/jsonpath-plus-10.1.0.tgz",
+      "integrity": "sha512-gHfV1IYqH8uJHYVTs8BJX1XKy2/rR93+f8QQi0xhx95aCiXn1ettYAd5T+7FU6wfqyDoX/wy0pm/fL3jOKJ9Lg==",
+      "dependencies": {
+        "@jsep-plugin/assignment": "^1.2.1",
+        "@jsep-plugin/regex": "^1.0.3",
+        "jsep": "^1.3.9"
+      },
+      "bin": {
+        "jsonpath": "bin/jsonpath-cli.js",
+        "jsonpath-plus": "bin/jsonpath-cli.js"
+      },
       "engines": {
-        "node": ">=12.0.0"
+        "node": ">=18.0.0"
       }
     },
     "node_modules/jsonpointer": {

package/lib/commands/diff.d.ts

@@ -5,7 +5,7 @@ export default class Diff extends Command {
     static flags: {
         'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<import("@stoplight/spectral-cli/dist/services/config").OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
+        'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"info" | "error" | "warn" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
         output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         format: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;

package/lib/commands/format.d.ts

@@ -0,0 +1,18 @@
+import Command from '../core/base';
+export default class Convert extends Command {
+    static specFile: any;
+    static metricsMetadata: any;
+    static description: string;
+    static flags: {
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+        format: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    };
+    static args: {
+        'spec-file': import("@oclif/core/lib/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+    private handleConversion;
+    private handleOutput;
+    private removeExtensionFromOutputPath;
+}

package/lib/commands/format.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+const fs_1 = require("fs");
+const core_1 = require("@oclif/core");
+const base_1 = tslib_1.__importDefault(require("../core/base"));
+const SpecificationFile_1 = require("../core/models/SpecificationFile");
+const specification_file_1 = require("../core/errors/specification-file");
+const picocolors_1 = require("picocolors");
+const format_flags_1 = require("../core/flags/format.flags");
+class Convert extends base_1.default {
+    run() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const { args, flags } = yield this.parse(Convert);
+            const filePath = args['spec-file'];
+            const outputFileFormat = flags['format'];
+            let convertedFile;
+            try {
+                this.specFile = yield (0, SpecificationFile_1.load)(filePath);
+                // eslint-disable-next-line sonarjs/no-duplicate-string
+                this.metricsMetadata.to_version = flags['target-version'];
+                const ff = (0, SpecificationFile_1.retrieveFileFormat)(this.specFile.text());
+                const isSpecFileJson = ff === 'json';
+                const isSpecFileYaml = ff === 'yaml';
+                if (!isSpecFileJson && !isSpecFileYaml) {
+                    throw new specification_file_1.SpecificationWrongFileFormat(filePath);
+                }
+                convertedFile = this.handleConversion(isSpecFileJson, isSpecFileYaml, outputFileFormat);
+                if (!convertedFile) {
+                    return;
+                }
+                yield this.handleOutput(flags.output, convertedFile, outputFileFormat);
+            }
+            catch (err) {
+                this.error(err);
+            }
+        });
+    }
+    handleConversion(isSpecFileJson, isSpecFileYaml, outputFileFormat) {
+        var _a;
+        const text = (_a = this.specFile) === null || _a === void 0 ? void 0 : _a.text();
+        if (isSpecFileJson && text) {
+            if (outputFileFormat === 'json') {
+                throw new Error(`Your document is already a ${(0, picocolors_1.cyan)('JSON')}`);
+            }
+            return (0, SpecificationFile_1.convertToYaml)(text);
+        }
+        if (isSpecFileYaml && text) {
+            if (outputFileFormat === 'yaml' || outputFileFormat === 'yml') {
+                throw new Error(`Your document is already a ${(0, picocolors_1.cyan)('YAML')}`);
+            }
+            return (0, SpecificationFile_1.convertToJSON)(text);
+        }
+    }
+    handleOutput(outputPath, formattedFile, outputFileFormat) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            if (outputPath) {
+                outputPath = this.removeExtensionFromOutputPath(outputPath);
+                const finalFileName = `${outputPath}.${outputFileFormat}`;
+                yield fs_1.promises.writeFile(finalFileName, formattedFile, {
+                    encoding: 'utf8',
+                });
+                this.log(`succesfully formatted to ${outputFileFormat} at ${(0, picocolors_1.green)(finalFileName)} ✅`);
+            }
+            else {
+                this.log(formattedFile);
+                this.log(`succesfully logged after formatting to ${outputFileFormat} ✅`);
+            }
+        });
+    }
+    removeExtensionFromOutputPath(filename) {
+        var _a;
+        // Removes the extension from a filename if it is .json, .yaml, or .yml
+        // this is so that we can remove the provided extension name in the -o flag and
+        // apply our own extension name according to the content of the file
+        const validExtensions = ['json', 'yaml', 'yml'];
+        const parts = filename.split('.');
+        if (parts.length > 1) {
+            const extension = (_a = parts.pop()) === null || _a === void 0 ? void 0 : _a.toLowerCase();
+            if (extension && validExtensions.includes(extension)) {
+                return parts.join('.');
+            }
+        }
+        return filename;
+    }
+}
+exports.default = Convert;
+Convert.metricsMetadata = {};
+Convert.description = 'Convert asyncapi documents from any format to yaml, yml or JSON';
+Convert.flags = (0, format_flags_1.convertFormatFlags)();
+Convert.args = {
+    'spec-file': core_1.Args.string({
+        description: 'spec path, url, or context-name',
+        required: false,
+    }),
+};

package/lib/commands/validate.d.ts

@@ -5,7 +5,7 @@ export default class Validate extends Command {
         score: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<import("@stoplight/spectral-cli/dist/services/config").OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
-        'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
+        'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"info" | "error" | "warn" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
         output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         watch: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;

package/lib/core/errors/specification-file.d.ts

@@ -4,6 +4,9 @@ declare class SpecificationFileError extends Error {
 export declare class SpecificationFileNotFound extends SpecificationFileError {
     constructor(filePath?: string);
 }
+export declare class SpecificationWrongFileFormat extends SpecificationFileError {
+    constructor(filePath?: string);
+}
 export declare class SpecificationURLNotFound extends SpecificationFileError {
     constructor(URL: string);
 }

package/lib/core/errors/specification-file.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorLoadingSpec = exports.SpecificationURLNotFound = exports.SpecificationFileNotFound = void 0;
+exports.ErrorLoadingSpec = exports.SpecificationURLNotFound = exports.SpecificationWrongFileFormat = exports.SpecificationFileNotFound = void 0;
 const context_error_1 = require("./context-error");
 class SpecificationFileError extends Error {
     constructor() {
@@ -20,6 +20,13 @@ class SpecificationFileNotFound extends SpecificationFileError {
     }
 }
 exports.SpecificationFileNotFound = SpecificationFileNotFound;
+class SpecificationWrongFileFormat extends SpecificationFileError {
+    constructor(filePath) {
+        super();
+        this.message = `File ${filePath} is not of correct format.`;
+    }
+}
+exports.SpecificationWrongFileFormat = SpecificationWrongFileFormat;
 class SpecificationURLNotFound extends SpecificationFileError {
     constructor(URL) {
         super();

package/lib/core/flags/diff.flags.d.ts

@@ -1,7 +1,7 @@
 export declare const diffFlags: () => {
     'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<import("@stoplight/spectral-cli/dist/services/config").OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
-    'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
+    'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"info" | "error" | "warn" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
     output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
     format: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;

package/lib/core/flags/format.flags.d.ts

@@ -0,0 +1,6 @@
+export type fileFormat = 'yaml' | 'yml' | 'json';
+export declare const convertFormatFlags: () => {
+    help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    format: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+};

package/lib/core/flags/format.flags.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertFormatFlags = void 0;
+const core_1 = require("@oclif/core");
+const availFileFormats = ['yaml', 'yml', 'json'];
+const convertFormatFlags = () => {
+    return {
+        help: core_1.Flags.help({ char: 'h' }),
+        format: core_1.Flags.string({
+            char: 'f',
+            description: 'Specify the format to convert to',
+            options: availFileFormats,
+            required: true,
+            default: 'json',
+        }),
+        output: core_1.Flags.string({
+            char: 'o',
+            description: 'path to the file where the result is saved',
+        }),
+    };
+};
+exports.convertFormatFlags = convertFormatFlags;

package/lib/core/flags/validate.flags.d.ts

@@ -2,7 +2,7 @@ export declare const validateFlags: () => {
     score: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<import("@stoplight/spectral-cli/dist/services/config").OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
-    'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
+    'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"info" | "error" | "warn" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
     output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
     watch: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;

package/lib/core/models/SpecificationFile.d.ts

@@ -1,3 +1,4 @@
+import { fileFormat } from 'core/flags/format.flags';
 export declare class Specification {
     private readonly spec;
     private readonly filePath?;
@@ -33,4 +34,7 @@ export declare function load(filePathOrContextName?: string, loadType?: LoadType
 export declare function nameType(name: string): Promise<string>;
 export declare function isURL(urlpath: string): Promise<boolean>;
 export declare function fileExists(name: string): Promise<boolean>;
+export declare function retrieveFileFormat(content: string): fileFormat | undefined;
+export declare function convertToYaml(spec: string): string | undefined;
+export declare function convertToJSON(spec: string): string | undefined;
 export {};

package/lib/core/models/SpecificationFile.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fileExists = exports.isURL = exports.nameType = exports.load = exports.Specification = void 0;
+exports.convertToJSON = exports.convertToYaml = exports.retrieveFileFormat = exports.fileExists = exports.isURL = exports.nameType = exports.load = exports.Specification = void 0;
 const tslib_1 = require("tslib");
 const fs_1 = require("fs");
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -226,3 +226,42 @@ function detectSpecFile() {
         return existingFileNames.find(filename => filename !== undefined);
     });
 }
+function retrieveFileFormat(content) {
+    try {
+        if (content.trimStart()[0] === '{') {
+            JSON.parse(content);
+            return 'json';
+        }
+        // below yaml.load is not a definitive way to determine if a file is yaml or not.
+        // it is able to load .txt text files also.
+        js_yaml_1.default.load(content);
+        return 'yaml';
+    }
+    catch (err) {
+        return undefined;
+    }
+}
+exports.retrieveFileFormat = retrieveFileFormat;
+function convertToYaml(spec) {
+    try {
+        // JS object -> YAML string
+        const jsonContent = js_yaml_1.default.load(spec);
+        return js_yaml_1.default.dump(jsonContent);
+    }
+    catch (err) {
+        console.error(err);
+    }
+}
+exports.convertToYaml = convertToYaml;
+function convertToJSON(spec) {
+    try {
+        // JSON or YAML String -> JS object
+        const jsonContent = js_yaml_1.default.load(spec);
+        // JS Object -> pretty JSON string
+        return JSON.stringify(jsonContent, null, 2);
+    }
+    catch (err) {
+        console.error(err);
+    }
+}
+exports.convertToJSON = convertToJSON;

package/lib/core/parser.d.ts

@@ -15,7 +15,7 @@ export declare enum ValidationStatus {
 export declare function validationFlags({ logDiagnostics }?: ValidationFlagsOptions): {
     'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
-    'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
+    'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"info" | "error" | "warn" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
     output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
 };
 export interface ValidateOptions {

package/oclif.manifest.json

@@ -291,6 +291,63 @@
         "diff.js"
       ]
     },
+    "format": {
+      "aliases": [],
+      "args": {
+        "spec-file": {
+          "description": "spec path, url, or context-name",
+          "name": "spec-file",
+          "required": false
+        }
+      },
+      "description": "Convert asyncapi documents from any format to yaml, yml or JSON",
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "format": {
+          "char": "f",
+          "description": "Specify the format to convert to",
+          "name": "format",
+          "required": true,
+          "default": "json",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "yaml",
+            "yml",
+            "json"
+          ],
+          "type": "option"
+        },
+        "output": {
+          "char": "o",
+          "description": "path to the file where the result is saved",
+          "name": "output",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "format",
+      "pluginAlias": "@asyncapi/cli",
+      "pluginName": "@asyncapi/cli",
+      "pluginType": "core",
+      "strict": true,
+      "metricsMetadata": {},
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "format.js"
+      ]
+    },
     "optimize": {
       "aliases": [],
       "args": {
@@ -1637,5 +1694,5 @@
       ]
     }
   },
-  "version": "2.9.0"
+  "version": "2.10.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@asyncapi/cli",
   "description": "All in one CLI for all AsyncAPI tools",
-  "version": "2.9.0",
+  "version": "2.10.0",
   "author": "@asyncapi",
   "bin": {
     "asyncapi": "./bin/run_bin"