@kosdev-code/kos-ui-sdk 0.1.0-dev.5053

package/models/models/future/future-types.d.ts

@@ -0,0 +1,265 @@
+import { FutureEndState } from '../../services/future';
+import { IKosDataModel } from '../../../core';
+
+/**
+ * Basic Future delegation interface for models that hold a single Future reference.
+ *
+ * @group KOS Model
+ * @category Asynchronous Operations
+ */
+export interface FutureDelegate<T extends {} = Record<string, unknown>> {
+    future?: IFutureModel<T>;
+}
+/**
+ * Container pattern for managing multiple Future operations in KOS models.
+ *
+ * Provides comprehensive Future management capabilities for models that handle
+ * multiple concurrent long-running operations with centralized lifecycle management.
+ *
+ * @example Basic Future Container
+ * ```typescript
+ * @kosModel("device-operations-model")
+ * export class DeviceOperationsModel implements FutureContainer {
+ *   futureHandler: FutureAwareContainer;
+ *
+ *   constructor(modelId: string, options: any, context: KosCreationContext) {
+ *     this.id = modelId;
+ *     this.futureHandler = new FutureHandler(this);
+ *   }
+ *
+ *   onFutureUpdate(future: IFutureModel): void {
+ *     // Handle progress updates from any managed Future
+ *     console.log(`Operation ${future.id}: ${future.progress}%`);
+ *   }
+ * }
+ * ```
+ *
+ * @group KOS Model
+ * @category Asynchronous Operations
+ */
+export interface FutureContainer<T extends {} = Record<string, unknown>> {
+    futureHandler: FutureAwareContainer<T>;
+    onFutureUpdate?: (future: IFutureModel<T>) => void;
+}
+/**
+ * Advanced pattern for models managing multiple named Future operations.
+ *
+ * @group KOS Model
+ * @category Asynchronous Operations
+ */
+export interface MultiFutureAware<T extends {} = Record<string, unknown>> {
+    futureMap: Map<string, IFutureModel<T>>;
+}
+/**
+ * Container interface providing comprehensive Future lifecycle management.
+ *
+ * Handles multiple concurrent Futures with operations for adding, removing,
+ * and querying Future instances. Essential for complex models that coordinate
+ * multiple device operations simultaneously.
+ *
+ * @example Future Container Operations
+ * ```typescript
+ * // Add new Future with optional alias
+ * container.addFuture(calibrationFuture, 'pump-calibration');
+ *
+ * // Query specific Future
+ * const future = container.getFuture('pump-calibration');
+ *
+ * // Remove completed Future
+ * container.removeFuture('pump-calibration');
+ *
+ * // Get all active Futures
+ * const activeFutures = container.allFutures;
+ * ```
+ *
+ * @group KOS Model
+ * @category Asynchronous Operations
+ */
+export interface FutureAwareContainer<T extends {} = Record<string, unknown>> extends FutureDelegate<T> {
+    removeFuture(alias?: string): void;
+    getFuture(alias?: string): IFutureModel<T> | undefined;
+    addFuture(future: IFutureModel<T>, alias?: string): void;
+    allFutures: IFutureModel<T>[];
+    onFutureUpdate?: (future: IFutureModel<T>) => void;
+}
+/**
+ * Simplified interface for models that need basic Future awareness.
+ *
+ * Provides essential Future status information without full container complexity.
+ * Ideal for models that typically handle single operations or need simple
+ * Future integration.
+ *
+ * @example Basic Future Awareness
+ * ```typescript
+ * function OperationStatus({ model }: { model: FutureAware }) {
+ *   return (
+ *     <div>
+ *       <p>Status: {model.status}</p>
+ *       <progress value={model.progress} max={100} />
+ *       <p>Time remaining: {model.timeRemaining}</p>
+ *       {model.status === 'IN_PROGRESS' && (
+ *         <button onClick={() => model.cancel()}>Cancel</button>
+ *       )}
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ * @group KOS Model
+ * @category Asynchronous Operations
+ */
+export interface FutureAware {
+    readonly statusFuture?: IFutureModel;
+    status: string;
+    progress: number;
+    timeRemaining: string;
+    cancel: () => Promise<void>;
+}
+/**
+ * Configuration options for Future model instances.
+ *
+ * Defines the initial state and parameters for Future operations including
+ * progress tracking, client data attachment, and namespace configuration.
+ *
+ * @remarks
+ * Used to identify additional data that can be set on the model during
+ * instantiation. It is expected that implementers will set these properties
+ * in the constructor. The value <strong>might</strong> be overridden by
+ * subsequent lifecycle methods or updates.
+ *
+ * @example Basic Future Options
+ * ```typescript
+ * const futureOptions: IFutureModelOptions = {
+ *   id: 'calibration-123',
+ *   namespace: 'kos',
+ *   progress: 0,
+ *   clientData: { deviceId: 'pump-S4', targetRate: 1.2 }
+ * };
+ *
+ * const future = FutureFactory.instance('my-future')
+ *   .options(futureOptions)
+ *   .build();
+ * ```
+ *
+ * @group KOS Model
+ * @category Asynchronous Operations
+ */
+export interface IFutureModelOptions<T extends {} = Record<string, unknown>> {
+    id: string;
+    tracker?: string;
+    progress?: number;
+    remainingTimeMs?: number;
+    endState?: FutureEndState;
+    reason?: string;
+    namespace?: string;
+    reasonData?: {
+        name: string;
+        version: string;
+    } | {
+        vmId: string;
+        target: string;
+    } | {
+        vmId: string;
+        target: string;
+    }[];
+    clientData?: T;
+    note?: string;
+}
+/**
+ * Future - Reactive long-running operation management for KOS devices and applications.
+ *
+ * The Future model provides comprehensive tracking and management of asynchronous operations
+ * with real-time progress updates, cancellation support, and automatic lifecycle management.
+ * Essential for building responsive user interfaces that handle time-consuming operations.
+ *
+ * ## Key Features
+ * - **Real-Time Progress Tracking** - Live updates via WebSocket topics with percentage completion
+ * - **Cancellation Support** - Ability to cancel in-progress operations safely
+ * - **Automatic Cleanup** - Models self-destruct when operations complete or fail
+ * - **Status Management** - Clear status reporting (NOT_ACTIVE, IN_PROGRESS, Success, Fail)
+ * - **Time Estimation** - Remaining time calculations with localized formatting
+ * - **Client Data Attachment** - Associate custom data with future operations
+ * - **Namespace Support** - Separate futures for different services (kos, studio, etc.)
+ *
+ * ## Operation Lifecycle
+ * Futures progress through distinct states with automatic status management:
+ * - **NOT_ACTIVE** - Operation not yet started or queued
+ * - **IN_PROGRESS** - Operation actively executing with progress updates
+ * - **Success** - Operation completed successfully (triggers automatic cleanup)
+ * - **Fail** - Operation failed with error details (triggers automatic cleanup)
+ *
+ * ## Common Use Cases
+ * - **Device Operations** - Track pump calibration, system diagnostics, configuration updates
+ * - **File Transfers** - Monitor upload/download progress with cancellation support
+ * - **System Updates** - Track firmware updates, package installations, system maintenance
+ * - **Data Processing** - Monitor analysis operations, report generation, bulk operations
+ * - **VM Management** - Track VM creation, deployment, and lifecycle operations
+ *
+ * @example Basic Future Tracking
+ * ```typescript
+ * const calibrationFuture = FutureFactory.instance('calibration-op')
+ *   .options({
+ *     id: 'pump-cal-123',
+ *     namespace: 'kos',
+ *     clientData: { pumpId: 'S4', targetRate: 0.9 }
+ *   })
+ *   .build();
+ *
+ * // Monitor progress
+ * console.log(`Status: ${calibrationFuture.status}`);
+ * console.log(`Progress: ${calibrationFuture.progress}%`);
+ * console.log(`Time remaining: ${calibrationFuture.timeRemaining}`);
+ *
+ * // Cancel if needed
+ * await calibrationFuture.cancelFuture();
+ * ```
+ *
+ * @example React Integration
+ * ```typescript
+ * function CalibrationProgress({ futureId }: { futureId: string }) {
+ *   const future = useFuture(futureId);
+ *
+ *   return (
+ *     <div>
+ *       <progress value={future.progress} max={100} />
+ *       <p>{future.timeRemaining} remaining</p>
+ *       {future.status === 'IN_PROGRESS' && (
+ *         <button onClick={() => future.cancelFuture()}>
+ *           Cancel Operation
+ *         </button>
+ *       )}
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ * @interface
+ * @group KOS Model
+ * @category Asynchronous Operations
+ * @useDeclaredType
+ *
+ * @see {@link IFutureModelOptions} - Configuration options for Future instances
+ * @see {@link FutureAware} - Interface for models that integrate with Futures
+ * @see {@link FutureContainer} - Container pattern for managing multiple Futures
+ */
+export interface IFutureModel<T extends {} = Record<string, unknown>> extends IKosDataModel, Omit<IFutureModelOptions<T>, "modifyFuture"> {
+    id: string;
+    progress: number;
+    remainingTimeMs: number;
+    endState?: FutureEndState;
+    reason?: string;
+    reasonData?: {
+        vmId: string;
+        target: string;
+    } | {
+        vmId: string;
+        target: string;
+    }[];
+    clientData?: T;
+    note?: string;
+    futureId: string;
+    status: string;
+    cancelFuture: () => Promise<void>;
+    timeRemaining: string;
+}
+//# sourceMappingURL=future-types.d.ts.map

package/models/models/future/future-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"future-types.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/future/future-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACpE,MAAM,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACrE,aAAa,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC;IACvC,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;CACpD;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACtE,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CACzC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAC1E,SAAQ,cAAc,CAAC,CAAC,CAAC;IACzB,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IACvD,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzD,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9B,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;CACpD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACzE,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EACP;QACE,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,GACD;QACE,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,GACD;QACE,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,EAAE,CAAC;IACR,UAAU,CAAC,EAAE,CAAC,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4EG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAClE,SAAQ,aAAa,EACnB,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EACP;QACE,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,GACD;QACE,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,EAAE,CAAC;IACR,UAAU,CAAC,EAAE,CAAC,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAClC,aAAa,EAAE,MAAM,CAAC;CACvB"}

package/models/models/future/index.d.ts

@@ -0,0 +1,6 @@
+export * from './future-aware';
+export * from './future-factory';
+export { default as FutureModel } from './future-model';
+export * from './future-model-builder';
+export type { FutureAware, FutureAwareContainer, FutureContainer, FutureDelegate, IFutureModel, IFutureModelOptions, MultiFutureAware, } from './future-types';
+//# sourceMappingURL=index.d.ts.map

package/models/models/future/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/future/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACxD,cAAc,wBAAwB,CAAC;AACvC,YAAY,EACV,WAAW,EACX,oBAAoB,EACpB,eAAe,EACf,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,gBAAgB,GACjB,MAAM,gBAAgB,CAAC"}

package/models/models/future-container/future-container-factory.d.ts

@@ -0,0 +1,5 @@
+import { IFutureContainerModel } from './future-container-types';
+
+export declare const FUTURE_CONTAINER_MODEL_TYPE = "future-container-model";
+export declare const FutureContainerFactory: import('../../../core').ModelFactory<IFutureContainerModel, Partial<import('./future-container-types').IFutureContainerModelOptionsActions>>;
+//# sourceMappingURL=future-container-factory.d.ts.map

package/models/models/future-container/future-container-factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"future-container-factory.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/future-container/future-container-factory.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,qBAAqB,EAEtB,MAAM,0BAA0B,CAAC;AAElC,eAAO,MAAM,2BAA2B,2BAA2B,CAAC;AACpE,eAAO,MAAM,sBAAsB,8IAGL,CAAC"}

package/models/models/future-container/future-container-model.d.ts

@@ -0,0 +1,124 @@
+import { IFutureContainerModel, IFutureContainerModelOptions } from './future-container-types';
+import { IFutureModel } from '../future';
+import { ApiCallback } from '../../../common';
+import { FutureRequest, FutureResponse } from '../../services/future';
+import { KosCreationContext } from '../../../core';
+
+/**
+ * @category future
+ * @name FutureContainerModel
+ * @version 1.0.0
+ * @author Matthew Holman <maholman@coca-cola.com>
+ * @internal
+ * Represents a list of Future
+ */
+declare class FutureContainerModel implements IFutureContainerModel {
+    id: string;
+    private logger;
+    private _deleteFuture;
+    private _addFuture;
+    private _futures;
+    createModel: <T = void>(request: FutureRequest) => Promise<T>;
+    deleteModel: (id: string) => Promise<void>;
+    constructor(modelId: string, options: IFutureContainerModelOptions, context: KosCreationContext);
+    /**
+     * @category Computed
+     * @getter
+     * Computed value that will recalculate automatically whenever Futures
+     * are added or removed from the map.
+     *
+     * @returns the list of Futures
+     *
+     * @internal
+     */
+    get futures(): IFutureModel<Record<string, unknown>>[];
+    get models(): IFutureModel<Record<string, unknown>>[];
+    /**
+     * Convenience function that will retrieve the IFutureModel based on
+     * the id.
+     *
+     * @param futureId - the id of the future to be retrieved
+     * @returns the `IFutureModel` or `undefined` if not available in the list
+     * @internal
+     */
+    getFuture(futureId: string): IFutureModel<Record<string, unknown>> | undefined;
+    /**
+     * @category Action
+     * Internally adds the provided Future to the map
+     *
+     * @param group - The Future model to add
+     * @internal
+     */
+    addFutureModel(model: IFutureModel): void;
+    /**
+     * @category Action
+     * Internally adds the provided Future to the map
+     *
+     * @param group - The Future model to add
+     * @internal
+     */
+    removeFutureModel(id: string): void;
+    /**
+     * This is the entry point which enables an this model to be “visited” by a visitor object.
+     *
+     * @remarks
+     * Futures as part of a KOS Model Visitor pattern allowing clients
+     * to traverse the KOS Model hierarchy and perform operations on elements
+     * as they are "visited".
+     *
+     * Ths method serves as an entry point for visitors allowing them to dispatch
+     * actions on elements in a collection without requiring the models to have
+     * explicit knowledge of the operation being performed.
+     *
+     * @group KOS Model
+     * @internal
+     */
+    /**
+     * Gets the direct children of this Future collection.
+     *
+     * @remarks
+     * Allows the KOS Model framework to operate off of a directed graph
+     * and perform generic operations on collections of models by traversing
+     * the hierarchy.
+     *
+     * This method will inform the framework of what child models exist in a containment
+     * relationship.
+     *
+     * @returns - the collection of Future models maintained by this model.
+     * @group KOS Model
+     * @internal
+     */
+    /**
+     * Removes a Future model from the collection.
+     *
+     * @remarks
+     * If a remove service function was passed in as part of the options
+     * in the constructor then it will be used.  Otherwise the default
+     * delete service will be invoked.
+     *
+     * @param id - the id of the Future to be removed
+     *
+     * @see deleteFutureService
+     * @category Action
+     * @internal
+     */
+    removeFuture(id: string): Promise<void>;
+    /**
+     * Adds a Future model into the collection.
+     *
+     * @remarks
+     * If an add service function was passed in as part of the options
+     * in the constructor then it will be used.  Otherwise the default
+     * add service will be invoked.
+     *
+     * @param model - the Future model to be added
+     *
+     * @see addFutureService
+     * @category Action
+     * @internal
+     */
+    createFuture(model: FutureRequest): Promise<any>;
+    handleFutureUpdated(future: FutureResponse, payload: ApiCallback): void;
+}
+export default FutureContainerModel;
+//# sourceMappingURL=future-container-model.d.ts.map

package/models/models/future-container/future-container-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"future-container-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/future-container/future-container-model.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAQL,KAAK,kBAAkB,EAExB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAE3E,OAAO,EAAY,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAM7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAI9C,OAAO,KAAK,EACV,qBAAqB,EACrB,4BAA4B,EAC7B,MAAM,0BAA0B,CAAC;AAGlC;;;;;;;GAOG;AACH,cACM,oBAAqB,YAAW,qBAAqB;IACzD,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,aAAa,CAEiC;IACtD,OAAO,CAAC,UAAU,CAEgC;IAGlD,OAAO,CAAC,QAAQ,CAAmC;IACnD,WAAW,EAAE,CAAC,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC9D,WAAW,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;gBAGzC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,4BAA4B,EACrC,OAAO,EAAE,kBAAkB;IAa7B;;;;;;;;;OASG;IACH,IAAI,OAAO,4CAEV;IAED,IAAI,MAAM,4CAET;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM;IAI1B;;;;;;OAMG;IACH,cAAc,CAAC,KAAK,EAAE,YAAY;IAIlC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,EAAE,MAAM;IAI5B;;;;;;;;;;;;;;OAcG;IAEH;;;;;;;;;;;;;;OAcG;IAGH;;;;;;;;;;;;;OAaG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM;IAQ7B;;;;;;;;;;;;;OAaG;IACG,YAAY,CAAC,KAAK,EAAE,aAAa;IAsBvC,mBAAmB,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,WAAW;CAOjE;AAED,eAAe,oBAAoB,CAAC"}

package/models/models/future-container/future-container-types.d.ts

@@ -0,0 +1,109 @@
+import { IFutureModel } from '../future/future-types';
+import { FutureRequest } from '../../services/future';
+import { IKosContainerModel, IKosDataModel, KosServiceResponse } from '../../../core';
+
+/**
+ * Actions that can be optionally passed into a FutureContainerModel via
+ * the options parameter and can override the default service to be called.
+ *
+ * @remarks
+ * It is expected that implementations of `IKosDataModel` will have default
+ * implementations of services that can be used in the event that these overrides are
+ * not provided
+ *
+ * @category future
+ * @internal
+ */
+export interface IFutureContainerModelOptionsActions {
+    /**
+     * Service to delete an FutureModel from the backend.
+     *
+     * @remarks
+     * it is expected that the response will not provide any additional data and the
+     * system should only assume that a successful response means that the request was
+     * accepted by the backend.  Successful deletion of the model will be broadcast
+     * via the appropriate Event Topic.
+     *
+     * @returns - a Promise that resolves to an empty `KosServiceResponse`
+     * @category Service
+     * @internal
+     */
+    deleteFuture: (groupId: string) => Promise<KosServiceResponse<unknown> | undefined>;
+    /**
+     * Service to add an FutureModel to the backend.
+     *
+     * @remarks
+     * it is expected that the response will not provide any additional data and the
+     * system should only assume that a successful response means that the request was
+     * accepted by the backend.  Successful addition of the model will be broadcast
+     * via the appropriate Event Topic.
+     *
+     * @returns - a Promise that resolves to an empty `KosServiceResponse`
+     * @category Service
+     * @internal
+     */
+    addFuture: (future: FutureRequest) => Promise<KosServiceResponse<any> | undefined>;
+}
+/**
+ * Additional properties that can be passed into the constructor in order
+ * to set initial values
+ *
+ * @remarks
+ * Used to identify additional data that can be set on the model during
+ * instantiation.  It is expected that implementers will set these properties
+ * in the constructor.  The value <strong>might</strong> be overriden by
+ * subsequent lifecycle methods or updates.
+ *
+ * @category future
+ * @internal
+ */
+export type IFutureContainerModelOptions = Partial<IFutureContainerModelOptionsActions>;
+/**
+ * Represents the public interface of a `IFutureContainerModel`
+ *
+ * @category future
+ * @internal
+ */
+export interface IFutureContainerModel extends IKosContainerModel<IFutureModel, FutureRequest>, IKosDataModel, Omit<IFutureContainerModelOptions, "getFutures" | "deleteFuture" | "addFuture"> {
+    futures: IFutureModel[];
+    /**
+     * Retrieve the IFutureModel based on the id.
+     * @internal
+     * @param futureId - the id of the future to be retrieved
+     * @returns the `IFutureModel` or `undefined` if not avaiable in the list
+     */
+    getFuture: (futureId: string) => IFutureModel | undefined;
+    /**
+     * Adds a Future model into the collection.
+     *
+     * @remarks
+     * If an add service function was passed in as part of the options
+     * in the constructor then it will be used.  Otherwise the default
+     * add service will be invoked.
+     *
+     * @param model - the Future model to be added
+     *
+     * @see addFutureService
+     * @category Action
+     * @internal
+     */
+    createFuture: <T = void>(model: FutureRequest) => Promise<T>;
+    /**
+     * Removes a Future model from the collection.
+     *
+     * @remarks
+     * If a remove service function was passed in as part of the options
+     * in the constructor then it will be used.  Otherwise the default
+     * delete service will be invoked.
+     *
+     * @param id - the id of the Future to be removed
+     *
+     * @see deleteFutureService
+     * @category Action
+     * @internal
+     */
+    removeFuture: (id: string) => Promise<void>;
+    addFutureModel: (model: IFutureModel) => void;
+    removeFutureModel: (id: string) => void;
+}
+//# sourceMappingURL=future-container-types.d.ts.map

package/models/models/future-container/future-container-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"future-container-types.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/future-container/future-container-types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,mCAAmC;IAClD;;;;;;;;;;;;OAYG;IACH,YAAY,EAAE,CACZ,OAAO,EAAE,MAAM,KACZ,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC;IAEtD;;;;;;;;;;;;OAYG;IACH,SAAS,EAAE,CACT,MAAM,EAAE,aAAa,KAClB,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC;CACnD;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,4BAA4B,GACtC,OAAO,CAAC,mCAAmC,CAAC,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,WAAW,qBACf,SAAQ,kBAAkB,CAAC,YAAY,EAAE,aAAa,CAAC,EACrD,aAAa,EACb,IAAI,CACF,4BAA4B,EAC5B,YAAY,GAAG,cAAc,GAAG,WAAW,CAC5C;IACH,OAAO,EAAE,YAAY,EAAE,CAAC;IAExB;;;;;OAKG;IACH,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,YAAY,GAAG,SAAS,CAAC;IAC1D;;;;;;;;;;;;;OAaG;IACH,YAAY,EAAE,CAAC,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,aAAa,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC7D;;;;;;;;;;;;;OAaG;IACH,YAAY,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,cAAc,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;IAC9C,iBAAiB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CACzC"}

package/models/models/future-container/index.d.ts

@@ -0,0 +1,4 @@
+export type { IFutureContainerModel, IFutureContainerModelOptions, } from './future-container-types';
+export { default as FutureContainerModel } from './future-container-model';
+export * from './future-container-factory';
+//# sourceMappingURL=index.d.ts.map

package/models/models/future-container/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/future-container/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,qBAAqB,EACrB,4BAA4B,GAC7B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAC3E,cAAc,4BAA4B,CAAC"}

package/models/models/index.d.ts

@@ -0,0 +1,22 @@
+export * from './browser-router';
+export * from './config-bean';
+export * from './config-bean-prop';
+export * from './future';
+export * from './future-container';
+export * from './key-value';
+export * from './kos-expression-evaluator';
+export * from './kos-log-manager';
+export * from './kos-time';
+export * from './log-stream';
+export * from './ota';
+export * from './region-info';
+export * from './software-info';
+export * from './state-bean';
+export * from './state-prop';
+export * from './translation';
+export * from './trouble';
+export * from './trouble-container';
+export { troubleDataFactory } from './trouble-container/trouble-utils';
+export * from './types';
+export * from './ws-event';
+//# sourceMappingURL=index.d.ts.map

package/models/models/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/models/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC"}

package/models/models/key-value/index.d.ts

@@ -0,0 +1,9 @@
+export type { KeyValueModel } from './key-value-model';
+export { KeyValue } from './key-value-registration';
+/**
+ * @group KOS Model
+ * @category Key-Value Store
+ */
+export * as KeyValueServices from './services';
+export type * from './types';
+//# sourceMappingURL=index.d.ts.map

package/models/models/key-value/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/key-value/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD;;;GAGG;AACH,OAAO,KAAK,gBAAgB,MAAM,YAAY,CAAC;AAC/C,mBAAmB,SAAS,CAAC"}