@reliverse/rempts 1.7.34 → 1.7.36

package/README.md

@@ -99,17 +99,19 @@ import {
 
 To help you migrate from the different CLI frameworks, `@reliverse/rempts` has some aliases for the most popular prompts.
 
-| Prompt                | Aliases         |
-|-----------------------|-----------------|
-| `useSpinner`          | `spinner`       |
-| `selectPrompt`        | `select`        |
-| `multiselectPrompt`   | `multiselect`   |
-| `inputPrompt`         | `text`, `input` |
-| `@reliverse/relinka`  | `log`           |
-
-### Notices
-
-- `setup`/`cleanup` are now `onCmdInit`/`onCmdExit` (old names still work for now).
+| Prompt                | Aliases          |
+|-----------------------|------------------|
+| `createCli`           | `runMain`        |
+| `onCmdInit`           | `setup`          |
+| `onCmdExit`           | `cleanup`        |
+| `useSpinner`          | `spinner`        |
+| `selectPrompt`        | `select`         |
+| `multiselectPrompt`   | `multiselect`    |
+| `inputPrompt`         | `text`, `input`  |
+| `confirmPrompt`       | `confirm`        |
+| `introPrompt`         | `intro`, `start` |
+| `outroPrompt`         | `outro`, `end`   |
+| `log`                 | `relinka`        |
 
 ### Prompts Usage Example
 

package/bin/libs/confirm/confirm-mod.js

@@ -84,7 +84,7 @@ export async function confirmPrompt(options) {
     endTitleColor = "dim",
     border = true
   } = options;
-  const finalTitle = message && title ? `${title}: ${message}` : message ?? title;
+  const finalTitle = message && title ? `${title}: ${message}` : message ?? title ?? "Confirm";
   const finalDefaultValue = defaultValue ?? initialValue;
   const rl = readline.createInterface({ input, output });
   let errorMessage = "";

package/bin/libs/group/group-mod.d.ts

@@ -0,0 +1,33 @@
+export interface GroupOptions {
+    onCancel?: () => void;
+    showProgress?: boolean;
+    title?: string;
+}
+export interface GroupContext<T> {
+    results: Partial<T>;
+    step: keyof T;
+    stepIndex: number;
+    totalSteps: number;
+}
+export type GroupStep<T, K extends keyof T> = (context: GroupContext<T>) => Promise<T[K]> | T[K];
+export type GroupSteps<T> = {
+    [K in keyof T]: GroupStep<T, K>;
+};
+/**
+ * Runs a series of prompts in sequence, where each prompt can depend on the results of previous prompts.
+ *
+ * @param steps Object where each key is a step name and each value is a function that returns a promise
+ * @param options Optional configuration including onCancel callback and progress display
+ * @returns Promise resolving to the complete results object
+ */
+export declare function group<T extends Record<string, any>>(steps: GroupSteps<T>, options?: GroupOptions): Promise<T>;
+/**
+ * Utility function to create a step that depends on specific previous results
+ */
+export declare function createStep<T, K extends keyof T, D extends keyof T>(stepFunction: (context: GroupContext<T>, dependency: T[D]) => Promise<T[K]> | T[K], dependencyKey: D): GroupStep<T, K>;
+/**
+ * Utility function to create a step that depends on multiple previous results
+ */
+export declare function createMultiStep<T, K extends keyof T, D extends (keyof T)[]>(stepFunction: (context: GroupContext<T>, dependencies: {
+    [P in D[number]]: T[P];
+}) => Promise<T[K]> | T[K], dependencyKeys: D): GroupStep<T, K>;

package/bin/libs/group/group-mod.js

@@ -0,0 +1,93 @@
+import { msg } from "../msg-fmt/messages.js";
+export async function group(steps, options = {}) {
+  const { showProgress = true, title = "Configuration" } = options;
+  const stepKeys = Object.keys(steps);
+  const results = {};
+  const totalSteps = stepKeys.length;
+  if (showProgress && title) {
+    msg({
+      type: "M_START",
+      title,
+      titleColor: "cyan",
+      titleTypography: "bold"
+    });
+  }
+  for (let stepIndex = 0; stepIndex < stepKeys.length; stepIndex++) {
+    const stepKey = stepKeys[stepIndex];
+    const stepFunction = steps[stepKey];
+    if (showProgress) {
+      msg({
+        type: "M_MIDDLE",
+        title: `Step ${stepIndex + 1}/${totalSteps}: ${String(stepKey)}`,
+        titleColor: "dim"
+      });
+    }
+    const context = {
+      results,
+      step: stepKey,
+      stepIndex,
+      totalSteps
+    };
+    try {
+      const result = await stepFunction(context);
+      results[stepKey] = result;
+      if (showProgress) {
+        msg({
+          type: "M_MIDDLE",
+          title: `\u2713 ${String(stepKey)} completed`,
+          titleColor: "green"
+        });
+      }
+    } catch (error) {
+      if (error instanceof Error && error.message === "CANCEL") {
+        if (options.onCancel) {
+          options.onCancel();
+        }
+        throw error;
+      }
+      if (showProgress) {
+        msg({
+          type: "M_ERROR",
+          title: `\u2717 ${String(stepKey)} failed: ${error instanceof Error ? error.message : String(error)}`,
+          titleColor: "red"
+        });
+      }
+      throw error;
+    }
+  }
+  if (showProgress) {
+    msg({
+      type: "M_END",
+      title: `${title} completed successfully!`,
+      titleColor: "green",
+      titleTypography: "bold"
+    });
+  }
+  return results;
+}
+export function createStep(stepFunction, dependencyKey) {
+  return (context) => {
+    const dependency = context.results[dependencyKey];
+    if (dependency === void 0) {
+      throw new Error(
+        `Dependency '${String(dependencyKey)}' is required but not available`
+      );
+    }
+    return stepFunction(context, dependency);
+  };
+}
+export function createMultiStep(stepFunction, dependencyKeys) {
+  return (context) => {
+    const dependencies = {};
+    for (const key of dependencyKeys) {
+      const dependency = context.results[key];
+      if (dependency === void 0) {
+        throw new Error(
+          `Dependency '${String(key)}' is required but not available`
+        );
+      }
+      dependencies[key] = dependency;
+    }
+    return stepFunction(context, dependencies);
+  };
+}

package/bin/libs/input/input-mod.js

@@ -100,7 +100,7 @@ function renderPromptUI(params) {
         symbolColor
       });
       void streamText({
-        text: title,
+        text: title || "",
         delay: streamDelay,
         color: titleColor,
         newline: false
@@ -229,7 +229,7 @@ export async function inputPrompt(options) {
     shouldStream = false,
     streamDelay = 20
   } = options;
-  const finalTitle = message && title ? `${title}: ${message}` : message ?? title;
+  const finalTitle = message && title ? `${title}: ${message}` : message ?? title ?? "Input";
   const finalDefaultValue = defaultValue ?? initialValue;
   const terminal = readline.createInterface({
     input: process.stdin,

package/bin/libs/multiselect/multiselect-prompt.js

@@ -110,12 +110,14 @@ export async function multiselectPrompt(params) {
     debug = false,
     terminalWidth: customTerminalWidth = 90,
     displayInstructions = false,
+    required = false,
     minSelect = 0,
     maxSelect,
     selectAll = false
   } = params;
-  const finalTitle = message && title ? `${title}: ${message}` : message ?? title;
+  const finalTitle = message && title ? `${title}: ${message}` : message ?? title ?? "Select options";
   const finalDefaultValue = defaultValue ?? initialValue;
+  const effectiveMinSelect = required ? Math.max(1, minSelect) : minSelect;
   let pointer = finalDefaultValue.length > 0 ? options.findIndex(
     (opt) => opt && isSelectOption(opt) && finalDefaultValue.includes(opt.value) && !opt.disabled
   ) : 0;
@@ -257,9 +259,9 @@ export async function multiselectPrompt(params) {
     }
     async function confirmSelection() {
       const selectedCount = selectedOptions.size;
-      if (selectedCount < minSelect) {
+      if (selectedCount < effectiveMinSelect) {
         deleteLastLine();
-        errorMessage = `You must select at least ${minSelect} option${minSelect !== 1 ? "s" : ""}.`;
+        errorMessage = `You must select at least ${effectiveMinSelect} option${effectiveMinSelect !== 1 ? "s" : ""}.`;
         renderOptions();
         return;
       }

package/bin/libs/select/select-alias.d.ts

@@ -0,0 +1,9 @@
+import type { SelectPromptParams } from "../../types.js";
+export declare const select: <T extends string>(params: SelectPromptParams<T>) => Promise<T>;
+export declare const selectSimple: <T extends string>(params: Omit<SelectPromptParams<T>, "options"> & {
+    options: {
+        value: T;
+        label?: string;
+        hint?: string;
+    }[];
+}) => Promise<T>;

package/bin/libs/select/select-alias.js

@@ -0,0 +1,9 @@
+import { selectPrompt } from "./select-prompt.js";
+export const select = selectPrompt;
+export const selectSimple = (params) => {
+  return selectPrompt({
+    ...params,
+    optionsArray: params.options,
+    options: void 0
+  });
+};

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

@@ -114,6 +114,7 @@ export async function selectPrompt(params) {
     message,
     content = "",
     options,
+    optionsArray,
     defaultValue,
     initialValue,
     required = false,
@@ -132,13 +133,19 @@ export async function selectPrompt(params) {
     shouldStream = false,
     streamDelay = 20
   } = params;
-  const finalTitle = message && title ? `${title}: ${message}` : message ?? title;
+  const finalTitle = message && title ? `${title}: ${message}` : message ?? title ?? "Select option";
   const finalDefaultValue = defaultValue ?? initialValue;
-  let selectedIndex = finalDefaultValue ? options.findIndex(
+  const finalOptions = options ?? optionsArray?.map((opt) => ({
+    value: opt.value,
+    label: opt.label ?? opt.value,
+    hint: opt.hint,
+    disabled: false
+  })) ?? [];
+  let selectedIndex = finalDefaultValue ? finalOptions.findIndex(
     (option) => isSelectOption(option) && option.value === finalDefaultValue && !option.disabled
   ) : -1;
   if (selectedIndex === -1) {
-    selectedIndex = options.findIndex(
+    selectedIndex = finalOptions.findIndex(
       (option) => isSelectOption(option) && !option.disabled
     );
   }
@@ -152,7 +159,7 @@ export async function selectPrompt(params) {
   }
   const instructions = "Use <\u2191/\u2193> or <k/j> to navigate, <Enter> to select, <Ctrl+C> to exit";
   let errorMessage = "";
-  const allDisabled = options.every(
+  const allDisabled = finalOptions.every(
     (option) => isSelectOption(option) && option.disabled
   );
   let lastUILineCount = 0;
@@ -165,7 +172,7 @@ export async function selectPrompt(params) {
     void renderPromptUI({
       title: finalTitle,
       content,
-      options,
+      options: finalOptions,
       selectedIndex,
       errorMessage,
       displayInstructions,
@@ -189,7 +196,7 @@ export async function selectPrompt(params) {
   lastUILineCount = await renderPromptUI({
     title: finalTitle,
     content,
-    options,
+    options: finalOptions,
     selectedIndex,
     errorMessage,
     displayInstructions,
@@ -229,8 +236,8 @@ export async function selectPrompt(params) {
     function moveSelectionUp() {
       const originalPointer = selectedIndex;
       do {
-        selectedIndex = (selectedIndex - 1 + options.length) % options.length;
-        const option = options[selectedIndex];
+        selectedIndex = (selectedIndex - 1 + finalOptions.length) % finalOptions.length;
+        const option = finalOptions[selectedIndex];
         if (option && isSelectOption(option) && !option.disabled) break;
       } while (selectedIndex !== originalPointer);
       renderOptions();
@@ -238,14 +245,14 @@ export async function selectPrompt(params) {
     function moveSelectionDown() {
       const originalPointer = selectedIndex;
       do {
-        selectedIndex = (selectedIndex + 1) % options.length;
-        const option = options[selectedIndex];
+        selectedIndex = (selectedIndex + 1) % finalOptions.length;
+        const option = finalOptions[selectedIndex];
         if (option && isSelectOption(option) && !option.disabled) break;
       } while (selectedIndex !== originalPointer);
       renderOptions();
     }
     async function confirmSelection() {
-      const option = options[selectedIndex];
+      const option = finalOptions[selectedIndex];
       if (!option || !isSelectOption(option)) {
         errorMessage = "This option is not selectable.";
         renderOptions();
@@ -256,7 +263,7 @@ export async function selectPrompt(params) {
         renderOptions();
         return;
       }
-      if (required && !option.value) {
+      if (required && (!option.value || option.value === "")) {
         errorMessage = "You must select a valid option.";
         renderOptions();
         return;

package/bin/mod.d.ts

@@ -7,6 +7,8 @@ export { confirmPrompt } from "./libs/confirm/confirm-mod.js";
 export { datePrompt } from "./libs/date/date.js";
 export { startEditor } from "./libs/editor/editor-mod.js";
 export { mainSymbols, fallbackSymbols, figures, } from "./libs/figures/figures-mod.js";
+export type { GroupOptions, GroupContext, GroupStep, GroupSteps, } from "./libs/group/group-mod.js";
+export { group, createStep, createMultiStep } from "./libs/group/group-mod.js";
 export { input, text, password } from "./libs/input/input-alias.js";
 export { inputPrompt } from "./libs/input/input-mod.js";
 export { startPrompt, intro } from "./libs/intro/intro-alias.js";
@@ -17,7 +19,7 @@ export type { EmptyArgs, BaseArgProps, BaseArgDefinition, PositionalArgDefinitio
 export { loadCommand } from "./libs/launcher/run-command.js";
 export { addCompletions } from "./libs/launcher/trpc-orpc-support/completions.js";
 export { CliValidationError, FailedToExitError, } from "./libs/launcher/trpc-orpc-support/errors.js";
-export { TrpcCommand, parseRouter, createRpcCli, z, trpcServer, zod, } from "./libs/launcher/trpc-orpc-support/index.js";
+export { TrpcCommand, parseRouter, createRpcCli, z, } from "./libs/launcher/trpc-orpc-support/index.js";
 export { flattenedProperties, incompatiblePropertyPairs, getDescription, getSchemaTypes, getEnumChoices, } from "./libs/launcher/trpc-orpc-support/json-schema.js";
 export type { CommandJSON } from "./libs/launcher/trpc-orpc-support/json.js";
 export { commandToJSON } from "./libs/launcher/trpc-orpc-support/json.js";
@@ -46,9 +48,9 @@ export { endPrompt, outro } from "./libs/outro/outro-alias.js";
 export { outroPrompt } from "./libs/outro/outro-mod.js";
 export type { ResultsType } from "./libs/results/results.js";
 export { resultPrompt } from "./libs/results/results.js";
-export { select } from "./libs/select/aliases-alias.js";
 export { numMultiSelectPrompt } from "./libs/select/nummultiselect-prompt.js";
 export { numSelectPrompt } from "./libs/select/numselect-prompt.js";
+export { select, selectSimple } from "./libs/select/select-alias.js";
 export { selectPrompt } from "./libs/select/select-prompt.js";
 export { togglePrompt } from "./libs/select/toggle-prompt.js";
 export { spinner } from "./libs/spinner/spinner-alias.js";
@@ -63,4 +65,4 @@ export { streamText, streamTextBox, streamTextWithSpinner, } from "./libs/utils/
 export { pm, reliversePrompts } from "./libs/utils/system.js";
 export { isTerminalInteractive, isValidName, normalizeName, } from "./libs/utils/validate.js";
 export { createAsciiArt } from "./libs/visual/visual-mod.js";
-export type { MsgType, TypographyName, BorderColorName, ColorName, VariantName, MsgConfig, PromptOptions, ChoiceOptions, SelectOption, StandardColor, OutputColor, EditorExitResult, MessageKind, AllKinds, MessageConfig, StreamOptions, ProgressBarOptions, ProgressBar, PromptType, ConfirmPromptOptions, StreamTextOptions, PreventWrongTerminalSizeOptions, InputPromptOptions, RenderParams, SymbolName, Symbols, FmtMsgOptions, TogglePromptParams, SeparatorOption, MultiselectPromptParams, DatePromptOptions, } from "./types.js";
+export type { MsgType, TypographyName, BorderColorName, ColorName, VariantName, MsgConfig, PromptOptions, ChoiceOptions, SelectOption, StandardColor, OutputColor, EditorExitResult, MessageKind, AllKinds, MessageConfig, StreamOptions, ProgressBarOptions, ProgressBar, PromptType, ConfirmPromptOptions, StreamTextOptions, PreventWrongTerminalSizeOptions, InputPromptOptions, RenderParams, SymbolName, Symbols, FmtMsgOptions, TogglePromptParams, SeparatorOption, SelectPromptParams, MultiselectPromptParams, DatePromptOptions, } from "./types.js";

package/bin/mod.js

@@ -19,6 +19,7 @@ export {
   fallbackSymbols,
   figures
 } from "./libs/figures/figures-mod.js";
+export { group, createStep, createMultiStep } from "./libs/group/group-mod.js";
 export { input, text, password } from "./libs/input/input-alias.js";
 export { inputPrompt } from "./libs/input/input-mod.js";
 export { startPrompt, intro } from "./libs/intro/intro-alias.js";
@@ -41,9 +42,7 @@ export {
   TrpcCommand,
   parseRouter,
   createRpcCli,
-  z,
-  trpcServer,
-  zod
+  z
 } from "./libs/launcher/trpc-orpc-support/index.js";
 export {
   flattenedProperties,
@@ -117,9 +116,9 @@ export { numberPrompt } from "./libs/number/number-mod.js";
 export { endPrompt, outro } from "./libs/outro/outro-alias.js";
 export { outroPrompt } from "./libs/outro/outro-mod.js";
 export { resultPrompt } from "./libs/results/results.js";
-export { select } from "./libs/select/aliases-alias.js";
 export { numMultiSelectPrompt } from "./libs/select/nummultiselect-prompt.js";
 export { numSelectPrompt } from "./libs/select/numselect-prompt.js";
+export { select, selectSimple } from "./libs/select/select-alias.js";
 export { selectPrompt } from "./libs/select/select-prompt.js";
 export { togglePrompt } from "./libs/select/toggle-prompt.js";
 export { spinner } from "./libs/spinner/spinner-alias.js";

package/bin/types.d.ts

@@ -115,7 +115,7 @@ export interface ProgressBar {
  */
 export type PromptType = "input" | "inputmasked" | "select" | "multiselect" | "nummultiselect" | "numselect" | "toggle" | "confirm" | "spinner" | "progressbar" | "results" | "nextsteps" | "animatedtext" | "date" | "end";
 export interface ConfirmPromptOptions {
-    title: string;
+    title?: string;
     message?: string;
     defaultValue?: boolean;
     initialValue?: boolean;
@@ -213,7 +213,7 @@ export type InputPromptOptions = {
     streamDelay?: number;
     symbol?: SymbolName;
     symbolColor?: ColorName;
-    title: string;
+    title?: string;
     titleColor?: ColorName;
     titleTypography?: TypographyName;
     titleVariant?: VariantName;
@@ -235,7 +235,7 @@ export interface RenderParams {
     placeholder?: string;
     symbol?: SymbolName;
     symbolColor?: ColorName;
-    title: string;
+    title?: string;
     titleColor?: ColorName;
     titleTypography?: TypographyName;
     titleVariant?: VariantName;
@@ -285,10 +285,12 @@ export interface FmtMsgOptions {
     noNewLine?: boolean;
 }
 export interface TogglePromptParams<T extends string> {
-    title: string;
+    title?: string;
+    message?: string;
     content?: string;
     options?: [T, T];
     defaultValue?: T;
+    initialValue?: T;
     borderColor?: BorderColorName;
     titleColor?: ColorName;
     titleTypography?: TypographyName;
@@ -310,7 +312,12 @@ export interface SelectPromptParams<T extends string> {
     title?: string;
     message?: string;
     content?: string;
-    options: (SelectOption<T> | SeparatorOption)[];
+    options?: (SelectOption<T> | SeparatorOption)[];
+    optionsArray?: {
+        value: T;
+        label?: string;
+        hint?: string;
+    }[];
     defaultValue?: T;
     initialValue?: T;
     required?: boolean;
@@ -330,7 +337,7 @@ export interface SelectPromptParams<T extends string> {
     streamDelay?: number;
 }
 export interface MultiselectPromptParams<T extends string> {
-    title: string;
+    title?: string;
     message?: string;
     content?: string;
     options: (SelectOption<T> | SeparatorOption)[];
@@ -348,6 +355,7 @@ export interface MultiselectPromptParams<T extends string> {
     debug?: boolean;
     terminalWidth?: number;
     displayInstructions?: boolean;
+    required?: boolean;
     minSelect?: number;
     maxSelect?: number;
     selectAll?: boolean;

package/package.json

@@ -44,7 +44,7 @@
   "license": "MIT",
   "name": "@reliverse/rempts",
   "type": "module",
-  "version": "1.7.34",
+  "version": "1.7.36",
   "author": "reliverse",
   "bugs": {
     "email": "blefnk@gmail.com",

package/bin/libs/select/aliases-alias.d.ts

@@ -1,2 +0,0 @@
-import type { SelectPromptParams } from "../../types.js";
-export declare const select: <T extends string>(params: SelectPromptParams<T>) => Promise<T>;

package/bin/libs/select/aliases-alias.js

@@ -1,2 +0,0 @@
-import { selectPrompt } from "./select-prompt.js";
-export const select = selectPrompt;