convoker 0.3.2 → 0.3.4

package/dist/error.d.mts

@@ -0,0 +1,5 @@
+import "./color-BuHvMolk.mjs";
+import "./standard-schema-DLeKaehR.mjs";
+import "./input-B12iaqb8.mjs";
+import { c as ConvokerError, d as MissingRequiredArgumentError, f as MissingRequiredOptionError, l as HelpAskedError, m as UnknownOptionError, p as TooManyArgumentsError, u as InputValidationError } from "./command-BXmfoT-l.mjs";
+export { ConvokerError, HelpAskedError, InputValidationError, MissingRequiredArgumentError, MissingRequiredOptionError, TooManyArgumentsError, UnknownOptionError };

package/dist/error.mjs

@@ -0,0 +1,3 @@
+import { a as MissingRequiredOptionError, i as MissingRequiredArgumentError, n as HelpAskedError, o as TooManyArgumentsError, r as InputValidationError, s as UnknownOptionError, t as ConvokerError } from "./error-C1S1gs8L.mjs";
+
+export { ConvokerError, HelpAskedError, InputValidationError, MissingRequiredArgumentError, MissingRequiredOptionError, TooManyArgumentsError, UnknownOptionError };

package/dist/index-Dikc5KAP.d.mts

@@ -0,0 +1,199 @@
+import { n as Theme } from "./color-BuHvMolk.mjs";
+import { t as StandardSchemaV1 } from "./standard-schema-DLeKaehR.mjs";
+import { i as raw_d_exports } from "./raw-BqvlveTU.mjs";
+
+//#region src/prompt/index.d.ts
+declare namespace index_d_exports {
+  export { BaseOpts, ConfirmOpts, EditorOpts, PasswordOpts, SearchOpts, SelectOption, SelectOpts, TextOpts, confirm, editor, multiselect, password, raw_d_exports as raw, search, select, setTheme, text };
+}
+/**
+ * Sets the theme of the prompts.
+ * @param t The new theme.
+ */
+declare function setTheme(t: Theme): void;
+/**
+ * Base options for prompts.
+ */
+interface BaseOpts<T> {
+  /**
+   * The message of the prompt.
+   */
+  message: string;
+  /**
+   * An `AbortSignal` to cancel the prompt.
+   */
+  signal?: AbortSignal;
+  /**
+   * The default value.
+   */
+  default?: T;
+  /**
+   * The theme of the prompt.
+   */
+  theme?: Theme;
+  /**
+   * A validator function, or a Standard Schema validator.
+   */
+  validate?: StandardSchemaV1<any, T> | ((value: T) => boolean | T);
+}
+/**
+ * Options for text input.
+ */
+interface TextOpts extends BaseOpts<string> {
+  /**
+   * A placeholder, displayed when the user hasn't typed anything yet.
+   */
+  placeholder?: string;
+  /**
+   * Minimum length of the input.
+   */
+  minLength?: number;
+  /**
+   * Maximum length of the input.
+   */
+  maxLength?: number;
+}
+/**
+ * Prompts the user for text input.
+ * @param opts Options for text input.
+ * @returns The text the user typed in, or the default.
+ */
+declare function text(opts: TextOpts): Promise<string>;
+/**
+ * Options for password input.
+ */
+interface PasswordOpts extends TextOpts {
+  /**
+   * The mask for the password input.
+   */
+  mask?: string;
+  /**
+   * If the user should be asked to confirm the password, by typing it again.
+   */
+  confirm?: boolean;
+}
+/**
+ * Prompts the user for a password.
+ * @param opts Options for password input.
+ * @returns The password.
+ */
+declare function password(opts: PasswordOpts): Promise<string>;
+/**
+ * An option for select input.
+ */
+interface SelectOption<T> {
+  /**
+   * The label (what gets displayed) of the select option.
+   */
+  label: string;
+  /**
+   * The value (what gets returned) of the select option.
+   */
+  value: T;
+  /**
+   * A description of the option.
+   */
+  hint?: string;
+  /**
+   * If this option is disabled.
+   */
+  disabled?: boolean;
+}
+/**
+ * Options for select input.
+ */
+interface SelectOpts<T> extends BaseOpts<T> {
+  /**
+   * Every option the user can pick from.
+   */
+  options: SelectOption<T>[];
+  /**
+   * The initial option selected.
+   */
+  initialIndex?: number;
+}
+/**
+ * Prompts the user to select a single option.
+ * @param opts Options for select input.
+ * @returns The selected option's value.
+ */
+declare function select<T>(opts: SelectOpts<T>): Promise<T>;
+/**
+ * Prompts the user to select multiple options.
+ * @param opts Options for select input.
+ * @returns The selected options.
+ */
+declare function multiselect<T>(opts: SelectOpts<T>): Promise<T[]>;
+/**
+ * Options for search input.
+ */
+interface SearchOpts<T> extends BaseOpts<T> {
+  /**
+   * Every option the user can search through.
+   */
+  options: SelectOption<T>[];
+  /**
+   * Placeholder for the search input.
+   */
+  placeholder?: string;
+  /**
+   * Minimum length for a query string.
+   */
+  minQueryLength?: number;
+  /**
+   * Filters a single option.
+   * @param query The search query.
+   * @param option The option to filter.
+   */
+  filter?(query: string, option: SelectOption<T>): boolean;
+}
+/**
+ * Prompts the user to search through a list of options.
+ * @param opts Options for search input.
+ * @returns The selected option.
+ */
+declare function search<T>(opts: SearchOpts<T>): Promise<T>;
+/**
+ * Options for confirm input.
+ */
+interface ConfirmOpts extends BaseOpts<boolean> {
+  /**
+   * What gets displayed for the Yes option.
+   */
+  yesLabel?: string;
+  /**
+   * What gets displayed for the No option.
+   */
+  noLabel?: string;
+}
+/**
+ * Prompts the user to confirm an action.
+ * @param opts Options for confirm input.
+ * @returns If the user picked Yes.
+ */
+declare function confirm(opts: ConfirmOpts): Promise<boolean>;
+/**
+ * Options for opening the system editor.
+ */
+interface EditorOpts extends BaseOpts<string> {
+  /**
+   * The initial value.
+   */
+  initial?: string;
+  /**
+   * The language of the value.
+   */
+  language?: string;
+  /**
+   * If the input is required for continuing or not.
+   */
+  required?: boolean;
+}
+/**
+ * Opens the system editor, or asks for input in the terminal as fallback.
+ * @param opts Options for opening the system editor.
+ * @returns The result of the system editor.
+ */
+declare function editor(opts: EditorOpts): Promise<string>;
+//#endregion
+export { text as _, SearchOpts as a, TextOpts as c, index_d_exports as d, multiselect as f, setTheme as g, select as h, PasswordOpts as i, confirm as l, search as m, ConfirmOpts as n, SelectOption as o, password as p, EditorOpts as r, SelectOpts as s, BaseOpts as t, editor as u };

package/dist/index.d.mts

@@ -0,0 +1,73 @@
+import { C as color_d_exports, n as Theme } from "./color-BuHvMolk.mjs";
+import "./standard-schema-DLeKaehR.mjs";
+import { d as input_d_exports } from "./input-B12iaqb8.mjs";
+import { a as ErrorFn, h as error_d_exports, i as CommandAlias, n as Builder, o as MiddlewareFn, r as Command, s as ParseResult, t as ActionFn } from "./command-BXmfoT-l.mjs";
+import "./raw-BqvlveTU.mjs";
+import { d as index_d_exports } from "./index-Dikc5KAP.mjs";
+
+//#region src/log.d.ts
+declare namespace log_d_exports {
+  export { LogConfig, error, fatal, info, setConfig, setTheme, setup, trace, warn };
+}
+/**
+ * The logger configuration.
+ */
+interface LogConfig {
+  /**
+   * The format to print as.
+   */
+  format: "text" | "json" | "xml" | "yaml" | "csv";
+  /**
+   * Standard output.
+   */
+  stdout: WritableStream<string>;
+  /**
+   * Standard error.
+   */
+  stderr: WritableStream<string>;
+  /**
+   * Standard input.
+   */
+  stdin: ReadableStream<string>;
+}
+/**
+ * Sets a new theme.
+ * @param t The theme.
+ */
+declare function setTheme(t: Theme): void;
+/**
+ * Sets new configuration.
+ * @param c The config.
+ */
+declare function setConfig(c: Partial<LogConfig>): Promise<void>;
+/**
+ * Sets default configuration.
+ */
+declare function setup(): Promise<void>;
+/**
+ * Prints debug information.
+ * @param msgs The messages to write.
+ */
+declare function trace(...msgs: any[]): Promise<void>;
+/**
+ * Prints information.
+ * @param msgs The messages to write.
+ */
+declare function info(...msgs: any[]): Promise<void>;
+/**
+ * Prints warnings.
+ * @param msgs The messages to write.
+ */
+declare function warn(...msgs: any[]): Promise<void>;
+/**
+ * Prints errors.
+ * @param msgs The messages to write.
+ */
+declare function error(...msgs: any[]): Promise<void>;
+/**
+ * Prints errors and exits.
+ * @param msgs The messages to write.
+ */
+declare function fatal(...msgs: any[]): Promise<void>;
+//#endregion
+export { ActionFn, Builder, Command, CommandAlias, ErrorFn, MiddlewareFn, ParseResult, color_d_exports as color, error_d_exports as error, input_d_exports as i, log_d_exports as log, index_d_exports as prompt };

package/dist/index.mjs

@@ -0,0 +1,10 @@
+import "./utils-ChmY93uA.mjs";
+import { S as color_exports } from "./color-OlJQTTxb.mjs";
+import { c as error_exports } from "./error-C1S1gs8L.mjs";
+import "./standard-schema-DBXbMy6L.mjs";
+import "./raw--889icsd.mjs";
+import { a as prompt_exports } from "./prompt-Cvufljin.mjs";
+import { n as log_exports, t as Command } from "./command-D2UiQBNA.mjs";
+import { a as input_exports } from "./input-DRy_sVxZ.mjs";
+
+export { Command, color_exports as color, error_exports as error, input_exports as i, log_exports as log, prompt_exports as prompt };

package/dist/input-B12iaqb8.d.mts

@@ -0,0 +1,187 @@
+import { t as StandardSchemaV1 } from "./standard-schema-DLeKaehR.mjs";
+
+//#region src/input.d.ts
+declare namespace input_d_exports {
+  export { BasicKind, InferEntry, InferInput, Input, Kind, Option, Positional, TypeOf, argument, convert, option, positional };
+}
+/**
+ * An input object.
+ */
+interface Input {
+  [x: string]: Option<any, any, any> | Positional<any, any, any>;
+}
+/**
+ * A basic input type.
+ */
+type BasicKind = "boolean" | "string" | "number" | "bigint";
+/**
+ * An input type.
+ */
+type Kind = BasicKind | StandardSchemaV1<any, any>;
+/**
+ * Converts a Kind to a TypeScript type.
+ */
+type TypeOf<T extends Kind> = T extends StandardSchemaV1<any, infer Out> ? Out : T extends "boolean" ? boolean : T extends "string" ? string : T extends "number" ? number : T extends "bigint" ? bigint : never;
+/**
+ * Infers TypeScript types from an input object.
+ */
+type InferInput<T extends Input> = { [K in keyof T]: InferEntry<T[K]> };
+/**
+ * Infers a TypeScript type from an option or positional.
+ */
+type InferEntry<T> = T extends {
+  $kind: infer TKind extends Kind;
+  $required: infer Required;
+  $list: infer List;
+} ? List extends true ? Required extends true ? TypeOf<TKind>[] : TypeOf<TKind>[] | undefined : Required extends true ? TypeOf<TKind> : TypeOf<TKind> | undefined : never;
+/**
+ * Converts a value from a Kind to a TypeScript type.
+ * @param kind The kind to convert to.
+ * @param value The value to convert.
+ * @returns The converted value.
+ */
+declare function convert<TKind$1 extends Kind>(kind: TKind$1, value: string | string[]): Promise<TypeOf<TKind$1> | TypeOf<TKind$1>[]>;
+/**
+ * An option.
+ */
+declare class Option<TKind$1 extends Kind, TRequired extends boolean = true, TList extends boolean = false> {
+  /**
+   * The kind of this option.
+   */
+  $kind: TKind$1;
+  /**
+   * The aliases of this option.
+   */
+  $names: string[];
+  /**
+   * The description of this option.
+   */
+  $description: string | undefined;
+  /**
+   * The default value of this option.
+   */
+  $default: TypeOf<TKind$1> | undefined;
+  /**
+   * If this option is required.
+   */
+  $required: TRequired;
+  /**
+   * If this option is a list.
+   */
+  $list: TList;
+  /**
+   * A separator if this option is a list.
+   */
+  $separator: string | undefined;
+  /**
+   * Creates a new option.
+   * @param kind The type of this option.
+   * @param names The names of this option.
+   */
+  constructor(kind: TKind$1, names: string[]);
+  /**
+   * Makes this option a list.
+   * @returns this
+   */
+  list(separator?: string): Option<TKind$1, TRequired, true>;
+  /**
+   * Makes this option required.
+   * @returns this
+   */
+  required(): Option<TKind$1, true, TList>;
+  /**
+   * Makes this option optional.
+   * @returns this
+   */
+  optional(): Option<TKind$1, false, TList>;
+  /**
+   * Sets a default value.
+   * @param value The default value.
+   * @returns this
+   */
+  default(value: TypeOf<TKind$1>): this;
+  /**
+   * Sets a description.
+   * @param desc The description.
+   * @returns this
+   */
+  description(desc: string): this;
+}
+/**
+ * A positional argument.
+ */
+declare class Positional<TKind$1 extends Kind, TRequired extends boolean = true, TList extends boolean = false> {
+  /**
+   * The type of this argument.
+   */
+  $kind: TKind$1;
+  /**
+   * The default value of this argument.
+   */
+  $default: TypeOf<TKind$1> | undefined;
+  /**
+   * The description of this argument.
+   */
+  $description: string | undefined;
+  /**
+   * If this argument is required.
+   */
+  $required: TRequired;
+  /**
+   * If this argument is a list.
+   */
+  $list: TList;
+  /**
+   * Creates a new positional argument.
+   * @param kind The positional argument.
+   */
+  constructor(kind: TKind$1);
+  /**
+   * Makes this argument a list.
+   * @returns this
+   */
+  list(): Positional<TKind$1, TRequired, true>;
+  /**
+   * Makes this argument required.
+   * @returns this
+   */
+  required(): Positional<TKind$1, true, TList>;
+  /**
+   * Makes this argument optional.
+   * @returns this
+   */
+  optional(): Positional<TKind$1, false, TList>;
+  /**
+   * Sets a default value.
+   * @param value The default value.
+   * @returns this
+   */
+  default(value: TypeOf<TKind$1>): this;
+  /**
+   * Sets a description.
+   * @param desc The description.
+   * @returns this
+   */
+  description(desc: string): this;
+}
+/**
+ * Creates a new option.
+ * @param kind The kind of option.
+ * @param names The names of the option.
+ * @returns A new option.
+ */
+declare function option<T extends Kind>(kind: T, ...names: string[]): Option<T>;
+/**
+ * Creates a new positional argument.
+ * @param kind The kind of positional argument.
+ * @returns A new positional argument.
+ */
+declare function positional<T extends Kind>(kind: T): Positional<T>;
+/**
+ * Creates a new positional argument.
+ * @param kind The kind of positional argument.
+ * @returns A new positional argument.
+ */
+declare function argument<T extends Kind>(kind: T): Positional<T>;
+//#endregion
+export { Kind as a, TypeOf as c, input_d_exports as d, option as f, Input as i, argument as l, InferEntry as n, Option as o, positional as p, InferInput as r, Positional as s, BasicKind as t, convert as u };

package/dist/input-DRy_sVxZ.mjs

@@ -0,0 +1,174 @@
+import { t as __export } from "./chunk-z5eko27R.mjs";
+import { t as validate } from "./standard-schema-DBXbMy6L.mjs";
+
+//#region src/input.ts
+var input_exports = /* @__PURE__ */ __export({
+	Option: () => Option,
+	Positional: () => Positional,
+	argument: () => argument,
+	convert: () => convert,
+	option: () => option,
+	positional: () => positional
+});
+/**
+* Converts a value from a Kind to a TypeScript type.
+* @param kind The kind to convert to.
+* @param value The value to convert.
+* @returns The converted value.
+*/
+async function convert(kind, value) {
+	async function convertOne(val) {
+		if (typeof kind === "string") switch (kind) {
+			case "boolean": return val === "true";
+			case "bigint": return BigInt(val);
+			case "number": return parseFloat(val);
+			case "string": return val;
+		}
+		return validate(kind, val);
+	}
+	if (Array.isArray(value)) return await Promise.all(value.map((v) => convertOne(v)));
+	return convertOne(value);
+}
+/**
+* An option.
+*/
+var Option = class {
+	/**
+	* Creates a new option.
+	* @param kind The type of this option.
+	* @param names The names of this option.
+	*/
+	constructor(kind, names) {
+		this.$required = true;
+		this.$list = false;
+		this.$kind = kind;
+		this.$names = names.map((name) => name.replace(/^-+/, ""));
+	}
+	/**
+	* Makes this option a list.
+	* @returns this
+	*/
+	list(separator) {
+		this.$list = true;
+		this.$separator = separator ?? this.$separator;
+		return this;
+	}
+	/**
+	* Makes this option required.
+	* @returns this
+	*/
+	required() {
+		this.$required = true;
+		return this;
+	}
+	/**
+	* Makes this option optional.
+	* @returns this
+	*/
+	optional() {
+		this.$required = false;
+		return this;
+	}
+	/**
+	* Sets a default value.
+	* @param value The default value.
+	* @returns this
+	*/
+	default(value) {
+		this.$default = value;
+		return this;
+	}
+	/**
+	* Sets a description.
+	* @param desc The description.
+	* @returns this
+	*/
+	description(desc) {
+		this.$description = desc;
+		return this;
+	}
+};
+/**
+* A positional argument.
+*/
+var Positional = class {
+	/**
+	* Creates a new positional argument.
+	* @param kind The positional argument.
+	*/
+	constructor(kind) {
+		this.$required = true;
+		this.$list = false;
+		this.$kind = kind;
+	}
+	/**
+	* Makes this argument a list.
+	* @returns this
+	*/
+	list() {
+		this.$list = true;
+		return this;
+	}
+	/**
+	* Makes this argument required.
+	* @returns this
+	*/
+	required() {
+		this.$required = true;
+		return this;
+	}
+	/**
+	* Makes this argument optional.
+	* @returns this
+	*/
+	optional() {
+		this.$required = false;
+		return this;
+	}
+	/**
+	* Sets a default value.
+	* @param value The default value.
+	* @returns this
+	*/
+	default(value) {
+		this.$default = value;
+		return this;
+	}
+	/**
+	* Sets a description.
+	* @param desc The description.
+	* @returns this
+	*/
+	description(desc) {
+		this.$description = desc;
+		return this;
+	}
+};
+/**
+* Creates a new option.
+* @param kind The kind of option.
+* @param names The names of the option.
+* @returns A new option.
+*/
+function option(kind, ...names) {
+	return new Option(kind, names);
+}
+/**
+* Creates a new positional argument.
+* @param kind The kind of positional argument.
+* @returns A new positional argument.
+*/
+function positional(kind) {
+	return new Positional(kind);
+}
+/**
+* Creates a new positional argument.
+* @param kind The kind of positional argument.
+* @returns A new positional argument.
+*/
+function argument(kind) {
+	return new Positional(kind);
+}
+
+//#endregion
+export { input_exports as a, convert as i, Positional as n, option as o, argument as r, positional as s, Option as t };

package/dist/input.d.mts

@@ -0,0 +1,3 @@
+import "./standard-schema-DLeKaehR.mjs";
+import { a as Kind, c as TypeOf, f as option, i as Input, l as argument, n as InferEntry, o as Option, p as positional, r as InferInput, s as Positional, t as BasicKind, u as convert } from "./input-B12iaqb8.mjs";
+export { BasicKind, InferEntry, InferInput, Input, Kind, Option, Positional, TypeOf, argument, convert, option, positional };

package/dist/input.mjs

@@ -0,0 +1,5 @@
+import "./error-C1S1gs8L.mjs";
+import "./standard-schema-DBXbMy6L.mjs";
+import { i as convert, n as Positional, o as option, r as argument, s as positional, t as Option } from "./input-DRy_sVxZ.mjs";
+
+export { Option, Positional, argument, convert, option, positional };

package/dist/prompt/index.d.mts

@@ -0,0 +1,5 @@
+import "../color-BuHvMolk.mjs";
+import "../standard-schema-DLeKaehR.mjs";
+import { i as raw_d_exports } from "../raw-BqvlveTU.mjs";
+import { _ as text, a as SearchOpts, c as TextOpts, f as multiselect, g as setTheme, h as select, i as PasswordOpts, l as confirm, m as search, n as ConfirmOpts, o as SelectOption, p as password, r as EditorOpts, s as SelectOpts, t as BaseOpts, u as editor } from "../index-Dikc5KAP.mjs";
+export { BaseOpts, ConfirmOpts, EditorOpts, PasswordOpts, SearchOpts, SelectOption, SelectOpts, TextOpts, confirm, editor, multiselect, password, raw_d_exports as raw, search, select, setTheme, text };

package/dist/prompt/index.mjs

@@ -0,0 +1,8 @@
+import "../utils-ChmY93uA.mjs";
+import "../color-OlJQTTxb.mjs";
+import "../error-C1S1gs8L.mjs";
+import "../standard-schema-DBXbMy6L.mjs";
+import { i as raw_exports } from "../raw--889icsd.mjs";
+import { c as setTheme, i as password, l as text, n as editor, o as search, r as multiselect, s as select, t as confirm } from "../prompt-Cvufljin.mjs";
+
+export { confirm, editor, multiselect, password, raw_exports as raw, search, select, setTheme, text };

package/dist/prompt/raw.d.mts

@@ -0,0 +1,2 @@
+import { a as readKey, n as cursorDown, o as readLine, r as cursorUp, t as clearLines } from "../raw-BqvlveTU.mjs";
+export { clearLines, cursorDown, cursorUp, readKey, readLine };

package/dist/prompt/raw.mjs

@@ -0,0 +1,4 @@
+import "../utils-ChmY93uA.mjs";
+import { a as readKey, n as cursorDown, o as readLine, r as cursorUp, t as clearLines } from "../raw--889icsd.mjs";
+
+export { clearLines, cursorDown, cursorUp, readKey, readLine };