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

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

@@ -0,0 +1 @@
+{"version":3,"file":"pump-services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/pump/services/pump-services.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EAEd,kBAAkB,EAGnB,MAAM,yBAAyB,CAAC;AAWjC,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,OAAO,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,aAAa;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,oBAAoB;IAC5B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,eAAO,MAAM,UAAU,iCAIpB,aAAa,4DAQf,CAAC;AAEF,eAAO,MAAM,eAAe,WAAkB,MAAM,UAAU,MAAM,kCAQnE,CAAC"}

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

@@ -0,0 +1,56 @@
+import { IntentAware } from '../../types';
+import { IKosDataModel, TroubleAware } from '@kosdev-code/kos-ui-sdk';
+
+
+export enum PourStatus {
+  IDLE = "idle",
+  POURING = "pouring",
+}
+export interface PumpOptions<AdditionalData extends object = any> {
+  inserted: boolean;
+  type: string;
+  ingredientId?: string;
+  holderPath: string;
+  boardPath: string;
+  nozzlePath: string;
+  childPump: boolean;
+  virtual?: boolean;
+  name: string;
+  path: string;
+  prevIngredientId?: string;
+  [key: keyof AdditionalData]: AdditionalData[key];
+}
+
+interface IntentResponse {
+  tracker: string;
+  id: string;
+}
+
+/**
+ * @category Model
+ */
+export interface PumpModel<AdditionalData extends object = any>
+  extends IKosDataModel,
+    IntentAware,
+    AdditionalData,
+    TroubleAware {
+  id: string;
+  inserted: boolean;
+  type: string;
+  virtual?: boolean;
+  childPump: boolean;
+  future?: IFutureModel;
+  ingredientId?: string;
+  holderPath: string;
+  boardPath: string;
+  nozzlePath: string;
+  name: string;
+  path: string;
+  prevIngredientId?: string;
+  [key: keyof AdditionalData]: AdditionalData[key];
+  isPouring: boolean;
+  canPour: boolean;
+  readonly pouringState: string;
+  updateModel(options: PumpOptions): void;
+  resolveIntentVolume(intent: string): Promise<{ volume: number }>;
+}

package/models/models/pump/utils/pump-trouble-resolver.d.ts

@@ -0,0 +1,8 @@
+import { TroubleModel } from '@kosdev-code/kos-ui-sdk';
+
+export interface PumpTroubleData {
+    pumpPath: string;
+}
+export declare const getPumpRelatedPaths: (pumpPath: string) => Promise<string[]>;
+export declare const pumpTroubleResolver: (trouble: TroubleModel<PumpTroubleData>) => Promise<string[]>;
+//# sourceMappingURL=pump-trouble-resolver.d.ts.map

package/models/models/pump/utils/pump-trouble-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pump-trouble-resolver.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/pump/utils/pump-trouble-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,eAAO,MAAM,mBAAmB,aAAoB,MAAM,sBASzD,CAAC;AAEF,eAAO,MAAM,mBAAmB,YACrB,aAAa,eAAe,CAAC,sBAOvC,CAAC"}

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

@@ -0,0 +1,3 @@
+export { PumpContainer, PumpIndex } from './pump-container-model';
+export type * from './types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/pump-container/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAClE,mBAAmB,SAAS,CAAC"}

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

@@ -0,0 +1,85 @@
+import { PumpContainerModel, PumpContainerOptions } from './types';
+import { SingletonKosModelRegistrationBean } from '@kosdev-code/kos-ui-sdk';
+
+export declare enum PumpIndex {
+    byBoard = "byBoard",
+    byType = "byType",
+    byNozzle = "byNozzle"
+}
+/**
+ * # PumpContainer
+ *
+ * The registration bean includes convenience methods for creating and working with PumpContainerModel 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: PumpContainer.type})
+ * private holderContainerModel: PumpContainerModel;
+ * ```
+ *
+ *
+ * ## factory
+ *
+ * The factory function that can be used to create new PumpContainerModel 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 = PumpContainer.factory({ });
+ * ```
+ *
+ * ## 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 PumpContainerModel.
+ *
+ * @example
+ * ```typescript
+ *
+ * const model: IKosDataModel = ...; // some model
+ *
+ * if (PumpContainer.predicate(model)) {
+ *    // if the function evaluates to true, the model is narrowed down to PumpContainerModel
+ *    // and the compiler will know that the model has the PumpContainerModel 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 { PumpContainer } from "@kosdev-code/kos-dispense-sdk";
+ * ...
+ * import { IKosRegistry } from "@kosdev-code/kos-ui-sdk";
+ * export const kosModels: IKosRegistry["models"] = {
+ *  ...PumpContainer.registration,
+ * };
+ * ```
+ *
+ * ## registration.singleton
+ * The PumpContainer model is a singleton.  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.
+ *
+ * * */
+export declare const PumpContainer: SingletonKosModelRegistrationBean<PumpContainerModel, PumpContainerOptions>;
+//# sourceMappingURL=pump-container-model.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pump-container-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/pump-container/pump-container-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,iCAAiC,EAClC,MAAM,yBAAyB,CAAC;AASjC,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAQxE,oBAAY,SAAS;IACnB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,QAAQ,aAAa;CACtB;AAiED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0EO;AACP,eAAO,MAAM,aAAa,EAAE,iCAAiC,CAC3D,kBAAkB,EAClB,oBAAoB,CAarB,CAAC"}

package/models/models/pump-container/types/index.d.ts

@@ -0,0 +1,31 @@
+import { PumpModel } from '../../pump/types';
+import { IKosDataModel, IKosModelContainer, IKosModelHolder } from '@kosdev-code/kos-ui-sdk';
+
+
+export interface PumpContainerOptions {}
+
+/**
+ * Represents a collection of holders for the dispenser or a specific assembly.
+ *
+ * Provides default indexing to allow for grouping of holders by nozzle.
+ *
+ *
+ * @category Model
+ */
+export interface PumpContainerModel<T extends object = unknown>
+  extends IKosDataModel,
+    IKosModelHolder<PumpModel<T>> {
+  /** the unique identifier for the model */
+  id: string;
+
+  /** the collection of holder models  */
+  models: IKosModelContainer<PumpModel<T>>;
+  readonly pumpModels: PumpModel<T>[];
+
+  /**
+   * The collection of pump paths.
+   */
+  readonly pumpPaths: string[];
+  /** convenience method to update the holder container based on the options */
+  updateModel(options: PumpContainerOptions): void;
+}

package/models/models/types/assembly.d.ts

@@ -0,0 +1,83 @@
+export type AssemblyBoard<BoardExt extends object = {}> = {
+    [key in keyof BoardExt]: BoardExt[key];
+} & {
+    type: string;
+    name: string;
+    path: string;
+    linked: boolean;
+    instanceId?: string;
+};
+export interface HolderSlice {
+    pos: number;
+    maxVolMl?: number;
+    currentVolMl?: number;
+}
+export type AssemblyHolder<HolderExt extends object = {}> = {
+    [key in keyof HolderExt]: HolderExt[key];
+} & {
+    agitated: boolean;
+    name: string;
+    path: string;
+    ingType?: string;
+    ingSource?: string;
+    ingredientId?: string;
+    type?: string;
+    slice?: HolderSlice;
+    container?: {
+        enjoyByDate: number;
+    };
+};
+export type SubAssemblyPump<PumpExt extends object = {}> = Omit<AssemblyPump<PumpExt>, "pumps">;
+export type AssemblyPump<PumpExt extends object = {}> = {
+    [key in keyof PumpExt]: PumpExt[key];
+} & {
+    name: string;
+    path: string;
+    inserted: boolean;
+    childPump?: boolean;
+    virtual?: boolean;
+    pumps?: SubAssemblyPump<PumpExt>[];
+    type: string;
+    boardPath: string;
+    holderPath: string;
+    ingredientId?: string;
+    prevIngredientId?: string;
+};
+interface AssemblyPipeline {
+    name: string;
+    topicPrefix: string;
+    path: string;
+}
+export type AssemblyNozzle<NozzleExt extends object = {}, PumpExt extends object = {}> = {
+    [key in keyof NozzleExt]: NozzleExt[key];
+} & {
+    name: string;
+    path: string;
+    urlPrefix: string;
+    topicPrefix: string;
+    pumps: AssemblyPump<PumpExt>[];
+    pipelines: AssemblyPipeline[];
+};
+export type Assembly<AssemblyExt extends object = any, NozzleExt extends object = any, HolderExt extends object = any, BoardExt extends object = any, PumpExt extends object = any> = {
+    [key in keyof AssemblyExt]: AssemblyExt[key];
+} & {
+    boards: AssemblyBoard<BoardExt>[];
+    holders: Record<string, AssemblyHolder<HolderExt>[]>;
+    nozzles: AssemblyNozzle<NozzleExt, PumpExt>[];
+    core: boolean;
+    name: string;
+    path: string;
+};
+export interface BaseAssemblyResponse<AssemblyExt extends object = any, NozzleExt extends object = any, HolderExt extends object = any, BoardExt extends object = any, PumpExt extends object = any> {
+    assemblies: Assembly<AssemblyExt, NozzleExt, HolderExt, BoardExt, PumpExt>[];
+}
+interface AssemblyResponseKeys {
+    AssemblyExt: object;
+    NozzleExt: object;
+    HolderExt: object;
+    BoardExt: object;
+    PumpExt: object;
+}
+export type AssemblyResponse<T extends Partial<AssemblyResponseKeys>> = BaseAssemblyResponse<T["AssemblyExt"] extends object ? T["AssemblyExt"] : any, T["NozzleExt"] extends object ? T["NozzleExt"] : any, T["HolderExt"] extends object ? T["HolderExt"] : any, T["BoardExt"] extends object ? T["BoardExt"] : any, T["PumpExt"] extends object ? T["PumpExt"] : any>;
+export {};
+//# sourceMappingURL=assembly.d.ts.map

package/models/models/types/assembly.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assembly.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/types/assembly.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,CAAC,QAAQ,SAAS,MAAM,GAAG,EAAE,IAAI;KACvD,GAAG,IAAI,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC;CACvC,GAAG;IACF,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AACD,MAAM,MAAM,cAAc,CAAC,SAAS,SAAS,MAAM,GAAG,EAAE,IAAI;KACzD,GAAG,IAAI,MAAM,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC;CACzC,GAAG;IACF,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,SAAS,CAAC,EAAE;QACV,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;CACH,CAAC;AACF,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,MAAM,GAAG,EAAE,IAAI,IAAI,CAC7D,YAAY,CAAC,OAAO,CAAC,EACrB,OAAO,CACR,CAAC;AACF,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,MAAM,GAAG,EAAE,IAAI;KACrD,GAAG,IAAI,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC;CACrC,GAAG;IACF,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,UAAU,gBAAgB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd;AACD,MAAM,MAAM,cAAc,CACxB,SAAS,SAAS,MAAM,GAAG,EAAE,EAC7B,OAAO,SAAS,MAAM,GAAG,EAAE,IACzB;KACD,GAAG,IAAI,MAAM,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC;CACzC,GAAG;IACF,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;IAC/B,SAAS,EAAE,gBAAgB,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,QAAQ,CAClB,WAAW,SAAS,MAAM,GAAG,GAAG,EAChC,SAAS,SAAS,MAAM,GAAG,GAAG,EAC9B,SAAS,SAAS,MAAM,GAAG,GAAG,EAC9B,QAAQ,SAAS,MAAM,GAAG,GAAG,EAC7B,OAAO,SAAS,MAAM,GAAG,GAAG,IAC1B;KACD,GAAG,IAAI,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC;CAC7C,GAAG;IACF,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;IAClC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACrD,OAAO,EAAE,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC;IAC9C,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AACF,MAAM,WAAW,oBAAoB,CACnC,WAAW,SAAS,MAAM,GAAG,GAAG,EAChC,SAAS,SAAS,MAAM,GAAG,GAAG,EAC9B,SAAS,SAAS,MAAM,GAAG,GAAG,EAC9B,QAAQ,SAAS,MAAM,GAAG,GAAG,EAC7B,OAAO,SAAS,MAAM,GAAG,GAAG;IAE5B,UAAU,EAAE,QAAQ,CAAC,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC;CAC9E;AAED,UAAU,oBAAoB;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,OAAO,CAAC,oBAAoB,CAAC,IAClE,oBAAoB,CAClB,CAAC,CAAC,aAAa,CAAC,SAAS,MAAM,GAAG,CAAC,CAAC,aAAa,CAAC,GAAG,GAAG,EACxD,CAAC,CAAC,WAAW,CAAC,SAAS,MAAM,GAAG,CAAC,CAAC,WAAW,CAAC,GAAG,GAAG,EACpD,CAAC,CAAC,WAAW,CAAC,SAAS,MAAM,GAAG,CAAC,CAAC,WAAW,CAAC,GAAG,GAAG,EACpD,CAAC,CAAC,UAAU,CAAC,SAAS,MAAM,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,GAAG,EAClD,CAAC,CAAC,SAAS,CAAC,SAAS,MAAM,GAAG,CAAC,CAAC,SAAS,CAAC,GAAG,GAAG,CACjD,CAAC"}

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

@@ -0,0 +1,4 @@
+export * as AssemblyTypes from './assembly';
+export * from './intent';
+export * from './pouring';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,YAAY,CAAC;AAC5C,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC"}

package/models/models/types/intent.d.ts

@@ -0,0 +1,19 @@
+import { IKosIdentifiable, FutureResponse } from '@kosdev-code/kos-ui-sdk';
+
+export interface IntentAwareProps {
+    intent: string;
+    pumpPath?: string;
+}
+/**
+ * Perform a named pour intent on the holder pump.
+ *
+ * @param props.intent The name of the intent to perform.
+ * @param props.pumpPath The path of the pump to perform the intent on.  If not specified, the first pump will be used.
+ */
+export interface IntentAware extends IKosIdentifiable {
+    canPour: boolean;
+    isPouring: boolean;
+    cancelPour: () => Promise<void>;
+    performIntent(props: IntentAwareProps | string): Promise<FutureResponse | undefined>;
+}
+//# sourceMappingURL=intent.d.ts.map

package/models/models/types/intent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"intent.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/types/intent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAY,SAAQ,gBAAgB;IACnD,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAChC,aAAa,CACX,KAAK,EAAE,gBAAgB,GAAG,MAAM,GAC/B,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;CACxC"}

package/models/models/types/pouring.d.ts

@@ -0,0 +1,9 @@
+export declare enum PourState {
+    IDLE = "IDLE",
+    POURING = "POURING",
+    POUR_STARTING = "POUR_STARTING",
+    POUR_CANCELING = "POUR_CANCELING",
+    POUR_CANCELED = "POUR_CANCELED",
+    POUR_COMPLETE = "POUR_COMPLETE"
+}
+//# sourceMappingURL=pouring.d.ts.map

package/models/models/types/pouring.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pouring.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/types/pouring.ts"],"names":[],"mappings":"AAAA,oBAAY,SAAS;IACnB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,aAAa,kBAAkB;IAC/B,cAAc,mBAAmB;IACjC,aAAa,kBAAkB;IAC/B,aAAa,kBAAkB;CAChC"}

package/models/utils/dispense-registration-manager.d.ts

@@ -0,0 +1,28 @@
+import { KosModelRegistry as CoreKosModelRegistration, RegistrationManager, RegistrationResult } from '@kosdev-code/kos-ui-sdk';
+
+export declare const registerDispenseModels: <R>(root: R) => () => {
+    preload: (type: string) => RegistrationResult<R>;
+    model: <T extends import('@kosdev-code/kos-ui-sdk').BaseKosModelRegistrationBean<any, any> | import('@kosdev-code/kos-ui-sdk').KosModelRegistrationType<any, any>>(registration: T, preload?: boolean | undefined) => RegistrationResult<R>;
+    companion: (parentType: string, companion: import('@kosdev-code/kos-ui-sdk').KosCompanionModelType<any>) => RegistrationResult<R>;
+    legacy: <T_1 extends import('@kosdev-code/kos-ui-sdk').IKosModelRegistration>(type: string, registration: T_1) => RegistrationResult<R>;
+};
+export type DispenseKosModelRegistration<R> = typeof CoreKosModelRegistration & {
+    dispense: {
+        models: () => RegistrationResult<R>;
+    };
+    preload: ReturnType<typeof RegistrationManager.model.preloadModel>;
+    model: ReturnType<typeof RegistrationManager.model.register>;
+    companion: ReturnType<typeof RegistrationManager.companion.register>;
+};
+declare const _KosModelRegistry: {
+    core: {
+        models: () => RegistrationResult<{}>;
+    };
+    preload: (type: string) => RegistrationResult<unknown>;
+    model: <T extends import('@kosdev-code/kos-ui-sdk').BaseKosModelRegistrationBean<any, any> | import('@kosdev-code/kos-ui-sdk').KosModelRegistrationType<any, any>>(registration: T, preload?: boolean | undefined) => RegistrationResult<unknown>;
+    companion: (parentType: string, companion: import('@kosdev-code/kos-ui-sdk').KosCompanionModelType<any>) => RegistrationResult<unknown>;
+};
+type KosModelRegistryType = DispenseKosModelRegistration<typeof _KosModelRegistry>;
+declare const KosModelRegistry: KosModelRegistryType;
+export { KosModelRegistry };
+//# sourceMappingURL=dispense-registration-manager.d.ts.map

package/models/utils/dispense-registration-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dispense-registration-manager.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-dispense-sdk/src/models/utils/dispense-registration-manager.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,IAAI,wBAAwB,EAG5C,mBAAmB,EAInB,KAAK,kBAAkB,EAExB,MAAM,yBAAyB,CAAC;AAOjC,eAAO,MAAM,sBAAsB,YACvB,CAAC;;;;;CAuCV,CAAC;AAEJ,MAAM,MAAM,4BAA4B,CAAC,CAAC,IACxC,OAAO,wBAAwB,GAAG;IAChC,QAAQ,EAAE;QAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC,CAAC,CAAC,CAAA;KAAE,CAAC;IAClD,OAAO,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACnE,KAAK,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC7D,SAAS,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;CACtE,CAAC;AAEJ,QAAA,MAAM,iBAAiB;;;;;;;CAEtB,CAAC;AAcF,KAAK,oBAAoB,GAAG,4BAA4B,CACtD,OAAO,iBAAiB,CACzB,CAAC;AAEF,QAAA,MAAM,gBAAgB,EAAE,oBAA+C,CAAC;AAExE,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/models/utils/extension-utils.d.ts

@@ -0,0 +1,266 @@
+import { SelectedPourable } from '../models/nozzle/types';
+import { BeverageResponse } from '../models/nozzle/services';
+import { IngredientResponse } from '../models/ingredient/services';
+import { HolderModel } from '../models/holder/types';
+import { HolderResponse } from '../models/holder/services';
+import { AssemblyTypes, AssemblyModel } from '../models';
+import { CoreExtensionManager, DataLoader, DataMapper, IndexExtension, PropertyMapper, FlagResolver } from '@kosdev-code/kos-ui-sdk';
+
+export type IngredientDataMapper<AdditionalData extends object = Record<string, any>> = DataMapper<IngredientResponse, AdditionalData, any>;
+/**
+ * Mapping function that maps an ingredient response into the type property of
+ * the {@link IngredientModel}.
+ */
+export type IngredientTypeMapper<T extends IngredientResponse = IngredientResponse> = PropertyMapper<T, string>;
+/**
+ * Mapping function that maps additional data from holder service response
+ * into the {@link HolderModel} data.
+ */
+export type HolderTypeMapper<T extends HolderResponse = HolderResponse> = PropertyMapper<T, string>;
+/**
+ * Mapping function that maps additional data from holder service response
+ * into the {@link HolderModel} data.
+ */
+export type HolderDataMapper<AdditionalData extends object = Record<string, any>, HolderData extends HolderResponse = HolderResponse> = DataMapper<HolderData, AdditionalData, any>;
+export type GroupBeverageResponse = BeverageResponse & {
+    groupId: string;
+};
+export type AvailabilityDataMapper<AdditionalData extends object = Record<string, any>, AvailabilityData extends GroupBeverageResponse = GroupBeverageResponse> = DataMapper<AvailabilityData, AdditionalData, any>;
+export type SelectedPourableMapper = DataMapper<SelectedPourable, any>;
+export type BoardDataMapper<AdditionalData extends object = Record<string, any>, BoardData extends AssemblyTypes.AssemblyBoard<any> = AssemblyTypes.AssemblyBoard<any>> = DataMapper<BoardData, AdditionalData, any>;
+export type AssemblyMapper<AdditionalData extends object = Record<string, any>, AssemblyResponseData extends AssemblyTypes.AssemblyResponse<any> = AssemblyTypes.AssemblyResponse<any>> = DataMapper<AssemblyResponseData, AdditionalData, any>;
+/**
+ * The DispenseExtensionManager is responsible for managing the extension points that are specific to the Dispense application.
+ */
+export declare class DispenseExtensionManager {
+    core: CoreExtensionManager;
+    /**
+     * Maps data into the {@link IngredientModel}
+     *
+     * It is common for the ingredient data provided by the ingredient service to be augmented with additional properties that are
+     * not provided by the base KOS Ingredient model. The {@link IngredientMapper} extension point allows for the data to be mapped
+     * into the {@link IngredientModel} and the {@link IngredientModel.data} property to be augmented with additional properties.
+     *
+     * @example
+     * The following example shows how to map the data from the service response into the {@link IngredientModel}.
+     * The context is provided by the {@link IngredientLoader} extension point with its data being used to optionally augment the
+     * ingredient data.
+     *
+     * The result of the mapping will be available in the `data` property of the {@link IngredientModel}.
+     *
+     * In this case the `IngedientReponseData` interface represents the data being returned by the ingredient service and the
+     * `IngredientData` interface represents the data that will be available in the {@link IngredientModel.data} property.  The `ingredientDataMapper`
+     * is responsible for mapping from one format to the other.
+     *
+     * ```typescript
+     *
+     * interface IngredientResponseData extends NozzleServices.IngredientResponse {
+     *   chilled: boolean;
+     *   carbonated: boolean;
+     *   highYield: boolean;
+     * }
+     *
+     * interface IngredientData {
+     *   chilled: boolean;
+     *   carbonated: boolean;
+     *   highYield: boolean;
+     * }
+     *
+     * export const ingredientDataMapper = async (
+     * data: IngredientResponseData,
+     * context: IngredientContext
+     * ): Promise<IngredientData> => {
+     *  return {
+     *    chilled: data.chilled,
+     *    carbonated: data.carbonated,
+     *    highYield: data.highYield,
+     *  }
+     * }
+     * ```
+     * */
+    registerIngredientDataMapper(ingredientDataMapper: IngredientDataMapper): this;
+    /**
+     * Loads data that will be provided as context into the {@link IngredientMapper}
+     *
+     * @example
+     * The following example shows how to load the brandset data, normalize it into a map and then provide it back to the framework
+     * where it can be used by the other extension points.
+     *
+     * In the ingredient container model, the data is provided to the {@link IngredientMapper} extension point in order to augment ingredient data
+     * and also loaded into the ingredient container model context in order to make the data available throughout the code.
+     *
+     * ```typescript
+     *  export const ingredientContextLoader = async (): Promise<BeverageContext> => {
+     *  const response = await kosFetch('kos:/system/some/ingredient/endpoint.json');
+     *
+     *   if (response.status !== 200) {
+     *     KosLog.error('Failed to load ingredient data');
+     *       return {};
+     *   }
+     *  const json = await response.json();
+     *  return json;
+     *  };
+     * ```
+     * */
+    registerIngredientLoader(ingredientLoader: DataLoader): this;
+    registerIngredientIndex(ingredientIndex: IndexExtension): this;
+    /**
+     * Registers a data mapper for the {@link IngredientModel}
+     * */
+    registerIngredientTypeMapper(ingredientTypeMapper: IngredientTypeMapper): this;
+    /**
+     * Registers a data mapper for the {@link HolderModel} model.
+     * @param holderDataMapper - Mapping function that maps additional data from holder service response
+     * @returns
+     */
+    registerHolderDataMapper(holderDataMapper: HolderDataMapper): this;
+    registerHolderTypeMapper(holderTypeMapper: HolderTypeMapper): this;
+    /**
+     * Maps the ingredientId property of the holder into the {@link HolderModel}.
+     * If not provided, the ingredientId will assume that the value is mapped from the
+     * ingredientId property of the service response.
+     * */
+    registerHolderIngredientMapper(holderTypeMapper: HolderTypeMapper): this;
+    registerHolderIndex<T extends HolderModel = HolderModel>(holderIndex: IndexExtension<T>): this;
+    /**
+     * Maps data into the {@link AvailabilityModel}
+     *
+     * @example
+     * The following example shows how to map the data from the service response into the {@link AvailabilityModel}.
+     * The context is provided by the {@link AvailabilityLoader} extension point with its data being used to augment the
+     * availability data.
+     *
+     * The result of the mapping will be available in the `data` property of the {@link AvailabilityModel}.
+     *
+     * ```typescript
+     * export const beverageDataMapper = async (
+     * data: NozzleServices.BeverageResponse,
+     * context: BeverageContext
+     * ): Promise<BeverageData> => {
+     *  const id = data.altId;
+     *  const iconUrl = encodeURI(
+     *    `http://localhost:8081/system/brandset/${context?.[id]?.icon}`
+     *  );
+     *  const cuiColorCode = context?.[id]?.cuiColorCode
+     *    ? context?.[id]?.cuiColorCode
+     *    : '';
+     *  return { iconUrl, cuiColorCode };
+     * };
+     * ```
+     * */
+    registerAvailabilityDataMapper(availabilityMapper: AvailabilityDataMapper): this;
+    /**
+     * Loads data that will be provided as context into the {@link AvailabilityMapper}
+     *
+     * @example
+     * A common use case is to load brandset data that is UI specific and not provided directly by the Java service.
+     *
+     * The following example shows how to load the brandset data, normalize it into a map and then provide it back to the framework
+     * where it can be used by the other extension points.
+     *
+     * In the nozzle model, the data is provided to the {@link AvailabilityMapper} extension point in order to augment availability data
+     * and also loaded into the nozzle model context in order to make the data available throughout the code.
+     *
+     * ```typescript
+     *  export const beverageContextLoader = async (): Promise<BeverageContext> => {
+     *  const response = await kosFetch('kos:/system/brandset/brandset.json');
+     *
+     *   if (response.status !== 200) {
+     *     KosLog.error('Failed to load beverage data');
+     *       return {};
+     *   }
+     *   const json: BrandsetResponse | null = await response.json();
+     *   const initialBeverages: Record<string, BrandsetIngredient> = {};
+     *   const beverages = json?.ingredients?.reduce((acc, beverage) => {
+     *     acc[beverage.ingredientId] = beverage;
+     *     return acc;
+     *   }, initialBeverages);
+     *  return beverages;
+     *  };
+     * ```
+     * */
+    registerAvailabilityLoader(availabilityLoader: DataLoader): this;
+    /**
+     * Maps the abstract {@link SelectedPourable} data into a format that is specific to the nozzle.
+     * */
+    registerSelectedPourableDataMapper(selectedPourableMapper: SelectedPourableMapper): this;
+    /**
+     * Maps data into the {@link AssemblyModel} data.
+     * Used in cases where the base assembly has been extended with additional properties in the backend.  This extension
+     * point allows for the data to be mapped into the {@link AssemblyModel} and augmented with additional properties.
+     *
+     * @example
+     *
+     * In this example of an implementation of a {@link AssemblyMapper}, the {@link AssemblyResponse} data is mapped into
+     * a {@link FreestyleAssembly} object.
+     *
+     * The {@link FreestyleAssemblyResponse} interface represents the additional data being returned by the assembly service and is
+     * merged into the {@link AssemblyResponse} interface.
+     *
+     * The {@link FreestyleAssembly} interface represents the additional data, beyond the base data set, that will be merged into the {@link AssemblyModel}.
+     *
+     * The mapper is responsible for mapping from the {@link FreestyleAssemblyResponse} format to the {@link FreestyleAssembly} format.
+     * ```typescript
+     *  import { AssemblyTypes } from "@kosdev-code/kos-dispense-sdk";
+     *  import { DataMapper } from "@kosdev-code/kos-ui-sdk";
+     *
+     *  // define the additional data being returned by the assembly service
+     *  export interface FreestyleAssemblyResponse {
+     *    iceAgitator?: {
+     *      name: "iceAgitator";
+     *      path: string;
+     *    };
+     *  }
+     *
+     *  // define the additional data structure that will be merged into the assembly model
+     *  export interface FreestyleAssembly {
+     *    iceAgitator: {
+     *      path: string;
+     *    };
+     *    carbAgitator: {
+     *      path: string;
+     *    };
+     *  }
+     *
+     *
+     *  // define the mapper that will map the data from the service response into the additional data structure
+     *  // that will be merged into the assembly model.
+     *  // In this case the mapper is responsible for mapping from the {@link FreestyleAssemblyResponse} format to the {@link FreestyleAssembly} format.
+     *  export const assemblyDataMapper: DataMapper<
+     *    AssemblyTypes.AssemblyResponse<FreestyleAssemblyResponse>,
+     *    FreestyleAssembly
+     *    > = async (data) => {
+     *    const response = data.assemblies.reduce((acc, assembly) => {
+     *      const agitatorKeys = ["iceAgitator", "carbAgitator"];
+     *      agitatorKeys.forEach((key) => {
+     *        const agitator = assembly[key];
+     *        if (agitator) {
+     *          acc[key] = agitator;
+     *        }
+     *      });
+     *
+     *      return acc;
+     *    }, {} as FreestyleAssembly);
+     *    return response;
+     *  };
+     *```
+     */
+    registerAssemblyDataMapper(assemblyDataMapper: AssemblyMapper): this;
+    registerBoardIndex(boardIndex: IndexExtension): this;
+    registerBoardDataMapper(boardDataMapper: BoardDataMapper<any, any>): this;
+    registerAssemblyFeatureFlagResolver(assemblyFeatureFlagResolver: FlagResolver<AssemblyModel>): this;
+}
+/**
+ * The KosExtensionManager provides access to the extension points that are provided in the SDK for Dispense applications.
+ *
+ * The extension points are divided into two categories:
+ *
+ * @param core - The core extension {@link CoreExtensionManager}  points are used to extend the base models that are provided by the SDK.
+ * @param dispense -  The dispense extension {@link DispenseExtensionManager} points are used to extend the models that are specific to the Dispense SDK.
+ */
+export declare class KosExtensionManager {
+    dispense: DispenseExtensionManager;
+    core: CoreExtensionManager;
+    constructor();
+}
+//# sourceMappingURL=extension-utils.d.ts.map

package/models/utils/extension-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extension-utils.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-dispense-sdk/src/models/utils/extension-utils.ts"],"names":[],"mappings":"AACA,OAAO,EACL,oBAAoB,EACpB,UAAU,EACV,UAAU,EAGV,cAAc,EACd,cAAc,EACd,KAAK,YAAY,EAClB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,aAAa,EAAE,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AAC9D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE/D,MAAM,MAAM,oBAAoB,CAC9B,cAAc,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IACjD,UAAU,CAAC,kBAAkB,EAAE,cAAc,EAAE,GAAG,CAAC,CAAC;AAExD;;;GAGG;AACH,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IAC/C,cAAc,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAE9B;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,IACpE,cAAc,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAE5B;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAC1B,cAAc,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACnD,UAAU,SAAS,cAAc,GAAG,cAAc,IAChD,UAAU,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,CAAC,CAAC;AAEhD,MAAM,MAAM,qBAAqB,GAAG,gBAAgB,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAC3E,MAAM,MAAM,sBAAsB,CAChC,cAAc,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACnD,gBAAgB,SAAS,qBAAqB,GAAG,qBAAqB,IACpE,UAAU,CAAC,gBAAgB,EAAE,cAAc,EAAE,GAAG,CAAC,CAAC;AAEtD,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;AAEvE,MAAM,MAAM,eAAe,CACzB,cAAc,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACnD,SAAS,SAAS,aAAa,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,aAAa,CAAC,GAAG,CAAC,IACnF,UAAU,CAAC,SAAS,EAAE,cAAc,EAAE,GAAG,CAAC,CAAC;AAE/C,MAAM,MAAM,cAAc,CACxB,cAAc,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACnD,oBAAoB,SAAS,aAAa,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,gBAAgB,CAAC,GAAG,CAAC,IACpG,UAAU,CAAC,oBAAoB,EAAE,cAAc,EAAE,GAAG,CAAC,CAAC;AAC1D;;GAEG;AACH,qBAAa,wBAAwB;IACnC,IAAI,EAAE,oBAAoB,CAA8B;IACxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SA2CK;IACL,4BAA4B,CAAC,oBAAoB,EAAE,oBAAoB;IASvE;;;;;;;;;;;;;;;;;;;;;;SAsBK;IACL,wBAAwB,CAAC,gBAAgB,EAAE,UAAU;IAQrD,uBAAuB,CAAC,eAAe,EAAE,cAAc;IAQvD;;SAEK;IACL,4BAA4B,CAAC,oBAAoB,EAAE,oBAAoB;IAQvE;;;;OAIG;IACH,wBAAwB,CAAC,gBAAgB,EAAE,gBAAgB;IAQ3D,wBAAwB,CAAC,gBAAgB,EAAE,gBAAgB;IAQ3D;;;;SAIK;IACL,8BAA8B,CAAC,gBAAgB,EAAE,gBAAgB;IAQjE,mBAAmB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,EACrD,WAAW,EAAE,cAAc,CAAC,CAAC,CAAC;IAShC;;;;;;;;;;;;;;;;;;;;;;;;;SAyBK;IACL,8BAA8B,CAAC,kBAAkB,EAAE,sBAAsB;IAQzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SA6BK;IACL,0BAA0B,CAAC,kBAAkB,EAAE,UAAU;IAQzD;;SAEK;IACL,kCAAkC,CAChC,sBAAsB,EAAE,sBAAsB;IAShD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4DG;IACH,0BAA0B,CAAC,kBAAkB,EAAE,cAAc;IAQ7D,kBAAkB,CAAC,UAAU,EAAE,cAAc;IAQ7C,uBAAuB,CAAC,eAAe,EAAE,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC;IAQlE,mCAAmC,CACjC,2BAA2B,EAAE,YAAY,CAAC,aAAa,CAAC;CAQ3D;AAED;;;;;;;GAOG;AACH,qBAAa,mBAAmB;IAC9B,QAAQ,EAAE,wBAAwB,CAAC;IACnC,IAAI,EAAE,oBAAoB,CAAC;;CAK5B"}