@kosdev-code/kos-ddk-models 2.0.1 → 2.0.2

package/lib/agitation-control/agitation-control-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"agitation-control-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/ddk/kos-ddk-models/src/lib/agitation-control/agitation-control-model.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,eAAe,EAEf,aAAa,EACb,gBAAgB,EAGhB,kBAAkB,EAOlB,oBAAoB,EAIpB,KAAK,YAAY,EAClB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AASvD,eAAO,MAAM,UAAU,4BAA4B,CAAC;AACpD,eAAO,MAAM,cAAc,YAAY,CAAC;AACxC,eAAO,MAAM,cAAc,YAAY,CAAC;AACxC,MAAM,MAAM,qBAAqB,GAC/B,oBAAoB,CAAC,yBAAyB,CAAC,CAAC;AAElD,qBACa,yBACX,YAAW,aAAa,EAAE,gBAAgB,EAAE,eAAe;IAE3D,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,oBAAoB,CAAC;IACpC,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,gBAAgB,CAAwB;IAChD,OAAO,CAAC,kBAAkB,CAAC,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,CAAe;IAEhC,OAAO,CAAC,WAAW,CAAoB;gBAErC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,uBAAuB,EAChC,OAAO,EAAE,kBAAkB;IAY7B,IAAI,QAAQ,CAAC,KAAK,EAAE,OAAO,EAE1B;IACD,IAAI,QAAQ,IAHQ,OAAO,CAK1B;IACD,IAAI,YAAY,YAEf;IAED,IAAI,WAAW,YAEd;IAED,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAEzB;IAED,IAAI,OAAO,IAJQ,OAAO,CAMzB;IAED,IAAI,OAAO,YAIV;IAED,QAAQ;IAMR,IAAI,cAAc,YAKjB;IACD,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IA0B5D,OAAO,CAAC,UAAU,CAAgB;IAE5B,uBAAuB,CAAC,OAAO,CAAC,EAAE,MAAM;IAkB9C,IAAI,iBAAiB,YAEpB;IACD,IAAI,cAAc,QAKjB;IAED,IAAI,eAAe,QAKlB;IAGD,IAAI,MAAM,sDAET;IAED,IAAI,aAAa,sDAEhB;IAED,IAAI,aAAa,sDAEhB;IAGD,sBAAsB,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;IAMhE,oBAAoB,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;IAKtC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B,MAAM;IAUN,oBAAoB;IAUd,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}
+{"version":3,"file":"agitation-control-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/ddk/kos-ddk-models/src/lib/agitation-control/agitation-control-model.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,eAAe,EAEf,aAAa,EACb,gBAAgB,EAGhB,kBAAkB,EAOlB,oBAAoB,EAIpB,KAAK,YAAY,EAClB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AASvD,eAAO,MAAM,UAAU,4BAA4B,CAAC;AACpD,eAAO,MAAM,cAAc,YAAY,CAAC;AACxC,eAAO,MAAM,cAAc,YAAY,CAAC;AACxC,MAAM,MAAM,qBAAqB,GAC/B,oBAAoB,CAAC,yBAAyB,CAAC,CAAC;AAElD,qBACa,yBACX,YAAW,aAAa,EAAE,gBAAgB,EAAE,eAAe;IAE3D,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,oBAAoB,CAAC;IACpC,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,gBAAgB,CAAwB;IAChD,OAAO,CAAC,kBAAkB,CAAC,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,CAAe;IAEhC,OAAO,CAAC,WAAW,CAAoB;gBAErC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,uBAAuB,EAChC,OAAO,EAAE,kBAAkB;IAY7B,IAAI,QAAQ,CAAC,KAAK,EAAE,OAAO,EAE1B;IACD,IAAI,QAAQ,IAHQ,OAAO,CAK1B;IACD,IAAI,YAAY,YAIf;IAED,IAAI,WAAW,YAEd;IAED,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAEzB;IAED,IAAI,OAAO,IAJQ,OAAO,CAMzB;IAED,IAAI,OAAO,YAIV;IAED,QAAQ;IAMR,IAAI,cAAc,YAKjB;IACD,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IA0B5D,OAAO,CAAC,UAAU,CAAgB;IAE5B,uBAAuB,CAAC,OAAO,CAAC,EAAE,MAAM;IAkB9C,IAAI,iBAAiB,YAEpB;IACD,IAAI,cAAc,QAKjB;IAED,IAAI,eAAe,QAKlB;IAGD,IAAI,MAAM,sDAET;IAED,IAAI,aAAa,sDAEhB;IAED,IAAI,aAAa,sDAEhB;IAGD,sBAAsB,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;IAMhE,oBAAoB,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;IAKtC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B,MAAM;IAUN,oBAAoB;IAUd,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}

package/lib/spm-pump/index.d.ts

@@ -0,0 +1,5 @@
+export { SpmPump } from './spm-pump-registration';
+export type * from './types';
+export type { SpmPumpModel } from './spm-pump-model';
+export * as SpmPumpServices from './services';
+//# sourceMappingURL=index.d.ts.map

package/lib/spm-pump/index.d.ts.map

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

package/lib/spm-pump/services/index.d.ts

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

package/lib/spm-pump/services/index.d.ts.map

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

package/lib/spm-pump/services/spm-pump-services.d.ts

@@ -0,0 +1,7 @@
+import { FutureResponse } from '../../../../../../sdk/kos-ui-sdk/src/index.ts';
+
+export declare const performPreCalibrate: (pump: string, tracker?: string) => Promise<FutureResponse>;
+export declare const performCalibrate: (pump: string, tracker?: string) => Promise<FutureResponse>;
+export declare const performVerify: (pump: string, volume: string, payload: any, tracker?: string) => Promise<FutureResponse>;
+export declare const performComplete: (pump: string, volume1: string, volume2: string, payload: any) => Promise<any>;
+//# sourceMappingURL=spm-pump-services.d.ts.map

package/lib/spm-pump/services/spm-pump-services.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spm-pump-services.d.ts","sourceRoot":"","sources":["../../../../../../../packages/ddk/kos-ddk-models/src/lib/spm-pump/services/spm-pump-services.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,cAAc,EAEpB,MAAM,yBAAyB,CAAC;AAYjC,eAAO,MAAM,mBAAmB,SAAgB,MAAM,YAAY,MAAM,4BAoCvE,CAAC;AAEF,eAAO,MAAM,gBAAgB,SAAgB,MAAM,YAAY,MAAM,4BAoCpE,CAAC;AAEF,eAAO,MAAM,aAAa,SAClB,MAAM,UACJ,MAAM,WACL,GAAG,YACF,MAAM,4BA4CjB,CAAC;AAEF,eAAO,MAAM,eAAe,SACpB,MAAM,WACH,MAAM,WACN,MAAM,WACN,GAAG,iBA8Bb,CAAC"}

package/lib/spm-pump/spm-pump-model.d.ts

@@ -0,0 +1,26 @@
+import { IntentAware, IntentAwareProps } from '../../../../../sdk/kos-dispense-sdk/src/index.ts';
+import { SpmPumpOptions } from './types';
+import { KosCreationContext, IKosDataModel, IKosIdentifiable, PublicModelInterface, FutureContainer, FutureAwareContainer, FutureResponse } from '../../../../../sdk/kos-ui-sdk/src/index.ts';
+
+export declare const MODEL_TYPE = "spm-pump-model";
+export type SpmPumpModel = PublicModelInterface<SpmPumpModelImpl>;
+export declare class SpmPumpModelImpl implements IKosDataModel, IKosIdentifiable, IntentAware, FutureContainer {
+    id: string;
+    private logger;
+    private pump;
+    futureHandler: FutureAwareContainer;
+    constructor(modelId: string, options: SpmPumpOptions, context: KosCreationContext);
+    get name(): string;
+    get canPour(): boolean;
+    get isPouring(): boolean;
+    cancelPour(): Promise<void>;
+    performIntent(props: IntentAwareProps | string): Promise<FutureResponse | undefined>;
+    get future(): import('../../../../../sdk/kos-ui-sdk/src/index.ts').IFutureModel<Record<string, unknown>> | undefined;
+    performPreCalibrate(tracker?: string): Promise<FutureResponse>;
+    performCalibrate(tracker?: string): Promise<FutureResponse>;
+    performVerify(volume: string, payload: any, tracker?: string): Promise<FutureResponse>;
+    performComplete(volume1: string, volume2: string, payload: any): Promise<any>;
+    init(): Promise<void>;
+    load(): Promise<void>;
+}
+//# sourceMappingURL=spm-pump-model.d.ts.map

package/lib/spm-pump/spm-pump-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spm-pump-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/ddk/kos-ddk-models/src/lib/spm-pump/spm-pump-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,EACf,oBAAoB,EACpB,cAAc,EACf,MAAM,yBAAyB,CAAC;AAGjC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,OAAO,KAAK,EACV,WAAW,EACX,gBAAgB,EAEjB,MAAM,+BAA+B,CAAC;AAQvC,eAAO,MAAM,UAAU,mBAAmB,CAAC;AAE3C,MAAM,MAAM,YAAY,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;AAElE,qBACa,gBACX,YAAW,aAAa,EAAE,gBAAgB,EAAE,WAAW,EAAE,eAAe;IAExE,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,IAAI,CAAY;IACxB,aAAa,EAAE,oBAAoB,CAAC;gBAGlC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,cAAc,EACvB,OAAO,EAAE,kBAAkB;IAS7B,IAAI,IAAI,WAEP;IAED,IAAI,OAAO,YAEV;IAED,IAAI,SAAS,YAEZ;IAEK,UAAU;IAIhB,aAAa,CACX,KAAK,EAAE,gBAAgB,GAAG,MAAM,GAC/B,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAItC,IAAI,MAAM,wFAET;IAGK,mBAAmB,CAAC,OAAO,CAAC,EAAE,MAAM;IAKpC,gBAAgB,CAAC,OAAO,CAAC,EAAE,MAAM;IAKjC,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,MAAM;IAI5D,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;IAM9D,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}

package/lib/spm-pump/spm-pump-registration.d.ts

@@ -0,0 +1,87 @@
+import { SpmPumpModel } from './spm-pump-model';
+import { SpmPumpOptions } from './types';
+import { KosModelRegistrationFactory } from '../../../../../sdk/kos-ui-sdk/src/index.ts';
+
+/**
+ * # SpmPump
+ *
+ * The registration bean includes convenience methods for creating and working with SpmPumpModel 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: SpmPump.type, id: "spmPumpId"})
+ * private spmPumpModel: SpmPumpModel;
+ * ```
+ *
+ *
+ * ## factory
+ *
+ * The factory method creates a factory function that can be used to create new SpmPumpModel instances.
+ *
+ 
+ * The factory function is a curried function that takes the model id as the first argument and the options as the second argument.
+ *
+ * If a model with the specified id 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 = SpmPump.factory("spmPumpId")({
+ *   // 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 SpmPumpModel.
+ *
+ * @example
+ * ```typescript
+ *
+ * const model: IKosDataModel = ...; // some model
+ *
+ * if (SpmPump.predicate(model)) {
+ *    // if the function evaluates to true, the model is narrowed down to SpmPumpModel
+ *    // and the compiler will know that the model has the SpmPumpModel 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 { SpmPump } 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(SpmPump);
+ * ```
+ *
+ * ## registration.singleton
+ 
+ * The spmPump model is NOT a singleton model.  This means that each time the factory function is called with a unique ID, a new model instance will be created.
+ * If the factory function is called with an ID that already exists, the existing model will be returned.
+ 
+ * */
+export declare const SpmPump: KosModelRegistrationFactory<SpmPumpModel, SpmPumpOptions>;
+//# sourceMappingURL=spm-pump-registration.d.ts.map

package/lib/spm-pump/spm-pump-registration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spm-pump-registration.d.ts","sourceRoot":"","sources":["../../../../../../packages/ddk/kos-ddk-models/src/lib/spm-pump/spm-pump-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAgFK;AACL,eAAO,MAAM,OAAO,2DAMlB,CAAC"}

package/lib/spm-pump/types/index.d.ts

@@ -0,0 +1,5 @@
+import { PumpOptions, PumpModel } from '../../../../../../sdk/kos-dispense-sdk/src/index.ts';
+import { IKosCompanionOptions } from '../../../../../../sdk/kos-ui-sdk/src/index.ts';
+
+
+export type SpmPumpOptions = IKosCompanionOptions<SpmPumpModel, SpmPumpOptions>;

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@kosdev-code/kos-ddk-models",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "dependencies": {
-    "@kosdev-code/kos-ui-sdk": "~2.0.8",
-    "@kosdev-code/kos-dispense-sdk": "~2.0.8",
-    "@kosdev-code/kos-freestyle-sdk": "~2.0.8"
+    "@kosdev-code/kos-ui-sdk": "~2.0.18",
+    "@kosdev-code/kos-dispense-sdk": "~2.0.18",
+    "@kosdev-code/kos-freestyle-sdk": "~2.0.18"
   },
   "main": "./index.js",
   "module": "./index.mjs",
   "typings": "./index.d.ts",
   "kos": {
     "build": {
-      "gitHash": "26743490ccd3555641529b81d803612636a8eba3"
+      "gitHash": "6d5033cbef412a98aef14c695c39ea48b5625e8a"
     }
   },
   "publishConfig": {