@asyncapi/cli 3.5.1 → 3.6.0

package/bin/dev

@@ -1,4 +1,4 @@
-#!/usr/bin/env nod
+#!/usr/bin/env node
 
 const oclif = require('@oclif/core')
 

package/lib/apps/api/app.js

@@ -12,6 +12,7 @@ const helmet_1 = tslib_1.__importDefault(require("helmet"));
 const logger_1 = require("../../utils/logger");
 const constants_1 = require("./constants");
 const problem_middleware_1 = require("./middlewares/problem.middleware");
+const logger_middleware_1 = require("./middlewares/logger.middleware");
 class App {
     constructor(controllers, port = process.env.PORT || 80, env = process.env.NODE_ENV || 'development') {
         this.controllers = controllers;
@@ -71,6 +72,7 @@ class App {
                 // for `/docs` path
                 crossOriginEmbedderPolicy: false,
             }));
+            this.app.use(logger_middleware_1.loggerMiddleware);
         });
     }
     initializeControllers() {

package/lib/apps/api/controllers/version.controller.d.ts

@@ -0,0 +1,8 @@
+import { Router } from 'express';
+import { Controller } from '../../../interfaces';
+export declare class VersionController implements Controller {
+    basepath: string;
+    private startTime;
+    private getPackageInfo;
+    boot(): Promise<Router>;
+}

package/lib/apps/api/controllers/version.controller.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VersionController = void 0;
+const tslib_1 = require("tslib");
+const os = tslib_1.__importStar(require("os"));
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
+const express_1 = require("express");
+class VersionController {
+    constructor() {
+        this.basepath = '/version';
+        this.startTime = new Date();
+    }
+    getPackageInfo() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            try {
+                const packagePath = path.join(process.cwd(), 'package.json');
+                return JSON.parse(fs.readFileSync(packagePath, 'utf8'));
+            }
+            catch (_a) {
+                return {};
+            }
+        });
+    }
+    boot() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const router = (0, express_1.Router)();
+            router.get(`${this.basepath}`, (req, res, next) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                var _a;
+                try {
+                    const packageJson = yield this.getPackageInfo();
+                    const versionInfo = {
+                        // Core version information
+                        version: packageJson.version || process.env.npm_package_version || 'unknown',
+                        name: packageJson.name || 'AsyncAPI CLI API',
+                        description: packageJson.description || 'All in one CLI for all AsyncAPI tools',
+                        // Runtime information
+                        runtime: {
+                            node: process.version,
+                            environment: process.env.NODE_ENV || 'development',
+                            platform: os.platform(),
+                            arch: os.arch(),
+                            uptime: `${Math.floor((Date.now() - this.startTime.getTime()) / 1000)} seconds`,
+                            startTime: this.startTime.toISOString()
+                        },
+                        // Repository information
+                        repository: {
+                            url: packageJson.homepage || ((_a = packageJson.repository) === null || _a === void 0 ? void 0 : _a.url) || 'https://github.com/asyncapi/cli',
+                            bugs: packageJson.bugs || 'https://github.com/asyncapi/cli/issues',
+                            license: packageJson.license || 'Apache-2.0'
+                        },
+                        // API metadata
+                        api: {
+                            basePath: this.basepath,
+                            timestamp: new Date().toISOString(),
+                            health: 'ok'
+                        }
+                    };
+                    res.json(versionInfo);
+                }
+                catch (err) {
+                    return next(err);
+                }
+            }));
+            return router;
+        });
+    }
+}
+exports.VersionController = VersionController;

package/lib/apps/api/index.d.ts

@@ -6,4 +6,5 @@ import { BundleController } from './controllers/bundle.controller';
 import { DiffController } from './controllers/diff.controller';
 import { DocsController } from './controllers/docs.controller';
 import { HelpController } from './controllers/help.controller';
-export declare const CONTROLLERS: (ValidateController | ParseController | GenerateController | ConvertController | BundleController | DiffController | DocsController | HelpController)[];
+import { VersionController } from './controllers/version.controller';
+export declare const CONTROLLERS: (ValidateController | ParseController | GenerateController | ConvertController | BundleController | DiffController | DocsController | HelpController | VersionController)[];

package/lib/apps/api/index.js

@@ -9,6 +9,7 @@ const bundle_controller_1 = require("./controllers/bundle.controller");
 const diff_controller_1 = require("./controllers/diff.controller");
 const docs_controller_1 = require("./controllers/docs.controller");
 const help_controller_1 = require("./controllers/help.controller");
+const version_controller_1 = require("./controllers/version.controller");
 exports.CONTROLLERS = [
     new validate_controller_1.ValidateController(),
     new parse_controller_1.ParseController(),
@@ -18,4 +19,5 @@ exports.CONTROLLERS = [
     new diff_controller_1.DiffController(),
     new docs_controller_1.DocsController(),
     new help_controller_1.HelpController(),
+    new version_controller_1.VersionController(),
 ];

package/lib/apps/api/middlewares/logger.middleware.d.ts

@@ -0,0 +1,2 @@
+import { NextFunction, Request, Response } from 'express';
+export declare function loggerMiddleware(req: Request, res: Response, next: NextFunction): void;

package/lib/apps/api/middlewares/logger.middleware.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loggerMiddleware = loggerMiddleware;
+const logger_1 = require("../../../utils/logger");
+function loggerMiddleware(req, res, next) {
+    const start = Date.now();
+    res.on('finish', () => {
+        const duration = Date.now() - start;
+        logger_1.logger.info(`[${req.method}] ${req.originalUrl} ${res.statusCode} - ${duration}ms`);
+    });
+    next();
+}

package/lib/apps/cli/commands/diff.d.ts

@@ -10,7 +10,7 @@ export default class Diff extends Command {
         'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<import("@stoplight/spectral-cli/dist/services/config").OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
         'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
-        output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'save-output': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         format: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         type: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
@@ -25,6 +25,7 @@ export default class Diff extends Command {
     };
     run(): Promise<void>;
     outputJSON(diffOutput: AsyncAPIDiff, outputType: string): void;
+    writeOutputToFile(diffOutput: AsyncAPIDiff, outputType: string, filePath: string, outputFormat: string): Promise<void>;
     outputYAML(diffOutput: AsyncAPIDiff, outputType: string): void;
     outputMarkdown(diffOutput: AsyncAPIDiff, outputType: string): void;
     parseDocuments(command: Command, firstDocument: Specification, secondDocument: Specification, flags: Record<string, any>): Promise<{

package/lib/apps/cli/commands/diff.js

@@ -32,6 +32,7 @@ class Diff extends base_1.default {
             let markdownSubtype = flags['markdownSubtype'];
             const watchMode = flags['watch'];
             const noError = flags['no-error'];
+            const writeOutput = flags['save-output'];
             let firstDocument, secondDocument;
             checkAndWarnFalseFlag(outputFormat, markdownSubtype);
             markdownSubtype = setDefaultMarkdownSubtype(outputFormat, markdownSubtype);
@@ -97,20 +98,25 @@ class Diff extends base_1.default {
                     outputType: outputFormat, // NOSONAR
                     markdownSubtype: markdownSubtype,
                 });
-                if (outputFormat === 'json') {
-                    this.outputJSON(diffOutput, outputType);
-                }
-                else if (outputFormat === 'yaml' || outputFormat === 'yml') {
-                    this.outputYAML(diffOutput, outputType);
-                }
-                else if (outputFormat === 'md') {
-                    this.outputMarkdown(diffOutput, outputType);
+                if (writeOutput) {
+                    yield this.writeOutputToFile(diffOutput, outputType, writeOutput, outputFormat);
                 }
                 else {
-                    this.log(`The output format ${outputFormat} is not supported at the moment.`);
-                }
-                if (!noError) {
-                    throwOnBreakingChange(diffOutput, outputFormat);
+                    if (outputFormat === 'json') {
+                        this.outputJSON(diffOutput, outputType);
+                    }
+                    else if (outputFormat === 'yaml' || outputFormat === 'yml') {
+                        this.outputYAML(diffOutput, outputType);
+                    }
+                    else if (outputFormat === 'md') {
+                        this.outputMarkdown(diffOutput, outputType);
+                    }
+                    else {
+                        this.log(`The output format ${outputFormat} is not supported at the moment.`);
+                    }
+                    if (!noError) {
+                        throwOnBreakingChange(diffOutput, outputFormat);
+                    }
                 }
             }
             catch (error) {
@@ -142,6 +148,44 @@ class Diff extends base_1.default {
             this.log(`The output type ${outputType} is not supported at the moment.`);
         }
     }
+    writeOutputToFile(diffOutput, outputType, filePath, outputFormat) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            let content;
+            if (outputFormat === 'json') {
+                if (outputType === 'breaking') {
+                    content = JSON.stringify(diffOutput.breaking(), null, 2);
+                }
+                else if (outputType === 'non-breaking') {
+                    content = JSON.stringify(diffOutput.nonBreaking(), null, 2);
+                }
+                else if (outputType === 'unclassified') {
+                    content = JSON.stringify(diffOutput.unclassified(), null, 2);
+                }
+                else if (outputType === 'all') {
+                    content = JSON.stringify(diffOutput.getOutput(), null, 2);
+                }
+                else {
+                    content = `The output type ${outputType} is not supported at the moment.`;
+                }
+            }
+            else if (outputFormat === 'yaml' || outputFormat === 'yml') {
+                content = genericOutput(diffOutput, outputType);
+            }
+            else if (outputFormat === 'md') {
+                content = genericOutput(diffOutput, outputType);
+            }
+            else {
+                content = `The output format ${outputFormat} is not supported at the moment.`;
+            }
+            try {
+                yield fs_1.promises.writeFile(filePath, content);
+                this.log(`Output successfully written to: ${filePath}`);
+            }
+            catch (error) {
+                this.error(`Failed to write output to file: ${error.message}`);
+            }
+        });
+    }
     outputYAML(diffOutput, outputType) {
         this.log(genericOutput(diffOutput, outputType));
     }

package/lib/apps/cli/commands/validate.d.ts

@@ -11,7 +11,7 @@ export default class Validate extends Command {
         'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<import("@stoplight/spectral-cli/dist/services/config").OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
         'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
-        output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'save-output': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         watch: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };

package/lib/apps/cli/commands/validate.js

@@ -55,6 +55,7 @@ class Validate extends base_1.default {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g;
             const diagnosticsFormat = (_a = flags['diagnostics-format']) !== null && _a !== void 0 ? _a : 'stylish';
+            const writeOutput = flags['save-output'];
             const hasIssues = (_c = (((_b = result.data) === null || _b === void 0 ? void 0 : _b.diagnostics) && result.data.diagnostics.length > 0)) !== null && _c !== void 0 ? _c : false;
             const isFailSeverity = ((_d = result.data) === null || _d === void 0 ? void 0 : _d.status) === validation_service_1.ValidationStatus.INVALID;
             const sourceString = ((_e = this.specFile) === null || _e === void 0 ? void 0 : _e.toSourceString()) || '';
@@ -66,15 +67,15 @@ class Validate extends base_1.default {
                 this.log(governanceMessage);
             }
             const diagnosticsOutput = this.validationService.formatDiagnosticsOutput(((_f = result.data) === null || _f === void 0 ? void 0 : _f.diagnostics) || [], diagnosticsFormat, (_g = flags['fail-severity']) !== null && _g !== void 0 ? _g : 'error');
-            if (flags.output) {
-                const { success, error } = yield this.validationService.saveDiagnosticsToFile(flags.output, diagnosticsFormat, diagnosticsOutput);
+            if (writeOutput) {
+                const { success, error } = yield this.validationService.saveDiagnosticsToFile(writeOutput, diagnosticsFormat, diagnosticsOutput);
                 if (!success) {
                     this.logToStderr(error || 'Failed to save diagnostics to file', {
                         exit: 1,
                     });
                 }
                 else {
-                    this.log(`Diagnostics saved to ${flags.output}`);
+                    this.log(`Diagnostics saved to ${writeOutput}`);
                 }
             }
             else {

package/lib/apps/cli/internal/flags/diff.flags.d.ts

@@ -2,7 +2,7 @@ export declare const diffFlags: () => {
     'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<import("@stoplight/spectral-cli/dist/services/config").OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
     'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
-    output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'save-output': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
     format: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     type: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;

package/lib/apps/cli/internal/flags/parser.flags.d.ts

@@ -6,5 +6,5 @@ export declare function parserFlags({ logDiagnostics, }?: ValidationFlagsOptions
     'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
     'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
-    output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'save-output': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
 };

package/lib/apps/cli/internal/flags/parser.flags.js

@@ -20,9 +20,9 @@ function parserFlags({ logDiagnostics = true, } = {}) {
             options: ['error', 'warn', 'info', 'hint'],
             default: 'error',
         })(),
-        output: core_1.Flags.string({
+        'save-output': core_1.Flags.string({
             description: 'The output file name. Omitting this flag the result will be printed in the console.',
-            char: 'o',
+            char: 's',
         }),
     };
 }

package/lib/apps/cli/internal/flags/validate.flags.d.ts

@@ -5,7 +5,7 @@ export declare const validateFlags: () => {
     'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<import("@stoplight/spectral-cli/dist/services/config").OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
     'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
-    output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'save-output': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
     watch: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
 };

package/oclif.manifest.json

@@ -288,10 +288,10 @@
           ],
           "type": "option"
         },
-        "output": {
-          "char": "o",
+        "save-output": {
+          "char": "s",
           "description": "The output file name. Omitting this flag the result will be printed in the console.",
-          "name": "output",
+          "name": "save-output",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -584,10 +584,10 @@
           ],
           "type": "option"
         },
-        "output": {
-          "char": "o",
+        "save-output": {
+          "char": "s",
           "description": "The output file name. Omitting this flag the result will be printed in the console.",
-          "name": "output",
+          "name": "save-output",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -1121,8 +1121,9 @@
         },
         "output": {
           "char": "o",
-          "description": "The output file name. Omitting this flag the result will be printed in the console.",
+          "description": "The output directory where the models should be written to. Omitting this flag will write the models to `stdout`.",
           "name": "output",
+          "required": false,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -1377,6 +1378,14 @@
           ],
           "type": "option"
         },
+        "save-output": {
+          "char": "s",
+          "description": "The output file name. Omitting this flag the result will be printed in the console.",
+          "name": "save-output",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "proxyHost": {
           "description": "Name of the ProxyHost",
           "name": "proxyHost",
@@ -2142,5 +2151,5 @@
       ]
     }
   },
-  "version": "3.5.1"
+  "version": "3.6.0"
 }

package/openapi.yaml

@@ -1,6 +1,6 @@
 openapi: 3.1.0
 info:
-  version: 0.1.0
+  version: 0.2.0
   title: AsyncAPI Server API
   description: Server API providing official AsyncAPI tools
   contact:
@@ -15,6 +15,31 @@ servers:
   - url: https://api.asyncapi.com/v1
 
 paths:
+  /version:
+    get:
+      summary: Get the current version of the AsyncAPI CLI.
+      operationId: getVersion
+      tags:
+        - version
+      responses:
+        "200":
+          description: Successfully retrieved the version.
+          content:
+            application/json:
+              schema:
+                ref: "#/components/schemas/VersionResponse"
+        "500":
+          description: Internal server error.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Problem"
+        default:
+          description: Unexpected problem.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Problem"
   /validate:
     post:
       summary: Validate the given AsyncAPI document.
@@ -581,3 +606,108 @@ components:
         - title
         - status
       additionalProperties: true
+    VersionResponse:
+      type: object
+      description: Version information for the AsyncAPI CLI API
+      properties:
+        version:
+          type: string
+          description: The current version of the AsyncAPI CLI
+          example: "3.5.1"
+        name:
+          type: string
+          description: The name of the application
+          example: "@asyncapi/cli"
+        description:
+          type: string
+          description: Description of the application
+          example: "All in one CLI for all AsyncAPI tools"
+        runtime:
+          type: object
+          description: Runtime information
+          properties:
+            node:
+              type: string
+              description: Node.js version
+              example: "v24.7.0"
+            environment:
+              type: string
+              description: Build environment
+              example: "development"
+              enum: ["development", "staging", "production"]
+            platform:
+              type: string
+              description: Operating system platform
+              example: "darwin"
+            arch:
+              type: string
+              description: System architecture
+              example: "arm64"
+            uptime:
+              type: string
+              description: Application uptime
+              example: "12 seconds"
+            startTime:
+              type: string
+              format: date-time
+              description: Application start time
+              example: "2025-09-12T05:08:25.171Z"
+          required:
+            - node
+            - environment
+            - platform
+            - arch
+            - uptime
+            - startTime
+        repository:
+          type: object
+          description: Repository information
+          properties:
+            url:
+              type: string
+              format: uri
+              description: Repository URL
+              example: "https://github.com/asyncapi/cli"
+            bugs:
+              type: string
+              format: uri
+              description: Bug tracker URL
+              example: "https://github.com/asyncapi/cli/issues"
+            license:
+              type: string
+              description: License type
+              example: "Apache-2.0"
+          required:
+            - url
+            - bugs
+            - license
+        api:
+          type: object
+          description: API metadata
+          properties:
+            basePath:
+              type: string
+              description: API base path
+              example: "/version"
+            timestamp:
+              type: string
+              format: date-time
+              description: Current timestamp
+              example: "2025-09-12T05:08:37.979Z"
+            health:
+              type: string
+              description: API health status
+              example: "ok"
+              enum: ["ok", "degraded", "error"]
+          required:
+            - basePath
+            - timestamp
+            - health
+      required:
+        - version
+        - name
+        - description
+        - build
+        - runtime
+        - repository
+        - api

package/package.json

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