@nan0web/ui-cli 1.1.1 → 2.1.0

package/types/InputAdapter.d.ts

@@ -1,5 +1,11 @@
-/** @typedef {import("./ui/select.js").InputFn} InputFn */
-/** @typedef {import("./ui/select.js").ConsoleLike} ConsoleLike */
+/**
+ * @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
+ */
 /**
  * Extends the generic {@link BaseInputAdapter} with CLI‑specific behaviour.
  *
@@ -9,16 +15,34 @@
 export default class CLiInputAdapter extends BaseInputAdapter {
     constructor(options?: {});
     /** @returns {ConsoleLike} */
-    get console(): import("./ui/select.js").ConsoleLike;
+    get console(): ConsoleLike;
+    /** @param {Function} val */
+    set t(val: Function);
+    /** @returns {Function} */
+    get t(): Function;
     /** @returns {NodeJS.WriteStream} */
     get stdout(): NodeJS.WriteStream;
+    /** @returns {string[]} */
+    getRemainingAnswers(): string[];
     /**
      * Create a handler with stop words that supports predefined answers.
      *
      * @param {string[]} stops - Stop words for cancellation.
-     * @returns {InputFn}
+     * @returns {Function}
+     */
+    createHandler(stops?: string[]): Function;
+    /**
+     * Create a select handler that supports predefined answers.
+     * @returns {Function}
      */
-    createHandler(stops?: string[]): InputFn;
+    createSelectHandler(): Function;
+    /**
+     * Pause execution and wait for user input (Press any key).
+     *
+     * @param {string} [message] - Message to display.
+     * @returns {Promise<void>}
+     */
+    pause(message?: string): Promise<void>;
     /**
      * Prompt the user for a full form, handling navigation and validation.
      *
@@ -29,7 +53,7 @@ export default class CLiInputAdapter extends BaseInputAdapter {
      */
     requestForm(form: UiForm, options?: {
         silent?: boolean | undefined;
-    } | undefined): Promise<any>;
+    }): Promise<any>;
     /**
      * Render a UI component in the CLI environment.
      *
@@ -52,16 +76,120 @@ export default class CLiInputAdapter extends BaseInputAdapter {
      * Prompt the user to select an option from a list.
      *
      * @param {Object} config - Configuration object.
-     * @returns {Promise<string>} Selected value (or empty string on cancel).
+     * @returns {Promise<{value: string|undefined, cancelled: boolean}>} Selected value (or undefined on cancel).
      */
-    requestSelect(config: any): Promise<string>;
+    requestSelect(config: any): Promise<{
+        value: string | undefined;
+        cancelled: boolean;
+    }>;
     /**
      * Prompt for a single string input.
      *
      * @param {Object} config - Prompt configuration.
-     * @returns {Promise<string>} User response string.
+     * @returns {Promise<{value: string|undefined, cancelled: boolean}>} User response string or undefined on cancel.
+     */
+    requestInput(config: any): Promise<{
+        value: string | undefined;
+        cancelled: boolean;
+    }>;
+    /**
+     * Prompt the user for an autocomplete selection.
+     *
+     * @param {Object} config - Configuration object.
+     * @returns {Promise<{value: any, cancelled: boolean}>} Selected value.
+     */
+    requestAutocomplete(config: any): Promise<{
+        value: any;
+        cancelled: boolean;
+    }>;
+    /**
+     * Requests confirmation (yes/no).
+     *
+     * @param {Object} config - Confirmation configuration.
+     * @returns {Promise<{value: boolean|undefined, cancelled: boolean}>} User confirmation.
+     */
+    requestConfirm(config: any): Promise<{
+        value: boolean | undefined;
+        cancelled: boolean;
+    }>;
+    /**
+     * Display an interactive table.
+     *
+     * @param {Object} config - Table configuration.
+     * @returns {Promise<{value: any, cancelled: boolean}>}
+     */
+    requestTable(config: any): Promise<{
+        value: any;
+        cancelled: boolean;
+    }>;
+    /**
+     * Requests multiple selection.
+     *
+     * @param {Object} config - Multiselect configuration.
+     * @returns {Promise<{value: any[]|undefined, cancelled: boolean}>} Selected values.
+     */
+    requestMultiselect(config: any): Promise<{
+        value: any[] | undefined;
+        cancelled: boolean;
+    }>;
+    /**
+     * Requests masked input.
+     *
+     * @param {Object} config - Mask configuration.
+     * @returns {Promise<{value: string|undefined, cancelled: boolean}>} Masked value.
+     */
+    requestMask(config: any): Promise<{
+        value: string | undefined;
+        cancelled: boolean;
+    }>;
+    /**
+     * Request a toggle switch.
+     * @param {Object} config
+     * @returns {Promise<{value: boolean|undefined, cancelled: boolean}>}
+     */
+    requestToggle(config: any): Promise<{
+        value: boolean | undefined;
+        cancelled: boolean;
+    }>;
+    /**
+     * Request a numeric slider.
+     * @param {Object} config
+     * @returns {Promise<{value: number|undefined, cancelled: boolean}>}
      */
-    requestInput(config: any): Promise<string>;
+    requestSlider(config: any): Promise<{
+        value: number | undefined;
+        cancelled: boolean;
+    }>;
+    /**
+     * Create a progress bar.
+     * @param {Object} options
+     * @returns {import('./ui/progress.js').ProgressBar}
+     */
+    requestProgress(options: any): import("./ui/progress.js").ProgressBar;
+    /**
+     * Create and start a spinner.
+     * @param {string} message
+     * @returns {import('./ui/spinner.js').Spinner}
+     */
+    requestSpinner(message: string): import("./ui/spinner.js").Spinner;
+    /**
+     * Request a selection from a tree view.
+     * @param {Object} config
+     * @returns {Promise<{value: any, cancelled: boolean}>} Selected node(s).
+     */
+    requestTree(config: any): Promise<{
+        value: any;
+        cancelled: boolean;
+    }>;
+    /**
+     * Request a date or time from the user.
+     * @param {Object} config
+     * @returns {Promise<{value: Date|undefined, cancelled: boolean}>}
+     */
+    requestDateTime(config: any): Promise<{
+        value: Date | undefined;
+        cancelled: boolean;
+    }>;
     /**
      * Asks user a question or form and returns the completed form
      * @param {string | UiForm} question
@@ -73,6 +201,7 @@ export default class CLiInputAdapter extends BaseInputAdapter {
     select(cfg: any): Promise<{
         index: number;
         value: any;
+        cancelled: boolean;
     }>;
     /**
      * **New API** – Require input for a {@link UiMessage} instance.
@@ -89,8 +218,13 @@ export default class CLiInputAdapter extends BaseInputAdapter {
     requireInput(msg: UiMessage): Promise<any>;
     #private;
 }
-export type InputFn = import("./ui/select.js").InputFn;
-export type ConsoleLike = import("./ui/select.js").ConsoleLike;
-import { InputAdapter as BaseInputAdapter } from "@nan0web/ui";
-import { UiForm } from "@nan0web/ui";
-import { UiMessage } from "@nan0web/ui";
+export type ConsoleLike = {
+    debug: (...args: any[]) => void;
+    log: (...args: any[]) => void;
+    info: (...args: any[]) => void;
+    warn: (...args: any[]) => void;
+    error: (...args: any[]) => void;
+};
+import { InputAdapter as BaseInputAdapter } from '@nan0web/ui';
+import { UiForm } from '@nan0web/ui';
+import { UiMessage } from '@nan0web/ui';

package/types/OutputAdapter.d.ts

@@ -12,7 +12,7 @@ export default class OutputAdapter {
     constructor(options?: {
         console?: any;
         components?: Map<string, () => Promise<Function>> | undefined;
-    } | undefined);
+    });
     /** @returns {any} */
     get console(): any;
     /**

package/types/README.md.d.ts

@@ -1 +1 @@
-export {};
+export {}

package/types/UiMessage.d.ts

@@ -8,33 +8,35 @@
  * @extends {Message}
  */
 export default class UiMessage<T extends Record<string, any>> extends Message {
-    constructor(input?: import("../node_modules/@nan0web/co/types/Message.js").MessageInput | undefined);
-    /**
-     * Validates the message body against its schema.
-     *
-     * NOTE: The signature must exactly match `Message.validate` – it returns a
-     * `Map<string,string>` regardless of the generic type, otherwise TypeScript
-     * reports incompatibility with the base class.
-     *
-     * @param {any} [body=this.body] - Optional body to validate.
-     * @returns {Map<string,string>} Map of validation errors (empty if valid).
-     */
-    validate(body?: any): Map<string, string>;
-    /**
-     * Requires input via UI adapter. Validates fields according to the static `Body` schema.
-     *
-     * @param {Object} ui - UI adapter with input/output capabilities.
-     * @param {InputAdapter} ui.input - Input adapter for prompts.
-     * @param {OutputAdapter} [ui.output] - Optional output adapter for rendering.
-     * @returns {Promise<T>} Resolves with updated body or rejects if cancelled.
-     * @throws {CancelError} When user cancels the input process.
-     */
-    requireInput(ui: {
-        input: InputAdapter;
-        output?: import("./OutputAdapter.js").default | undefined;
-    }): Promise<T>;
+	constructor(
+		input?: import('../node_modules/@nan0web/co/types/Message.js').MessageInput | undefined,
+	)
+	/**
+	 * Validates the message body against its schema.
+	 *
+	 * NOTE: The signature must exactly match `Message.validate` – it returns a
+	 * `Map<string,string>` regardless of the generic type, otherwise TypeScript
+	 * reports incompatibility with the base class.
+	 *
+	 * @param {any} [body=this.body] - Optional body to validate.
+	 * @returns {Map<string,string>} Map of validation errors (empty if valid).
+	 */
+	validate(body?: any): Map<string, string>
+	/**
+	 * Requires input via UI adapter. Validates fields according to the static `Body` schema.
+	 *
+	 * @param {Object} ui - UI adapter with input/output capabilities.
+	 * @param {InputAdapter} ui.input - Input adapter for prompts.
+	 * @param {OutputAdapter} [ui.output] - Optional output adapter for rendering.
+	 * @returns {Promise<T>} Resolves with updated body or rejects if cancelled.
+	 * @throws {CancelError} When user cancels the input process.
+	 */
+	requireInput(ui: {
+		input: InputAdapter
+		output?: import('./OutputAdapter.js').default | undefined
+	}): Promise<T>
 }
-export type MessageBodySchema = import("@nan0web/co").MessageBodySchema;
-export type InputAdapter = import("./InputAdapter.js").default;
-export type OutputAdapter = import("./OutputAdapter.js").default;
-import { Message } from "@nan0web/co";
+export type MessageBodySchema = import('@nan0web/co').MessageBodySchema
+export type InputAdapter = import('./InputAdapter.js').default
+export type OutputAdapter = import('./OutputAdapter.js').default
+import { Message } from '@nan0web/co'

package/types/components/prompt/Autocomplete.d.ts

@@ -0,0 +1,6 @@
+export function Autocomplete(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/prompt/Confirm.d.ts

@@ -0,0 +1,6 @@
+export function Confirm(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/prompt/DateTime.d.ts

@@ -0,0 +1,6 @@
+export function DateTime(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/prompt/Input.d.ts

@@ -0,0 +1,6 @@
+export function Input(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/prompt/Mask.d.ts

@@ -0,0 +1,6 @@
+export function Mask(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/prompt/Multiselect.d.ts

@@ -0,0 +1,6 @@
+export function Multiselect(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/prompt/Next.d.ts

@@ -0,0 +1,6 @@
+export function Next(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/prompt/Password.d.ts

@@ -0,0 +1,6 @@
+export function Password(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/prompt/Pause.d.ts

@@ -0,0 +1,6 @@
+export function Pause(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/prompt/ProgressBar.d.ts

@@ -0,0 +1,12 @@
+/**
+ * ProgressBar Component.
+ * usage:
+ * const bar = await render(ProgressBar({ total: 100 }));
+ * bar.update(50);
+ */
+export function ProgressBar(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/prompt/Select.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Select Prompt Component.
+ *
+ * @param {Object} props
+ * @param {string} props.message - Question/Title.
+ * @param {Array} props.options - Options list.
+ * @param {number} [props.limit] - Max visible options.
+ */
+export function Select(props: {
+    message: string;
+    options: any[];
+    limit?: number | undefined;
+}): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/prompt/Slider.d.ts

@@ -0,0 +1,6 @@
+export function Slider(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/prompt/Spinner.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Spinner Component.
+ * Usage: await render(Spinner({ message: 'Loading...', action: promise }))
+ *
+ * @param {Object} props
+ * @param {string} props.message - Main message.
+ * @param {Promise<any>} [props.action] - Async action to wait for.
+ * @param {string} [props.successMessage] - Message on success.
+ * @param {string} [props.errorMessage] - Message on error.
+ */
+export function Spinner(props: {
+    message: string;
+    action?: Promise<any> | undefined;
+    successMessage?: string | undefined;
+    errorMessage?: string | undefined;
+}): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/prompt/Toggle.d.ts

@@ -0,0 +1,6 @@
+export function Toggle(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/prompt/Tree.d.ts

@@ -0,0 +1,6 @@
+export function Tree(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/view/Alert.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Alert View Component.
+ *
+ * @param {Object} props
+ * @param {string} props.title - Title of the alert.
+ * @param {string} props.children - Message content.
+ * @param {'info'|'success'|'warning'|'error'} [props.variant='info'] - Style variant.
+ * @param {string} [props.message] - Alias for children (legacy support).
+ * @param {boolean} [props.sound] - Play sound (side-effect during toString is acceptable here as it invokes on print).
+ */
+export function Alert(props: {
+    title: string;
+    children: string;
+    variant?: "error" | "info" | "success" | "warning" | undefined;
+    message?: string | undefined;
+    sound?: boolean | undefined;
+}): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+};

package/types/components/view/Badge.d.ts

@@ -0,0 +1,5 @@
+export function Badge(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+};

package/types/components/view/Nav.d.ts

@@ -0,0 +1,15 @@
+export function Breadcrumbs(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+};
+export function Tabs(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+};
+export function Steps(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+};

package/types/components/view/Table.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Table Component.
+ * Can be static (display only) or interactive (filter/select).
+ */
+export function Table(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};

package/types/components/view/Toast.d.ts

@@ -0,0 +1,5 @@
+export function Toast(props: any): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+};

package/types/core/Component.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Creates a Static View Component.
+ * These components are synchronous and can be stringified directly.
+ *
+ * @param {string} displayName - Name of the component (e.g. 'Alert').
+ * @param {any} props - Props passed to the component.
+ * @param {Function} formatFn - Pure function (props) => string.
+ */
+export function createView(displayName: string, props: any, formatFn: Function): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+};
+/**
+ * Creates an Interactive Prompt Component.
+ * These components are asynchronous and require `render()` or `await` handling.
+ *
+ * @param {string} displayName - Name of the component.
+ * @param {any} props - Props.
+ * @param {Function} executorFn - Async function (props) => Promise<result>.
+ */
+export function createPrompt(displayName: string, props: any, executorFn: Function): {
+    $$typeof: symbol;
+    type: string;
+    props: any;
+    execute: () => any;
+};
+/**
+ * Core Component logic.
+ *
+ * Defines the contract for View (static) and Prompt (interactive) components.
+ */
+export const ComponentSymbol: unique symbol;
+export const PromptSymbol: unique symbol;

package/types/core/PropValidation.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Prop validation utilities for UI components.
+ * @module core/PropValidation
+ */
+/**
+ * Validates that a value is a valid Date object or a parseable date string.
+ * @param {any} value
+ * @param {string} propName
+ * @param {string} componentName
+ * @throws {TypeError} if validation fails
+ */
+export function validateDate(value: any, propName: string, componentName: string): void;
+/**
+ * Validates that a value is a string.
+ * @param {any} value
+ * @param {string} propName
+ * @param {string} componentName
+ * @param {boolean} required
+ * @throws {TypeError} if validation fails
+ */
+export function validateString(value: any, propName: string, componentName: string, required?: boolean): void;
+/**
+ * Validates that a value is a function.
+ * @param {any} value
+ * @param {string} propName
+ * @param {string} componentName
+ * @param {boolean} required
+ * @throws {TypeError} if validation fails
+ */
+export function validateFunction(value: any, propName: string, componentName: string, required?: boolean): void;
+/**
+ * Validates that a value is a boolean.
+ * @param {any} value
+ * @param {string} propName
+ * @param {string} componentName
+ * @param {boolean} required
+ * @throws {TypeError} if validation fails
+ */
+export function validateBoolean(value: any, propName: string, componentName: string, required?: boolean): void;
+/**
+ * Validates that a value is a number.
+ * @param {any} value
+ * @param {string} propName
+ * @param {string} componentName
+ * @param {boolean} required
+ * @throws {TypeError} if validation fails
+ */
+export function validateNumber(value: any, propName: string, componentName: string, required?: boolean): void;

package/types/core/render.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Component Renderer.
+ *
+ * Handles both Static Views and Interactive Prompts.
+ */
+export function render(component: any): Promise<any>;