@nan0web/ui-cli 1.1.1 → 2.0.0

package/types/index.d.ts

@@ -1,16 +1,48 @@
-export { str2argv } from "./utils/parse.js";
-export { generateForm } from "./ui/form.js";
-export const renderers: Map<string, (data: any) => string>;
+export { select } from "./ui/select.js";
+export { confirm } from "./ui/confirm.js";
+export { multiselect } from "./ui/multiselect.js";
+export { mask } from "./ui/mask.js";
+export { table } from "./ui/table.js";
+export { autocomplete } from "./ui/autocomplete.js";
+export { alert } from "./ui/alert.js";
+export { badge } from "./ui/badge.js";
+export { toast } from "./ui/toast.js";
+export { spinner } from "./ui/spinner.js";
+export { progress } from "./ui/progress.js";
+export { tree } from "./ui/tree.js";
+export { datetime } from "./ui/date-time.js";
+export { toggle } from "./ui/toggle.js";
+export { slider } from "./ui/slider.js";
 export default CLiInputAdapter;
-export type CommandHelpField = import("./CommandHelp.js").CommandHelpField;
-import CLI from "./CLI.js";
-import CLiInputAdapter from "./InputAdapter.js";
-import { CancelError } from "@nan0web/ui/core";
-import OutputAdapter from "./OutputAdapter.js";
-import Command from "./Command.js";
-import CommandError from "./CommandError.js";
-import CommandMessage from "./CommandMessage.js";
-import CommandParser from "./CommandParser.js";
-import CommandHelp from "./CommandHelp.js";
-export { CLI, CLiInputAdapter, CancelError, OutputAdapter, Command, CommandError, CommandMessage, CommandParser, CommandHelp };
-export { select, next, pause, createInput, ask, Input } from "./ui/index.js";
+import { render } from './core/render.js';
+import CLiInputAdapter from './InputAdapter.js';
+import { CancelError } from '@nan0web/ui/core';
+import { Alert } from './components/view/Alert.js';
+import { Badge } from './components/view/Badge.js';
+import { Table } from './components/view/Table.js';
+import { Breadcrumbs } from './components/view/Nav.js';
+import { Tabs } from './components/view/Nav.js';
+import { Steps } from './components/view/Nav.js';
+import { Toast } from './components/view/Toast.js';
+import { Select } from './components/prompt/Select.js';
+import { Input } from './components/prompt/Input.js';
+import { Password } from './components/prompt/Password.js';
+import { Confirm } from './components/prompt/Confirm.js';
+import { Multiselect } from './components/prompt/Multiselect.js';
+import { Mask } from './components/prompt/Mask.js';
+import { Autocomplete } from './components/prompt/Autocomplete.js';
+import { Slider } from './components/prompt/Slider.js';
+import { Toggle } from './components/prompt/Toggle.js';
+import { DateTime } from './components/prompt/DateTime.js';
+import { Next } from './components/prompt/Next.js';
+import { Pause } from './components/prompt/Pause.js';
+import { Tree } from './components/prompt/Tree.js';
+import { Spinner } from './components/prompt/Spinner.js';
+import { ProgressBar } from './components/prompt/ProgressBar.js';
+import CLI from './CLI.js';
+import CommandParser from './CommandParser.js';
+import OutputAdapter from './OutputAdapter.js';
+export { render, CLiInputAdapter, CancelError, Alert, Badge, Table, Breadcrumbs, Tabs, Steps, Toast, Select, Input, Password, Confirm, Multiselect, Mask, Autocomplete, Slider, Toggle, DateTime, Next, Pause, Tree, Spinner, ProgressBar, CLI, CommandParser, OutputAdapter };
+export { createInput, ask, text } from "./ui/input.js";
+export { next, pause } from "./ui/next.js";
+export { breadcrumbs, tabs, steps } from "./ui/nav.js";

package/types/test/PlaygroundTest.d.ts

@@ -1,7 +1,7 @@
 /**
  * @typedef {object} PlaygroundTestConfig
  * @property {NodeJS.ProcessEnv} env Environment variables for the child process.
- * @property {{ includeDebugger?: boolean }} [config={}] Configuration options.
+ * @property {{ includeDebugger?: boolean, includeEmptyLines?: boolean, feedStdin?: boolean }} [config={}] Configuration options.
  */
 /**
  * Utility class to run playground demos and capture output.
@@ -18,16 +18,18 @@
 export default class PlaygroundTest {
     /**
      * @param {NodeJS.ProcessEnv} env Environment variables for the child process.
-     * @param {{ includeDebugger?: boolean, includeEmptyLines?: boolean }} [config={}] Configuration options.
+     * @param {{ includeDebugger?: boolean, includeEmptyLines?: boolean, feedStdin?: boolean }} [config={}] Configuration options.
      */
     constructor(env: NodeJS.ProcessEnv, config?: {
-        includeDebugger?: boolean | undefined;
-        includeEmptyLines?: boolean | undefined;
-    } | undefined);
+        includeDebugger?: boolean;
+        includeEmptyLines?: boolean;
+        feedStdin?: boolean;
+    });
     env: NodeJS.ProcessEnv;
     /** @type {boolean} Include debugger lines in output (default: false). */
     includeDebugger: boolean;
     incldeEmptyLines: boolean;
+    feedStdin: boolean;
     /**
      * Subscribe to an event.
      */
@@ -53,7 +55,7 @@ export default class PlaygroundTest {
      *
      * @param {string[]} [args=["play/main.js"]] Arguments passed to the node process.
      */
-    run(args?: string[] | undefined): Promise<{
+    run(args?: string[]): Promise<{
         stdout: any;
         stderr: any;
         exitCode: any;
@@ -74,7 +76,9 @@ export type PlaygroundTestConfig = {
      * Configuration options.
      */
     config?: {
-        includeDebugger?: boolean | undefined;
+        includeDebugger?: boolean;
+        includeEmptyLines?: boolean;
+        feedStdin?: boolean;
     } | undefined;
 };
-import { EventContext } from "@nan0web/event";
+import { EventContext } from '@nan0web/event';

package/types/test/index.d.ts

@@ -1,3 +1,3 @@
 export { PlaygroundTest };
 export default PlaygroundTest;
-import PlaygroundTest from "./PlaygroundTest.js";
+import PlaygroundTest from './PlaygroundTest.js';

package/types/ui/alert.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Renders an alert box and optionally plays a sound.
+ *
+ * @param {string} message - Message content.
+ * @param {'info'|'success'|'warning'|'error'} [variant='info']
+ * @param {Object} [options]
+ * @param {string} [options.title] - Optional title.
+ * @param {boolean} [options.sound=false] - Play beep sound.
+ * @returns {string} Styled message block.
+ */
+export function alert(message: string, variant?: "info" | "success" | "warning" | "error", options?: {
+    title?: string | undefined;
+    sound?: boolean | undefined;
+}): string;

package/types/ui/autocomplete.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Renders a searchable selection list.
+ *
+ * @param {Object} input
+ * @param {string} [input.message] - Prompt message.
+ * @param {string} [input.title] - Alternative prompt title.
+ * @param {Array|Function} input.options - List of options or async function to fetch them.
+ * @param {number} [input.limit=10] - Max visible items.
+ * @returns {Promise<{index:number,value:any,cancelled:boolean}>}
+ */
+export function autocomplete(input: {
+    message?: string | undefined;
+    title?: string | undefined;
+    options: any[] | Function;
+    limit?: number | undefined;
+}): Promise<{
+    index: number;
+    value: any;
+    cancelled: boolean;
+}>;

package/types/ui/badge.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Renders a status badge.
+ *
+ * @param {string} label - Text to display.
+ * @param {'info'|'success'|'warning'|'error'|'neutral'} [variant='neutral']
+ * @returns {string} Styled string.
+ */
+export function badge(label: string, variant?: "info" | "success" | "warning" | "error" | "neutral"): string;

package/types/ui/confirm.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @param {Object} config
+ * @param {string} config.message
+ * @param {boolean} [config.initial=true] - Default value (true=Yes, false=No)
+ * @param {Function} [config.format] - Output value formatter
+ * @param {string} [config.active] - Label for "Yes" state
+ * @param {string} [config.inactive] - Label for "No" state
+ * @param {Function} [config.t] - Optional translation function.
+ * @returns {Promise<{value:boolean, cancelled:boolean}>}
+ */
+export function confirm(config: {
+    message: string;
+    initial?: boolean | undefined;
+    format?: Function | undefined;
+    active?: string | undefined;
+    inactive?: string | undefined;
+    t?: Function | undefined;
+}): Promise<{
+    value: boolean;
+    cancelled: boolean;
+}>;

package/types/ui/date-time.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Prompt user for a date or time.
+ *
+ * @param {Object} config
+ * @param {string} config.message
+ * @param {Date} [config.initial]
+ * @param {string} [config.mask] - Optional mask (e.g. 'YYYY-MM-DD HH:mm')
+ * @param {Function} [config.t] - Optional translation function.
+ * @returns {Promise<{value:Date, cancelled:boolean}>}
+ */
+export function datetime(config: {
+    message: string;
+    initial?: Date | undefined;
+    mask?: string | undefined;
+    t?: Function | undefined;
+}): Promise<{
+    value: Date;
+    cancelled: boolean;
+}>;

package/types/ui/form.d.ts

@@ -14,7 +14,7 @@
 export function generateForm(BodyClass: Function, options?: {
     initialState?: any;
     t?: Function | undefined;
-} | undefined): UiForm;
+}): UiForm;
 /**
  * CLI-specific form handler that introspects a model class for static field schemas.
  *
@@ -38,24 +38,54 @@ export default class Form {
      * @param {Object} [options={}] - Options.
      * @param {string[]} [options.stops=["quit", "cancel", "exit"]] - Stop words.
      * @param {(prompt: string) => Promise<Input>} [options.inputFn] - Custom input function.
+     * @param {(config: object) => Promise<{index:number, value:any}>} [options.selectFn] - Custom select function.
+     * @param {(config: object) => Promise<{value: number, cancelled: boolean}>} [options.sliderFn] - Custom slider function.
+     * @param {(config: object) => Promise<{value: boolean, cancelled: boolean}>} [options.toggleFn] - Custom toggle function.
+     * @param {Function} [options.t] - Optional translation function.
      * @throws {TypeError} If model is not an object with a constructor.
      */
     constructor(model: any, options?: {
         stops?: string[] | undefined;
         inputFn?: ((prompt: string) => Promise<Input>) | undefined;
-    } | undefined);
+        selectFn?: ((config: object) => Promise<{
+            index: number;
+            value: any;
+        }>) | undefined;
+        sliderFn?: ((config: object) => Promise<{
+            value: number;
+            cancelled: boolean;
+        }>) | undefined;
+        toggleFn?: ((config: object) => Promise<{
+            value: boolean;
+            cancelled: boolean;
+        }>) | undefined;
+        t?: Function | undefined;
+    });
     /** @type {Function} Input handler with cancellation support. */
     handler: Function;
-    /**
-     * Prompts for selection using the provided configuration.
-     *
-     * @param {Object} config - Selection configuration.
-     * @returns {Promise<{index:number, value:any}>} Selected option.
-     */
-    select(config: any): Promise<{
+    options: {
+        stops?: string[] | undefined;
+        inputFn?: ((prompt: string) => Promise<Input>) | undefined;
+        selectFn?: ((config: object) => Promise<{
+            index: number;
+            value: any;
+        }>) | undefined;
+        sliderFn?: ((config: object) => Promise<{
+            value: number;
+            cancelled: boolean;
+        }>) | undefined;
+        toggleFn?: ((config: object) => Promise<{
+            value: boolean;
+            cancelled: boolean;
+        }>) | undefined;
+        t?: Function | undefined;
+    };
+    t: Function;
+    select: typeof select | ((config: object) => Promise<{
         index: number;
         value: any;
-    }>;
+    }>);
+    get fields(): any[];
     /**
      * Prompts for input using the internal handler.
      *
@@ -86,5 +116,6 @@ export default class Form {
     get body(): any;
     #private;
 }
-import { UiForm } from "@nan0web/ui";
-import { Input } from "./input.js";
+import { UiForm } from '@nan0web/ui';
+import { Input } from './input.js';
+import { select } from './select.js';

package/types/ui/index.d.ts

@@ -1,3 +1,18 @@
-export { Input, createInput, ask } from "./input.js";
-export { select, default as baseSelect } from "./select.js";
+export { badge } from "./badge.js";
+export { alert } from "./alert.js";
+export { toast } from "./toast.js";
+export { tree } from "./tree.js";
+export { datetime } from "./date-time.js";
+export { Input, text, createInput, ask } from "./input.js";
+export { select, select as baseSelect } from "./select.js";
+export { confirm, confirm as baseConfirm } from "./confirm.js";
 export { next, pause } from "./next.js";
+export { autocomplete, autocomplete as baseAutocomplete } from "./autocomplete.js";
+export { table, table as baseTable } from "./table.js";
+export { multiselect, multiselect as baseMultiselect } from "./multiselect.js";
+export { mask, mask as baseMask } from "./mask.js";
+export { toggle, toggle as baseToggle } from "./toggle.js";
+export { slider, slider as baseSlider } from "./slider.js";
+export { progress, ProgressBar, progress as baseProgress } from "./progress.js";
+export { spinner, Spinner, spinner as baseSpinner } from "./spinner.js";
+export { breadcrumbs, tabs, steps } from "./nav.js";

package/types/ui/input.d.ts

@@ -1,60 +1,43 @@
-/// <reference types="node" resolution-mode="require"/>
-/** @typedef {import("./select.js").ConsoleLike} ConsoleLike */
-/** @typedef {(input: Input) => Promise<boolean>} LoopFn */
-/** @typedef {(input: Input) => string} NextQuestionFn */
 /**
- * Input function.
- * ---
- * Must be used only as a type — typedef does not work with full arguments description for functions.
- * ---
- * @param {string} question - Prompt displayed to the user.
- * @param {boolean | LoopFn} [loop=false] - Loop‑control flag, validator or boolean that forces a single answer.
- * @param {string | NextQuestionFn} [nextQuestion] - When `false` the prompt ends after one answer.
- *                                            When a `function` is supplied it receives the current {@link Input}
- *                                            and must return a new question string for the next iteration.
- *
- * @returns {Promise<Input>} Resolves with an {@link Input} instance that contains the final answer,
- *                           the raw value and cancellation state.
- *
- * @throws {Error} May propagate errors from the underlying readline interface.
+ * Triggers a system beep (ASCII Bell).
  */
-export function InputFn(question: string, loop?: boolean | LoopFn | undefined, nextQuestion?: string | NextQuestionFn | undefined): Promise<Input>;
+export function beep(): void;
 /**
- * Low‑level prompt that returns a trimmed string.
- *
- * @param {Object} input
- * @param {string} input.question - Text displayed as a prompt.
- * @param {string} [input.predef] - Optional predefined answer (useful for testing).
- * @param {ConsoleLike} [input.console] - Optional console to show predefined value
- * @param {import("node:readline").Interface} [input.rl] - Readline interface instnace
- * @returns {Promise<string>} The answer without surrounding whitespace.
- *
- * When `predef` is supplied the function mimics the usual readline output
- * (`question + answer + newline`) and returns the trimmed value.
+ * Modern text input with validation and default value.
+ *
+ * @param {Object} config
+ * @param {string} config.message - Prompt question
+ * @param {string} [config.initial] - Default value
+ * @param {string} [config.type] - Prompt type (text, password, etc)
+ * @param {(value:string)=>boolean|string|Promise<boolean|string>} [config.validate] - Validator
+ * @param {(value:string)=>string} [config.format] - Formatter
+ * @returns {Promise<{value:string, cancelled:boolean}>}
  */
-export function _askRaw(input: {
-    question: string;
-    predef?: string | undefined;
-    console?: import("./select.js").ConsoleLike | undefined;
-    rl?: import("readline").Interface | undefined;
-}): Promise<string>;
+export function text(config: {
+    message: string;
+    initial?: string | undefined;
+    type?: string | undefined;
+    validate?: ((value: string) => boolean | string | Promise<boolean | string>) | undefined;
+    format?: ((value: string) => string) | undefined;
+}): Promise<{
+    value: string;
+    cancelled: boolean;
+}>;
 /**
  * Factory that creates a reusable async input handler.
+ * Adapter for legacy ask() signature.
  *
  * @param {string[]} [stops=[]] Words that trigger cancellation.
  * @param {string|undefined} [predef] Optional predefined answer for testing.
- * @param {ConsoleLike} [console] Optional console instance.
- * @returns {InputFn} Async function that resolves to an {@link Input}.
+ * @param {Object} [console] Optional console instance.
+ * @param {(input: Input) => Promise<boolean>|boolean} [loop] Optional loop validator.
+ * @returns {Function} Async function that resolves to an {@link Input}.
  */
-export function createInput(stops?: string[] | undefined, predef?: string | undefined, console?: import("./select.js").ConsoleLike | undefined): typeof InputFn;
+export function createInput(stops?: string[], predef?: string | undefined, console?: any, loop?: (input: Input) => Promise<boolean> | boolean): Function;
 /**
- * @param {string[]} predefined
- * @param {ConsoleLike} console
- * @param {string[]} [stops=[]]
- * @returns {import("./select.js").InputFn}
- * @throws {CancelError}
+ * Mock helper for predefined inputs (Testing).
  */
-export function createPredefinedInput(predefined: string[], console: ConsoleLike, stops?: string[] | undefined): import("./select.js").InputFn;
+export function createPredefinedInput(predefined: any, console: any, stops?: any[]): (question: any) => Promise<Input>;
 /**
  * Represents a line of user input.
  *
@@ -64,43 +47,17 @@ export function createPredefinedInput(predefined: string[], console: ConsoleLike
  * @property {boolean} cancelled – True when the answer matches a stop word.
  */
 export class Input {
-    /**
-     * Create a new {@link Input} instance.
-     *
-     * @param {Object} [input={}] - Optional initial values.
-     * @param {string} [input.value] - Initial answer string.
-     * @param {boolean} [input.cancelled] - Initial cancel flag.
-     * @param {string|string[]} [input.stops] - Words that trigger cancellation.
-     */
-    constructor(input?: {
-        value?: string | undefined;
-        cancelled?: boolean | undefined;
-        stops?: string | string[] | undefined;
-    } | undefined);
+    constructor(input?: {});
     /** @type {string} */
     value: string;
     /** @type {string[]} */
     stops: string[];
-    /**
-     * Returns whether the input has been cancelled either explicitly or via a stop word.
-     *
-     * @returns {boolean}
-     */
     get cancelled(): boolean;
-    /** @returns {string} The raw answer value. */
     toString(): string;
     #private;
 }
 /**
  * High‑level input helper `ask`.
- *
- * This constant inherits the full {@link InputFn} signature **and** the
- * detailed JSDoc description for each argument, as defined in {@link InputFn}.
- *
- * @type {InputFn}
+ * Use this for simple string prompts.
  */
-export const ask: typeof InputFn;
-export default createInput;
-export type ConsoleLike = import("./select.js").ConsoleLike;
-export type LoopFn = (input: Input) => Promise<boolean>;
-export type NextQuestionFn = (input: Input) => string;
+export const ask: Function;

package/types/ui/mask.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Validates and optionally formats user input based on a pattern.
+ * Pattern uses '#' for numbers and 'A' for letters.
+ * Example: '(###) ###-####'
+ *
+ * @param {Object} config
+ * @param {string} config.message - Prompt question
+ * @param {string} config.mask - Mask pattern (e.g., '###-###')
+ * @param {string} [config.placeholder] - Hint for the user
+ * @param {Function} [config.t] - Translation function
+ * @returns {Promise<{value: string, cancelled: boolean}>}
+ */
+/**
+ * Cleans the input value by stripping non-alphanumerics and smart prefix.
+ */
+export function cleanMaskInput(value: any, mask: any): any;
+/**
+ * Formats a value according to the given mask.
+ * pattern: # = digit, A = letter, 0 = digit.
+ *
+ * @param {string} value
+ * @param {string} mask
+ * @returns {string}
+ */
+export function formatMask(value: string, mask: string): string;
+export function mask(config: any): Promise<{
+    value: string;
+    cancelled: boolean;
+}>;

package/types/ui/multiselect.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Interactive multiple selection with checkboxes.
+ *
+ * @param {Object} config
+ * @param {string} config.message - Prompt question
+ * @param {Array<string|Object>} config.options - List of choices
+ * @param {number} [config.limit=10] - Visible items limit
+ * @param {Array<any>} [config.initial=[]] - Initial selected values
+ * @param {string|boolean} [config.instructions] - Custom instructions
+ * @param {string} [config.hint] - Navigation hint
+ * @param {Function} [config.t] - Translation function
+ * @returns {Promise<{value: Array<any>, cancelled: boolean}>}
+ */
+export function multiselect(config: {
+    message: string;
+    options: Array<string | any>;
+    limit?: number | undefined;
+    initial?: any[] | undefined;
+    instructions?: string | boolean | undefined;
+    hint?: string | undefined;
+    t?: Function | undefined;
+}): Promise<{
+    value: Array<any>;
+    cancelled: boolean;
+}>;

package/types/ui/nav.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Renders a breadcrumb trail.
+ *
+ * @param {string[]} items - List of path segments.
+ * @param {Object} [options]
+ * @param {string} [options.separator='›'] - Separator character.
+ * @returns {string} Styled string.
+ */
+export function breadcrumbs(items: string[], options?: {
+    separator?: string | undefined;
+}): string;
+/**
+ * Renders a tab bar (visual only).
+ *
+ * @param {string[]} items - List of tab labels.
+ * @param {number} [active=0] - Index of active tab.
+ * @returns {string} Styled string.
+ */
+export function tabs(items: string[], active?: number): string;
+/**
+ * Renders a step indicator (wizard).
+ *
+ * @param {string[]} items - List of step labels.
+ * @param {number} [current=0] - Index of current step.
+ * @returns {string} Styled string.
+ */
+export function steps(items: string[], current?: number): string;

package/types/ui/progress.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Functional helper for progress.
+ * @param {Object} options
+ * @returns {ProgressBar}
+ */
+export function progress(options: any): ProgressBar;
+/**
+ * Progress module – visual progress bar with timers.
+ * @module ui/progress
+ */
+/**
+ * Renders a progress bar.
+ */
+export class ProgressBar {
+    /**
+     * @param {Object} options
+     * @param {number} options.total
+     * @param {string} [options.title]
+     * @param {number} [options.width=40]
+     */
+    constructor(options: {
+        total: number;
+        title?: string | undefined;
+        width?: number | undefined;
+    });
+    total: number;
+    title: string | undefined;
+    width: number;
+    current: number;
+    startTime: number;
+    /**
+     * Update progress.
+     * @param {number} current
+     */
+    update(current: number): void;
+    /**
+     * Increment progress.
+     * @param {number} [step=1]
+     */
+    tick(step?: number): void;
+    render(): void;
+    formatTime(seconds: any): string;
+}