@hot-updater/cli-tools 0.35.7 → 0.35.9

package/dist/index.d.mts

@@ -296,6 +296,20 @@ declare const createHotUpdaterConfigScaffoldFromBuilder: (builder: ConfigBuilder
 }?: CreateHotUpdaterConfigScaffoldFromBuilderOptions) => HotUpdaterConfigScaffold;
 declare const writeHotUpdaterConfig: (scaffold: HotUpdaterConfigScaffold, filePath?: string) => Promise<WriteHotUpdaterConfigResult>;
 //#endregion
+//#region src/hotUpdaterEnv.d.ts
+type HotUpdaterInitEnv = {
+  readonly env: Readonly<Record<string, string>>;
+  readonly inputEnv?: Readonly<Record<string, string>>;
+  readonly managedEnv: Readonly<Record<string, string>>;
+};
+declare const getHotUpdaterInitInputEnv: ({
+  env,
+  managedEnv
+}: HotUpdaterInitEnv, nonInteractive: boolean) => Readonly<Record<string, string>>;
+declare const readHotUpdaterInitEnv: (cwd: string, envFile?: string) => Promise<HotUpdaterInitEnv>;
+declare const readHotUpdaterEnv: (cwd: string) => Promise<Readonly<Record<string, string>>>;
+declare const getHotUpdaterEnvValue: (env: Readonly<Record<string, string>>, key: string) => string | undefined;
+//#endregion
 //#region src/HotUpdateDirUtil.d.ts
 declare const HotUpdateDirUtil: {
   readonly dirName: ".hot-updater";
@@ -320,6 +334,113 @@ declare const HotUpdateDirUtil: {
   }) => string;
 };
 //#endregion
+//#region src/initProvider.d.ts
+type InitProviderInputPersistence = "always" | "with-consent";
+type InitProviderInputDefinition = {
+  readonly envKey: string;
+  readonly help: string;
+  readonly optional?: boolean;
+  readonly persistence?: InitProviderInputPersistence;
+  readonly preflight?: boolean;
+  readonly prompt?: {
+    readonly defaultValue?: string;
+    readonly message: string;
+    readonly placeholder?: string;
+    readonly type: "confirm" | "password" | "select" | "text";
+  };
+  readonly requiredWhen?: (inputs: Readonly<Record<string, string | undefined>>) => boolean;
+  readonly requirementHint?: string;
+  readonly validate?: (value: string | undefined) => boolean;
+};
+type InitProviderTextPromptDefinition = {
+  readonly defaultValue?: string;
+  readonly message: string;
+  readonly placeholder?: string;
+  readonly type: "text";
+};
+type InitProviderInputsDefinition = Readonly<Record<string, InitProviderInputDefinition>>;
+type InitProviderDefinition<TInputs extends InitProviderInputsDefinition = InitProviderInputsDefinition> = {
+  readonly inputs: TInputs;
+  readonly label: string;
+};
+declare const defineInitProvider: <const TInputs extends InitProviderInputsDefinition>(provider: InitProviderDefinition<TInputs>) => InitProviderDefinition<TInputs>;
+declare const shouldAutoSelectOnlyInitResource: ({
+  availableResourceCount,
+  savedIdentifier
+}: {
+  readonly availableResourceCount: number;
+  readonly savedIdentifier?: string;
+}) => boolean;
+declare const getInitProviderTextPromptValues: (prompt: InitProviderTextPromptDefinition, savedValue?: string) => {
+  initialValue: string | undefined;
+  placeholder: string | undefined;
+};
+declare const resolveInitProviderInput: (env: Readonly<Record<string, string>>, input: InitProviderInputDefinition) => string | undefined;
+declare const resolveInitProviderInputs: (env: Readonly<Record<string, string>>, provider: InitProviderDefinition) => Readonly<Record<string, string | undefined>>;
+declare const getMissingInitProviderInputs: ({
+  inputs,
+  preflightOnly,
+  provider
+}: {
+  readonly inputs: Readonly<Record<string, string | undefined>>;
+  readonly preflightOnly?: boolean;
+  readonly provider: InitProviderDefinition;
+}) => readonly string[];
+declare const assertInitProviderInputs: <TInputs extends InitProviderInputsDefinition>({
+  inputs,
+  provider,
+  strict
+}: {
+  readonly inputs: Readonly<Record<string, string | undefined>>;
+  readonly provider: InitProviderDefinition<TInputs>;
+  readonly strict?: boolean;
+}) => void;
+declare const confirmInitInputPersistence: <TInputs extends InitProviderInputsDefinition>({
+  existingEnv,
+  inputs,
+  nonInteractive,
+  provider
+}: {
+  readonly existingEnv: Readonly<Record<string, string>>;
+  readonly inputs: Readonly<Record<string, string | undefined>>;
+  readonly nonInteractive: boolean;
+  readonly provider: InitProviderDefinition<TInputs>;
+}) => Promise<boolean>;
+declare const getInitProviderEnvVars: <TInputs extends InitProviderInputsDefinition>({
+  includeConsentInputs,
+  inputs,
+  provider
+}: {
+  readonly includeConsentInputs: boolean;
+  readonly inputs: Readonly<Record<string, string | undefined>>;
+  readonly provider: InitProviderDefinition<TInputs>;
+}) => Record<string, string>;
+//#endregion
+//#region src/initOptions.d.ts
+type RunInitOptions = {
+  readonly build: BuildType;
+  readonly envFile?: string;
+};
+declare class InitError extends Error {
+  readonly name: string;
+}
+declare class MissingInitInputsError extends InitError {
+  readonly missingInputs: readonly string[];
+  readonly name = "MissingInitInputsError";
+  constructor(missingInputs: readonly string[]);
+}
+declare class InitEnvFileError extends InitError {
+  readonly name = "InitEnvFileError";
+}
+declare const assertInitInputs: ({
+  inputs,
+  strict
+}: {
+  readonly inputs: Readonly<Record<string, string | undefined>>;
+  readonly strict?: boolean;
+}) => void;
+declare const getMissingInitInputs: (inputs: Readonly<Record<string, string | undefined>>) => readonly string[];
+//#endregion
 //#region src/LogWriter.d.ts
 type HotUpdaterLogWriter = {
   logFilePath: string | null;
@@ -360,7 +481,8 @@ type EnvVarValue = string | {
   value: string;
 };
 declare const makeEnv: (newEnvVars: Record<string, EnvVarValue>, filePath?: string, options?: {
-  preserveKeys?: string[];
+  readonly preserveKeys?: readonly string[];
+  readonly removeKeys?: readonly string[];
 }) => Promise<string>;
 //#endregion
 //#region src/promoteBundle.d.ts
@@ -422,7 +544,7 @@ declare function promoteBundle({
   targetChannel
 }: PromoteBundleInput, deps: PromoteBundleDependencies): Promise<Bundle>;
 //#endregion
-//#region ../../node_modules/.pnpm/@clack+core@1.0.1/node_modules/@clack/core/dist/index.d.mts
+//#region ../../node_modules/.pnpm/@clack+core@1.4.3/node_modules/@clack/core/dist/index.d.mts
 declare const actions: readonly ["up", "down", "left", "right", "space", "enter", "cancel"];
 type Action = (typeof actions)[number];
 /** Global settings for Clack programs, stored in memory */
@@ -434,6 +556,16 @@ interface InternalClackSettings {
     error: string;
   };
   withGuide: boolean;
+  date: {
+    monthNames: string[];
+    messages: {
+      invalidMonth: string;
+      required: string;
+      invalidDay: (days: number, month: string) => string;
+      afterMin: (min: Date) => string;
+      beforeMax: (max: Date) => string;
+    };
+  };
 }
 declare const settings: InternalClackSettings;
 interface ClackSettings {
@@ -461,6 +593,19 @@ interface ClackSettings {
     error?: string;
   };
   withGuide?: boolean;
+  /**
+   * Date prompt localization
+   */
+  date?: {
+    /** Month names for validation messages (January, February, ...) */monthNames?: string[];
+    messages?: {
+      /** Shown when date is missing */required?: string; /** Shown when month > 12 */
+      invalidMonth?: string; /** (days, monthName) => message for invalid day */
+      invalidDay?: (days: number, month: string) => string; /** (min) => message when date is before minDate */
+      afterMin?: (min: Date) => string; /** (max) => message when date is after maxDate */
+      beforeMax?: (max: Date) => string;
+    };
+  };
 }
 declare function updateSettings(updates: ClackSettings): void;
 /**
@@ -484,14 +629,116 @@ interface ClackEvents<TValue> {
   finalize: () => void;
   beforePrompt: () => void;
 }
+/** The Standard Schema interface. */
+interface StandardSchemaV1<Input = unknown, Output = Input> {
+  /** The Standard Schema properties. */
+  readonly '~standard': StandardSchemaV1.Props<Input, Output>;
+}
+declare namespace StandardSchemaV1 {
+  /** The Standard Schema properties interface. */
+  interface Props<Input = unknown, Output = Input> {
+    /** The version number of the standard. */
+    readonly version: 1;
+    /** The vendor name of the schema library. */
+    readonly vendor: string;
+    /** Validates unknown input values. */
+    readonly validate: (value: unknown, options?: StandardSchemaV1.Options | undefined) => Result<Output> | Promise<Result<Output>>;
+    /** Inferred types associated with the schema. */
+    readonly types?: Types<Input, Output> | undefined;
+  }
+  /** The result interface of the validate function. */
+  type Result<Output> = SuccessResult<Output> | FailureResult;
+  /** The result interface if validation succeeds. */
+  interface SuccessResult<Output> {
+    /** The typed output value. */
+    readonly value: Output;
+    /** A falsy value for `issues` indicates success. */
+    readonly issues?: undefined;
+  }
+  interface Options {
+    /** Explicit support for additional vendor-specific parameters, if needed. */
+    readonly libraryOptions?: Record<string, unknown> | undefined;
+  }
+  /** The result interface if validation fails. */
+  interface FailureResult {
+    /** The issues of failed validation. */
+    readonly issues: ReadonlyArray<Issue>;
+  }
+  /** The issue interface of the failure output. */
+  interface Issue {
+    /** The error message of the issue. */
+    readonly message: string;
+    /** The path of the issue, if any. */
+    readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
+  }
+  /** The path segment interface of the issue. */
+  interface PathSegment {
+    /** The key representing a path segment. */
+    readonly key: PropertyKey;
+  }
+  /** The Standard Schema types interface. */
+  interface Types<Input = unknown, Output = Input> {
+    /** The input type of the schema. */
+    readonly input: Input;
+    /** The output type of the schema. */
+    readonly output: Output;
+  }
+  /** Infers the input type of a Standard Schema. */
+  type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
+  /** Infers the output type of a Standard Schema. */
+  type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
+}
+/**
+ * A function or [Standard Schema](https://github.com/standard-schema/standard-schema)
+ * that validates user input. If a custom function is given, you should return a
+ * `string` or `Error` to show as a validation error, or `undefined` to accept the result.
+ *
+ * @example Using arktype
+ * ```ts
+ * import { text } from '@clack/prompts';
+ * import { type } from 'arktype';
+ *
+ * const name = await text({
+ *   message: 'Enter your name (letters only)',
+ *   validate: type('string.alpha').describe('Name can only contain letters'),
+ * });
+ * ```
+ *
+ * @example Custom validator
+ * ```ts
+ * import { text } from '@clack/prompts';
+ *
+ * const age = await text({
+ *   message: 'Enter your age:',
+ *   validate(value) {
+ *     if (!value) return 'Please enter a value';
+ *     const num = parseInt(value);
+ *     if (isNaN(num)) return 'Please enter a valid number';
+ *     if (num < 0 || num > 120) return 'Age must be between 0 and 120';
+ *     return undefined;
+ *   },
+ * });
+ * ```
+ */
+type Validate<TValue> = ((value: TValue | undefined) => string | Error | undefined) | StandardSchemaV1<TValue | undefined, unknown>;
+/**
+ * Runs the `validate()` option and normalizes the result
+ * @param validate - The validate option
+ * @param value - The user input
+ * @returns the validation result
+ */
 interface PromptOptions<TValue, Self extends Prompt<TValue>> {
   render(this: Omit<Self, 'prompt'>): string | undefined;
   initialValue?: any;
   initialUserInput?: string;
-  validate?: ((value: TValue | undefined) => string | Error | undefined) | undefined;
+  /**
+   * A function or a [Standard Schema](https://github.com/standard-schema/standard-schema)
+   * that validates user input. If a custom function is given, you should return a `string` or `Error`
+   * to show as a validation error, or `undefined` to accept the result.
+   */
+  validate?: Validate<TValue> | undefined;
   input?: Readable$1;
   output?: Writable;
-  debug?: boolean;
   signal?: AbortSignal;
 }
 declare class Prompt<TValue> {
@@ -539,6 +786,7 @@ declare class Prompt<TValue> {
   emit<T extends keyof ClackEvents<TValue>>(event: T, ...data: Parameters<ClackEvents<TValue>[T]>): void;
   prompt(): Promise<symbol | TValue | undefined>;
   protected _isActionKey(char: string | undefined, _key: Key$1): boolean;
+  protected _shouldSubmit(_char: string | undefined, _key: Key$1): boolean;
   protected _setValue(value: TValue | undefined): void;
   protected _setUserInput(value: string | undefined, write?: boolean): void;
   protected _clearUserInput(): void;
@@ -557,6 +805,13 @@ interface AutocompleteOptions$1<T extends OptionLike$1> extends PromptOptions<T[
   options: T[] | ((this: AutocompletePrompt<T>) => T[]);
   filter?: FilterFunction<T>;
   multiple?: boolean;
+  /**
+   * When set (non-empty), pressing Tab with no input fills the field with this value
+   * and runs the normal filter/selection logic so the user can confirm with Enter.
+   * Tab only fills the input when the placeholder matches at least one option under
+   * the prompt's filter (so the value remains selectable).
+   */
+  placeholder?: string;
 }
 declare class AutocompletePrompt<T extends OptionLike$1> extends Prompt<T['value'] | T['value'][]> {
   #private;
@@ -573,9 +828,10 @@ declare class AutocompletePrompt<T extends OptionLike$1> extends Prompt<T['value
   deselectAll(): void;
   toggleSelected(value: T['value']): void;
 }
+type DateFormat = 'YMD' | 'MDY' | 'DMY';
 declare function isCancel(value: unknown): value is symbol;
 declare namespace index_d_exports {
-  export { AutocompleteMultiSelectOptions, AutocompleteOptions, BoxAlignment, BoxOptions, ClackSettings, CommonOptions, ConfirmOptions, GroupMultiSelectOptions, LimitOptionsParams, LogMessageOptions, MultiSelectOptions, NoteOptions, Option, PasswordOptions, PathOptions, ProgressOptions, ProgressResult, PromptGroup, PromptGroupAwaitedReturn, PromptGroupOptions, 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, SelectKeyOptions, SelectOptions, SpinnerOptions, SpinnerResult, Task, TaskLogCompletionOptions, TaskLogMessageOptions, TaskLogOptions, TextOptions, autocomplete, autocompleteMultiselect, box, cancel, confirm, group, groupMultiselect, intro, isCI, isCancel, isTTY, limitOptions, log$1 as log, multiselect, note, outro, password, path, progress, select, selectKey, settings, spinner, stream, symbol, symbolBar, taskLog, tasks, text, unicode, unicodeOr, updateSettings };
+  export { AutocompleteMultiSelectOptions, AutocompleteOptions, BoxAlignment, BoxOptions, ClackSettings, CommonOptions, ConfirmOptions, DateFormat, DateOptions, GroupMultiSelectOptions, LimitOptionsParams, LogMessageOptions, MULTISELECT_INSTRUCTIONS, MultiLineOptions, MultiSelectOptions, NoteOptions, Option, PasswordOptions, PathOptions, ProgressOptions, ProgressResult, PromptGroup, PromptGroupAwaitedReturn, PromptGroupOptions, SELECT_INSTRUCTIONS, 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, SelectKeyOptions, SelectOptions, SpinnerOptions, SpinnerResult, Task, TaskLogCompletionOptions, TaskLogMessageOptions, TaskLogOptions, TextOptions, autocomplete, autocompleteMultiselect, box, cancel, confirm, date, formatInstructionFooter, group, groupMultiselect, intro, isCI, isCancel, isTTY, limitOptions, log$1 as log, multiline, multiselect, note, outro, password, path, progress, select, selectKey, settings, spinner, stream, symbol, symbolBar, taskLog, tasks, text, unicode, unicodeOr, updateSettings };
 }
 declare const unicode: boolean;
 declare const isCI: () => boolean;
@@ -614,6 +870,8 @@ interface CommonOptions {
   signal?: AbortSignal;
   withGuide?: boolean;
 }
+declare function formatInstructionFooter(instructions: string[], hasGuide: boolean): string[];
+declare const SELECT_INSTRUCTIONS: string[];
 type Primitive = Readonly<string | boolean | number>;
 type Option<Value> = Value extends Primitive ? {
   /**
@@ -669,117 +927,487 @@ interface SelectOptions<Value> extends CommonOptions {
   options: Option<Value>[];
   initialValue?: Value;
   maxItems?: number;
+  /**
+   * Show keyboard instructions below the option list.
+   * @default true
+   */
+  showInstructions?: boolean;
 }
 declare const select: <Value>(opts: SelectOptions<Value>) => Promise<Value | symbol>;
+/**
+ * Options for the {@link autocomplete} prompt.
+ */
 interface AutocompleteSharedOptions<Value> extends CommonOptions {
   /**
-   * The message to display to the user.
+   * The message or question shown to the user above the input.
    */
   message: string;
   /**
-   * Available options for the autocomplete prompt.
+   * The options to present, or a function that returns the options to present
+   * allowing for custom search/filtering.
+   *
+   * @see https://bomb.sh/docs/clack/packages/prompts/#dynamic-options-getter
    */
   options: Option<Value>[] | ((this: AutocompletePrompt<Option<Value>>) => Option<Value>[]);
   /**
-   * Maximum number of items to display at once.
+   * The maximum number of items/options to display in the autocomplete list at once.
    */
   maxItems?: number;
   /**
-   * Placeholder text to display when no input is provided.
+   * Placeholder text displayed when the search field is empty. When set, pressing
+   * tab copies the placeholder into the input.
    */
   placeholder?: string;
   /**
-   * Validates the value
+   * A function or a [Standard Schema](https://github.com/standard-schema/standard-schema)
+   * that validates user input. If a custom function is given, you should return a `string` or `Error`
+   * to show as a validation error, or `undefined` to accept the result.
    */
-  validate?: (value: Value | Value[] | undefined) => string | Error | undefined;
+  validate?: Validate<Value | Value[]>;
   /**
-   * Custom filter function to match options against search input.
-   * If not provided, a default filter that matches label, hint, and value is used.
+   * Custom filter function to match options against the search input.
    */
   filter?: (search: string, option: Option<Value>) => boolean;
 }
 interface AutocompleteOptions<Value> extends AutocompleteSharedOptions<Value> {
   /**
-   * The initial selected value.
+   * The initially selected option from the list.
    */
   initialValue?: Value;
   /**
-   * The initial user input
+   * The starting value shown in the users input box.
    */
   initialUserInput?: string;
 }
+/**
+ * The `autocomplete` prompt combines a text input with a searchable list of options.
+ * It's perfect for when you have a large list of options and want to help users
+ * find what they're looking for quickly.
+ *
+ * @see https://bomb.sh/docs/clack/packages/prompts/#autocomplete
+ *
+ * @example
+ * ```ts
+ * import { autocomplete } from '@clack/prompts';
+ *
+ * const framework = await autocomplete({
+ *   message: 'Search for a framework',
+ *   options: [
+ *     { value: 'next', label: 'Next.js', hint: 'React framework' },
+ *     { value: 'astro', label: 'Astro', hint: 'Content-focused' },
+ *     { value: 'svelte', label: 'SvelteKit', hint: 'Compile-time framework' },
+ *     { value: 'remix', label: 'Remix', hint: 'Full stack framework' },
+ *     { value: 'nuxt', label: 'Nuxt', hint: 'Vue framework' },
+ *   ],
+ *   placeholder: 'Type to search...',
+ *   maxItems: 5,
+ * });
+ * ```
+ */
 declare const autocomplete: <Value>(opts: AutocompleteOptions<Value>) => Promise<Value | symbol>;
+/**
+ * Options for the {@link autocompleteMultiselect} prompt
+ */
 interface AutocompleteMultiSelectOptions<Value> extends AutocompleteSharedOptions<Value> {
   /**
-   * The initial selected values
+   * The initially selected option(s) from the list.
    */
   initialValues?: Value[];
   /**
-   * If true, at least one option must be selected
+   * When `true` at least one option must be selected.
+   * @default false
    */
   required?: boolean;
 }
 /**
- * Integrated autocomplete multiselect - combines type-ahead filtering with multiselect in one UI
+ * The `autocompleteMultiselect` prompt combines the search functionality of autocomplete
+ * with the ability to select multiple options.
+ *
+ * @see https://bomb.sh/docs/clack/packages/prompts/#autocomplete-multiselect
+ *
+ * @example
+ * ```ts
+ * import { autocompleteMultiselect } from '@clack/prompts';
+ *
+ * const frameworks = await autocompleteMultiselect({
+ *   message: 'Select frameworks',
+ *   options: [
+ *     { value: 'next', label: 'Next.js', hint: 'React framework' },
+ *     { value: 'astro', label: 'Astro', hint: 'Content-focused' },
+ *     { value: 'svelte', label: 'SvelteKit', hint: 'Compile-time framework' },
+ *     { value: 'remix', label: 'Remix', hint: 'Full stack framework' },
+ *     { value: 'nuxt', label: 'Nuxt', hint: 'Vue framework' },
+ *   ],
+ *   placeholder: 'Type to search...',
+ *   maxItems: 5,
+ * });
+ * ```
  */
 declare const autocompleteMultiselect: <Value>(opts: AutocompleteMultiSelectOptions<Value>) => Promise<Value[] | symbol>;
+/**
+ * Alignment for content or titles within the box.
+ */
 type BoxAlignment = 'left' | 'center' | 'right';
+/**
+ * Options for the {@link box} prompt.
+ */
 interface BoxOptions extends CommonOptions {
+  /**
+   * Alignment of the content (`'left'`, `'center'`, or `'right'`).
+   * @default 'left'
+   */
   contentAlign?: BoxAlignment;
+  /**
+   * Alignment of the title (`'left'`, `'center'`, or `'right'`).
+   * @default 'left'
+   */
   titleAlign?: BoxAlignment;
+  /**
+   * The width of the box, either `'auto'` to fit the content or a number for a fixed width.
+   * @default 'auto'
+   */
   width?: number | 'auto';
+  /**
+   * Padding around the title.
+   * @default 1
+   */
   titlePadding?: number;
+  /**
+   * Padding around the content.
+   * @default 2
+   */
   contentPadding?: number;
+  /**
+   * Use rounded corners when `true`, square corners when `false`.
+   * @default true
+   */
   rounded?: boolean;
+  /**
+   * Custom function to style the border characters.
+   */
   formatBorder?: (text: string) => string;
 }
+/**
+ * Renders a customizable box around text content. It's similar to {@link note} but offers
+ * more styling options.
+ *
+ * @see https://bomb.sh/docs/clack/packages/prompts/#box
+ *
+ * @param message - The content to display inside the box.
+ * @param title - The title to display in the top border of the box.
+ * @param opts - Optional configuration for the box styling and behavior.
+ *
+ * @example
+ * ```ts
+ * import { box } from '@clack/prompts';
+ *
+ * box('This is the content of the box', 'Box Title', {
+ *   contentAlign: 'center',
+ *   titleAlign: 'center',
+ *   width: 'auto',
+ *   rounded: true,
+ * });
+ * ```
+ */
 declare const box: (message?: string, title?: string, opts?: BoxOptions) => void;
+/**
+ * Options for the {@link confirm} prompt.
+ */
 interface ConfirmOptions extends CommonOptions {
+  /**
+   * The message or question shown to the user above the input.
+   */
   message: string;
+  /**
+   * The label to use for the active (true) option.
+   * @default 'Yes'
+   */
   active?: string;
+  /**
+   * The label to use for the inactive (false) option.
+   * @default 'No'
+   */
   inactive?: string;
+  /**
+   * The initial selected value (true or false).
+   * @default true
+   */
   initialValue?: boolean;
+  /**
+   * Whether to render the options vertically instead of horizontally.
+   * @default false
+   */
   vertical?: boolean;
 }
+/**
+ * The `confirm` prompt accepts a yes or no choice, returning a boolean value
+ * corresponding to the user's selection.
+ *
+ * @see https://bomb.sh/docs/clack/packages/prompts/#confirmation
+ *
+ * @example
+ * ```ts
+ * import { confirm } from '@clack/prompts';
+ *
+ * const shouldProceed = await confirm({
+ *   message: 'Do you want to continue?',
+ * });
+ * ```
+ */
 declare const confirm: (opts: ConfirmOptions) => Promise<boolean | symbol>;
+/**
+ * Options for the {@link date} prompt.
+ */
+interface DateOptions extends CommonOptions {
+  /**
+   * The message or question shown to the user above the input.
+   */
+  message: string;
+  /**
+   * The date format for the input segments.
+   * @deafult based on locale
+   */
+  format?: DateFormat;
+  /**
+   * The BCP 47 language tag to use for formatting
+   * @see https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag
+   * @example "en-GB"
+   */
+  locale?: string;
+  /**
+   * The default value returned when the user doesn't select a date.
+   */
+  defaultValue?: Date;
+  /**
+   * The starting date shown when the prompt first renders.
+   * Users can edit this value before submitting.
+   */
+  initialValue?: Date;
+  /**
+   * The minimum allowed date for validation.
+   */
+  minDate?: Date;
+  /**
+   * The maximum allowed date for validation.
+   */
+  maxDate?: Date;
+  /**
+   * A function or a [Standard Schema](https://github.com/standard-schema/standard-schema)
+   * that validates user input. If a custom function is given, you should return a `string` or `Error`
+   * to show as a validation error, or `undefined` to accept the result.
+   */
+  validate?: Validate<Date>;
+}
+/**
+ * The `date` prompt provides an interactive date picker, allowing users
+ * to navigate between year, month, and day segments and
+ * increment/decrement values using keyboard controls.
+ *
+ * @see https://bomb.sh/docs/clack/packages/prompts/#date-input
+ *
+ * @example
+ * ```ts
+ * import { date } from '@clack/prompts';
+ *
+ * const birthday = await date({
+ *   message: 'Pick your birthday',
+ *   minDate: new Date('1900-01-01'),
+ *   initialValue: new Date(),
+ *   maxDate: new Date(),
+ * });
+ * ```
+ */
+declare const date: (opts: DateOptions) => Promise<Date | symbol>;
 type Prettify<T> = { [P in keyof T]: T[P] } & {};
+/**
+ * The return type of a {@link PromptGroup}.
+ * Resolves all prompt results, excluding the cancel symbol.
+ */
 type PromptGroupAwaitedReturn<T> = { [P in keyof T]: Exclude<Awaited<T[P]>, symbol> };
+/**
+ * Options for the {@link group} utility.
+ */
 interface PromptGroupOptions<T> {
   /**
-   * Control how the group can be canceled
-   * if one of the prompts is canceled.
+   * Called when any one of the prompts is canceled.
    */
   onCancel?: (opts: {
     results: Prettify<Partial<PromptGroupAwaitedReturn<T>>>;
   }) => void;
 }
+/**
+ * A group of prompts to be displayed sequentially, with each prompt receiving
+ * the results of all previous prompts in the group.
+ */
 type PromptGroup<T> = { [P in keyof T]: (opts: {
   results: Prettify<Partial<PromptGroupAwaitedReturn<Omit<T, P>>>>;
 }) => undefined | Promise<T[P] | undefined> };
 /**
- * Define a group of prompts to be displayed
- * and return a results of objects within the group
+ * The `group` utility provides a consistent way to combine a series of prompts,
+ * combining each answer into one object. Each prompt receives the results of
+ * all previously completed prompts, and are displayed sequentially.
+ *
+ * @see https://bomb.sh/docs/clack/packages/prompts/#group
+ *
+ * @example
+ * ```ts
+ * import { group, text, password } from '@clack/prompts';
+ *
+ * const account = await group({
+ *   email: () => text({
+ *     message: 'What is your email address?',
+ *   }),
+ *   username: ({ results }) => text({
+ *     message: 'What is your username?',
+ *     placeholder: results.email?.replace(/@.+$/, '').toLowerCase() ?? '',
+ *   }),
+ *   password: () => password({
+ *     message: 'Define your password',
+ *   }),
+ * });
+ * ```
  */
 declare const group: <T>(prompts: PromptGroup<T>, opts?: PromptGroupOptions<T>) => Promise<Prettify<PromptGroupAwaitedReturn<T>>>;
+/**
+ * Options for the {@link groupMultiselect} prompt.
+ */
 interface GroupMultiSelectOptions<Value> extends CommonOptions {
+  /**
+   * The message or question shown to the user above the input.
+   */
   message: string;
+  /**
+   * Grouped options to display. Each key is a group label, and each value is an array of options.
+   */
   options: Record<string, Option<Value>[]>;
+  /**
+   * The initially selected option(s).
+   */
   initialValues?: Value[];
+  /**
+   * The maximum number of items/options to display at once.
+   */
+  maxItems?: number;
+  /**
+   * When `true` at least one option must be selected.
+   * @default true
+   */
   required?: boolean;
+  /**
+   * The value the cursor should be positioned at initially.
+   */
   cursorAt?: Value;
+  /**
+   * Whether entire groups can be selected at once.
+   * @default true
+   */
   selectableGroups?: boolean;
+  /**
+   * Number of blank lines between groups.
+   * @default 0
+   */
   groupSpacing?: number;
+  /**
+   * Show keyboard instructions below the option list.
+   * @default true
+   */
+  showInstructions?: boolean;
 }
+/**
+ * The `groupMultiselect` prompt extends the {@link multiselect} prompt to allow
+ * arranging distinct Multi-Selects, whilst keeping all of them interactive.
+ *
+ * @see https://bomb.sh/docs/clack/packages/prompts/#group-multiselect
+ *
+ * @example
+ * ```ts
+ * import { groupMultiselect } from '@clack/prompts';
+ *
+ * const result = await groupMultiselect({
+ * 	message: 'Define your project',
+ * 	options: {
+ * 		'Testing': [
+ * 			{ value: 'Jest', hint: 'JavaScript testing framework' },
+ * 			{ value: 'Playwright', hint: 'End-to-end testing' },
+ * 		],
+ * 		'Language': [
+ * 			{ value: 'js', label: 'JavaScript', hint: 'Dynamic typing' },
+ * 			{ value: 'ts', label: 'TypeScript', hint: 'Static typing' },
+ * 		],
+ * 	},
+ * });
+ * ```
+ *
+ * @param opts The options for the group multiselect prompt
+ */
 declare const groupMultiselect: <Value>(opts: GroupMultiSelectOptions<Value>) => Promise<Value[] | symbol>;
+/**
+ * Options for the {@link limitOptions} function.
+ */
 interface LimitOptionsParams<TOption> extends CommonOptions {
+  /**
+   * The list of options to display.
+   */
   options: TOption[];
-  maxItems: number | undefined;
+  /**
+   * The index of the currently active/selected option.
+   */
   cursor: number;
+  /**
+   * A function that styles the given option string.
+   *
+   * @param option - The option string to style.
+   * @param active - Whether the option is currently selected.
+   */
   style: (option: TOption, active: boolean) => string;
+  /**
+   * Maximum number of options to display at once.
+   * @default Infinity
+   */
+  maxItems?: number;
+  /**
+   * Number of columns to reserve for padding.
+   * @default 0
+   */
   columnPadding?: number;
+  /**
+   * Number of rows to reserve for padding.
+   * @default 4
+   */
   rowPadding?: number;
 }
-declare const limitOptions: <TOption>(params: LimitOptionsParams<TOption>) => string[];
+/**
+ * Trims an option list to what fits the terminal, while keeping the active
+ * option (cursor) visible using a Clack style sliding window.
+ *
+ * @returns The lines to render.
+ *
+ * @see https://bomb.sh/docs/clack/packages/prompts/#limitoptions
+ *
+ * @example
+ * ```ts
+ * import { limitOptions } from '@clack/prompts';
+ * import { styleText } from 'node:util';
+ *
+ * const options = ['apple', 'banana', 'cherry', 'date'];
+ * const lines = limitOptions({
+ *   options,
+ *   cursor: 2,
+ *   maxItems: 8,
+ *   style: (opt, active) =>
+ *     active ? styleText('cyan', opt) : styleText('dim', opt),
+ * });
+ * ```
+ */
+declare const limitOptions: <TOption>({
+  cursor,
+  options,
+  style,
+  output,
+  maxItems,
+  columnPadding,
+  rowPadding
+}: LimitOptionsParams<TOption>) => string[];
 interface LogMessageOptions extends CommonOptions {
   symbol?: string;
   spacing?: number;
@@ -800,9 +1428,136 @@ declare const log$1: {
   warning: (message: string, opts?: LogMessageOptions) => void;
   error: (message: string, opts?: LogMessageOptions) => void;
 };
+/**
+ * The `cancel` function defines an interruption of an interaction
+ * and therefore its end.
+ *
+ * @param title Optional closing message to be displayed.
+ * @param opts Additional configuration options.
+ *
+ * @see https://bomb.sh/docs/clack/packages/prompts/#cancel
+ *
+ * @example
+ * ```ts
+ * import { cancel } from '@clack/prompts';
+ * import process from 'node:process';
+ *
+ * cancel('Installation canceled');
+ * process.exit(1);
+ * ```
+ */
 declare const cancel: (message?: string, opts?: CommonOptions) => void;
+/**
+ * The `intro` function defines the beginning of an interaction.
+ *
+ * @param title Optional title to be displayed.
+ * @param opts Additional configuration options.
+ *
+ * @see https://bomb.sh/docs/clack/packages/prompts/#intro
+ *
+ * @example
+ * ```ts
+ * import { intro } from '@clack/prompts';
+ *
+ * intro('Welcome to clack');
+ * ```
+ */
 declare const intro: (title?: string, opts?: CommonOptions) => void;
+/**
+ * The `outro` function defines the end of an interaction.
+ *
+ * @param title Optional closing message to be displayed.
+ * @param opts Additional configuration options.
+ *
+ * @see https://bomb.sh/docs/clack/packages/prompts/#outro
+ *
+ * @example
+ * ```ts
+ * import { outro } from '@clack/prompts';
+ *
+ * outro('All operations are finished');
+ * ```
+ */
 declare const outro: (message?: string, opts?: CommonOptions) => void;
+/**
+ * Options for the {@link text} prompt
+ */
+interface TextOptions extends CommonOptions {
+  /**
+   * The prompt message or question shown to the user above the input.
+   */
+  message: string;
+  /**
+   * A visual hint shown when the field has no content.
+   */
+  placeholder?: string;
+  /**
+   * A fallback value returned when the user provides nothing (empty input).
+   */
+  defaultValue?: string;
+  /**
+   * The starting value shown when the prompt first renders.
+   * Users can edit this value before submitting.
+   */
+  initialValue?: string;
+  /**
+   * A function or a [Standard Schema](https://github.com/standard-schema/standard-schema)
+   * that validates user input. If a custom function is given, you should return a `string` or `Error`
+   * to show as a validation error, or `undefined` to accept the result.
+   */
+  validate?: Validate<string>;
+}
+/**
+ * The text prompt accepts a single line of text.
+ *
+ * @see https://bomb.sh/docs/clack/packages/prompts/#text-input
+ *
+ * @example
+ * ```ts
+ * import { text } from '@clack/prompts';
+ *
+ * const name = await text({
+ *   message: 'What is your name?',
+ *   placeholder: 'John Doe',
+ *   validate: (value) => {
+ *     if (!value || value.length < 2) return 'Name must be at least 2 characters';
+ *     return undefined;
+ *   },
+ * });
+ * ```
+ */
+declare const text: (opts: TextOptions) => Promise<string | symbol>;
+/**
+ * Options for the {@link multiline} prompt
+ */
+interface MultiLineOptions extends TextOptions {
+  /**
+   * When enabled it shows a `[ submit ]` button that can be focused with tab.
+   * By default, pressing `Enter` twice submits the input
+   *
+   * @default false
+   */
+  showSubmit?: boolean;
+}
+/**
+ * The multi-line prompt accepts multiple lines of text input.
+ * By default, pressing `Enter` twice submits the input.
+ *
+ * @see https://bomb.sh/docs/clack/packages/prompts/#multi-line-text
+ *
+ * @example
+ * ```ts
+ * import { multiline } from '@clack/prompts';
+ *
+ * const bio = await multiline({
+ *   message: 'Enter your bio',
+ *   placeholder: 'Tell us about yourself...',
+ *   showSubmit: true,
+ * });
+ * ```
+ */
+declare const multiline: (opts: MultiLineOptions) => Promise<string | symbol>;
+declare const MULTISELECT_INSTRUCTIONS: string[];
 interface MultiSelectOptions<Value> extends CommonOptions {
   message: string;
   options: Option<Value>[];
@@ -810,6 +1565,11 @@ interface MultiSelectOptions<Value> extends CommonOptions {
   maxItems?: number;
   required?: boolean;
   cursorAt?: Value;
+  /**
+   * Show keyboard instructions below the option list.
+   * @default true
+   */
+  showInstructions?: boolean;
 }
 declare const multiselect: <Value>(opts: MultiSelectOptions<Value>) => Promise<Value[] | symbol>;
 type FormatFn = (line: string) => string;
@@ -817,20 +1577,94 @@ interface NoteOptions extends CommonOptions {
   format?: FormatFn;
 }
 declare const note: (message?: string, title?: string, opts?: NoteOptions) => void;
+/**
+ * Options for the {@link password} prompt
+ */
 interface PasswordOptions extends CommonOptions {
+  /**
+   * The prompt message or question shown to the user above the input.
+   */
   message: string;
+  /**
+   * Character to use for masking input.
+   * @default ▪/•
+   */
   mask?: string;
-  validate?: (value: string | undefined) => string | Error | undefined;
+  /**
+   * A function or a [Standard Schema](https://github.com/standard-schema/standard-schema)
+   * that validates user input. If a custom function is given, you should return a `string` or `Error`
+   * to show as a validation error, or `undefined` to accept the result.
+   */
+  validate?: Validate<string>;
+  /**
+   * When enabled it causes the input to be cleared if/when validation fails.
+   * @default false
+   */
   clearOnError?: boolean;
 }
+/**
+ * The password prompt behaves like the {@link text} prompt, but the input is masked.
+ *
+ * @see https://bomb.sh/docs/clack/packages/prompts/#password-input
+ *
+ * @example
+ * ```ts
+ * import { password } from '@clack/prompts';
+ *
+ * const result = await password({
+ *   message: 'Enter your password',
+ * });
+ * ```
+ */
 declare const password: (opts: PasswordOptions) => Promise<string | symbol>;
+/**
+ * Options for the {@link path} prompt.
+ */
 interface PathOptions extends CommonOptions {
+  /**
+   * The message or question shown to the user above the input.
+   */
+  message: string;
+  /**
+   * The starting directory for path suggestions (defaults to current working directory).
+   */
   root?: string;
+  /**
+   * When `true` only **directories** appear in suggestions while you navigate.
+   */
   directory?: boolean;
+  /**
+   * The starting path shown when the prompt first renders, which users can edit
+   * before submitting. If not provided it will fall back to the given `root`,
+   * or the current working directory.
+   *
+   * In `directory` mode, if the initial value points to a directory that exists,
+   * pressing enter will submit the input instead of jumping to the first child.
+   */
   initialValue?: string;
-  message: string;
-  validate?: (value: string | undefined) => string | Error | undefined;
+  /**
+   * A function or a [Standard Schema](https://github.com/standard-schema/standard-schema)
+   * that validates user input. If a custom function is given, you should return a `string` or `Error`
+   * to show as a validation error, or `undefined` to accept the result.
+   */
+  validate?: Validate<string>;
 }
+/**
+ * The `path` prompt extends `autocomplete` to provide file and directory suggestions.
+ *
+ * @see https://bomb.sh/docs/clack/packages/prompts/#path-selection
+ *
+ * @example
+ * ```ts
+ * import { path } from '@clack/prompts';
+ *
+ * const result = await path({
+ *   message: 'Select a file:',
+ *   root: process.cwd(),
+ *   directory: false,
+ * });
+ * ```
+ */
 declare const path: (opts: PathOptions) => Promise<string | symbol>;
 interface SpinnerOptions extends CommonOptions {
   indicator?: 'dots' | 'timer';
@@ -936,18 +1770,11 @@ declare const taskLog: (opts: TaskLogOptions) => {
   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>;
 //#endregion
 //#region src/prompts.d.ts
-type PromptProgress = ReturnType<typeof progress>;
-type PromptSpinner = ReturnType<typeof spinner>;
+declare const p: typeof index_d_exports;
+type PromptProgress = ReturnType<typeof p.progress>;
+type PromptSpinner = ReturnType<typeof p.spinner>;
 //#endregion
 //#region src/readPackageUp.d.ts
 interface ReadPackageUpResult<T = unknown> {
@@ -982,4 +1809,4 @@ type TransformTemplateArgs<T extends string> = { [Key in ExtractPlaceholders<T>]
  */
 declare function transformTemplate<T extends string>(templateString: T, values: TransformTemplateArgs<T>): string;
 //#endregion
-export { BuildLogger, BuildLoggerConfig, BuildType, ConfigBuilder, ConfigBuilderScaffold, ConfigResponse, CreateHotUpdaterConfigScaffoldFromBuilderOptions, CreateHotUpdaterConfigScaffoldOptions, HOT_UPDATER_SERVER_PACKAGE_VERSION_ENV, HotUpdateDirUtil, HotUpdaterConfigOptions, HotUpdaterConfigScaffold, HotUpdaterLogWriter, IConfigBuilder, ImportInfo, LEGACY_BUNDLE_ERROR, ManagedHelperStatement, ManagedHelperStrategy, PromoteBundleDependencies, PromoteBundleInput, PromptProgress, PromptSpinner, ProviderConfig, ReactNativeMetadata, ReadPackageUpResult, WriteHotUpdaterConfigResult, banner, typedColors as colors, copyDirToTmp, createCopiedBundleArchive, createHotUpdaterConfigScaffold, createHotUpdaterConfigScaffoldFromBuilder, createLogWriter, createTarBr, createTarBrTargetFiles, createTarGz, createTarGzTargetFiles, createZip, createZipTargetFiles, decryptJson, encryptJson, ensureInstallPackages, getAndroidSdkPath, getCwd, getPackageManager, getReactNativeMetadatas, link, loadConfig, log, makeEnv, index_d_exports as p, printBanner, promoteBundle, readPackageUp, renderImportStatements, resolveHotUpdaterServerVersion, resolvePackageVersion, stripAnsi, transformEnv, transformTemplate, writeHotUpdaterConfig };
+export { BuildLogger, BuildLoggerConfig, BuildType, ConfigBuilder, ConfigBuilderScaffold, ConfigResponse, CreateHotUpdaterConfigScaffoldFromBuilderOptions, CreateHotUpdaterConfigScaffoldOptions, HOT_UPDATER_SERVER_PACKAGE_VERSION_ENV, HotUpdateDirUtil, HotUpdaterConfigOptions, HotUpdaterConfigScaffold, HotUpdaterInitEnv, HotUpdaterLogWriter, IConfigBuilder, ImportInfo, InitEnvFileError, InitError, InitProviderDefinition, InitProviderInputDefinition, InitProviderInputPersistence, LEGACY_BUNDLE_ERROR, ManagedHelperStatement, ManagedHelperStrategy, MissingInitInputsError, PromoteBundleDependencies, PromoteBundleInput, PromptProgress, PromptSpinner, ProviderConfig, ReactNativeMetadata, ReadPackageUpResult, RunInitOptions, WriteHotUpdaterConfigResult, assertInitInputs, assertInitProviderInputs, banner, typedColors as colors, confirmInitInputPersistence, copyDirToTmp, createCopiedBundleArchive, createHotUpdaterConfigScaffold, createHotUpdaterConfigScaffoldFromBuilder, createLogWriter, createTarBr, createTarBrTargetFiles, createTarGz, createTarGzTargetFiles, createZip, createZipTargetFiles, decryptJson, defineInitProvider, encryptJson, ensureInstallPackages, getAndroidSdkPath, getCwd, getHotUpdaterEnvValue, getHotUpdaterInitInputEnv, getInitProviderEnvVars, getInitProviderTextPromptValues, getMissingInitInputs, getMissingInitProviderInputs, getPackageManager, getReactNativeMetadatas, link, loadConfig, log, makeEnv, p, printBanner, promoteBundle, readHotUpdaterEnv, readHotUpdaterInitEnv, readPackageUp, renderImportStatements, resolveHotUpdaterServerVersion, resolveInitProviderInput, resolveInitProviderInputs, resolvePackageVersion, shouldAutoSelectOnlyInitResource, stripAnsi, transformEnv, transformTemplate, writeHotUpdaterConfig };