@kosdev-code/kos-ui-sdk 2.0.41 → 2.1.1

package/models/models/region-info/region-info-model.d.ts

@@ -10,6 +10,10 @@ interface RegionSettingsService {
     timeZone: string;
 }
 type RegionSettingsConfigBean = IConfigBeanModel<RegionSettingsService>;
+/**
+ * @ignore
+ * @internal
+ */
 export declare class RegionInfoModelImpl<AdditionalData extends BaseRegionResponse = BaseRegionResponse> implements RegionInfoModel {
     id: string;
     private unitSystemMap;
@@ -69,15 +73,15 @@ export declare class RegionInfoModelImpl<AdditionalData extends BaseRegionRespon
      */
     convert(value: number, from: UnitSource, to: UnitSource): string;
     /**
-     *@internal
+     * @internal
      */
     init(): Promise<void>;
     /**
-     *@internal
+     * @internal
      */
     load(): Promise<void>;
     /**
-     *@internal
+     * @internal
      */
     ready(): Promise<void>;
 }

package/models/models/region-info/region-info-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"region-info-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/region-info/region-info-model.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,EACL,kBAAkB,EAIlB,eAAe,EAEhB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,iBAAiB,EAGjB,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,UAAU,EACV,iBAAiB,EACjB,SAAS,EAEV,MAAM,SAAS,CAAC;AAOjB,UAAU,qBAAqB;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAMD,KAAK,wBAAwB,GAAG,gBAAgB,CAAC,qBAAqB,CAAC,CAAC;AAQxE,qBACa,mBAAmB,CAC9B,cAAc,SAAS,kBAAkB,GAAG,kBAAkB,CAC9D,YAAW,eAAe;IAE1B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,aAAa,CAA4B;IACjD,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,iBAAiB,CAAoB;IAE7C,OAAO,CAAC,SAAS,CAAkD;IACnE,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,WAAW,CAAoC;IAEvD,YAAY,EAAG,wBAAwB,CAAC;IAGxC,OAAO,CAAC,MAAM,CAAoB;IAElC,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,WAAW,CAAgC;gBAEvC,OAAO,EAAE,MAAM;IAe3B,IAAI,gBAAgB,aAEnB;IACD,IAAI,iBAAiB,WAEpB;IAED,IAAI,YAAY,WAEf;IAED,IAAI,YAAY,WASf;IAED,IAAI,kBAAkB,WAKrB;IAED,IAAI,kBAAkB,YAKrB;IAED,IAAI,YAAY,WASf;IAED,IAAI,kBAAkB,WAKrB;IAED,IAAI,iBAAiB,WAMpB;IAED,IAAI,eAAe,WAElB;IAED,IAAI,gBAAgB,WAEnB;IAED,IAAI,SAAS,aAEZ;IAED,IAAI,YAAY,aAKf;IAED,IAAI,QAAQ,WAEX;IAED,IAAI,cAAc,oCAEjB;IAED,IAAI,kBAAkB,WAErB;IAED,IAAI,iBAAiB,wBAQpB;IAED,IAAI,iBAAiB,wBAQpB;IAED,IAAI,iBAAiB,wBAOpB;IAED,qBAAqB,CAAC,YAAY,EAAE,MAAM;IAW1C,qBAAqB,CAAC,YAAY,EAAE,MAAM;IAW1C,qBAAqB,CAAC,YAAY,EAAE,MAAM;IAW1C,aAAa,CAAC,KAAK,CAAC,EAAE,MAAM;IAe5B,cAAc,CAAC,KAAK,EAAE,MAAM;IAa5B;;OAEG;IACH,2BAA2B,CACzB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,MAAM;IAqChB;;OAEG;IACH,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAyB5D;;OAEG;IAEH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS;IAoBnE;;OAEG;IACH,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;IAazD;;OAEG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU;IAqDvD;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAuD3B;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAG7B;AAED,QAAA,MAAM,YAAY;;;;;;;;;CASjB,CAAC;AACF,eAAe,YAAY,CAAC"}
+{"version":3,"file":"region-info-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/region-info/region-info-model.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,EACL,kBAAkB,EAIlB,eAAe,EAEhB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,iBAAiB,EAGjB,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,UAAU,EACV,iBAAiB,EACjB,SAAS,EAEV,MAAM,SAAS,CAAC;AAOjB,UAAU,qBAAqB;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAMD,KAAK,wBAAwB,GAAG,gBAAgB,CAAC,qBAAqB,CAAC,CAAC;AAQxE;;;GAGG;AACH,qBACa,mBAAmB,CAC9B,cAAc,SAAS,kBAAkB,GAAG,kBAAkB,CAC9D,YAAW,eAAe;IAE1B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,aAAa,CAA4B;IACjD,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,iBAAiB,CAAoB;IAE7C,OAAO,CAAC,SAAS,CAAkD;IACnE,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,WAAW,CAAoC;IAEvD,YAAY,EAAG,wBAAwB,CAAC;IAGxC,OAAO,CAAC,MAAM,CAAoB;IAElC,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,WAAW,CAAgC;gBAEvC,OAAO,EAAE,MAAM;IAe3B,IAAI,gBAAgB,aAEnB;IACD,IAAI,iBAAiB,WAEpB;IAED,IAAI,YAAY,WAEf;IAED,IAAI,YAAY,WASf;IAED,IAAI,kBAAkB,WAKrB;IAED,IAAI,kBAAkB,YAKrB;IAED,IAAI,YAAY,WASf;IAED,IAAI,kBAAkB,WAKrB;IAED,IAAI,iBAAiB,WAMpB;IAED,IAAI,eAAe,WAElB;IAED,IAAI,gBAAgB,WAEnB;IAED,IAAI,SAAS,aAEZ;IAED,IAAI,YAAY,aAKf;IAED,IAAI,QAAQ,WAEX;IAED,IAAI,cAAc,oCAEjB;IAED,IAAI,kBAAkB,WAErB;IAED,IAAI,iBAAiB,wBAQpB;IAED,IAAI,iBAAiB,wBAQpB;IAED,IAAI,iBAAiB,wBAOpB;IAED,qBAAqB,CAAC,YAAY,EAAE,MAAM;IAW1C,qBAAqB,CAAC,YAAY,EAAE,MAAM;IAW1C,qBAAqB,CAAC,YAAY,EAAE,MAAM;IAW1C,aAAa,CAAC,KAAK,CAAC,EAAE,MAAM;IAe5B,cAAc,CAAC,KAAK,EAAE,MAAM;IAa5B;;OAEG;IACH,2BAA2B,CACzB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,MAAM;IAqChB;;OAEG;IACH,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAyB5D;;OAEG;IAEH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS;IAoBnE;;OAEG;IACH,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;IAazD;;OAEG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU;IAqDvD;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAuD3B;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAG7B;AAED,QAAA,MAAM,YAAY;;;;;;;;;CASjB,CAAC;AACF,eAAe,YAAY,CAAC"}

package/models/models/region-info/services/region-info-services.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"region-info-services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/region-info/services/region-info-services.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf;AACD,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;CACf;AACD,MAAM,WAAW,IAAI;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,OAAO,CAAC;CACd;AACD,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AACD,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,OAAO,CAAC;CACjB;AACD,MAAM,MAAM,eAAe,CACzB,cAAc,SAAS,kBAAkB,GAAG,kBAAkB,IAC5D,kBAAkB,GAAG;KACtB,GAAG,IAAI,MAAM,cAAc,GAAG,cAAc,CAAC,GAAG,CAAC;CACnD,CAAC;AACF;;;;GAIG;AACH,eAAO,MAAM,aAAa,8FAGzB,CAAC;AAEF,eAAO,MAAM,UAAU,iHAKtB,CAAC"}
+{"version":3,"file":"region-info-services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/region-info/services/region-info-services.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf;AACD,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;CACf;AACD,MAAM,WAAW,IAAI;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,OAAO,CAAC;CACd;AACD,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AACD,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,OAAO,CAAC;CACjB;AACD,MAAM,MAAM,eAAe,CACzB,cAAc,SAAS,kBAAkB,GAAG,kBAAkB,IAC5D,kBAAkB,GAAG;KACtB,GAAG,IAAI,MAAM,cAAc,GAAG,cAAc,CAAC,GAAG,CAAC;CACnD,CAAC;AACF;;;;GAIG;AACH,eAAO,MAAM,aAAa,8FAOzB,CAAC;AAEF,eAAO,MAAM,UAAU,iHAStB,CAAC"}

package/models/models/region-info/types/index.d.ts

@@ -1,9 +1,41 @@
 import { BaseRegionResponse, RegionsResponse, Unit } from '../services';
 import { IKosDataModel } from '../../../../core';
 
+/**
+ * Unit conversion source specification for the conversion system.
+ *
+ * Flexible specification allowing conversion by specific unit name or by
+ * measurement system with automatic unit selection. The conversion system
+ * intelligently selects appropriate default units when only system/measure is provided.
+ *
+ * @example Specific Unit Conversion
+ * ```typescript
+ * const fahrenheitSource: UnitSource = { unit: 'fahrenheit' };
+ * const celsiusSource: UnitSource = { unit: 'celsius' };
+ *
+ * const result = regionModel.convert(72, fahrenheitSource, celsiusSource);
+ * console.log(result); // '22.22'
+ * ```
+ *
+ * @example System-Based Conversion (Auto Unit Selection)
+ * ```typescript
+ * const imperialLength: UnitSource = { measure: 'length', system: 'imperial' };
+ * const metricLength: UnitSource = { measure: 'length', system: 'metric' };
+ *
+ * // Automatically uses miles → kilometers
+ * const result = regionModel.convert(5, imperialLength, metricLength);
+ * console.log(result); // '8.047'
+ * ```
+ *
+ * @group KOS Model
+ * @category Region Info
+ */
 export interface UnitSource {
+    /** Measurement system identifier (e.g., 'metric', 'imperial', 'us') */
     system?: string;
+    /** Type of measurement (e.g., 'length', 'weight', 'temperature', 'volume') */
     measure?: string;
+    /** Specific unit name (e.g., 'meter', 'kilogram', 'fahrenheit') */
     unit?: string;
 }
 export type MeasureMapKeys = string | "default";
@@ -11,6 +43,24 @@ export type SystemMeasureMap = Record<MeasureMapKeys, Unit>;
 export type MeasureMap = Record<string, SystemMeasureMap>;
 export type SystemDefaultMap = Record<string, string>;
 export type DefaultMeasureMap = Record<string, SystemDefaultMap>;
+/**
+ * Configuration options for creating RegionInfoModel instances.
+ *
+ * Currently an empty interface but reserved for future regional configuration
+ * options such as default locale preferences, custom unit mappings, or
+ * regional API endpoints.
+ *
+ * @example
+ * ```typescript
+ * const options: RegionInfoOptions = {
+ *   // Future options will be defined here
+ * };
+ * const regionModel = RegionInfo.instance().options(options).build();
+ * ```
+ *
+ * @group KOS Model
+ * @category Region Info
+ */
 export interface RegionInfoOptions {
 }
 interface BaseOptions {
@@ -20,32 +70,110 @@ interface FormatOptions extends BaseOptions {
     format: string;
 }
 /**
- * Interface for time format options, extending FormatOptions.
- * @internal
- **/
+ * Time format configuration options for regional time display.
+ *
+ * Defines available time formats including 12-hour (AM/PM) and 24-hour formats
+ * with their display patterns and behavior.
+ *
+ * @example
+ * ```typescript
+ * const timeFormats: TimeFormatOptions[] = [
+ *   { id: '12h', format: 'hh:mm:ss a', ampm: true },   // 3:45:30 PM
+ *   { id: '24h', format: 'HH:mm:ss', ampm: false }     // 15:45:30
+ * ];
+ * ```
+ *
+ * @group KOS Model
+ * @category Region Info
+ */
 export interface TimeFormatOptions extends FormatOptions {
+    /** True if using 12-hour format with AM/PM, false for 24-hour format */
     ampm: boolean;
 }
 /**
- * Interface for date format options, extending FormatOptions.
- * @internal
- **/
+ * Date format configuration options for regional date display.
+ *
+ * Defines available date formats including different component ordering
+ * (Day/Month/Year vs Month/Day/Year) and display patterns.
+ *
+ * @example
+ * ```typescript
+ * const dateFormats: DateFormatOptions[] = [
+ *   { id: 'us', format: 'MM/DD/YYYY', order: 'MDY' },    // 03/15/2024
+ *   { id: 'eu', format: 'DD/MM/YYYY', order: 'DMY' },    // 15/03/2024
+ *   { id: 'iso', format: 'YYYY-MM-DD', order: 'YMD' }    // 2024-03-15
+ * ];
+ * ```
+ *
+ * @group KOS Model
+ * @category Region Info
+ */
 export interface DateFormatOptions extends FormatOptions {
+    /** Order of date components: 'MDY', 'DMY', 'YMD', etc. */
     order: string;
 }
 /**
- * Interface for unit system options, extending BaseOptions.
- * @internal
- **/
+ * Unit system configuration options for measurement standards.
+ *
+ * Defines available unit systems (metric, imperial, etc.) with their
+ * display names and identification.
+ *
+ * @example
+ * ```typescript
+ * const unitSystems: UnitSystemOptions[] = [
+ *   { id: 'metric', name: 'Metric System' },
+ *   { id: 'imperial', name: 'Imperial System' },
+ *   { id: 'us', name: 'US Customary System' }
+ * ];
+ * ```
+ *
+ * @group KOS Model
+ * @category Region Info
+ */
 export interface UnitSystemOptions extends BaseOptions {
+    /** Display name of the unit system (e.g., 'Metric System', 'Imperial System') */
     name: string;
 }
 /**
- * Represents a model for region information, extending the basic region options and data model.
- * It allows for managing regional settings and unit conversions.
+ * Region Info Model - Comprehensive regional localization and unit conversion system for KOS applications.
+ *
+ * This singleton model provides centralized management of regional settings including time formats,
+ * date formats, unit systems, time zones, and intelligent unit conversion. Essential for building
+ * internationally-aware applications that adapt to local preferences and measurement standards.
+ *
+ * ## Key Features
+ * - **Time & Date Formatting** - Configurable 12/24-hour time and various date order formats
+ * - **Unit System Management** - Complete metric/imperial conversion with precision control
+ * - **Time Zone Support** - Full time zone management with regional associations
+ * - **Dynamic Configuration** - Live updates through KOS configuration system
+ * - **Type Safety** - Generic support for additional regional data
+ * - **Singleton Pattern** - Single instance manages all regional settings
+ *
+ * ## Unit Conversion System
+ * The model provides intelligent unit conversion between different measurement systems:
+ * - **Automatic scaling** - Handles complex conversions with proper scaling factors
+ * - **Precision control** - Configurable decimal places per unit type
+ * - **Family validation** - Prevents invalid conversions (e.g., length to weight)
+ * - **Default unit resolution** - Automatic selection of appropriate units per system
+ *
+ * @template AdditionalData - Extends BaseRegionResponse for custom regional data requirements
+ *
+ * @interface
+ * @example Basic Usage
+ * ```typescript
+ * const regionModel = RegionInfo.instance().build();
+ *
+ * // Unit conversion and regional settings
+ * const celsius = regionModel.convert(72, { unit: 'fahrenheit' }, { unit: 'celsius' });
+ * console.log(regionModel.selectedCountry);     // 'us'
+ * ```
+ *
+ * @group KOS Model
+ * @category Region Info
+ * @useDeclaredType
  *
- * @category Model
- * @template AdditionalData - Extends the base region response to include additional data as needed.
+ * @see {@link UnitSource} - Unit conversion source specification
+ * @see {@link RegionInfoOptions} - Configuration options for RegionInfoModel instances
  */
 export interface RegionInfoModel<AdditionalData extends BaseRegionResponse = BaseRegionResponse> extends RegionInfoOptions, IKosDataModel {
     /** Unique identifier for the region model instance. */

package/models/models/region-info/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/region-info/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAGxE,MAAM,WAAW,UAAU;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAGD,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,SAAS,CAAC;AAGhD,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;AAG5D,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAG1D,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAGtD,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAIjE,MAAM,WAAW,iBAAiB;CAAG;AAGrC,UAAU,WAAW;IACnB,EAAE,EAAE,MAAM,CAAC;CACZ;AAGD,UAAU,aAAc,SAAQ,WAAW;IACzC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;IAGI;AACJ,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;IAGI;AACJ,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;IAGI;AACJ,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe,CAC9B,cAAc,SAAS,kBAAkB,GAAG,kBAAkB,CAC9D,SAAQ,iBAAiB,EACvB,aAAa;IACf,uDAAuD;IACvD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,yEAAyE;IACzE,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAEnC,0CAA0C;IAC1C,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,sDAAsD;IACtD,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,sDAAsD;IACtD,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,iFAAiF;IACjF,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAEnC,sCAAsC;IACtC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAEjC,wCAAwC;IACxC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,cAAc,EAAE,eAAe,CAAC,cAAc,CAAC,CAAC;IAEhD,kEAAkE;IAClE,kBAAkB,EAAE,OAAO,CAAC;IAE5B,gDAAgD;IAChD,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAE3B,gCAAgC;IAChC,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B,mDAAmD;IACnD,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB,uDAAuD;IACvD,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB,mDAAmD;IACnD,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,CAAC;IAEhD,mDAAmD;IACnD,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,CAAC;IAEhD,mDAAmD;IACnD,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,CAAC;IAEhD;;;;;;;;OAQG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,GAAG,MAAM,CAAC;IAEjE;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;;;;;OAMG;IACH,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;IAEtE;;;;;;;OAOG;IACH,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAEzC;;;OAGG;IACH,aAAa,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAEzC;;;;;;;OAOG;IACH,2BAA2B,CACzB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,MAAM,GACZ,MAAM,CAAC;CACX;AAGD,oBAAY,aAAa;IACvB,MAAM,IAAA;IACN,KAAK,IAAA;IACL,MAAM,IAAA;IACN,QAAQ,IAAA;IACR,KAAK,IAAA;IACL,MAAM,IAAA;CACP;AAGD,MAAM,MAAM,SAAS,GAAG;IACtB,MAAM,EAAE,MAAM;IACd,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,MAAM;IAChB,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,MAAM;CACf,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/region-info/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,WAAW,UAAU;IACzB,uEAAuE;IACvE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8EAA8E;IAC9E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mEAAmE;IACnE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAGD,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,SAAS,CAAC;AAGhD,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;AAG5D,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAG1D,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAGtD,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAEjE;;;;;;;;;;;;;;;;;GAiBG;AAEH,MAAM,WAAW,iBAAiB;CAAG;AAGrC,UAAU,WAAW;IACnB,EAAE,EAAE,MAAM,CAAC;CACZ;AAGD,UAAU,aAAc,SAAQ,WAAW;IACzC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,wEAAwE;IACxE,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,0DAA0D;IAC1D,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,iFAAiF;IACjF,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,WAAW,eAAe,CAC9B,cAAc,SAAS,kBAAkB,GAAG,kBAAkB,CAC9D,SAAQ,iBAAiB,EACvB,aAAa;IACf,uDAAuD;IACvD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,yEAAyE;IACzE,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAEnC,0CAA0C;IAC1C,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,sDAAsD;IACtD,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,sDAAsD;IACtD,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,iFAAiF;IACjF,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAEnC,sCAAsC;IACtC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAEjC,wCAAwC;IACxC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,cAAc,EAAE,eAAe,CAAC,cAAc,CAAC,CAAC;IAEhD,kEAAkE;IAClE,kBAAkB,EAAE,OAAO,CAAC;IAE5B,gDAAgD;IAChD,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAE3B,gCAAgC;IAChC,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B,mDAAmD;IACnD,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB,uDAAuD;IACvD,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB,mDAAmD;IACnD,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,CAAC;IAEhD,mDAAmD;IACnD,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,CAAC;IAEhD,mDAAmD;IACnD,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,CAAC;IAEhD;;;;;;;;OAQG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,GAAG,MAAM,CAAC;IAEjE;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;;;;;OAMG;IACH,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;IAEtE;;;;;;;OAOG;IACH,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAEzC;;;OAGG;IACH,aAAa,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAEzC;;;;;;;OAOG;IACH,2BAA2B,CACzB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,MAAM,GACZ,MAAM,CAAC;CACX;AAGD,oBAAY,aAAa;IACvB,MAAM,IAAA;IACN,KAAK,IAAA;IACL,MAAM,IAAA;IACN,QAAQ,IAAA;IACR,KAAK,IAAA;IACL,MAAM,IAAA;CACP;AAGD,MAAM,MAAM,SAAS,GAAG;IACtB,MAAM,EAAE,MAAM;IACd,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,MAAM;IAChB,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,MAAM;CACf,CAAC"}

package/models/models/software-info/software-info-model.d.ts

@@ -1,14 +1,86 @@
-import { ArtifactsType, NodeInfoType, SoftwareInfoModel, SoftwareInfoOptions } from './types';
+import { ArtifactsType, NodeInfoType, SoftwareInfoOptions } from './types';
+import { PublicModelInterface } from '../../../core/types';
 import { IKosDataModel, KosCreationContext } from '../../../core/core/kosModel';
 
 export declare const MODEL_TYPE = "software-info-model";
-export declare class SoftwareInfoModelImpl implements SoftwareInfoModel, IKosDataModel {
+/**
+ * SoftwareInfo - System software version and artifact management for KOS devices.
+ *
+ * The SoftwareInfo model provides comprehensive visibility into installed software versions,
+ * artifacts, and system components across all nodes in a KOS device. This model is essential
+ * for applications that need to display system information, perform version checks, or
+ * manage software compatibility and updates.
+ *
+ * ## Key Features
+ * - **Node-Based Architecture** - Track software information across multiple device nodes
+ * - **Artifact Management** - Complete visibility into installed software components and versions
+ * - **Version Tracking** - Monitor KOS framework versions and application artifacts
+ * - **Group Organization** - Automatic categorization of artifacts by functional groups
+ * - **System Overview** - Comprehensive system software inventory and version reporting
+ * - **Compatibility Checking** - Version information for dependency and compatibility validation
+ *
+ * ## Data Structure
+ * The model organizes software information hierarchically:
+ * - **Nodes** - Individual system nodes (primary, secondary, etc.)
+ * - **Artifacts** - Software components installed on each node
+ * - **Groups** - Logical grouping of related artifacts (core, ui, services, etc.)
+ * - **Versions** - Specific version information for each artifact
+ *
+ * ## Common Use Cases
+ * - **System Information Display** - Show installed software versions to users and administrators
+ * - **Version Compatibility** - Check software versions before updates or feature activation
+ * - **Support Diagnostics** - Provide detailed software information for troubleshooting
+ * - **Update Planning** - Assess current software state before planning updates
+ * - **Inventory Management** - Track and report on installed software components
+ *
+ * @interface
+ * @example Basic Usage
+ * ```typescript
+ * const softwareInfo = SoftwareInfo.instance('system-info').build();
+ *
+ * // Access system software information across nodes
+ * const nodes = softwareInfo.nodes;
+ * nodes?.forEach(node => {
+ *   console.log(`Node ${node.nodeName}: KOS ${node.kosVersion}`);
+ * });
+ * ```
+ *
+ * @group KOS Model
+ * @category System Integration
+ * @useDeclaredType
+ *
+ * @see {@link SoftwareInfoOptions} - Configuration options for SoftwareInfo model
+ * @see {@link NodeInfoType} - Individual node software information
+ * @see {@link ArtifactsType} - Software artifact information
+ * @see {@link getSoftwareInfos} - Service function for loading software data
+ */
+export type SoftwareInfoModel = PublicModelInterface<SoftwareInfoModelImpl>;
+/**
+ * @ignore
+ * @internal
+ */
+export declare class SoftwareInfoModelImpl implements IKosDataModel {
+    /** Unique identifier for the model instance */
     id: string;
     private logger;
+    /** Software information for all device nodes, including KOS versions and artifacts */
     nodes: NodeInfoType[] | undefined;
     constructor(modelId: string, _options: SoftwareInfoOptions, context: KosCreationContext);
+    /**
+     * @internal
+     */
     init(): Promise<void>;
+    /**
+     * Groups artifacts by a specified property for organization.
+     * @param arr Array of artifacts to group
+     * @param property Property to group by
+     * @returns Grouped artifacts organized by the specified property
+     * @private
+     */
     groupBy(arr: ArtifactsType[], property: keyof ArtifactsType): Record<string, ArtifactsType[]>;
+    /**
+     * @internal
+     */
     load(): Promise<void>;
 }
 //# sourceMappingURL=software-info-model.d.ts.map

package/models/models/software-info/software-info-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"software-info-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/software-info/software-info-model.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,aAAa,EAEb,kBAAkB,EACnB,MAAM,6BAA6B,CAAC;AAGrC,OAAO,KAAK,EACV,aAAa,EACb,YAAY,EACZ,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,SAAS,CAAC;AAEjB,eAAO,MAAM,UAAU,wBAAwB,CAAC;AAEhD,qBACa,qBAAsB,YAAW,iBAAiB,EAAE,aAAa;IAC5E,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IAEjC,KAAK,EAAE,YAAY,EAAE,GAAG,SAAS,CAAC;gBAEhC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,mBAAmB,EAC7B,OAAO,EAAE,kBAAkB;IASvB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAG3B,OAAO,CAAC,GAAG,EAAE,aAAa,EAAE,EAAE,QAAQ,EAAE,MAAM,aAAa;IAUrD,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAuB5B"}
+{"version":3,"file":"software-info-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/software-info/software-info-model.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,aAAa,EAEb,kBAAkB,EACnB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAGhE,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAEhF,eAAO,MAAM,UAAU,wBAAwB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;AAE5E;;;GAGG;AACH,qBACa,qBAAsB,YAAW,aAAa;IACzD,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IAEjC,sFAAsF;IACtF,KAAK,EAAE,YAAY,EAAE,GAAG,SAAS,CAAC;gBAEhC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,mBAAmB,EAC7B,OAAO,EAAE,kBAAkB;IAS7B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,EAAE,aAAa,EAAE,EAAE,QAAQ,EAAE,MAAM,aAAa;IAU3D;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAuB5B"}

package/models/models/software-info/types/index.d.ts

@@ -1,35 +1,67 @@
-import { IKosDataModel } from '../../../../core';
+import { SoftwareInfoModelImpl } from '../software-info-model';
+import { PublicModelInterface } from '../../../../core';
 
 
 /**
- * @internal
+ * Configuration options for SoftwareInfo model instances.
+ *
+ * This interface defines the configuration options for the SoftwareInfo model.
+ * Currently, no specific configuration options are required as the model
+ * automatically loads software information from the system manifest API.
+ *
+ * @example Basic Usage
+ * ```typescript
+ * const softwareInfo = SoftwareInfo.instance('system-info').build();
+ * ```
+ *
+ * @category Model Configuration
+ * @category System Integration
  */
-export interface SoftwareInfoOptions {}
+export interface SoftwareInfoOptions {
+  /** Reserved for future extensibility - currently no options required */
+  [key: string]: never;
+}
 
 /**
- * Maintains the state of the current software information.
- * @category Model
- * @link withSoftwareInfo
+ * @interface
+ * @useDeclaredType
  */
-export interface SoftwareInfoModel extends IKosDataModel {
-  nodes: Nodes;
-}
+export type SoftwareInfoModel = PublicModelInterface<SoftwareInfoModelImpl>;
 
+/**
+ * Software artifact information representing an individual component or package.
+ *
+ * This interface describes a software artifact (component, package, or module)
+ * installed on a KOS device node, including its identification, grouping, and version.
+ *
+ * @group KOS Model
+ * @category Types
+ */
 export interface ArtifactsType {
+  /** Unique identifier/name of the software artifact */
   name: string;
+  /** Functional group classification (core, ui, services, etc.) */
   group: string;
+  /** Semantic version string of the artifact */
   version: string;
 }
 
+/**
+ * Node software information representing all software components on a device node.
+ *
+ * This interface describes the complete software configuration of a single KOS device node,
+ * including the node identification, KOS framework version, and all installed artifacts
+ * organized by functional groups.
+ *
+ * @group KOS Model
+ * @category Types
+ */
 export interface NodeInfoType {
+  /** Node identifier (primary, secondary, etc.) */
   nodeName: string;
+  /** KOS framework version running on this node */
+  kosVersion?: string;
+  /** Artifacts organized by functional groups */
   group: Record<string, ArtifactsType[]>;
 }
 
-export interface NodeHead {
-  NodeType: string;
-}
-
-export interface object {
-  [key: string]: string;
-}

package/models/models/state-bean/state-bean-model.d.ts

@@ -1,29 +1,106 @@
 import { StateBeanModel, StateBeanOptions, StatePropsMap } from './types';
 import { StateBeanResponse } from './services';
 import { StatePropertyTypes } from '../types';
+import { PublicModelInterface } from '../../../core/types';
 import { IKosModelLogger, KosContextLogger, KosCreationContext } from '../../../core';
 
 export declare const MODEL_TYPE = "state-bean-model";
-export declare class StateBeanModelImpl<T extends Record<string, StatePropertyTypes> = any> implements StateBeanModel<T>, IKosModelLogger {
+/**
+ * StateBean - Reactive state management for KOS device state properties.
+ *
+ * The StateBean model provides real-time access to KOS device state information through
+ * reactive properties that automatically synchronize with device state changes via WebSocket
+ * topics. This model is essential for applications that need to monitor device state,
+ * track property changes, or build reactive UIs that respond to device status updates.
+ *
+ * ## Key Features
+ * - **Real-time Synchronization** - Automatic updates via `/kos/state/{path}` WebSocket topics
+ * - **Type-safe Properties** - Strongly typed state properties with automatic type conversion
+ * - **Observable State Map** - Reactive Map-based property storage for efficient updates
+ * - **Automatic Type Conversion** - Smart conversion of string values to boolean/number types
+ * - **Path-based Organization** - Hierarchical state organization using dot-notation paths
+ * - **Lifecycle Management** - Proper initialization and loading of state data
+ *
+ * ## Topic-Based Reactivity
+ * The model listens to KOS topics for real-time synchronization:
+ * - **`/kos/state/{path}`** - Receives state updates for the specified path, triggering automatic property updates across all connected clients
+ *
+ * ## State Property Types
+ * Supports all common KOS state property types:
+ * - **string** - Text values, configuration strings, identifiers
+ * - **number** - Numeric values, counters, measurements, percentages
+ * - **boolean** - Status flags, enabled/disabled states, operational flags
+ * - **object** - Complex state objects, nested configurations
+ *
+ * ## Common Use Cases
+ * - **Device Status Monitoring** - Track operational states, error conditions, health metrics
+ * - **Configuration State** - Monitor dynamic configuration changes and feature flags
+ * - **System Status Dashboards** - Build real-time status displays and monitoring interfaces
+ * - **Conditional UI Logic** - Show/hide UI elements based on device state
+ * - **State-dependent Operations** - Enable/disable functionality based on device state
+ * - **Multi-client Synchronization** - Keep multiple clients in sync with device state
+ *
+ * @interface
+ * @example Basic Usage
+ * ```typescript
+ * const deviceState = StateBean.instance('device-status')
+ *   .options({ path: 'device.operational.status' })
+ *   .build();
+ *
+ * // Access reactive state properties
+ * const isOnline = deviceState.props.get('online') as boolean;
+ * const temperature = deviceState.props.get('temperature') as number;
+ * ```
+ *
+ * @group KOS Model
+ * @category State Management
+ * @useDeclaredType
+ *
+ * @see {@link StateBeanOptions} - Configuration options for StateBean model
+ * @see {@link StatePropertyTypes} - Supported state property value types
+ * @see {@link StateProp} - Individual property access model
+ * @see {@link getStateBeanData} - Service function for loading state data
+ */
+export type StateBean<T extends Record<string, StatePropertyTypes> = Record<string, StatePropertyTypes>> = PublicModelInterface<StateBeanModelImpl<T>>;
+/**
+ * @ignore
+ * @internal
+ */
+export declare class StateBeanModelImpl<T extends Record<string, StatePropertyTypes> = Record<string, StatePropertyTypes>> implements StateBeanModel<T>, IKosModelLogger {
+    /** Unique identifier for the model instance */
     id: string;
+    /** State path being monitored for updates */
     path: string;
+    /** Reactive Map of state properties with automatic type conversion */
     props: StatePropsMap<T>;
+    /** Context logger for debugging and diagnostics */
     logger: KosContextLogger;
     constructor(modelId: string, options: StateBeanOptions, context: KosCreationContext);
+    /**
+     * Updates the model configuration with new options.
+     * @param options New configuration options to apply
+     */
     updateModel(options: StateBeanOptions): void;
     /**
-     * @category Subscription
-     * Updates the Config Bean model when a `/kos/config//update` event
-     * is recieved from the server.
-     *
-     *
-     * @param data - the raw callback
-     * @param data.body - the Config Bean that was updated.
-     * @see ConfigBeanResponse
+     * Handles WebSocket state updates from the KOS topic system.
+     * Automatically converts string values to appropriate types (boolean, number).
+     * @param stateBean State data received from WebSocket topic
+     * @internal
      */
     handleConfigBeanUpdated(stateBean: StateBeanResponse): void;
+    /**
+     * @internal
+     */
     init(): Promise<void>;
+    /**
+     * Updates multiple properties at once with type conversion.
+     * @param props Properties to update
+     * @private
+     */
     updateProps(props: Record<string, StatePropertyTypes>): void;
+    /**
+     * @internal
+     */
     load(): Promise<void>;
 }
 //# sourceMappingURL=state-bean-model.d.ts.map

package/models/models/state-bean/state-bean-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"state-bean-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/state-bean/state-bean-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EACnB,MAAM,eAAe,CAAC;AASvB,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAoB,KAAK,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE/E,eAAO,MAAM,UAAU,qBAAqB,CAAC;AAE7C,qBACa,kBAAkB,CAC7B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,GAAG,CAClD,YAAW,cAAc,CAAC,CAAC,CAAC,EAAE,eAAe;IAE7C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAG,MAAM,CAAC;IACd,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IACxB,MAAM,EAAE,gBAAgB,CAAC;gBAEvB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,kBAAkB;IAQ7B,WAAW,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI;IAI5C;;;;;;;;;OASG;IAKH,uBAAuB,CAAC,SAAS,EAAE,iBAAiB;IAkB9C,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC;IAM/C,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAO5B"}
+{"version":3,"file":"state-bean-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/state-bean/state-bean-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EACnB,MAAM,eAAe,CAAC;AAQvB,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAEhE,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAoB,KAAK,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE/E,eAAO,MAAM,UAAU,qBAAqB,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,MAAM,MAAM,SAAS,CACnB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,MAAM,CACnD,MAAM,EACN,kBAAkB,CACnB,IACC,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;AAIhD;;;GAGG;AACH,qBACa,kBAAkB,CAC7B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,MAAM,CACnD,MAAM,EACN,kBAAkB,CACnB,CACD,YAAW,cAAc,CAAC,CAAC,CAAC,EAAE,eAAe;IAE7C,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,6CAA6C;IAC7C,IAAI,EAAG,MAAM,CAAC;IACd,sEAAsE;IACtE,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IACxB,mDAAmD;IACnD,MAAM,EAAE,gBAAgB,CAAC;gBAEvB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,kBAAkB;IAQ7B;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI;IAI5C;;;;;OAKG;IAKH,uBAAuB,CAAC,SAAS,EAAE,iBAAiB;IAkBpD;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B;;;;OAIG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC;IAMrD;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAO5B"}