@kosdev-code/kos-ui-sdk 2.0.2

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.
+     *
+     * @category 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.
+     * @category 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,20 @@
+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-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,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,5 @@
+export type { KeyValueModel } from './key-value-model';
+export { KeyValue } from './key-value-registration';
+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,OAAO,KAAK,gBAAgB,MAAM,YAAY,CAAC;AAC/C,mBAAmB,SAAS,CAAC"}

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

@@ -0,0 +1,19 @@
+import { KeyValueOptions } from './types';
+import { KeyValueUpdate } from './services';
+import { IKosDataModel, IKosIdentifiable, KosCreationContext, KosData, PublicModelInterface } from '../../../core';
+
+export declare const MODEL_TYPE = "key-value-model";
+export type KeyValueModel = PublicModelInterface<KeyValueModelImpl>;
+export declare class KeyValueModelImpl implements IKosDataModel, IKosIdentifiable {
+    id: string;
+    private logger;
+    private namespace;
+    data: KosData<Record<string, string | number | boolean | undefined>>;
+    constructor(modelId: string, options: KeyValueOptions, context: KosCreationContext);
+    init(): Promise<void>;
+    updateState(key: string, value: string | number | boolean | undefined): Promise<void>;
+    load(): Promise<void>;
+    handleStateUpdate(update: KeyValueUpdate): void;
+    handleStateDelete(update: KeyValueUpdate): void;
+}
+//# sourceMappingURL=key-value-model.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"key-value-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/key-value/key-value-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,OAAO,EACP,oBAAoB,EACrB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAIL,KAAK,cAAc,EACpB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C,eAAO,MAAM,UAAU,oBAAoB,CAAC;AAE5C,MAAM,MAAM,aAAa,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;AAEpE,qBACa,iBAAkB,YAAW,aAAa,EAAE,gBAAgB;IACvE,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,SAAS,CAAS;IAC1B,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC;gBAEnE,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,kBAAkB;IAUvB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,WAAW,CACf,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAC3C,OAAO,CAAC,IAAI,CAAC;IAUV,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAO3B,iBAAiB,CAAC,MAAM,EAAE,cAAc;IAQxC,iBAAiB,CAAC,MAAM,EAAE,cAAc;CAMzC"}

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

@@ -0,0 +1,89 @@
+import { KeyValueOptions } from './types';
+import { KeyValueModel } from './key-value-model';
+import { KosModelRegistrationFactory } from '../../../core';
+
+/**
+ * # KeyValue
+ *
+ * The registration bean includes convenience methods for creating and working with KeyValueModel 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: KeyValue.type, id: "studioStateId"})
+ * private studioStateModel: KeyValueModel;
+ * ```
+ *
+ *
+ * ## factory
+ *
+ * The factory method creates a factory function that can be used to create new KeyValueModel 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 = KeyValue.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 KeyValueModel.
+ *
+ * @example
+ * ```typescript
+ *
+ * const model: IKosDataModel = ...; // some model
+ *
+ * if (KeyValue.predicate(model)) {
+ *    // if the function evaluates to true, the model is narrowed down to KeyValueModel
+ *    // and the compiler will know that the model has the KeyValueModel 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 { KeyValue } 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(KeyValue);
+ * ```
+ *
+ * ## registration.singleton
+ 
+ * The studioState 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 KeyValue: KosModelRegistrationFactory<KeyValueModel, KeyValueOptions>;
+//# sourceMappingURL=key-value-registration.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"key-value-registration.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/key-value/key-value-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAkFK;AACL,eAAO,MAAM,QAAQ,6DAMnB,CAAC"}

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

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

package/models/models/key-value/services/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/services/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC"}

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

@@ -0,0 +1,18 @@
+interface KeyValueResponse {
+    [key: string]: string | number | boolean;
+}
+export interface KeyValueUpdate {
+    namespace: string;
+    key: string;
+    value: string;
+}
+export declare const deleteKeyValue: (namespace: string, key: string) => Promise<void>;
+export declare const updateKeyValue: (namespace: string, key: string, value: string | number | boolean) => Promise<any>;
+/**
+ * @category Service
+ * Retrieves the initial studio-state data.
+ */
+export declare const getKeyValue: (namespace?: string) => Promise<KeyValueResponse>;
+export declare const deleteKeyValueNamespace: (namespace: string) => Promise<void>;
+export {};
+//# sourceMappingURL=key-value-services.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"key-value-services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/key-value/services/key-value-services.ts"],"names":[],"mappings":"AAUA,UAAU,gBAAgB;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CAC1C;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,eAAO,MAAM,cAAc,cAAqB,MAAM,OAAO,MAAM,kBAKlE,CAAC;AACF,eAAO,MAAM,cAAc,cACd,MAAM,OACZ,MAAM,SACJ,MAAM,GAAG,MAAM,GAAG,OAAO,iBAcjC,CAAC;AACF;;;GAGG;AACH,eAAO,MAAM,WAAW,mDAavB,CAAC;AAEF,eAAO,MAAM,uBAAuB,cAAqB,MAAM,kBAK9D,CAAC"}

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

@@ -0,0 +1,3 @@
+export interface KeyValueOptions {
+  namespace?: string;
+}

package/models/models/kos-core/index.d.ts

@@ -0,0 +1,11 @@
+import { IKosRegistry, IKosCoreManager } from '../../../core';
+
+declare class KosCoreModel {
+    core: IKosCoreManager;
+    private _token;
+    constructor(registry: IKosRegistry);
+    get token(): string;
+    set token(token: string);
+}
+export default KosCoreModel;
+//# sourceMappingURL=index.d.ts.map

package/models/models/kos-core/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/kos-core/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,eAAe,EAAW,MAAM,eAAe,CAAC;AAEzD,cAAM,YAAY;IAChB,IAAI,EAAE,eAAe,CAAC;IACtB,OAAO,CAAC,MAAM,CAAS;gBACX,QAAQ,EAAE,YAAY;IAMlC,IAAI,KAAK,IAGQ,MAAM,CADtB;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,EAGtB;CACF;AAED,eAAe,YAAY,CAAC"}

package/models/models/kos-time/index.d.ts

@@ -0,0 +1,5 @@
+export type { KosTimeModel } from './kos-time-model';
+export { KosTime } from './kos-time-registration';
+export * as KosTimeServices from './services';
+export type * from './types';
+//# sourceMappingURL=index.d.ts.map

package/models/models/kos-time/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/kos-time/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,KAAK,eAAe,MAAM,YAAY,CAAC;AAC9C,mBAAmB,SAAS,CAAC"}

package/models/models/kos-time/kos-time-model.d.ts

@@ -0,0 +1,36 @@
+import { DateBean, KosTimeOptions, TimeBean } from './types';
+import { IKosDataModel, IKosModelLogger, KosContextLogger, KosCreationContext, PublicModelInterface } from '../../../core';
+
+export declare const MODEL_TYPE = "kos-time-model";
+export type KosTimeModel = PublicModelInterface<KosTimeModelImpl>;
+export declare class KosTimeModelImpl implements IKosModelLogger, IKosDataModel {
+    id: string;
+    logger: KosContextLogger;
+    timezone: string;
+    constructor(modelId: string, _options: KosTimeOptions, context: KosCreationContext);
+    /**
+     * Updates the system clock to the provided time.
+     *
+     * @param time - The time to set the system time to
+     */
+    updateSystemTime(time: TimeBean): Promise<void>;
+    /**
+     * Updates the system clock to the provided date.
+     *
+     * @param date - The date to set the system date to
+     */
+    updateSystemDate(date: DateBean): Promise<void>;
+    /**
+     * Updates the system clock to the provided timezone.
+     * @param timezone - The timezone to set the system timezone to
+     */
+    updateSystemTimezone(timezone: string): Promise<void>;
+    handleTimeChange(): void;
+    handleDayChange(): void;
+    handleTimeZoneChange(): Promise<void>;
+    init(): Promise<void>;
+    private retrieveTimezone;
+    setTimezone(tz: string): void;
+    load(): Promise<void>;
+}
+//# sourceMappingURL=kos-time-model.d.ts.map

package/models/models/kos-time/kos-time-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kos-time-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/kos-time/kos-time-model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,eAAe,CAAC;AAIvB,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,cAAc,EAAE,KAAK,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC5E,eAAO,MAAM,UAAU,mBAAmB,CAAC;AAM3C,MAAM,MAAM,YAAY,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;AAClE,qBACa,gBAAiB,YAAW,eAAe,EAAE,aAAa;IACrE,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,gBAAgB,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;gBAEf,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,cAAc,EACxB,OAAO,EAAE,kBAAkB;IAO7B;;;;OAIG;IACG,gBAAgB,CAAC,IAAI,EAAE,QAAQ;IAIrC;;;;OAIG;IACG,gBAAgB,CAAC,IAAI,EAAE,QAAQ;IAIrC;;;OAGG;IACG,oBAAoB,CAAC,QAAQ,EAAE,MAAM;IAK3C,gBAAgB,IAAI,IAAI;IAMxB,eAAe,IAAI,IAAI;IAMjB,oBAAoB;IAQpB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;YAIb,gBAAgB;IAI9B,WAAW,CAAC,EAAE,EAAE,MAAM;IAGhB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAI5B"}

package/models/models/kos-time/kos-time-registration.d.ts

@@ -0,0 +1,87 @@
+import { KosTimeOptions } from './types';
+import { KosTimeModel } from './kos-time-model';
+import { SingletonKosModelRegistrationBean } from '../../../core';
+
+/**
+ * # KosTime
+ *
+ * The registration bean includes convenience methods for creating and working with KosTimeModel 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: KosTime.type, id: "kosTimeId"})
+ * private kosTimeModel: KosTimeModel;
+ * ```
+ *
+ *
+ * ## factory
+ *
+ * The factory method creates a factory function that can be used to create new KosTimeModel 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 = KosTime.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 KosTimeModel.
+ *
+ * @example
+ * ```typescript
+ *
+ * const model: IKosDataModel = ...; // some model
+ *
+ * if (KosTime.predicate(model)) {
+ *    // if the function evaluates to true, the model is narrowed down to KosTimeModel
+ *    // and the compiler will know that the model has the KosTimeModel 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 { KosTime } from "@kosdev-code/kos-dispense-sdk";
+ * ...
+ * import { ExtensionManager, IKosRegistry } from "@kosdev-code/kos-ui-sdk";
+ * export const kosModels: IKosRegistry["models"] = {
+ *  ...KosTime.registration,
+ * };
+ * ```
+ *
+ * ## registration.singleton
+ 
+ * The kosTime 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.
+ * @private
+ * */
+export declare const KosTime: Readonly<SingletonKosModelRegistrationBean<KosTimeModel, KosTimeOptions>>;
+//# sourceMappingURL=kos-time-registration.d.ts.map

package/models/models/kos-time/kos-time-registration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kos-time-registration.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/kos-time/kos-time-registration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,eAAe,CAAC;AAEvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAgFK;AACL,eAAO,MAAM,OAAO,EAAE,QAAQ,CAC5B,iCAAiC,CAAC,YAAY,EAAE,cAAc,CAAC,CAWhE,CAAC"}

package/models/models/kos-time/services/index.d.ts

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

package/models/models/kos-time/services/index.d.ts.map

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

package/models/models/kos-time/services/kos-time-services.d.ts

@@ -0,0 +1,16 @@
+interface TimeBean {
+    hour: number;
+    min: number;
+    sec: number;
+}
+interface DateBean {
+    month: number;
+    day: number;
+    year: number;
+}
+export declare const setTime: (time: TimeBean) => Promise<any>;
+export declare const setDate: (date: DateBean) => Promise<any>;
+export declare const setTimezone: (timezone: string) => Promise<any>;
+export declare const getTimezone: () => Promise<string>;
+export {};
+//# sourceMappingURL=kos-time-services.d.ts.map

package/models/models/kos-time/services/kos-time-services.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kos-time-services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-ui-sdk/src/models/models/kos-time/services/kos-time-services.ts"],"names":[],"mappings":"AAWA,UAAU,QAAQ;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACb;AAED,UAAU,QAAQ;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAcD,eAAO,MAAM,OAAO,SAAgB,QAAQ,iBAW3C,CAAC;AAEF,eAAO,MAAM,OAAO,SAAgB,QAAQ,iBAW3C,CAAC;AAEF,eAAO,MAAM,WAAW,aAAoB,MAAM,iBAUjD,CAAC;AAEF,eAAO,MAAM,WAAW,uBAUvB,CAAC"}

package/models/models/kos-time/types/index.d.ts

@@ -0,0 +1,13 @@
+export interface TimeBean {
+  hour: number;
+  min: number;
+  sec: number;
+}
+
+export interface DateBean {
+  month: number;
+  day: number;
+  year: number;
+}
+
+export interface KosTimeOptions {}