@reliverse/rempts 1.6.0

package/bin/core-impl/utils/stream-text.js

@@ -0,0 +1,136 @@
+import { re } from "@reliverse/relico";
+import { stdout } from "node:process";
+import ora from "ora";
+import { cursor } from "sisteransi";
+import terminalSize from "terminal-size";
+import wrapAnsi from "wrap-ansi";
+import { toBaseColor } from "../msg-fmt/colors.js";
+import { msg } from "../msg-fmt/messages.js";
+function getTerminalWidth() {
+  return terminalSize().columns;
+}
+let isStartOfLine = true;
+let isFirstLine = true;
+function stripAnsi(text) {
+  return text.replace(/\x1b\[[0-9;]*[a-zA-Z]/g, "");
+}
+function extractAnsi(text) {
+  return text.match(/\x1b\[[0-9;]*[a-zA-Z]/g) || [];
+}
+function wrapWithBar(text, isFirst, color) {
+  const prefix = isFirst ? re.green("\u25C6") : re.dim("\u2502");
+  const ansiCodes = extractAnsi(text);
+  const cleanText = stripAnsi(text);
+  const coloredText = color ? re[color](cleanText) : re.dim(cleanText);
+  const finalText = ansiCodes.length > 0 ? ansiCodes.join("") + coloredText : coloredText;
+  return `${prefix}  ${finalText}`;
+}
+function wrapText(text) {
+  const width = getTerminalWidth();
+  return wrapAnsi(text, width - 4, { hard: false, trim: true });
+}
+export async function streamText({
+  text,
+  delay = 50,
+  showCursor = false,
+  color,
+  newline = true,
+  clearLine = false,
+  onProgress
+}) {
+  if (!showCursor) {
+    stdout.write(cursor.hide);
+  }
+  if (clearLine) {
+    stdout.write("\r\x1B[K");
+  }
+  const wrappedText = wrapText(text);
+  isFirstLine = true;
+  let buffer = "";
+  for (const char of wrappedText) {
+    if (char === "\n") {
+      if (buffer) {
+        const output = isStartOfLine ? wrapWithBar(buffer, isFirstLine, color) : color ? re[color](buffer) : re.dim(buffer);
+        stdout.write(output);
+        buffer = "";
+      }
+      stdout.write(char);
+      isStartOfLine = true;
+      isFirstLine = false;
+      continue;
+    }
+    buffer += char;
+    if (!char.includes("\x1B[") && buffer) {
+      const output = isStartOfLine ? wrapWithBar(buffer, isFirstLine, color) : color ? re[color](buffer) : re.dim(buffer);
+      stdout.write(output);
+      await new Promise((resolve) => setTimeout(resolve, delay));
+      isStartOfLine = false;
+      buffer = "";
+      if (onProgress) {
+        onProgress(output);
+      }
+    }
+  }
+  if (buffer) {
+    const output = isStartOfLine ? wrapWithBar(buffer, isFirstLine, color) : color ? re[color](buffer) : re.dim(buffer);
+    stdout.write(output);
+    if (onProgress) {
+      onProgress(output);
+    }
+  }
+  if (newline) {
+    stdout.write("\n");
+  }
+  if (!showCursor) {
+    stdout.write(cursor.show);
+  }
+}
+export async function streamTextBox({
+  text,
+  delay = 50,
+  color,
+  borderColor = "dim"
+}) {
+  stdout.write(cursor.hide);
+  msg({
+    type: "M_START",
+    title: "",
+    borderColor
+  });
+  await streamText({
+    text,
+    delay,
+    showCursor: false,
+    color,
+    newline: false,
+    clearLine: false
+  });
+  msg({
+    type: "M_END",
+    borderColor
+  });
+  stdout.write(cursor.show);
+}
+export async function streamTextWithSpinner({
+  text,
+  delay = 50,
+  color = "cyan",
+  spinnerFrames,
+  spinnerDelay
+}) {
+  let currentText = "";
+  const spinner = ora({
+    text: currentText,
+    color: toBaseColor(color),
+    spinner: spinnerFrames ? {
+      frames: spinnerFrames,
+      interval: spinnerDelay
+    } : "dots"
+  }).start();
+  for (const char of text) {
+    currentText += char;
+    spinner.text = color ? re[color](currentText) : currentText;
+    await new Promise((resolve) => setTimeout(resolve, delay));
+  }
+  spinner.stop();
+}

package/bin/core-impl/utils/system.d.ts

@@ -0,0 +1,6 @@
+export declare const pm: import("@reliverse/runtime").PkgManagerInfo;
+export declare const reliversePrompts: {
+    name: string;
+    version: string;
+    description: string;
+};

package/bin/core-impl/utils/system.js

@@ -0,0 +1,7 @@
+import { getUserPkgManager } from "@reliverse/runtime";
+export const pm = await getUserPkgManager();
+export const reliversePrompts = {
+  name: "@reliverse/prompts",
+  version: "1.6.0",
+  description: "@reliverse/prompts is a powerful library that enables seamless, typesafe, and resilient prompts for command-line applications. Crafted with simplicity and elegance, it provides developers with an intuitive and robust way to build interactive CLIs."
+};

package/bin/core-impl/utils/validate.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Checks if the terminal is interactive
+ */
+export declare function isTerminalInteractive(input?: NodeJS.ReadStream & {
+    fd: 0;
+}): boolean;
+/**
+ * Validates a name against allowed characters
+ */
+type ValidationResult = {
+    isValid: boolean;
+    message?: string;
+};
+export declare function isValidName(name: string): ValidationResult;
+/**
+ * Cleans up project name from config by removing scope and invalid characters.
+ * For paths with multiple segments (e.g. "@org/subpath/cli"), takes the last segment.
+ * This also ensures complex cases (e.g. "@some@weird/path/the-name!" returns "the-name").
+ */
+export declare function normalizeName(name: string): string;
+export {};

package/bin/core-impl/utils/validate.js

@@ -0,0 +1,17 @@
+export function isTerminalInteractive(input = process.stdin) {
+  return Boolean(input.isTTY);
+}
+export function isValidName(name) {
+  if (!/^[a-zA-Z0-9-]+$/.test(name)) {
+    return {
+      isValid: false,
+      message: "Project name can only contain latin letters, numbers and hyphens"
+    };
+  }
+  return { isValid: true };
+}
+export function normalizeName(name) {
+  const segments = name.split("/");
+  const lastSegment = segments[segments.length - 1] ?? name;
+  return lastSegment.replace(/[^a-zA-Z0-9-]/g, "");
+}

package/bin/core-impl/visual/animate/animate.d.ts

@@ -0,0 +1,14 @@
+import { type Animation, type AnimationName } from "@figliolia/chalk-animation";
+import type { BorderColorName, ColorName, MsgType, TypographyName } from "../../../core-types.js";
+export declare const animationMap: Record<AnimationName, (text: string) => Animation>;
+export declare function animateText({ title, anim, delay, type, titleColor, titleTypography, border, borderColor, horizontalLineLength, }: {
+    title: string;
+    anim: AnimationName;
+    delay?: number;
+    type?: MsgType;
+    titleColor?: ColorName;
+    titleTypography?: TypographyName;
+    borderColor?: BorderColorName;
+    border?: boolean;
+    horizontalLineLength?: number;
+}): Promise<void>;

package/bin/core-impl/visual/animate/animate.js

@@ -0,0 +1,65 @@
+import {
+  ChalkAnimation
+} from "@figliolia/chalk-animation";
+import { relinka } from "@reliverse/relinka";
+import { msg } from "../../msg-fmt/messages.js";
+import {
+  deleteLastLine,
+  getTerminalWidth
+} from "../../msg-fmt/terminal.js";
+export const animationMap = {
+  rainbow: ChalkAnimation.rainbow,
+  pulse: ChalkAnimation.pulse,
+  glitch: ChalkAnimation.glitch,
+  radar: ChalkAnimation.radar,
+  neon: ChalkAnimation.neon,
+  karaoke: ChalkAnimation.karaoke
+};
+function calculateDelay(text) {
+  const baseDelay = 1e3;
+  const delayPerCharacter = 50;
+  return baseDelay + text.length * delayPerCharacter;
+}
+export async function animateText({
+  title = "",
+  anim,
+  delay,
+  type = "M_INFO",
+  titleColor = "cyan",
+  titleTypography = "none",
+  border = true,
+  borderColor = "dim",
+  horizontalLineLength = 0
+}) {
+  if (horizontalLineLength === 0) {
+    horizontalLineLength = getTerminalWidth() - 5;
+  }
+  const finalDelay = delay ?? calculateDelay(title);
+  const animation = animationMap[anim](title);
+  try {
+    await new Promise((resolve) => {
+      setTimeout(() => {
+        animation.stop();
+        deleteLastLine();
+        if (title.includes("\u2502  ")) {
+          title = title.replace("\u2502  ", "");
+        } else if (title.includes("\u2139  ")) {
+          title = title.replace("\u2139  ", "");
+        }
+        msg({
+          type,
+          title,
+          titleColor,
+          titleTypography,
+          content: "",
+          borderColor,
+          border,
+          horizontalLineLength
+        });
+        resolve();
+      }, finalDelay);
+    });
+  } catch (error) {
+    relinka("error", "Animation failed to complete.", error);
+  }
+}

package/bin/core-impl/visual/ascii-art/ascii-art.d.ts

@@ -0,0 +1,6 @@
+import { type Fonts } from "figlet";
+export declare function createAsciiArt({ message, font, clearConsole, }: {
+    message: string;
+    font?: Fonts;
+    clearConsole?: boolean;
+}): Promise<void>;

package/bin/core-impl/visual/ascii-art/ascii-art.js

@@ -0,0 +1,13 @@
+import { relinka } from "@reliverse/relinka";
+import figlet from "figlet";
+export async function createAsciiArt({
+  message,
+  font = "Standard",
+  clearConsole = false
+}) {
+  if (clearConsole) {
+    relinka("clear", "");
+  }
+  const asciiArt = figlet.textSync(message, { font });
+  relinka("info", asciiArt);
+}

package/bin/core-types.d.ts

@@ -0,0 +1,334 @@
+export type MsgType = "M_NULL" | "M_INFO_NULL" | "M_START" | "M_MIDDLE" | "M_GENERAL" | "M_GENERAL_NULL" | "M_INFO" | "M_ERROR" | "M_ERROR_NULL" | "M_END" | "M_NEWLINE" | "M_BAR";
+export type TypographyName = "bold" | "strikethrough" | "underline" | "italic" | "none";
+export type BorderColorName = "reset" | "inverse" | "dim" | "black" | "red" | "redBright" | "green" | "greenBright" | "yellow" | "yellowBright" | "blue" | "blueBright" | "magenta" | "magentaBright" | "cyan" | "cyanBright" | "bgCyan" | "bgCyanBright" | "white" | "gray";
+export type ColorName = BorderColorName | "gradientGradient" | "rainbowGradient" | "cristalGradient" | "mindGradient" | "passionGradient" | "viceGradient" | "retroGradient" | "none";
+type AnimationName = "rainbow" | "pulse" | "glitch" | "radar" | "neon" | "karaoke";
+export type VariantName = "doubleBox" | "none";
+export type MsgConfig = {
+    symbol: string;
+    prefix?: string;
+    color?: (text: string) => string;
+    newLineBefore?: boolean;
+    newLineAfter?: boolean;
+    suffix?: string;
+};
+export type PromptOptions = {
+    schema?: any;
+    title?: string;
+    titleColor?: ColorName;
+    titleTypography?: TypographyName;
+    titleVariant?: VariantName;
+    titleAnimation?: AnimationName;
+    titleAnimationDelay?: number;
+    content?: string;
+    contentColor?: ColorName;
+    contentTypography?: TypographyName;
+    contentVariant?: VariantName;
+    hint?: string;
+    placeholder?: string;
+    validate?: (value: any) => boolean | string | Promise<boolean | string>;
+    defaultColor?: ColorName;
+    defaultTypography?: TypographyName;
+    choices?: ChoiceOptions[];
+    variantOptions?: {
+        box?: {
+            limit?: number;
+        };
+    };
+    action?: () => Promise<void>;
+    border?: boolean;
+    borderColor?: BorderColorName;
+    additionalLinesToDelete?: number;
+    hintPlaceholderColor?: ColorName;
+    hints?: string[];
+    required?: boolean;
+    initial?: any[];
+    endTitle?: string;
+    endTitleColor?: ColorName;
+    horizontalLine?: boolean;
+    horizontalLineLength?: number;
+    symbol?: string;
+    customSymbol?: string;
+};
+type ChoiceRequiredOptions = {
+    id: string;
+    title: string;
+};
+type ChoiceOptionalOptions = {
+    description?: string;
+    titleTypography?: TypographyName;
+    action?: () => Promise<void>;
+};
+export type ChoiceOptions = ChoiceRequiredOptions & ChoiceOptionalOptions;
+export type SelectOption<T> = {
+    value: T;
+    label: string;
+    hint?: string;
+    disabled?: boolean;
+};
+/**
+ * Standard terminal colors supported by most terminals
+ */
+export type StandardColor = "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray";
+/**
+ * All possible output colors including special colors
+ */
+export type OutputColor = StandardColor | "dim";
+export type EditorExitResult = {
+    saved: boolean;
+    content: string | null;
+    filename: string | null;
+};
+export type MessageKind = "log" | "info" | "warn" | "error" | "success";
+type VerboseKind = `${MessageKind}-verbose`;
+export type AllKinds = MessageKind | VerboseKind;
+export type MessageConfig = {
+    type: "M_INFO" | "M_ERROR";
+    titleColor?: "retroGradient" | "viceGradient" | "yellowBright";
+    titleTypography?: "bold";
+    contentColor?: "dim";
+    contentTypography?: "italic";
+};
+export type StreamOptions = {
+    delay?: number;
+    useSpinner?: boolean;
+    spinnerFrames?: string[];
+    spinnerDelay?: number;
+};
+export type ProgressBarOptions = {
+    total: number;
+    width?: number;
+    completeChar?: string;
+    incompleteChar?: string;
+    format?: string;
+    colorize?: boolean;
+    increment?: number;
+    desiredTotalTime?: number;
+};
+export type ProgressBar = {
+    update: (value: number) => Promise<void>;
+    increment: (amount?: number) => Promise<void>;
+    render: () => Promise<void>;
+};
+/**
+ * Union type for available prompt types.
+ */
+export type PromptType = "input" | "inputmasked" | "select" | "multiselect" | "nummultiselect" | "numselect" | "toggle" | "confirm" | "spinner" | "progressbar" | "results" | "nextsteps" | "animatedtext" | "date" | "end";
+export type ConfirmPromptOptions = {
+    title: string;
+    defaultValue?: boolean;
+    content?: string;
+    titleColor?: ColorName;
+    titleTypography?: TypographyName;
+    titleVariant?: VariantName;
+    contentColor?: ColorName;
+    contentTypography?: TypographyName;
+    contentVariant?: VariantName;
+    borderColor?: BorderColorName;
+    hintPlaceholderColor?: ColorName;
+    variantOptions?: any;
+    action?: () => Promise<void>;
+    displayInstructions?: boolean;
+    debug?: boolean;
+    endTitle?: string;
+    endTitleColor?: ColorName;
+    border?: boolean;
+    terminalWidth?: number;
+};
+export type StreamTextOptions = {
+    /**
+     * Text to stream
+     */
+    text: string;
+    /**
+     * Delay between each character in milliseconds
+     * @default 50
+     */
+    delay?: number;
+    /**
+     * Whether to show cursor while streaming
+     * @default false
+     */
+    showCursor?: boolean;
+    /**
+     * Color to use for the text
+     * @default undefined (no color)
+     */
+    color?: ColorName;
+    /**
+     * Whether to add a newline at the end
+     * @default true
+     */
+    newline?: boolean;
+    /**
+     * Whether to clear the line before streaming
+     * @default false
+     */
+    clearLine?: boolean;
+    /**
+     * Callback function to update the spinner text
+     */
+    onProgress?: (currentText: string) => void;
+};
+export type PreventWrongTerminalSizeOptions = {
+    isDev?: boolean;
+    shouldExit?: boolean;
+    minWidth?: number;
+    minHeight?: number;
+    sizeErrorDescription?: string;
+};
+/**
+ * InputPromptOptions
+ *
+ * Extended options for handling user input prompts, including validation
+ * and UI styling. Inherits from PromptOptions.
+ */
+export type InputPromptOptions = {
+    border?: boolean;
+    borderColor?: BorderColorName;
+    content?: string;
+    contentColor?: ColorName;
+    contentTypography?: TypographyName;
+    contentVariant?: VariantName;
+    customSymbol?: string;
+    defaultValue?: string;
+    endTitle?: string;
+    endTitleColor?: ColorName;
+    hardcoded?: {
+        userInput?: string;
+        errorMessage?: string;
+        showPlaceholder?: boolean;
+    };
+    hint?: string;
+    hintPlaceholderColor?: ColorName;
+    mode?: "plain" | "password";
+    mask?: string;
+    placeholder?: string;
+    schema?: any;
+    shouldStream?: boolean;
+    streamDelay?: number;
+    symbol?: SymbolName;
+    symbolColor?: ColorName;
+    title: string;
+    titleColor?: ColorName;
+    titleTypography?: TypographyName;
+    titleVariant?: VariantName;
+    validate?: (value: string) => string | boolean | undefined | Promise<string | boolean | undefined>;
+    variantOptions?: unknown;
+} & PromptOptions;
+export type RenderParams = {
+    border: boolean;
+    borderColor?: BorderColorName;
+    content?: string;
+    contentColor?: ColorName;
+    contentTypography?: TypographyName;
+    contentVariant?: VariantName;
+    customSymbol?: string;
+    errorMessage: string;
+    hint?: string;
+    hintPlaceholderColor?: ColorName;
+    mask?: string;
+    placeholder?: string;
+    symbol?: SymbolName;
+    symbolColor?: ColorName;
+    title: string;
+    titleColor?: ColorName;
+    titleTypography?: TypographyName;
+    titleVariant?: VariantName;
+    userInput: string;
+    isRerender?: boolean;
+};
+/**
+ * Known symbol names that will have IntelliSense support
+ */
+export type SymbolName = "pointer" | "start" | "middle" | "end" | "line" | "corner_top_right" | "step_active" | "step_error" | "info" | "success";
+export type Symbols = Record<SymbolName, string>;
+export type FmtMsgOptions = {
+    type: MsgType;
+    title?: string;
+    titleAfterAnim?: string;
+    content?: string | undefined;
+    titleColor?: ColorName;
+    titleTypography?: TypographyName;
+    titleVariant?: VariantName;
+    contentColor?: ColorName;
+    contentTypography?: TypographyName;
+    contentVariant?: VariantName;
+    hint?: string;
+    hintPlaceholderColor?: ColorName;
+    hintTypography?: TypographyName;
+    border?: boolean;
+    borderColor?: ColorName;
+    dontRemoveBar?: boolean;
+    variantOptions?: {
+        box?: {
+            limit?: number;
+        };
+    };
+    errorMessage?: string;
+    addNewLineBefore?: boolean;
+    addNewLineAfter?: boolean;
+    placeholder?: string;
+    horizontalLine?: boolean;
+    horizontalLineLength?: number;
+    terminalWidth?: number;
+    instructions?: string;
+    wrapTitle?: boolean;
+    wrapContent?: boolean;
+    symbol?: SymbolName;
+    customSymbol?: string;
+    symbolColor?: ColorName;
+    noNewLine?: boolean;
+};
+export type TogglePromptParams<T extends string> = {
+    title: string;
+    content?: string;
+    options?: [T, T];
+    defaultValue?: T;
+    borderColor?: BorderColorName;
+    titleColor?: ColorName;
+    titleTypography?: TypographyName;
+    titleVariant?: VariantName;
+    contentColor?: ColorName;
+    contentTypography?: TypographyName;
+    border?: boolean;
+    endTitle?: string;
+    endTitleColor?: ColorName;
+    displayInstructions?: boolean;
+    debug?: boolean;
+};
+export type SeparatorOption = {
+    separator: true;
+    width?: number;
+    symbol?: SymbolName;
+};
+export type MultiselectPromptParams<T extends string> = {
+    title: string;
+    content?: string;
+    options: (SelectOption<T> | SeparatorOption)[];
+    defaultValue?: T[];
+    borderColor?: BorderColorName;
+    titleColor?: ColorName;
+    titleTypography?: TypographyName;
+    titleVariant?: VariantName;
+    contentColor?: ColorName;
+    contentTypography?: TypographyName;
+    border?: boolean;
+    endTitle?: string;
+    endTitleColor?: ColorName;
+    debug?: boolean;
+    terminalWidth?: number;
+    displayInstructions?: boolean;
+    minSelect?: number;
+    maxSelect?: number;
+    selectAll?: boolean;
+};
+export type DatePromptOptions = PromptOptions & {
+    dateFormat: string;
+    dateKind: "birthday" | "other";
+    defaultValue?: string;
+    endTitle?: string;
+    endTitleColor?: ColorName;
+    border?: boolean;
+};
+export {};

package/bin/main.d.ts

@@ -0,0 +1,36 @@
+export { anykeyPrompt } from "./core-impl/anykey/anykey-mod.js";
+export { datePrompt } from "./core-impl/date/date.js";
+export { startEditor } from "./core-impl/editor/editor-mod.js";
+export { mainSymbols, fallbackSymbols, } from "./core-impl/figures/figures-mod.js";
+export { confirmPrompt } from "./core-impl/input/confirm-prompt.js";
+export { inputPrompt } from "./core-impl/input/input-prompt.js";
+export type { ArgDefinition, ArgDefinitions, SubCommandsMap, Command, InferArgTypes, FileBasedCmdsOptions, } from "./core-impl/launcher/launcher-mod.js";
+export { defineCommand, showUsage, runMain, } from "./core-impl/launcher/launcher-mod.js";
+export { toBaseColor, toSolidColor } from "./core-impl/msg-fmt/colors.js";
+export { relinkaByRemptsDeprecated, relinkaAsyncByRemptsDeprecated, throwError, } from "./core-impl/msg-fmt/logger.js";
+export { colorMap, typographyMap } from "./core-impl/msg-fmt/mapping.js";
+export { symbols, bar, fmt, msg, msgUndo, msgUndoAll, printLineBar, } from "./core-impl/msg-fmt/messages.js";
+export { getTerminalHeight, getExactTerminalWidth, getTerminalWidth, breakLines, removeCursor, restoreCursor, deleteLastLine, deleteLastLines, countLines, } from "./core-impl/msg-fmt/terminal.js";
+export { variantMap, isValidVariant, applyVariant, } from "./core-impl/msg-fmt/variants.js";
+export { nextStepsPrompt } from "./core-impl/next-steps/next-steps.js";
+export { numberPrompt } from "./core-impl/number/number-mod.js";
+export type { ResultsType } from "./core-impl/results/results.js";
+export { resultPrompt } from "./core-impl/results/results.js";
+export { multiselectPrompt } from "./core-impl/select/multiselect-prompt.js";
+export { numMultiSelectPrompt } from "./core-impl/select/nummultiselect-prompt.js";
+export { numSelectPrompt } from "./core-impl/select/numselect-prompt.js";
+export { selectPrompt } from "./core-impl/select/select-prompt.js";
+export { togglePrompt } from "./core-impl/select/toggle-prompt.js";
+export { endPrompt } from "./core-impl/st-end/end.js";
+export { startPrompt } from "./core-impl/st-end/start.js";
+export { progressTaskPrompt } from "./core-impl/task/progress.js";
+export { spinnerTaskPrompt } from "./core-impl/task/spinner.js";
+export { colorize } from "./core-impl/utils/colorize.js";
+export { errorHandler } from "./core-impl/utils/errors.js";
+export { preventUnsupportedTTY, preventWindowsHomeDirRoot, preventWrongTerminalSize, } from "./core-impl/utils/prevent.js";
+export { completePrompt, renderEndLine, renderEndLineInput, } from "./core-impl/utils/prompt-end.js";
+export { streamText, streamTextBox, streamTextWithSpinner, } from "./core-impl/utils/stream-text.js";
+export { pm, reliversePrompts } from "./core-impl/utils/system.js";
+export { isTerminalInteractive, isValidName, normalizeName, } from "./core-impl/utils/validate.js";
+export { animationMap, animateText, } from "./core-impl/visual/animate/animate.js";
+export { createAsciiArt } from "./core-impl/visual/ascii-art/ascii-art.js";