@reliverse/rempts 1.7.28 → 1.7.29

package/bin/components/select/select-prompt.d.ts

@@ -1,12 +1,13 @@
 import type { BorderColorName, ColorName, SelectOption, TypographyName, VariantName } from "../../types.js";
 import { symbols } from "../msg-fmt/messages.js";
-type SeparatorOption = {
+interface SeparatorOption {
     separator: true;
     width?: number;
     symbol?: keyof typeof symbols;
-};
-type SelectPromptParams<T extends string> = {
-    title: string;
+}
+interface SelectPromptParams<T extends string> {
+    title?: string;
+    message?: string;
     content?: string;
     options: (SelectOption<T> | SeparatorOption)[];
     defaultValue?: T;
@@ -25,7 +26,7 @@ type SelectPromptParams<T extends string> = {
     displayInstructions?: boolean;
     shouldStream?: boolean;
     streamDelay?: number;
-};
+}
 /**
  * Displays a selectable prompt in the terminal and returns the chosen value.
  */

package/bin/components/select/select-prompt.js

@@ -111,6 +111,7 @@ async function renderPromptUI(params) {
 export async function selectPrompt(params) {
   const {
     title = "",
+    message = "",
     content = "",
     options,
     defaultValue,
@@ -130,6 +131,7 @@ export async function selectPrompt(params) {
     shouldStream = false,
     streamDelay = 20
   } = params;
+  const finalTitle = message || title;
   let selectedIndex = defaultValue ? options.findIndex(
     (option) => isSelectOption(option) && option.value === defaultValue && !option.disabled
   ) : -1;
@@ -159,7 +161,7 @@ export async function selectPrompt(params) {
       }
     }
     void renderPromptUI({
-      title,
+      title: finalTitle,
       content,
       options,
       selectedIndex,
@@ -183,7 +185,7 @@ export async function selectPrompt(params) {
     });
   }
   lastUILineCount = await renderPromptUI({
-    title,
+    title: finalTitle,
     content,
     options,
     selectedIndex,

package/bin/components/spinner/spinner-mod.d.ts

@@ -0,0 +1,106 @@
+interface SpinnerOptions {
+    cancelMessage?: string;
+    color?: string;
+    delay?: number;
+    errorMessage?: string;
+    failText?: string;
+    frames?: string[];
+    hideCursor?: boolean;
+    indicator?: "dots" | "timer";
+    onCancel?: () => void;
+    prefixText?: string;
+    signal?: AbortSignal;
+    silent?: boolean;
+    spinner?: string;
+    successText?: string;
+    text: string;
+}
+interface ProgressOptions {
+    current: number;
+    total: number;
+    format?: "percentage" | "count" | "both";
+}
+interface SpinnerControls {
+    start: (text?: string) => SpinnerControls;
+    stop: (text?: string, code?: number) => void;
+    setText: (text: string) => void;
+    setProgress: (progress: ProgressOptions) => void;
+    succeed: (text?: string) => void;
+    fail: (text?: string) => void;
+    warn: (text?: string) => void;
+    info: (text?: string) => void;
+    isSpinning: () => boolean;
+    clear: () => void;
+    getElapsedTime: () => number;
+    pause: () => void;
+    resume: () => void;
+    dispose: () => void;
+    isCancelled: boolean;
+}
+/**
+ * Creates a terminal spinner with enhanced controls and styling options.
+ *
+ * @example
+ * ```typescript
+ * // Basic usage
+ * const spinner = useSpinner({ text: "Loading..." }).start();
+ * spinner.stop();
+ *
+ * // With progress tracking
+ * const spinner = useSpinner({ text: "Processing files..." }).start();
+ * for (let i = 0; i < files.length; i++) {
+ *   spinner.setProgress({ current: i + 1, total: files.length });
+ *   await processFile(files[i]);
+ * }
+ * spinner.succeed();
+ *
+ * // With custom color and spinner
+ * const spinner = useSpinner({
+ *   text: "Processing...",
+ *   color: "cyan",
+ *   spinner: "dots"
+ * }).start();
+ *
+ * // With success/failure states
+ * const spinner = useSpinner({
+ *   text: "Uploading...",
+ *   successText: "Upload complete!",
+ *   failText: "Upload failed!"
+ * }).start();
+ * try {
+ *   await uploadFile();
+ *   spinner.succeed();
+ * } catch (error) {
+ *   spinner.fail();
+ * }
+ *
+ * // Using the wrapper for async operations
+ * await useSpinner.promise(
+ *   async (spinner) => {
+ *     await longOperation();
+ *     spinner.setProgress({ current: 50, total: 100 });
+ *   },
+ *   {
+ *     text: "Working...",
+ *     successText: "Done!",
+ *     failText: "Failed!"
+ *   }
+ * );
+ * ```
+ */
+export declare function useSpinner(options: SpinnerOptions): SpinnerControls;
+export declare namespace useSpinner {
+    var promise: <T>(operation: (spinner: SpinnerControls) => Promise<T>, options: SpinnerOptions) => Promise<T>;
+    var nested: (parentOptions: SpinnerOptions) => {
+        start: () => {
+            child: (childOptions: SpinnerOptions) => SpinnerControls;
+            finish: (success: boolean, text?: string) => void;
+            dispose: () => void;
+        };
+    };
+    var withTiming: <T>(operation: (spinner: SpinnerControls) => Promise<T>, options: SpinnerOptions) => Promise<{
+        result: T;
+        duration: number;
+    }>;
+}
+export {};

package/bin/components/spinner/spinner-mod.js

@@ -0,0 +1,263 @@
+import { re } from "@reliverse/relico";
+import { block } from "../cancel/cancel.js";
+const unicode = process.platform !== "win32" || process.env.TERM_PROGRAM === "vscode";
+const defaultFrames = unicode ? ["\u25D2", "\u25D0", "\u25D3", "\u25D1"] : ["\u2022", "o", "O", "0"];
+const defaultDelay = unicode ? 80 : 120;
+function isInteractive() {
+  return process.stdout.isTTY && !process.env.CI && !process.env.GITHUB_ACTIONS && !process.env.GITLAB_CI && !process.env.BUILDKITE && process.env.TERM !== "dumb";
+}
+function formatProgress(options) {
+  const { current, total, format = "both" } = options;
+  const percentage = Math.round(current / total * 100);
+  switch (format) {
+    case "percentage":
+      return `${percentage}%`;
+    case "count":
+      return `${current}/${total}`;
+    case "both":
+      return `${current}/${total} (${percentage}%)`;
+    default:
+      return `${current}/${total}`;
+  }
+}
+function formatTimer(origin) {
+  const duration = (performance.now() - origin) / 1e3;
+  const min = Math.floor(duration / 60);
+  const secs = Math.floor(duration % 60);
+  return min > 0 ? `[${min}m ${secs}s]` : `[${secs}s]`;
+}
+function removeTrailingDots(msg) {
+  return msg.replace(/\.+$/, "");
+}
+export function useSpinner(options) {
+  let loop;
+  const interactive = isInteractive();
+  let unblock = null;
+  const state = {
+    isActive: false,
+    isPaused: false,
+    startTime: null,
+    pausedTime: 0,
+    text: options.text,
+    isCancelled: false,
+    origin: performance.now(),
+    indicatorTimer: 0
+  };
+  const handleExit = (code) => {
+    const msg = code > 1 ? options.errorMessage ?? "Operation failed" : options.cancelMessage ?? "Operation cancelled";
+    state.isCancelled = code === 1;
+    if (state.isActive) {
+      controls.stop(msg, code);
+      if (state.isCancelled && typeof options.onCancel === "function") {
+        options.onCancel();
+      }
+    }
+  };
+  const errorEventHandler = () => handleExit(2);
+  const signalEventHandler = () => handleExit(1);
+  const registerHooks = () => {
+    process.on("uncaughtExceptionMonitor", errorEventHandler);
+    process.on("unhandledRejection", errorEventHandler);
+    process.on("SIGINT", signalEventHandler);
+    process.on("SIGTERM", signalEventHandler);
+    process.on("exit", handleExit);
+    if (options.signal) {
+      options.signal.addEventListener("abort", signalEventHandler);
+    }
+  };
+  const clearHooks = () => {
+    process.removeListener("uncaughtExceptionMonitor", errorEventHandler);
+    process.removeListener("unhandledRejection", errorEventHandler);
+    process.removeListener("SIGINT", signalEventHandler);
+    process.removeListener("SIGTERM", signalEventHandler);
+    process.removeListener("exit", handleExit);
+    if (options.signal) {
+      options.signal.removeEventListener("abort", signalEventHandler);
+    }
+  };
+  const clearPrevMessage = () => {
+    if (state.prevMessage === void 0) return;
+    if (process.env.CI) process.stdout.write("\n");
+    const prevLines = state.prevMessage.split("\n");
+    process.stdout.write(`\x1B[${prevLines.length}A`);
+    process.stdout.write("\x1B[0J");
+  };
+  const controls = {
+    start: (text) => {
+      if (text) {
+        options.text = text;
+        state.text = text;
+      }
+      if (options.silent || !interactive) {
+        console.log(
+          options.prefixText ? `${options.prefixText} ${options.text}` : options.text
+        );
+        state.isActive = true;
+        state.startTime = Date.now();
+        return controls;
+      }
+      state.isActive = true;
+      state.origin = performance.now();
+      unblock = block({ output: process.stdout });
+      process.stdout.write(`${re.dim("\u2502")}
+`);
+      let frameIndex = 0;
+      registerHooks();
+      loop = setInterval(() => {
+        if (process.env.CI && state.text === state.prevMessage) {
+          return;
+        }
+        clearPrevMessage();
+        state.prevMessage = state.text;
+        const frame = re.magenta((options.frames ?? defaultFrames)[frameIndex]);
+        if (process.env.CI) {
+          process.stdout.write(`${frame}  ${state.text}...`);
+        } else if (options.indicator === "timer") {
+          process.stdout.write(
+            `${frame}  ${state.text} ${formatTimer(state.origin)}`
+          );
+        } else {
+          const loadingDots = ".".repeat(Math.floor(state.indicatorTimer)).slice(0, 3);
+          process.stdout.write(`${frame}  ${state.text}${loadingDots}`);
+        }
+        frameIndex = (frameIndex + 1) % (options.frames ?? defaultFrames).length;
+        state.indicatorTimer = state.indicatorTimer < 4 ? state.indicatorTimer + 0.125 : 0;
+      }, options.delay ?? defaultDelay);
+      return controls;
+    },
+    stop: (text, code = 0) => {
+      if (!state.isActive) return;
+      state.isActive = false;
+      clearInterval(loop);
+      clearPrevMessage();
+      const step = code === 0 ? re.green("\u2713") : code === 1 ? re.red("\u2717") : re.red("\u2717");
+      const finalText = text ?? state.text;
+      if (options.indicator === "timer") {
+        process.stdout.write(
+          `${step}  ${finalText} ${formatTimer(state.origin)}
+`
+        );
+      } else {
+        process.stdout.write(`${step}  ${finalText}
+`);
+      }
+      clearHooks();
+      if (unblock) unblock();
+    },
+    setText: (text) => {
+      state.text = removeTrailingDots(text);
+      options.text = text;
+    },
+    setProgress: (progress) => {
+      const progressText = formatProgress(progress);
+      const newText = `${state.text} [${progressText}]`;
+      state.text = newText;
+      options.text = newText;
+    },
+    succeed: (text) => {
+      const successText = text ?? options.successText ?? state.text;
+      controls.stop(successText, 0);
+    },
+    fail: (text) => {
+      const failText = text ?? options.failText ?? state.text;
+      controls.stop(failText, 2);
+    },
+    warn: (text) => {
+      const warnText = text ?? state.text;
+      controls.stop(warnText, 0);
+    },
+    info: (text) => {
+      const infoText = text ?? state.text;
+      controls.stop(infoText, 0);
+    },
+    isSpinning: () => {
+      return state.isActive && !state.isPaused;
+    },
+    clear: () => {
+      clearPrevMessage();
+    },
+    getElapsedTime: () => {
+      if (!state.startTime) return 0;
+      const currentTime = Date.now();
+      return currentTime - state.startTime - state.pausedTime;
+    },
+    pause: () => {
+      if (state.isActive && !state.isPaused) {
+        clearInterval(loop);
+        state.isPaused = true;
+      }
+    },
+    resume: () => {
+      if (state.isActive && state.isPaused) {
+        loop = setInterval(() => {
+        }, options.delay ?? defaultDelay);
+        state.isPaused = false;
+      }
+    },
+    dispose: () => {
+      if (state.isActive) {
+        controls.stop();
+      }
+      state.isActive = false;
+      state.isPaused = false;
+    },
+    get isCancelled() {
+      return state.isCancelled;
+    }
+  };
+  return controls;
+}
+useSpinner.promise = async (operation, options) => {
+  const spinner = useSpinner(options).start();
+  try {
+    const result = await operation(spinner);
+    spinner.succeed();
+    return result;
+  } catch (error) {
+    spinner.fail();
+    throw error;
+  } finally {
+    spinner.dispose();
+  }
+};
+useSpinner.nested = (parentOptions) => {
+  const parentSpinner = useSpinner({
+    ...parentOptions,
+    silent: true
+    // Parent is silent, children will show progress
+  });
+  return {
+    start: () => {
+      parentSpinner.start();
+      return {
+        child: (childOptions) => useSpinner(childOptions),
+        finish: (success, text) => {
+          if (success) {
+            parentSpinner.succeed(text);
+          } else {
+            parentSpinner.fail(text);
+          }
+        },
+        dispose: () => parentSpinner.dispose()
+      };
+    }
+  };
+};
+useSpinner.withTiming = async (operation, options) => {
+  const spinner = useSpinner(options).start();
+  const startTime = Date.now();
+  try {
+    const result = await operation(spinner);
+    const duration = Date.now() - startTime;
+    spinner.succeed(`${options.successText || options.text} (${duration}ms)`);
+    return { result, duration };
+  } catch (error) {
+    const duration = Date.now() - startTime;
+    spinner.fail(
+      `${options.failText || options.text} (failed after ${duration}ms)`
+    );
+    throw error;
+  } finally {
+    spinner.dispose();
+  }
+};

package/bin/components/task/progress.d.ts

@@ -1,2 +1,2 @@
 import type { ProgressBar, ProgressBarOptions } from "../../types.js";
-export declare function progressTaskPrompt(options: ProgressBarOptions): Promise<ProgressBar>;
+export declare function taskProgressPrompt(options: ProgressBarOptions): Promise<ProgressBar>;

package/bin/components/task/progress.js

@@ -1,6 +1,6 @@
 import { re } from "@reliverse/relico";
 import { cursor, erase } from "sisteransi";
-export async function progressTaskPrompt(options) {
+export async function taskProgressPrompt(options) {
   if (options.total <= 0) {
     throw new Error("Total must be a positive number");
   }

package/bin/components/task/{spinner.d.ts → task-spin.d.ts}

@@ -2,7 +2,7 @@ import type { SpinnerName } from "cli-spinners";
 type SimpleSpinnerType = "default" | "dottedCircle" | "boxSpinner";
 type OraSpinnerType = Extract<SpinnerName, OraAllowedSpinners>;
 type OraAllowedSpinners = "dots" | "bouncingBar" | "arc";
-type TaskOptions<T extends "simple" | "ora"> = {
+interface TaskOptions<T extends "simple" | "ora"> {
     initialMessage: string;
     successMessage?: string;
     errorMessage?: string;
@@ -10,6 +10,6 @@ type TaskOptions<T extends "simple" | "ora"> = {
     spinnerSolution: T;
     spinnerType?: T extends "simple" ? SimpleSpinnerType : OraSpinnerType;
     action: (updateMessage: (message: string) => void) => Promise<void>;
-};
-export declare function spinnerTaskPrompt<T extends "simple" | "ora">(options: TaskOptions<T>): Promise<void>;
+}
+export declare function taskSpinPrompt<T extends "simple" | "ora">(options: TaskOptions<T>): Promise<void>;
 export {};

package/bin/components/task/{spinner.js → task-spin.js}

@@ -3,7 +3,7 @@ import process from "node:process";
 import ora from "ora";
 import { cursor, erase } from "sisteransi";
 import { msg } from "../msg-fmt/messages.js";
-export async function spinnerTaskPrompt(options) {
+export async function taskSpinPrompt(options) {
   const {
     initialMessage,
     successMessage = "Task completed successfully.",

package/bin/mod.d.ts

@@ -2,7 +2,7 @@ export { anykeyPrompt } from "./components/anykey/anykey-mod.js";
 export { datePrompt } from "./components/date/date.js";
 export { startEditor } from "./components/editor/editor-mod.js";
 export { mainSymbols, fallbackSymbols, } from "./components/figures/figures-mod.js";
-export { confirmPrompt } from "./components/input/confirm-prompt.js";
+export { confirmPrompt } from "./components/confirm/confirm-prompt.js";
 export { inputPrompt } from "./components/input/input-prompt.js";
 export * from "./components/launcher/launcher-types.js";
 export { defineCommand, defineArgs, showUsage, runMain, runCmd, } from "./components/launcher/launcher-mod.js";
@@ -22,10 +22,10 @@ export { numMultiSelectPrompt } from "./components/select/nummultiselect-prompt.
 export { numSelectPrompt } from "./components/select/numselect-prompt.js";
 export { selectPrompt } from "./components/select/select-prompt.js";
 export { togglePrompt } from "./components/select/toggle-prompt.js";
-export { endPrompt } from "./components/st-end/end.js";
-export { startPrompt } from "./components/st-end/start.js";
-export { progressTaskPrompt } from "./components/task/progress.js";
-export { spinnerTaskPrompt } from "./components/task/spinner.js";
+export { introPrompt } from "./components/intro/intro-start.js";
+export { outroPrompt } from "./components/outro/outro-end.js";
+export { taskProgressPrompt } from "./components/task/progress.js";
+export { taskSpinPrompt } from "./components/task/task-spin.js";
 export { colorize } from "./utils/colorize.js";
 export { errorHandler } from "./utils/errors.js";
 export { preventUnsupportedTTY, preventWindowsHomeDirRoot, preventWrongTerminalSize, } from "./utils/prevent.js";
@@ -33,6 +33,9 @@ export { completePrompt, renderEndLine, renderEndLineInput, } from "./utils/prom
 export { streamText, streamTextBox, streamTextWithSpinner, } from "./utils/stream-text.js";
 export { pm, reliversePrompts } from "./utils/system.js";
 export { isTerminalInteractive, isValidName, normalizeName, } from "./utils/validate.js";
-export { animationMap, animateText, } from "./components/visual/animate/animate.js";
-export { createAsciiArt } from "./components/visual/ascii-art/ascii-art.js";
-export { useSpinner } from "./hooks/spinner/spinner-mod.js";
+export { animationMap, animateText, } from "./components/animate/animate.js";
+export { createAsciiArt } from "./components/ascii-art/ascii-art.js";
+export { useSpinner } from "./components/spinner/spinner-mod.js";
+export { log } from "./components/log/log.js";
+export { cancel, isCancel, createCancel, CANCEL, block, setRawMode, getColumns, isWindows, type CancelValue, } from "./components/cancel/cancel.js";
+export { password, input, text, multiselect, select, startPrompt, intro, endPrompt, outro, spinner, } from "./components/aliases/aliases-mod.js";

package/bin/mod.js

@@ -5,7 +5,7 @@ export {
   mainSymbols,
   fallbackSymbols
 } from "./components/figures/figures-mod.js";
-export { confirmPrompt } from "./components/input/confirm-prompt.js";
+export { confirmPrompt } from "./components/confirm/confirm-prompt.js";
 export { inputPrompt } from "./components/input/input-prompt.js";
 export * from "./components/launcher/launcher-types.js";
 export {
@@ -56,10 +56,10 @@ export { numMultiSelectPrompt } from "./components/select/nummultiselect-prompt.
 export { numSelectPrompt } from "./components/select/numselect-prompt.js";
 export { selectPrompt } from "./components/select/select-prompt.js";
 export { togglePrompt } from "./components/select/toggle-prompt.js";
-export { endPrompt } from "./components/st-end/end.js";
-export { startPrompt } from "./components/st-end/start.js";
-export { progressTaskPrompt } from "./components/task/progress.js";
-export { spinnerTaskPrompt } from "./components/task/spinner.js";
+export { introPrompt } from "./components/intro/intro-start.js";
+export { outroPrompt } from "./components/outro/outro-end.js";
+export { taskProgressPrompt } from "./components/task/progress.js";
+export { taskSpinPrompt } from "./components/task/task-spin.js";
 export { colorize } from "./utils/colorize.js";
 export { errorHandler } from "./utils/errors.js";
 export {
@@ -86,6 +86,29 @@ export {
 export {
   animationMap,
   animateText
-} from "./components/visual/animate/animate.js";
-export { createAsciiArt } from "./components/visual/ascii-art/ascii-art.js";
-export { useSpinner } from "./hooks/spinner/spinner-mod.js";
+} from "./components/animate/animate.js";
+export { createAsciiArt } from "./components/ascii-art/ascii-art.js";
+export { useSpinner } from "./components/spinner/spinner-mod.js";
+export { log } from "./components/log/log.js";
+export {
+  cancel,
+  isCancel,
+  createCancel,
+  CANCEL,
+  block,
+  setRawMode,
+  getColumns,
+  isWindows
+} from "./components/cancel/cancel.js";
+export {
+  password,
+  input,
+  text,
+  multiselect,
+  select,
+  startPrompt,
+  intro,
+  endPrompt,
+  outro,
+  spinner
+} from "./components/aliases/aliases-mod.js";