@asyncapi/cli 3.4.2 → 3.5.1

package/lib/apps/cli/internal/base/BaseGeneratorCommand.d.ts

@@ -0,0 +1,42 @@
+import Command from '../../internal/base';
+import { Specification } from '../../../../domains/models/SpecificationFile';
+import { Parser } from '@asyncapi/parser';
+import { ParsedFlags } from '../../../../domains/models/generate/Flags';
+import { GeneratorService } from '../../../../domains/services/generator.service';
+export interface GeneratorOptions {
+    forceWrite: boolean;
+    install: boolean;
+    debug: boolean;
+    templateParams: any;
+    noOverwriteGlobs: string[];
+    mapBaseUrlToFolder: any;
+    disabledHooks: Record<string, string>;
+    registry: {
+        url?: string;
+        auth?: string;
+        token?: string;
+    };
+}
+export declare abstract class BaseGeneratorCommand extends Command {
+    static readonly flags: {
+        proxyHost: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        proxyPort: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    };
+    static args: {
+        asyncapi: import("@oclif/core/lib/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
+    parser: Parser;
+    protected generatorService: GeneratorService;
+    protected buildGeneratorOptions(flags: any, parsedFlags: ParsedFlags): Promise<GeneratorOptions>;
+    protected applyProxyConfiguration(asyncapi: string, proxyHost?: string, proxyPort?: string): string;
+    protected handleWatchMode(asyncapi: string, template: string, output: string, options: GeneratorOptions, genOption: any, interactive: boolean): Promise<void>;
+    protected buildGenOption(flags: any, parsedFlags: ParsedFlags): any;
+    protected generate(asyncapi: string | undefined, template: string, output: string, options: GeneratorOptions, genOption: any, interactive?: boolean): Promise<void>;
+    protected parseCommonArgs(args: Record<string, any>, output?: string): Promise<{
+        asyncapi: string;
+        output: string;
+    }>;
+    protected loadAsyncAPIInput(asyncapi: string): Promise<Specification>;
+    protected handleCancellation(value: any): void;
+    protected loadSpecificationSafely(asyncapi: string | undefined): Promise<Specification>;
+}

package/lib/apps/cli/internal/base/BaseGeneratorCommand.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseGeneratorCommand = void 0;
+const tslib_1 = require("tslib");
+const base_1 = tslib_1.__importDefault(require("../../internal/base"));
+// eslint-disable-next-line
+// @ts-ignore
+const generator_1 = tslib_1.__importDefault(require("@asyncapi/generator"));
+const SpecificationFile_1 = require("../../../../domains/models/SpecificationFile");
+const validation_error_1 = require("../../../../errors/validation-error");
+const generator_error_1 = require("../../../../errors/generator-error");
+const parser_1 = require("@asyncapi/parser");
+const prompts_1 = require("@clack/prompts");
+const proxy_flags_1 = require("../../internal/flags/proxy.flags");
+const generate_args_1 = require("../../internal/args/generate.args");
+const watcher_1 = require("../../../../utils/generate/watcher");
+const mapBaseUrl_1 = require("../../../../utils/generate/mapBaseUrl");
+const prompts_2 = require("../../../../utils/generate/prompts");
+const generator_service_1 = require("../../../../domains/services/generator.service");
+class BaseGeneratorCommand extends base_1.default {
+    constructor() {
+        super(...arguments);
+        this.parser = new parser_1.Parser();
+        this.generatorService = new generator_service_1.GeneratorService();
+    }
+    buildGeneratorOptions(flags, parsedFlags) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return {
+                forceWrite: flags['force-write'],
+                install: flags.install,
+                debug: flags.debug,
+                templateParams: parsedFlags.params,
+                noOverwriteGlobs: flags['no-overwrite'],
+                mapBaseUrlToFolder: parsedFlags.mapBaseUrlToFolder,
+                disabledHooks: parsedFlags.disableHooks,
+                registry: {
+                    url: flags['registry-url'],
+                    auth: flags['registry-auth'],
+                    token: flags['registry-token'],
+                },
+            };
+        });
+    }
+    applyProxyConfiguration(asyncapi, proxyHost, proxyPort) {
+        if (proxyHost && proxyPort) {
+            const proxyUrl = `http://${proxyHost}:${proxyPort}`;
+            return `${asyncapi}+${proxyUrl}`;
+        }
+        return asyncapi;
+    }
+    handleWatchMode(asyncapi, template, output, options, genOption, interactive) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const watcher = (0, watcher_1.watcherHandler)(this, asyncapi, template, output, options, genOption, interactive);
+            yield (0, watcher_1.runWatchMode)(this, asyncapi, template, output, generator_1.default, watcher);
+        });
+    }
+    buildGenOption(flags, parsedFlags) {
+        const genOption = {};
+        if (flags['map-base-url']) {
+            genOption.resolve = { resolve: (0, mapBaseUrl_1.getMapBaseUrlToFolderResolver)(parsedFlags.mapBaseUrlToFolder) };
+        }
+        return genOption;
+    }
+    generate(asyncapi_1, template_1, output_1, options_1, genOption_1) {
+        return tslib_1.__awaiter(this, arguments, void 0, function* (asyncapi, template, output, options, genOption, interactive = true) {
+            const specification = yield this.loadSpecificationSafely(asyncapi);
+            const result = yield this.generatorService.generate(specification, template, output, options, // GeneratorService expects different options interface
+            genOption, interactive);
+            if (!result.success) {
+                throw new generator_error_1.GeneratorError(new Error(result.error));
+            }
+        });
+    }
+    parseCommonArgs(args, output) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            let asyncapi = args['asyncapi'];
+            const cancellationMessage = 'Operation cancelled';
+            if (!asyncapi) {
+                asyncapi = yield (0, prompts_2.promptForAsyncAPIPath)();
+            }
+            if ((0, prompts_1.isCancel)(asyncapi)) {
+                this.error(cancellationMessage, { exit: 1 });
+            }
+            if (!output) {
+                output = yield (0, prompts_2.promptForOutputDir)();
+            }
+            if ((0, prompts_1.isCancel)(output)) {
+                this.error(cancellationMessage, { exit: 1 });
+            }
+            return { asyncapi, output };
+        });
+    }
+    loadAsyncAPIInput(asyncapi) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return (yield (0, SpecificationFile_1.load)(asyncapi)) || (yield (0, SpecificationFile_1.load)());
+        });
+    }
+    handleCancellation(value) {
+        if ((0, prompts_1.isCancel)(value)) {
+            this.error('Operation cancelled', { exit: 1 });
+        }
+    }
+    loadSpecificationSafely(asyncapi) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield (0, SpecificationFile_1.load)(asyncapi);
+            }
+            catch (err) {
+                return this.error(new validation_error_1.ValidationError({
+                    type: 'invalid-file',
+                    filepath: asyncapi,
+                }), { exit: 1 });
+            }
+        });
+    }
+}
+exports.BaseGeneratorCommand = BaseGeneratorCommand;
+BaseGeneratorCommand.flags = Object.assign({}, (0, proxy_flags_1.proxyFlags)());
+BaseGeneratorCommand.args = Object.assign({}, generate_args_1.generateArgs);

package/lib/apps/cli/internal/flags/generate/clients.flags.d.ts

@@ -0,0 +1,16 @@
+export declare const clientsFlags: () => {
+    help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    'disable-hook': import("@oclif/core/lib/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'no-interactive': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    install: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    debug: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    'no-overwrite': import("@oclif/core/lib/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'force-write': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    watch: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    param: import("@oclif/core/lib/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'map-base-url': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'registry-url': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'registry-auth': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'registry-token': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+};

package/lib/apps/cli/internal/flags/generate/clients.flags.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clientsFlags = void 0;
+const sharedFlags_1 = require("./sharedFlags");
+const clientsFlags = () => {
+    return Object.assign({}, sharedFlags_1.sharedFlags);
+};
+exports.clientsFlags = clientsFlags;

package/lib/apps/cli/internal/flags/generate/fromTemplate.flags.d.ts

@@ -1,4 +1,29 @@
 export declare const fromTemplateFlags: () => {
+    'use-new-generator': {
+        name: string;
+        char?: import("@oclif/core/lib/interfaces").AlphabetLowercase | import("@oclif/core/lib/interfaces").AlphabetUppercase;
+        summary?: string;
+        description: string;
+        helpLabel?: string;
+        helpGroup?: string;
+        env?: string;
+        hidden?: boolean;
+        required?: boolean;
+        dependsOn?: string[];
+        exclusive?: string[];
+        exactlyOne?: string[];
+        relationships?: import("@oclif/core/lib/interfaces/parser").Relationship[];
+        deprecated?: true | import("@oclif/core/lib/interfaces").Deprecation;
+        aliases?: string[];
+        charAliases?: (import("@oclif/core/lib/interfaces").AlphabetLowercase | import("@oclif/core/lib/interfaces").AlphabetUppercase)[];
+        deprecateAliases?: boolean;
+        noCacheDefault?: boolean;
+        atLeastOne?: string[];
+        type: "boolean";
+        allowNo: boolean;
+        default: import("@oclif/core/lib/interfaces/parser").FlagDefault<boolean>;
+        parse: (input: boolean, context: import("@oclif/core/lib/interfaces/parser").FlagParserContext, opts: import("@oclif/core/lib/interfaces/parser").FlagProps & import("@oclif/core/lib/interfaces/parser").BooleanFlagProps) => Promise<boolean>;
+    };
     help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
     'disable-hook': import("@oclif/core/lib/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     'no-interactive': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
@@ -13,5 +38,4 @@ export declare const fromTemplateFlags: () => {
     'registry-url': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     'registry-auth': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     'registry-token': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
-    'use-new-generator': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
 };

package/lib/apps/cli/internal/flags/generate/fromTemplate.flags.js

@@ -1,65 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fromTemplateFlags = void 0;
+const sharedFlags_1 = require("./sharedFlags");
 const core_1 = require("@oclif/core");
-const global_flags_1 = require("../global.flags");
 const fromTemplateFlags = () => {
-    return {
-        help: core_1.Flags.help({ char: 'h' }),
-        'disable-hook': core_1.Flags.string({
-            char: 'd',
-            description: 'Disable a specific hook type or hooks from a given hook type',
-            multiple: true,
-        }),
-        'no-interactive': core_1.Flags.boolean({
-            description: 'Disable interactive mode and run with the provided flags.',
-            required: false,
-            default: false,
-        }),
-        install: core_1.Flags.boolean({
-            char: 'i',
-            default: false,
-            description: 'Installs the template and its dependencies (defaults to false)',
-        }),
-        debug: core_1.Flags.boolean({
-            description: 'Enable more specific errors in the console',
-        }),
-        'no-overwrite': core_1.Flags.string({
-            char: 'n',
-            multiple: true,
-            description: 'Glob or path of the file(s) to skip when regenerating',
-        }),
-        output: core_1.Flags.string({
-            char: 'o',
-            description: 'Directory where to put the generated files (defaults to current directory)',
-        }),
-        'force-write': core_1.Flags.boolean({
-            default: false,
-            description: 'Force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)',
-        }),
-        watch: (0, global_flags_1.watchFlag)('Watches the template directory and the AsyncAPI document, and re-generate the files when changes occur. Ignores the output directory.'),
-        param: core_1.Flags.string({
-            char: 'p',
-            description: 'Additional param to pass to templates',
-            multiple: true,
-        }),
-        'map-base-url': core_1.Flags.string({
-            description: 'Maps all schema references from base url to local folder',
-        }),
-        'registry-url': core_1.Flags.string({
-            default: 'https://registry.npmjs.org',
-            description: 'Specifies the URL of the private registry for fetching templates and dependencies',
-        }),
-        'registry-auth': core_1.Flags.string({
-            description: 'The registry username and password encoded with base64, formatted as username:password',
-        }),
-        'registry-token': core_1.Flags.string({
-            description: 'The npm registry authentication token, that can be passed instead of base64 encoded username and password',
-        }),
-        'use-new-generator': core_1.Flags.boolean({
-            default: false,
-            description: 'Use v2 generator, for generating from newer templates',
-        }),
-    };
+    return Object.assign(Object.assign({}, sharedFlags_1.sharedFlags), { 'use-new-generator': Object.assign({ default: false, description: 'Use v2 generator, for generating from newer templates' }, core_1.Flags.boolean()) });
 };
 exports.fromTemplateFlags = fromTemplateFlags;

package/lib/apps/cli/internal/flags/generate/sharedFlags.d.ts

@@ -0,0 +1,16 @@
+export declare const sharedFlags: {
+    help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    'disable-hook': import("@oclif/core/lib/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'no-interactive': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    install: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    debug: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    'no-overwrite': import("@oclif/core/lib/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'force-write': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    watch: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    param: import("@oclif/core/lib/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'map-base-url': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'registry-url': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'registry-auth': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'registry-token': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+};

package/lib/apps/cli/internal/flags/generate/sharedFlags.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sharedFlags = void 0;
+const core_1 = require("@oclif/core");
+const global_flags_1 = require("../global.flags");
+exports.sharedFlags = {
+    help: core_1.Flags.help({ char: 'h' }),
+    'disable-hook': core_1.Flags.string({
+        char: 'd',
+        description: 'Disable a specific hook type or hooks from a given hook type',
+        multiple: true
+    }),
+    'no-interactive': core_1.Flags.boolean({
+        description: 'Disable interactive mode and run with the provided flags.',
+        default: false,
+    }),
+    install: core_1.Flags.boolean({
+        char: 'i',
+        default: false,
+        description: 'Installs the template and its dependencies (defaults to false)'
+    }),
+    debug: core_1.Flags.boolean({
+        description: 'Enable more specific errors in the console'
+    }),
+    'no-overwrite': core_1.Flags.string({
+        char: 'n',
+        multiple: true,
+        description: 'Glob or path of the file(s) to skip when regenerating'
+    }),
+    output: core_1.Flags.string({
+        char: 'o',
+        description: 'Directory where to put the generated files (defaults to current directory)',
+    }),
+    'force-write': core_1.Flags.boolean({
+        default: false,
+        description: 'Force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)'
+    }),
+    watch: (0, global_flags_1.watchFlag)('Watches the template directory and the AsyncAPI document, and re-generate the files when changes occur. Ignores the output directory.'),
+    param: core_1.Flags.string({
+        char: 'p',
+        description: 'Additional param to pass to templates',
+        multiple: true
+    }),
+    'map-base-url': core_1.Flags.string({
+        description: 'Maps all schema references from base url to local folder'
+    }),
+    'registry-url': core_1.Flags.string({
+        default: 'https://registry.npmjs.org',
+        description: 'Specifies the URL of the private registry for fetching templates and dependencies'
+    }),
+    'registry-auth': core_1.Flags.string({
+        description: 'The registry username and password encoded with base64, formatted as username:password'
+    }),
+    'registry-token': core_1.Flags.string({
+        description: 'The npm registry authentication token, that can be passed instead of base64 encoded username and password'
+    }),
+};

package/lib/apps/cli/internal/flags/start/preview.flags.d.ts

@@ -5,4 +5,5 @@ export declare const previewFlags: () => {
     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>;
+    noBrowser: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
 };

package/lib/apps/cli/internal/flags/start/preview.flags.js

@@ -26,6 +26,7 @@ const previewFlags = () => {
             description: 'Pass this to suppress the detiled error logs.',
             default: false,
         }),
+        noBrowser: core_1.Flags.boolean({ char: 'B', description: 'Pass this to not open browser automatically upon running the command', default: false })
     };
 };
 exports.previewFlags = previewFlags;

package/lib/apps/cli/internal/flags/start/studio.flags.d.ts

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

package/lib/apps/cli/internal/flags/start/studio.flags.js

@@ -19,6 +19,7 @@ const studioFlags = () => {
             required: false,
             default: false,
         }),
+        noBrowser: core_1.Flags.boolean({ char: 'B', description: 'Pass this to not open browser automatically upon running the command', default: false })
     };
 };
 exports.studioFlags = studioFlags;

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

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