@asyncapi/cli 1.16.1 → 1.18.0

package/lib/core/flags/generate/fromTemplate.flags.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fromTemplateFlags = void 0;
+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'
+        })
+    };
+};
+exports.fromTemplateFlags = fromTemplateFlags;

package/lib/core/flags/generate/models.flags.d.ts

@@ -0,0 +1,43 @@
+export declare const modelsFlags: () => {
+    '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>;
+    help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    'no-interactive': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    /**
+     * TypeScript specific options
+     */
+    tsModelType: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    tsEnumType: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    tsModuleSystem: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    tsIncludeComments: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    tsExportType: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    tsJsonBinPack: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    tsMarshalling: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    tsExampleInstance: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    tsRawPropertyNames: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    /**
+     * Go and Java specific package name to use for the generated models
+     */
+    packageName: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    /**
+     * Java specific options
+     */
+    javaIncludeComments: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    javaJackson: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    javaConstraints: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    /**
+     * C++ and C# and PHP specific namespace to use for the generated models
+     */
+    namespace: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    /**
+     * C# specific options
+     */
+    csharpAutoImplement: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    csharpNewtonsoft: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    csharpArrayType: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    csharpHashcode: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    csharpEqual: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    csharpSystemJson: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+};

package/lib/core/flags/generate/models.flags.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.modelsFlags = void 0;
+const core_1 = require("@oclif/core");
+const parser_1 = require("../../parser");
+const modelsFlags = () => {
+    return Object.assign({ help: core_1.Flags.help({ char: 'h' }), 'no-interactive': core_1.Flags.boolean({
+            description: 'Disable interactive mode and run with the provided flags.',
+            required: false,
+            default: false,
+        }), output: core_1.Flags.string({
+            char: 'o',
+            description: 'The output directory where the models should be written to. Omitting this flag will write the models to `stdout`.',
+            required: false
+        }), 
+        /**
+         * TypeScript specific options
+         */
+        tsModelType: core_1.Flags.string({
+            type: 'option',
+            options: ['class', 'interface'],
+            description: 'TypeScript specific, define which type of model needs to be generated.',
+            required: false,
+            default: 'class',
+        }), tsEnumType: core_1.Flags.string({
+            type: 'option',
+            options: ['enum', 'union'],
+            description: 'TypeScript specific, define which type of enums needs to be generated.',
+            required: false,
+            default: 'enum',
+        }), tsModuleSystem: core_1.Flags.string({
+            type: 'option',
+            options: ['ESM', 'CJS'],
+            description: 'TypeScript specific, define the module system to be used.',
+            required: false,
+            default: 'ESM',
+        }), tsIncludeComments: core_1.Flags.boolean({
+            description: 'TypeScript specific, if enabled add comments while generating models.',
+            required: false,
+            default: false,
+        }), tsExportType: core_1.Flags.string({
+            type: 'option',
+            options: ['default', 'named'],
+            description: 'TypeScript specific, define which type of export needs to be generated.',
+            required: false,
+            default: 'default',
+        }), tsJsonBinPack: core_1.Flags.boolean({
+            description: 'TypeScript specific, define basic support for serializing to and from binary with jsonbinpack.',
+            required: false,
+            default: false,
+        }), tsMarshalling: core_1.Flags.boolean({
+            description: 'TypeScript specific, generate the models with marshalling functions.',
+            required: false,
+            default: false,
+        }), tsExampleInstance: core_1.Flags.boolean({
+            description: 'Typescript specific, generate example of the model',
+            required: false,
+            default: false,
+        }), tsRawPropertyNames: core_1.Flags.boolean({
+            description: 'Typescript specific, generate the models using raw property names.',
+            required: false,
+            default: false,
+        }), 
+        /**
+         * Go and Java specific package name to use for the generated models
+         */
+        packageName: core_1.Flags.string({
+            description: 'Go, Java and Kotlin specific, define the package to use for the generated models. This is required when language is `go`, `java` or `kotlin`.',
+            required: false
+        }), 
+        /**
+         * Java specific options
+         */
+        javaIncludeComments: core_1.Flags.boolean({
+            description: 'Java specific, if enabled add comments while generating models.',
+            required: false,
+            default: false
+        }), javaJackson: core_1.Flags.boolean({
+            description: 'Java specific, generate the models with Jackson serialization support',
+            required: false,
+            default: false
+        }), javaConstraints: core_1.Flags.boolean({
+            description: 'Java specific, generate the models with constraints',
+            required: false,
+            default: false
+        }), 
+        /**
+         * C++ and C# and PHP specific namespace to use for the generated models
+         */
+        namespace: core_1.Flags.string({
+            description: 'C#, C++ and PHP specific, define the namespace to use for the generated models. This is required when language is `csharp`,`c++` or `php`.',
+            required: false
+        }), 
+        /**
+         * C# specific options
+         */
+        csharpAutoImplement: core_1.Flags.boolean({
+            description: 'C# specific, define whether to generate auto-implemented properties or not.',
+            required: false,
+            default: false
+        }), csharpNewtonsoft: core_1.Flags.boolean({
+            description: 'C# specific, generate the models with newtonsoft serialization support',
+            required: false,
+            default: false
+        }), csharpArrayType: core_1.Flags.string({
+            type: 'option',
+            description: 'C# specific, define which type of array needs to be generated.',
+            options: ['Array', 'List'],
+            required: false,
+            default: 'Array'
+        }), csharpHashcode: core_1.Flags.boolean({
+            description: 'C# specific, generate the models with the GetHashCode method overwritten',
+            required: false,
+            default: false
+        }), csharpEqual: core_1.Flags.boolean({
+            description: 'C# specific, generate the models with the Equal method overwritten',
+            required: false,
+            default: false
+        }), csharpSystemJson: core_1.Flags.boolean({
+            description: 'C# specific, generate the models with System.Text.Json serialization support',
+            required: false,
+            default: false
+        }) }, (0, parser_1.validationFlags)({ logDiagnostics: false }));
+};
+exports.modelsFlags = modelsFlags;

package/lib/{flags.d.ts → core/flags/global.flags.d.ts}

@@ -1 +1,4 @@
 export declare const watchFlag: (description?: string | undefined) => import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+export declare const helpFlag: () => {
+    help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+};

package/lib/{flags.js → core/flags/global.flags.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.watchFlag = void 0;
+exports.helpFlag = exports.watchFlag = void 0;
 const core_1 = require("@oclif/core");
 const watchFlag = (description) => {
     return core_1.Flags.boolean({
@@ -10,3 +10,9 @@ const watchFlag = (description) => {
     });
 };
 exports.watchFlag = watchFlag;
+const helpFlag = () => {
+    return {
+        help: core_1.Flags.help({ char: 'h' })
+    };
+};
+exports.helpFlag = helpFlag;

package/lib/core/flags/new/file.flags.d.ts

@@ -0,0 +1,8 @@
+export declare const fileFlags: (exampleFlagDescription: string) => {
+    help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    'file-name': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    example: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    studio: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    port: import("@oclif/core/lib/interfaces").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'no-tty': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+};

package/lib/core/flags/new/file.flags.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fileFlags = void 0;
+const core_1 = require("@oclif/core");
+const fileFlags = (exampleFlagDescription) => {
+    return {
+        help: core_1.Flags.help({ char: 'h' }),
+        'file-name': core_1.Flags.string({ char: 'n', description: 'name of the file' }),
+        example: core_1.Flags.string({ char: 'e', description: exampleFlagDescription }),
+        studio: core_1.Flags.boolean({ char: 's', description: 'open in Studio' }),
+        port: core_1.Flags.integer({ char: 'p', description: 'port in which to start Studio' }),
+        'no-tty': core_1.Flags.boolean({ description: 'do not use an interactive terminal' }),
+    };
+};
+exports.fileFlags = fileFlags;

package/lib/core/flags/new/glee.flags.d.ts

@@ -0,0 +1,7 @@
+export declare const gleeFlags: () => {
+    help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    name: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    template: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    file: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'force-write': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+};

package/lib/core/flags/new/glee.flags.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gleeFlags = void 0;
+const core_1 = require("@oclif/core");
+const gleeFlags = () => {
+    return {
+        help: core_1.Flags.help({ char: 'h' }),
+        name: core_1.Flags.string({
+            char: 'n',
+            description: 'Name of the Project',
+            default: 'project',
+        }),
+        template: core_1.Flags.string({
+            char: 't',
+            description: 'Name of the Template',
+            default: 'default',
+        }),
+        file: core_1.Flags.string({
+            char: 'f',
+            description: 'The path to the AsyncAPI file for generating a Glee project.',
+        }),
+        '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)',
+        }),
+    };
+};
+exports.gleeFlags = gleeFlags;

package/lib/core/flags/optimize.flags.d.ts

@@ -0,0 +1,17 @@
+export declare enum Optimizations {
+    REMOVE_COMPONENTS = "remove-components",
+    REUSE_COMPONENTS = "reuse-components",
+    MOVE_DUPLICATES_TO_COMPONENTS = "move-duplicates-to-components",
+    MOVE_ALL_TO_COMPONENTS = "move-all-to-components"
+}
+export declare enum Outputs {
+    TERMINAL = "terminal",
+    NEW_FILE = "new-file",
+    OVERWRITE = "overwrite"
+}
+export declare const optimizeFlags: () => {
+    help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    optimization: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
+    output: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'no-tty': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+};

package/lib/core/flags/optimize.flags.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.optimizeFlags = exports.Outputs = exports.Optimizations = void 0;
+const core_1 = require("@oclif/core");
+var Optimizations;
+(function (Optimizations) {
+    Optimizations["REMOVE_COMPONENTS"] = "remove-components";
+    Optimizations["REUSE_COMPONENTS"] = "reuse-components";
+    Optimizations["MOVE_DUPLICATES_TO_COMPONENTS"] = "move-duplicates-to-components";
+    Optimizations["MOVE_ALL_TO_COMPONENTS"] = "move-all-to-components";
+})(Optimizations = exports.Optimizations || (exports.Optimizations = {}));
+var Outputs;
+(function (Outputs) {
+    Outputs["TERMINAL"] = "terminal";
+    Outputs["NEW_FILE"] = "new-file";
+    Outputs["OVERWRITE"] = "overwrite";
+})(Outputs = exports.Outputs || (exports.Outputs = {}));
+const optimizeFlags = () => {
+    return {
+        help: core_1.Flags.help({ char: 'h' }),
+        optimization: core_1.Flags.string({ char: 'p', default: Object.values(Optimizations), options: Object.values(Optimizations), multiple: true, description: 'select the type of optimizations that you want to apply.' }),
+        output: core_1.Flags.string({ char: 'o', default: Outputs.TERMINAL, options: Object.values(Outputs), description: 'select where you want the output.' }),
+        'no-tty': core_1.Flags.boolean({ description: 'do not use an interactive terminal', default: false }),
+    };
+};
+exports.optimizeFlags = optimizeFlags;

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

@@ -0,0 +1,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>;
+};

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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.studioFlags = void 0;
+const core_1 = require("@oclif/core");
+const studioFlags = () => {
+    return {
+        help: core_1.Flags.help({ char: 'h' }),
+        file: core_1.Flags.string({ char: 'f', description: 'path to the AsyncAPI file to link with Studio' }),
+        port: core_1.Flags.integer({ char: 'p', description: 'port in which to start Studio' }),
+    };
+};
+exports.studioFlags = studioFlags;

package/lib/core/flags/validate.flags.d.ts

@@ -0,0 +1,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>;
+    help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    watch: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+};

package/lib/core/flags/validate.flags.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateFlags = void 0;
+const core_1 = require("@oclif/core");
+const parser_1 = require("../parser");
+const global_flags_1 = require("./global.flags");
+const validateFlags = () => {
+    return Object.assign({ help: core_1.Flags.help({ char: 'h' }), watch: (0, global_flags_1.watchFlag)() }, (0, parser_1.validationFlags)());
+};
+exports.validateFlags = validateFlags;

package/oclif.manifest.json

@@ -1141,7 +1141,7 @@
     "start": {
       "aliases": [],
       "args": {},
-      "description": "Start asyncapi studio",
+      "description": "",
       "flags": {},
       "hasDynamicHelp": false,
       "hiddenAliases": [],
@@ -1476,5 +1476,5 @@
       ]
     }
   },
-  "version": "1.16.1"
+  "version": "1.18.0"
 }

package/package.json

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