convoker 0.3.0 → 0.3.3

package/dist/{prompt.d.ts → prompt/index.d.ts}

@@ -1,258 +1,193 @@
-import { StandardSchemaV1 } from '../../../../../../../../../../src/standard-schema';
-import { Theme } from '../../../../../../../../../../src/color';
-
-/**
- * Base options for prompts.
- */
-export declare 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);
-}
-
-/**
- * Clears `lines` amount of lines.
- * @param lines Amount of lines to clear.
- */
-declare function clearLines(lines?: number): void;
-
-/**
- * Prompts the user to confirm an action.
- * @param opts Options for confirm input.
- * @returns If the user picked Yes.
- */
-declare function confirm_2(opts: ConfirmOpts): Promise<boolean>;
-export { confirm_2 as confirm }
-
-/**
- * Options for confirm input.
- */
-export declare interface ConfirmOpts extends BaseOpts<boolean> {
-    /**
-     * What gets displayed for the Yes option.
-     */
-    yesLabel?: string;
-    /**
-     * What gets displayed for the No option.
-     */
-    noLabel?: string;
-}
-
-/**
- * Moves the cursor down `n` times.
- * @param n The amount of steps to move.
- */
-declare function cursorDown(n?: number): void;
-
-/**
- * Moves the cursor up `n` times.
- * @param n The amount of steps to move.
- */
-declare function cursorUp(n?: number): void;
-
-/**
- * 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.
- */
-export declare function editor(opts: EditorOpts): Promise<string>;
-
-/**
- * Options for opening the system editor.
- */
-export declare 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;
-}
-
-/**
- * Prompts the user to select multiple options.
- * @param opts Options for select input.
- * @returns The selected options.
- */
-export declare function multiselect<T>(opts: SelectOpts<T>): Promise<T[]>;
-
-/**
- * Prompts the user for a password.
- * @param opts Options for password input.
- * @returns The password.
- */
-export declare function password(opts: PasswordOpts): Promise<string>;
-
-/**
- * Options for password input.
- */
-export declare 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;
-}
-
-declare namespace raw {
-    export {
-        readLine,
-        readKey,
-        clearLines,
-        cursorUp,
-        cursorDown
-    }
-}
-export { raw }
-
-/**
- * Reads a single key from stdin.
- * @returns The key that was read.
- */
-declare function readKey(): Promise<string>;
-
-/**
- * Reads a line from standard input.
- * @param message The message.
- * @param def Default value.
- * @param opts Options for reading a line.
- * @returns The line that was read.
- */
-declare function readLine(message?: string, def?: string, opts?: {
-    masked?: boolean;
-    maskChar?: string;
-    multiline?: boolean;
-}): Promise<string>;
-
-/**
- * Prompts the user to search through a list of options.
- * @param opts Options for search input.
- * @returns The selected option.
- */
-export declare function search<T>(opts: SearchOpts<T>): Promise<T>;
-
-/**
- * Options for search input.
- */
-export declare 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 select a single option.
- * @param opts Options for select input.
- * @returns The selected option's value.
- */
-export declare function select<T>(opts: SelectOpts<T>): Promise<T>;
-
-/**
- * An option for select input.
- */
-export declare 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.
- */
-export declare interface SelectOpts<T> extends BaseOpts<T> {
-    /**
-     * Every option the user can pick from.
-     */
-    options: SelectOption<T>[];
-    /**
-     * The initial option selected.
-     */
-    initialIndex?: number;
-}
-
-/**
- * Sets the theme of the prompts.
- * @param t The new theme.
- */
-export declare function setTheme(t: Theme): void;
-
-/**
- * Prompts the user for text input.
- * @param opts Options for text input.
- * @returns The text the user typed in, or the default.
- */
-export declare function text(opts: TextOpts): Promise<string>;
-
-/**
- * Options for text input.
- */
-export declare 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;
-}
-
-export { }
+import { type Theme } from "../color";
+import { type StandardSchemaV1 } from "../standard-schema";
+import * as raw from "./raw";
+/**
+ * Sets the theme of the prompts.
+ * @param t The new theme.
+ */
+export declare function setTheme(t: Theme): void;
+/**
+ * Base options for prompts.
+ */
+export 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.
+ */
+export 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.
+ */
+export declare function text(opts: TextOpts): Promise<string>;
+/**
+ * Options for password input.
+ */
+export 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.
+ */
+export declare function password(opts: PasswordOpts): Promise<string>;
+/**
+ * An option for select input.
+ */
+export 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.
+ */
+export 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.
+ */
+export 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.
+ */
+export declare function multiselect<T>(opts: SelectOpts<T>): Promise<T[]>;
+/**
+ * Options for search input.
+ */
+export 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.
+ */
+export declare function search<T>(opts: SearchOpts<T>): Promise<T>;
+/**
+ * Options for confirm input.
+ */
+export 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.
+ */
+export declare function confirm(opts: ConfirmOpts): Promise<boolean>;
+/**
+ * Options for opening the system editor.
+ */
+export 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.
+ */
+export declare function editor(opts: EditorOpts): Promise<string>;
+export { raw };