@asyncapi/cli 3.0.1 → 3.1.0

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/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/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": {
@@ -1776,5 +1848,5 @@
       ]
     }
   },
-  "version": "3.0.1"
+  "version": "3.1.0"
 }

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.0",
   "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",