@flowscripter/dynamic-cli-framework 1.7.3 → 1.7.4

package/dist/src/api/RunResult.js

@@ -0,0 +1,73 @@
+export var RunState;
+(function (RunState) {
+    /**
+     * Arguments were successfully parsed and the specified command(s) were successfully executed.
+     */
+    RunState[RunState["SUCCESS"] = 0] = "SUCCESS";
+    /**
+     * The arguments supplied were invalid or could not be parsed.
+     */
+    RunState[RunState["PARSE_ERROR"] = 1] = "PARSE_ERROR";
+    /**
+     * Arguments were successfully parsed but no command was discovered.
+     */
+    RunState[RunState["NO_COMMAND"] = 2] = "NO_COMMAND";
+    /**
+     * Arguments were successfully parsed and command(s) discovered but command execution failed.
+     */
+    RunState[RunState["EXECUTION_ERROR"] = 3] = "EXECUTION_ERROR";
+    /**
+     * General runtime error related to the framework.
+     */
+    RunState[RunState["RUNTIME_ERROR"] = 4] = "RUNTIME_ERROR";
+    /**
+     * Execution was interrupted by a signal (e.g. Ctrl-C or SIGTERM).
+     */
+    RunState[RunState["INTERRUPTED"] = 130] = "INTERRUPTED";
+})(RunState || (RunState = {}));
+/**
+ * Possible reasons for an invalid argument.
+ */
+export var InvalidArgumentReason;
+(function (InvalidArgumentReason) {
+    /**
+     * The argument value was not specified.
+     */
+    InvalidArgumentReason[InvalidArgumentReason["MISSING_VALUE"] = 0] = "MISSING_VALUE";
+    /**
+     * The value specified was not the correct type for the argument.
+     */
+    InvalidArgumentReason[InvalidArgumentReason["INCORRECT_VALUE_TYPE"] = 1] = "INCORRECT_VALUE_TYPE";
+    /**
+     * The argument does not support multiple values.
+     */
+    InvalidArgumentReason[InvalidArgumentReason["ILLEGAL_MULTIPLE_VALUES"] = 2] = "ILLEGAL_MULTIPLE_VALUES";
+    /**
+     * The value specified was not one of the defined allowable values for the argument.
+     */
+    InvalidArgumentReason[InvalidArgumentReason["ILLEGAL_VALUE"] = 3] = "ILLEGAL_VALUE";
+    /**
+     * The arguments specified resulted in a sparse array of values.
+     */
+    InvalidArgumentReason[InvalidArgumentReason["ILLEGAL_SPARSE_ARRAY"] = 4] = "ILLEGAL_SPARSE_ARRAY";
+    /**
+     * The argument specified an unknown complex option property.
+     */
+    InvalidArgumentReason[InvalidArgumentReason["UNKNOWN_PROPERTY"] = 5] = "UNKNOWN_PROPERTY";
+    /**
+     * Complex option nesting exceeds maximum of {@link MAXIMUM_COMPLEX_OPTION_NESTING_DEPTH}.
+     */
+    InvalidArgumentReason[InvalidArgumentReason["NESTING_DEPTH_EXCEEDED"] = 6] = "NESTING_DEPTH_EXCEEDED";
+    /**
+     * Array value nesting exceeds maximum of {@link MAXIMUM_ARGUMENT_ARRAY_SIZE}.
+     */
+    InvalidArgumentReason[InvalidArgumentReason["ARRAY_SIZE_EXCEEDED"] = 7] = "ARRAY_SIZE_EXCEEDED";
+    /**
+     * Attempt to set a primitive value on a complex object object.
+     */
+    InvalidArgumentReason[InvalidArgumentReason["OPTION_IS_COMPLEX"] = 8] = "OPTION_IS_COMPLEX";
+    /**
+     * The value failed a custom validation function defined on the argument.
+     */
+    InvalidArgumentReason[InvalidArgumentReason["CUSTOM_VALIDATION"] = 9] = "CUSTOM_VALIDATION";
+})(InvalidArgumentReason || (InvalidArgumentReason = {}));

package/dist/src/api/argument/ArgumentValueTypes.js

@@ -0,0 +1,18 @@
+/**
+ * Enum of possible {@link Argument} value types.
+ */
+export var ArgumentValueTypeName;
+(function (ArgumentValueTypeName) {
+    ArgumentValueTypeName[ArgumentValueTypeName["STRING"] = 0] = "STRING";
+    ArgumentValueTypeName[ArgumentValueTypeName["NUMBER"] = 1] = "NUMBER";
+    ArgumentValueTypeName[ArgumentValueTypeName["INTEGER"] = 2] = "INTEGER";
+    ArgumentValueTypeName[ArgumentValueTypeName["BOOLEAN"] = 3] = "BOOLEAN";
+    ArgumentValueTypeName[ArgumentValueTypeName["SECRET"] = 4] = "SECRET";
+})(ArgumentValueTypeName || (ArgumentValueTypeName = {}));
+/**
+ * Only possible value for {@link ComplexOption.type}.
+ */
+export var ComplexValueTypeName;
+(function (ComplexValueTypeName) {
+    ComplexValueTypeName[ComplexValueTypeName["COMPLEX"] = 5] = "COMPLEX";
+})(ComplexValueTypeName || (ComplexValueTypeName = {}));

package/dist/src/api/argument/ComplexOption.js

@@ -0,0 +1 @@
+export const MAXIMUM_COMPLEX_OPTION_NESTING_DEPTH = 10;

package/dist/src/api/argument/SubCommandArgument.js

@@ -0,0 +1 @@
+export const MAXIMUM_ARGUMENT_ARRAY_SIZE = 255;

package/dist/src/api/plugin/CLIPlugin.js

@@ -0,0 +1,2 @@
+import { DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY_EXTENSION_POINT } from "./CommandFactory.js";
+import { DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY_EXTENSION_POINT } from "./ServiceProviderFactory.js";

package/dist/src/api/plugin/CommandFactory.js

@@ -0,0 +1,7 @@
+/**
+ * Extension point identifier for {@link CommandFactory} extensions.
+ *
+ * Plugins register against this extension point to supply {@link Command} instances
+ * that are added to the CLI before execution begins.
+ */
+export const DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY_EXTENSION_POINT = "DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY";

package/dist/src/api/plugin/ServiceProviderFactory.js

@@ -0,0 +1,7 @@
+/**
+ * Extension point identifier for {@link ServiceProviderFactory} extensions.
+ *
+ * Plugins register against this extension point to supply {@link ServiceProvider} instances
+ * that are initialised by the runner as part of the normal service lifecycle.
+ */
+export const DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY_EXTENSION_POINT = "DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY";

package/dist/src/api/plugin/createCLIPlugin.js

@@ -0,0 +1,30 @@
+import { DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY_EXTENSION_POINT } from "./CommandFactory.js";
+import { DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY_EXTENSION_POINT } from "./ServiceProviderFactory.js";
+/**
+ * Build a {@link CLIPlugin} from optional {@link CommandFactory} and {@link ServiceProviderFactory}
+ * instances (or factory functions), without needing to hand-construct extension descriptors.
+ */
+export default function createCLIPlugin(options) {
+    const extensionDescriptors = [];
+    if (options.commandFactory) {
+        const commandFactory = options.commandFactory;
+        extensionDescriptors.push({
+            extensionPoint: DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY_EXTENSION_POINT,
+            factory: {
+                create: async () => typeof commandFactory === "function" ? commandFactory() : commandFactory,
+            },
+        });
+    }
+    if (options.serviceProviderFactory) {
+        const serviceProviderFactory = options.serviceProviderFactory;
+        extensionDescriptors.push({
+            extensionPoint: DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY_EXTENSION_POINT,
+            factory: {
+                create: async () => typeof serviceProviderFactory === "function"
+                    ? serviceProviderFactory()
+                    : serviceProviderFactory,
+            },
+        });
+    }
+    return { extensionDescriptors, pluginData: options.pluginData };
+}

package/dist/src/api/service/core/ArgumentPrompterService.js

@@ -0,0 +1 @@
+export const ARGUMENT_PROMPTER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/argument-prompter-service";

package/dist/src/api/service/core/AsciiBannerGeneratorService.js

@@ -0,0 +1 @@
+export const ASCII_BANNER_GENERATOR_SERVICE_ID = "@flowscripter/dynamic-cli-framework/ascii-banner-generator-service";

package/dist/src/api/service/core/CompletionService.js

@@ -0,0 +1,8 @@
+export const COMPLETION_SERVICE_ID = "@flowscripter/dynamic-cli-framework/completion-service";
+export var ShellType;
+(function (ShellType) {
+    ShellType["BASH"] = "bash";
+    ShellType["ZSH"] = "zsh";
+    ShellType["FISH"] = "fish";
+    ShellType["POWERSHELL"] = "powershell";
+})(ShellType || (ShellType = {}));

package/dist/src/api/service/core/DataDumpGeneratorService.js

@@ -0,0 +1,7 @@
+import { Buffer } from "node:buffer";
+export const DATA_DUMP_GENERATOR_SERVICE_ID = "@flowscripter/dynamic-cli-framework/data-dump-generator-service";
+export var DumpFormat;
+(function (DumpFormat) {
+    DumpFormat["HEX"] = "HEX";
+    DumpFormat["ASCII"] = "ASCII";
+})(DumpFormat || (DumpFormat = {}));

package/dist/src/api/service/core/ImagePrinterService.js

@@ -0,0 +1 @@
+export const IMAGE_PRINTER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/image-printer-service";

package/dist/src/api/service/core/KeyValueService.js

@@ -0,0 +1,7 @@
+export const KEY_VALUE_SERVICE_ID = "@flowscripter/dynamic-cli-framework/key-value-service";
+/**
+ * The sentinel prefix used to indicate a value is stored as an OS-native secret.
+ * Values starting with this prefix are resolved via the {@link SecretService}.
+ * This prefix is reserved and must not be used for regular key-value data.
+ */
+export const SECRET_SENTINEL_PREFIX = "__SECRET__:";

package/dist/src/api/service/core/PluginService.js

@@ -0,0 +1,6 @@
+/**
+ * Service ID for {@link PluginService}.
+ *
+ * Pass to {@link Context.getServiceById} to retrieve the active {@link PluginService} instance.
+ */
+export const PLUGIN_SERVICE_ID = "PLUGIN_SERVICE";

package/dist/src/api/service/core/PrettyPrinterService.js

@@ -0,0 +1 @@
+export const PRETTY_PRINTER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/pretty-printer-service";

package/dist/src/api/service/core/PrinterService.js

@@ -0,0 +1,42 @@
+export const PRINTER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/printer-service";
+import { WritableStream } from "node:stream/web";
+/**
+ * Enum of message importance level.
+ */
+export var Level;
+(function (Level) {
+    Level[Level["DEBUG"] = 0] = "DEBUG";
+    Level[Level["INFO"] = 1] = "INFO";
+    Level[Level["WARN"] = 2] = "WARN";
+    Level[Level["ERROR"] = 3] = "ERROR";
+})(Level || (Level = {}));
+/**
+ * Enum of spinner animation styles.
+ */
+export var SpinnerStyle;
+(function (SpinnerStyle) {
+    SpinnerStyle["BOX"] = "BOX";
+    SpinnerStyle["STAR"] = "STAR";
+})(SpinnerStyle || (SpinnerStyle = {}));
+/**
+ * Enum of progress bar rendering styles.
+ */
+export var ProgressStyle;
+(function (ProgressStyle) {
+    ProgressStyle["STROKE"] = "STROKE";
+    ProgressStyle["FILL"] = "FILL";
+})(ProgressStyle || (ProgressStyle = {}));
+/**
+ * Enum of message icons.
+ */
+export var Icon;
+(function (Icon) {
+    // Will be displayed in green if {@link Printer.colorEnabled} is `true`.
+    Icon[Icon["SUCCESS"] = 0] = "SUCCESS";
+    // Will be displayed in red if {@link Printer.colorEnabled} is `true`.
+    Icon[Icon["FAILURE"] = 1] = "FAILURE";
+    // Will be displayed in yellow if {@link Printer.colorEnabled} is `true`.
+    Icon[Icon["ALERT"] = 2] = "ALERT";
+    // Will be displayed in blue if {@link Printer.colorEnabled} is `true`.
+    Icon[Icon["INFORMATION"] = 3] = "INFORMATION";
+})(Icon || (Icon = {}));

package/dist/src/api/service/core/PrompterService.js

@@ -0,0 +1,10 @@
+export const PROMPTER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/prompter-service";
+export var PromptType;
+(function (PromptType) {
+    PromptType[PromptType["SINGLE_SELECT"] = 0] = "SINGLE_SELECT";
+    PromptType[PromptType["MULTI_SELECT"] = 1] = "MULTI_SELECT";
+    PromptType[PromptType["ACKNOWLEDGE"] = 2] = "ACKNOWLEDGE";
+    PromptType[PromptType["TOGGLE"] = 3] = "TOGGLE";
+    PromptType[PromptType["TEXT"] = 4] = "TEXT";
+    PromptType[PromptType["OPEN_URL"] = 5] = "OPEN_URL";
+})(PromptType || (PromptType = {}));

package/dist/src/api/service/core/ShutdownService.js

@@ -0,0 +1 @@
+export const SHUTDOWN_SERVICE_ID = "@flowscripter/dynamic-cli-framework/shutdown-service";

package/dist/src/api/service/core/SyntaxHighlighterService.js

@@ -0,0 +1 @@
+export const SYNTAX_HIGHLIGHTER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/syntax-highlighter-service";

package/dist/src/api/service/core/Table.js

@@ -0,0 +1,49 @@
+export default class Table {
+    rowCount;
+    columnCount;
+    options;
+    #columnOptions = new Map();
+    #rowOptions = new Map();
+    #cells = new Map();
+    constructor(rowCount, columnCount, options) {
+        this.rowCount = rowCount;
+        this.columnCount = columnCount;
+        this.options = options ?? {};
+    }
+    row(rowIndex, rowOptions) {
+        if (rowIndex < 0 || rowIndex >= this.rowCount) {
+            throw new Error(`Row index ${rowIndex} out of bounds [0, ${this.rowCount})`);
+        }
+        this.#rowOptions.set(rowIndex, rowOptions);
+        return this;
+    }
+    column(columnIndex, columnOptions) {
+        if (columnIndex < 0 || columnIndex >= this.columnCount) {
+            throw new Error(`Column index ${columnIndex} out of bounds [0, ${this.columnCount})`);
+        }
+        this.#columnOptions.set(columnIndex, columnOptions);
+        return this;
+    }
+    cell(rowIndex, columnIndex, contents, cellOptions) {
+        if (rowIndex < 0 || rowIndex >= this.rowCount) {
+            throw new Error(`Row index ${rowIndex} out of bounds [0, ${this.rowCount})`);
+        }
+        if (columnIndex < 0 || columnIndex >= this.columnCount) {
+            throw new Error(`Column index ${columnIndex} out of bounds [0, ${this.columnCount})`);
+        }
+        this.#cells.set(`${rowIndex},${columnIndex}`, {
+            contents,
+            options: cellOptions,
+        });
+        return this;
+    }
+    getColumnOptions(columnIndex) {
+        return this.#columnOptions.get(columnIndex);
+    }
+    getRowOptions(rowIndex) {
+        return this.#rowOptions.get(rowIndex);
+    }
+    getCell(rowIndex, columnIndex) {
+        return this.#cells.get(`${rowIndex},${columnIndex}`);
+    }
+}

package/dist/src/api/service/core/TableGeneratorService.d.ts

@@ -25,6 +25,7 @@ export interface CellOptions {
     align?: Align;
 }
 export default interface TableGeneratorService {
+    createTable(rowCount: number, columnCount: number, options?: TableOptions): Table;
     render(table: Table): string;
 }
 import type Table from "./Table.ts";

package/dist/src/api/service/core/TableGeneratorService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TableGeneratorService.d.ts","sourceRoot":"","sources":["../../../../../src/api/service/core/TableGeneratorService.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,0BAA0B,gEACwB,CAAC;AAEhE,oBAAY,KAAK;IACf,IAAI,IAAI;IACR,MAAM,IAAI;IACV,KAAK,IAAI;CACV;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,qBAAqB;IAC5C,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC;CAC9B;AAED,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC"}
+{"version":3,"file":"TableGeneratorService.d.ts","sourceRoot":"","sources":["../../../../../src/api/service/core/TableGeneratorService.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,0BAA0B,gEACwB,CAAC;AAEhE,oBAAY,KAAK;IACf,IAAI,IAAI;IACR,MAAM,IAAI;IACV,KAAK,IAAI;CACV;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,qBAAqB;IAC5C,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,KAAK,CAAC;IAClF,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC;CAC9B;AAED,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC"}

package/dist/src/api/service/core/TableGeneratorService.js

@@ -0,0 +1,7 @@
+export const TABLE_GENERATOR_SERVICE_ID = "@flowscripter/dynamic-cli-framework/table-generator-service";
+export var Align;
+(function (Align) {
+    Align[Align["LEFT"] = 0] = "LEFT";
+    Align[Align["CENTER"] = 1] = "CENTER";
+    Align[Align["RIGHT"] = 2] = "RIGHT";
+})(Align || (Align = {}));

package/dist/src/api/service/core/TreePrinterService.js

@@ -0,0 +1 @@
+export const TREE_PRINTER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/tree-printer-service";

package/dist/src/cli/BaseCLI.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseCLI.d.ts","sourceRoot":"","sources":["../../../src/cli/BaseCLI.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,eAAe,CAAC;AACrC,OAAO,KAAK,SAAS,MAAM,qBAAqB,CAAC;AAIjD,OAAO,KAAK,OAAO,MAAM,2BAA2B,CAAC;AAGrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,KAAK,SAAS,MAAM,qBAAqB,CAAC;AA4BjD,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AAGpD,OAAO,KAAK,MAAM,MAAM,uBAAuB,CAAC;AAChD,OAAO,KAAK,SAAS,MAAM,0BAA0B,CAAC;AACtD,OAAO,KAAK,qBAAqB,MAAM,iCAAiC,CAAC;AAiBzE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,OAAO,OAAQ,YAAW,GAAG;;gBAavC,SAAS,EAAE,SAAS,EACpB,oBAAoB,EAAE,cAAc,EACpC,oBAAoB,EAAE,cAAc,EACpC,aAAa,EAAE,OAAO,EACtB,aAAa,EAAE,OAAO,EACtB,cAAc,EAAE,QAAQ,EACxB,cAAc,EAAE,QAAQ,EACxB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE,qBAAqB;IA2DjC;;;;;;;OAOG;IACI,kBAAkB,CAAC,eAAe,EAAE,eAAe;IAI1D;;;;;;;;OAQG;IACI,UAAU,CAAC,OAAO,EAAE,OAAO;IAU5B,GAAG,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;CAiK3D"}
+{"version":3,"file":"BaseCLI.d.ts","sourceRoot":"","sources":["../../../src/cli/BaseCLI.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,eAAe,CAAC;AACrC,OAAO,KAAK,SAAS,MAAM,qBAAqB,CAAC;AAIjD,OAAO,KAAK,OAAO,MAAM,2BAA2B,CAAC;AAGrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,KAAK,SAAS,MAAM,qBAAqB,CAAC;AA4BjD,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AAGpD,OAAO,KAAK,MAAM,MAAM,uBAAuB,CAAC;AAChD,OAAO,KAAK,SAAS,MAAM,0BAA0B,CAAC;AACtD,OAAO,KAAK,qBAAqB,MAAM,iCAAiC,CAAC;AAYzE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,OAAO,OAAQ,YAAW,GAAG;;gBAavC,SAAS,EAAE,SAAS,EACpB,oBAAoB,EAAE,cAAc,EACpC,oBAAoB,EAAE,cAAc,EACpC,aAAa,EAAE,OAAO,EACtB,aAAa,EAAE,OAAO,EACtB,cAAc,EAAE,QAAQ,EACxB,cAAc,EAAE,QAAQ,EACxB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE,qBAAqB;IA2DjC;;;;;;;OAOG;IACI,kBAAkB,CAAC,eAAe,EAAE,eAAe;IAI1D;;;;;;;;OAQG;IACI,UAAU,CAAC,OAAO,EAAE,OAAO;IAU5B,GAAG,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;CAwJ3D"}

package/dist/src/cli/BaseCLI.js

@@ -0,0 +1,233 @@
+import { RunState } from "../api/RunResult.js";
+import getLogger from "../util/logger.js";
+import DefaultCommandRegistry from "../runtime/registry/DefaultCommandRegistry.js";
+import DefaultServiceProviderRegistry from "../runtime/registry/DefaultServiceProviderRegistry.js";
+import DefaultContext from "../runtime/DefaultContext.js";
+import { SingleCommandCliHelpGlobalCommand, SingleCommandCliHelpSubCommand, } from "../command/SingleCommandCliHelpCommand.js";
+import { MultiCommandCliHelpGlobalCommand, MultiCommandCliHelpSubCommand, } from "../command/MultiCommandCliHelpCommand.js";
+import VersionCommand from "../command/VersionCommand.js";
+import UsageCommand from "../command/UsageCommand.js";
+import { isGlobalCommand, isGlobalModifierCommand, isGroupCommand, isSubCommand, } from "../runtime/command/CommandTypeGuards.js";
+import CommandValidator from "../runtime/command/CommandValidator.js";
+import ShutdownServiceProvider from "../service/shutdown/ShutdownServiceProvider.js";
+import { shutdownState } from "../service/shutdown/ShutdownState.js";
+import ConfigurationServiceProvider from "../service/configuration/ConfigurationServiceProvider.js";
+import PrinterServiceProvider from "../service/printer/PrinterServiceProvider.js";
+import TableGeneratorServiceProvider from "../service/tableGenerator/TableGeneratorServiceProvider.js";
+import { run } from "../runtime/runner.js";
+import { printRuntimeError } from "../util/runnerHelper.js";
+import { WritableStream } from "node:stream/web";
+import DefaultPrinterService from "../service/printer/DefaultPrinterService.js";
+import DefaultPrompterService, { DEFAULT_PROMPTER_CONFIG, } from "../service/prompter/DefaultPrompterService.js";
+import PrompterServiceProvider from "../service/prompter/PrompterServiceProvider.js";
+import DefaultArgumentPrompterService from "../service/argumentPrompter/DefaultArgumentPrompterService.js";
+import ArgumentPrompterServiceProvider from "../service/argumentPrompter/ArgumentPrompterServiceProvider.js";
+import DefaultCompletionService from "../service/completion/DefaultCompletionService.js";
+import CompletionServiceProvider from "../service/completion/CompletionServiceProvider.js";
+import ImagePrinterServiceProvider from "../service/imagePrinter/ImagePrinterServiceProvider.js";
+const logger = getLogger("BaseCLI");
+/**
+ * Base implementation of a {@link CLI}.
+ *
+ * By default the following service providers are added:
+ *
+ * * {@link ShutdownServiceProvider}
+ * * {@link PrinterServiceProvider}
+ * * {@link ConfigurationServiceProvider}
+ * * {@link TableGeneratorServiceProvider}
+ *
+ * NOTE: The `ConfigurationServiceProvider` will not be added if the required `allow-read` and `allow-write`
+ * permissions are not granted. It can also be excluded if desired via a constructor argument.
+ *
+ * Optionally enabled via {@link BaseCLIFeatureOptions}:
+ *
+ * * {@link ImagePrinterServiceProvider}
+ *
+ * By default the following commands are added:
+ *
+ * * {@link SingleCommandCliHelpSubCommand} or {@link MultiCommandCliHelpSubCommand}
+ * * {@link SingleCommandCliHelpGlobalCommand} or {@link MultiCommandCliHelpGlobalCommand}
+ * * commands provided by the {@link ConfigurationServiceProvider}.
+ * * commands provided by the {@link PrinterServiceProvider}.
+ */
+export default class BaseCLI {
+    #cliConfig;
+    #options;
+    #keyReader;
+    #stderrTerminal;
+    #addedNonModifierCommands;
+    #serviceProviderRegistry;
+    #commandRegistry;
+    #context;
+    #printerService;
+    #stdoutTerminal;
+    constructor(cliConfig, stdoutWritableStream, stderrWritableStream, stdoutIsColor, stderrIsColor, stdoutTerminal, stderrTerminal, styler, keyReader, options) {
+        if (cliConfig.name.length === 0) {
+            throw new Error("Invalid empty CLI name provided");
+        }
+        if (cliConfig.name[0].match(/[0-9\-_]/)) {
+            throw new Error(`Invalid CLI name starting with a digit or dash provided: '${cliConfig.name}'`);
+        }
+        if (cliConfig.description !== undefined && cliConfig.description.length === 0) {
+            throw new Error("Invalid empty CLI description provided");
+        }
+        if (cliConfig.version !== undefined && cliConfig.version.length === 0) {
+            throw new Error("Invalid empty CLI version provided");
+        }
+        this.#cliConfig = cliConfig;
+        this.#options = {
+            configFileSupportEnabled: false,
+            envVarsSupportEnabled: false,
+            keyValueServiceEnabled: false,
+            secretServiceEnabled: false,
+            argumentPrompterServiceEnabled: false,
+            completionServiceEnabled: false,
+            imagePrinterServiceEnabled: false,
+            validateAllCommands: false,
+            promptingEnabled: true,
+            ...options,
+        };
+        this.#keyReader = keyReader;
+        this.#stderrTerminal = stderrTerminal;
+        this.#addedNonModifierCommands = [];
+        let commandValidator;
+        if (this.#options.validateAllCommands) {
+            commandValidator = new CommandValidator(this.#cliConfig);
+        }
+        // create a service provider registry
+        this.#serviceProviderRegistry = new DefaultServiceProviderRegistry();
+        // create a command registry
+        this.#commandRegistry = new DefaultCommandRegistry([], commandValidator);
+        // create a context
+        this.#context = new DefaultContext(this.#cliConfig);
+        this.#stdoutTerminal = stdoutTerminal;
+        this.#printerService = new DefaultPrinterService(stdoutWritableStream, stderrWritableStream, stdoutIsColor, stderrIsColor, stdoutTerminal, stderrTerminal, styler);
+    }
+    /**
+     * Add a {@link ServiceProvider} to the CLI's {@link ServiceProviderRegistry}.
+     *
+     * This will register the {@link ServiceProvider}, add any provided services to the {@link Context} and register
+     * any provided {@link Command} instances.
+     *
+     * @param serviceProvider the {@link ServiceProvider} to add.
+     */
+    addServiceProvider(serviceProvider) {
+        this.#serviceProviderRegistry.addServiceProvider(serviceProvider);
+    }
+    /**
+     * Add a {@link Command} to the CLI's {@link CommandRegistry}.
+     *
+     * If only one non-modifier {@link Command} is added, the CLI will operate as a single command CLI and the provided
+     * command will be set as a default command. If more than one command is added, the CLI will operate as a
+     * multi-command CLI. In this case the default command will be set to a help command.
+     *
+     * @param command the {@link Command} to add.
+     */
+    addCommand(command) {
+        if (!isGlobalModifierCommand(command)) {
+            // store the command locally to help determine if this CLI will be a single or multi-command CLI
+            this.#addedNonModifierCommands.push(command);
+        }
+        // register the command
+        this.#commandRegistry.addCommand(command);
+    }
+    async run(args) {
+        if (this.#addedNonModifierCommands.length === 0) {
+            throw new Error("No non-modifier commands added to the CLI, nothing to run!");
+        }
+        if (this.#addedNonModifierCommands.length === 1 &&
+            !isSubCommand(this.#addedNonModifierCommands[0]) &&
+            !isGlobalCommand(this.#addedNonModifierCommands[0]) &&
+            !isGroupCommand(this.#addedNonModifierCommands[0])) {
+            throw new Error("If only one command is added, it must be a global command, sub-command, or group command!");
+        }
+        // create and add core services
+        this.addServiceProvider(new ShutdownServiceProvider(100));
+        this.addServiceProvider(new PrinterServiceProvider(80, this.#printerService));
+        this.addServiceProvider(new TableGeneratorServiceProvider(70));
+        const prompterService = new DefaultPrompterService(DEFAULT_PROMPTER_CONFIG, this.#stderrTerminal, this.#keyReader, this.#printerService);
+        prompterService.promptEnabled = this.#options.promptingEnabled;
+        this.addServiceProvider(new PrompterServiceProvider(75, prompterService));
+        if (this.#options.argumentPrompterServiceEnabled) {
+            const argumentPrompterService = new DefaultArgumentPrompterService(prompterService);
+            this.addServiceProvider(new ArgumentPrompterServiceProvider(65, argumentPrompterService));
+        }
+        if (this.#options.imagePrinterServiceEnabled) {
+            this.addServiceProvider(new ImagePrinterServiceProvider(55, this.#stdoutTerminal));
+        }
+        if (this.#options.completionServiceEnabled) {
+            const completionService = new DefaultCompletionService();
+            this.addServiceProvider(new CompletionServiceProvider(5, completionService, this.#commandRegistry));
+        }
+        const configurationServiceProvider = new ConfigurationServiceProvider(90, this.#options.envVarsSupportEnabled, this.#options.configFileSupportEnabled, this.#options.keyValueServiceEnabled, this.#options.secretServiceEnabled);
+        this.addServiceProvider(configurationServiceProvider);
+        for (const serviceProvider of this.#serviceProviderRegistry.getServiceProviders()) {
+            const serviceInfo = await serviceProvider.getServiceInfo(this.#cliConfig);
+            if (serviceInfo.service) {
+                this.#context.addServiceInstance(serviceProvider.serviceId, serviceInfo.service);
+            }
+            serviceInfo.commands.forEach((command) => {
+                this.#commandRegistry.addCommand(command, serviceProvider.serviceId);
+            });
+        }
+        logger.debug(() => `Running with args: ${args.join(" ")}`);
+        let helpSubCommand;
+        let helpGlobalCommand;
+        let defaultCommand;
+        try {
+            // setup help commands and default command based on the number of commands explicitly added via {@link addCommand)
+            if (this.#addedNonModifierCommands.length === 1 &&
+                !isGroupCommand(this.#addedNonModifierCommands[0])) {
+                // a single-command CLI
+                defaultCommand = this.#addedNonModifierCommands[0];
+                helpSubCommand = new SingleCommandCliHelpSubCommand(this.#options.envVarsSupportEnabled, defaultCommand, this.#commandRegistry);
+                helpGlobalCommand = new SingleCommandCliHelpGlobalCommand(this.#options.envVarsSupportEnabled, defaultCommand, this.#commandRegistry);
+            }
+            else {
+                // a multi-command CLI
+                helpSubCommand = new MultiCommandCliHelpSubCommand(this.#options.envVarsSupportEnabled, this.#commandRegistry);
+                helpGlobalCommand = new MultiCommandCliHelpGlobalCommand(this.#options.envVarsSupportEnabled, this.#commandRegistry);
+            }
+            // register the help commands
+            this.#commandRegistry.addCommand(helpSubCommand);
+            this.#commandRegistry.addCommand(helpGlobalCommand);
+            // register the version command
+            this.#commandRegistry.addCommand(new VersionCommand());
+            // run...
+            const runResult = await run(args, this.#commandRegistry, this.#serviceProviderRegistry, configurationServiceProvider, this.#context, defaultCommand);
+            // then handle the result...
+            if (runResult.runState === RunState.NO_COMMAND) {
+                // print usage
+                await new UsageCommand(helpGlobalCommand).execute(this.#context);
+            }
+            else if (runResult.runState === RunState.PARSE_ERROR) {
+                if (runResult.command !== undefined &&
+                    (isSubCommand(runResult.command) || isGlobalCommand(runResult.command))) {
+                    // print help on specific command
+                    await helpSubCommand.execute(this.#context, {
+                        command: runResult.command.name,
+                    });
+                }
+                else {
+                    // print usage
+                    await new UsageCommand(helpGlobalCommand).execute(this.#context);
+                }
+            }
+            return runResult;
+        }
+        catch (error) {
+            if (shutdownState.shutdownRequested || error.message === "Interrupted") {
+                return { runState: RunState.INTERRUPTED };
+            }
+            logger.error("Runtime error: %s", error.message);
+            await printRuntimeError(this.#context, error);
+            return {
+                runState: RunState.RUNTIME_ERROR,
+                error: error,
+            };
+        }
+        finally {
+            await ShutdownServiceProvider.shutdown();
+        }
+    }
+}