@flowscripter/dynamic-cli-framework 1.4.18 → 1.5.0

package/dist/src/api/BaseCLIFeatureOptions.d.ts

@@ -0,0 +1,12 @@
+export default interface BaseCLIFeatureOptions {
+    readonly configFileSupportEnabled?: boolean;
+    readonly envVarsSupportEnabled?: boolean;
+    readonly keyValueServiceEnabled?: boolean;
+    readonly secretServiceEnabled?: boolean;
+    readonly argumentPrompterServiceEnabled?: boolean;
+    readonly completionServiceEnabled?: boolean;
+    readonly imagePrinterServiceEnabled?: boolean;
+    readonly validateAllCommands?: boolean;
+    readonly promptingEnabled?: boolean;
+}
+//# sourceMappingURL=BaseCLIFeatureOptions.d.ts.map

package/dist/src/api/BaseCLIFeatureOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseCLIFeatureOptions.d.ts","sourceRoot":"","sources":["../../../src/api/BaseCLIFeatureOptions.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,WAAW,qBAAqB;IAC5C,QAAQ,CAAC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAC5C,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IACzC,QAAQ,CAAC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAC1C,QAAQ,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IACxC,QAAQ,CAAC,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAClD,QAAQ,CAAC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAC5C,QAAQ,CAAC,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAC9C,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IACvC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CACrC"}

package/dist/src/api/CLI.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Interface to be implemented by a CLI application.
+ */
+import type RunResult from "./RunResult.ts";
+import type CLIConfig from "./CLIConfig.ts";
+export default interface CLI {
+    /**
+     * Run the CLI with the provided arguments which do not include the invoked executable name.
+     *
+     * @param args the arguments to parse.
+     * @param cliConfig the {@link CLIConfig} for the CLI application.
+     *
+     * @return result of parsing arguments and running appropriate {@link Command} instances.
+     */
+    run(args: ReadonlyArray<string>, cliConfig: CLIConfig): Promise<RunResult>;
+}
+//# sourceMappingURL=CLI.d.ts.map

package/dist/src/api/CLI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CLI.d.ts","sourceRoot":"","sources":["../../../src/api/CLI.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAE5C,MAAM,CAAC,OAAO,WAAW,GAAG;IAC1B;;;;;;;OAOG;IACH,GAAG,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CAC5E"}

package/dist/src/api/CLIConfig.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Interface specifying common configuration for a {@link CLI} application.
+ */
+export default interface CLIConfig {
+    /**
+     * Name of the CLI application.
+     */
+    readonly name: string;
+    /**
+     * Optional description of the CLI application.
+     */
+    readonly description?: string;
+    /**
+     * Optional sub-message to display below the banner.
+     */
+    readonly subMessage?: string;
+    /**
+     * Version of the CLI application.
+     */
+    readonly version: string;
+}
+//# sourceMappingURL=CLIConfig.d.ts.map

package/dist/src/api/CLIConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CLIConfig.d.ts","sourceRoot":"","sources":["../../../src/api/CLIConfig.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,SAAS;IAChC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B"}

package/dist/src/api/Context.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Interface allowing a {@link CLI} to pass context to a {@link Command} instance.
+ */
+import type CLIConfig from "./CLIConfig.ts";
+export default interface Context {
+    /**
+     * The {@link CLIConfig} in use by the {@link CLI}.
+     */
+    readonly cliConfig: CLIConfig;
+    /**
+     * Return the service identified by the specified ID.
+     *
+     * @param id the ID of the service to retrieve.
+     */
+    getServiceById(id: string): unknown;
+    /**
+     * Check if the specified service exists in the context.
+     *
+     * @param id the ID of the desired service.
+     */
+    doesServiceExist(id: string): boolean;
+}
+//# sourceMappingURL=Context.d.ts.map

package/dist/src/api/Context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Context.d.ts","sourceRoot":"","sources":["../../../src/api/Context.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAE5C,MAAM,CAAC,OAAO,WAAW,OAAO;IAC9B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B;;;;OAIG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;IAEpC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;CACvC"}

package/dist/src/api/RunResult.d.ts

@@ -0,0 +1,128 @@
+/**
+ * State of a {@link CLI} after invocation.
+ */
+import type Command from "./command/Command.ts";
+import type Argument from "./argument/Argument.ts";
+import type ComplexOption from "./argument/ComplexOption.ts";
+import type { PopulatedArgumentValues, PopulatedArgumentValueType } from "./argument/ArgumentValueTypes.ts";
+export declare enum RunState {
+    /**
+     * Arguments were successfully parsed and the specified command(s) were successfully executed.
+     */
+    SUCCESS = 0,
+    /**
+     * The arguments supplied were invalid or could not be parsed.
+     */
+    PARSE_ERROR = 1,
+    /**
+     * Arguments were successfully parsed but no command was discovered.
+     */
+    NO_COMMAND = 2,
+    /**
+     * Arguments were successfully parsed and command(s) discovered but command execution failed.
+     */
+    EXECUTION_ERROR = 3,
+    /**
+     * General runtime error related to the framework.
+     */
+    RUNTIME_ERROR = 4,
+    /**
+     * Execution was interrupted by a signal (e.g. Ctrl-C or SIGTERM).
+     */
+    INTERRUPTED = 130
+}
+/**
+ * Possible reasons for an invalid argument.
+ */
+export declare enum InvalidArgumentReason {
+    /**
+     * The argument value was not specified.
+     */
+    MISSING_VALUE = 0,
+    /**
+     * The value specified was not the correct type for the argument.
+     */
+    INCORRECT_VALUE_TYPE = 1,
+    /**
+     * The argument does not support multiple values.
+     */
+    ILLEGAL_MULTIPLE_VALUES = 2,
+    /**
+     * The value specified was not one of the defined allowable values for the argument.
+     */
+    ILLEGAL_VALUE = 3,
+    /**
+     * The arguments specified resulted in a sparse array of values.
+     */
+    ILLEGAL_SPARSE_ARRAY = 4,
+    /**
+     * The argument specified an unknown complex option property.
+     */
+    UNKNOWN_PROPERTY = 5,
+    /**
+     * Complex option nesting exceeds maximum of {@link MAXIMUM_COMPLEX_OPTION_NESTING_DEPTH}.
+     */
+    NESTING_DEPTH_EXCEEDED = 6,
+    /**
+     * Array value nesting exceeds maximum of {@link MAXIMUM_ARGUMENT_ARRAY_SIZE}.
+     */
+    ARRAY_SIZE_EXCEEDED = 7,
+    /**
+     * Attempt to set a primitive value on a complex object object.
+     */
+    OPTION_IS_COMPLEX = 8,
+    /**
+     * The value failed a custom validation function defined on the argument.
+     */
+    CUSTOM_VALIDATION = 9
+}
+/**
+ * Details of an invalid parsed argument.
+ */
+export interface InvalidArgument {
+    /**
+     * A reason for the parsing error
+     */
+    readonly reason: InvalidArgumentReason;
+    /**
+     * The name of the argument specified (if it was able to be populated)
+     */
+    readonly name?: string;
+    /**
+     * The {@link Argument} (if it was able to be populated)
+     */
+    readonly argument?: Argument | ComplexOption;
+    /**
+     * The argument value (if it was able to be populated).
+     *
+     * NOTE: This value is unlikely to be valid as it is the cause of the invalid argument error.
+     */
+    readonly value?: PopulatedArgumentValues | PopulatedArgumentValueType | Array<PopulatedArgumentValues | PopulatedArgumentValueType>;
+    /**
+     * An optional message providing detail about the validation failure.
+     * Populated when {@link reason} is {@link InvalidArgumentReason.CUSTOM_VALIDATION}.
+     */
+    readonly message?: string;
+}
+/**
+ * Result of a {@link CLI} invocation.
+ */
+export default interface RunResult {
+    /**
+     * The state after processing the invocation.
+     */
+    readonly runState: RunState;
+    /**
+     * Populated if {@link runState} is {@link RunState.SUCCESS}, {@link RunState.PARSE_ERROR} or {@link RunState.EXECUTION_ERROR}.
+     */
+    readonly command?: Command;
+    /**
+     * Populated if {@link runState} is {@link RunState.PARSE_ERROR}
+     */
+    readonly invalidArguments?: ReadonlyArray<InvalidArgument>;
+    /**
+     * Populated if {@link runState} is {@link RunState.EXECUTION_ERROR} or {@link RunState.RUNTIME_ERROR}.
+     */
+    readonly error?: Error;
+}
+//# sourceMappingURL=RunResult.d.ts.map

package/dist/src/api/RunResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RunResult.d.ts","sourceRoot":"","sources":["../../../src/api/RunResult.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,sBAAsB,CAAC;AAChD,OAAO,KAAK,QAAQ,MAAM,wBAAwB,CAAC;AACnD,OAAO,KAAK,aAAa,MAAM,6BAA6B,CAAC;AAC7D,OAAO,KAAK,EACV,uBAAuB,EACvB,0BAA0B,EAC3B,MAAM,kCAAkC,CAAC;AAE1C,oBAAY,QAAQ;IAClB;;OAEG;IACH,OAAO,IAAI;IAEX;;OAEG;IACH,WAAW,IAAI;IAEf;;OAEG;IACH,UAAU,IAAI;IAEd;;OAEG;IACH,eAAe,IAAI;IAEnB;;OAEG;IACH,aAAa,IAAI;IAEjB;;OAEG;IACH,WAAW,MAAM;CAClB;AAED;;GAEG;AACH,oBAAY,qBAAqB;IAC/B;;OAEG;IACH,aAAa,IAAI;IAEjB;;OAEG;IACH,oBAAoB,IAAI;IAExB;;OAEG;IACH,uBAAuB,IAAI;IAE3B;;OAEG;IACH,aAAa,IAAI;IAEjB;;OAEG;IACH,oBAAoB,IAAI;IAExB;;OAEG;IACH,gBAAgB,IAAI;IAEpB;;OAEG;IACH,sBAAsB,IAAI;IAE1B;;OAEG;IACH,mBAAmB,IAAI;IAEvB;;OAEG;IACH,iBAAiB,IAAI;IAErB;;OAEG;IACH,iBAAiB,IAAI;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,aAAa,CAAC;IAE7C;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EACX,uBAAuB,GACvB,0BAA0B,GAC1B,KAAK,CAAC,uBAAuB,GAAG,0BAA0B,CAAC,CAAC;IAEhE;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,SAAS;IAChC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAE3D;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;CACxB"}

package/dist/src/api/argument/Argument.d.ts

@@ -0,0 +1,62 @@
+import type { ArgumentSingleValueType, ArgumentValues, ArgumentValueType, ArgumentValueTypeName } from "./ArgumentValueTypes.ts";
+/**
+ * Interface to be implemented by all {@link Command} arguments.
+ */
+export default interface Argument {
+    /**
+     * Type of the argument value.
+     */
+    readonly type: ArgumentValueTypeName;
+    /**
+     * Optional list of values that the value must match. This is not supported for {@link ArgumentValueTypeName.BOOLEAN}.
+     */
+    readonly allowableValues?: ReadonlyArray<ArgumentSingleValueType>;
+    /**
+     * Optional (default is `false`) for {@link ArgumentValueTypeName.STRING} when comparing a value against {@link allowableValues}.
+     */
+    readonly isCaseInsensitive?: boolean;
+    /**
+     * Optional for {@link ArgumentValueTypeName.INTEGER} or {@link ArgumentValueTypeName.NUMBER} when validating a value.
+     */
+    readonly minValueInclusive?: number;
+    /**
+     * Optional for {@link ArgumentValueTypeName.INTEGER} or {@link ArgumentValueTypeName.NUMBER} when validating a value.
+     */
+    readonly maxValueInclusive?: number;
+    /**
+     * Optional configuration key to use for the argument. Must consist of alphanumeric non-whitespace uppercase
+     * ASCII or `_` characters. Must not start with a digit.
+     *
+     * If not specified a default configuration key is determined as follows: The {@link SubCommandArgument.name} is capitalized
+     * and any `-` characters are replaced with `_` characters. If the result starts with a digit, it is
+     * prefixed with `_`. Some examples:
+     *
+     * * name: `FooBar` => configuration key: `FOOBAR`
+     * * name: `Hello-World-` => configuration key: `HELLO_WORLD_`
+     * * name: `3` => configuration key: `_3`
+     *
+     * NOTE: Regardless of whether a {@link configurationKey} is specified, or the default is relied upon,
+     * it will only be used if the parent {@link Command} has specified {@link Command.enableConfiguration} as `true`.
+     */
+    readonly configurationKey?: string;
+    /**
+     * Optional custom validation function invoked after all built-in validation
+     * has passed. Receives the validated and type-converted value.
+     *
+     * Return `undefined` if the value is valid, or a string describing the
+     * validation error. The error string is associated with
+     * {@link InvalidArgumentReason.CUSTOM_VALIDATION}.
+     *
+     * Example: ensure array values are unique:
+     * ```typescript
+     * validate: (value) => {
+     *   const arr = value as string[];
+     *   return new Set(arr).size !== arr.length
+     *     ? "values must be unique"
+     *     : undefined;
+     * }
+     * ```
+     */
+    readonly validate?: (value: ArgumentValueType | ArgumentValues | Array<ArgumentValues>) => string | undefined;
+}
+//# sourceMappingURL=Argument.d.ts.map

package/dist/src/api/argument/Argument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Argument.d.ts","sourceRoot":"","sources":["../../../../src/api/argument/Argument.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,cAAc,EACd,iBAAiB,EACjB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AAEjC;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,QAAQ;IAC/B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,qBAAqB,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAEpC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAClB,KAAK,EAAE,iBAAiB,GAAG,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC,KAC9D,MAAM,GAAG,SAAS,CAAC;CACzB"}

package/dist/src/api/argument/ArgumentValueTypes.d.ts

@@ -0,0 +1,68 @@
+/**
+ * The type of single {@link Argument} values which are supported.
+ *
+ * NOTE: JavaScript does not have a special runtime value for INTEGER so this is covered by `number`.
+ * NOTE: `string` is also used for PASSWORD values.
+ */
+export type ArgumentSingleValueType = number | string | boolean;
+/**
+ * The type of the value to be parsed as an argument can be: `boolean`, `number` or `string` or an array of these.
+ */
+export type ArgumentValueType = ArgumentSingleValueType | Array<ArgumentSingleValueType>;
+/**
+ * A container object for populated argument values.
+ *
+ * The following are all valid examples:
+ *
+ * * `{ }`
+ * * `{ foo: 1 }`
+ * * `{ foo: true }`
+ * * `{ foo: 'bar' }`
+ * * `{ foo: [ 1, 2 ] }`
+ * * `{ foo: [ true, true ] }`
+ * * `{ foo: [ 'bar', 'gar' ] }`
+ * * `{ foo: { a: 1 } }`
+ * * `{ foo: { a: { b: 'c'} } }`
+ * * `{ foo: [ { a: { b: 'c'} }, { a: { b: 'c'} } ] }`
+ *
+ * An array of arrays is not allowed, so the following is an INVALID example:
+ *
+ * * `{ foo: [ [ 1, 2 ], [3, 4 ] ] }`
+ */
+export type ArgumentValues = {
+    [argName: string]: ArgumentValueType | ArgumentValues | Array<ArgumentValues>;
+};
+/**
+ * Enum of possible {@link Argument} value types.
+ */
+export declare enum ArgumentValueTypeName {
+    STRING = 0,
+    NUMBER = 1,
+    INTEGER = 2,
+    BOOLEAN = 3,
+    SECRET = 4
+}
+/**
+ * Only possible value for {@link ComplexOption.type}.
+ */
+export declare enum ComplexValueTypeName {
+    COMPLEX = 5
+}
+/**
+ * Populated single value type is very similar to {@link ArgumentSingleValueType} but allows for an illegal
+ * undefined value.
+ */
+export type PopulatedArgumentSingleValueType = ArgumentSingleValueType | undefined;
+/**
+ * Populated argument value types are very similar to {@link ArgumentValueType} but allow for illegal
+ * undefined values.
+ */
+export type PopulatedArgumentValueType = PopulatedArgumentSingleValueType | Array<PopulatedArgumentSingleValueType>;
+/**
+ * Populated values are very similar to {@link ArgumentValues} but allow for illegal
+ * undefined properties and array entries.
+ */
+export interface PopulatedArgumentValues {
+    [argName: string]: PopulatedArgumentValueType | PopulatedArgumentValues | Array<PopulatedArgumentValues | undefined> | undefined;
+}
+//# sourceMappingURL=ArgumentValueTypes.d.ts.map

package/dist/src/api/argument/ArgumentValueTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArgumentValueTypes.d.ts","sourceRoot":"","sources":["../../../../src/api/argument/ArgumentValueTypes.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,CAAC,CAAC;AAEzF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,OAAO,EAAE,MAAM,GAAG,iBAAiB,GAAG,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;CAC/E,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB;IAC/B,MAAM,IAAI;IACV,MAAM,IAAI;IACV,OAAO,IAAI;IACX,OAAO,IAAI;IACX,MAAM,IAAI;CACX;AAED;;GAEG;AACH,oBAAY,oBAAoB;IAC9B,OAAO,IAAI;CACZ;AAED;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GAAG,uBAAuB,GAAG,SAAS,CAAC;AAEnF;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAClC,gCAAgC,GAChC,KAAK,CAAC,gCAAgC,CAAC,CAAC;AAE5C;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,CAAC,OAAO,EAAE,MAAM,GACZ,0BAA0B,GAC1B,uBAAuB,GACvB,KAAK,CAAC,uBAAuB,GAAG,SAAS,CAAC,GAC1C,SAAS,CAAC;CACf"}

package/dist/src/api/argument/ComplexOption.d.ts

@@ -0,0 +1,21 @@
+import type Option from "./Option.ts";
+import type { ArgumentValues, ComplexValueTypeName } from "./ArgumentValueTypes.ts";
+export declare const MAXIMUM_COMPLEX_OPTION_NESTING_DEPTH = 10;
+/**
+ * A container option argument for defining {@link SubCommand} nested argument hierarchies.
+ */
+export default interface ComplexOption extends Omit<Option, "type" | "defaultValue" | "allowableValues"> {
+    /**
+     * Type of the argument value.
+     */
+    readonly type: ComplexValueTypeName;
+    /**
+     * List of child {@link Option} properties.
+     */
+    readonly properties: ReadonlyArray<Option | ComplexOption>;
+    /**
+     * Default value for the argument if not specified.
+     */
+    readonly defaultValue?: ArgumentValues | Array<ArgumentValues>;
+}
+//# sourceMappingURL=ComplexOption.d.ts.map

package/dist/src/api/argument/ComplexOption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ComplexOption.d.ts","sourceRoot":"","sources":["../../../../src/api/argument/ComplexOption.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AACtC,OAAO,KAAK,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAEpF,eAAO,MAAM,oCAAoC,KAAK,CAAC;AAEvD;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,aAAc,SAAQ,IAAI,CACjD,MAAM,EACN,MAAM,GAAG,cAAc,GAAG,iBAAiB,CAC5C;IACC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,oBAAoB,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,MAAM,GAAG,aAAa,CAAC,CAAC;IAE3D;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;CAChE"}

package/dist/src/api/argument/GlobalCommandArgument.d.ts

@@ -0,0 +1,16 @@
+import type Argument from "./Argument.ts";
+import type { ArgumentSingleValueType } from "./ArgumentValueTypes.ts";
+/**
+ * Interface to be implemented by a single {@link Argument} defined by a {@link GlobalCommand}.
+ */
+export default interface GlobalCommandArgument extends Argument {
+    /**
+     * Default value for the argument if not specified.
+     */
+    readonly defaultValue?: ArgumentSingleValueType;
+    /**
+     * If this is `true` the argument does not need to be specified nor have a default value. The default is `false`.
+     */
+    readonly isOptional?: boolean;
+}
+//# sourceMappingURL=GlobalCommandArgument.d.ts.map

package/dist/src/api/argument/GlobalCommandArgument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GlobalCommandArgument.d.ts","sourceRoot":"","sources":["../../../../src/api/argument/GlobalCommandArgument.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAEvE;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,qBAAsB,SAAQ,QAAQ;IAC7D;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,uBAAuB,CAAC;IAEhD;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;CAC/B"}

package/dist/src/api/argument/Option.d.ts

@@ -0,0 +1,29 @@
+import type { ArgumentValueType } from "./ArgumentValueTypes.ts";
+import type SubCommandArgument from "./SubCommandArgument.ts";
+/**
+ * Interface for {@link SubCommand} option arguments.
+ */
+export default interface Option extends SubCommandArgument {
+    /**
+     * Optional short alias for the option.
+     *
+     * Must consist of a single alphanumeric non-whitespace ASCII character.
+     */
+    readonly shortAlias?: string;
+    /**
+     * Default value for the argument if not specified.
+     */
+    readonly defaultValue?: ArgumentValueType;
+    /**
+     * If this is `true` the option does not need to be specified nor have a default value.
+     */
+    readonly isOptional?: boolean;
+    /**
+     * If this is `true` the option can be specified multiple times and all values will be returned in an array
+     * matching the order provided.
+     *
+     * NOTE: If {@link isOptional} is `false`, at least one instance of the option must be specified.
+     */
+    readonly isArray?: boolean;
+}
+//# sourceMappingURL=Option.d.ts.map

package/dist/src/api/argument/Option.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Option.d.ts","sourceRoot":"","sources":["../../../../src/api/argument/Option.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,KAAK,kBAAkB,MAAM,yBAAyB,CAAC;AAE9D;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,MAAO,SAAQ,kBAAkB;IACxD;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B"}

package/dist/src/api/argument/Positional.d.ts

@@ -0,0 +1,26 @@
+import type SubCommandArgument from "./SubCommandArgument.ts";
+/**
+ * Interface for {@link SubCommand} positional arguments.
+ */
+export default interface Positional extends SubCommandArgument {
+    /**
+     * If this is `true` the argument can be specified one or multiple times and all values will be returned in
+     * an array matching the order provided.
+     *
+     * NOTE: If {@link isVarargOptional} is `true`, the argument can specified zero, one or multiple times.
+     *
+     * NOTE: There can be only one positional with this set and it must be the last the last item if there
+     * are multiple positionals defined.
+     */
+    readonly isVarargMultiple?: boolean;
+    /**
+     * If this is `true` the argument can be specified zero or once i.e. it does not need to be specified.
+     *
+     * NOTE: If {@link isVarargMultiple} is `true`, the argument can specified zero, one or multiple times.
+     *
+     * NOTE: There can be only one positional with this set and it must be the last the last item if there
+     * are multiple positionals defined.
+     */
+    readonly isVarargOptional?: boolean;
+}
+//# sourceMappingURL=Positional.d.ts.map

package/dist/src/api/argument/Positional.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Positional.d.ts","sourceRoot":"","sources":["../../../../src/api/argument/Positional.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,kBAAkB,MAAM,yBAAyB,CAAC;AAE9D;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,UAAW,SAAQ,kBAAkB;IAC5D;;;;;;;;OAQG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAEpC;;;;;;;OAOG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CACrC"}

package/dist/src/api/argument/SubCommandArgument.d.ts

@@ -0,0 +1,18 @@
+import type Argument from "./Argument.ts";
+export declare const MAXIMUM_ARGUMENT_ARRAY_SIZE = 255;
+/**
+ * Interface to be implemented by all {@link SubCommand} arguments.
+ */
+export default interface SubCommandArgument extends Argument {
+    /**
+     * Name of the argument.
+     *
+     * Must consist of alphanumeric non-whitespace ASCII or `_` and `-` characters. Cannot start with `-`.
+     */
+    readonly name: string;
+    /**
+     * Optional description of the argument.
+     */
+    readonly description?: string;
+}
+//# sourceMappingURL=SubCommandArgument.d.ts.map

package/dist/src/api/argument/SubCommandArgument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubCommandArgument.d.ts","sourceRoot":"","sources":["../../../../src/api/argument/SubCommandArgument.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAE1C,eAAO,MAAM,2BAA2B,MAAM,CAAC;AAE/C;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,kBAAmB,SAAQ,QAAQ;IAC1D;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B"}

package/dist/src/api/command/Command.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Common interface for all command types.
+ */
+export default interface Command {
+    /**
+     * Name of the command.
+     *
+     * Must consist of alphanumeric non-whitespace ASCII or `_` and `-` characters. Cannot start with `-`.
+     */
+    readonly name: string;
+    /**
+     * Optional description of the command.
+     */
+    readonly description?: string;
+    /**
+     * Optionally enable support for populating argument values via configuration. If this is `true` then
+     * default argument values may be sourced using a configuration source provided by the CLI runtime.
+     */
+    readonly enableConfiguration?: boolean;
+}
+//# sourceMappingURL=Command.d.ts.map

package/dist/src/api/command/Command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Command.d.ts","sourceRoot":"","sources":["../../../../src/api/command/Command.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,OAAO;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAC;CACxC"}

package/dist/src/api/command/GlobalCommand.d.ts

@@ -0,0 +1,28 @@
+import type Command from "./Command.ts";
+import type GlobalCommandArgument from "../argument/GlobalCommandArgument.ts";
+import type Context from "../Context.ts";
+import type { ArgumentSingleValueType } from "../argument/ArgumentValueTypes.ts";
+/**
+ * Interface for a global command.
+ */
+export default interface GlobalCommand extends Command {
+    /**
+     * Optional short alias for the global command.
+     *
+     * Must consist of a single alphanumeric non-whitespace ASCII character.
+     */
+    readonly shortAlias?: string;
+    /**
+     * Optional {@link GlobalCommandArgument} for the command.
+     */
+    readonly argument?: GlobalCommandArgument;
+    /**
+     * Execute the command.
+     *
+     * @param context the {@link Context} in which to execute the command.
+     * @param argumentValue optional argument value for the command. This will be populated unless
+     * the command's {@link GlobalCommandArgument} is optional and the argument value was not provided.
+     */
+    execute(context: Context, argumentValue?: ArgumentSingleValueType): Promise<void>;
+}
+//# sourceMappingURL=GlobalCommand.d.ts.map

package/dist/src/api/command/GlobalCommand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GlobalCommand.d.ts","sourceRoot":"","sources":["../../../../src/api/command/GlobalCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,qBAAqB,MAAM,sCAAsC,CAAC;AAC9E,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AAEjF;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,aAAc,SAAQ,OAAO;IACpD;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IAE1C;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnF"}

package/dist/src/api/command/GlobalModifierCommand.d.ts

@@ -0,0 +1,12 @@
+import type GlobalCommand from "./GlobalCommand.ts";
+/**
+ * Interface for a global modifier command.
+ */
+export default interface GlobalModifierCommand extends GlobalCommand {
+    /**
+     * Used to determine the order in which multiple global modifier command instances
+     * parsed from the provided arguments will be executed. Higher values will execute before lower values.
+     */
+    readonly executePriority: number;
+}
+//# sourceMappingURL=GlobalModifierCommand.d.ts.map

package/dist/src/api/command/GlobalModifierCommand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GlobalModifierCommand.d.ts","sourceRoot":"","sources":["../../../../src/api/command/GlobalModifierCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAC;AAEpD;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,qBAAsB,SAAQ,aAAa;IAClE;;;OAGG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;CAClC"}

package/dist/src/api/command/GroupCommand.d.ts

@@ -0,0 +1,19 @@
+import type SubCommand from "./SubCommand.ts";
+import type Command from "./Command.ts";
+import type Context from "../Context.ts";
+/**
+ * Interface for a group command.
+ */
+export default interface GroupCommand extends Command {
+    /**
+     * Array of {@link SubCommand} instances for this group command. Must contain at least one sub-command.
+     */
+    readonly memberSubCommands: ReadonlyArray<SubCommand>;
+    /**
+     * Execute the command.
+     *
+     * @param context the {@link Context} in which to execute the command.
+     */
+    execute(context: Context): Promise<void>;
+}
+//# sourceMappingURL=GroupCommand.d.ts.map

package/dist/src/api/command/GroupCommand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupCommand.d.ts","sourceRoot":"","sources":["../../../../src/api/command/GroupCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AAEzC;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,YAAa,SAAQ,OAAO;IACnD;;OAEG;IACH,QAAQ,CAAC,iBAAiB,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IAEtD;;;;OAIG;IACH,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1C"}

package/dist/src/api/command/SubCommand.d.ts

@@ -0,0 +1,37 @@
+import type Command from "./Command.ts";
+import type Option from "../argument/Option.ts";
+import type Positional from "../argument/Positional.ts";
+import type UsageExample from "./UsageExample.ts";
+import type ComplexOption from "../argument/ComplexOption.ts";
+import type { ArgumentValues } from "../argument/ArgumentValueTypes.ts";
+import type Context from "../Context.ts";
+/**
+ * Interface for a sub-command.
+ */
+export default interface SubCommand extends Command {
+    /**
+     * {@link Option} or {@link ComplexOption} argument definitions for the sub-command.
+     */
+    readonly options: ReadonlyArray<Option | ComplexOption>;
+    /**
+     * {@link Positional} argument definitions for the sub-command.
+     */
+    readonly positionals: ReadonlyArray<Positional>;
+    /**
+     * Optional grouping topic of the command for structuring of help output.
+     */
+    readonly helpTopic?: string;
+    /**
+     * Optional usage examples for the command to support help output.
+     */
+    readonly usageExamples?: ReadonlyArray<UsageExample>;
+    /**
+     * Execute the command.
+     *
+     * @param context the {@link Context} in which to execute the command.
+     * @param argumentValues the argument values for the command. This may be empty if
+     * the command's {@link Option} and {@link Positional} instances are all optional and no argument values were provided.
+     */
+    execute(context: Context, argumentValues: ArgumentValues): Promise<void>;
+}
+//# sourceMappingURL=SubCommand.d.ts.map

package/dist/src/api/command/SubCommand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubCommand.d.ts","sourceRoot":"","sources":["../../../../src/api/command/SubCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,MAAM,MAAM,uBAAuB,CAAC;AAChD,OAAO,KAAK,UAAU,MAAM,2BAA2B,CAAC;AACxD,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAC;AAClD,OAAO,KAAK,aAAa,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AAEzC;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,UAAW,SAAQ,OAAO;IACjD;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,GAAG,aAAa,CAAC,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IAEhD;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IAErD;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1E"}