@asyncapi/cli 0.13.2 → 0.13.3

package/lib/commands/validate.js

@@ -6,26 +6,11 @@ const parser = tslib_1.__importStar(require("@asyncapi/parser"));
 const base_1 = tslib_1.__importDefault(require("../base"));
 const validation_error_1 = require("../errors/validation-error");
 const SpecificationFile_1 = require("../models/SpecificationFile");
-const specification_file_1 = require("../errors/specification-file");
 class Validate extends base_1.default {
     async run() {
         const { args } = this.parse(Validate);
         const filePath = args['spec-file'];
-        let specFile;
-        try {
-            specFile = await SpecificationFile_1.load(filePath);
-        }
-        catch (err) {
-            if (err instanceof specification_file_1.SpecificationFileNotFound) {
-                this.error(new validation_error_1.ValidationError({
-                    type: 'invalid-file',
-                    filepath: filePath
-                }));
-            }
-            else {
-                this.error(err);
-            }
-        }
+        const specFile = await SpecificationFile_1.load(filePath);
         try {
             if (specFile.getFilePath()) {
                 await parser.parse(specFile.text());

package/lib/errors/context-error.d.ts

@@ -1,3 +1,4 @@
+export declare const NO_CONTEXTS_SAVED = "Specify what AsyncAPI file to be used.\nThese are your options to specify in the CLI what AsyncAPI file should be used:\n - You can provide a path to the AsyncAPI file: asyncapi <command> path/to/file/asyncapi\n - You can also pass a saved context that points to your AsyncAPI file: asyncapi <command> context-name\n - In case you did not specify a context that you want to use, the CLI checks if there is a default context and uses it. To set default context run: asyncapi context use mycontext\n - In case you did not provide any reference to AsyncAPI file and there is no default context, the CLI detects if in your current working directory you have files like asyncapi.json, asyncapi.yaml, asyncapi.yml. Just rename your file accordingly.\n";
 declare class ContextError extends Error {
     constructor();
 }

package/lib/errors/context-error.js

@@ -1,9 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContextNotFound = exports.MissingCurrentContextError = exports.MissingContextFileError = void 0;
-const NO_CONTEXTS_SAVED = 'No contexts saved yet, run asyncapi --help to learn more';
+exports.ContextNotFound = exports.MissingCurrentContextError = exports.MissingContextFileError = exports.NO_CONTEXTS_SAVED = void 0;
 const CONTEXT_NOT_FOUND = (contextName) => `Context "${contextName}" does not exists.`;
 const MISSING_CURRENT_CONTEXT = 'No context is set as current, please set a current context.';
+exports.NO_CONTEXTS_SAVED = `Specify what AsyncAPI file to be used.
+These are your options to specify in the CLI what AsyncAPI file should be used:
+ - You can provide a path to the AsyncAPI file: asyncapi <command> path/to/file/asyncapi
+ - You can also pass a saved context that points to your AsyncAPI file: asyncapi <command> context-name
+ - In case you did not specify a context that you want to use, the CLI checks if there is a default context and uses it. To set default context run: asyncapi context use mycontext
+ - In case you did not provide any reference to AsyncAPI file and there is no default context, the CLI detects if in your current working directory you have files like asyncapi.json, asyncapi.yaml, asyncapi.yml. Just rename your file accordingly.
+`;
 class ContextError extends Error {
     constructor() {
         super();
@@ -13,7 +19,7 @@ class ContextError extends Error {
 class MissingContextFileError extends ContextError {
     constructor() {
         super();
-        this.message = NO_CONTEXTS_SAVED;
+        this.message = exports.NO_CONTEXTS_SAVED;
     }
 }
 exports.MissingContextFileError = MissingContextFileError;

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

@@ -7,4 +7,9 @@ export declare class SpecificationFileNotFound extends SpecificationFileError {
 export declare class SpecificationURLNotFound extends SpecificationFileError {
     constructor(URL: string);
 }
+declare type From = 'file' | 'url' | 'context';
+export declare class ErrorLoadingSpec extends Error {
+    private readonly errorMessages;
+    constructor(from?: From, param?: string);
+}
 export {};

package/lib/errors/specification-file.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SpecificationURLNotFound = exports.SpecificationFileNotFound = void 0;
+exports.ErrorLoadingSpec = exports.SpecificationURLNotFound = exports.SpecificationFileNotFound = void 0;
+const context_error_1 = require("./context-error");
 class SpecificationFileError extends Error {
     constructor() {
         super();
@@ -26,3 +27,28 @@ class SpecificationURLNotFound extends SpecificationFileError {
     }
 }
 exports.SpecificationURLNotFound = SpecificationURLNotFound;
+class ErrorLoadingSpec extends Error {
+    constructor(from, param) {
+        super();
+        this.errorMessages = {
+            default: context_error_1.NO_CONTEXTS_SAVED
+        };
+        if (from === 'file') {
+            this.name = 'error loading AsyncAPI document from file';
+            this.message = `${param} is an invalid file path`;
+        }
+        if (from === 'url') {
+            this.name = 'error loading AsyncAPI docuement from url';
+            this.message = `${param} is an invalid url`;
+        }
+        if (from === 'context') {
+            this.name = 'error loading AsyncAPI document from context';
+            this.message = `${param} is an invalid context name`;
+        }
+        if (!from) {
+            this.name = 'error locating AsyncAPI document';
+            this.message = this.errorMessages.default;
+        }
+    }
+}
+exports.ErrorLoadingSpec = ErrorLoadingSpec;

package/lib/models/SpecificationFile.d.ts

@@ -18,7 +18,13 @@ export default class SpecificationFile {
     getPath(): string;
     read(): Promise<string>;
 }
-export declare function load(filePathOrContextName?: string): Promise<Specification>;
+interface LoadType {
+    file?: boolean;
+    url?: boolean;
+    context?: boolean;
+}
+export declare function load(filePathOrContextName?: string, loadType?: LoadType): Promise<Specification>;
 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 {};

package/lib/models/SpecificationFile.js

@@ -7,6 +7,7 @@ const path = tslib_1.__importStar(require("path"));
 const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
 const Context_1 = require("./Context");
 const specification_file_1 = require("../errors/specification-file");
+const context_error_1 = require("../errors/context-error");
 const { readFile, lstat } = fs_1.promises;
 const allowedFileNames = [
     'asyncapi.json',
@@ -32,15 +33,25 @@ class Specification {
         return this.fileURL;
     }
     static async fromFile(filepath) {
-        return new Specification(await readFile(filepath, { encoding: 'utf8' }), { filepath });
+        let spec;
+        try {
+            spec = await readFile(filepath, { encoding: 'utf8' });
+        }
+        catch (error) {
+            throw new specification_file_1.ErrorLoadingSpec('file', filepath);
+        }
+        return new Specification(spec, { filepath });
     }
     static async fromURL(URLpath) {
         let response;
         try {
             response = await node_fetch_1.default(URLpath, { method: 'GET' });
+            if (!response.ok) {
+                throw new specification_file_1.ErrorLoadingSpec('url', URLpath);
+            }
         }
         catch (error) {
-            throw new specification_file_1.SpecificationURLNotFound(URLpath);
+            throw new specification_file_1.ErrorLoadingSpec('url', URLpath);
         }
         return new Specification(await (response === null || response === void 0 ? void 0 : response.text()), { fileURL: URLpath });
     }
@@ -58,8 +69,18 @@ class SpecificationFile {
     }
 }
 exports.default = SpecificationFile;
-async function load(filePathOrContextName) {
+/* eslint-disable sonarjs/cognitive-complexity */
+async function load(filePathOrContextName, loadType) {
     if (filePathOrContextName) {
+        if (loadType === null || loadType === void 0 ? void 0 : loadType.file) {
+            return Specification.fromFile(filePathOrContextName);
+        }
+        if (loadType === null || loadType === void 0 ? void 0 : loadType.context) {
+            return loadFromContext(filePathOrContextName);
+        }
+        if (loadType === null || loadType === void 0 ? void 0 : loadType.url) {
+            return Specification.fromURL(filePathOrContextName);
+        }
         const type = await nameType(filePathOrContextName);
         if (type === TYPE_CONTEXT_NAME) {
             return loadFromContext(filePathOrContextName);
@@ -78,11 +99,11 @@ async function load(filePathOrContextName) {
         if (autoDetectedSpecFile) {
             return Specification.fromFile(autoDetectedSpecFile);
         }
-        if (!filePathOrContextName || !autoDetectedSpecFile) {
-            throw e;
+        if (e instanceof context_error_1.MissingContextFileError) {
+            throw new specification_file_1.ErrorLoadingSpec();
         }
+        throw e;
     }
-    throw new specification_file_1.SpecificationFileNotFound();
 }
 exports.load = load;
 async function nameType(name) {
@@ -118,16 +139,24 @@ async function fileExists(name) {
         if ((await lstat(name)).isFile()) {
             return true;
         }
-        throw new specification_file_1.SpecificationFileNotFound(name);
+        throw new specification_file_1.ErrorLoadingSpec('file', name);
     }
     catch (e) {
-        throw new specification_file_1.SpecificationFileNotFound(name);
+        throw new specification_file_1.ErrorLoadingSpec('file', name);
     }
 }
 exports.fileExists = fileExists;
 async function loadFromContext(contextName) {
-    const context = await Context_1.loadContext(contextName);
-    return Specification.fromFile(context);
+    try {
+        const context = await Context_1.loadContext(contextName);
+        return Specification.fromFile(context);
+    }
+    catch (error) {
+        if (error instanceof context_error_1.MissingContextFileError) {
+            throw new specification_file_1.ErrorLoadingSpec();
+        }
+        throw error;
+    }
 }
 async function detectSpecFile() {
     const existingFileNames = await Promise.all(allowedFileNames.map(async (filename) => {

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.13.2","commands":{"config":{"id":"config","description":"access configs","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"diff":{"id":"diff","description":"find diff between two asyncapi files","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"format":{"name":"format","type":"option","char":"f","description":"format of the output","options":["json"],"default":"json"},"type":{"name":"type","type":"option","char":"t","description":"type of the output","options":["breaking","non-breaking","unclassified","all"],"default":"all"},"overrides":{"name":"overrides","type":"option","char":"o","description":"path to JSON file containing the override properties"}},"args":[{"name":"old","description":"old spec path, URL or context-name","required":true},{"name":"new","description":"new spec path, URL or context-name","required":true}]},"new":{"id":"new","description":"creates a new asyncapi file","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"file-name":{"name":"file-name","type":"option","char":"n","description":"name of the file"},"example":{"name":"example","type":"option","char":"e","description":"name of the example to use"},"studio":{"name":"studio","type":"boolean","char":"s","description":"open in Studio","allowNo":false},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio"},"no-tty":{"name":"no-tty","type":"boolean","description":"do not use an interactive terminal","allowNo":false}},"args":[]},"start":{"id":"start","description":"starts a new local instance of Studio","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"validate":{"id":"validate","description":"validate asyncapi file","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"spec-file","description":"spec path, url, or context-name","required":false}]},"config:context":{"id":"config:context","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start:studio":{"id":"start:studio","description":"starts a new local instance of Studio","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"file":{"name":"file","type":"option","char":"f","description":"path to the AsyncAPI file to link with Studio"},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio"}},"args":[]},"config:context:add":{"id":"config:context:add","description":"Add or modify a context in the store","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"context-name","description":"context name","required":true},{"name":"spec-file-path","description":"file path of the spec file","required":true}]},"config:context:current":{"id":"config:context:current","description":"Shows the current context that is being used","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"config:context:list":{"id":"config:context:list","description":"List all the stored context in the store","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"config:context:remove":{"id":"config:context:remove","description":"Delete a context from the store","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"context-name","description":"Name of the context to delete","required":true}]},"config:context:use":{"id":"config:context:use","description":"Set a context as current","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"context-name","description":"name of the saved context","required":true}]}}}
+{"version":"0.13.3","commands":{"config":{"id":"config","description":"access configs","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"diff":{"id":"diff","description":"find diff between two asyncapi files","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"format":{"name":"format","type":"option","char":"f","description":"format of the output","options":["json"],"default":"json"},"type":{"name":"type","type":"option","char":"t","description":"type of the output","options":["breaking","non-breaking","unclassified","all"],"default":"all"},"overrides":{"name":"overrides","type":"option","char":"o","description":"path to JSON file containing the override properties"}},"args":[{"name":"old","description":"old spec path, URL or context-name","required":true},{"name":"new","description":"new spec path, URL or context-name","required":true}]},"new":{"id":"new","description":"creates a new asyncapi file","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"file-name":{"name":"file-name","type":"option","char":"n","description":"name of the file"},"example":{"name":"example","type":"option","char":"e","description":"name of the example to use"},"studio":{"name":"studio","type":"boolean","char":"s","description":"open in Studio","allowNo":false},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio"},"no-tty":{"name":"no-tty","type":"boolean","description":"do not use an interactive terminal","allowNo":false}},"args":[]},"start":{"id":"start","description":"starts a new local instance of Studio","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"validate":{"id":"validate","description":"validate asyncapi file","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"spec-file","description":"spec path, url, or context-name","required":false}]},"config:context":{"id":"config:context","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start:studio":{"id":"start:studio","description":"starts a new local instance of Studio","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"file":{"name":"file","type":"option","char":"f","description":"path to the AsyncAPI file to link with Studio"},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio"}},"args":[]},"config:context:add":{"id":"config:context:add","description":"Add or modify a context in the store","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"context-name","description":"context name","required":true},{"name":"spec-file-path","description":"file path of the spec file","required":true}]},"config:context:current":{"id":"config:context:current","description":"Shows the current context that is being used","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"config:context:list":{"id":"config:context:list","description":"List all the stored context in the store","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"config:context:remove":{"id":"config:context:remove","description":"Delete a context from the store","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"context-name","description":"Name of the context to delete","required":true}]},"config:context:use":{"id":"config:context:use","description":"Set a context as current","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"context-name","description":"name of the saved context","required":true}]}}}

package/package.json

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