@nan0web/ui-cli 1.1.1 → 2.1.0

package/types/ui/select.d.ts

@@ -1,74 +1,35 @@
-/** @typedef {import("./input.js").Input} Input */
-/** @typedef {import("./input.js").InputFn} InputFn */
-/**
- * @typedef {Object} ConsoleLike
- * @property {(...args: any[]) => void} debug
- * @property {(...args: any[]) => void} log
- * @property {(...args: any[]) => void} info
- * @property {(...args: any[]) => void} warn
- * @property {(...args: any[]) => void} error
- */
-/**
- * @typedef {Object} SelectConfig
- * @property {string} title – Title displayed above the options list.
- * @property {string} prompt – Prompt displayed for the answer.
- * @property {Array|Map} options – Collection of selectable items.
- * @property {ConsoleLike} console – Console‑like object with an `info` method.
- * @property {string[]} [stops=[]] Words that trigger cancellation.
- * @property {InputFn} [ask] Custom ask function (defaults to {@link createInput}).
- * @property {string} [invalidPrompt="Invalid choice, try again: "] Message shown on invalid input.
- */
 /**
  * Configuration object for {@link select}.
  *
- * @param {SelectConfig} input
- * @returns {Promise<{index:number,value:any}>} Resolves with the selected index and its value.
+ * @param {Object} input
+ * @param {string} input.title - Title displayed above the options list.
+ * @param {string} [input.prompt] - Prompt displayed for the answer.
+ * @param {Array|Map} input.options - Collection of selectable items.
+ * @param {Object} [input.console] - Deprecated. Ignored in new implementation.
+ * @param {string[]} [input.stops=[]] - Deprecated. Ignored in new implementation.
+ * @param {any} [input.ask] - Deprecated. Ignored in new implementation.
+ * @param {string} [input.invalidPrompt] - Deprecated. Ignored in new implementation.
+ * @param {number} [input.limit=10] - Max visible items.
+ * @param {string} [input.hint] - Hint text.
+ * @param {Function} [input.t] - Translation function.
+ * @returns {Promise<{index:number,value:any,cancelled:boolean}>} Resolves with the selected index and its value.
  *
  * @throws {CancelError} When the user cancels the operation.
- * @throws {Error} When options are missing or an incorrect value is supplied and no
- *   `invalidPrompt` is defined.
  */
-export function select(input: SelectConfig): Promise<{
-    index: number;
-    value: any;
-}>;
-export default select;
-export type Input = import("./input.js").Input;
-export type InputFn = typeof import("./input.js").InputFn;
-export type ConsoleLike = {
-    debug: (...args: any[]) => void;
-    log: (...args: any[]) => void;
-    info: (...args: any[]) => void;
-    warn: (...args: any[]) => void;
-    error: (...args: any[]) => void;
-};
-export type SelectConfig = {
-    /**
-     * – Title displayed above the options list.
-     */
+export function select(input: {
     title: string;
-    /**
-     * – Prompt displayed for the answer.
-     */
-    prompt: string;
-    /**
-     * – Collection of selectable items.
-     */
+    prompt?: string | undefined;
     options: any[] | Map<any, any>;
-    /**
-     * – Console‑like object with an `info` method.
-     */
-    console: ConsoleLike;
-    /**
-     * Words that trigger cancellation.
-     */
+    console?: any;
     stops?: string[] | undefined;
-    /**
-     * Custom ask function (defaults to {@link createInput }).
-     */
-    ask?: typeof import("./input.js").InputFn | undefined;
-    /**
-     * Message shown on invalid input.
-     */
+    ask?: any;
     invalidPrompt?: string | undefined;
-};
+    limit?: number | undefined;
+    hint?: string | undefined;
+    t?: Function | undefined;
+}): Promise<{
+    index: number;
+    value: any;
+    cancelled: boolean;
+}>;
+export default select;

package/types/ui/slider.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @param {Object} config
+ * @param {string} config.message
+ * @param {number} [config.initial]
+ * @param {number} [config.min=0]
+ * @param {number} [config.max=100]
+ * @param {number} [config.step=1]
+ * @param {number} [config.jump]
+ * @param {Function} [config.t] - Optional translation function.
+ * @returns {Promise<{value:number, cancelled:boolean}>}
+ */
+export function slider(config: {
+    message: string;
+    initial?: number | undefined;
+    min?: number | undefined;
+    max?: number | undefined;
+    step?: number | undefined;
+    jump?: number | undefined;
+    t?: Function | undefined;
+}): Promise<{
+    value: number;
+    cancelled: boolean;
+}>;

package/types/ui/spinner.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Functional helper for spinner.
+ * @param {string} message
+ * @returns {Spinner}
+ */
+export function spinner(message: string): Spinner;
+/**
+ * Spinner module – loading indicators.
+ * @module ui/spinner
+ */
+/**
+ * Visual spinner for async operations.
+ */
+export class Spinner {
+    static FRAMES: string[];
+    /**
+     * @param {string} [message]
+     */
+    constructor(message?: string);
+    message: string;
+    frameIndex: number;
+    interval: NodeJS.Timeout | null;
+    startTime: number;
+    start(): void;
+    stop(status?: string): void;
+    success(msg: any): void;
+    error(msg: any): void;
+}

package/types/ui/table.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Renders an interactive table.
+ *
+ * @param {Object} input
+ * @param {Array<Object>} input.data - Data to display.
+ * @param {Array<string>} [input.columns] - Columns to include.
+ * @param {string} [input.title] - Table title.
+ * @param {boolean} [input.interactive=true] - Whether to allow filtering.
+ * @param {boolean} [input.instant=false] - Whether to use instant search (char-by-char).
+ * @param {(val:string)=>string} [input.t] - Translation function.
+ * @param {Logger} [input.logger] - Logger instance.
+ * @param {Function} [input.prompt] - Prompt function.
+ * @returns {Promise<{value:any, cancelled:boolean}>} Selected row (if interactive) or last state.
+ */
+export function table(input: {
+    data: Array<any>;
+    columns?: string[] | undefined;
+    title?: string | undefined;
+    interactive?: boolean | undefined;
+    instant?: boolean | undefined;
+    t?: ((val: string) => string) | undefined;
+    logger?: Logger | undefined;
+    prompt?: Function | undefined;
+}): Promise<{
+    value: any;
+    cancelled: boolean;
+}>;
+import Logger from '@nan0web/log';

package/types/ui/toast.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Renders a toast message.
+ *
+ * @param {string} message - Message content.
+ * @param {'info'|'success'|'warning'|'error'} [variant='info']
+ * @returns {string} Styled string.
+ */
+export function toast(message: string, variant?: "info" | "success" | "warning" | "error"): string;

package/types/ui/toggle.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @param {Object} config
+ * @param {string} config.message
+ * @param {boolean} [config.initial=false]
+ * @param {string} [config.active='yes']
+ * @param {string} [config.inactive='no']
+ * @returns {Promise<{value:boolean, cancelled:boolean}>}
+ */
+export function toggle(config: {
+    message: string;
+    initial?: boolean | undefined;
+    active?: string | undefined;
+    inactive?: string | undefined;
+}): Promise<{
+    value: boolean;
+    cancelled: boolean;
+}>;

package/types/ui/tree.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @typedef {Object} TreeNode
+ * @property {string} name
+ * @property {'file'|'dir'} type
+ * @property {TreeNode[]} [children] -- If undefined, might be loaded async
+ * @property {any} [payload] -- Custom data
+ * @property {any} [value] -- Result value (usually same as path or name)
+ * @property {string} [path] -- File path
+ * @property {boolean} [expanded] -- Internal state
+ * @property {boolean} [checked] -- Internal state
+ * @property {number} [depth] -- Calculated
+ */
+/**
+ * Tree Prompt
+ */
+export function tree(config: any): Promise<any>;
+export type TreeNode = {
+    name: string;
+    type: "file" | "dir";
+    /**
+     * -- If undefined, might be loaded async
+     */
+    children?: TreeNode[] | undefined;
+    /**
+     * -- Custom data
+     */
+    payload?: any;
+    /**
+     * -- Result value (usually same as path or name)
+     */
+    value?: any;
+    /**
+     * -- File path
+     */
+    path?: string | undefined;
+    /**
+     * -- Internal state
+     */
+    expanded?: boolean | undefined;
+    /**
+     * -- Internal state
+     */
+    checked?: boolean | undefined;
+    /**
+     * -- Calculated
+     */
+    depth?: number | undefined;
+};