@reliverse/rempts 1.6.0

package/bin/core-impl/select/numselect-prompt.js

@@ -0,0 +1,115 @@
+import { stdin as input, stdout as output } from "node:process";
+import readline from "node:readline/promises";
+import { bar, fmt, msg } from "../msg-fmt/messages.js";
+import {
+  countLines,
+  deleteLastLine,
+  deleteLastLines
+} from "../msg-fmt/terminal.js";
+import { colorize } from "../utils/colorize.js";
+export async function numSelectPrompt(opts) {
+  const {
+    title = "",
+    hint,
+    hintPlaceholderColor = "blue",
+    validate,
+    defaultValue,
+    titleColor = "cyan",
+    titleTypography = "none",
+    titleVariant,
+    content,
+    contentColor = "dim",
+    contentTypography = "italic",
+    contentVariant,
+    borderColor = "dim",
+    variantOptions,
+    inline = true,
+    choices
+  } = opts;
+  if (!choices || choices.length === 0) {
+    throw new Error("Choices are required for select prompt.");
+  }
+  const rl = readline.createInterface({ input, output });
+  const formattedBar = bar({ borderColor });
+  let linesToDelete = 0;
+  let errorMessage = "";
+  while (true) {
+    if (linesToDelete > 0) {
+      deleteLastLines(linesToDelete);
+    }
+    const { text: question } = fmt({
+      hintPlaceholderColor,
+      type: errorMessage !== "" ? "M_ERROR" : "M_GENERAL",
+      title,
+      titleColor,
+      titleTypography,
+      titleVariant,
+      content,
+      contentColor,
+      contentTypography,
+      contentVariant,
+      borderColor,
+      hint,
+      variantOptions,
+      errorMessage
+    });
+    let choicesText = "";
+    if (inline) {
+      choicesText = choices.map(
+        (choice, index) => `${index + 1}) ${choice.title}${choice.description ? ` (${choice.description})` : ""}`
+      ).join(" / ");
+    } else {
+      choicesText = choices.map(
+        (choice, index) => `${index + 1}) ${choice.title}${choice.description ? ` - ${choice.description}` : ""}`
+      ).join(`
+${formattedBar} `);
+    }
+    const { text: formattedPrompt } = fmt({
+      hintPlaceholderColor,
+      type: "M_NULL",
+      title: `${question}
+${choicesText}
+${formattedBar}  ${colorize(
+        "Enter your choice:",
+        contentColor
+      )}
+${formattedBar}  `
+    });
+    const questionLines = countLines(formattedPrompt);
+    linesToDelete = questionLines + 1;
+    const prompt = await rl.question(formattedPrompt);
+    const answer = prompt.trim() || defaultValue;
+    if (!prompt.trim() && defaultValue !== void 0) {
+      deleteLastLine();
+      msg({
+        type: "M_MIDDLE",
+        title: `  ${defaultValue}`,
+        titleColor: "none"
+      });
+      msg({ type: "M_BAR", borderColor });
+    }
+    const num = Number(answer);
+    if (Number.isNaN(num) || num < 1 || num > choices.length) {
+      errorMessage = `Please enter a number between 1 and ${choices.length}.`;
+      continue;
+    }
+    const selectedChoice = choices[num - 1];
+    const selectedValue = selectedChoice?.id ?? num;
+    let isValid = true;
+    errorMessage = "";
+    if (validate && isValid) {
+      const validation = await validate(selectedValue);
+      if (validation !== true) {
+        isValid = false;
+        errorMessage = typeof validation === "string" ? validation : "Invalid input.";
+      }
+    }
+    if (isValid) {
+      rl.close();
+      if (selectedChoice?.action) {
+        await selectedChoice.action();
+      }
+      return selectedValue;
+    }
+  }
+}

package/bin/core-impl/select/select-prompt.d.ts

@@ -0,0 +1,33 @@
+import type { BorderColorName, ColorName, SelectOption, TypographyName, VariantName } from "../../core-types.js";
+import { symbols } from "../msg-fmt/messages.js";
+type SeparatorOption = {
+    separator: true;
+    width?: number;
+    symbol?: keyof typeof symbols;
+};
+type SelectPromptParams<T extends string> = {
+    title: string;
+    content?: string;
+    options: (SelectOption<T> | SeparatorOption)[];
+    defaultValue?: T;
+    required?: boolean;
+    borderColor?: BorderColorName;
+    titleColor?: ColorName;
+    titleTypography?: TypographyName;
+    titleVariant?: VariantName;
+    contentColor?: ColorName;
+    contentTypography?: TypographyName;
+    border?: boolean;
+    endTitle?: string;
+    endTitleColor?: ColorName;
+    debug?: boolean;
+    terminalWidth?: number;
+    displayInstructions?: boolean;
+    shouldStream?: boolean;
+    streamDelay?: number;
+};
+/**
+ * Displays a selectable prompt in the terminal and returns the chosen value.
+ */
+export declare function selectPrompt<T extends string>(params: SelectPromptParams<T>): Promise<T>;
+export {};

package/bin/core-impl/select/select-prompt.js

@@ -0,0 +1,303 @@
+import { re } from "@reliverse/relico";
+import { relinka } from "@reliverse/relinka";
+import { stdin as input, stdout as output } from "node:process";
+import readline from "node:readline";
+import { msg, symbols } from "../msg-fmt/messages.js";
+import { deleteLastLine } from "../msg-fmt/terminal.js";
+import { completePrompt } from "../utils/prompt-end.js";
+import { streamText } from "../utils/stream-text.js";
+function isSelectOption(option) {
+  return !("separator" in option);
+}
+async function renderPromptUI(params) {
+  const {
+    title,
+    content,
+    options,
+    selectedIndex,
+    errorMessage,
+    displayInstructions,
+    allDisabled,
+    instructions,
+    titleColor,
+    contentColor,
+    contentTypography,
+    debug,
+    titleVariant,
+    titleTypography,
+    isRerender = false,
+    shouldStream = false,
+    streamDelay = 20
+  } = params;
+  if (!isRerender) {
+    if (shouldStream) {
+      deleteLastLine();
+      msg({ type: "M_BAR", title: "" });
+      await streamText({
+        text: title,
+        delay: streamDelay,
+        color: titleColor,
+        newline: false,
+        clearLine: true
+      });
+      process.stdout.write("\r");
+      msg({
+        type: "M_GENERAL",
+        title,
+        titleColor,
+        titleVariant,
+        titleTypography
+      });
+      if (content) {
+        msg({
+          type: "M_NULL",
+          content,
+          contentColor,
+          contentTypography
+        });
+      }
+    } else {
+      msg({ type: "M_GENERAL", title, titleColor });
+      if (content) {
+        msg({
+          type: "M_NULL",
+          content,
+          contentColor,
+          contentTypography
+        });
+      }
+    }
+  }
+  let uiLineCount = 0;
+  if (errorMessage) {
+    msg({
+      type: "M_ERROR",
+      title: `${re.redBright(symbols.step_error)} ${re.redBright(errorMessage)}`
+    });
+    uiLineCount++;
+  } else if (allDisabled) {
+    msg({ type: "M_ERROR", title: re.redBright("All options are disabled.") });
+    uiLineCount++;
+  } else if (displayInstructions && !isRerender) {
+    msg({ type: "M_NULL", title: re.blue(instructions) });
+    uiLineCount++;
+  }
+  for (let index = 0; index < options.length; index++) {
+    const option = options[index];
+    if (!option) continue;
+    if (!isSelectOption(option)) {
+      const width = option.width ?? 20;
+      const symbolKey = option.symbol ?? "line";
+      const lineSymbol = symbolKey in symbols ? symbols[symbolKey] : "\u2500";
+      msg({ type: "M_NULL", title: re.dim(lineSymbol.repeat(width)) });
+      uiLineCount++;
+      continue;
+    }
+    const isSelected = index === selectedIndex;
+    const isDisabled = option.disabled;
+    const prefix = isSelected ? re.dim(re.reset("> ")) : "  ";
+    const labelColor = isDisabled ? re.dim(re.reset(option.label)) : isSelected ? re.reset(re.yellow(option.label)) : re.reset(option.label);
+    const hint = option.hint ? re.reset(
+      ` (${isDisabled ? re.dim(option.hint) : re.italic(re.dim(option.hint))})`
+    ) : "";
+    msg({ type: "M_NULL", title: `${prefix}${labelColor}${hint}` });
+    uiLineCount++;
+  }
+  if (debug) {
+    relinka("info", "", { optionsCount: options.length });
+  }
+  return uiLineCount;
+}
+export async function selectPrompt(params) {
+  const {
+    title = "",
+    content = "",
+    options,
+    defaultValue,
+    required = false,
+    borderColor = "dim",
+    titleColor = "cyan",
+    titleTypography = "none",
+    titleVariant,
+    contentColor = "dim",
+    contentTypography = "italic",
+    border = true,
+    endTitle = "",
+    endTitleColor = "dim",
+    debug = false,
+    terminalWidth: customTerminalWidth = 90,
+    displayInstructions = false,
+    shouldStream = false,
+    streamDelay = 20
+  } = params;
+  let selectedIndex = defaultValue ? options.findIndex(
+    (option) => isSelectOption(option) && option.value === defaultValue && !option.disabled
+  ) : -1;
+  if (selectedIndex === -1) {
+    selectedIndex = options.findIndex(
+      (option) => isSelectOption(option) && !option.disabled
+    );
+  }
+  if (selectedIndex === -1) {
+    selectedIndex = 0;
+  }
+  const rl = readline.createInterface({ input, output });
+  readline.emitKeypressEvents(input, rl);
+  if (typeof input.setRawMode === "function") {
+    input.setRawMode(true);
+  }
+  const instructions = "Use <\u2191/\u2193> or <k/j> to navigate, <Enter> to select, <Ctrl+C> to exit";
+  let errorMessage = "";
+  const allDisabled = options.every(
+    (option) => isSelectOption(option) && option.disabled
+  );
+  let lastUILineCount = 0;
+  function renderOptions() {
+    if (lastUILineCount > 0) {
+      for (let i = 0; i < lastUILineCount; i++) {
+        process.stdout.write("\x1B[1A\x1B[2K");
+      }
+    }
+    void renderPromptUI({
+      title,
+      content,
+      options,
+      selectedIndex,
+      errorMessage,
+      displayInstructions,
+      allDisabled,
+      instructions,
+      borderColor,
+      titleColor,
+      contentColor,
+      contentTypography,
+      debug,
+      titleVariant,
+      titleTypography,
+      terminalWidth: customTerminalWidth,
+      isRerender: true,
+      shouldStream,
+      streamDelay
+    }).then((count) => {
+      lastUILineCount = count;
+    });
+  }
+  lastUILineCount = await renderPromptUI({
+    title,
+    content,
+    options,
+    selectedIndex,
+    errorMessage,
+    displayInstructions,
+    allDisabled,
+    instructions,
+    borderColor,
+    titleColor,
+    contentColor,
+    contentTypography,
+    debug,
+    titleVariant,
+    titleTypography,
+    terminalWidth: customTerminalWidth,
+    isRerender: false,
+    shouldStream,
+    streamDelay
+  });
+  return new Promise((resolve) => {
+    function handleKeypress(_str, key) {
+      if (allDisabled) {
+        if (key.name === "c" && key.ctrl) {
+          void endPrompt(true);
+          return;
+        }
+        return;
+      }
+      if (key.name === "up" || key.name === "k") {
+        moveSelectionUp();
+      } else if (key.name === "down" || key.name === "j") {
+        moveSelectionDown();
+      } else if (key.name === "return") {
+        void confirmSelection();
+      } else if (key.name === "c" && key.ctrl) {
+        void endPrompt(true);
+      }
+    }
+    function moveSelectionUp() {
+      const originalPointer = selectedIndex;
+      do {
+        selectedIndex = (selectedIndex - 1 + options.length) % options.length;
+        const option = options[selectedIndex];
+        if (option && isSelectOption(option) && !option.disabled) break;
+      } while (selectedIndex !== originalPointer);
+      renderOptions();
+    }
+    function moveSelectionDown() {
+      const originalPointer = selectedIndex;
+      do {
+        selectedIndex = (selectedIndex + 1) % options.length;
+        const option = options[selectedIndex];
+        if (option && isSelectOption(option) && !option.disabled) break;
+      } while (selectedIndex !== originalPointer);
+      renderOptions();
+    }
+    async function confirmSelection() {
+      const option = options[selectedIndex];
+      if (!option || !isSelectOption(option)) {
+        errorMessage = "This option is not selectable.";
+        renderOptions();
+        return;
+      }
+      if (option.disabled) {
+        errorMessage = "This option is disabled";
+        renderOptions();
+        return;
+      }
+      if (required && !option.value) {
+        errorMessage = "You must select a valid option.";
+        renderOptions();
+        return;
+      }
+      cleanup();
+      resolve(option.value);
+      deleteLastLine();
+      await completePrompt(
+        "select",
+        false,
+        endTitle,
+        endTitleColor,
+        titleTypography,
+        titleVariant ? titleVariant : void 0,
+        border,
+        borderColor,
+        void 0,
+        true
+      );
+    }
+    async function endPrompt(isCtrlC = false) {
+      await completePrompt(
+        "select",
+        isCtrlC,
+        endTitle,
+        endTitleColor,
+        titleTypography,
+        titleVariant ? titleVariant : void 0,
+        border,
+        borderColor,
+        void 0,
+        false
+      );
+      cleanup(isCtrlC);
+    }
+    function cleanup(isCtrlC = false) {
+      if (typeof input.setRawMode === "function") {
+        input.setRawMode(false);
+      }
+      rl.close();
+      input.removeListener("keypress", handleKeypress);
+      if (isCtrlC) {
+        process.exit(0);
+      }
+    }
+    input.on("keypress", handleKeypress);
+  });
+}

package/bin/core-impl/select/toggle-prompt.d.ts

@@ -0,0 +1,5 @@
+import type { TogglePromptParams } from "../../core-types.js";
+/**
+ * A toggle prompt that lets the user choose between two options (Yes/No style).
+ */
+export declare function togglePrompt<T extends string>(params: TogglePromptParams<T>): Promise<boolean>;

package/bin/core-impl/select/toggle-prompt.js

@@ -0,0 +1,209 @@
+import { re } from "@reliverse/relico";
+import { relinka } from "@reliverse/relinka";
+import { stdin as input, stdout as output } from "node:process";
+import readline from "node:readline";
+import { msg } from "../msg-fmt/messages.js";
+import { deleteLastLine } from "../msg-fmt/terminal.js";
+import { completePrompt } from "../utils/prompt-end.js";
+function renderTogglePrompt(params) {
+  const {
+    title,
+    content,
+    options,
+    selectedIndex,
+    errorMessage,
+    instructions,
+    titleColor,
+    titleTypography,
+    titleVariant,
+    contentColor,
+    contentTypography,
+    displayInstructions,
+    debug,
+    isRerender = false
+  } = params;
+  if (!isRerender) {
+    msg({
+      type: "M_GENERAL",
+      title,
+      titleColor,
+      titleTypography,
+      ...titleVariant ? { titleVariant } : {}
+    });
+    if (content) {
+      msg({
+        type: "M_NULL",
+        content: content.split("\n").map((line) => line.trim()).join("\n"),
+        contentColor,
+        contentTypography
+      });
+    }
+  }
+  let uiLineCount = 0;
+  if (errorMessage) {
+    msg({
+      type: "M_NULL",
+      title: re.redBright(errorMessage)
+    });
+    uiLineCount++;
+  } else if (displayInstructions && !isRerender) {
+    msg({
+      type: "M_NULL",
+      title: re.yellow(instructions)
+    });
+    uiLineCount++;
+  }
+  const displayString = options.map(
+    (option, index) => index === selectedIndex ? re.yellow(option) : re.reset(option)
+  ).join(re.dim(re.reset(" / ")));
+  msg({ type: "M_NULL", title: displayString });
+  uiLineCount++;
+  if (debug) {
+    relinka("info", "", {
+      selectedIndex,
+      displayOptions: options
+    });
+  }
+  return uiLineCount;
+}
+export async function togglePrompt(params) {
+  const {
+    title = "",
+    content = "",
+    options = ["Yes", "No"],
+    defaultValue = "Yes",
+    borderColor = "dim",
+    titleColor = "cyan",
+    titleTypography = "none",
+    titleVariant,
+    contentColor = "dim",
+    contentTypography = "italic",
+    border = true,
+    endTitle = "",
+    endTitleColor = "dim",
+    displayInstructions = false,
+    debug = false
+  } = params;
+  if (options.length !== 2) {
+    throw new Error("togglePrompt requires exactly two options.");
+  }
+  let selectedIndex = options.findIndex((option) => option === defaultValue);
+  if (selectedIndex === -1) {
+    selectedIndex = 0;
+  }
+  const rl = readline.createInterface({ input, output });
+  readline.emitKeypressEvents(input, rl);
+  if (typeof input.setRawMode === "function") {
+    input.setRawMode(true);
+  }
+  const instructions = "Use <\u2190/\u2192> or <h/l> to navigate, <Enter> to select, <Ctrl+C> to exit";
+  let errorMessage = "";
+  let lastUILineCount = 0;
+  function renderOptions() {
+    if (lastUILineCount > 0) {
+      for (let i = 0; i < lastUILineCount; i++) {
+        process.stdout.write("\x1B[1A\x1B[2K");
+      }
+    }
+    lastUILineCount = renderTogglePrompt({
+      title,
+      content,
+      options,
+      selectedIndex,
+      errorMessage,
+      instructions,
+      borderColor,
+      titleColor,
+      titleTypography,
+      ...titleVariant ? { titleVariant } : {},
+      contentColor,
+      contentTypography,
+      border,
+      displayInstructions,
+      debug,
+      isRerender: true
+    });
+  }
+  lastUILineCount = renderTogglePrompt({
+    title,
+    content,
+    options,
+    selectedIndex,
+    errorMessage,
+    instructions,
+    borderColor,
+    titleColor,
+    titleTypography,
+    ...titleVariant ? { titleVariant } : {},
+    contentColor,
+    contentTypography,
+    border,
+    displayInstructions,
+    debug,
+    isRerender: false
+  });
+  return new Promise((resolve) => {
+    function cleanup(isCtrlC = false) {
+      if (typeof input.setRawMode === "function") {
+        input.setRawMode(false);
+      }
+      rl.close();
+      input.removeListener("keypress", handleKeypress);
+      if (isCtrlC) {
+        process.exit(0);
+      }
+    }
+    function endPrompt(isCtrlC = false) {
+      if (endTitle !== "") {
+        msg({
+          type: "M_END",
+          title: endTitle,
+          titleColor: endTitleColor,
+          titleTypography,
+          ...titleVariant ? { titleVariant } : {},
+          border,
+          borderColor
+        });
+      }
+      cleanup(isCtrlC);
+    }
+    function handleKeypress(_str, key) {
+      if (key.name === "left" || key.name === "h") {
+        selectedIndex = (selectedIndex - 1 + options.length) % options.length;
+        errorMessage = "";
+        renderOptions();
+      } else if (key.name === "right" || key.name === "l") {
+        selectedIndex = (selectedIndex + 1) % options.length;
+        errorMessage = "";
+        renderOptions();
+      } else if (key.name === "return") {
+        const selectedOption = options[selectedIndex];
+        if (!selectedOption) {
+          errorMessage = "You must select an option.";
+          renderOptions();
+        } else {
+          cleanup();
+          const booleanValue = selectedIndex === 0;
+          void completePrompt(
+            "toggle",
+            false,
+            endTitle,
+            endTitleColor,
+            titleTypography,
+            titleVariant ? titleVariant : void 0,
+            border,
+            borderColor,
+            void 0,
+            booleanValue
+          );
+          resolve(booleanValue);
+          deleteLastLine();
+          msg({ type: "M_BAR", borderColor });
+        }
+      } else if (key.name === "c" && key.ctrl) {
+        endPrompt(true);
+      }
+    }
+    input.on("keypress", handleKeypress);
+  });
+}

package/bin/core-impl/st-end/end.d.ts

@@ -0,0 +1,2 @@
+import type { PromptOptions } from "../../core-types.js";
+export declare function endPrompt({ title, titleColor, titleTypography, titleVariant, titleAnimation, titleAnimationDelay, border, borderColor, horizontalLineLength, }: PromptOptions): Promise<void>;

package/bin/core-impl/st-end/end.js

@@ -0,0 +1,42 @@
+import { msg } from "../msg-fmt/messages.js";
+import { getExactTerminalWidth } from "../msg-fmt/terminal.js";
+import { animateText } from "../visual/animate/animate.js";
+export async function endPrompt({
+  title = "",
+  titleColor = "cyan",
+  titleTypography = "none",
+  titleVariant,
+  titleAnimation,
+  titleAnimationDelay,
+  border = true,
+  borderColor = "dim",
+  horizontalLineLength = 0
+}) {
+  if (horizontalLineLength === 0) {
+    horizontalLineLength = getExactTerminalWidth() - 3;
+  }
+  if (titleAnimation) {
+    await animateText({
+      title: title ? title : " ",
+      anim: titleAnimation,
+      delay: titleAnimationDelay,
+      type: "M_END",
+      titleColor,
+      titleTypography,
+      border,
+      borderColor,
+      horizontalLineLength
+    });
+  } else {
+    msg({
+      type: "M_END",
+      title: title ? title : " ",
+      titleColor,
+      titleTypography,
+      titleVariant,
+      border,
+      borderColor,
+      horizontalLineLength
+    });
+  }
+}