@maizzle/framework 6.0.0-rc.0 → 6.0.0-rc.2

package/node_modules/@clack/prompts/dist/index.d.mts

@@ -1,26 +1,45 @@
-export { ClackSettings, isCancel, updateSettings } from '@clack/core';
+import { State, AutocompletePrompt, DateFormat } from '@clack/core';
+export { ClackSettings, DateFormat, isCancel, settings, updateSettings } from '@clack/core';
+import { Readable, Writable } from 'node:stream';
 
-interface TextOptions {
-    message: string;
-    placeholder?: string;
-    defaultValue?: string;
-    initialValue?: string;
-    validate?: (value: string) => string | Error | undefined;
+declare const unicode: boolean;
+declare const isCI: () => boolean;
+declare const isTTY: (output: Writable) => boolean;
+declare const unicodeOr: (c: string, fallback: string) => string;
+declare const S_STEP_ACTIVE: string;
+declare const S_STEP_CANCEL: string;
+declare const S_STEP_ERROR: string;
+declare const S_STEP_SUBMIT: string;
+declare const S_BAR_START: string;
+declare const S_BAR: string;
+declare const S_BAR_END: string;
+declare const S_BAR_START_RIGHT: string;
+declare const S_BAR_END_RIGHT: string;
+declare const S_RADIO_ACTIVE: string;
+declare const S_RADIO_INACTIVE: string;
+declare const S_CHECKBOX_ACTIVE: string;
+declare const S_CHECKBOX_SELECTED: string;
+declare const S_CHECKBOX_INACTIVE: string;
+declare const S_PASSWORD_MASK: string;
+declare const S_BAR_H: string;
+declare const S_CORNER_TOP_RIGHT: string;
+declare const S_CONNECT_LEFT: string;
+declare const S_CORNER_BOTTOM_RIGHT: string;
+declare const S_CORNER_BOTTOM_LEFT: string;
+declare const S_CORNER_TOP_LEFT: string;
+declare const S_INFO: string;
+declare const S_SUCCESS: string;
+declare const S_WARN: string;
+declare const S_ERROR: string;
+declare const symbol: (state: State) => string;
+declare const symbolBar: (state: State) => string;
+interface CommonOptions {
+    input?: Readable;
+    output?: Writable;
+    signal?: AbortSignal;
+    withGuide?: boolean;
 }
-declare const text: (opts: TextOptions) => Promise<string | symbol>;
-interface PasswordOptions {
-    message: string;
-    mask?: string;
-    validate?: (value: string) => string | Error | undefined;
-}
-declare const password: (opts: PasswordOptions) => Promise<string | symbol>;
-interface ConfirmOptions {
-    message: string;
-    active?: string;
-    inactive?: string;
-    initialValue?: boolean;
-}
-declare const confirm: (opts: ConfirmOptions) => Promise<boolean | symbol>;
+
 type Primitive = Readonly<string | boolean | number>;
 type Option<Value> = Value extends Primitive ? {
     /**
@@ -40,6 +59,13 @@ type Option<Value> = Value extends Primitive ? {
      * By default, no `hint` is displayed.
      */
     hint?: string;
+    /**
+     * Whether this option is disabled.
+     * Disabled options are visible but cannot be selected.
+     *
+     * By default, options are not disabled.
+     */
+    disabled?: boolean;
 } : {
     /**
      * Internal data for this option.
@@ -56,68 +82,111 @@ type Option<Value> = Value extends Primitive ? {
      * By default, no `hint` is displayed.
      */
     hint?: string;
+    /**
+     * Whether this option is disabled.
+     * Disabled options are visible but cannot be selected.
+     *
+     * By default, options are not disabled.
+     */
+    disabled?: boolean;
 };
-interface SelectOptions<Value> {
+interface SelectOptions<Value> extends CommonOptions {
     message: string;
     options: Option<Value>[];
     initialValue?: Value;
     maxItems?: number;
 }
-declare const select: <Value>(opts: SelectOptions<Value>) => Promise<symbol | Value>;
-declare const selectKey: <Value extends string>(opts: SelectOptions<Value>) => Promise<symbol | Value>;
-interface MultiSelectOptions<Value> {
+declare const select: <Value>(opts: SelectOptions<Value>) => Promise<Value | symbol>;
+
+interface AutocompleteSharedOptions<Value> extends CommonOptions {
+    /**
+     * The message to display to the user.
+     */
     message: string;
-    options: Option<Value>[];
-    initialValues?: Value[];
+    /**
+     * Available options for the autocomplete prompt.
+     */
+    options: Option<Value>[] | ((this: AutocompletePrompt<Option<Value>>) => Option<Value>[]);
+    /**
+     * Maximum number of items to display at once.
+     */
     maxItems?: number;
-    required?: boolean;
-    cursorAt?: Value;
+    /**
+     * Placeholder text to display when no input is provided.
+     */
+    placeholder?: string;
+    /**
+     * Validates the value
+     */
+    validate?: (value: Value | Value[] | undefined) => string | Error | undefined;
+    /**
+     * Custom filter function to match options against search input.
+     * If not provided, a default filter that matches label, hint, and value is used.
+     */
+    filter?: (search: string, option: Option<Value>) => boolean;
 }
-declare const multiselect: <Value>(opts: MultiSelectOptions<Value>) => Promise<symbol | Value[]>;
-interface GroupMultiSelectOptions<Value> {
-    message: string;
-    options: Record<string, Option<Value>[]>;
+interface AutocompleteOptions<Value> extends AutocompleteSharedOptions<Value> {
+    /**
+     * The initial selected value.
+     */
+    initialValue?: Value;
+    /**
+     * The initial user input
+     */
+    initialUserInput?: string;
+}
+declare const autocomplete: <Value>(opts: AutocompleteOptions<Value>) => Promise<Value | symbol>;
+interface AutocompleteMultiSelectOptions<Value> extends AutocompleteSharedOptions<Value> {
+    /**
+     * The initial selected values
+     */
     initialValues?: Value[];
+    /**
+     * If true, at least one option must be selected
+     */
     required?: boolean;
-    cursorAt?: Value;
-    selectableGroups?: boolean;
 }
-declare const groupMultiselect: <Value>(opts: GroupMultiSelectOptions<Value>) => Promise<symbol | Value[]>;
-declare const note: (message?: string, title?: string) => void;
-declare const cancel: (message?: string) => void;
-declare const intro: (title?: string) => void;
-declare const outro: (message?: string) => void;
-type LogMessageOptions = {
-    symbol?: string;
-};
-declare const log: {
-    message: (message?: string, { symbol }?: LogMessageOptions) => void;
-    info: (message: string) => void;
-    success: (message: string) => void;
-    step: (message: string) => void;
-    warn: (message: string) => void;
-    /** alias for `log.warn()`. */
-    warning: (message: string) => void;
-    error: (message: string) => void;
-};
-declare const stream: {
-    message: (iterable: Iterable<string> | AsyncIterable<string>, { symbol }?: LogMessageOptions) => Promise<void>;
-    info: (iterable: Iterable<string> | AsyncIterable<string>) => Promise<void>;
-    success: (iterable: Iterable<string> | AsyncIterable<string>) => Promise<void>;
-    step: (iterable: Iterable<string> | AsyncIterable<string>) => Promise<void>;
-    warn: (iterable: Iterable<string> | AsyncIterable<string>) => Promise<void>;
-    /** alias for `log.warn()`. */
-    warning: (iterable: Iterable<string> | AsyncIterable<string>) => Promise<void>;
-    error: (iterable: Iterable<string> | AsyncIterable<string>) => Promise<void>;
-};
-interface SpinnerOptions {
-    indicator?: 'dots' | 'timer';
+/**
+ * Integrated autocomplete multiselect - combines type-ahead filtering with multiselect in one UI
+ */
+declare const autocompleteMultiselect: <Value>(opts: AutocompleteMultiSelectOptions<Value>) => Promise<Value[] | symbol>;
+
+type BoxAlignment = 'left' | 'center' | 'right';
+interface BoxOptions extends CommonOptions {
+    contentAlign?: BoxAlignment;
+    titleAlign?: BoxAlignment;
+    width?: number | 'auto';
+    titlePadding?: number;
+    contentPadding?: number;
+    rounded?: boolean;
+    formatBorder?: (text: string) => string;
 }
-declare const spinner: ({ indicator }?: SpinnerOptions) => {
-    start: (msg?: string) => void;
-    stop: (msg?: string, code?: number) => void;
-    message: (msg?: string) => void;
-};
+declare const box: (message?: string, title?: string, opts?: BoxOptions) => void;
+
+interface ConfirmOptions extends CommonOptions {
+    message: string;
+    active?: string;
+    inactive?: string;
+    initialValue?: boolean;
+    vertical?: boolean;
+}
+declare const confirm: (opts: ConfirmOptions) => Promise<boolean | symbol>;
+
+interface DateOptions extends CommonOptions {
+    message: string;
+    format?: DateFormat;
+    locale?: string;
+    defaultValue?: Date;
+    initialValue?: Date;
+    minDate?: Date;
+    maxDate?: Date;
+    validate?: (value: Date | undefined) => string | Error | undefined;
+}
+declare const date: (opts: DateOptions) => Promise<Date | symbol>;
+
+type Prettify<T> = {
+    [P in keyof T]: T[P];
+} & {};
 type PromptGroupAwaitedReturn<T> = {
     [P in keyof T]: Exclude<Awaited<T[P]>, symbol>;
 };
@@ -130,9 +199,6 @@ interface PromptGroupOptions<T> {
         results: Prettify<Partial<PromptGroupAwaitedReturn<T>>>;
     }) => void;
 }
-type Prettify<T> = {
-    [P in keyof T]: T[P];
-} & {};
 type PromptGroup<T> = {
     [P in keyof T]: (opts: {
         results: Prettify<Partial<PromptGroupAwaitedReturn<Omit<T, P>>>>;
@@ -142,7 +208,131 @@ type PromptGroup<T> = {
  * Define a group of prompts to be displayed
  * and return a results of objects within the group
  */
-declare const group: <T>(prompts: PromptGroup<T>, opts?: PromptGroupOptions<T> | undefined) => Promise<{ [P in keyof PromptGroupAwaitedReturn<T>]: PromptGroupAwaitedReturn<T>[P]; }>;
+declare const group: <T>(prompts: PromptGroup<T>, opts?: PromptGroupOptions<T>) => Promise<Prettify<PromptGroupAwaitedReturn<T>>>;
+
+interface GroupMultiSelectOptions<Value> extends CommonOptions {
+    message: string;
+    options: Record<string, Option<Value>[]>;
+    initialValues?: Value[];
+    required?: boolean;
+    cursorAt?: Value;
+    selectableGroups?: boolean;
+    groupSpacing?: number;
+}
+declare const groupMultiselect: <Value>(opts: GroupMultiSelectOptions<Value>) => Promise<Value[] | symbol>;
+
+interface LimitOptionsParams<TOption> extends CommonOptions {
+    options: TOption[];
+    cursor: number;
+    style: (option: TOption, active: boolean) => string;
+    maxItems?: number;
+    columnPadding?: number;
+    rowPadding?: number;
+}
+declare const limitOptions: <TOption>({ cursor, options, style, output, maxItems, columnPadding, rowPadding, }: LimitOptionsParams<TOption>) => string[];
+
+interface LogMessageOptions extends CommonOptions {
+    symbol?: string;
+    spacing?: number;
+    secondarySymbol?: string;
+}
+declare const log: {
+    message: (message?: string | string[], { symbol, secondarySymbol, output, spacing, withGuide, }?: LogMessageOptions) => void;
+    info: (message: string, opts?: LogMessageOptions) => void;
+    success: (message: string, opts?: LogMessageOptions) => void;
+    step: (message: string, opts?: LogMessageOptions) => void;
+    warn: (message: string, opts?: LogMessageOptions) => void;
+    /** alias for `log.warn()`. */
+    warning: (message: string, opts?: LogMessageOptions) => void;
+    error: (message: string, opts?: LogMessageOptions) => void;
+};
+
+declare const cancel: (message?: string, opts?: CommonOptions) => void;
+declare const intro: (title?: string, opts?: CommonOptions) => void;
+declare const outro: (message?: string, opts?: CommonOptions) => void;
+
+interface MultiSelectOptions<Value> extends CommonOptions {
+    message: string;
+    options: Option<Value>[];
+    initialValues?: Value[];
+    maxItems?: number;
+    required?: boolean;
+    cursorAt?: Value;
+}
+declare const multiselect: <Value>(opts: MultiSelectOptions<Value>) => Promise<Value[] | symbol>;
+
+type FormatFn = (line: string) => string;
+interface NoteOptions extends CommonOptions {
+    format?: FormatFn;
+}
+declare const note: (message?: string, title?: string, opts?: NoteOptions) => void;
+
+interface PasswordOptions extends CommonOptions {
+    message: string;
+    mask?: string;
+    validate?: (value: string | undefined) => string | Error | undefined;
+    clearOnError?: boolean;
+}
+declare const password: (opts: PasswordOptions) => Promise<string | symbol>;
+
+interface PathOptions extends CommonOptions {
+    root?: string;
+    directory?: boolean;
+    initialValue?: string;
+    message: string;
+    validate?: (value: string | undefined) => string | Error | undefined;
+}
+declare const path: (opts: PathOptions) => Promise<string | symbol>;
+
+interface SpinnerOptions extends CommonOptions {
+    indicator?: 'dots' | 'timer';
+    onCancel?: () => void;
+    cancelMessage?: string;
+    errorMessage?: string;
+    frames?: string[];
+    delay?: number;
+    styleFrame?: (frame: string) => string;
+}
+interface SpinnerResult {
+    start(msg?: string): void;
+    stop(msg?: string): void;
+    cancel(msg?: string): void;
+    error(msg?: string): void;
+    message(msg?: string): void;
+    clear(): void;
+    readonly isCancelled: boolean;
+}
+declare const spinner: ({ indicator, onCancel, output, cancelMessage, errorMessage, frames, delay, signal, ...opts }?: SpinnerOptions) => SpinnerResult;
+
+interface ProgressOptions extends SpinnerOptions {
+    style?: 'light' | 'heavy' | 'block';
+    max?: number;
+    size?: number;
+}
+interface ProgressResult extends SpinnerResult {
+    advance(step?: number, msg?: string): void;
+}
+declare function progress({ style, max: userMax, size: userSize, ...spinnerOptions }?: ProgressOptions): ProgressResult;
+
+interface SelectKeyOptions<Value extends string> extends CommonOptions {
+    message: string;
+    options: Option<Value>[];
+    initialValue?: Value;
+    caseSensitive?: boolean;
+}
+declare const selectKey: <Value extends string>(opts: SelectKeyOptions<Value>) => Promise<Value | symbol>;
+
+declare const stream: {
+    message: (iterable: Iterable<string> | AsyncIterable<string>, { symbol }?: LogMessageOptions) => Promise<void>;
+    info: (iterable: Iterable<string> | AsyncIterable<string>) => Promise<void>;
+    success: (iterable: Iterable<string> | AsyncIterable<string>) => Promise<void>;
+    step: (iterable: Iterable<string> | AsyncIterable<string>) => Promise<void>;
+    warn: (iterable: Iterable<string> | AsyncIterable<string>) => Promise<void>;
+    /** alias for `log.warn()`. */
+    warning: (iterable: Iterable<string> | AsyncIterable<string>) => Promise<void>;
+    error: (iterable: Iterable<string> | AsyncIterable<string>) => Promise<void>;
+};
+
 type Task = {
     /**
      * Task title
@@ -160,6 +350,42 @@ type Task = {
 /**
  * Define a group of tasks to be executed
  */
-declare const tasks: (tasks: Task[]) => Promise<void>;
+declare const tasks: (tasks: Task[], opts?: CommonOptions) => Promise<void>;
+
+interface TaskLogOptions extends CommonOptions {
+    title: string;
+    limit?: number;
+    spacing?: number;
+    retainLog?: boolean;
+}
+interface TaskLogMessageOptions {
+    raw?: boolean;
+}
+interface TaskLogCompletionOptions {
+    showLog?: boolean;
+}
+/**
+ * Renders a log which clears on success and remains on failure
+ */
+declare const taskLog: (opts: TaskLogOptions) => {
+    message(msg: string, mopts?: TaskLogMessageOptions): void;
+    group(name: string): {
+        message(msg: string, mopts?: TaskLogMessageOptions): void;
+        error(message: string): void;
+        success(message: string): void;
+    };
+    error(message: string, opts?: TaskLogCompletionOptions): void;
+    success(message: string, opts?: TaskLogCompletionOptions): void;
+};
+
+interface TextOptions extends CommonOptions {
+    message: string;
+    placeholder?: string;
+    defaultValue?: string;
+    initialValue?: string;
+    validate?: (value: string | undefined) => string | Error | undefined;
+}
+declare const text: (opts: TextOptions) => Promise<string | symbol>;
 
-export { type ConfirmOptions, type GroupMultiSelectOptions, type LogMessageOptions, type MultiSelectOptions, type Option, type PasswordOptions, type PromptGroup, type PromptGroupAwaitedReturn, type PromptGroupOptions, type SelectOptions, type SpinnerOptions, type Task, type TextOptions, cancel, confirm, group, groupMultiselect, intro, log, multiselect, note, outro, password, select, selectKey, spinner, stream, tasks, text };
+export { S_BAR, S_BAR_END, S_BAR_END_RIGHT, S_BAR_H, S_BAR_START, S_BAR_START_RIGHT, S_CHECKBOX_ACTIVE, S_CHECKBOX_INACTIVE, S_CHECKBOX_SELECTED, S_CONNECT_LEFT, S_CORNER_BOTTOM_LEFT, S_CORNER_BOTTOM_RIGHT, S_CORNER_TOP_LEFT, S_CORNER_TOP_RIGHT, S_ERROR, S_INFO, S_PASSWORD_MASK, S_RADIO_ACTIVE, S_RADIO_INACTIVE, S_STEP_ACTIVE, S_STEP_CANCEL, S_STEP_ERROR, S_STEP_SUBMIT, S_SUCCESS, S_WARN, autocomplete, autocompleteMultiselect, box, cancel, confirm, date, group, groupMultiselect, intro, isCI, isTTY, limitOptions, log, multiselect, note, outro, password, path, progress, select, selectKey, spinner, stream, symbol, symbolBar, taskLog, tasks, text, unicode, unicodeOr };
+export type { AutocompleteMultiSelectOptions, AutocompleteOptions, BoxAlignment, BoxOptions, CommonOptions, ConfirmOptions, DateOptions, GroupMultiSelectOptions, LimitOptionsParams, LogMessageOptions, MultiSelectOptions, NoteOptions, Option, PasswordOptions, PathOptions, ProgressOptions, ProgressResult, PromptGroup, PromptGroupAwaitedReturn, PromptGroupOptions, SelectKeyOptions, SelectOptions, SpinnerOptions, SpinnerResult, Task, TaskLogCompletionOptions, TaskLogMessageOptions, TaskLogOptions, TextOptions };