convoker 0.3.3 → 0.4.0

package/dist/index-BYLskLxk.d.mts

@@ -0,0 +1,200 @@
+import { n as Theme } from "./index-BtbthYjp.mjs";
+import { t as StandardSchemaV1 } from "./standard-schema-DXS-QnwX.mjs";
+import { i as raw_d_exports } from "./raw-cqTp2vds.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 };
+//# sourceMappingURL=index-BYLskLxk.d.mts.map

package/dist/index-BtbthYjp.d.mts

@@ -0,0 +1,168 @@
+//#region src/utils.d.ts
+/**
+ * Deep `Partial<T>`.
+ */
+type DeepPartial<T> = { [P in keyof T]?: DeepPartial<T[P]> };
+declare namespace index_d_exports {
+  export { DEFAULT_THEME, Theme, bgBlack, bgBlue, bgBlueBright, bgCyan, bgCyanBright, bgGray, bgGreen, bgGreenBright, bgMagenta, bgMagentaBright, bgRed, bgRedBright, bgWhite, bgWhiteBright, bgYellow, bgYellowBright, black, blue, blueBright, bold, createAnsiColor, cyan, cyanBright, defineTheme, dim, gray, green, greenBright, hidden, inverse, italic, magenta, magentaBright, overline, red, redBright, reset, strikethrough, supportsColor, underline, white, whiteBright, yellow, yellowBright };
+}
+/**
+ * If the runtime supports color.
+ */
+declare const supportsColor: boolean;
+/**
+ * Creates a function that wraps a string in ANSI codes.
+ * @param open The opening ANSI code.
+ * @param close The closing ANSI code.
+ * @returns A function that wraps the string in ANSI codes.
+ */
+declare function createAnsiColor(open: number, close: number): (input: any) => string;
+declare const reset: (input: any) => string;
+declare const bold: (input: any) => string;
+declare const dim: (input: any) => string;
+declare const italic: (input: any) => string;
+declare const underline: (input: any) => string;
+declare const overline: (input: any) => string;
+declare const inverse: (input: any) => string;
+declare const hidden: (input: any) => string;
+declare const strikethrough: (input: any) => string;
+declare const black: (input: any) => string;
+declare const red: (input: any) => string;
+declare const green: (input: any) => string;
+declare const yellow: (input: any) => string;
+declare const blue: (input: any) => string;
+declare const magenta: (input: any) => string;
+declare const cyan: (input: any) => string;
+declare const white: (input: any) => string;
+declare const gray: (input: any) => string;
+declare const bgBlack: (input: any) => string;
+declare const bgRed: (input: any) => string;
+declare const bgGreen: (input: any) => string;
+declare const bgYellow: (input: any) => string;
+declare const bgBlue: (input: any) => string;
+declare const bgMagenta: (input: any) => string;
+declare const bgCyan: (input: any) => string;
+declare const bgWhite: (input: any) => string;
+declare const bgGray: (input: any) => string;
+declare const redBright: (input: any) => string;
+declare const greenBright: (input: any) => string;
+declare const yellowBright: (input: any) => string;
+declare const blueBright: (input: any) => string;
+declare const magentaBright: (input: any) => string;
+declare const cyanBright: (input: any) => string;
+declare const whiteBright: (input: any) => string;
+declare const bgRedBright: (input: any) => string;
+declare const bgGreenBright: (input: any) => string;
+declare const bgYellowBright: (input: any) => string;
+declare const bgBlueBright: (input: any) => string;
+declare const bgMagentaBright: (input: any) => string;
+declare const bgCyanBright: (input: any) => string;
+declare const bgWhiteBright: (input: any) => string;
+/**
+ * A theme.
+ */
+interface Theme {
+  /**
+   * Wraps a string in a background ANSI code.
+   * @param a The string to wrap.
+   */
+  background?(a: string): string;
+  /**
+   * Wraps a string in a foreground ANSI code.
+   * @param a The string to wrap.
+   */
+  foreground?(a: string): string;
+  /**
+   * Wraps a string in a primary ANSI code.
+   * @param a The string to wrap.
+   */
+  primary(a: string): string;
+  /**
+   * Wraps a string in a secondary ANSI code.
+   * @param a The string to wrap.
+   */
+  secondary(a: string): string;
+  /**
+   * Wraps a string in a accent ANSI code.
+   * @param a The string to wrap.
+   */
+  accent?(a: string): string;
+  /**
+   * Wraps a string in a success ANSI code.
+   * @param a The string to wrap.
+   */
+  success(a: string): string;
+  /**
+   * Wraps a string in a warning ANSI code.
+   * @param a The string to wrap.
+   */
+  warning(a: string): string;
+  /**
+   * Wraps a string in a error ANSI code.
+   * @param a The string to wrap.
+   */
+  error(a: string): string;
+  /**
+   * Wraps a string in a info ANSI code.
+   * @param a The string to wrap.
+   */
+  info?(a: string): string;
+  /**
+   * Set of symbols for logging.
+   */
+  symbols?: {
+    /**
+     * Success message symbol.
+     */
+    success: string;
+    /**
+     * Error message symbol.
+     */
+    error: string;
+    /**
+     * Fatal error message symbol.
+     */
+    fatal: string;
+    /**
+     * Warning message symbol.
+     */
+    warning: string;
+    /**
+     * Information message symbol.
+     */
+    info?: string;
+  };
+  /**
+   * Optional styles.
+   */
+  styles?: {
+    /**
+     * Wraps a string in a bold ANSI code.
+     * @param a The string to wrap.
+     */
+    bold?(a: string): string;
+    /**
+     * Wraps a string in an italic ANSI code.
+     * @param a The string to wrap.
+     */
+    italic?(a: string): string;
+    /**
+     * Wraps a string in an underline ANSI code.
+     * @param a The string to wrap.
+     */
+    underline?(a: string): string;
+  };
+}
+/**
+ * The default theme.
+ */
+declare const DEFAULT_THEME: Theme;
+/**
+ * Defines a theme.
+ * @param theme The (partial) theme.
+ * @returns The theme, merged with the default theme.
+ */
+declare function defineTheme(theme: DeepPartial<Theme>): Theme;
+//#endregion
+export { greenBright as A, reset as B, createAnsiColor as C, dim as D, defineTheme as E, magenta as F, whiteBright as G, supportsColor as H, magentaBright as I, DeepPartial as J, yellow as K, overline as L, index_d_exports as M, inverse as N, gray as O, italic as P, red as R, bold as S, cyanBright as T, underline as U, strikethrough as V, white as W, bgYellow as _, bgBlueBright as a, blue as b, bgGray as c, bgMagenta as d, bgMagentaBright as f, bgWhiteBright as g, bgWhite as h, bgBlue as i, hidden as j, green as k, bgGreen as l, bgRedBright as m, Theme as n, bgCyan as o, bgRed as p, yellowBright as q, bgBlack as r, bgCyanBright as s, DEFAULT_THEME as t, bgGreenBright as u, bgYellowBright as v, cyan as w, blueBright as x, black as y, redBright as z };
+//# sourceMappingURL=index-BtbthYjp.d.mts.map

package/dist/index-ClhbwSD8.d.mts

@@ -0,0 +1,202 @@
+import { t as StandardSchemaV1 } from "./standard-schema-DXS-QnwX.mjs";
+
+//#region src/input/error.d.ts
+/**
+ * Thrown when the command fails to validate an input.
+ */
+declare class InputValidationError extends Error {
+  /**
+   * A list of messages.
+   */
+  messages: string[];
+  /**
+   * Creates a new input validation error.
+   * @param messages The messages.
+   */
+  constructor(messages: string[]);
+}
+declare namespace index_d_exports {
+  export { BasicKind, InferEntry, InferInput, Input, InputValidationError, 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, index_d_exports as d, option as f, Input as i, argument as l, InputValidationError as m, InferEntry as n, Option as o, positional as p, InferInput as r, Positional as s, BasicKind as t, convert as u };
+//# sourceMappingURL=index-ClhbwSD8.d.mts.map