@nan0web/ui 1.5.2 → 1.7.0

package/types/domain/components/AutocompleteModel.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @typedef {Object} AutocompleteData
+ * @property {string} [content]
+ * @property {string[]} [options]
+ */
+/**
+ * Model-as-Schema for Autocomplete component.
+ * Represents a text input with search suggestions.
+ */
+export class AutocompleteModel extends Model {
+    static content: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    static options: {
+        help: string;
+        default: never[];
+        type: string;
+    };
+    /**
+     * @param {AutocompleteData | any} [data]
+     */
+    constructor(data?: AutocompleteData | any);
+    /** @type {string|undefined} */ content: string | undefined;
+    /** @type {string[]|undefined} */ options: string[] | undefined;
+    run(): AsyncGenerator<{
+        type: string;
+        field: string;
+        schema: {
+            help: string;
+            options: string[] | undefined;
+        };
+        component: string;
+        model: any;
+    }, {
+        type: string;
+        data: {
+            selected: string | undefined;
+        };
+    }, unknown>;
+}
+export type AutocompleteData = {
+    content?: string | undefined;
+    options?: string[] | undefined;
+};
+import { Model } from '@nan0web/core';

package/types/domain/components/BreadcrumbModel.d.ts

@@ -0,0 +1,164 @@
+/**
+ * @typedef {Object} BreadcrumbItem
+ * @property {string} label  - Human-readable display name (e.g. "Sandbox", "Кнопка")
+ * @property {string} path   - URL-safe segment (e.g. "sandbox", "button")
+ */
+/**
+ * @typedef {Object} BreadcrumbData
+ * @property {BreadcrumbItem[]} [items]
+ * @property {string} [separator]
+ */
+/**
+ * Model-as-Schema for Breadcrumb navigation.
+ *
+ * Each breadcrumb item has a `label` (display) and a `path` (URL segment).
+ * The full path is the join of all segments, mirroring both:
+ *   - Web URL:    /sandbox/button/export
+ *   - DBFS URI:   sandbox/button/export/index  (relative to db.root)
+ *   - Data path:  {db.root}/sandbox/button/export/index.yaml
+ *   - CLI nav:    🏖 Sandbox › Button › Export
+ *
+ * This is the universal "where am I?" model for any OLMUI application.
+ *
+ * ESC/Back = pop() one item. Empty stack = app exit.
+ * Ctrl+C   = always exit (adapter responsibility).
+ */
+export class BreadcrumbModel extends Model {
+    static items: {
+        help: string;
+        type: string;
+        default: never[];
+    };
+    static separator: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    /**
+     * Reconstruct a BreadcrumbModel from a URL path string.
+     *
+     * @param {string} urlPath - e.g. "/sandbox/button" or "sandbox/button"
+     * @param {Record<string,string>} [labelMap={}] - Optional map of path→label for display names.
+     * @returns {BreadcrumbModel}
+     */
+    static fromPath(urlPath: string, labelMap?: Record<string, string>): BreadcrumbModel;
+    /**
+     * Create a URL-safe slug from any label.
+     * Handles Unicode (Cyrillic, etc.) by lowercasing and replacing spaces/special chars.
+     *
+     * @param {string} label
+     * @returns {string}
+     */
+    static slugify(label: string): string;
+    /**
+     * @param {BreadcrumbData | any} [data]
+     */
+    constructor(data?: BreadcrumbData | any);
+    /** @type {BreadcrumbItem[]} */ items: BreadcrumbItem[];
+    /** @type {string} */ separator: string;
+    /**
+     * Push a new level onto the navigation stack.
+     *
+     * @param {string} label - Display label (e.g. "Button", "Кнопка")
+     * @param {string} [path] - URL segment. Auto-slugified from label if omitted.
+     * @returns {this}
+     */
+    push(label: string, path?: string): this;
+    /**
+     * Pop the last level from the navigation stack.
+     *
+     * @returns {BreadcrumbItem|undefined} The removed item, or undefined if stack was empty.
+     */
+    pop(): BreadcrumbItem | undefined;
+    /**
+     * Whether the user can navigate back (stack has > 0 items after pop).
+     *
+     * @returns {boolean}
+     */
+    canGoBack(): boolean;
+    /**
+     * Navigate to a specific depth by truncating the stack.
+     *
+     * @param {number} depth - Target depth (0 = root only).
+     * @returns {this}
+     */
+    navigateTo(depth: number): this;
+    /**
+     * Full URL-style path: `/sandbox/button/export`
+     * @returns {string}
+     */
+    get path(): string;
+    /**
+     * Just the path segments array: `['sandbox', 'button', 'export']`
+     * @returns {string[]}
+     */
+    get segments(): string[];
+    /**
+     * Just the display labels: `['Sandbox', 'Button', 'Export']`
+     * @returns {string[]}
+     */
+    get labels(): string[];
+    /**
+     * Current (last) breadcrumb item.
+     * @returns {BreadcrumbItem|undefined}
+     */
+    get current(): BreadcrumbItem | undefined;
+    /**
+     * Current navigation depth (0 = no items).
+     * @returns {number}
+     */
+    get depth(): number;
+    /**
+     * Serialize to URL query param value: `sandbox/button/export`
+     * @returns {string}
+     */
+    toURL(): string;
+    /**
+     * DBFS document URI — the key you pass to `db.fetch()` or `db.get()`.
+     * Relative to `db.root`, without extension (DBFS resolves `.yaml`/`.json` automatically).
+     *
+     * @example
+     * nav.push('sandbox').push('button')
+     * nav.toURI()        // → 'sandbox/button/index'
+     * db.fetch(nav.toURI()) // ← DBFS resolves to {root}/sandbox/button/index.yaml
+     *
+     * @param {string} [leaf='index'] - Document name without extension.
+     * @returns {string}
+     */
+    toURI(leaf?: string): string;
+    /**
+     * Full filesystem path relative to db.root: `sandbox/button/export/index.yaml`
+     * This is what DBFS resolves to on disk: `{cwd}/{root}/{toDataPath()}`.
+     *
+     * @param {string} [filename='index.yaml'] - Leaf filename with extension.
+     * @returns {string}
+     */
+    toDataPath(filename?: string): string;
+    /**
+     * Yields a log intent with the current breadcrumb path.
+     * This is a "display-only" run — it shows the navigation state.
+     */
+    run(): AsyncGenerator<any, {
+        type: string;
+        data: {
+            path: string;
+            items: BreadcrumbItem[];
+            depth: number;
+        };
+    }, unknown>;
+}
+export type BreadcrumbItem = {
+    /**
+     * - Human-readable display name (e.g. "Sandbox", "Кнопка")
+     */
+    label: string;
+    /**
+     * - URL-safe segment (e.g. "sandbox", "button")
+     */
+    path: string;
+};
+export type BreadcrumbData = {
+    items?: BreadcrumbItem[] | undefined;
+    separator?: string | undefined;
+};
+import { Model } from '@nan0web/core';

package/types/domain/components/ButtonModel.d.ts

@@ -0,0 +1,81 @@
+/**
+ * @typedef {'primary'|'secondary'|'info'|'ok'|'warn'|'err'|'ghost'} ButtonVariant
+ * @typedef {'sm'|'md'|'lg'} ButtonSize
+ * @typedef {Object} ButtonData
+ * @property {string} [content]
+ * @property {ButtonVariant} [variant]
+ * @property {ButtonSize} [size]
+ * @property {boolean} [outline]
+ * @property {boolean} [disabled]
+ * @property {boolean} [loading]
+ */
+/**
+ * Model-as-Schema for Button component.
+ * Represents the intention and state of a Button interaction.
+ * Used exclusively for schema definition and editor validation.
+ */
+export class ButtonModel extends Model {
+    static content: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    static variant: {
+        help: string;
+        default: string;
+        options: string[];
+    };
+    static size: {
+        help: string;
+        default: string;
+        options: string[];
+    };
+    static outline: {
+        help: string;
+        default: boolean;
+        type: string;
+    };
+    static disabled: {
+        help: string;
+        default: boolean;
+        type: string;
+    };
+    static loading: {
+        help: string;
+        default: boolean;
+        type: string;
+    };
+    /**
+     * @param {ButtonData | any} [data]
+     */
+    constructor(data?: ButtonData | any);
+    /** @type {string|undefined} */ content: string | undefined;
+    /** @type {ButtonVariant|undefined} */ variant: ButtonVariant | undefined;
+    /** @type {ButtonSize|undefined} */ size: ButtonSize | undefined;
+    /** @type {boolean|undefined} */ outline: boolean | undefined;
+    /** @type {boolean|undefined} */ disabled: boolean | undefined;
+    /** @type {boolean|undefined} */ loading: boolean | undefined;
+    run(): AsyncGenerator<{
+        type: string;
+        field: string;
+        schema: {
+            help: string;
+        };
+        component: string;
+        model: any;
+    }, {
+        type: string;
+        data: any;
+    }, unknown>;
+}
+export type ButtonVariant = "primary" | "secondary" | "info" | "ok" | "warn" | "err" | "ghost";
+export type ButtonSize = "sm" | "md" | "lg";
+export type ButtonData = {
+    content?: string | undefined;
+    variant?: ButtonVariant | undefined;
+    size?: ButtonSize | undefined;
+    outline?: boolean | undefined;
+    disabled?: boolean | undefined;
+    loading?: boolean | undefined;
+};
+import { Model } from '@nan0web/core';

package/types/domain/components/ConfirmModel.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @typedef {Object} ConfirmData
+ * @property {string} [message]
+ * @property {string} [confirmText]
+ * @property {string} [cancelText]
+ */
+/**
+ * Model-as-Schema for Confirm component.
+ */
+export class ConfirmModel extends Model {
+    static message: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    static confirmText: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    static cancelText: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    /**
+     * @param {ConfirmData | any} [data]
+     */
+    constructor(data?: ConfirmData | any);
+    /** @type {string|undefined} */ message: string | undefined;
+    /** @type {string|undefined} */ confirmText: string | undefined;
+    /** @type {string|undefined} */ cancelText: string | undefined;
+    run(): AsyncGenerator<{
+        type: string;
+        field: string;
+        schema: {
+            help: string | undefined;
+            type: string;
+        };
+        component: string;
+        model: any;
+    }, {
+        type: string;
+        data: {
+            confirmed: boolean;
+        };
+    }, unknown>;
+}
+export type ConfirmData = {
+    message?: string | undefined;
+    confirmText?: string | undefined;
+    cancelText?: string | undefined;
+};
+import { Model } from '@nan0web/core';

package/types/domain/components/InputModel.d.ts

@@ -0,0 +1,121 @@
+/**
+ * @typedef {'text'|'email'|'password'|'number'|'tel'|'url'|'date'} InputType
+ * @typedef {Object} InputData
+ * @property {InputType} [type]
+ * @property {string} [label]
+ * @property {string} [placeholder]
+ * @property {boolean} [required]
+ * @property {string} [pattern]
+ * @property {string} [min]
+ * @property {string} [max]
+ * @property {string} [step]
+ * @property {string} [hint]
+ * @property {boolean} [disabled]
+ * @property {string} [content]
+ */
+/**
+ * Model-as-Schema for Input component.
+ * Used exclusively for schema definition, validation, and editor reflection.
+ */
+export class InputModel extends Model {
+    static type: {
+        help: string;
+        default: string;
+        options: string[];
+    };
+    static label: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    static placeholder: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    static required: {
+        help: string;
+        default: boolean;
+        type: string;
+    };
+    static pattern: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    static min: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    static max: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    static step: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    static hint: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    static disabled: {
+        help: string;
+        default: boolean;
+        type: string;
+    };
+    static content: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    /**
+     * @param {InputData | any} [data]
+     */
+    constructor(data?: InputData | any);
+    /** @type {InputType|undefined} */ type: InputType | undefined;
+    /** @type {string|undefined} */ label: string | undefined;
+    /** @type {string|undefined} */ placeholder: string | undefined;
+    /** @type {boolean|undefined} */ required: boolean | undefined;
+    /** @type {string|undefined} */ pattern: string | undefined;
+    /** @type {string|undefined} */ min: string | undefined;
+    /** @type {string|undefined} */ max: string | undefined;
+    /** @type {string|undefined} */ step: string | undefined;
+    /** @type {string|undefined} */ hint: string | undefined;
+    /** @type {boolean|undefined} */ disabled: boolean | undefined;
+    /** @type {string|undefined} */ content: string | undefined;
+    run(): AsyncGenerator<{
+        type: string;
+        field: string;
+        schema: {
+            help: string;
+            validate: (val: any) => true | "This field is required" | "Invalid format";
+        };
+        component: string;
+        model: any;
+    }, {
+        type: string;
+        data: {
+            value: string | undefined;
+        };
+    }, unknown>;
+}
+export type InputType = "text" | "email" | "password" | "number" | "tel" | "url" | "date";
+export type InputData = {
+    type?: InputType | undefined;
+    label?: string | undefined;
+    placeholder?: string | undefined;
+    required?: boolean | undefined;
+    pattern?: string | undefined;
+    min?: string | undefined;
+    max?: string | undefined;
+    step?: string | undefined;
+    hint?: string | undefined;
+    disabled?: boolean | undefined;
+    content?: string | undefined;
+};
+import { Model } from '@nan0web/core';

package/types/domain/components/SelectModel.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @typedef {Object} SelectData
+ * @property {string} [content]
+ * @property {string[]} [options]
+ */
+/**
+ * Model-as-Schema for Select component.
+ * Represents a dropdown choice selection.
+ */
+export class SelectModel extends Model {
+    static content: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    static options: {
+        help: string;
+        default: string[];
+        type: string;
+    };
+    /**
+     * @param {SelectData | any} [data]
+     */
+    constructor(data?: SelectData | any);
+    /** @type {string|undefined} */ content: string | undefined;
+    /** @type {string[]|undefined} */ options: string[] | undefined;
+    run(): AsyncGenerator<{
+        type: string;
+        field: string;
+        schema: {
+            help: string;
+            options: string[] | undefined;
+            validate: (val: any) => true | "Invalid option selected";
+        };
+        component: string;
+        model: any;
+    }, {
+        type: string;
+        data: {
+            selected: string | undefined;
+        };
+    }, unknown>;
+}
+export type SelectData = {
+    content?: string | undefined;
+    options?: string[] | undefined;
+};
+import { Model } from '@nan0web/core';

package/types/domain/components/SpinnerModel.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @typedef {'sm'|'md'|'lg'} SpinnerSize
+ * @typedef {Object} SpinnerData
+ * @property {SpinnerSize} [size]
+ * @property {string} [color]
+ */
+/**
+ * Model-as-Schema for Spinner component.
+ * Represents a loading or progress state without user interaction.
+ */
+export class SpinnerModel extends Model {
+    static size: {
+        help: string;
+        default: string;
+        options: string[];
+    };
+    static color: {
+        help: string;
+        type: string;
+        default: string;
+    };
+    /**
+     * @param {SpinnerData | any} [data]
+     */
+    constructor(data?: SpinnerData | any);
+    /** @type {SpinnerSize|undefined} */ size: SpinnerSize | undefined;
+    /** @type {string|undefined} */ color: string | undefined;
+    run(): AsyncGenerator<{
+        type: string;
+        message: string;
+        component: string;
+        model: any;
+    }, {
+        type: string;
+        data: {
+            completed: boolean;
+        };
+    }, unknown>;
+}
+export type SpinnerSize = "sm" | "md" | "lg";
+export type SpinnerData = {
+    size?: SpinnerSize | undefined;
+    color?: string | undefined;
+};
+import { Model } from '@nan0web/core';

package/types/domain/components/TableModel.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @typedef {Object} TableData
+ * @property {string[]} [columns]
+ * @property {string[][]} [rows]
+ */
+/**
+ * Model-as-Schema for Table Data component.
+ * Displays tabular string data in rows and columns.
+ */
+export class TableModel extends Model {
+    static columns: {
+        help: string;
+        type: string;
+        default: string[];
+    };
+    static rows: {
+        help: string;
+        type: string;
+        default: string[][];
+    };
+    /**
+     * @param {TableData | any} [data]
+     */
+    constructor(data?: TableData | any);
+    /** @type {string[]|undefined} */ columns: string[] | undefined;
+    /** @type {string[][]|undefined} */ rows: string[][] | undefined;
+    run(): AsyncGenerator<{
+        type: string;
+        level: string;
+        message: string;
+        component: string;
+        model: any;
+    }, {
+        type: string;
+        data: {
+            rowsCount: number;
+        };
+    }, unknown>;
+}
+export type TableData = {
+    columns?: string[] | undefined;
+    rows?: string[][] | undefined;
+};
+import { Model } from '@nan0web/core';

package/types/domain/components/ToastModel.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @typedef {'success'|'error'|'info'|'warning'} ToastVariant
+ * @typedef {Object} ToastData
+ * @property {string} [message]
+ * @property {ToastVariant} [variant]
+ * @property {number} [duration]
+ * @property {boolean} [open]
+ */
+/**
+ * Model-as-Schema for Toast notification component.
+ * Represents a transient message displayed to the user.
+ */
+export class ToastModel extends Model {
+    static message: {
+        help: string;
+        default: string;
+        type: string;
+    };
+    static variant: {
+        help: string;
+        default: string;
+        options: string[];
+    };
+    static duration: {
+        help: string;
+        default: number;
+        type: string;
+    };
+    static open: {
+        help: string;
+        default: boolean;
+        type: string;
+    };
+    /**
+     * @param {ToastData | any} [data]
+     */
+    constructor(data?: ToastData | any);
+    /** @type {string|undefined} */ message: string | undefined;
+    /** @type {ToastVariant|undefined} */ variant: ToastVariant | undefined;
+    /** @type {number|undefined} */ duration: number | undefined;
+    /** @type {boolean|undefined} */ open: boolean | undefined;
+    run(): AsyncGenerator<{
+        type: string;
+        level: string;
+        message: string | undefined;
+        component: string;
+        model: any;
+    }, {
+        type: string;
+        data: {
+            closed: boolean;
+        };
+    }, unknown>;
+}
+export type ToastVariant = "success" | "error" | "info" | "warning";
+export type ToastData = {
+    message?: string | undefined;
+    variant?: ToastVariant | undefined;
+    duration?: number | undefined;
+    open?: boolean | undefined;
+};
+import { Model } from '@nan0web/core';