@actsecurity/cli 0.2.66

package/dist/esm/arguments/singleValueArgument.d.ts

@@ -0,0 +1,17 @@
+import { type Argument, type PerArgumentArgs, type ValidatedValues } from './argument.js';
+type SingleValueValidator<ValueType> = (rawValue: string) => Promise<ValidatedValues<ValueType>> | ValidatedValues<ValueType>;
+type ArgumentWithDefault<ValueType> = {
+    defaultValue: ValueType;
+} & PerArgumentArgs;
+type ArgumentWithoutDefault<ValueType> = {
+    defaultValue?: undefined;
+} & PerArgumentArgs;
+/**
+ * Creates a single value argument factory for a specific type
+ */
+export declare function singleValueArgument<ValueType>(validator: SingleValueValidator<ValueType>, descriptionSuffix?: string): {
+    (options: ArgumentWithDefault<ValueType>): Argument<ValueType>;
+    (options: ArgumentWithoutDefault<ValueType>): Argument<ValueType | undefined>;
+};
+export {};
+//# sourceMappingURL=singleValueArgument.d.ts.map

package/dist/esm/arguments/singleValueArgument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"singleValueArgument.d.ts","sourceRoot":"","sources":["../../../src/arguments/singleValueArgument.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,eAAe,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAA;AAEzF,KAAK,oBAAoB,CAAC,SAAS,IAAI,CACrC,QAAQ,EAAE,MAAM,KACb,OAAO,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,GAAG,eAAe,CAAC,SAAS,CAAC,CAAA;AAErE,KAAK,mBAAmB,CAAC,SAAS,IAAI;IAAE,YAAY,EAAE,SAAS,CAAA;CAAE,GAAG,eAAe,CAAA;AACnF,KAAK,sBAAsB,CAAC,SAAS,IAAI;IAAE,YAAY,CAAC,EAAE,SAAS,CAAA;CAAE,GAAG,eAAe,CAAA;AAKvF;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAC3C,SAAS,EAAE,oBAAoB,CAAC,SAAS,CAAC,EAC1C,iBAAiB,GAAE,MAAW;cAEG,mBAAmB,CAAC,SAAS,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC;cAE1E,sBAAsB,CAAC,SAAS,CAAC,GACzC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC;EAuCnC"}

package/dist/esm/arguments/singleValueArgument.js

@@ -0,0 +1,33 @@
+import {} from './argument.js';
+/**
+ * Creates a single value argument factory for a specific type
+ */
+export function singleValueArgument(validator, descriptionSuffix = '') {
+    function createArgument(options) {
+        return {
+            description: options.description + descriptionSuffix,
+            validateValues: async (currentValue, values, isCurrentlyDefaulted) => {
+                if (currentValue !== undefined && currentValue != options.defaultValue) {
+                    return {
+                        valid: false,
+                        message: 'expects a single value but was set multiple times'
+                    };
+                }
+                if (values.length == 0) {
+                    return { valid: false, message: 'a value is required' };
+                }
+                if (values.length > 1) {
+                    return {
+                        valid: false,
+                        message: 'expects a single value but received ' + values.join(', ')
+                    };
+                }
+                return validator(values[0]);
+            },
+            reduceValues: async (current, newValue, isCurrentlyDefaulted) => newValue,
+            defaultValue: options.defaultValue
+        };
+    }
+    return createArgument;
+}
+//# sourceMappingURL=singleValueArgument.js.map

package/dist/esm/arguments/singleValueArgument.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"singleValueArgument.js","sourceRoot":"","sources":["../../../src/arguments/singleValueArgument.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6D,MAAM,eAAe,CAAA;AAYzF;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,SAA0C,EAC1C,oBAA4B,EAAE;IAM9B,SAAS,cAAc,CACrB,OAA+C;QAE/C,OAAO;YACL,WAAW,EAAE,OAAO,CAAC,WAAW,GAAG,iBAAiB;YACpD,cAAc,EAAE,KAAK,EACnB,YAAmC,EACnC,MAAgB,EAChB,oBAA6B,EACQ,EAAE;gBACvC,IAAI,YAAY,KAAK,SAAS,IAAI,YAAY,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;oBACvE,OAAO;wBACL,KAAK,EAAE,KAAK;wBACZ,OAAO,EAAE,mDAAmD;qBAC7D,CAAA;gBACH,CAAC;gBACD,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;oBACvB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAA;gBACzD,CAAC;gBACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACtB,OAAO;wBACL,KAAK,EAAE,KAAK;wBACZ,OAAO,EAAE,sCAAsC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;qBACpE,CAAA;gBACH,CAAC;gBAED,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;YAC7B,CAAC;YACD,YAAY,EAAE,KAAK,EACjB,OAA8B,EAC9B,QAAmB,EACnB,oBAA6B,EAC7B,EAAE,CAAC,QAAQ;YACb,YAAY,EAAE,OAAO,CAAC,YAAY;SACnC,CAAA;IACH,CAAC;IAED,OAAO,cAAc,CAAA;AACvB,CAAC"}

package/dist/esm/arguments/stringArguments.d.ts

@@ -0,0 +1,17 @@
+export declare const stringArgument: {
+    (options: {
+        defaultValue: string;
+    } & import("./argument.js").PerArgumentArgs): import("./argument.js").Argument<string>;
+    (options: {
+        defaultValue?: undefined;
+    } & import("./argument.js").PerArgumentArgs): import("./argument.js").Argument<string | undefined>;
+};
+export declare const stringArrayArgument: {
+    (options: {
+        defaultValue: string[];
+    } & import("./argument.js").PerArgumentArgs): import("./argument.js").Argument<string[]>;
+    (options: {
+        defaultValue?: undefined;
+    } & import("./argument.js").PerArgumentArgs): import("./argument.js").Argument<string[] | undefined>;
+};
+//# sourceMappingURL=stringArguments.d.ts.map

package/dist/esm/arguments/stringArguments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringArguments.d.ts","sourceRoot":"","sources":["../../../src/arguments/stringArguments.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,cAAc;;;;;;;CAM1B,CAAA;AAED,eAAO,MAAM,mBAAmB;;;;;;;CAM/B,CAAA"}

package/dist/esm/arguments/stringArguments.js

@@ -0,0 +1,11 @@
+import { arrayValueArgument } from './arrayValueArgument.js';
+import { singleValueArgument } from './singleValueArgument.js';
+export const stringArgument = singleValueArgument((rawValue) => ({
+    valid: true,
+    value: rawValue
+}), '. One string required.');
+export const stringArrayArgument = arrayValueArgument((rawValue) => ({
+    valid: true,
+    value: rawValue
+}), '. One or more strings required.');
+//# sourceMappingURL=stringArguments.js.map

package/dist/esm/arguments/stringArguments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringArguments.js","sourceRoot":"","sources":["../../../src/arguments/stringArguments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAE9D,MAAM,CAAC,MAAM,cAAc,GAAG,mBAAmB,CAC/C,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACb,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,QAAQ;CAChB,CAAC,EACF,wBAAwB,CACzB,CAAA;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG,kBAAkB,CACnD,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACb,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,QAAQ;CAChB,CAAC,EACF,iCAAiC,CAClC,CAAA"}

package/dist/esm/cli.d.ts

@@ -0,0 +1,131 @@
+import { type Argument } from './arguments/argument.js';
+type ParsedArguments<T extends Record<string, Argument<any>>> = {
+    [K in keyof T as K]: T[K] extends Argument<infer V> ? V : never;
+};
+/**
+ * A subcommand that can be used in the CLI.
+ */
+export type Subcommand = {
+    description: string;
+    arguments: Record<string, Argument<any>>;
+};
+/**
+ * A map of CLI argument keys to their configuration.
+ */
+export type Config<T extends Record<string, Argument<any>>> = T;
+interface ConsoleLogger {
+    log: (...args: any[]) => void;
+}
+/**
+ * Additional arguments that can be used to configure the CLI parser.
+ */
+export interface AdditionalCliOptions {
+    /**
+     * The version of the CLI command. If provided, the CLI provides a --version flag that prints the version and exits.
+     *
+     * If a string is provided, it is printed as-is.
+     * If an object it can have the following properties:
+     * - currentVersion: the current version of the CLI. This can be a string or a function that returns a Promise<string> or string.
+     * - checkForUpdates: Can be:
+     *   - a string name of the npm package to check for updates
+     *   - a function that returns a Promise<string | null> that returns the latest version or null if no update is available.
+     * - updateMessage: a function that takes the current version and latest version and returns a string message to display when an update is available.
+     */
+    version?: string | {
+        currentVersion: string | (() => Promise<string> | string);
+        checkForUpdates?: string | (() => Promise<string | null>);
+        updateMessage?: (current: string, latest: string) => string;
+    };
+    /**
+     * The argument string from the CLI. If not provided, the process.argv.slice(2) is used.
+     */
+    args?: string[];
+    /**
+     * The environment variables to use for parsing. If not provided, process.env is used.
+     */
+    env?: Record<string, string>;
+    /**
+     * The prefix to use for environment variables. If provided, the CLI will look for environment variables with the prefix followed by an underscore.
+     */
+    envPrefix?: string;
+    /**
+     * The name of the operands to display in the help message. Defaults to "operands".
+     */
+    operandsName?: string;
+    /**
+     * Whether a subcommand is required. If true, the CLI will exit with an error if no subcommand is provided.
+     */
+    requireSubcommand?: boolean;
+    /**
+     * If there are zero arguments, show the help message. Defaults to false.
+     */
+    showHelpIfNoArgs?: boolean;
+    /**
+     * Expect operands. Whether the app expects operands. Defaults to true.
+     *
+     * Changes the help message to include operands.
+     */
+    expectOperands?: boolean;
+    /**
+     * Allow operands from standard input. If true, the help will include a note about reading operands from standard input.
+     *
+     * Defaults to false
+     */
+    allowOperandsFromStdin?: boolean;
+    /**
+     * A logger to use for printing help messages. If not provided, console.log is used.
+     */
+    consoleLogger?: ConsoleLogger;
+}
+type OperandsType<A extends AdditionalCliOptions> = A extends {
+    expectOperands: false;
+} ? never : string[];
+export type SelectedSubcommandWithArgs<C extends Record<string, Subcommand>, O extends Record<string, Argument<any>>, A extends AdditionalCliOptions> = keyof C extends never ? {
+    subcommand: never;
+    args: ParsedArguments<O>;
+    operands: OperandsType<A>;
+    anyValues: boolean;
+    printHelp: () => void;
+} : A extends {
+    requireSubcommand: true;
+} ? {
+    [K in keyof C]: {
+        subcommand: K;
+        args: ParsedArguments<C[K]['arguments']> & ParsedArguments<O>;
+        operands: OperandsType<A>;
+        anyValues: boolean;
+        printHelp: () => void;
+    };
+}[keyof C] : {
+    subcommand: undefined;
+    args: ParsedArguments<O>;
+    operands: OperandsType<A>;
+    anyValues: boolean;
+    printHelp: () => void;
+} | {
+    [K in keyof C]: {
+        subcommand: K;
+        args: ParsedArguments<C[K]['arguments']> & ParsedArguments<O>;
+        operands: OperandsType<A>;
+        anyValues: boolean;
+        printHelp: () => void;
+    };
+}[keyof C];
+type Only<A, B> = {
+    [K in keyof A]: K extends keyof B ? A[K] : never;
+} & Partial<B>;
+/**
+ * Parse CLI Arguments and return the parsed typesafe results.
+ *
+ * @param command the name of the command arguments are being parsed for.
+ * @param subcommands the list of subcommands that can be used, if any.
+ * @param cliArgs the configuration options for the CLI command.
+ * @param additionalOptions additional arguments to be used for parsing and displaying help.
+ * @returns the parsed arguments, operands, and subcommand if applicable.
+ */
+export declare function parseCliArguments<const O extends Record<string, Argument<any>>, const C extends Record<string, Subcommand>, const A extends AdditionalCliOptions>(command: string, subcommands: C, cliArgs: Config<O>, additionalOptions?: Only<A, AdditionalCliOptions>): Promise<SelectedSubcommandWithArgs<C, O, A>>;
+export declare function camelToCapitalSnakeCase(input: string): string;
+export declare function camelToKebabCase(input: string): string;
+export declare function printHelpContents<O extends Record<string, Argument<any>>, C extends Record<string, Subcommand>>(command: string, subcommands: C, cliOptions: O, additionalArgs?: AdditionalCliOptions, selectedSubcommand?: string | undefined): void;
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/esm/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AAGvD,KAAK,eAAe,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI;KAC7D,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAChE,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAA;CACzC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAA;AAS/D,UAAU,aAAa;IACrB,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;;;OAUG;IAEH,OAAO,CAAC,EACJ,MAAM,GACN;QACE,cAAc,EAAE,MAAM,GAAG,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAA;QACzD,eAAe,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAA;QACzD,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,MAAM,CAAA;KAC5D,CAAA;IAEL;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAEhC;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;CAC9B;AAED,KAAK,YAAY,CAAC,CAAC,SAAS,oBAAoB,IAAI,CAAC,SAAS;IAAE,cAAc,EAAE,KAAK,CAAA;CAAE,GACnF,KAAK,GACL,MAAM,EAAE,CAAA;AAEZ,MAAM,MAAM,0BAA0B,CACpC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EACpC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,EACvC,CAAC,SAAS,oBAAoB,IAC5B,MAAM,CAAC,SAAS,KAAK,GACrB;IACE,UAAU,EAAE,KAAK,CAAA;IACjB,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;IACxB,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;IACzB,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,MAAM,IAAI,CAAA;CACtB,GACD,CAAC,SAAS;IAAE,iBAAiB,EAAE,IAAI,CAAA;CAAE,GACnC;KACG,CAAC,IAAI,MAAM,CAAC,GAAG;QACd,UAAU,EAAE,CAAC,CAAA;QACb,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;QAC7D,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;QACzB,SAAS,EAAE,OAAO,CAAA;QAClB,SAAS,EAAE,MAAM,IAAI,CAAA;KACtB;CACF,CAAC,MAAM,CAAC,CAAC,GACR;IACE,UAAU,EAAE,SAAS,CAAA;IACrB,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;IACxB,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;IACzB,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,MAAM,IAAI,CAAA;CACtB,GACD;KACG,CAAC,IAAI,MAAM,CAAC,GAAG;QACd,UAAU,EAAE,CAAC,CAAA;QACb,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;QAC7D,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;QACzB,SAAS,EAAE,OAAO,CAAA;QAClB,SAAS,EAAE,MAAM,IAAI,CAAA;KACtB;CACF,CAAC,MAAM,CAAC,CAAC,CAAA;AAElB,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI;KACf,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CACjD,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;AAEd;;;;;;;;GAQG;AACH,wBAAsB,iBAAiB,CACrC,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,EAC7C,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EAC1C,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAEpC,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,CAAC,EACd,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAClB,iBAAiB,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,oBAAoB,CAAC,GAChD,OAAO,CAAC,0BAA0B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CA8O9C;AAwJD,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAI7D;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAItD;AAED,wBAAgB,iBAAiB,CAC/B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,EACvC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EAEpC,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,CAAC,EACd,UAAU,EAAE,CAAC,EACb,cAAc,CAAC,EAAE,oBAAoB,EACrC,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,GACtC,IAAI,CA+EN"}