@asyncapi/cli 3.1.1 → 3.3.0

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

@@ -0,0 +1,85 @@
+"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("../internal/base"));
+const validation_error_1 = require("../../../errors/validation-error");
+const SpecificationFile_1 = require("../../../domains/models/SpecificationFile");
+const specification_file_1 = require("../../../errors/specification-file");
+const picocolors_1 = require("picocolors");
+const proxy_flags_1 = require("../internal/flags/proxy.flags");
+const specs_1 = tslib_1.__importDefault(require("@asyncapi/specs"));
+const convert_flags_1 = require("../internal/flags/convert.flags");
+const convert_service_1 = require("../../../domains/services/convert.service");
+const latestVersion = Object.keys(specs_1.default.schemas).pop();
+class Convert extends base_1.default {
+    constructor() {
+        super(...arguments);
+        this.conversionService = new convert_service_1.ConversionService();
+    }
+    run() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const { args, flags } = yield this.parse(Convert);
+            let filePath = args['spec-file'];
+            const proxyHost = flags['proxyHost'];
+            const proxyPort = flags['proxyPort'];
+            if (proxyHost && proxyPort) {
+                const proxyUrl = `http://${proxyHost}:${proxyPort}`;
+                filePath = `${filePath}+${proxyUrl}`; // Update filePath with proxyUrl
+            }
+            try {
+                // LOAD FILE
+                this.specFile = yield (0, SpecificationFile_1.load)(filePath);
+                // eslint-disable-next-line sonarjs/no-duplicate-string
+                this.metricsMetadata.to_version = flags['target-version'];
+                const conversionOptions = {
+                    format: flags.format,
+                    'target-version': (flags['target-version'] ||
+                        latestVersion),
+                    perspective: flags['perspective'],
+                };
+                const result = yield this.conversionService.convertDocument(this.specFile, conversionOptions);
+                if (!result.success || !result.data) {
+                    this.error(result.error || 'Conversion failed', { exit: 1 });
+                }
+                this.metricsMetadata.conversion_result = result;
+                this.log(this.conversionService.handleLogging(this.specFile, conversionOptions));
+                if (flags['output']) {
+                    yield this.conversionService.handleOutput(flags['output'], result.data.convertedDocument);
+                }
+                else {
+                    this.log(result.data.convertedDocument);
+                }
+            }
+            catch (err) {
+                this.handleError(err, filePath !== null && filePath !== void 0 ? filePath : 'unknown', flags);
+            }
+        });
+    }
+    // Helper function to handle errors
+    handleError(err, filePath, flags) {
+        var _a;
+        if (err instanceof specification_file_1.SpecificationFileNotFound) {
+            this.error(new validation_error_1.ValidationError({
+                type: 'invalid-file',
+                filepath: filePath,
+            }));
+        }
+        else if (((_a = this.specFile) === null || _a === void 0 ? void 0 : _a.toJson().asyncapi) > flags['target-version']) {
+            this.error(`The ${(0, picocolors_1.cyan)(filePath)} file cannot be converted to an older version. Downgrading is not supported.`);
+        }
+        else {
+            this.error(err);
+        }
+    }
+}
+Convert.metricsMetadata = {};
+Convert.description = 'Convert asyncapi documents older to newer versions or OpenAPI/postman-collection documents to AsyncAPI';
+Convert.flags = Object.assign(Object.assign({}, (0, convert_flags_1.convertFlags)(latestVersion)), (0, proxy_flags_1.proxyFlags)());
+Convert.args = {
+    'spec-file': core_1.Args.string({
+        description: 'spec path, url, or context-name',
+        required: false,
+    }),
+};
+exports.default = Convert;

package/lib/{commands → apps/cli/commands}/diff.d.ts

@@ -1,11 +1,15 @@
 import AsyncAPIDiff from '@asyncapi/diff/lib/asyncapidiff';
-import Command from '../core/base';
+import { Specification } from '../../../domains/models/SpecificationFile';
+import Command from '../internal/base';
+import { ValidationStatus } from '../../../domains/services/validation.service';
+import { Diagnostic } from '@asyncapi/parser/cjs';
 export default class Diff extends Command {
     static description: string;
+    private validationService;
     static flags: {
         '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<"info" | "error" | "warn" | "hint", 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>;
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         format: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
@@ -23,4 +27,9 @@ export default class Diff extends Command {
     outputJSON(diffOutput: AsyncAPIDiff, outputType: string): 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<{
+        firstDocumentParsed: import("@asyncapi/parser/cjs").AsyncAPIDocumentInterface;
+        secondDocumentParsed: import("@asyncapi/parser/cjs").AsyncAPIDocumentInterface;
+    } | undefined>;
+    handleGovernanceMessage(document: Specification, diagnostics: Diagnostic[], status: ValidationStatus): Promise<void>;
 }

package/lib/{commands → apps/cli/commands}/diff.js

@@ -6,16 +6,20 @@ const core_1 = require("@oclif/core");
 const diff = tslib_1.__importStar(require("@asyncapi/diff"));
 const fs_1 = require("fs");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const SpecificationFile_1 = require("../core/models/SpecificationFile");
-const base_1 = tslib_1.__importDefault(require("../core/base"));
-const validation_error_1 = require("../core/errors/validation-error");
-const specification_file_1 = require("../core/errors/specification-file");
-const diff_error_1 = require("../core/errors/diff-error");
-const globals_1 = require("../core/globals");
-const parser_1 = require("../core/parser");
-const diff_flags_1 = require("../core/flags/diff.flags");
+const SpecificationFile_1 = require("../../../domains/models/SpecificationFile");
+const base_1 = tslib_1.__importDefault(require("../internal/base"));
+const validation_error_1 = require("../../../errors/validation-error");
+const specification_file_1 = require("../../../errors/specification-file");
+const diff_error_1 = require("../../../errors/diff-error");
+const globals_1 = require("../internal/globals");
+const diff_flags_1 = require("../internal/flags/diff.flags");
+const validation_service_1 = require("../../../domains/services/validation.service");
 const { readFile } = fs_1.promises;
 class Diff extends base_1.default {
+    constructor() {
+        super(...arguments);
+        this.validationService = new validation_service_1.ValidationService();
+    }
     /* eslint-disable sonarjs/cognitive-complexity */
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -84,14 +88,14 @@ class Diff extends base_1.default {
                 }
             }
             try {
-                const parsed = yield parseDocuments(this, firstDocument, secondDocument, flags);
+                const parsed = yield this.parseDocuments(this, firstDocument, secondDocument, flags);
                 if (!parsed) {
                     return;
                 }
                 const diffOutput = diff.diff(parsed.firstDocumentParsed.json(), parsed.secondDocumentParsed.json(), {
                     override: overrides,
                     outputType: outputFormat, // NOSONAR
-                    markdownSubtype: markdownSubtype
+                    markdownSubtype: markdownSubtype,
                 });
                 if (outputFormat === 'json') {
                     this.outputJSON(diffOutput, outputType);
@@ -110,7 +114,8 @@ class Diff extends base_1.default {
                 }
             }
             catch (error) {
-                if (error instanceof diff_error_1.DiffBreakingChangeError || error instanceof TypeError) {
+                if (error instanceof diff_error_1.DiffBreakingChangeError ||
+                    error instanceof TypeError) {
                     this.error(error);
                 }
                 throw new validation_error_1.ValidationError({
@@ -143,12 +148,65 @@ class Diff extends base_1.default {
     outputMarkdown(diffOutput, outputType) {
         this.log(genericOutput(diffOutput, outputType));
     }
+    parseDocuments(command, firstDocument, secondDocument, flags) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const firstResult = yield this.validationService.parseDocument(firstDocument, {}, flags);
+            const secondResult = yield this.validationService.parseDocument(secondDocument, {}, flags);
+            if (!firstResult.success || !secondResult.success) {
+                this.error(new validation_error_1.ValidationError({
+                    type: 'invalid-file',
+                    filepath: firstDocument.getFilePath() || secondDocument.getFilePath(),
+                    err: firstResult.error || secondResult.error,
+                }));
+            }
+            if (!firstResult.data || !secondResult.data) {
+                return;
+            }
+            const { document: firstDocumentParsed, status: firstDocumentStatus, diagnostics: firstDiagnostics, } = firstResult.data;
+            const { document: secondDocumentParsed, status: secondDocumentStatus, diagnostics: secondDiagnostics, } = secondResult.data;
+            if (flags['log-diagnostics']) {
+                this.log(`Diagnostics for ${firstDocument.getFilePath() || firstDocument.getFileURL()}:`);
+                this.handleGovernanceMessage(firstDocument, firstDiagnostics, firstDocumentStatus);
+                this.log(this.validationService.formatDiagnosticsOutput(firstDiagnostics, flags['diagnostics-format'], flags['fail-severity']));
+                this.log(`Diagnostics for ${secondDocument.getFilePath() || secondDocument.getFileURL()}:`);
+                this.handleGovernanceMessage(secondDocument, secondDiagnostics, secondDocumentStatus);
+                this.log(this.validationService.formatDiagnosticsOutput(secondDiagnostics, flags['diagnostics-format'], flags['fail-severity']));
+            }
+            if (!firstDocumentParsed ||
+                !secondDocumentParsed ||
+                firstDocumentStatus === 'invalid' ||
+                secondDocumentStatus === 'invalid') {
+                return;
+            }
+            return { firstDocumentParsed, secondDocumentParsed };
+        });
+    }
+    handleGovernanceMessage(document, diagnostics, status) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const sourceString = document.toSourceString();
+            const hasIssues = diagnostics && diagnostics.length > 0;
+            const isFailSeverity = status === validation_service_1.ValidationStatus.INVALID;
+            const governanceMessage = this.validationService.generateGovernanceMessage(sourceString, hasIssues, isFailSeverity);
+            if (isFailSeverity) {
+                this.logToStderr(governanceMessage);
+            }
+            else {
+                this.log(governanceMessage);
+            }
+        });
+    }
 }
 Diff.description = 'Find diff between two asyncapi files';
 Diff.flags = (0, diff_flags_1.diffFlags)();
 Diff.args = {
-    old: core_1.Args.string({ description: 'old spec path, URL or context-name', required: true }),
-    new: core_1.Args.string({ description: 'new spec path, URL or context-name', required: true }),
+    old: core_1.Args.string({
+        description: 'old spec path, URL or context-name',
+        required: true,
+    }),
+    new: core_1.Args.string({
+        description: 'new spec path, URL or context-name',
+        required: true,
+    }),
 };
 exports.default = Diff;
 /**
@@ -159,23 +217,18 @@ exports.default = Diff;
  */
 function genericOutput(diffOutput, outputType) {
     switch (outputType) {
-        case 'breaking': return diffOutput.breaking();
-        case 'non-breaking': return diffOutput.nonBreaking();
-        case 'unclassified': return diffOutput.unclassified();
-        case 'all': return diffOutput.getOutput();
-        default: return `The output type ${outputType} is not supported at the moment.`;
+        case 'breaking':
+            return diffOutput.breaking();
+        case 'non-breaking':
+            return diffOutput.nonBreaking();
+        case 'unclassified':
+            return diffOutput.unclassified();
+        case 'all':
+            return diffOutput.getOutput();
+        default:
+            return `The output type ${outputType} is not supported at the moment.`;
     }
 }
-function parseDocuments(command, firstDocument, secondDocument, flags) {
-    return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const { document: firstDocumentParsed, status: firstDocumentStatus } = yield (0, parser_1.parse)(command, firstDocument, flags);
-        const { document: secondDocumentParsed, status: secondDocumentStatus } = yield (0, parser_1.parse)(command, secondDocument, flags);
-        if (!firstDocumentParsed || !secondDocumentParsed || firstDocumentStatus === 'invalid' || secondDocumentStatus === 'invalid') {
-            return;
-        }
-        return { firstDocumentParsed, secondDocumentParsed };
-    });
-}
 /**
  * Reads the file from give path and parses it as JSON
  * @param path The path to override file
@@ -213,7 +266,8 @@ 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 === 'yaml' || outputFormat === 'yml') &&
+            breakingChanges !== '[]\n')) {
         throw new diff_error_1.DiffBreakingChangeError();
     }
 }
@@ -221,7 +275,7 @@ function throwOnBreakingChange(diffOutput, outputFormat) {
  * Checks and warns user about providing unnecessary markdownSubtype option.
  */
 function checkAndWarnFalseFlag(format, markdownSubtype) {
-    if (format !== 'md' && typeof (markdownSubtype) !== 'undefined') {
+    if (format !== 'md' && typeof markdownSubtype !== 'undefined') {
         const warningMessage = chalk_1.default.yellowBright(`Warning: The given markdownSubtype flag will not work with the given format.\nProvided flag markdownSubtype: ${markdownSubtype}`);
         console.log(warningMessage);
     }
@@ -230,7 +284,7 @@ function checkAndWarnFalseFlag(format, markdownSubtype) {
  * Sets the default markdownSubtype option in case user doesn't provide one.
  */
 function setDefaultMarkdownSubtype(format, markdownSubtype) {
-    if (format === 'md' && typeof (markdownSubtype) === 'undefined') {
+    if (format === 'md' && typeof markdownSubtype === 'undefined') {
         return 'yaml';
     }
     return markdownSubtype;

package/lib/{commands → apps/cli/commands}/format.d.ts

@@ -1,4 +1,4 @@
-import Command from '../core/base';
+import Command from '../internal/base';
 export default class Convert extends Command {
     static specFile: any;
     static metricsMetadata: any;

package/lib/{commands → apps/cli/commands}/format.js

@@ -4,11 +4,11 @@ const tslib_1 = require("tslib");
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 const fs_1 = require("fs");
 const core_1 = require("@oclif/core");
-const base_1 = tslib_1.__importDefault(require("../core/base"));
-const SpecificationFile_1 = require("../core/models/SpecificationFile");
-const specification_file_1 = require("../core/errors/specification-file");
+const base_1 = tslib_1.__importDefault(require("../internal/base"));
+const SpecificationFile_1 = require("../../../domains/models/SpecificationFile");
+const specification_file_1 = require("../../../errors/specification-file");
 const picocolors_1 = require("picocolors");
-const format_flags_1 = require("../core/flags/format.flags");
+const format_flags_1 = require("../internal/flags/format.flags");
 class Convert extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {

package/lib/{commands → apps/cli/commands}/generate/fromTemplate.d.ts

@@ -1,7 +1,8 @@
-import Command from '../../core/base';
+import Command from '../../internal/base';
 import { Parser } from '@asyncapi/parser';
 export default class Template extends Command {
     static description: string;
+    private generatorService;
     static examples: string[];
     static readonly flags: {
         proxyHost: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
@@ -27,16 +28,14 @@ export default class Template extends Command {
         template: import("@oclif/core/lib/interfaces").Arg<string | undefined, Record<string, unknown>>;
     };
     parser: Parser;
-    run(): Promise<void>;
+    run(): Promise<undefined>;
     private parseArgs;
+    private disableHooksParser;
     private parseFlags;
     private registryURLParser;
     private registryValidation;
     private paramParser;
-    private disableHooksParser;
     private mapBaseURLParser;
-    private generate;
-    private generateUsingNewGenerator;
     private runWatchMode;
     private watcherHandler;
     private getMapBaseUrlToFolderResolver;