@nan0web/ui 1.8.0 → 1.9.0

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

@@ -0,0 +1,35 @@
+/**
+ * GalleryModel — OLMUI Model-as-Schema
+ * Image gallery / media grid with optional captions.
+ */
+export class GalleryModel extends Model {
+    static $id: string;
+    static title: {
+        help: string;
+        placeholder: string;
+        default: string;
+    };
+    static items: {
+        help: string;
+        type: string;
+        default: never[];
+    };
+    static columns: {
+        help: string;
+        default: number;
+        type: string;
+    };
+    /**
+     * @param {Partial<GalleryModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<GalleryModel> | Record<string, any>, options?: object);
+    /** @type {string} Gallery section title */ title: string;
+    /** @type {Array<{src: string, caption?: string, alt?: string}>} Gallery items */ items: Array<{
+        src: string;
+        caption?: string;
+        alt?: string;
+    }>;
+    /** @type {number} Number of columns in grid layout */ columns: number;
+}
+import { Model } from '@nan0web/types';

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

@@ -0,0 +1,21 @@
+/**
+ * HeaderConfigModel — OLMUI Model-as-Schema
+ * Configuration container mapping UI variant keys to HeaderVisibilityModel instances.
+ */
+export class HeaderConfigModel extends Model {
+    static $id: string;
+    static ui: {
+        help: string;
+        type: string;
+        hint: typeof HeaderVisibilityModel;
+        default: {};
+    };
+    /**
+     * @param {Partial<HeaderConfigModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<HeaderConfigModel> | Record<string, any>, options?: object);
+    /** @type {Record<string, HeaderVisibilityModel>} Map of UI variant name → HeaderVisibilityModel */ ui: Record<string, HeaderVisibilityModel>;
+}
+import { Model } from '@nan0web/types';
+import { HeaderVisibilityModel } from './HeaderVisibilityModel.js';

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

@@ -0,0 +1,49 @@
+/**
+ * HeaderVisibilityModel — OLMUI Model-as-Schema
+ * Boolean flags controlling which header elements are visible.
+ */
+export class HeaderVisibilityModel extends Model {
+    static $id: string;
+    static logo: {
+        help: string;
+        default: boolean;
+        type: string;
+    };
+    static theme: {
+        help: string;
+        default: boolean;
+        type: string;
+    };
+    static search: {
+        help: string;
+        default: boolean;
+        type: string;
+    };
+    static share: {
+        help: string;
+        default: boolean;
+        type: string;
+    };
+    static nav: {
+        help: string;
+        default: boolean;
+        type: string;
+    };
+    static langs: {
+        help: string;
+        default: boolean;
+        type: string;
+    };
+    /**
+     * @param {Partial<HeaderVisibilityModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<HeaderVisibilityModel> | Record<string, any>, options?: object);
+    /** @type {boolean} Show logo */ logo: boolean;
+    /** @type {boolean} Show theme toggle (dark/light) */ theme: boolean;
+    /** @type {boolean} Show search input */ search: boolean;
+    /** @type {boolean} Show share button */ share: boolean;
+    /** @type {boolean} Show navigation links */ nav: boolean;
+    /** @type {boolean} Show language switcher */ langs: boolean;
+}
+import { Model } from '@nan0web/types';

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

@@ -0,0 +1,24 @@
+/**
+ * HeroModel — OLMUI Model-as-Schema
+ * Main landing page banner with a big heading, description, and primary CTA.
+ */
+export 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 actions: {
+        help: string;
+        type: string;
+        default: never[];
+    };
+}
+import { Model } from '@nan0web/core';

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

@@ -1,21 +1,5 @@
-/**
- * @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: {
@@ -74,48 +58,24 @@ export class InputModel extends Model {
         type: string;
     };
     /**
-     * @param {InputData | any} [data]
+     * @param {Partial<InputModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
      */
-    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>;
+    constructor(data?: Partial<InputModel> | Record<string, any>, options?: object);
+    /** @type {string} HTML5 Input type attribute */ type: string;
+    /** @type {string} Label displayed above the input */ label: string;
+    /** @type {string} Placeholder text shown when empty */ placeholder: string;
+    /** @type {boolean} Whether the field must be filled out */ required: boolean;
+    /** @type {string} RegExp pattern for validation */ pattern: string;
+    /** @type {string} Minimum value */ min: string;
+    /** @type {string} Maximum value */ max: string;
+    /** @type {string} Step interval */ step: string;
+    /** @type {string} Helper text displayed below the input */ hint: string;
+    /** @type {boolean} Whether the input is disabled */ disabled: boolean;
+    /** @type {string} The actual value of the input */ content: string;
+    /**
+     * @returns {AsyncGenerator<any, any, any>}
+     */
+    run(): AsyncGenerator<any, any, any>;
 }
-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';
+import { Model } from '@nan0web/types';

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

@@ -0,0 +1,25 @@
+/**
+ * PriceModel — OLMUI Model-as-Schema
+ * Represents a monetary value with currency.
+ */
+export class PriceModel extends Model {
+    static $id: string;
+    static value: {
+        help: string;
+        default: number;
+        type: string;
+    };
+    static currency: {
+        help: string;
+        placeholder: string;
+        default: string;
+    };
+    /**
+     * @param {Partial<PriceModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<PriceModel> | Record<string, any>, options?: object);
+    /** @type {number} Numeric price value */ value: number;
+    /** @type {string} Currency code (ISO 4217) */ currency: string;
+}
+import { Model } from '@nan0web/types';

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

@@ -0,0 +1,34 @@
+/**
+ * PricingModel — OLMUI Model-as-Schema
+ * A pricing tier/plan with title, price, and feature list.
+ */
+export class PricingModel extends Model {
+    static $id: string;
+    static title: {
+        help: string;
+        placeholder: string;
+        default: string;
+        required: boolean;
+    };
+    static price: {
+        help: string;
+        type: string;
+        hint: typeof PriceModel;
+        default: null;
+    };
+    static features: {
+        help: string;
+        type: string;
+        default: never[];
+    };
+    /**
+     * @param {Partial<PricingModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<PricingModel> | Record<string, any>, options?: object);
+    /** @type {string} Pricing plan name */ title: string;
+    /** @type {PriceModel|null} Price object (value + currency) */ price: PriceModel | null;
+    /** @type {string[]} List of features included in this plan */ features: string[];
+}
+import { Model } from '@nan0web/types';
+import { PriceModel } from './PriceModel.js';

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

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

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

@@ -0,0 +1,40 @@
+/**
+ * ProfileDropdownModel — OLMUI Model-as-Schema
+ * Account/profile dropdown in the header (user menu).
+ */
+export class ProfileDropdownModel extends Model {
+    static $id: string;
+    static profileName: {
+        alias: string;
+        help: string;
+        placeholder: string;
+        default: string;
+    };
+    static email: {
+        help: string;
+        placeholder: string;
+        default: string;
+    };
+    static avatar: {
+        help: string;
+        placeholder: string;
+        default: string;
+    };
+    static actions: {
+        help: string;
+        type: string;
+        hint: typeof Navigation;
+        default: never[];
+    };
+    /**
+     * @param {Partial<ProfileDropdownModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<ProfileDropdownModel> | Record<string, any>, options?: object);
+    /** @type {string} Display name of the user */ profileName: string;
+    /** @type {string} User email address */ email: string;
+    /** @type {string} User avatar image URL */ avatar: string;
+    /** @type {Navigation[]} Dropdown menu items */ actions: Navigation[];
+}
+import { Model } from '@nan0web/types';
+import Navigation from '../Navigation.js';

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

@@ -1,8 +1,3 @@
-/**
- * @typedef {Object} SelectData
- * @property {string} [content]
- * @property {string[]} [options]
- */
 /**
  * Model-as-Schema for Select component.
  * Represents a dropdown choice selection.
@@ -19,30 +14,20 @@ export class SelectModel extends Model {
         type: string;
     };
     /**
-     * @param {SelectData | any} [data]
+     * @param {Partial<SelectModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
      */
-    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;
+    constructor(data?: Partial<SelectModel> | Record<string, any>, options?: object);
+    /** @type {string} Currently selected item or default placeholder */ content: string;
+    /** @type {string[]} List of available options for selection */ options: string[];
+    /**
+     * @returns {AsyncGenerator<any, { type: 'result', data: { selected: string } }, any>}
+     */
+    run(): AsyncGenerator<any, {
+        type: "result";
         data: {
-            selected: string | undefined;
+            selected: string;
         };
-    }, unknown>;
+    }, any>;
 }
-export type SelectData = {
-    content?: string | undefined;
-    options?: string[] | undefined;
-};
-import { Model } from '@nan0web/core';
+import { Model } from '@nan0web/types';

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

@@ -0,0 +1,32 @@
+/**
+ * ShowcaseAppModel — OLMUI Model-as-Schema
+ * A container model representing the entire UI library showcase.
+ * @property {string} title - App title
+ * @property {any[]} sections - Collection of UI sections
+ */
+export class ShowcaseAppModel extends Model {
+    static $id: string;
+    static title: {
+        help: string;
+        default: string;
+    };
+    static sections: {
+        help: string;
+        type: string;
+        default: never[];
+    };
+    /**
+     * OLMUI Generator — drives the showcase rendering.
+     */
+    run(): AsyncGenerator<{
+        type: string;
+        message: any;
+        component: string;
+    }, {
+        type: string;
+        data: {
+            success: boolean;
+        };
+    }, unknown>;
+}
+import { Model } from '@nan0web/core';

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

@@ -1,9 +1,3 @@
-/**
- * @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.
@@ -20,26 +14,15 @@ export class SpinnerModel extends Model {
         default: string;
     };
     /**
-     * @param {SpinnerData | any} [data]
+     * @param {Partial<SpinnerModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
      */
-    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>;
+    constructor(data?: Partial<SpinnerModel> | Record<string, any>, options?: object);
+    /** @type {'sm'|'md'|'lg'} Spinner diameter */ size: "sm" | "md" | "lg";
+    /** @type {string} Override for base color token */ color: string;
+    /**
+     * @returns {AsyncGenerator<any, any, any>}
+     */
+    run(): AsyncGenerator<any, any, any>;
 }
-export type SpinnerSize = "sm" | "md" | "lg";
-export type SpinnerData = {
-    size?: SpinnerSize | undefined;
-    color?: string | undefined;
-};
-import { Model } from '@nan0web/core';
+import { Model } from '@nan0web/types';

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

@@ -0,0 +1,33 @@
+/**
+ * StatsItemModel — OLMUI Model-as-Schema
+ * A single stat entry (e.g. "Users: 10,000 ↑12%").
+ */
+export class StatsItemModel extends Model {
+    static $id: string;
+    static label: {
+        help: string;
+        placeholder: string;
+        default: string;
+        required: boolean;
+    };
+    static value: {
+        help: string;
+        placeholder: string;
+        default: string;
+        required: boolean;
+    };
+    static trend: {
+        help: string;
+        placeholder: string;
+        default: string;
+    };
+    /**
+     * @param {Partial<StatsItemModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<StatsItemModel> | Record<string, any>, options?: object);
+    /** @type {string} Stat label (e.g. "Active Users") */ label: string;
+    /** @type {string} Stat value (number or formatted string) */ value: string;
+    /** @type {string} Trend indicator (e.g. "+12%", "-3%", or empty) */ trend: string;
+}
+import { Model } from '@nan0web/types';

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

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

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

@@ -1,8 +1,3 @@
-/**
- * @typedef {Object} TableData
- * @property {string[]} [columns]
- * @property {string[][]} [rows]
- */
 /**
  * Model-as-Schema for Table Data component.
  * Displays tabular string data in rows and columns.
@@ -19,26 +14,15 @@ export class TableModel extends Model {
         default: string[][];
     };
     /**
-     * @param {TableData | any} [data]
+     * @param {Partial<TableModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
      */
-    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>;
+    constructor(data?: Partial<TableModel> | Record<string, any>, options?: object);
+    /** @type {string[]} Array of column headers */ columns: string[];
+    /** @type {string[][]} 2D Array of table cells matching column length */ rows: string[][];
+    /**
+     * @returns {AsyncGenerator<any, any, any>}
+     */
+    run(): AsyncGenerator<any, any, any>;
 }
-export type TableData = {
-    columns?: string[] | undefined;
-    rows?: string[][] | undefined;
-};
-import { Model } from '@nan0web/core';
+import { Model } from '@nan0web/types';

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

@@ -0,0 +1,28 @@
+/**
+ * TabsModel — OLMUI Model-as-Schema
+ * Tab container with selectable panels.
+ */
+export class TabsModel extends Model {
+    static $id: string;
+    static active: {
+        help: string;
+        default: number;
+        type: string;
+    };
+    static tabs: {
+        help: string;
+        type: string;
+        default: never[];
+    };
+    /**
+     * @param {Partial<TabsModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<TabsModel> | Record<string, any>, options?: object);
+    /** @type {number} Index of the currently active tab */ active: number;
+    /** @type {Array<{label: string, content: string}>} Tab definitions */ tabs: Array<{
+        label: string;
+        content: string;
+    }>;
+}
+import { Model } from '@nan0web/types';

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

@@ -0,0 +1,18 @@
+/**
+ * TestimonialModel — OLMUI Model-as-Schema
+ * Extends CommentModel with a rating field for testimonials/reviews.
+ */
+export class TestimonialModel extends CommentModel {
+    static rating: {
+        help: string;
+        default: number;
+        type: string;
+    };
+    /**
+     * @param {Partial<TestimonialModel> | Record<string, any>} data Model input data.
+     * @param {object} [options] Extended options (db, etc.)
+     */
+    constructor(data?: Partial<TestimonialModel> | Record<string, any>, options?: object);
+    /** @type {number} Rating from 1 to 5 stars */ rating: number;
+}
+import { CommentModel } from './CommentModel.js';