123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296
import { WidenType } from "./_utils.ts";import { brightBlue, underline } from "./deps.ts";import {  GenericList,  GenericListKeys,  GenericListOption,  GenericListOptionGroup,  GenericListOptionGroupSettings,  GenericListOptions,  GenericListOptionSettings,  GenericListSeparatorOption,  GenericListSettings,  isOption,  isOptionGroup,} from "./_generic_list.ts";import { GenericPrompt } from "./_generic_prompt.ts";import { getFiguresByKeys } from "./_figures.ts";
/** Select prompt options. */export interface SelectOptions<TValue>  extends GenericListOptions<TValue, TValue, TValue> {  /** Keymap to assign key names to prompt actions. */  keys?: SelectKeys;  /** An array of child options. */  options: Array<    | Extract<TValue, string | number>    | Extract<WidenType<TValue>, string | number>    | SelectOption<TValue>    | SelectOptionGroup<TValue>    | GenericListSeparatorOption  >;}
/** Select prompt settings. */export interface SelectSettings<TValue> extends  GenericListSettings<    TValue,    TValue,    TValue,    SelectOptionSettings<TValue>,    SelectOptionGroupSettings<TValue>  > {  keys: SelectKeys;}
/** Select option options. */export type SelectOption<TValue> = GenericListOption<TValue>;
/** Select option group options. */export type SelectOptionGroup<TValue> = GenericListOptionGroup<  TValue,  GenericListOption<TValue>>;
/** Select option settings. */export type SelectOptionSettings<TValue> = GenericListOptionSettings<TValue>;
/** Select option group settings. */export type SelectOptionGroupSettings<TValue> = GenericListOptionGroupSettings<  TValue,  SelectOptionSettings<TValue>>;
/** Select prompt keymap. */export type SelectKeys = GenericListKeys;
/** * Select prompt representation. * * Simple prompt: * * ```ts * import { Select } from "./mod.ts"; * * const color: string = await Select.prompt({ *   message: "Pick a color", *   options: ["red", "green", "blue"], * }); * ``` * * Mixed option types: * * ```ts * import { Select } from "./mod.ts"; * * const value: string | number = await Select.prompt<string | number>({ *   message: "Pick a color", *   options: [1, 2, "3", "4"], * }); * ``` * * None primitive option types: * * ```ts * import { Select } from "./mod.ts"; * * const date: Date = await Select.prompt({ *   message: "Pick a date", *   options: [ *     { *       name: "Date 1", *       value: new Date(100000), *     }, *     { *       name: "Date 2", *       value: new Date(200000), *     }, *     { *       name: "Date 3", *       value: new Date(300000), *     }, *   ], * }); * ``` * * Grouped options: * * ```ts * import { Select } from "./mod.ts"; * * const value = await Select.prompt({ *   message: "Select a value", *   options: [{ *     name: "Group 1", *     options: ["foo", "bar", "baz"], *   }, { *     name: "Group 2", *     options: ["beep", "boop"], *   }], * }); * ``` */export class Select<TValue> extends GenericList<  TValue,  TValue,  TValue,  SelectOptionSettings<TValue>,  SelectOptionGroupSettings<TValue>> {  protected readonly settings: SelectSettings<TValue>;  protected options: Array<    SelectOptionSettings<TValue> | SelectOptionGroupSettings<TValue>  >;  protected listIndex: number;  protected listOffset: number;
  /** Execute the prompt with provided options. */  public static prompt<TValue>(    options: SelectOptions<TValue>,  ): Promise<WidenType<TValue>> {    return new this(options).prompt() as Promise<WidenType<TValue>>;  }
  /**   * Inject prompt value. If called, the prompt doesn't prompt for an input and   * returns immediately the injected value. Can be used for unit tests or pre   * selections.   *   * @param value Input value.   */  public static inject(value: string): void {    GenericPrompt.inject(value);  }
  constructor(options: SelectOptions<TValue>) {    super();    this.settings = this.getDefaultSettings(options);    this.options = this.settings.options.slice();    this.listIndex = this.getListIndex(this.settings.default);    this.listOffset = this.getPageOffset(this.listIndex);  }
  public getDefaultSettings(    options: SelectOptions<TValue>,  ): SelectSettings<TValue> {    return {      ...super.getDefaultSettings(options),      options: this.mapOptions(options, options.options),    };  }
  /** Map string option values to options and set option defaults. */  protected mapOptions(    promptOptions: SelectOptions<TValue>,    options: Array<      | Extract<TValue, string | number>      | Extract<WidenType<TValue>, string | number>      | SelectOption<TValue>      | SelectOptionGroup<TValue>      | GenericListSeparatorOption    >,  ): Array<SelectOptionSettings<TValue> | SelectOptionGroupSettings<TValue>> {    return options.map((option) =>      isSelectOptionGroup(option)        ? this.mapOptionGroup(promptOptions, option)        : typeof option === "string" || typeof option === "number"        ? this.mapOption(          promptOptions,          { value: option as TValue },        )        : this.mapOption(promptOptions, option)    );  }
  protected input(): string {    return underline(brightBlue(this.inputValue));  }
  protected async submit(): Promise<void> {    if (      this.isBackButton(this.selectedOption) ||      isOptionGroup(this.selectedOption)    ) {      const info = isOptionGroup(this.selectedOption)        ? ` To select a group use ${          getFiguresByKeys(this.settings.keys.open ?? []).join(", ")        }.`        : "";      this.setErrorMessage(`No option selected.${info}`);      return;    }
    await super.submit();  }
  /** Get value of selected option. */  protected getValue(): TValue {    const option = this.options[this.listIndex];    assertIsOption(option);    return option.value;  }
  /**   * Validate input value.   * @param value User input value.   * @return True on success, false or error message on error.   */  protected validate(value: TValue): boolean | string {    return this.options.findIndex((      option: SelectOptionSettings<TValue> | SelectOptionGroupSettings<TValue>,    ) => isOption(option) && option.value === value) !== -1;  }
  /**   * Map input value to output value.   * @param value Input value.   * @return Output value.   */  protected transform(value: TValue): TValue {    return value;  }
  /**   * Format output value.   * @param value Output value.   */  protected format(value: TValue): string {    return this.settings.format?.(value) ??      this.getOptionByValue(value)?.name ?? String(value);  }}
function assertIsOption<  TValue,  TOption extends GenericListOption<TValue>,>(  option: TOption | GenericListOptionGroup<TValue, GenericListOption<TValue>>,): asserts option is TOption {  if (!isOption(option)) {    throw new Error("Expected an option but got an option group.");  }}
export function isSelectOptionGroup(  option: unknown,  // deno-lint-ignore no-explicit-any): option is SelectOptionGroup<any> {  return isOptionGroup(option);}
/** * Select options type. * @deprecated Use `Array<string | SelectOption | SelectOptionGroup>` instead. */export type SelectValueOptions = Array<  string | SelectOption<string> | SelectOptionGroup<string>>;
/** * Select option settings type. * @deprecated Use `Array<SelectOptionSettings | SelectOptionGroupSettings>` instead. */export type SelectValueSettings = Array<  SelectOptionSettings<string> | SelectOptionGroupSettings<string>>;