@kosdev-code/kos-ui-sdk 2.0.2

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

@@ -0,0 +1,3 @@
+export { default as KosConfigPropertySpec } from './config-bean-prop-model';
+export type * from './types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/config-bean-prop/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAC5E,mBAAmB,SAAS,CAAC"}

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

@@ -0,0 +1,76 @@
+import { ConfigPropertyTypes } from '../../types';
+import { IKosDataModel } from '../../core';
+import { SchemaNodeType, SchemaOptionsType } from '../../../services/config-bean';
+import { UnitConverter } from '../../../decorators';
+
+
+export interface ConfigPropConverter {
+  measure?: string;
+  from?: UnitConverter;
+  to?: UnitConverter;
+}
+
+export type FormatOptions =
+  | Intl.NumberFormatOptions
+  | ((system: string) => Intl.NumberFormatOptions);
+
+export interface OptionsType {
+  value: string;
+  label: string;
+}
+export type OptionsExpander =
+  | OptionsType[]
+  | ((system: string, options?: string[]) => OptionsType[]);
+/**
+ * Options that are passed into the model via the constructor
+ *
+ * @property path - the handle path for the config bean
+ * @property attribute - the attribute on the config bean
+ * @property converter - the converter indicating the source and target unit conversions
+ * @property formatter - the formatting to be applied to numeric values.  Uses the Intl.NumberFormatOptions
+ */
+export interface ConfigBeanPropOptions {
+  path: string;
+  attribute: string;
+  converter?: { from?: UnitConverter; to?: UnitConverter };
+  formatter?: FormatOptions;
+  optionsExpander?: OptionsExpander;
+  serviceBasePath?: string;
+}
+
+/**
+ * @property id - the unique identifier of the config bean property
+ * @property value - the raw value of the config property after any unit conversion
+ * The value does not perform any rounding or formatting
+ * @property displayValue - the string value of the value after all formatting, rounding
+ * and unit conversion
+ * @property unit - the unit of measure for the property.  This unit will be formatted based
+ * on the formatter options provided.
+ *
+ * @category Configuration Service
+ *
+ */
+export interface KosConfigProperty<
+  PropertyType extends ConfigPropertyTypes = ConfigPropertyTypes
+> extends ConfigBeanPropOptions,
+    IKosDataModel {
+  id: string;
+  serviceBasePath?: string;
+  readonly unit?: string;
+  readonly value?: PropertyType;
+  readonly rawValue?: PropertyType;
+  readonly significantValue?: PropertyType;
+  readonly previousValue?: PropertyType;
+  readonly displayValue?: string;
+  readonly displayOptions?: SchemaOptionsType;
+  readonly options?: OptionsType[];
+  readonly schemaType: SchemaNodeType | "enum";
+  readonly schemaFormat?: string;
+  /**
+   * Update the property value of the config bean property resulting in a
+   * the value being pushed to the backend for persistence.
+   * @param value - the value of the property
+   * @returns - void
+   */
+  updateProperty: (value: PropertyType | string) => void;
+}

package/models/models/device/device-model.d.ts

@@ -0,0 +1,48 @@
+import { DeviceOptions } from './types';
+import { IKosDataModel, IKosIdentifiable, KosCreationContext, PublicModelInterface } from '../../../core';
+
+export declare const MODEL_TYPE = "device-model";
+export declare const TOPIC_CRITICAL_DATA_CHANGED = "/kos/criticalData/changed";
+export declare const TOPIC_CRITICAL_DATA_AVAILABLE = "/kos/criticalData/available";
+export declare const TOPIC_CRITICAL_DATA_UNAVAILABLE = "/kos/criticalData/unavailable";
+/**
+ * A model representing a device.
+ * This is an alias for the implementation {@link DeviceModelImpl}.
+ *
+ * @category Model
+ *
+ */
+export type DeviceModel = PublicModelInterface<DeviceModelImpl>;
+export declare class DeviceModelImpl implements IKosDataModel, IKosIdentifiable {
+    id: string;
+    private logger;
+    private _serialNumber;
+    get serialNumber(): string | "unassigned";
+    private _name;
+    get name(): string | "unassigned";
+    private _nodeId;
+    get nodeId(): string | "unassigned";
+    get nodeType(): string;
+    get nodeName(): string;
+    constructor(modelId: string, _options: DeviceOptions, context: KosCreationContext);
+    /**
+     * Update the model with new options.
+     */
+    updateModel(options: DeviceOptions): void;
+    private loadDeviceData;
+    private loadSerialNumber;
+    /**
+     * Handle critical data changes to load the serial number at the appropriate time.
+     */
+    handleCriticalDataChanged(): Promise<void>;
+    init(): Promise<void>;
+    /**
+     * Load the device data.
+     *
+     * This method is called when the device model is loaded.
+     *
+     *
+     */
+    load(): Promise<void>;
+}
+//# sourceMappingURL=device-model.d.ts.map

package/models/models/device/device-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/device/device-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,eAAe,CAAC;AAGvB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,eAAO,MAAM,UAAU,iBAAiB,CAAC;AACzC,eAAO,MAAM,2BAA2B,8BAA8B,CAAC;AACvE,eAAO,MAAM,6BAA6B,gCAAgC,CAAC;AAC3E,eAAO,MAAM,+BAA+B,kCAAkC,CAAC;AAE/E;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG,oBAAoB,CAAC,eAAe,CAAC,CAAC;AAEhE,qBACa,eAAgB,YAAW,aAAa,EAAE,gBAAgB;IACrE,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,aAAa,CAAwB;IAE7C,IAAI,YAAY,IAAI,MAAM,GAAG,YAAY,CAExC;IAED,OAAO,CAAC,KAAK,CAAwB;IAErC,IAAI,IAAI,IAAI,MAAM,GAAG,YAAY,CAEhC;IAED,OAAO,CAAC,OAAO,CAAwB;IAEvC,IAAI,MAAM,IAAI,MAAM,GAAG,YAAY,CAElC;IAED,IAAI,QAAQ,IAAI,MAAM,CAGrB;IAED,IAAI,QAAQ,IAAI,MAAM,CAGrB;gBAGC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,aAAa,EACvB,OAAO,EAAE,kBAAkB;IAS7B;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;YAM3B,cAAc;YAYd,gBAAgB;IAU9B;;OAEG;IAKG,yBAAyB;IAOzB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B;;;;;;OAMG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAK5B"}

package/models/models/device/device-registration.d.ts

@@ -0,0 +1,89 @@
+import { DeviceOptions } from './types';
+import { DeviceModel } from './device-model';
+import { SingletonKosModelRegistrationFactory } from '../../../core';
+
+/**
+ * # Device
+ *
+ * The registration bean includes convenience methods for creating and working with DeviceModel instances.
+ *
+ * ## type
+ * The type property is a string that identifies the model type.
+ * The type is used to identify the model type in the model registry and to narrow down the model type in type predicates.  It's most frequently
+ * used when declaring dependencies on models.
+ *
+ * @example
+ * ```typescript
+ *
+ * @kosDependency({modelType: Device.type, id: "deviceId"})
+ * private deviceModel: DeviceModel;
+ * ```
+ *
+ *
+ * ## factory
+ *
+ * The factory method creates a factory function that can be used to create new DeviceModel instances.
+ *
+ 
+ * As this is a singleton model, the factory function accepts the model options as its argument.
+ *
+ * If a model with the same model type already exists, the factory function will return the existing model.  The options will be ignored
+ * in this case and the existing model will be returned in its current state.
+ *
+ * @example
+ * ```typescript
+ * const model = Device.factory({
+ *   // Add option data
+ * });
+ * ```
+ 
+
+ *
+ * ## predicate
+ *
+ * [Typescript type predicate](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates) function that will identify and narrow down a model to a DeviceModel.
+ *
+ * @example
+ * ```typescript
+ *
+ * const model: IKosDataModel = ...; // some model
+ *
+ * if (Device.predicate(model)) {
+ *    // if the function evaluates to true, the model is narrowed down to DeviceModel
+ *    // and the compiler will know that the model has the DeviceModel interface
+ *    model.updateAvailability(false);
+ * }
+ * ```
+ *
+ * ## registration
+ *
+ * The registration property is an object that can be used to simplify registration of the model with the model registry.  The registration object
+ * can be spread into the model registration and provides all of the required information to register the model implementation class against the model type.
+ *
+ *
+ * @example
+ *
+ * In an application registration file you can declare the model registration as follows:
+ *
+ * **registration.ts**
+ * ```typescript
+ * import { Device } from "@kos-ui/project-models";
+ * import { KosModelRegistry } from "@kosdev-code/kos-dispense-sdk";
+ *
+ * import { initKosProvider } from "@kosdev-code/kos-ui-sdk";
+ *
+ * KosModelRegistry.dispense
+ * .models()
+ * .model(Device);
+ * ```
+ *
+ * ## registration.singleton
+ 
+ * The device model is a singleton model.  This means that each time the factory function is called , the same instance will be returned.
+ * If the model does not yet exist, it will be created passing in the provided options to initialize it.
+ *
+ * Singleton models don't require an ID as they will use the model type as their ID to guarantee uniqueness throughout the system.
+ 
+ * */
+export declare const Device: SingletonKosModelRegistrationFactory<DeviceModel, DeviceOptions>;
+//# sourceMappingURL=device-registration.d.ts.map

package/models/models/device/device-registration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-registration.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/device/device-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oCAAoC,EAAE,MAAM,eAAe,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAkFK;AACL,eAAO,MAAM,MAAM,kEAMjB,CAAC"}

package/models/models/device/index.d.ts

@@ -0,0 +1,5 @@
+export { Device } from './device-registration';
+export type * from './types';
+export type { DeviceModel } from './device-model';
+export * as DeviceServices from './services';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/device/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,mBAAmB,SAAS,CAAC;AAC7B,YAAY,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,cAAc,MAAM,YAAY,CAAC"}

package/models/models/device/services/device-services.d.ts

@@ -0,0 +1,21 @@
+type SerialNumberResponse = [string | undefined, string | undefined];
+type DeviceResponse = [string, undefined] | [undefined, DevicePayload];
+type DevicePayload = {
+    serialNumber: string;
+    name: string;
+    nodeId: string;
+};
+/**
+ * @category Service
+ * @internal
+ * Retrieves the device serial number.
+ */
+export declare const getSerialNumber: () => Promise<SerialNumberResponse>;
+/**
+ * @category Service
+ * @internal
+ * Retrieves the initial device data.
+ */
+export declare const getDeviceDetails: () => Promise<DeviceResponse>;
+export {};
+//# sourceMappingURL=device-services.d.ts.map

package/models/models/device/services/device-services.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/device/services/device-services.ts"],"names":[],"mappings":"AAgBA,KAAK,oBAAoB,GAAG,CAAC,MAAM,GAAG,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;AAErE,KAAK,cAAc,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;AACvE,KAAK,aAAa,GAAG;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AACF;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAa,QAAQ,oBAAoB,CAgBpE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,QAAa,QAAQ,cAAc,CAmB/D,CAAC"}

package/models/models/device/services/index.d.ts

@@ -0,0 +1,2 @@
+export * from './device-services';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/device/services/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}

package/models/models/device/types/index.d.ts

@@ -0,0 +1,5 @@
+export interface DeviceOptions {
+  serialNumber?: string;
+  name?: string;
+  nodeId?: string;
+}

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

@@ -0,0 +1,32 @@
+import { FutureAwareContainer, FutureContainer, IFutureModel } from './future-types';
+
+export declare class MultipleFutureHandler<T extends {} = Record<string, unknown>> implements FutureAwareContainer<T> {
+    private futures;
+    private defaultContext;
+    private context;
+    private disposers;
+    private container?;
+    constructor(container?: FutureContainer<T>, defaultContext?: string);
+    get allFutures(): IFutureModel<T>[];
+    get future(): IFutureModel<T> | undefined;
+    addFuture(future: IFutureModel<T>, alias?: string): void;
+    removeFuture(alias?: string): void;
+    getFuture(alias?: string): IFutureModel<T> | undefined;
+}
+export declare class FutureHandler<T extends object = Record<string, unknown>> implements FutureAwareContainer<T> {
+    private disposer?;
+    private _future?;
+    private container?;
+    constructor(container?: FutureContainer<T>);
+    removeFuture(): void;
+    get future(): IFutureModel<T> | undefined;
+    getFuture(): IFutureModel<T> | undefined;
+    addFuture(future: IFutureModel<T>): void;
+    onFutureUpdate?: ((future: IFutureModel<T>) => void) | undefined;
+    get allFutures(): IFutureModel<T>[];
+    get timeRemaining(): string;
+    get status(): string;
+    get progress(): number;
+    cancel(): Promise<void>;
+}
+//# sourceMappingURL=future-aware.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"future-aware.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/future/future-aware.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,YAAY,EACb,MAAM,gBAAgB,CAAC;AAExB,qBAAa,qBAAqB,CAAC,CAAC,SAAS,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACvE,YAAW,oBAAoB,CAAC,CAAC,CAAC;IAElC,OAAO,CAAC,OAAO,CAA+B;IAC9C,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,SAAS,CAAiC;IAClD,OAAO,CAAC,SAAS,CAAC,CAAqB;gBAC3B,SAAS,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,EAAE,MAAM;IAQnE,IAAI,UAAU,sBAEb;IAED,IAAI,MAAM,gCAET;IACD,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM;IAWjD,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM;IAM3B,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM;CAIzB;AAED,qBAAa,aAAa,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACnE,YAAW,oBAAoB,CAAC,CAAC,CAAC;IAElC,OAAO,CAAC,QAAQ,CAAC,CAAa;IAE9B,OAAO,CAAC,OAAO,CAAC,CAAkB;IAClC,OAAO,CAAC,SAAS,CAAC,CAAqB;gBAC3B,SAAS,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC;IAK1C,YAAY;IAMZ,IAAI,MAAM,gCAET;IACD,SAAS,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS;IAIxC,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;IAWjC,cAAc,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAEjE,IAAI,UAAU,sBAEb;IACD,IAAI,aAAa,WAEhB;IAED,IAAI,MAAM,WAET;IAED,IAAI,QAAQ,WAEX;IAEK,MAAM;CAUb"}

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

@@ -0,0 +1,5 @@
+import { IFutureModel, IFutureModelOptions } from './future-types';
+
+export declare const FUTURE_MODEL_TYPE = "future-model";
+export declare const FutureFactory: import('../../../core').ModelFactory<IFutureModel<Record<string, unknown>>, IFutureModelOptions<Record<string, unknown>>>;
+//# sourceMappingURL=future-factory.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"future-factory.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/future/future-factory.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAExE,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAChD,eAAO,MAAM,aAAa,2HAEzB,CAAC"}

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

@@ -0,0 +1,76 @@
+import { IFutureModel, IFutureModelOptions } from './future-types';
+import { FutureResponse } from '../../services/future';
+import { ModelFactory } from '../../../core';
+
+/**
+ * Maps a `FutureResponse` DTO to an `IFutureModelOptions` object.
+ *
+ * @remarks
+ * This function will perform any type conversion or data mapping required
+ * by the IKosDataModel.  For example, date conversion or changes in interfaces
+ * can be managed at this layer rather than having the models deal with the
+ * various versions of the interface directly.
+ *
+ * @params dto - the Data Transfer Object received from the backend
+ * @returns - a valid `IFutureModelOptions` that can be used to
+ * instantiate a new model.
+ * @internal
+ * @category future
+ */
+export declare const mapDtoToFutureOptions: (dto: FutureResponse) => IFutureModelOptions<Record<string, unknown>>;
+/**
+ * Maps a `FutureResponse` DTO to an `IFutureModel` object.
+ *
+ * @remarks
+ * This function will run as a mobx action ensuring that all observers are notified
+ * if any changes are made.
+ *
+ * @params dto - the Data Transfer Object received from the backend
+ * @params model - the IModel to be update
+ * @internal
+ * @category future
+ */
+export declare const mapDtoToFutureModel: (dto: FutureResponse, model: IFutureModel) => void;
+/**
+ * Curried function that will produce a function that can be used to retrieve or create
+ * new instances of a `IFutureModel` given an ID and options.
+ *
+ * @remarks
+ * This serves as a convenience allowing for models to consumers to use a shorthand method when
+ * multiple models need to be created.
+ * The first level of function will accept a KOS Model Factory and return a function that can accept a single
+ * model ID parameter.  This will return a factory function that can accept a model options parameter and
+ * instantiate a new instance of a model or retrieve a an existing model.
+ *
+ * @param factory - the model factory to be used
+ * @returns - an instance of the `IFutureModel` that was either created
+ * or retrieved from the KOS Model framework if already existing.
+ *
+ * @internal
+ * @category future
+ */
+export declare const buildFutureModel: (factory: ModelFactory<IFutureModel, IFutureModelOptions>) => (modelId: string) => (futureOptions: IFutureModelOptions) => IFutureModel<Record<string, unknown>>;
+/**
+ * Factory function that simplifies the creation of a new model
+ *
+ * @remarks
+ * This method will map the response object to an `IFutureModelOptions` instance and
+ * construct a new instance of a model using the provided factory.  This will provide a shorthand
+ * for consumers when creating instances of models and allows for additional operations to be performed
+ * as part of the creation process.
+ *
+ * @example
+ * // create a new (potentially static) instance of the factory that can be used throughout the code.
+ * const buildFutureModel = buildFuture((FutureModel.Factory));
+ *
+ * // use the builder to create a new instance of the model from an options instance.
+ * const future: IFutureResponse = someFunctionToGetResponseFromServer();
+ * const futureModel = buildFutureModel(future);
+ *
+ * @param factory - The model factory that can be used to
+ *
+ * @internal
+ * @category future
+ */
+export declare const buildFuture: (factory: ModelFactory<IFutureModel, IFutureModelOptions>) => (future: FutureResponse) => any;
+//# sourceMappingURL=future-model-builder.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"future-model-builder.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/future/future-model-builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAmB,MAAM,eAAe,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAExE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,qBAAqB,QAAS,cAAc,iDAcxD,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,mBAAmB,QACzB,cAAc,SACZ,YAAY,SA6BpB,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,gBAAgB,YACjB,aAAa,YAAY,EAAE,mBAAmB,CAAC,eAC/C,MAAM,qBACA,mBAAmB,0CAGlC,CAAC;AAEJ;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,WAAW,YACZ,aAAa,YAAY,EAAE,mBAAmB,CAAC,cAChD,cAAc,QAIZ,CAAC"}

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

@@ -0,0 +1,66 @@
+import { IFutureModel, IFutureModelOptions } from './future-types';
+import { FutureEndState, FutureResponse } from '../../services/future';
+import { KosCreationContext } from '../../../core';
+
+interface FutureModel extends IFutureModel {
+}
+/**
+ * @category future
+ * @name FutureModel
+ * @version 1.0.0
+ * @author Matthew Holman <maholman@coca-cola.com>
+ *
+ * Represents a future.
+ */
+declare class FutureModel implements IFutureModel {
+    private logger;
+    private _cancelFuture;
+    futureId: string;
+    /**
+     * @category Constructor
+     *
+     * @param modelId - the unique modelId for this Future
+     * @param options - any options that should be merged into the Future
+     * @params options.id - the unique id of the Future
+     * @params options.name - the name of the Future
+     *
+     */
+    constructor(modelId: string, options: IFutureModelOptions, context: KosCreationContext);
+    /**
+     * @category Lifecycle
+     *
+     * @remarks
+     * No action is taken as part of the load lifecycle method.
+     *
+     * In future additional information about the workspace could be loaded
+     */
+    load(): Promise<void>;
+    unload(): void;
+    /**
+     * @category Action
+     *
+     * @remark
+     * Cancels the current future.
+     *
+     * If a service was passed in as part of the options in the constructor
+     * then it will be used.  Otherwise the default services will be invoked.
+     *
+     * @see cancelFutureService
+     */
+    cancelFuture(): Promise<void>;
+    get status(): FutureEndState | "IN_PROGRESS" | "NOT_ACTIVE";
+    get timeRemaining(): string;
+    /**
+     * @category Subscription
+     * Updates the Future model when a `kos.future/ID` event
+     * is received from the server.
+     *
+     *
+     * @param data - the raw callback
+     * @param data.body - the Future that was updated.
+     * @see FutureResponse
+     */
+    handleFutureUpdated(future: FutureResponse): void;
+}
+export default FutureModel;
+//# sourceMappingURL=future-model.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"future-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/future/future-model.ts"],"names":[],"mappings":"AACA,OAAO,EAOL,KAAK,kBAAkB,EACxB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,cAAc,EAGd,KAAK,cAAc,EACpB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAOxE,UAAU,WAAY,SAAQ,YAAY;CAAG;AAI7C;;;;;;;GAOG;AACH,cACM,WAAY,YAAW,YAAY;IACvC,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,aAAa,CAGuB;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;;;;OAQG;gBAED,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,kBAAkB;IAwB7B;;;;;;;OAOG;IACG,IAAI;IAIV,MAAM;IAMN;;;;;;;;;;OAUG;IACG,YAAY;IASlB,IAAI,MAAM,kDAMT;IAED,IAAI,aAAa,WAoChB;IAID;;;;;;;;;OASG;IAIH,mBAAmB,CAAC,MAAM,EAAE,cAAc;CAM3C;AAED,eAAe,WAAW,CAAC"}

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

@@ -0,0 +1,83 @@
+import { FutureEndState } from '../../services/future';
+import { IKosDataModel } from '../../../core';
+
+export interface FutureDelegate<T extends {} = Record<string, unknown>> {
+    future?: IFutureModel<T>;
+}
+export interface FutureContainer<T extends {} = Record<string, unknown>> {
+    futureHandler: FutureAwareContainer<T>;
+    onFutureUpdate?: (future: IFutureModel<T>) => void;
+}
+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;
+}
+export interface FutureAware {
+    readonly statusFuture?: IFutureModel;
+    status: string;
+    progress: number;
+    timeRemaining: string;
+    cancel: () => Promise<void>;
+}
+/**
+ * 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
+ */
+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;
+}
+/**
+ * Represents the public interface of a `IFutureModel`
+ *
+ * @category Model
+ */
+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,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACpE,MAAM,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;CAC1B;AACD,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,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;AACD,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;;;;;;;;;;;GAWG;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;;;;GAIG;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, } 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,GACpB,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"}