@nan0web/ui 1.8.0 → 1.10.0

package/types/domain/HeroModel.d.ts

@@ -0,0 +1,43 @@
+/**
+ * HeroModel — OLMUI Model-as-Schema
+ * Universal hero/banner section for landing pages.
+ * Uses Navigation[] for actions instead of a single CTA.
+ */
+export default class HeroModel extends Model {
+    static $id: string;
+    static title: {
+        help: string;
+        placeholder: string;
+        default: string;
+        required: boolean;
+    };
+    static description: {
+        help: string;
+        placeholder: string;
+        default: string;
+    };
+    static image: {
+        help: string;
+        placeholder: string;
+        hint: string;
+        upload: boolean;
+        default: string;
+    };
+    static actions: {
+        help: string;
+        type: string;
+        hint: typeof Navigation;
+        default: never[];
+    };
+    /**
+     * @param {Partial<HeroModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<HeroModel> | Record<string, any>, options?: object);
+    /** @type {string} Hero main headline */ title: string;
+    /** @type {string} Hero sub-headline or description text */ description: string;
+    /** @type {string} Hero background or feature image URL */ image: string;
+    /** @type {Navigation[]} Call-to-action buttons (multiple CTA support) */ actions: Navigation[];
+}
+import { Model } from '@nan0web/types';
+import Navigation from './Navigation.js';

package/types/domain/Navigation.d.ts

@@ -37,14 +37,15 @@ export default class Navigation extends Model {
         default: boolean;
     };
     /**
-     * @param {Partial<Navigation>} data
+     * @param {Partial<Navigation> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
      */
-    constructor(data?: Partial<Navigation>);
-    /** @type {string|undefined} */ title: string | undefined;
-    /** @type {string|undefined} */ href: string | undefined;
-    /** @type {string|undefined} */ icon: string | undefined;
-    /** @type {string|undefined} */ image: string | undefined;
-    /** @type {Navigation[]|undefined} */ children: Navigation[] | undefined;
-    /** @type {boolean|undefined} */ hidden: boolean | undefined;
+    constructor(data?: Partial<Navigation> | Record<string, any>, options?: object);
+    /** @type {string} Label for the menu item */ title: string;
+    /** @type {string} URL or internal app route */ href: string;
+    /** @type {string} Icon name/ID */ icon: string;
+    /** @type {string} Display image or thumbnail */ image: string;
+    /** @type {Navigation[]} Nested sub-menu navigation */ children: Navigation[];
+    /** @type {boolean} Hide from lists/menus */ hidden: boolean;
 }
-import { Model } from '@nan0web/core';
+import { Model } from '@nan0web/types';

package/types/domain/SandboxModel.d.ts

@@ -1,25 +1,9 @@
 /**
- * @typedef {Object} SandboxData
- * @property {string[]} [components]
- * @property {string} [selectedComponent]
- * @property {string} [themeFormat]
- */
-/**
- * Model-as-Schema for the UI Sandbox environment.
- * Represents a tool wrapping standard OLMUI components, allowing
- * users to inspect their models, tweak variables interactively,
- * and export the configuration as themes for the Marketplace.
- *
- * Navigation uses BreadcrumbModel:
- *   ESC = pop one level (if stack has no parent → exit app)
- *   Ctrl+C = always exit (handled by prompts.js wrapper)
- *
- * URL mapping:
- *   /sandbox             → Select Component
- *   /sandbox/button      → Edit Button properties
- *   /sandbox/button/export → Choose export format
+ * SandboxModel — OLMUI Model-as-Schema
+ * Environment for testing and previewing UI components with dynamic property editing.
  */
 export class SandboxModel extends Model {
+    static $id: string;
     static components: {
         help: string;
         type: string;
@@ -27,7 +11,8 @@ export class SandboxModel extends Model {
     };
     static selectedComponent: {
         help: string;
-        type: string;
+        placeholder: string;
+        default: string;
     };
     static themeFormat: {
         help: string;
@@ -35,25 +20,16 @@ export class SandboxModel extends Model {
         default: string;
     };
     /**
-     * @param {SandboxData | any} [data]
+     * @param {Partial<SandboxModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
      */
-    constructor(data?: SandboxData | any);
-    /** @type {string[]|undefined} */ components: string[] | undefined;
-    /** @type {string|undefined} */ selectedComponent: string | undefined;
-    /** @type {string|undefined} */ themeFormat: string | undefined;
-    run(): AsyncGenerator<any, {
-        type: string;
-        data: {
-            targetComponent: string | undefined;
-            themeConfig: any;
-            exportFormat: string | undefined;
-            breadcrumb: string;
-        };
-    }, any>;
+    constructor(data?: Partial<SandboxModel> | Record<string, any>, options?: object);
+    /** @type {string[]} List of registered UI components available for inspection */ components: string[];
+    /** @type {string} The component currently being inspected in the sandbox */ selectedComponent: string;
+    /** @type {'yaml'|'css'|'json'} The file format chosen to export the custom theme configuration */ themeFormat: "yaml" | "css" | "json";
+    /**
+     * @returns {AsyncGenerator<any, any, any>}
+     */
+    run(): AsyncGenerator<any, any, any>;
 }
-export type SandboxData = {
-    components?: string[] | undefined;
-    selectedComponent?: string | undefined;
-    themeFormat?: string | undefined;
-};
-import { Model } from '@nan0web/core';
+import { Model } from '@nan0web/types';

package/types/domain/ShowcaseAppModel.d.ts

@@ -1,64 +1,36 @@
 /**
  * Model-as-Schema for the entire UI Sandbox Showcase.
  * Represents a complete User Journey demonstrating all components.
- * Showcases OLMUI Scenario Testing capabilities.
  */
 export class ShowcaseAppModel extends Model {
-    static appName: {
+    static $id: string;
+    static UI: {
+        appName: string;
+        startBtn: string;
+        generateConfirm: string;
+        aborted: string;
+        success: string;
+        cancelled: string;
+        tableProperty: string;
+        tableValue: string;
+        tableStatus: string;
+        tableStatusActive: string;
+    };
+    static appTitle: {
+        alias: string;
         help: string;
         default: string;
         type: string;
     };
-    constructor(data?: {});
-    /** @type {string|undefined} */ appName: string | undefined;
-    run(): AsyncGenerator<{
-        type: string;
-        field: string;
-        schema: {
-            help: string;
-        };
-        component: string;
-        model: any;
-    } | {
-        type: string;
-        field: string;
-        schema: {
-            help: string | undefined;
-            type: string;
-        };
-        component: string;
-        model: any;
-    } | {
-        type: string;
-        level: string;
-        message: string | undefined;
-        component: string;
-        model: any;
-    } | {
-        type: string;
-        message: string;
-        component: string;
-        model: any;
-    }, {
-        type: string;
-        data: {
-            success: boolean;
-            reason: string;
-            profile?: undefined;
-            rowsDisplayed?: undefined;
-        };
-    } | {
-        type: string;
-        data: {
-            success: boolean;
-            profile: {
-                userName: string;
-                role: string;
-                tool: string;
-            };
-            rowsDisplayed: number;
-            reason?: undefined;
-        };
-    }, unknown>;
+    /**
+     * @param {Partial<ShowcaseAppModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<ShowcaseAppModel> | Record<string, any>, options?: object);
+    /** @type {string} App name help */ appTitle: string;
+    /**
+     * @returns {AsyncGenerator<any, any, any>}
+     */
+    run(): AsyncGenerator<any, any, any>;
 }
-import { Model } from '@nan0web/core';
+import { Model } from '@nan0web/types';

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

@@ -0,0 +1,33 @@
+/**
+ * AccordionModel — OLMUI Model-as-Schema
+ * Collapsible FAQ / accordion item with title + content.
+ */
+export class AccordionModel extends Model {
+    static $id: string;
+    static title: {
+        help: string;
+        placeholder: string;
+        default: string;
+        required: boolean;
+    };
+    static content: {
+        help: string;
+        placeholder: string;
+        default: string;
+        required: boolean;
+    };
+    static open: {
+        help: string;
+        default: boolean;
+        type: string;
+    };
+    /**
+     * @param {Partial<AccordionModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<AccordionModel> | Record<string, any>, options?: object);
+    /** @type {string} Accordion item header / question */ title: string;
+    /** @type {string} Accordion item body / answer (supports markdown) */ content: string;
+    /** @type {boolean} Whether the item is expanded by default */ open: boolean;
+}
+import { Model } from '@nan0web/types';

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

@@ -1,8 +1,3 @@
-/**
- * @typedef {Object} AutocompleteData
- * @property {string} [content]
- * @property {string[]} [options]
- */
 /**
  * Model-as-Schema for Autocomplete component.
  * Represents a text input with search suggestions.
@@ -19,29 +14,15 @@ export class AutocompleteModel extends Model {
         type: string;
     };
     /**
-     * @param {AutocompleteData | any} [data]
+     * @param {Partial<AutocompleteModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
      */
-    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>;
+    constructor(data?: Partial<AutocompleteModel> | Record<string, any>, options?: object);
+    /** @type {string} Current search text */ content: string;
+    /** @type {string[]} List of suggestions based on input */ options: string[];
+    /**
+     * @returns {AsyncGenerator<any, any, any>}
+     */
+    run(): AsyncGenerator<any, any, any>;
 }
-export type AutocompleteData = {
-    content?: string | undefined;
-    options?: string[] | undefined;
-};
-import { Model } from '@nan0web/core';
+import { Model } from '@nan0web/types';

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

@@ -0,0 +1,32 @@
+/**
+ * BannerModel — OLMUI Model-as-Schema
+ * Global notification bar (cookies, maintenance, announcements).
+ */
+export class BannerModel extends Model {
+    static $id: string;
+    static text: {
+        help: string;
+        placeholder: string;
+        default: string;
+        required: boolean;
+    };
+    static href: {
+        help: string;
+        placeholder: string;
+        default: string;
+    };
+    static closable: {
+        help: string;
+        default: boolean;
+        type: string;
+    };
+    /**
+     * @param {Partial<BannerModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<BannerModel> | Record<string, any>, options?: object);
+    /** @type {string} Banner message text */ text: string;
+    /** @type {string} Optional link for "Learn more" or action URL */ href: string;
+    /** @type {boolean} Whether the user can dismiss the banner */ closable: boolean;
+}
+import { Model } from '@nan0web/types';

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

@@ -51,11 +51,12 @@ export class BreadcrumbModel extends Model {
      */
     static slugify(label: string): string;
     /**
-     * @param {BreadcrumbData | any} [data]
+     * @param {BreadcrumbData | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
      */
-    constructor(data?: BreadcrumbData | any);
-    /** @type {BreadcrumbItem[]} */ items: BreadcrumbItem[];
-    /** @type {string} */ separator: string;
+    constructor(data?: BreadcrumbData | Record<string, any>, options?: object);
+    /** @type {BreadcrumbItem[]} Navigation stack */ items: BreadcrumbItem[];
+    /** @type {string} Visual separator between breadcrumb segments */ separator: string;
     /**
      * Push a new level onto the navigation stack.
      *
@@ -138,7 +139,13 @@ export class BreadcrumbModel extends Model {
      * Yields a log intent with the current breadcrumb path.
      * This is a "display-only" run — it shows the navigation state.
      */
-    run(): AsyncGenerator<any, {
+    run(): AsyncGenerator<{
+        type: string;
+        level: string;
+        message: string;
+        component: string;
+        model: BreadcrumbModel;
+    }, {
         type: string;
         data: {
             path: string;
@@ -161,4 +168,4 @@ export type BreadcrumbData = {
     items?: BreadcrumbItem[] | undefined;
     separator?: string | undefined;
 };
-import { Model } from '@nan0web/core';
+import { Model } from '@nan0web/types';

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

@@ -1,38 +1,20 @@
-/**
- * @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: {
+    static content: {
         help: string;
         default: string;
-        options: string[];
+        type: string;
     };
-    static outline: {
+    static href: {
         help: string;
-        default: boolean;
+        default: string;
         type: string;
     };
     static disabled: {
@@ -40,42 +22,24 @@ export class ButtonModel extends Model {
         default: boolean;
         type: string;
     };
-    static loading: {
+    static clicked: {
         help: string;
         default: boolean;
         type: string;
     };
     /**
-     * @param {ButtonData | any} [data]
+     * @param {Partial<ButtonModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
      */
-    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>;
+    constructor(data?: Partial<ButtonModel> | Record<string, any>, options?: object);
+    /** @type {'primary'|'secondary'|'danger'|'ghost'} Button visual style */ variant: "primary" | "secondary" | "danger" | "ghost";
+    /** @type {string} Text displayed inside the button */ content: string;
+    /** @type {string} Optional link URL */ href: string;
+    /** @type {boolean} Whether the button can be clicked */ disabled: boolean;
+    /** @type {boolean} Reactive flag set to true when user activates the button */ clicked: boolean;
+    /**
+     * @returns {AsyncGenerator<any, any, any>}
+     */
+    run(): AsyncGenerator<any, any, any>;
 }
-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';
+import { Model } from '@nan0web/types';

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

@@ -0,0 +1,39 @@
+/**
+ * CommentModel — OLMUI Model-as-Schema
+ * Base model for user-generated comments / reviews.
+ */
+export class CommentModel extends Model {
+    static $id: string;
+    static author: {
+        help: string;
+        placeholder: string;
+        default: string;
+        required: boolean;
+    };
+    static avatar: {
+        help: string;
+        placeholder: string;
+        default: string;
+    };
+    static text: {
+        help: string;
+        placeholder: string;
+        default: string;
+        required: boolean;
+    };
+    static date: {
+        help: string;
+        placeholder: string;
+        default: string;
+    };
+    /**
+     * @param {Partial<CommentModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<CommentModel> | Record<string, any>, options?: object);
+    /** @type {string} Author name */ author: string;
+    /** @type {string} Author avatar image URL */ avatar: string;
+    /** @type {string} Comment body text */ text: string;
+    /** @type {string} Comment date (ISO 8601) */ date: string;
+}
+import { Model } from '@nan0web/types';

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

@@ -1,54 +1,39 @@
 /**
- * @typedef {Object} ConfirmData
- * @property {string} [message]
- * @property {string} [confirmText]
- * @property {string} [cancelText]
- */
-/**
- * Model-as-Schema for Confirm component.
+ * Model-as-Schema for Confirmation dialog.
  */
 export class ConfirmModel extends Model {
+    static title: {
+        help: string;
+        default: string;
+        type: string;
+    };
     static message: {
         help: string;
         default: string;
         type: string;
     };
-    static confirmText: {
+    static okLabel: {
         help: string;
         default: string;
         type: string;
     };
-    static cancelText: {
+    static cancelLabel: {
         help: string;
         default: string;
         type: string;
     };
     /**
-     * @param {ConfirmData | any} [data]
+     * @param {Partial<ConfirmModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
      */
-    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>;
+    constructor(data?: Partial<ConfirmModel> | Record<string, any>, options?: object);
+    /** @type {string} Short title for the action */ title: string;
+    /** @type {string} The question asked to the user */ message: string;
+    /** @type {string} Text for the confirm button */ okLabel: string;
+    /** @type {string} Text for the cancel button */ cancelLabel: string;
+    /**
+     * @returns {AsyncGenerator<any, any, any>}
+     */
+    run(): AsyncGenerator<any, any, any>;
 }
-export type ConfirmData = {
-    message?: string | undefined;
-    confirmText?: string | undefined;
-    cancelText?: string | undefined;
-};
-import { Model } from '@nan0web/core';
+import { Model } from '@nan0web/types';

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

@@ -0,0 +1,40 @@
+/**
+ * EmptyStateModel — OLMUI Model-as-Schema
+ * Onboarding placeholder for empty tables, lists, or dashboards.
+ */
+export class EmptyStateModel extends Model {
+    static $id: string;
+    static icon: {
+        help: string;
+        placeholder: string;
+        default: string;
+    };
+    static title: {
+        help: string;
+        placeholder: string;
+        default: string;
+        required: boolean;
+    };
+    static description: {
+        help: string;
+        placeholder: string;
+        default: string;
+    };
+    static action: {
+        help: string;
+        type: string;
+        hint: typeof Navigation;
+        default: null;
+    };
+    /**
+     * @param {Partial<EmptyStateModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<EmptyStateModel> | Record<string, any>, options?: object);
+    /** @type {string} Illustration or icon name for the empty state */ icon: string;
+    /** @type {string} Empty state headline */ title: string;
+    /** @type {string} Helpful description guiding the user */ description: string;
+    /** @type {Navigation|null} Primary CTA action (Navigation link or button) */ action: Navigation | null;
+}
+import { Model } from '@nan0web/types';
+import Navigation from '../Navigation.js';

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

@@ -0,0 +1,27 @@
+/**
+ * FAQModel — OLMUI Model-as-Schema
+ * A section containing a title and a collection of FAQ (accordion) items.
+ */
+export class FAQModel extends Model {
+    static $id: string;
+    static title: {
+        help: string;
+        placeholder: string;
+        default: string;
+    };
+    static items: {
+        help: string;
+        type: string;
+        hint: typeof AccordionModel;
+        default: never[];
+    };
+    /**
+     * @param {Partial<FAQModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<FAQModel> | Record<string, any>, options?: object);
+    /** @type {string} Section title */ title: string;
+    /** @type {AccordionModel[]} Array of FAQ items */ items: AccordionModel[];
+}
+import { Model } from '@nan0web/types';
+import { AccordionModel } from './AccordionModel.js';