@kosdev-code/kos-ui-sdk 2.0.40 → 2.1.0

package/models/models/browser-router/browser-router-model.d.ts

@@ -2,14 +2,86 @@ import { BrowserRouterOptions } from './types';
 import { IKosDataModel, IKosIdentifiable, KosCreationContext, KosMethodTypes, KosMiddleware, PublicModelInterface } from '../../../core';
 
 export declare const MODEL_TYPE = "browser-router-model";
+/**
+ * BrowserRouter - HTTP routing and middleware management for KOS web services.
+ *
+ * The BrowserRouter model provides a comprehensive HTTP routing system that handles incoming
+ * requests via WebSocket topics and routes them through registered middleware and handlers.
+ * It enables KOS applications to expose REST APIs, handle device communication, and manage
+ * HTTP-based integrations with automatic OpenAPI specification generation.
+ *
+ * ## Key Features
+ * - **Topic-Based HTTP Handling** - Processes HTTP requests via `kos.http.request` topic
+ * - **Middleware Support** - Chain multiple middleware functions for request processing
+ * - **Route Management** - Dynamic registration, removal, and inspection of routes
+ * - **OpenAPI Generation** - Automatic API documentation at `/openapi.json`
+ * - **Request/Response Abstraction** - Familiar Express.js-style request/response objects
+ * - **Method Support** - Full HTTP method support (GET, POST, PUT, DELETE, PATCH)
+ *
+ * ## Topic-Based Reactivity
+ * The model listens to these KOS topics for HTTP request handling:
+ * - **`kos.http.request`** - Incoming HTTP requests from clients or other services
+ * - **`kos.http.response`** - Outgoing HTTP responses with status codes and data
+ *
+ * ## Common Use Cases
+ * - **REST API Endpoints** - Expose device data and control APIs
+ * - **Webhook Handlers** - Process incoming webhooks from external services
+ * - **Inter-Service Communication** - Handle requests between KOS services
+ * - **Device Integration** - Bridge HTTP protocols with KOS messaging
+ * - **API Gateway** - Route and transform requests to downstream services
+ *
+ * @interface
+ * @example Basic Usage
+ * ```typescript
+ * const router = KosBrowserRouter.instance('main-router')
+ *   .options({})
+ *   .build();
+ *
+ * // Register HTTP endpoints with middleware support
+ * router.use('GET', '/api/status', async (req, res) => {
+ *   res.send({ status: 'online' });
+ * });
+ *
+ * router.use('POST', '/api/commands', validateAuth, async (req, res) => {
+ *   res.status(200).send({ success: true });
+ * });
+ * ```
+ *
+ * @group KOS Model
+ * @category Browser Router
+ * @category Service Integration
+ * @useDeclaredType
+ *
+ * @see {@link BrowserRouterOptions} - Configuration options for BrowserRouter instances
+ */
 export type KosBrowserRouter = Omit<PublicModelInterface<BrowserRouterModelImpl>, "load" | "init">;
+/**
+ * @ignore
+ * @internal
+ */
 export declare class BrowserRouterModelImpl implements IKosDataModel, IKosIdentifiable {
+    /** Unique identifier for the router model instance */
     private _id;
+    /** Context logger for debugging HTTP requests and routing */
     private logger;
+    /** Internal HTTP router instance handling middleware chains */
     private router;
     constructor(modelId: string, _options: BrowserRouterOptions, context: KosCreationContext);
+    /** Model instance identifier */
     get id(): string;
+    /**
+     * Handles incoming HTTP requests from WebSocket topics.
+     * @param data Request body data
+     * @param payload Request headers and metadata
+     * @internal
+     */
     private handleRequest;
+    /**
+     * Registers a route with optional middleware chain.
+     * @param method HTTP method (GET, POST, PUT, DELETE, PATCH)
+     * @param path Route path pattern with parameter support
+     * @param middlewares Middleware functions and final handler
+     */
     use<TPath extends string = string>(method: KosMethodTypes, path: TPath, ...middlewares: KosMiddleware<TPath>[]): void;
     /**
      * Remove routes matching the given method and path
@@ -25,13 +97,20 @@ export declare class BrowserRouterModelImpl implements IKosDataModel, IKosIdenti
      */
     removeAllForPath(path: string): number;
     /**
-     * Get all registered routes (for debugging/monitoring)
+     * Gets all registered routes for debugging and monitoring.
+     * @returns Array of route objects with method and path
      */
     getRoutes(): Array<{
         method: string;
         path: string;
     }>;
+    /**
+     * @internal
+     */
     init(): Promise<void>;
+    /**
+     * @internal
+     */
     load(): Promise<void>;
 }
 //# sourceMappingURL=browser-router-model.d.ts.map

package/models/models/browser-router/browser-router-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser-router-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/browser-router/browser-router-model.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,aAAa,EAClB,KAAK,gBAAgB,EAErB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,aAAa,EAKlB,KAAK,oBAAoB,EAE1B,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAEpD,eAAO,MAAM,UAAU,yBAAyB,CAAC;AAIjD,MAAM,MAAM,gBAAgB,GAAG,IAAI,CACjC,oBAAoB,CAAC,sBAAsB,CAAC,EAC5C,MAAM,GAAG,MAAM,CAChB,CAAC;AAEF,qBACa,sBAAuB,YAAW,aAAa,EAAE,gBAAgB;IAC5E,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,MAAM,CAAmB;IAEjC,OAAO,CAAC,MAAM,CAAmB;gBAE/B,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,oBAAoB,EAC9B,OAAO,EAAE,kBAAkB;IAO7B,IAAI,EAAE,IAAI,MAAM,CAEf;YAKa,aAAa;IA0C3B,GAAG,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,EAC/B,MAAM,EAAE,cAAc,EACtB,IAAI,EAAE,KAAK,EACX,GAAG,WAAW,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,GACrC,IAAI;IAIP;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAIpD;;;;OAIG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAItC;;OAEG;IACH,SAAS,IAAI,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAK9C,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}
+{"version":3,"file":"browser-router-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/browser-router/browser-router-model.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,aAAa,EAClB,KAAK,gBAAgB,EAErB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,aAAa,EAKlB,KAAK,oBAAoB,EAE1B,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAEpD,eAAO,MAAM,UAAU,yBAAyB,CAAC;AAKjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CACjC,oBAAoB,CAAC,sBAAsB,CAAC,EAC5C,MAAM,GAAG,MAAM,CAChB,CAAC;AAEF;;;GAGG;AACH,qBACa,sBAAuB,YAAW,aAAa,EAAE,gBAAgB;IAC5E,sDAAsD;IACtD,OAAO,CAAC,GAAG,CAAS;IACpB,6DAA6D;IAC7D,OAAO,CAAC,MAAM,CAAmB;IACjC,+DAA+D;IAC/D,OAAO,CAAC,MAAM,CAAmB;gBAE/B,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,oBAAoB,EAC9B,OAAO,EAAE,kBAAkB;IAO7B,gCAAgC;IAChC,IAAI,EAAE,IAAI,MAAM,CAEf;IAED;;;;;OAKG;YAIW,aAAa;IA0C3B;;;;;OAKG;IACH,GAAG,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,EAC/B,MAAM,EAAE,cAAc,EACtB,IAAI,EAAE,KAAK,EACX,GAAG,WAAW,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,GACrC,IAAI;IAIP;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAIpD;;;;OAIG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAItC;;;OAGG;IACH,SAAS,IAAI,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAKpD;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}

package/models/models/browser-router/types/index.d.ts

@@ -1 +1,25 @@
-export interface BrowserRouterOptions {}
+/**
+ * Configuration options for BrowserRouter model instances.
+ *
+ * The BrowserRouter operates without specific configuration options, providing
+ * a zero-configuration HTTP routing solution. All routing behavior is controlled
+ * through route registration and middleware during model initialization.
+ *
+ * @example Basic Usage
+ * ```typescript
+ * const router = KosBrowserRouter.instance('api-router')
+ *   .options({})
+ *   .build();
+ *
+ * router.use('GET', '/api/status', async (req, res) => {
+ *   res.send({ status: 'healthy' });
+ * });
+ * ```
+ *
+ * @group KOS Model
+ * @category Service Integration
+ * @category Browser Router
+ */
+export interface BrowserRouterOptions {
+  [key: string]: never;
+}

package/models/models/config-bean/config-bean-model-builder.d.ts

@@ -32,7 +32,8 @@ export declare const mapUpdateDtoToConfigBeanModel: (dto: ConfigBeanUpdateRespon
  * instantiate a new model.
  *
  * @internal
- * @category Config Bean
+ * @group KOS Model
+ * @category Configuration
  */
 export declare const mapConfigBeanModelToDto: (model: IConfigBeanModel) => ConfigBeanRequest;
 /**
@@ -51,7 +52,8 @@ export declare const mapConfigBeanModelToDto: (model: IConfigBeanModel) => Confi
  * or retrieved from the KOS Model framework if already existing.
  *
  * @internal
- * @category Config Bean
+ * @group KOS Model
+ * @category Configuration
  */
 export declare const buildConfigBeanModel: (factory: ModelFactory<IConfigBeanModel, IConfigBeanModelOptions>) => (modelId: string) => (configBeanOptions: IConfigBeanModelOptions) => IConfigBeanModel;
 //# sourceMappingURL=config-bean-model-builder.d.ts.map

package/models/models/config-bean/config-bean-model-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config-bean-model-builder.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/config-bean/config-bean-model-builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,wBAAwB,EACxB,KAAK,WAAW,EACjB,MAAM,4BAA4B,CAAC;AAGpC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAEnE,wBAAgB,cAAc,CAAC,MAAM,GAAE,WAAW,EAAO,MAQxD;AAsBD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,uBAAuB,QAC7B,kBAAkB,SAChB,gBAAgB,SAWxB,CAAC;AAEF,eAAO,MAAM,6BAA6B,QACnC,wBAAwB,SACtB,gBAAgB,SAsBxB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,uBAAuB,UAAW,gBAAgB,sBAI9D,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,oBAAoB,YACrB,aAAa,gBAAgB,EAAE,uBAAuB,CAAC,eACvD,MAAM,yBACI,uBAAuB,qBAG1C,CAAC"}
+{"version":3,"file":"config-bean-model-builder.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/config-bean/config-bean-model-builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,wBAAwB,EACxB,KAAK,WAAW,EACjB,MAAM,4BAA4B,CAAC;AAGpC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAEnE,wBAAgB,cAAc,CAAC,MAAM,GAAE,WAAW,EAAO,MAQxD;AAsBD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,uBAAuB,QAC7B,kBAAkB,SAChB,gBAAgB,SAWxB,CAAC;AAEF,eAAO,MAAM,6BAA6B,QACnC,wBAAwB,SACtB,gBAAgB,SAsBxB,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,uBAAuB,UAAW,gBAAgB,sBAI9D,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,oBAAoB,YACrB,aAAa,gBAAgB,EAAE,uBAAuB,CAAC,eACvD,MAAM,yBACI,uBAAuB,qBAG1C,CAAC"}

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

@@ -3,24 +3,81 @@ import { ConfigBeanUpdateResponse } from '../../services/config-bean';
 import { ConfigBeanKeys, IConfigBeanModelOptions } from './config-bean-types';
 import { IKosDataModel, KosData, PublicModelInterface, KosModelRegistrationFactory } from '../../../core';
 
+/**
+ * ConfigBean - Reactive hierarchical configuration management for KOS devices.
+ *
+ * The ConfigBean model provides reactive access to hierarchical configuration data from KOS devices
+ * with real-time synchronization via WebSocket topics, schema-based validation, and transactional
+ * updates. Essential for building configuration interfaces and managing device operational parameters.
+ *
+ * ## Key Features
+ * - **Hierarchical Configuration** - Access nested configuration structures using path notation
+ * - **Real-Time Synchronization** - Automatic updates via `/kos/config/{path}` WebSocket topic
+ * - **Schema-Based Validation** - Built-in validation using device configuration schemas
+ * - **Transactional Updates** - Atomic configuration changes with rollback support
+ * - **Type-Safe Access** - Strongly typed property access with TypeScript support
+ * - **Reactive Properties** - Automatic UI updates when configuration changes
+ *
+ * ## Configuration Path Patterns
+ * ConfigBean supports hierarchical paths that mirror device system organization:
+ * - **System Level**: `system:app` - Machine identity, operational modes
+ * - **Service Level**: `kos:service:CANPumpMgr` - KOS service configurations
+ * - **Hardware Level**: `assembly:core:board:macro:pump:water` - Component settings
+ * - **Application Level**: `app:scheduling:dayWiseLockConfigMap` - Application-specific settings
+ *
+ * ## Common Use Cases
+ * - **Configuration Interfaces** - Build reactive configuration management screens
+ * - **Operational Parameter Control** - Real-time adjustment of device behavior
+ * - **Schema-Driven Forms** - Generate configuration UIs from device schemas
+ * - **System Administration** - Centralized device configuration management
+ * - **Bulk Configuration Updates** - Transactional updates across multiple properties
+ *
+ * @example Basic Configuration Management
+ * ```typescript
+ * const systemConfig = ConfigBean.instance('system-config')
+ *   .options({ path: 'system:app' })
+ *   .build();
+ *
+ * // Access current configuration values
+ * const machineId = systemConfig.values.machineId;
+ * const debugMode = systemConfig.values.debugMode;
+ *
+ * // Update configuration properties
+ * await systemConfig.updateProperty('debugMode', true);
+ * await systemConfig.updateProperty('machineId', 'MACHINE-001');
+ * ```
+ *
+ * @interface
+ * @group KOS Model
+ * @category Configuration
+ * @useDeclaredType
+ *
+ * @see {@link IConfigBeanModelOptions} - Configuration options for ConfigBean instances
+ * @see {@link ConfigBeanKeys} - Type-safe property key access
+ * @see {@link ConfigPropertyTypes} - Supported configuration property types
+ */
 export type IConfigBeanModel<T extends {} = any> = PublicModelInterface<ConfigBeanModelImpl<T>>;
 export declare const CONFIG_BEAN_MODEL_TYPE = "config-bean-model";
 /**
- * @category Model
- * @name ConfigBeanModel
- * @version 1.0.0
- * @author Mark Pomerant <mpomerant@coca-cola.com>
- *
- * Represents a config bean.
+ * @ignore
+ * @internal
  */
 declare class ConfigBeanModelImpl<T extends {} = any> implements IKosDataModel {
+    /** Service function for modifying configuration beans */
     private _modifyConfigBean;
+    /** Service function for retrieving configuration beans */
     private _getConfigBean;
+    /** Schema response containing configuration property definitions */
     private _schema?;
+    /** Unique identifier for this configuration model instance */
     id: string;
+    /** Hierarchical configuration path (e.g., 'system:app', 'kos:service:CANPumpMgr') */
     path: string;
+    /** Observable configuration properties with current values */
     props: KosData<Record<ConfigBeanKeys<T>, ConfigPropertyTypes>>;
+    /** Observable configuration properties with previous values (before last update) */
     prevProps: KosData<Record<ConfigBeanKeys<T>, ConfigPropertyTypes>>;
+    /** Optional custom base path for configuration service endpoints */
     serviceBasePath?: string;
     /**
      * @category Constructor
@@ -32,19 +89,68 @@ declare class ConfigBeanModelImpl<T extends {} = any> implements IKosDataModel {
      *
      */
     constructor(modelId: string, options: IConfigBeanModelOptions);
+    /**
+     * Gets current configuration property values.
+     *
+     * @returns Object containing all configuration properties with their current values
+     *
+     * @example Access Configuration Values
+     * ```typescript
+     * const currentValues = systemConfig.values;
+     * console.log('Machine ID:', currentValues.machineId);
+     * console.log('Debug Mode:', currentValues.debugMode);
+     * ```
+     */
     get values(): Record<keyof T, unknown>[keyof T][];
+    /**
+     * @internal
+     */
     ready(): Promise<void>;
     /**
-     * @category Lifecycle
+     * @internal
      *
      * @remarks
      * No action is taken as part of the load lifecycle method.
      *
-     * In future additional information about the worksapce could be loaded
+     * In future additional information about the workspace could be loaded
      */
     load(): Promise<void>;
+    /**
+     * Gets all available schema property keys.
+     *
+     * @returns Array of property keys from the configuration schema
+     */
     get schemaKeys(): string[];
+    /**
+     * Retrieves schema definition for a specific property.
+     *
+     * @param key - Property key to get schema for
+     * @returns Schema definition if found, undefined otherwise
+     *
+     * @example Get Property Schema
+     * ```typescript
+     * const schema = systemConfig.getSchemaForProperty('debugMode');
+     * if (schema) {
+     *   console.log('Type:', schema.type);
+     *   console.log('Description:', schema.description);
+     * }
+     * ```
+     */
     getSchemaForProperty(key: string): import('../../services/config-bean').SchemaNodeDef | undefined;
+    /**
+     * Updates a specific configuration property value.
+     *
+     * @category Action
+     *
+     * @param key - The configuration property key to update
+     * @param value - The new value to set for the property
+     *
+     * @example Update Configuration Property
+     * ```typescript
+     * await systemConfig.updateProperty('debugMode', true);
+     * await systemConfig.updateProperty('machineId', 'MACHINE-001');
+     * ```
+     */
     updateProperty(key: ConfigBeanKeys<T>, value: ConfigPropertyTypes): Promise<void>;
     /**
      * @category Action
@@ -60,12 +166,10 @@ declare class ConfigBeanModelImpl<T extends {} = any> implements IKosDataModel {
     updateConfigBean(): Promise<void>;
     /**
      * @category Subscription
-     * Updates the Config Bean model when a `/kos/config//update` event
-     * is recieved from the server.
-     *
+     * Updates the Config Bean model when a `/kos/config/{path}` event
+     * is received from the server.
      *
-     * @param data - the raw callback
-     * @param data.body - the Config Bean that was updated.
+     * @param configBean - the Config Bean that was updated.
      * @see ConfigBeanResponse
      */
     handleConfigBeanUpdated(configBean: ConfigBeanUpdateResponse): void;

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

@@ -1 +1 @@
-{"version":3,"file":"config-bean-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/config-bean/config-bean-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,OAAO,EACP,oBAAoB,EACrB,MAAM,eAAe,CAAC;AACvB,OAAO,EAIL,2BAA2B,EAG5B,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EACV,cAAc,EACd,uBAAuB,EACxB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAGL,KAAK,wBAAwB,EAE9B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAO/C,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,EAAE,GAAG,GAAG,IAAI,oBAAoB,CACrE,mBAAmB,CAAC,CAAC,CAAC,CACvB,CAAC;AAYF,eAAO,MAAM,sBAAsB,sBAAsB,CAAC;AAI1D;;;;;;;GAOG;AAEH,cACM,mBAAmB,CAAC,CAAC,SAAS,EAAE,GAAG,GAAG,CAAE,YAAW,aAAa;IACpE,OAAO,CAAC,iBAAiB,CAAiC;IAE1D,OAAO,CAAC,cAAc,CAA8B;IAEpD,OAAO,CAAC,OAAO,CAAC,CAAiB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAE/D,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAEnE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;;;;OAQG;gBACS,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,uBAAuB;IAqB7D,IAAI,MAAM,wCAET;IAEK,KAAK;IAIX;;;;;;;OAOG;IACG,IAAI;IAgBV,IAAI,UAAU,aAEb;IAED,oBAAoB,CAAC,GAAG,EAAE,MAAM;IAa1B,cAAc,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,mBAAmB;IAIvE;;;;;;;;;;OAUG;IACG,gBAAgB;IAOtB;;;;;;;;;OASG;IAKH,uBAAuB,CAAC,UAAU,EAAE,wBAAwB;CAG7D;AAED,eAAO,MAAM,UAAU,6EAMrB,CAAC"}
+{"version":3,"file":"config-bean-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/config-bean/config-bean-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,OAAO,EACP,oBAAoB,EACrB,MAAM,eAAe,CAAC;AACvB,OAAO,EAIL,2BAA2B,EAG5B,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EACV,cAAc,EACd,uBAAuB,EACxB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAGL,KAAK,wBAAwB,EAE9B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAO/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,EAAE,GAAG,GAAG,IAAI,oBAAoB,CACrE,mBAAmB,CAAC,CAAC,CAAC,CACvB,CAAC;AAYF,eAAO,MAAM,sBAAsB,sBAAsB,CAAC;AAK1D;;;GAGG;AACH,cACM,mBAAmB,CAAC,CAAC,SAAS,EAAE,GAAG,GAAG,CAAE,YAAW,aAAa;IACpE,yDAAyD;IACzD,OAAO,CAAC,iBAAiB,CAAiC;IAE1D,0DAA0D;IAC1D,OAAO,CAAC,cAAc,CAA8B;IAEpD,oEAAoE;IACpE,OAAO,CAAC,OAAO,CAAC,CAAiB;IACjC,8DAA8D;IAC9D,EAAE,EAAE,MAAM,CAAC;IACX,qFAAqF;IACrF,IAAI,EAAE,MAAM,CAAC;IACb,8DAA8D;IAC9D,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAE/D,oFAAoF;IACpF,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAEnE,oEAAoE;IACpE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;;;;OAQG;gBACS,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,uBAAuB;IAqB7D;;;;;;;;;;;OAWG;IACH,IAAI,MAAM,wCAET;IAED;;OAEG;IACG,KAAK;IAIX;;;;;;;OAOG;IACG,IAAI;IAgBV;;;;OAIG;IACH,IAAI,UAAU,aAEb;IAED;;;;;;;;;;;;;;OAcG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM;IAahC;;;;;;;;;;;;;OAaG;IACG,cAAc,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,mBAAmB;IAIvE;;;;;;;;;;OAUG;IACG,gBAAgB;IAOtB;;;;;;;OAOG;IAKH,uBAAuB,CAAC,UAAU,EAAE,wBAAwB;CAG7D;AAED,eAAO,MAAM,UAAU,6EAMrB,CAAC"}

package/models/models/config-bean/config-bean-types.d.ts

@@ -10,7 +10,8 @@ import { KosServiceResponse } from '../../../core';
  * implementations of services that can be used in the event that these overrides are
  * not provided
  *
- * @category Model
+ * @group KOS Model
+ * @category Configuration
  */
 export interface IConfigBeanModelOptionsActions {
     /**
@@ -50,7 +51,8 @@ export interface IConfigBeanModelOptionsActions {
  * in the constructor.  The value <strong>might</strong> be overriden by
  * subsequent lifecycle methods or updates.
  *
- * @category Options
+ * @group KOS Model
+ * @category Configuration
  * @internal
  */
 export interface IConfigBeanModelOptions extends Partial<IConfigBeanModelOptionsActions> {
@@ -61,6 +63,7 @@ export type ConfigBeanKeys<T> = keyof T;
 /**
  * Represents the public interface of a `IConfigBeanModel`
  *
- * @category Config Bean
+ * @group KOS Model
+ * @category Configuration
  */
 //# sourceMappingURL=config-bean-types.d.ts.map

package/models/models/config-bean/config-bean-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config-bean-types.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/config-bean/config-bean-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,4BAA4B,CAAC;AAEpC;;;;;;;;;;GAUG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,EAAE,CACjB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,iBAAiB,KACrB,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC;IAEtD;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,EAAE,CACd,EAAE,EAAE,MAAM,KACP,OAAO,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,GAAG,SAAS,CAAC,CAAC;CAClE;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,uBACf,SAAQ,OAAO,CAAC,8BAA8B,CAAC;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC;AACxC;;;;GAIG"}
+{"version":3,"file":"config-bean-types.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/config-bean/config-bean-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,4BAA4B,CAAC;AAEpC;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,EAAE,CACjB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,iBAAiB,KACrB,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC;IAEtD;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,EAAE,CACd,EAAE,EAAE,MAAM,KACP,OAAO,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,GAAG,SAAS,CAAC,CAAC;CAClE;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,uBACf,SAAQ,OAAO,CAAC,8BAA8B,CAAC;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC;AACxC;;;;;GAKG"}

package/models/models/config-bean/types/index.d.ts

@@ -0,0 +1,33 @@
+import { ConfigBeanRequest, ConfigBeanResponse } from '../../../services/config-bean';
+import { KosServiceResponse } from '../../../../core';
+
+
+/**
+ * Configuration options for ConfigBeanModel instances.
+ *
+ * Specifies which configuration path to access and optionally provides custom
+ * service implementations for testing or alternative backends.
+ *
+ * @category Model Configuration
+ * @category System Integration
+ */
+export interface IConfigBeanModelOptions {
+  /** The hierarchical configuration path using colon-separated notation (e.g., 'system:app', 'kos:service:CANPumpMgr') */
+  path: string;
+
+  /** Optional custom base path for configuration service endpoints */
+  serviceBasePath?: string;
+
+  /** Optional custom service implementation for retrieving configuration data */
+  getConfigBean?: (
+    path: string,
+    serviceBasePath?: string
+  ) => Promise<KosServiceResponse<ConfigBeanResponse> | undefined>;
+
+  /** Optional custom service implementation for updating configuration data */
+  modifyConfigBean?: (
+    path: string,
+    data: ConfigBeanRequest,
+    serviceBasePath?: string
+  ) => Promise<KosServiceResponse<unknown> | undefined>;
+}

package/models/models/config-bean-prop/config-bean-prop-model.d.ts

@@ -6,7 +6,8 @@ import { IConfigBeanModel } from '../config-bean/config-bean-model';
 import { UnitConverter } from '../../decorators/kos-config-bean-prop';
 
 /**
- * @inheritdoc
+ * @ignore
+ * @internal
  */
 declare class KosConfigPropertyImpl implements KosConfigProperty {
     id: string;
@@ -39,8 +40,32 @@ declare class KosConfigPropertyImpl implements KosConfigProperty {
      * @throws Error if the default unit for the given measure is not found
      **/
     getDefaultUnitForMeasure(measure: string, unitSystem: string): string;
+    /**
+     * Gets the schema data type for this property.
+     *
+     * @returns Schema type string (e.g., "String", "Number", "Boolean", "enum")
+     */
     get schemaType(): import('../../services/config-bean').SchemaNodeType | "enum";
+    /**
+     * Gets the schema format hint for this property.
+     *
+     * @returns Format string (e.g., "second", "milliliter", "hour") or empty string if not specified
+     */
     get schemaFormat(): string;
+    /**
+     * Gets available options for enumerated properties.
+     *
+     * @returns Array of options with label/value pairs for dropdowns and selection controls
+     *
+     * @example Get Property Options
+     * ```typescript
+     * const options = statusProperty.options;
+     * // Returns: [
+     * //   { label: "Active", value: "active" },
+     * //   { label: "Inactive", value: "inactive" }
+     * // ]
+     * ```
+     */
     get options(): OptionsType[];
     convertUnit(converter?: UnitConverter, defaultSystem?: string, defaultMeasure?: string): {
         measure: string | undefined;
@@ -55,21 +80,107 @@ declare class KosConfigPropertyImpl implements KosConfigProperty {
             unit: string | undefined;
         };
     };
+    /**
+     * Sets the configuration property value with automatic unit conversion.
+     *
+     * @param value - The new value to set (in regional units)
+     *
+     * @example Update Property Value
+     * ```typescript
+     * pumpRateProperty.value = 1.2; // Sets rate to 1.2 mL/s (converted to backend units)
+     * ```
+     */
     set value(value: ConfigPropertyTypes);
+    /**
+     * Gets the configuration property value converted to regional units.
+     *
+     * @returns Property value in regional display units
+     *
+     * @example Get Property Value
+     * ```typescript
+     * const currentRate = pumpRateProperty.value; // Gets rate in mL/s (regional units)
+     * ```
+     */
     get value(): ConfigPropertyTypes;
+    /**
+     * Gets the raw backend value without unit conversion.
+     *
+     * @returns Raw property value as stored in backend (typically SI units)
+     */
     get rawValue(): unknown;
+    /**
+     * Gets the property value with appropriate decimal precision for display.
+     *
+     * @returns Property value formatted with significant digits based on regional settings
+     */
     get significantValue(): unknown;
+    /**
+     * Gets the previous property value before the last update.
+     *
+     * @returns Previous property value in regional display units
+     *
+     * @example Track Value Changes
+     * ```typescript
+     * const oldValue = pumpRateProperty.previousValue; // Previous rate value
+     * const newValue = pumpRateProperty.value; // Current rate value
+     * console.log(`Rate changed from ${oldValue} to ${newValue}`);
+     * ```
+     */
     get previousValue(): {};
     getValue(current: boolean): {};
+    /**
+     * @internal
+     */
     activate(): Promise<void>;
+    /**
+     * Gets the formatted display string with units and localization.
+     *
+     * @returns Localized string representation with appropriate units (e.g., "1.2 mL/s", "150 °F")
+     *
+     * @example Display Formatted Value
+     * ```typescript
+     * const display = temperatureProperty.displayValue; // "72.5 °F"
+     * const rate = pumpRateProperty.displayValue; // "1.2 mL/s"
+     * ```
+     */
     get displayValue(): string;
+    /**
+     * Gets the unit of measure for the property value.
+     *
+     * @returns Unit string (e.g., "°F", "mL/s", "seconds") or empty string for unitless properties
+     *
+     * @example Get Property Unit
+     * ```typescript
+     * const unit = temperatureProperty.unit; // "°F" or "°C" based on regional settings
+     * const rateUnit = pumpRateProperty.unit; // "mL/s"
+     * ```
+     */
     get unit(): string | undefined;
+    /**
+     * Gets display formatting options from the backend schema.
+     *
+     * @returns Display options object with formatting preferences (decimals, style, etc.)
+     */
     get displayOptions(): import('../../services/config-bean').SchemaOptionsType | undefined;
     private getMeasureFromFormat;
     private getConverterFromFormat;
     private getDefaultUnit;
     getFormatterOptions(converter?: ConfigPropConverter): Intl.NumberFormat | null;
     private getConverter;
+    /**
+     * Updates the configuration property value with automatic unit conversion.
+     *
+     * @param value - The new value to set (in regional display units)
+     *
+     * @example Update Property
+     * ```typescript
+     * // Set temperature in Fahrenheit (regional unit)
+     * await temperatureProperty.updateProperty(75.5);
+     *
+     * // Set pump rate in mL/s (regional unit)
+     * await pumpRateProperty.updateProperty(1.2);
+     * ```
+     */
     updateProperty(value: ConfigPropertyTypes): Promise<void>;
 }
 declare const Registration: {

package/models/models/config-bean-prop/config-bean-prop-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config-bean-prop-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/config-bean-prop/config-bean-prop-model.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AAS3E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAc,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAKpD,OAAO,KAAK,EACV,qBAAqB,EACrB,mBAAmB,EACnB,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,WAAW,EACZ,MAAM,SAAS,CAAC;AAkDjB;;GAEG;AACH,cACM,qBAAsB,YAAW,iBAAiB;IACtD,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,UAAU,EAAG,eAAe,CAAC;IAG7B,IAAI,EAAG,gBAAgB,CAAC;gBAEZ,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,qBAAqB;IAY3D;;;;;;;QAOI;IACJ,2BAA2B,CACzB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,MAAM;IAgBf;;;;;;;;;QASI;IACJ,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAW5D,IAAI,UAAU,iEAOb;IAED,IAAI,YAAY,WAMf;IAED,IAAI,OAAO,kBAwBV;IAED,WAAW,CACT,SAAS,CAAC,EAAE,aAAa,EACzB,aAAa,CAAC,EAAE,MAAM,EACtB,cAAc,CAAC,EAAE,MAAM;;;;;IAazB,iBAAiB;;;;;;;;IAajB,IAAI,KAAK,CAAC,KAAK,EAAE,mBAAmB,EAEnC;IACD,IAAI,KAAK,IAHQ,mBAAmB,CAKnC;IAED,IAAI,QAAQ,YAEX;IAED,IAAI,gBAAgB,YA8BnB;IAED,IAAI,aAAa,OAEhB;IAED,QAAQ,CAAC,OAAO,EAAE,OAAO;IAcnB,QAAQ;IAId,IAAI,YAAY,WA2Bf;IAED,IAAI,IAAI,uBAWP;IAED,IAAI,cAAc,uEAMjB;IAED,OAAO,CAAC,oBAAoB;IAQ5B,OAAO,CAAC,sBAAsB;IAW9B,OAAO,CAAC,cAAc;IAgBtB,mBAAmB,CAAC,SAAS,CAAC,EAAE,mBAAmB;IAuDnD,OAAO,CAAC,YAAY;IAsDd,cAAc,CAAC,KAAK,EAAE,mBAAmB;CAgBhD;AAED,QAAA,MAAM,YAAY;;;;;;;;;CAWjB,CAAC;AACF,eAAe,YAAY,CAAC"}
+{"version":3,"file":"config-bean-prop-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/config-bean-prop/config-bean-prop-model.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AAS3E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAc,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAKpD,OAAO,KAAK,EACV,qBAAqB,EACrB,mBAAmB,EACnB,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,WAAW,EACZ,MAAM,SAAS,CAAC;AAmDjB;;;GAGG;AACH,cACM,qBAAsB,YAAW,iBAAiB;IACtD,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,UAAU,EAAG,eAAe,CAAC;IAG7B,IAAI,EAAG,gBAAgB,CAAC;gBAEZ,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,qBAAqB;IAY3D;;;;;;;QAOI;IACJ,2BAA2B,CACzB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,MAAM;IAgBf;;;;;;;;;QASI;IACJ,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAW5D;;;;OAIG;IACH,IAAI,UAAU,iEAOb;IAED;;;;OAIG;IACH,IAAI,YAAY,WAMf;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,OAAO,kBAwBV;IAED,WAAW,CACT,SAAS,CAAC,EAAE,aAAa,EACzB,aAAa,CAAC,EAAE,MAAM,EACtB,cAAc,CAAC,EAAE,MAAM;;;;;IAazB,iBAAiB;;;;;;;;IAajB;;;;;;;;;OASG;IACH,IAAI,KAAK,CAAC,KAAK,EAAE,mBAAmB,EAEnC;IAED;;;;;;;;;OASG;IACH,IAAI,KAAK,IAdQ,mBAAmB,CAgBnC;IAED;;;;OAIG;IACH,IAAI,QAAQ,YAEX;IAED;;;;OAIG;IACH,IAAI,gBAAgB,YA8BnB;IAED;;;;;;;;;;;OAWG;IACH,IAAI,aAAa,OAEhB;IAED,QAAQ,CAAC,OAAO,EAAE,OAAO;IAczB;;OAEG;IACG,QAAQ;IAId;;;;;;;;;;OAUG;IACH,IAAI,YAAY,WA2Bf;IAED;;;;;;;;;;OAUG;IACH,IAAI,IAAI,uBAWP;IAED;;;;OAIG;IACH,IAAI,cAAc,uEAMjB;IAED,OAAO,CAAC,oBAAoB;IAQ5B,OAAO,CAAC,sBAAsB;IAW9B,OAAO,CAAC,cAAc;IAgBtB,mBAAmB,CAAC,SAAS,CAAC,EAAE,mBAAmB;IAuDnD,OAAO,CAAC,YAAY;IAsDpB;;;;;;;;;;;;;OAaG;IACG,cAAc,CAAC,KAAK,EAAE,mBAAmB;CAgBhD;AAED,QAAA,MAAM,YAAY;;;;;;;;;CAWjB,CAAC;AACF,eAAe,YAAY,CAAC"}