trm-client 9.4.0 → 10.0.0

package/dist/command/implementations/Ping.d.ts

@@ -1,5 +1,6 @@
 import { AbstractCommand } from "../AbstractCommand";
+import { CommandMetadata } from "../metadata/CommandMetadata";
 export declare class Ping extends AbstractCommand {
-    protected init(): void;
+    static readonly metadata: CommandMetadata;
     protected handler(): Promise<void>;
 }

package/dist/command/implementations/Ping.js

@@ -14,11 +14,6 @@ const trm_commons_1 = require("trm-commons");
 const trm_core_1 = require("trm-core");
 const AbstractCommand_1 = require("../AbstractCommand");
 class Ping extends AbstractCommand_1.AbstractCommand {
-    init() {
-        this.registerOpts.requiresConnection = true;
-        this.registerOpts.requiresTrmDependencies = true;
-        this.command.description(`Ping trm-server (Used for testing purposes).`);
-    }
     handler() {
         return __awaiter(this, void 0, void 0, function* () {
             trm_commons_1.Logger.loading(`Pinging trm-server on ${trm_core_1.SystemConnector.getDest()}...`);
@@ -28,3 +23,18 @@ class Ping extends AbstractCommand_1.AbstractCommand {
     }
 }
 exports.Ping = Ping;
+Ping.metadata = {
+    id: "ping",
+    command: "ping",
+    title: "Ping server",
+    group: "registry",
+    guiRelevant: false,
+    description: "Ping the TRM server used by the connected system.",
+    icon: "Radar",
+    arguments: [],
+    options: [],
+    requirements: {
+        requiresConnection: true,
+        requiresTrmDependencies: true
+    }
+};

package/dist/command/implementations/Publish.d.ts

@@ -1,6 +1,8 @@
 import { AbstractCommand } from "../AbstractCommand";
+import { CommandMetadata } from "../metadata/CommandMetadata";
 export declare class Publish extends AbstractCommand {
-    protected init(): void;
+    private static readonly releaseOptions;
+    static readonly metadata: CommandMetadata[];
     private validateVersion;
     protected handler(): Promise<void>;
 }

package/dist/command/implementations/Publish.js

@@ -20,47 +20,8 @@ const utils_1 = require("../../utils");
 const semver_1 = require("semver");
 const path_1 = require("path");
 const sanitize_filename_1 = __importDefault(require("sanitize-filename"));
+const helpers_1 = require("../metadata/helpers");
 class Publish extends AbstractCommand_1.AbstractCommand {
-    init() {
-        this.registerOpts.requiresConnection = true;
-        this.registerOpts.requiresTrmDependencies = true;
-        if (this.name === 'pack') {
-            this.command.description(`Export a package to local file.`);
-            this.command.argument(`<package>`, `Name of the package`);
-            this.command.argument(`<version>`, `Version of the release`);
-            this.command.argument(`[filename]`, `Name (or path) of the output file.`);
-        }
-        else {
-            this.registerOpts.requiresRegistry = true;
-            this.command.description(`Publish a package to a registry.`);
-            this.command.argument(`<package>`, `Name of the package.`);
-            this.command.argument(`[version]`, `Optional: Version of the release to publish.`);
-            this.command.option(`-i, --increment <increment>`, `Semantic versioning increment (used when no version is specified)`, `patch`);
-            this.command.option(`--pre-release`, `Publish as pre release`, false);
-            this.command.option(`--pre-release-identifier <identifier>`, `Identifier (needs to pre a pre release)`);
-            this.command.option(`--tag <tag>`, `Release tag(s) (separated by comma)`);
-            this.command.option(`--private`, `Package marked as private. Depending on the registry, visibility might not be changed after first publish.`);
-            this.command.option(`--readme <readme>`, `Release readme (markdown or path to markdown file)`);
-            this.command.option(`--no-keep-manifest`, `Don't default to previous release manifest values.`);
-        }
-        this.command.option(`-P, --sap-package <sap package>`, `SAP Package.`);
-        this.command.option(`-T, --target <target>`, `Transport release target.`);
-        this.command.option(`--no-lang-tr`, `Do not generate language (translation) transport.`);
-        this.command.option(`--no-cust-tr`, `Do not generate customizing transport.`);
-        this.command.option(`--cust <customizing>`, `Customizing transport(s) (separated by comma).`);
-        this.command.option(`--no-auto-deps`, `Do not look for dependencies.`);
-        this.command.option(`--authors <authors>`, `Release author(s) (separated by comma)`);
-        this.command.option(`--backwards-compatible`, `Backwards-compatible release (reserved for future use)`);
-        this.command.option(`--description <description>`, `Release description`);
-        this.command.option(`--git <git url>`, `Release git URL`);
-        this.command.option(`--keywords <keywords>`, `Release keyword(s) (separated by comma)`);
-        this.command.option(`--license <license>`, `Release license`);
-        this.command.option(`--website <website url>`, `Release website URL`);
-        this.command.option(`--dependencies <dependencies>`, `Release dependencies (JSON or path to JSON file)`);
-        this.command.option(`--sap-entries <sap entries>`, `Release SAP entries (JSON or path to JSON file)`);
-        this.command.option(`--post-activities <post activities>`, `Release post activities (JSON or path to JSON file)`);
-        this.command.option(`--no-prompts`, `No prompts (will force some decisions).`);
-    }
     validateVersion(v) {
         if ((0, semver_1.valid)(v)) {
             return true;
@@ -154,3 +115,72 @@ class Publish extends AbstractCommand_1.AbstractCommand {
     }
 }
 exports.Publish = Publish;
+Publish.releaseOptions = [
+    (0, helpers_1.option)("-P, --sap-package <sap package>", { name: "sapPackage", label: "SAP package", description: "SAP package that owns the release objects." }),
+    (0, helpers_1.option)("-T, --target <target>", { name: "target", label: "Transport target", description: "Target system for release transports." }),
+    (0, helpers_1.option)("--no-lang-tr", { name: "langTr", label: "Language transport", description: "Skip language transport generation.", control: "checkbox", defaultValue: true }),
+    (0, helpers_1.option)("--no-cust-tr", { name: "custTr", label: "Customizing transport", description: "Skip customizing transport generation.", control: "checkbox", defaultValue: true }),
+    (0, helpers_1.option)("--cust <customizing>", { name: "cust", label: "Customizing transports", description: "Customizing transport requests, separated by commas.", multiple: true }),
+    (0, helpers_1.option)("--no-auto-deps", { name: "autoDeps", label: "Automatic dependencies", description: "Skip automatic dependency detection.", control: "checkbox", defaultValue: true }),
+    (0, helpers_1.option)("--authors <authors>", { name: "authors", label: "Authors", description: "Release authors, separated by commas.", multiple: true }),
+    (0, helpers_1.option)("--backwards-compatible", { name: "backwardsCompatible", label: "Backwards compatible", description: "Mark the release as backwards compatible.", control: "checkbox" }),
+    (0, helpers_1.option)("--description <description>", { name: "description", label: "Description", description: "Release description." }),
+    (0, helpers_1.option)("--git <git url>", { name: "git", label: "Git URL", description: "Release Git repository URL." }),
+    (0, helpers_1.option)("--keywords <keywords>", { name: "keywords", label: "Keywords", description: "Release keywords, separated by commas.", multiple: true }),
+    (0, helpers_1.option)("--license <license>", { name: "license", label: "License", description: "Release license." }),
+    (0, helpers_1.option)("--website <website url>", { name: "website", label: "Website", description: "Release website URL." }),
+    (0, helpers_1.option)("--dependencies <dependencies>", { name: "dependencies", label: "Dependencies", description: "Release dependencies as JSON, or a path to a JSON file.", control: "textarea" }),
+    (0, helpers_1.option)("--sap-entries <sap entries>", { name: "sapEntries", label: "SAP entries", description: "Release SAP entries as JSON, or a path to a JSON file.", control: "textarea" }),
+    (0, helpers_1.option)("--post-activities <post activities>", { name: "postActivities", label: "Post activities", description: "Release post activities as JSON, or a path to a JSON file.", control: "textarea" }),
+    (0, helpers_1.option)("--no-prompts", { name: "prompts", label: "Prompts", description: "Disable prompts and use automatic decisions.", control: "checkbox", defaultValue: true, guiRelevant: false })
+];
+Publish.metadata = [
+    {
+        id: "publish",
+        command: "publish",
+        title: "Publish package",
+        group: "package",
+        groupPriority: 9,
+        description: "Publish a package release to the registry.",
+        icon: "PackagePlus",
+        arguments: [
+            (0, helpers_1.argument)(0, { name: "package", label: "Package", description: "Package name." }),
+            (0, helpers_1.argument)(1, { name: "version", label: "Version", description: "Release version to publish.", required: false })
+        ],
+        options: [
+            (0, helpers_1.option)("-i, --increment <increment>", { name: "increment", label: "Version increment", description: "Semantic version increment to use when no version is provided.", control: "select", defaultValue: "patch" }),
+            (0, helpers_1.option)("--pre-release", { name: "preRelease", label: "Pre-release", description: "Publish the release as a pre-release.", control: "checkbox", defaultValue: false }),
+            (0, helpers_1.option)("--pre-release-identifier <identifier>", { name: "preReleaseIdentifier", label: "Pre-release identifier", description: "Identifier to append to a pre-release version." }),
+            (0, helpers_1.option)("--tag <tag>", { name: "tag", label: "Tags", description: "Release distribution tags, separated by commas.", multiple: true }),
+            (0, helpers_1.option)("--private", { name: "private", label: "Private", description: "Mark the package as private. Registry visibility may not be changeable after the first publish.", control: "checkbox" }),
+            (0, helpers_1.option)("--readme <readme>", { name: "readme", label: "Readme", description: "Release readme as Markdown, or a path to a Markdown file.", control: "textarea" }),
+            (0, helpers_1.option)("--no-keep-manifest", { name: "keepManifest", label: "Reuse manifest", description: "Do not reuse values from the previous release manifest.", control: "checkbox", defaultValue: true }),
+            ...Publish.releaseOptions
+        ],
+        requirements: {
+            requiresConnection: true,
+            requiresTrmDependencies: true,
+            requiresRegistry: true
+        }
+    },
+    {
+        id: "pack",
+        command: "pack",
+        aliases: ["export"],
+        title: "Export package",
+        group: "package",
+        groupPriority: 7,
+        description: "Export a package release to a local file.",
+        icon: "PackageOpen",
+        arguments: [
+            (0, helpers_1.argument)(0, { name: "package", label: "Package", description: "Package name." }),
+            (0, helpers_1.argument)(1, { name: "version", label: "Version", description: "Release version." }),
+            (0, helpers_1.argument)(2, { name: "filename", label: "Output file", description: "Output file name or path.", required: false, control: "file-picker" })
+        ],
+        options: Publish.releaseOptions,
+        requirements: {
+            requiresConnection: true,
+            requiresTrmDependencies: true
+        }
+    }
+];

package/dist/command/implementations/Registry.d.ts

@@ -1,5 +1,6 @@
 import { AbstractCommand } from "../AbstractCommand";
+import { CommandMetadata } from "../metadata/CommandMetadata";
 export declare class Registry extends AbstractCommand {
-    protected init(): void;
+    static readonly metadata: CommandMetadata[];
     protected handler(): Promise<void>;
 }

package/dist/command/implementations/Registry.js

@@ -14,19 +14,8 @@ const trm_core_1 = require("trm-core");
 const AbstractCommand_1 = require("../AbstractCommand");
 const trm_commons_1 = require("trm-commons");
 const registryAlias_1 = require("../../registryAlias");
+const helpers_1 = require("../metadata/helpers");
 class Registry extends AbstractCommand_1.AbstractCommand {
-    init() {
-        this.registerOpts.requiresRegistry = true;
-        if (this.subcommand === 'add') {
-            this.command.description(`Add a new registry.`);
-            this.command.argument(`<registry name>`, `Name of the registry to generate. Name "${trm_core_1.PUBLIC_RESERVED_KEYWORD}" and "${trm_core_1.LOCAL_RESERVED_KEYWORD}" are protected and cannot be used.`);
-        }
-        else if (this.subcommand === 'rm') {
-            this.command.description(`Remove a registry.`);
-            this.command.argument(`<registry name>`, `Name of the registry to delete. Registries "${trm_core_1.PUBLIC_RESERVED_KEYWORD}" and "${trm_core_1.LOCAL_RESERVED_KEYWORD}" are protected and cannot be deleted.`);
-        }
-        this.command.option(`-E, --registry-endpoint <endpoint>`, `Registry endpoint.`);
-    }
     handler() {
         return __awaiter(this, void 0, void 0, function* () {
             const registryName = this.args.registryName.trim();
@@ -83,3 +72,41 @@ class Registry extends AbstractCommand_1.AbstractCommand {
     }
 }
 exports.Registry = Registry;
+Registry.metadata = [
+    {
+        id: "registry:add",
+        command: "registry",
+        subcommand: "add",
+        title: "Add registry",
+        group: "registry",
+        description: "Add a registry alias.",
+        icon: "DatabaseZap",
+        arguments: [
+            (0, helpers_1.argument)(0, { name: "registryName", cliName: "registry name", label: "Registry name", description: `Registry alias to create. "${trm_core_1.PUBLIC_RESERVED_KEYWORD}" and "${trm_core_1.LOCAL_RESERVED_KEYWORD}" are reserved and cannot be used.` })
+        ],
+        options: [
+            (0, helpers_1.option)("-E, --registry-endpoint <endpoint>", { name: "registryEndpoint", label: "Registry endpoint", description: "Endpoint URL for the registry." })
+        ],
+        requirements: {
+            requiresRegistry: true
+        }
+    },
+    {
+        id: "registry:rm",
+        command: "registry",
+        subcommand: "rm",
+        title: "Remove registry",
+        group: "registry",
+        description: "Remove a registry alias.",
+        icon: "DatabaseX",
+        arguments: [
+            (0, helpers_1.argument)(0, { name: "registryName", cliName: "registry name", label: "Registry name", description: `Registry alias to remove. "${trm_core_1.PUBLIC_RESERVED_KEYWORD}" and "${trm_core_1.LOCAL_RESERVED_KEYWORD}" are protected and cannot be deleted.` })
+        ],
+        options: [
+            (0, helpers_1.option)("-E, --registry-endpoint <endpoint>", { name: "registryEndpoint", label: "Registry endpoint", description: "Endpoint URL for the registry." })
+        ],
+        requirements: {
+            requiresRegistry: true
+        }
+    }
+];

package/dist/command/implementations/Settings.d.ts

@@ -1,5 +1,6 @@
 import { AbstractCommand } from "../AbstractCommand";
+import { CommandMetadata } from "../metadata/CommandMetadata";
 export declare class Settings extends AbstractCommand {
-    protected init(): void;
+    static readonly metadata: CommandMetadata;
     protected handler(): Promise<void>;
 }

package/dist/command/implementations/Settings.js

@@ -13,13 +13,8 @@ exports.Settings = void 0;
 const trm_commons_1 = require("trm-commons");
 const AbstractCommand_1 = require("../AbstractCommand");
 const utils_1 = require("../../utils");
+const helpers_1 = require("../metadata/helpers");
 class Settings extends AbstractCommand_1.AbstractCommand {
-    init() {
-        this.registerOpts.requiresConnection = true;
-        this.registerOpts.requiresTrmDependencies = true;
-        this.command.description(`Show/Set settings.`);
-        this.command.option(`-s, --set <property>`, `Property as KEY=VALUE.`);
-    }
     handler() {
         return __awaiter(this, void 0, void 0, function* () {
             const setArgument = this.args.set;
@@ -40,3 +35,20 @@ class Settings extends AbstractCommand_1.AbstractCommand {
     }
 }
 exports.Settings = Settings;
+Settings.metadata = {
+    id: "settings",
+    command: "settings",
+    title: "Settings",
+    group: "utility",
+    guiRelevant: false,
+    description: "Show or update client settings.",
+    icon: "Settings",
+    arguments: [],
+    options: [
+        (0, helpers_1.option)("-s, --set <property>", { name: "set", label: "Set property", description: "Setting to update, in KEY=VALUE format." })
+    ],
+    requirements: {
+        requiresConnection: true,
+        requiresTrmDependencies: true
+    }
+};

package/dist/command/implementations/Unpublish.d.ts

@@ -1,5 +1,6 @@
 import { AbstractCommand } from "../AbstractCommand";
+import { CommandMetadata } from "../metadata/CommandMetadata";
 export declare class Unpublish extends AbstractCommand {
-    protected init(): void;
+    static readonly metadata: CommandMetadata;
     protected handler(): Promise<void>;
 }

package/dist/command/implementations/Unpublish.js

@@ -13,13 +13,8 @@ exports.Unpublish = void 0;
 const trm_commons_1 = require("trm-commons");
 const AbstractCommand_1 = require("../AbstractCommand");
 const semver_1 = require("semver");
+const helpers_1 = require("../metadata/helpers");
 class Unpublish extends AbstractCommand_1.AbstractCommand {
-    init() {
-        this.registerOpts.requiresRegistry = true;
-        this.command.description(`Unpublish a package release from registry.`);
-        this.command.argument(`<package>`, `Name of the package.`);
-        this.command.argument(`<version>`, `Version of the release.`);
-    }
     handler() {
         return __awaiter(this, void 0, void 0, function* () {
             if (!(0, semver_1.valid)(this.args.version)) {
@@ -32,3 +27,19 @@ class Unpublish extends AbstractCommand_1.AbstractCommand {
     }
 }
 exports.Unpublish = Unpublish;
+Unpublish.metadata = {
+    id: "unpublish",
+    command: "unpublish",
+    title: "Unpublish release",
+    group: "registry",
+    description: "Unpublish a package release from the registry.",
+    icon: "PackageX",
+    arguments: [
+        (0, helpers_1.argument)(0, { name: "package", label: "Package", description: "Package name." }),
+        (0, helpers_1.argument)(1, { name: "version", label: "Version", description: "Release version." })
+    ],
+    options: [],
+    requirements: {
+        requiresRegistry: true
+    }
+};

package/dist/command/implementations/View.d.ts

@@ -1,6 +1,7 @@
 import { AbstractCommand } from "../AbstractCommand";
+import { CommandMetadata } from "../metadata/CommandMetadata";
 export declare class View extends AbstractCommand {
-    protected init(): void;
+    static readonly metadata: CommandMetadata;
     private printHeaderSection;
     private printVersionSection;
     private printManifestSection;

package/dist/command/implementations/View.js

@@ -20,19 +20,9 @@ const chalk_1 = __importDefault(require("chalk"));
 const utils_1 = require("../../utils");
 const semver_1 = require("semver");
 const registryAlias_1 = require("../../registryAlias");
+const helpers_1 = require("../metadata/helpers");
 class View extends AbstractCommand_1.AbstractCommand {
-    init() {
-        this.registerOpts.requiresConnection = true;
-        this.registerOpts.addNoConnection = true;
-        this.registerOpts.requiresRegistry = true;
-        this.registerOpts.ignoreRegistryUnreachable = true;
-        this.command.description(`View package.`);
-        this.command.addHelpText(`before`, `Shows package details.
-If the package is not found on the system, it will automatically fall back to the data provided by the registry, granted it exists.`);
-        this.command.argument(`<package>`, `Name of the package.`);
-    }
     printHeaderSection(sapPackage) {
-        trm_commons_1.Logger.info(`Package name: ${chalk_1.default.bold(this.args.package)}`);
         trm_commons_1.Logger.info(`Registry: ${this.getRegistry().name}`);
         if (sapPackage) {
             trm_commons_1.Logger.info(`SAP Package: ${sapPackage}`);
@@ -232,3 +222,24 @@ If the package is not found on the system, it will automatically fall back to th
     }
 }
 exports.View = View;
+View.metadata = {
+    id: "view",
+    command: "view",
+    title: "View package",
+    group: "package",
+    guiRelevant: false,
+    description: "Show package details.",
+    longDescription: `Shows package details from the connected system.
+If the package is not installed, the command falls back to registry data when available.`,
+    icon: "Eye",
+    arguments: [
+        (0, helpers_1.argument)(0, { name: "package", label: "Package", description: "Package name." })
+    ],
+    options: [],
+    requirements: {
+        requiresConnection: true,
+        addNoConnection: true,
+        requiresRegistry: true,
+        ignoreRegistryUnreachable: true
+    }
+};

package/dist/command/implementations/WhoAmI.d.ts

@@ -1,5 +1,6 @@
 import { AbstractCommand } from "../AbstractCommand";
+import { CommandMetadata } from "../metadata/CommandMetadata";
 export declare class WhoAmI extends AbstractCommand {
-    protected init(): void;
+    static readonly metadata: CommandMetadata;
     protected handler(): Promise<void>;
 }

package/dist/command/implementations/WhoAmI.js

@@ -14,13 +14,6 @@ const trm_commons_1 = require("trm-commons");
 const AbstractCommand_1 = require("../AbstractCommand");
 const trm_registry_types_1 = require("trm-registry-types");
 class WhoAmI extends AbstractCommand_1.AbstractCommand {
-    init() {
-        this.registerOpts.requiresRegistry = true;
-        this.registerOpts.onlyRegistryAlias = true;
-        this.registerOpts.registryAuthBlacklist = [trm_registry_types_1.AuthenticationType.NO_AUTH];
-        this.command.description(`Get data about a current registry logged user.`);
-        this.command.addHelpText(`before`, `This command has no effect when trying to login into a registry that doesn't require authentication.`);
-    }
     handler() {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.hasRegistryAuthData()) {
@@ -34,3 +27,20 @@ class WhoAmI extends AbstractCommand_1.AbstractCommand {
     }
 }
 exports.WhoAmI = WhoAmI;
+WhoAmI.metadata = {
+    id: "whoami",
+    command: "whoami",
+    title: "Current user",
+    group: "registry",
+    guiRelevant: false,
+    description: "Show the currently authenticated registry user.",
+    longDescription: "This command has no effect for registries that do not require authentication.",
+    icon: "UserRound",
+    arguments: [],
+    options: [],
+    requirements: {
+        requiresRegistry: true,
+        onlyRegistryAlias: true,
+        registryAuthBlacklist: [trm_registry_types_1.AuthenticationType.NO_AUTH]
+    }
+};

package/dist/command/implementations/index.d.ts

@@ -1,3 +1,27 @@
+import { CommandClass } from "../metadata/CommandMetadata";
+import { Ping } from "./Ping";
+import { Info } from "./Info";
+import { Registry } from "./Registry";
+import { Login } from "./Login";
+import { WhoAmI } from "./WhoAmI";
+import { Logout } from "./Logout";
+import { Alias } from "./Alias";
+import { Publish } from "./Publish";
+import { DistTag } from "./DistTag";
+import { Lock } from "./Lock";
+import { Unpublish } from "./Unpublish";
+import { Deprecate } from "./Deprecate";
+import { Install } from "./Install";
+import { List } from "./List";
+import { Content } from "./Content";
+import { View } from "./View";
+import { Compare } from "./Compare";
+import { Dirty } from "./Dirty";
+import { FindDependencies } from "./FindDependencies";
+import { Cg3y } from "./Cg3y";
+import { Cg3z } from "./Cg3z";
+import { Settings } from "./Settings";
+import { ClearCache } from "./ClearCache";
 export * from "./Ping";
 export * from "./Info";
 export * from "./Registry";
@@ -21,3 +45,6 @@ export * from "./Cg3y";
 export * from "./Cg3z";
 export * from "./Settings";
 export * from "./ClearCache";
+export declare const commands: (typeof Ping | typeof Info | typeof Registry | typeof Login | typeof WhoAmI | typeof Logout | typeof Alias | typeof Publish | typeof DistTag | typeof Lock | typeof Unpublish | typeof Deprecate | typeof Install | typeof List | typeof Content | typeof View | typeof Compare | typeof Dirty | typeof FindDependencies | typeof Cg3y | typeof Cg3z | typeof Settings | typeof ClearCache)[];
+export declare function getCommand(id: string): CommandClass | undefined;
+export declare function getCommandMetadata(id: string): import("../metadata/CommandMetadata").CommandMetadata;

package/dist/command/implementations/index.js

@@ -14,6 +14,32 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.commands = void 0;
+exports.getCommand = getCommand;
+exports.getCommandMetadata = getCommandMetadata;
+const Ping_1 = require("./Ping");
+const Info_1 = require("./Info");
+const Registry_1 = require("./Registry");
+const Login_1 = require("./Login");
+const WhoAmI_1 = require("./WhoAmI");
+const Logout_1 = require("./Logout");
+const Alias_1 = require("./Alias");
+const Publish_1 = require("./Publish");
+const DistTag_1 = require("./DistTag");
+const Lock_1 = require("./Lock");
+const Unpublish_1 = require("./Unpublish");
+const Deprecate_1 = require("./Deprecate");
+const Install_1 = require("./Install");
+const List_1 = require("./List");
+const Content_1 = require("./Content");
+const View_1 = require("./View");
+const Compare_1 = require("./Compare");
+const Dirty_1 = require("./Dirty");
+const FindDependencies_1 = require("./FindDependencies");
+const Cg3y_1 = require("./Cg3y");
+const Cg3z_1 = require("./Cg3z");
+const Settings_1 = require("./Settings");
+const ClearCache_1 = require("./ClearCache");
 __exportStar(require("./Ping"), exports);
 __exportStar(require("./Info"), exports);
 __exportStar(require("./Registry"), exports);
@@ -37,3 +63,42 @@ __exportStar(require("./Cg3y"), exports);
 __exportStar(require("./Cg3z"), exports);
 __exportStar(require("./Settings"), exports);
 __exportStar(require("./ClearCache"), exports);
+exports.commands = [
+    Ping_1.Ping,
+    Info_1.Info,
+    Registry_1.Registry,
+    Login_1.Login,
+    WhoAmI_1.WhoAmI,
+    Logout_1.Logout,
+    Alias_1.Alias,
+    Publish_1.Publish,
+    DistTag_1.DistTag,
+    Lock_1.Lock,
+    Unpublish_1.Unpublish,
+    Deprecate_1.Deprecate,
+    Install_1.Install,
+    List_1.List,
+    Content_1.Content,
+    View_1.View,
+    Compare_1.Compare,
+    Dirty_1.Dirty,
+    FindDependencies_1.FindDependencies,
+    Cg3y_1.Cg3y,
+    Cg3z_1.Cg3z,
+    Settings_1.Settings,
+    ClearCache_1.ClearCache
+];
+function getCommand(id) {
+    return exports.commands.find(commandClass => {
+        const metadata = Array.isArray(commandClass.metadata) ? commandClass.metadata : [commandClass.metadata];
+        return metadata.some(command => command.id === id);
+    });
+}
+function getCommandMetadata(id) {
+    const commandClass = getCommand(id);
+    if (!commandClass) {
+        return undefined;
+    }
+    const metadata = Array.isArray(commandClass.metadata) ? commandClass.metadata : [commandClass.metadata];
+    return metadata.find(command => command.id === id);
+}

package/dist/command/index.d.ts

@@ -2,3 +2,5 @@ export * from "./AbstractCommand";
 export * from "./InquirerType";
 export * from "./LoggerType";
 export * from "./RegisterCommandOpts";
+export * from "./metadata";
+export * from "./runCommandHandler";

package/dist/command/index.js

@@ -18,3 +18,5 @@ __exportStar(require("./AbstractCommand"), exports);
 __exportStar(require("./InquirerType"), exports);
 __exportStar(require("./LoggerType"), exports);
 __exportStar(require("./RegisterCommandOpts"), exports);
+__exportStar(require("./metadata"), exports);
+__exportStar(require("./runCommandHandler"), exports);

package/dist/command/metadata/CommandMetadata.d.ts

@@ -0,0 +1,55 @@
+import { RegisterCommandOpts } from "../RegisterCommandOpts";
+import type { AbstractCommand } from "../AbstractCommand";
+export type CommandControlType = "text-input" | "password-input" | "number-input" | "checkbox" | "select" | "multiselect" | "file-picker" | "textarea";
+export interface CommandValueChoice {
+    label: string;
+    value: string | number | boolean;
+    description?: string;
+}
+export interface CommandFieldMetadata {
+    name: string;
+    cliName?: string;
+    label: string;
+    description: string;
+    required: boolean;
+    control: CommandControlType;
+    defaultValue?: unknown;
+    choices?: CommandValueChoice[];
+    placeholder?: string;
+    multiple?: boolean;
+    sensitive?: boolean;
+    guiRelevant?: boolean;
+}
+export interface CommandArgumentMetadata extends CommandFieldMetadata {
+    kind: "argument";
+    position: number;
+}
+export interface CommandOptionMetadata extends CommandFieldMetadata {
+    kind: "option";
+    flags: string;
+}
+export type CommandGroup = "package" | "registry" | "system" | "utility";
+export interface CommandMetadata {
+    id: string;
+    command: string;
+    subcommand?: string;
+    aliases?: string[];
+    title: string;
+    group: CommandGroup;
+    groupPriority?: number;
+    guiRelevant?: boolean;
+    description: string;
+    longDescription?: string;
+    icon: string;
+    arguments: CommandArgumentMetadata[];
+    options: CommandOptionMetadata[];
+    requirements: RegisterCommandOpts;
+}
+export type CommandMetadataExport = CommandMetadata | CommandMetadata[];
+export interface CommandMetadataProvider {
+    readonly metadata: CommandMetadataExport;
+}
+export interface CommandClass extends CommandMetadataProvider {
+    new (program: import("commander").Command, name: string, aliases?: string[], subcommand?: string): AbstractCommand;
+    new (name: string, aliases?: string[], subcommand?: string): AbstractCommand;
+}

package/dist/command/metadata/CommandMetadata.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/command/metadata/applyCommandMetadata.d.ts

@@ -0,0 +1,3 @@
+import { Command } from "commander";
+import { CommandMetadata } from "./CommandMetadata";
+export declare function applyCommandMetadata(command: Command, metadata: CommandMetadata): void;

package/dist/command/metadata/applyCommandMetadata.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyCommandMetadata = applyCommandMetadata;
+function argumentToken(argument) {
+    var _a;
+    const name = (_a = argument.cliName) !== null && _a !== void 0 ? _a : argument.name;
+    return argument.required ? `<${name}>` : `[${name}]`;
+}
+function applyCommandMetadata(command, metadata) {
+    var _a;
+    if ((_a = metadata.aliases) === null || _a === void 0 ? void 0 : _a.length) {
+        command.aliases(metadata.aliases);
+    }
+    command.description(metadata.description);
+    if (metadata.longDescription) {
+        command.addHelpText("before", metadata.longDescription);
+    }
+    [...metadata.arguments]
+        .sort((a, b) => a.position - b.position)
+        .forEach(argument => {
+        command.argument(argumentToken(argument), argument.description, argument.defaultValue);
+    });
+    metadata.options.forEach(option => {
+        command.option(option.flags, option.description, option.defaultValue);
+    });
+}