@asyncapi/cli 1.12.0 → 1.12.2

package/lib/commands/bundle.d.ts

@@ -1,19 +1,16 @@
 import { Example } from '@oclif/core/lib/interfaces';
 import Command from '../base';
-import { Specification } from '../models/SpecificationFile';
-import { Parser } from '@asyncapi/parser';
 export default class Bundle extends Command {
-    static description: string;
+    static readonly description = "Bundle one or multiple AsyncAPI Documents and their references together.";
     static strict: boolean;
     static examples: Example[];
     static flags: {
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
-        'reference-into-components': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         base: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        baseDir: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        xOrigin: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
-    parser: Parser;
     run(): Promise<void>;
     private collectMetricsData;
-    loadFiles(filepaths: string[]): Promise<Specification[]>;
 }

package/lib/commands/bundle.js

@@ -7,28 +7,19 @@ const bundler_1 = tslib_1.__importDefault(require("@asyncapi/bundler"));
 const fs_1 = require("fs");
 const path_1 = tslib_1.__importDefault(require("path"));
 const SpecificationFile_1 = require("../models/SpecificationFile");
-const parser_1 = require("@asyncapi/parser");
 const { writeFile } = fs_1.promises;
 class Bundle extends base_1.default {
-    constructor() {
-        super(...arguments);
-        this.parser = new parser_1.Parser();
-    }
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const { argv, flags } = yield this.parse(Bundle);
             const output = flags.output;
-            let baseFile;
             const outputFormat = path_1.default.extname(argv[0]);
-            const AsyncAPIFiles = yield this.loadFiles(argv);
+            const AsyncAPIFiles = argv;
             this.metricsMetadata.files = AsyncAPIFiles.length;
-            if (flags.base) {
-                baseFile = (yield (0, SpecificationFile_1.load)(flags.base)).text();
-            }
-            const fileContents = AsyncAPIFiles.map((file) => file.text());
-            const document = yield (0, bundler_1.default)(fileContents, {
-                referenceIntoComponents: flags['reference-into-components'],
-                base: baseFile
+            const document = yield (0, bundler_1.default)(AsyncAPIFiles, {
+                base: flags.base,
+                baseDir: flags.baseDir,
+                xOrigin: flags.xOrigin,
             });
             yield this.collectMetricsData(document);
             if (!output) {
@@ -69,29 +60,21 @@ class Bundle extends base_1.default {
             }
         });
     }
-    loadFiles(filepaths) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            const files = [];
-            for (const filepath of filepaths) {
-                const file = yield (0, SpecificationFile_1.load)(filepath);
-                files.push(file);
-            }
-            return files;
-        });
-    }
 }
 exports.default = Bundle;
-Bundle.description = 'bundle one or multiple asyncapi documents and their references together.';
+Bundle.description = 'Bundle one or multiple AsyncAPI Documents and their references together.';
 Bundle.strict = false;
 Bundle.examples = [
-    'asyncapi bundle ./asyncapi.yaml > final-asyncapi.yaml',
     'asyncapi bundle ./asyncapi.yaml --output final-asyncapi.yaml',
-    'asyncapi bundle ./asyncapi.yaml ./features.yaml --reference-into-components',
-    'asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./asyncapi.yaml --reference-into-components'
+    'asyncapi bundle ./asyncapi.yaml ./features.yaml',
+    'asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./main.yaml',
+    'asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./main.yaml --xOrigin',
+    'asyncapi bundle ./asyncapi.yaml -o final-asyncapi.yaml --base ../public-api/main.yaml --baseDir ./social-media/comments-service',
 ];
 Bundle.flags = {
     help: core_1.Flags.help({ char: 'h' }),
     output: core_1.Flags.string({ char: 'o', description: 'The output file name. Omitting this flag the result will be printed in the console.' }),
-    'reference-into-components': core_1.Flags.boolean({ char: 'r', description: 'Bundle the message $refs into components object.' }),
-    base: core_1.Flags.string({ char: 'b', description: 'Path to the file which will act as a base. This is required when some properties are to needed to be overwritten.' }),
+    base: core_1.Flags.string({ char: 'b', description: 'Path to the file which will act as a base. This is required when some properties need to be overwritten.' }),
+    baseDir: core_1.Flags.string({ char: 'd', description: 'One relative/absolute path to directory relative to which paths to AsyncAPI Documents that should be bundled will be resolved.' }),
+    xOrigin: core_1.Flags.boolean({ char: 'x', description: 'Pass this switch to generate properties "x-origin" that will contain historical values of dereferenced "$ref"s.' }),
 };

package/lib/commands/generate/fromTemplate.js

@@ -26,8 +26,6 @@ const templatesNotSupportingV3 = {
     '@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/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'
 };
 /**

package/oclif.manifest.json

@@ -3,12 +3,13 @@
     "bundle": {
       "aliases": [],
       "args": {},
-      "description": "bundle one or multiple asyncapi documents and their references together.",
+      "description": "Bundle one or multiple AsyncAPI Documents and their references together.",
       "examples": [
-        "asyncapi bundle ./asyncapi.yaml > final-asyncapi.yaml",
         "asyncapi bundle ./asyncapi.yaml --output final-asyncapi.yaml",
-        "asyncapi bundle ./asyncapi.yaml ./features.yaml --reference-into-components",
-        "asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./asyncapi.yaml --reference-into-components"
+        "asyncapi bundle ./asyncapi.yaml ./features.yaml",
+        "asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./main.yaml",
+        "asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./main.yaml --xOrigin",
+        "asyncapi bundle ./asyncapi.yaml -o final-asyncapi.yaml --base ../public-api/main.yaml --baseDir ./social-media/comments-service"
       ],
       "flags": {
         "help": {
@@ -26,20 +27,28 @@
           "multiple": false,
           "type": "option"
         },
-        "reference-into-components": {
-          "char": "r",
-          "description": "Bundle the message $refs into components object.",
-          "name": "reference-into-components",
-          "allowNo": false,
-          "type": "boolean"
-        },
         "base": {
           "char": "b",
-          "description": "Path to the file which will act as a base. This is required when some properties are to needed to be overwritten.",
+          "description": "Path to the file which will act as a base. This is required when some properties need to be overwritten.",
           "name": "base",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "baseDir": {
+          "char": "d",
+          "description": "One relative/absolute path to directory relative to which paths to AsyncAPI Documents that should be bundled will be resolved.",
+          "name": "baseDir",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "xOrigin": {
+          "char": "x",
+          "description": "Pass this switch to generate properties \"x-origin\" that will contain historical values of dereferenced \"$ref\"s.",
+          "name": "xOrigin",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -1439,5 +1448,5 @@
       ]
     }
   },
-  "version": "1.12.0"
+  "version": "1.12.2"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@asyncapi/cli",
   "description": "All in one CLI for all AsyncAPI tools",
-  "version": "1.12.0",
+  "version": "1.12.2",
   "author": "@asyncapi",
   "bin": {
     "asyncapi": "./bin/run_bin"
@@ -9,7 +9,7 @@
   "bugs": "https://github.com/asyncapi/cli/issues",
   "dependencies": {
     "@asyncapi/avro-schema-parser": "^3.0.22",
-    "@asyncapi/bundler": "^0.4.0",
+    "@asyncapi/bundler": "^0.5.0",
     "@asyncapi/converter": "^1.4.19",
     "@asyncapi/diff": "^0.4.1",
     "@asyncapi/generator": "^1.17.25",