@asyncapi/cli 0.51.2 → 0.51.4

package/README.md

@@ -81,6 +81,9 @@ Thanks go to these wonderful people ([emoji key](https://allcontributors.org/doc
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/meetagrawal09"><img src="https://avatars.githubusercontent.com/u/73902874?v=4?s=100" width="100px;" alt="Meet Agrawal"/><br /><sub><b>Meet Agrawal</b></sub></a><br /><a href="#infra-meetagrawal09" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://www.chinmayyy.tech"><img src="https://avatars.githubusercontent.com/u/112387862?v=4?s=100" width="100px;" alt="Chinmay Shewale"/><br /><sub><b>Chinmay Shewale</b></sub></a><br /><a href="https://github.com/asyncapi/cli/commits?author=chinma-yyy" title="Code">💻</a> <a href="https://github.com/asyncapi/cli/commits?author=chinma-yyy" title="Tests">⚠️</a></td>
     </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/mhmohona"><img src="https://avatars.githubusercontent.com/u/14244685?v=4?s=100" width="100px;" alt="Mahfuza Humayra Mohona"/><br /><sub><b>Mahfuza Humayra Mohona</b></sub></a><br /><a href="https://github.com/asyncapi/cli/commits?author=mhmohona" title="Documentation">📖</a></td>
+    </tr>
   </tbody>
 </table>
 

package/lib/commands/bundle.d.ts

@@ -1,5 +1,6 @@
 import { Example } from '@oclif/core/lib/interfaces';
 import Command from '../base';
+import { Specification } from '../models/SpecificationFile';
 export default class Bundle extends Command {
     static description: string;
     static strict: boolean;
@@ -11,5 +12,5 @@ export default class Bundle extends Command {
         base: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
     };
     run(): Promise<void>;
-    loadFiles(filepaths: string[]): Promise<string[]>;
+    loadFiles(filepaths: string[]): Promise<Specification[]>;
 }

package/lib/commands/bundle.js

@@ -16,10 +16,17 @@ class Bundle extends base_1.default {
             let baseFile;
             const outputFormat = path_1.default.extname(argv[0]);
             const AsyncAPIFiles = yield this.loadFiles(argv);
+            const containsAsyncAPI3 = AsyncAPIFiles.filter((file) => {
+                return file.isAsyncAPI3();
+            });
+            if (containsAsyncAPI3.length > 0) {
+                this.error('One of the files you tried to bundle is AsyncAPI v3 format, the bundle command does not support it yet, please checkout https://github.com/asyncapi/bundler/issues/133');
+            }
             if (flags.base) {
                 baseFile = (yield (0, SpecificationFile_1.load)(flags.base)).text();
             }
-            const document = yield (0, bundler_1.default)(AsyncAPIFiles, {
+            const fileContents = AsyncAPIFiles.map((file) => file.text());
+            const document = yield (0, bundler_1.default)(fileContents, {
                 referenceIntoComponents: flags['reference-into-components'],
                 base: baseFile
             });
@@ -39,7 +46,7 @@ class Bundle extends base_1.default {
                     });
                 }
                 if (format === '.json') {
-                    yield writeFile(path_1.default.resolve(process.cwd(), output), document.json(), {
+                    yield writeFile(path_1.default.resolve(process.cwd(), output), document.string(), {
                         encoding: 'utf-8',
                     });
                 }
@@ -52,7 +59,7 @@ class Bundle extends base_1.default {
             const files = [];
             for (const filepath of filepaths) {
                 const file = yield (0, SpecificationFile_1.load)(filepath);
-                files.push(file.text());
+                files.push(file);
             }
             return files;
         });

package/lib/commands/diff.js

@@ -33,6 +33,9 @@ class Diff extends base_1.default {
             markdownSubtype = setDefaultMarkdownSubtype(outputFormat, markdownSubtype);
             try {
                 firstDocument = yield (0, SpecificationFile_1.load)(firstDocumentPath);
+                if (firstDocument.isAsyncAPI3()) {
+                    this.error('Diff command does not support AsyncAPI v3 yet which was your first document, please checkout https://github.com/asyncapi/diff/issues/154');
+                }
                 enableWatch(watchMode, {
                     spec: firstDocument,
                     handler: this,
@@ -52,6 +55,9 @@ class Diff extends base_1.default {
             }
             try {
                 secondDocument = yield (0, SpecificationFile_1.load)(secondDocumentPath);
+                if (secondDocument.isAsyncAPI3()) {
+                    this.error('Diff command does not support AsyncAPI v3 yet which was your second document, please checkout https://github.com/asyncapi/diff/issues/154');
+                }
                 enableWatch(watchMode, {
                     spec: secondDocument,
                     handler: this,
@@ -237,8 +243,7 @@ const enableWatch = (status, watcher) => {
 function throwOnBreakingChange(diffOutput, outputFormat) {
     const breakingChanges = diffOutput.breaking();
     if ((outputFormat === 'json' && breakingChanges.length !== 0) ||
-        ((outputFormat === 'yaml' || outputFormat === 'yml') && breakingChanges !== '[]\n') ||
-        (outputFormat === 'md' && breakingChanges.length !== 0)) {
+        ((outputFormat === 'yaml' || outputFormat === 'yml') && breakingChanges !== '[]\n')) {
         throw new diff_error_1.DiffBreakingChangeError();
     }
 }

package/lib/commands/generate/fromTemplate.js

@@ -18,6 +18,30 @@ const red = (text) => `\x1b[31m${text}\x1b[0m`;
 const magenta = (text) => `\x1b[35m${text}\x1b[0m`;
 const yellow = (text) => `\x1b[33m${text}\x1b[0m`;
 const green = (text) => `\x1b[32m${text}\x1b[0m`;
+const templatesNotSupportingV3 = {
+    '@asyncapi/minimaltemplate': 'some link',
+    '@asyncapi/html-template': 'https://github.com/asyncapi/html-template/issues/430',
+    '@asyncapi/dotnet-nats-template': 'https://github.com/asyncapi/dotnet-nats-template/issues/384',
+    '@asyncapi/ts-nats-template': 'https://github.com/asyncapi/ts-nats-template/issues/545',
+    '@asyncapi/python-paho-template': 'https://github.com/asyncapi/python-paho-template/issues/189',
+    '@asyncapi/nodejs-ws-template': 'https://github.com/asyncapi/nodejs-ws-template/issues/294',
+    '@asyncapi/java-spring-cloud-stream-template': 'https://github.com/asyncapi/java-spring-cloud-stream-template/issues/336',
+    '@asyncapi/go-watermill-template': 'https://github.com/asyncapi/go-watermill-template/issues/243',
+    '@asyncapi/java-spring-template': 'https://github.com/asyncapi/java-spring-template/issues/308',
+    '@asyncapi/markdown-template': 'https://github.com/asyncapi/markdown-template/issues/341',
+    '@asyncapi/nodejs-template': 'https://github.com/asyncapi/nodejs-template/issues/215',
+    '@asyncapi/java-template': 'https://github.com/asyncapi/java-template/issues/118',
+    '@asyncapi/php-template': 'https://github.com/asyncapi/php-template/issues/191'
+};
+/**
+ * Verify that a given template support v3, if not, return the link to the issue that needs to be solved.
+ */
+function verifyTemplateSupportForV3(template) {
+    if (templatesNotSupportingV3[`${template}`] !== undefined) {
+        return templatesNotSupportingV3[`${template}`];
+    }
+    return undefined;
+}
 class Template extends base_1.default {
     constructor() {
         super(...arguments);
@@ -67,11 +91,18 @@ class Template extends base_1.default {
                 mapBaseUrlToFolder: parsedFlags.mapBaseUrlToFolder,
                 disabledHooks: parsedFlags.disableHooks,
             };
+            const asyncapiInput = (yield (0, SpecificationFile_1.load)(asyncapi)) || (yield (0, SpecificationFile_1.load)());
             const watchTemplate = flags['watch'];
             const genOption = {};
             if (flags['map-base-url']) {
                 genOption.resolve = { resolve: this.getMapBaseUrlToFolderResolver(parsedFlags.mapBaseUrlToFolder) };
             }
+            if (asyncapiInput.isAsyncAPI3()) {
+                const v3IssueLink = verifyTemplateSupportForV3(template);
+                if (v3IssueLink !== undefined) {
+                    this.error(`${template} template does not support AsyncAPI v3 documents, please checkout ${v3IssueLink}`);
+                }
+            }
             yield this.generate(asyncapi, template, output, options, genOption);
             if (watchTemplate) {
                 const watcherHandler = this.watcherHandler(asyncapi, template, output, options, genOption);

package/lib/commands/generate/models.js

@@ -29,6 +29,9 @@ class Models extends base_1.default {
             const { tsModelType, tsEnumType, tsIncludeComments, tsModuleSystem, tsExportType, tsJsonBinPack, tsMarshalling, tsExampleInstance, namespace, csharpAutoImplement, csharpArrayType, csharpNewtonsoft, csharpHashcode, csharpEqual, csharpSystemJson, packageName, output } = flags;
             const { language, file } = args;
             const inputFile = (yield (0, SpecificationFile_1.load)(file)) || (yield (0, SpecificationFile_1.load)());
+            if (inputFile.isAsyncAPI3()) {
+                this.error('Generate Models command does not support AsyncAPI v3 yet, please checkout https://github.com/asyncapi/modelina/issues/1376');
+            }
             const { document, diagnostics, status } = yield (0, parser_1.parse)(this, inputFile, flags);
             if (!document || status === 'invalid') {
                 const severityErrors = diagnostics.filter((obj) => obj.severity === 0);

package/lib/commands/optimize.js

@@ -34,10 +34,21 @@ class Optimize extends base_1.default {
             const { args, flags } = yield this.parse(Optimize); //NOSONAR
             const filePath = args['spec-file'];
             let specFile;
+            try {
+                specFile = yield (0, SpecificationFile_1.load)(filePath);
+            }
+            catch (err) {
+                this.error(new validation_error_1.ValidationError({
+                    type: 'invalid-file',
+                    filepath: filePath,
+                }));
+            }
+            if (specFile.isAsyncAPI3()) {
+                this.error('Optimize command does not support AsyncAPI v3 yet, please checkout https://github.com/asyncapi/optimizer/issues/168');
+            }
             let optimizer;
             let report;
             try {
-                specFile = yield (0, SpecificationFile_1.load)(filePath);
                 optimizer = new optimizer_1.Optimizer(specFile.text());
                 report = yield optimizer.getReport();
             }

package/lib/models/SpecificationFile.d.ts

@@ -7,6 +7,8 @@ export declare class Specification {
         filepath?: string;
         fileURL?: string;
     });
+    isAsyncAPI3(): boolean;
+    toJson(): Record<string, any>;
     text(): string;
     getFilePath(): string | undefined;
     getFileURL(): string | undefined;

package/lib/models/SpecificationFile.js

@@ -6,6 +6,7 @@ const fs_1 = require("fs");
 const path_1 = tslib_1.__importDefault(require("path"));
 const url_1 = require("url");
 const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
 const Context_1 = require("./Context");
 const specification_file_1 = require("../errors/specification-file");
 const context_error_1 = require("../errors/context-error");
@@ -30,6 +31,18 @@ class Specification {
             this.kind = 'url';
         }
     }
+    isAsyncAPI3() {
+        const jsObj = this.toJson();
+        return jsObj.asyncapi === '3.0.0';
+    }
+    toJson() {
+        try {
+            return js_yaml_1.default.load(this.spec, { json: true });
+        }
+        catch (e) {
+            return JSON.parse(this.spec);
+        }
+    }
     text() {
         return this.spec;
     }

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.51.2",
+  "version": "0.51.4",
   "commands": {
     "bundle": {
       "id": "bundle",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@asyncapi/cli",
   "description": "All in one CLI for all AsyncAPI tools",
-  "version": "0.51.2",
+  "version": "0.51.4",
   "author": "@asyncapi",
   "bin": {
     "asyncapi": "./bin/run"
@@ -29,6 +29,7 @@
     "fs-extra": "^11.1.0",
     "indent-string": "^4.0.0",
     "inquirer": "^8.2.0",
+    "js-yaml": "^4.1.0",
     "lodash.template": "^4.4.0",
     "node-fetch": "^2.0.0",
     "oclif": "^3.7.3",
@@ -52,6 +53,7 @@
     "@types/fs-extra": "^11.0.1",
     "@types/inquirer": "^8.1.3",
     "@types/jest": "^29.0.3",
+    "@types/js-yaml": "^4.0.5",
     "@types/lodash.template": "^4.4.4",
     "@types/node": "^10.17.60",
     "@types/node-fetch": "^2.5.12",