@asyncapi/cli 3.0.1 → 3.1.1

package/assets/create-glee-app/templates/tutorial/package-lock.json

@@ -451,11 +451,13 @@
       }
     },
     "node_modules/@babel/code-frame": {
-      "version": "7.24.7",
-      "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.24.7.tgz",
-      "integrity": "sha512-BcYH1CVJBO9tvyIZ2jVeXgSIMvGZ2FDRvDdOIVQyuklNKSsx+eppDEBq/g47Ayw+RqNFE+URvOShmf+f/qwAlA==",
+      "version": "7.26.2",
+      "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.26.2.tgz",
+      "integrity": "sha512-RJlIHRueQgwWitWgF8OdFYGZX328Ax5BCemNGlqHfplnRT9ESi8JkFlvaVYbS+UubVY6dpv87Fs2u5M29iNFVQ==",
+      "license": "MIT",
       "dependencies": {
-        "@babel/highlight": "^7.24.7",
+        "@babel/helper-validator-identifier": "^7.25.9",
+        "js-tokens": "^4.0.0",
         "picocolors": "^1.0.0"
       },
       "engines": {
@@ -753,17 +755,19 @@
       }
     },
     "node_modules/@babel/helper-string-parser": {
-      "version": "7.24.8",
-      "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.24.8.tgz",
-      "integrity": "sha512-pO9KhhRcuUyGnJWwyEgnRJTSIZHiT+vMD0kPeD+so0l7mxkMT19g3pjY9GTnHySck/hDzq+dtW/4VgnMkippsQ==",
+      "version": "7.25.9",
+      "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.25.9.tgz",
+      "integrity": "sha512-4A/SCr/2KLd5jrtOMFzaKjVtAei3+2r/NChoBNoZ3EyP/+GlhoaEGoWOZUmFmoITP7zOJyHIMm+DYRd8o3PvHA==",
+      "license": "MIT",
       "engines": {
         "node": ">=6.9.0"
       }
     },
     "node_modules/@babel/helper-validator-identifier": {
-      "version": "7.24.7",
-      "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.24.7.tgz",
-      "integrity": "sha512-rR+PBcQ1SMQDDyF6X0wxtG8QyLCgUB0eRAGguqRLfkCA87l7yAP7ehq8SNj96OOGTO8OBV70KhuFYcIkHXOg0w==",
+      "version": "7.25.9",
+      "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.25.9.tgz",
+      "integrity": "sha512-Ed61U6XJc3CVRfkERJWDz4dJwKe7iLmmJsbOGu9wSloNSFttHV0I8g6UAgb7qnK5ly5bGLPd4oXZlxCdANBOWQ==",
+      "license": "MIT",
       "engines": {
         "node": ">=6.9.0"
       }
@@ -790,101 +794,25 @@
       }
     },
     "node_modules/@babel/helpers": {
-      "version": "7.25.6",
-      "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.25.6.tgz",
-      "integrity": "sha512-Xg0tn4HcfTijTwfDwYlvVCl43V6h4KyVVX2aEm4qdO/PC6L2YvzLHFdmxhoeSA3eslcE6+ZVXHgWwopXYLNq4Q==",
-      "dependencies": {
-        "@babel/template": "^7.25.0",
-        "@babel/types": "^7.25.6"
-      },
-      "engines": {
-        "node": ">=6.9.0"
-      }
-    },
-    "node_modules/@babel/highlight": {
-      "version": "7.24.7",
-      "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.24.7.tgz",
-      "integrity": "sha512-EStJpq4OuY8xYfhGVXngigBJRWxftKX9ksiGDnmlY3o7B/V7KIAc9X4oiK87uPJSc/vs5L869bem5fhZa8caZw==",
+      "version": "7.26.10",
+      "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.26.10.tgz",
+      "integrity": "sha512-UPYc3SauzZ3JGgj87GgZ89JVdC5dj0AoetR5Bw6wj4niittNyFh6+eOGonYvJ1ao6B8lEa3Q3klS7ADZ53bc5g==",
+      "license": "MIT",
       "dependencies": {
-        "@babel/helper-validator-identifier": "^7.24.7",
-        "chalk": "^2.4.2",
-        "js-tokens": "^4.0.0",
-        "picocolors": "^1.0.0"
+        "@babel/template": "^7.26.9",
+        "@babel/types": "^7.26.10"
       },
       "engines": {
         "node": ">=6.9.0"
       }
     },
-    "node_modules/@babel/highlight/node_modules/ansi-styles": {
-      "version": "3.2.1",
-      "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz",
-      "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==",
-      "dependencies": {
-        "color-convert": "^1.9.0"
-      },
-      "engines": {
-        "node": ">=4"
-      }
-    },
-    "node_modules/@babel/highlight/node_modules/chalk": {
-      "version": "2.4.2",
-      "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz",
-      "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==",
-      "dependencies": {
-        "ansi-styles": "^3.2.1",
-        "escape-string-regexp": "^1.0.5",
-        "supports-color": "^5.3.0"
-      },
-      "engines": {
-        "node": ">=4"
-      }
-    },
-    "node_modules/@babel/highlight/node_modules/color-convert": {
-      "version": "1.9.3",
-      "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz",
-      "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==",
-      "dependencies": {
-        "color-name": "1.1.3"
-      }
-    },
-    "node_modules/@babel/highlight/node_modules/color-name": {
-      "version": "1.1.3",
-      "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz",
-      "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw=="
-    },
-    "node_modules/@babel/highlight/node_modules/escape-string-regexp": {
-      "version": "1.0.5",
-      "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz",
-      "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==",
-      "engines": {
-        "node": ">=0.8.0"
-      }
-    },
-    "node_modules/@babel/highlight/node_modules/has-flag": {
-      "version": "3.0.0",
-      "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz",
-      "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==",
-      "engines": {
-        "node": ">=4"
-      }
-    },
-    "node_modules/@babel/highlight/node_modules/supports-color": {
-      "version": "5.5.0",
-      "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz",
-      "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==",
-      "dependencies": {
-        "has-flag": "^3.0.0"
-      },
-      "engines": {
-        "node": ">=4"
-      }
-    },
     "node_modules/@babel/parser": {
-      "version": "7.25.6",
-      "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.25.6.tgz",
-      "integrity": "sha512-trGdfBdbD0l1ZPmcJ83eNxB9rbEax4ALFTF7fN386TMYbeCQbyme5cOEXQhbGXKebwGaB/J52w1mrklMcbgy6Q==",
+      "version": "7.26.10",
+      "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.26.10.tgz",
+      "integrity": "sha512-6aQR2zGE/QFi8JpDLjUZEPYOs7+mhKXm86VaKFiLP35JQwQb6bwUE+XbvkH0EptsYhbNBSUGaUBLKqxH1xSgsA==",
+      "license": "MIT",
       "dependencies": {
-        "@babel/types": "^7.25.6"
+        "@babel/types": "^7.26.10"
       },
       "bin": {
         "parser": "bin/babel-parser.js"
@@ -2160,13 +2088,14 @@
       }
     },
     "node_modules/@babel/template": {
-      "version": "7.25.0",
-      "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.25.0.tgz",
-      "integrity": "sha512-aOOgh1/5XzKvg1jvVz7AVrx2piJ2XBi227DHmbY6y+bM9H2FlN+IfecYu4Xl0cNiiVejlsCri89LUsbj8vJD9Q==",
+      "version": "7.26.9",
+      "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.26.9.tgz",
+      "integrity": "sha512-qyRplbeIpNZhmzOysF/wFMuP9sctmh2cFzRAZOn1YapxBsE1i9bJIY586R/WBLfLcmcBlM8ROBiQURnnNy+zfA==",
+      "license": "MIT",
       "dependencies": {
-        "@babel/code-frame": "^7.24.7",
-        "@babel/parser": "^7.25.0",
-        "@babel/types": "^7.25.0"
+        "@babel/code-frame": "^7.26.2",
+        "@babel/parser": "^7.26.9",
+        "@babel/types": "^7.26.9"
       },
       "engines": {
         "node": ">=6.9.0"
@@ -2190,13 +2119,13 @@
       }
     },
     "node_modules/@babel/types": {
-      "version": "7.25.6",
-      "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.25.6.tgz",
-      "integrity": "sha512-/l42B1qxpG6RdfYf343Uw1vmDjeNhneUXtzhojE7pDgfpEypmRhI6j1kr17XCVv4Cgl9HdAiQY2x0GwKm7rWCw==",
+      "version": "7.26.10",
+      "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.26.10.tgz",
+      "integrity": "sha512-emqcG3vHrpxUKTrxcblR36dcrcoRDvKmnL/dCL6ZsHaShW80qxCAcNhzQZrpeM765VzEos+xOi4s+r4IXzTwdQ==",
+      "license": "MIT",
       "dependencies": {
-        "@babel/helper-string-parser": "^7.24.8",
-        "@babel/helper-validator-identifier": "^7.24.7",
-        "to-fast-properties": "^2.0.0"
+        "@babel/helper-string-parser": "^7.25.9",
+        "@babel/helper-validator-identifier": "^7.25.9"
       },
       "engines": {
         "node": ">=6.9.0"
@@ -12340,14 +12269,6 @@
       "resolved": "https://registry.npmjs.org/tinycolor2/-/tinycolor2-1.6.0.tgz",
       "integrity": "sha512-XPaBkWQJdsf3pLKJV9p4qN/S+fm2Oj8AIPo1BTUhg5oxkvm9+SVEGFdhyOz7tTdUTfvxMiAs4sp6/eZO2Ew+pw=="
     },
-    "node_modules/to-fast-properties": {
-      "version": "2.0.0",
-      "resolved": "https://registry.npmjs.org/to-fast-properties/-/to-fast-properties-2.0.0.tgz",
-      "integrity": "sha512-/OaKK0xYrs3DmxRYqL/yDc+FxFUVYhDlXMhRmv3z915w2HF1tnN1omB354j8VUGO/hbRzyD6Y3sA7v7GS/ceog==",
-      "engines": {
-        "node": ">=4"
-      }
-    },
     "node_modules/to-regex-range": {
       "version": "5.0.1",
       "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",

package/lib/commands/start/preview.d.ts

@@ -0,0 +1,16 @@
+import Command from '../../core/base';
+export default class PreviewStudio extends Command {
+    static readonly description = "starts a new local instance of Studio in minimal state bundling all the refs of the schema file and with no editing allowed.";
+    static readonly flags: {
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+        port: import("@oclif/core/lib/interfaces").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        base: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        baseDir: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        xOrigin: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        suppressLogs: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static readonly args: {
+        'spec-file': import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/start/preview.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const base_1 = tslib_1.__importDefault(require("../../core/base"));
+const preview_flags_1 = require("../../core/flags/start/preview.flags");
+const SpecificationFile_1 = require("../../core/models/SpecificationFile");
+const Preview_1 = require("../../core/models/Preview");
+class PreviewStudio extends base_1.default {
+    run() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const { args, flags } = yield this.parse(PreviewStudio);
+            let filePath = (_a = args['spec-file']) !== null && _a !== void 0 ? _a : flags.file;
+            const previewPort = flags.port;
+            if (!filePath) {
+                filePath = ((yield (0, SpecificationFile_1.load)()).getFilePath());
+                this.log(`Loaded the specification from: ${filePath}`);
+            }
+            try {
+                this.specFile = yield (0, SpecificationFile_1.load)(filePath);
+            }
+            catch (error) {
+                if (filePath) {
+                    this.error(error);
+                }
+            }
+            this.metricsMetadata.port = previewPort;
+            (0, Preview_1.startPreview)(filePath, flags.base, flags.baseDir, flags.xOrigin, flags.suppressLogs, previewPort);
+        });
+    }
+}
+PreviewStudio.description = 'starts a new local instance of Studio in minimal state bundling all the refs of the schema file and with no editing allowed.';
+PreviewStudio.flags = (0, preview_flags_1.previewFlags)();
+PreviewStudio.args = {
+    'spec-file': core_1.Args.string({ description: 'the path to the file to be opened with studio or context name', required: true }),
+};
+exports.default = PreviewStudio;

package/lib/commands/start/studio.d.ts

@@ -5,9 +5,11 @@ export default class StartStudio extends Command {
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         file: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         port: import("@oclif/core/lib/interfaces").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'no-interactive': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
     static readonly args: {
         'spec-file': import("@oclif/core/lib/interfaces").Arg<string | undefined, Record<string, unknown>>;
     };
     run(): Promise<void>;
+    private parseArgs;
 }

package/lib/commands/start/studio.js

@@ -6,16 +6,23 @@ const Studio_1 = require("../../core/models/Studio");
 const SpecificationFile_1 = require("../../core/models/SpecificationFile");
 const studio_flags_1 = require("../../core/flags/start/studio.flags");
 const core_1 = require("@oclif/core");
+const prompts_1 = require("@clack/prompts");
 class StartStudio extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             var _a;
             const { args, flags } = yield this.parse(StartStudio);
+            let filePath = (_a = args['spec-file']) !== null && _a !== void 0 ? _a : flags.file;
+            let port = flags.port;
             if (flags.file) {
                 this.warn('The file flag has been removed and is being replaced by the argument spec-file. Please pass the filename directly like `asyncapi start studio asyncapi.yml`');
             }
-            let filePath = (_a = args['spec-file']) !== null && _a !== void 0 ? _a : flags.file;
-            const port = flags.port;
+            const isInteractive = !flags['no-interactive'];
+            if (isInteractive && !filePath) {
+                const parsedArgs = yield this.parseArgs({ filePath }, port === null || port === void 0 ? void 0 : port.toString());
+                filePath = parsedArgs.filePath;
+                port = parseInt(parsedArgs.port, 10);
+            }
             if (!filePath) {
                 try {
                     filePath = ((yield (0, SpecificationFile_1.load)()).getFilePath());
@@ -38,6 +45,43 @@ class StartStudio extends base_1.default {
             (0, Studio_1.start)(filePath, port);
         });
     }
+    parseArgs(args, port) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const operationCancelled = 'Operation cancelled by the user.';
+            let askForPort = false;
+            let { filePath } = args;
+            if (!filePath) {
+                filePath = yield (0, prompts_1.text)({
+                    message: 'Enter the path to the AsyncAPI document',
+                    defaultValue: 'asyncapi.yaml',
+                    placeholder: 'asyncapi.yaml',
+                    validate: (value) => {
+                        if (!value) {
+                            return 'The path to the AsyncAPI document is required';
+                        }
+                    },
+                });
+                askForPort = true;
+            }
+            if ((0, prompts_1.isCancel)(filePath)) {
+                (0, prompts_1.cancel)(operationCancelled);
+                this.exit();
+            }
+            if (!port && askForPort) {
+                port = (yield (0, prompts_1.text)({
+                    message: 'Enter the port in which to start Studio',
+                    defaultValue: '3210',
+                    placeholder: '3210',
+                    validate: (value) => (!value ? 'The port number is required' : undefined),
+                }));
+            }
+            if ((0, prompts_1.isCancel)(port)) {
+                (0, prompts_1.cancel)(operationCancelled);
+                this.exit();
+            }
+            return { filePath, port: port !== null && port !== void 0 ? port : '3210' };
+        });
+    }
 }
 StartStudio.description = 'starts a new local instance of Studio';
 StartStudio.flags = (0, studio_flags_1.studioFlags)();

package/lib/core/flags/start/preview.flags.d.ts

@@ -0,0 +1,8 @@
+export declare const previewFlags: () => {
+    help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    port: import("@oclif/core/lib/interfaces").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    base: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    baseDir: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    xOrigin: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    suppressLogs: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+};

package/lib/core/flags/start/preview.flags.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.previewFlags = void 0;
+const core_1 = require("@oclif/core");
+const previewFlags = () => {
+    return {
+        help: core_1.Flags.help({ char: 'h' }),
+        port: core_1.Flags.integer({ char: 'p', description: 'port in which to start Studio in the preview mode' }),
+        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 while bundling with the file.' }),
+        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.' }),
+        suppressLogs: core_1.Flags.boolean({ char: 'l', description: 'Pass this to suppress the detiled error logs.', default: false })
+    };
+};
+exports.previewFlags = previewFlags;

package/lib/core/flags/start/studio.flags.d.ts

@@ -2,4 +2,5 @@ export declare const studioFlags: () => {
     help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
     file: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     port: import("@oclif/core/lib/interfaces").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'no-interactive': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
 };

package/lib/core/flags/start/studio.flags.js

@@ -7,6 +7,11 @@ const studioFlags = () => {
         help: core_1.Flags.help({ char: 'h' }),
         file: core_1.Flags.string({ char: 'f', description: 'path to the AsyncAPI file to link with Studio', deprecated: true }),
         port: core_1.Flags.integer({ char: 'p', description: 'port in which to start Studio' }),
+        'no-interactive': core_1.Flags.boolean({
+            description: 'disable prompts for this command which asks for file path if not passed via the arguments.',
+            required: false,
+            default: false,
+        }),
     };
 };
 exports.studioFlags = studioFlags;

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

@@ -0,0 +1,2 @@
+export declare const DEFAULT_PORT = 3210;
+export declare function startPreview(filePath: string, base: string | undefined, baseDirectory: string | undefined, xOrigin: boolean | undefined, suppressLogs: boolean | undefined, port?: number): void;

package/lib/core/models/Preview.js

@@ -0,0 +1,195 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_PORT = void 0;
+exports.startPreview = startPreview;
+const tslib_1 = require("tslib");
+const specification_file_1 = require("../errors/specification-file");
+const fs_1 = require("fs");
+const bundler_1 = tslib_1.__importDefault(require("@asyncapi/bundler"));
+const http_1 = require("http");
+const ws_1 = require("ws");
+const chokidar_1 = tslib_1.__importDefault(require("chokidar"));
+const open_1 = tslib_1.__importDefault(require("open"));
+const next_1 = tslib_1.__importDefault(require("next"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+const picocolors_1 = require("picocolors");
+const package_json_1 = require("@asyncapi/studio/package.json");
+const sockets = [];
+const messageQueue = [];
+const filePathsToWatch = new Set();
+const defaultErrorMessage = 'error occured while bundling files. use --detailedLog or -l flag to get more details.';
+let bundleError = true;
+exports.DEFAULT_PORT = 3210;
+function isValidFilePath(filePath) {
+    return (0, fs_1.existsSync)(filePath);
+}
+// eslint-disable-next-line sonarjs/cognitive-complexity
+function startPreview(filePath, base, baseDirectory, xOrigin, suppressLogs, port = exports.DEFAULT_PORT) {
+    if (filePath && !isValidFilePath(filePath)) {
+        throw new specification_file_1.SpecificationFileNotFound(filePath);
+    }
+    const baseDir = path_1.default.dirname(path_1.default.resolve(filePath));
+    (0, bundler_1.default)(filePath).then((doc) => {
+        if (doc) {
+            bundleError = false;
+        }
+    }).catch((err) => {
+        if (suppressLogs) {
+            console.log(defaultErrorMessage);
+        }
+        else {
+            console.log(err);
+        }
+    });
+    const studioPath = path_1.default.dirname(require.resolve('@asyncapi/studio/package.json'));
+    const app = (0, next_1.default)({
+        dev: false,
+        dir: studioPath,
+        conf: {
+            distDir: 'build',
+        },
+    });
+    const handle = app.getRequestHandler();
+    const wsServer = new ws_1.WebSocketServer({ noServer: true });
+    wsServer.on('connection', (socket) => {
+        sockets.push(socket);
+        sendQueuedMessages();
+    });
+    wsServer.on('close', (socket) => {
+        sockets.splice(sockets.findIndex(s => s === socket));
+    });
+    app.prepare().then(() => {
+        if (filePath && !bundleError) {
+            messageQueue.push(JSON.stringify({
+                type: 'preview:connected',
+                code: 'Preview server connected'
+            }));
+            sendQueuedMessages();
+            findPathsToWatchFromSchemaRef(filePath, baseDir);
+            filePathsToWatch.add(path_1.default.resolve(baseDir, filePath));
+            chokidar_1.default.watch([...filePathsToWatch]).on('all', (event) => {
+                switch (event) {
+                    case 'add':
+                        (0, bundler_1.default)([filePath], {
+                            base,
+                            baseDir: baseDirectory,
+                            xOrigin,
+                        }).then((intitalDocument) => {
+                            messageQueue.push(JSON.stringify({
+                                type: 'preview:file:added',
+                                code: (path_1.default.extname(filePath) === '.yaml' || path_1.default.extname(filePath) === '.yml') ?
+                                    intitalDocument.yml() : intitalDocument.string()
+                            }));
+                            sendQueuedMessages();
+                        }).catch((e) => {
+                            if (suppressLogs) {
+                                console.log(defaultErrorMessage);
+                            }
+                            else {
+                                console.log(e);
+                            }
+                        });
+                        break;
+                    case 'change':
+                        (0, bundler_1.default)([filePath], {
+                            base,
+                            baseDir: baseDirectory,
+                            xOrigin,
+                        }).then((modifiedDocument) => {
+                            messageQueue.push(JSON.stringify({
+                                type: 'preview:file:changed',
+                                code: (path_1.default.extname(filePath) === '.yaml' || path_1.default.extname(filePath) === '.yml') ?
+                                    modifiedDocument.yml() : modifiedDocument.string()
+                            }));
+                            sendQueuedMessages();
+                        }).catch((error) => {
+                            if (suppressLogs) {
+                                console.log(defaultErrorMessage);
+                            }
+                            else {
+                                console.log(error);
+                            }
+                        });
+                        break;
+                    case 'unlink':
+                        messageQueue.push(JSON.stringify({
+                            type: 'preview:file:deleted',
+                            filePath,
+                        }));
+                        sendQueuedMessages();
+                        break;
+                }
+            });
+        }
+        const server = (0, http_1.createServer)((req, res) => handle(req, res));
+        server.on('upgrade', (request, socket, head) => {
+            if (request.url === '/preview-server' && request.headers['origin'] === `http://localhost:${port}`) {
+                console.log('🔗 WebSocket connection established for the preview.');
+                wsServer.handleUpgrade(request, socket, head, (sock) => {
+                    wsServer.emit('connection', sock, request);
+                });
+            }
+            else {
+                console.log('🔗 WebSocket connection not established.');
+                socket.destroy();
+            }
+        });
+        if (!bundleError) {
+            server.listen(port, () => {
+                const url = `http://localhost:${port}?previewServer=${port}&studio-version=${package_json_1.version}`;
+                console.log(`🎉 Connected to Preview Server running at ${(0, picocolors_1.blueBright)(url)}.`);
+                console.log(`🌐 Open this URL in your web browser: ${(0, picocolors_1.blueBright)(url)}`);
+                console.log(`🛑 If needed, press ${(0, picocolors_1.redBright)('Ctrl + C')} to stop the server.`);
+                if (filePath) {
+                    for (const entry of filePathsToWatch) {
+                        console.log(`👁️ Watching changes on file ${(0, picocolors_1.blueBright)(entry)}`);
+                    }
+                }
+                else {
+                    console.warn('Warning: No file was provided, and we couldn\'t find a default file (like "asyncapi.yaml" or "asyncapi.json") in the current folder. Starting Studio with a blank workspace.');
+                }
+                if (!bundleError) {
+                    (0, open_1.default)(url);
+                }
+            }).on('error', (error) => {
+                console.error(`Failed to start server on port ${port}:`, error.message);
+            });
+        }
+    });
+}
+function sendQueuedMessages() {
+    while (messageQueue.length && sockets.length) {
+        const nextMessage = messageQueue.shift();
+        for (const socket of sockets) {
+            socket.send(nextMessage);
+        }
+    }
+}
+function isLocalRefAPath(key, value) {
+    return (typeof value === 'string' && key === '$ref' &&
+        (value.startsWith('.') || value.startsWith('./') ||
+            value.startsWith('../') || !value.startsWith('#')));
+}
+function findPathsToWatchFromSchemaRef(filePath, baseDir) {
+    if (filePath && !isValidFilePath(filePath)) {
+        throw new specification_file_1.SpecificationFileNotFound(filePath);
+    }
+    const document = js_yaml_1.default.load((0, fs_1.readFileSync)(filePath, 'utf-8'));
+    const stack = [document];
+    while (stack.length > 0) {
+        const current = stack.pop();
+        if (current === null || typeof current !== 'object') {
+            continue;
+        }
+        for (const [key, value] of Object.entries(current)) {
+            if (isLocalRefAPath(key, value)) {
+                const absolutePath = path_1.default.resolve(baseDir, value);
+                filePathsToWatch.add(absolutePath);
+            }
+            if (value !== null && typeof value === 'object') {
+                stack.push(value);
+            }
+        }
+    }
+}

package/oclif.manifest.json

@@ -1451,6 +1451,78 @@
         "index.js"
       ]
     },
+    "start:preview": {
+      "aliases": [],
+      "args": {
+        "spec-file": {
+          "description": "the path to the file to be opened with studio or context name",
+          "name": "spec-file",
+          "required": true
+        }
+      },
+      "description": "starts a new local instance of Studio in minimal state bundling all the refs of the schema file and with no editing allowed.",
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "port": {
+          "char": "p",
+          "description": "port in which to start Studio in the preview mode",
+          "name": "port",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "base": {
+          "char": "b",
+          "description": "Path to the file which will act as a base. This is required when some properties need to be overwritten while bundling with the file.",
+          "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"
+        },
+        "suppressLogs": {
+          "char": "l",
+          "description": "Pass this to suppress the detiled error logs.",
+          "name": "suppressLogs",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "start:preview",
+      "pluginAlias": "@asyncapi/cli",
+      "pluginName": "@asyncapi/cli",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "start",
+        "preview.js"
+      ]
+    },
     "start:studio": {
       "aliases": [],
       "args": {
@@ -1485,6 +1557,13 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "no-interactive": {
+          "description": "disable prompts for this command which asks for file path if not passed via the arguments.",
+          "name": "no-interactive",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -1776,5 +1855,5 @@
       ]
     }
   },
-  "version": "3.0.1"
+  "version": "3.1.1"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@asyncapi/cli",
   "description": "All in one CLI for all AsyncAPI tools",
-  "version": "3.0.1",
+  "version": "3.1.1",
   "author": "@asyncapi",
   "bin": {
     "asyncapi": "./bin/run_bin"
@@ -19,7 +19,7 @@
     "@asyncapi/parser": "^3.3.0",
     "@asyncapi/protobuf-schema-parser": "^3.5.1",
     "@asyncapi/raml-dt-schema-parser": "^4.0.24",
-    "@asyncapi/studio": "^0.23.1",
+    "@asyncapi/studio": "^0.24.2",
     "@changesets/changelog-git": "^0.2.0",
     "@clack/prompts": "^0.7.0",
     "@oclif/core": "^4.2.9",