@kosdev-code/kos-dispense-sdk 0.1.0-next.970 → 0.1.0-next.975

package/models/models/cui-kit-state/types/index.d.ts

@@ -0,0 +1,68 @@
+import { FutureEndState } from '@kosdev-code/kos-ui-sdk';
+import { PourStrategy } from '../../../../ui/hooks/utils/pour-strategy/pour-strategy';
+import { AvailabilityModel } from '../../availability/types';
+import { PourStrategyAware } from '../../nozzle/types';
+import { PourContext } from '../../../utils/pour-context';
+/** A screen of the CUI Kit's selection flow. */
+export type CuiKitGroup = "brands" | "beverages" | "flavors" | "pour";
+
+/**
+ * The steps a CUI Kit shows. `beverages` is always on; the rest are opt-in. Turning a
+ * step off removes its screen, not its data: `flavors` stays selectable on another
+ * screen when its step is off.
+ */
+export interface CuiKitSteps {
+  brands?: boolean;
+  flavors?: boolean;
+  pour?: boolean;
+}
+
+export interface CuiKitStateOptions {
+  /** Path of the nozzle the kit drives. */
+  nozzlePath: string;
+  /**
+   * Where navigation starts when `steps` is not set.
+   * @deprecated Use `steps.brands`.
+   */
+  initialGroup?: "brands" | "beverages";
+  /** The steps to show. Without it the kit keeps its original brand → beverage → flavor flow. */
+  steps?: CuiKitSteps;
+  /** Pour defaults for every pour the kit starts. */
+  pour?: {
+    /** Gesture strategy for pours that do not name one. */
+    strategy?: PourStrategy;
+  };
+  /**
+   * Called when a pour ends on its own (a fixed or automated pour finishing, or a pour
+   * failing) rather than being cancelled. A hold-to-pour release never calls it.
+   */
+  onPourComplete?: (result: CuiPourResult) => void;
+  /** Companion model types created alongside the brand, beverage and flavor availability models. */
+  companionTypes?: {
+    brand?: string;
+    beverage?: string;
+    flavor?: string;
+  };
+}
+
+/** Options for a single pour. */
+export interface CuiPourOptions {
+  /** A beverage to select (with its brand) before pouring; waits until the nozzle has it. */
+  select?: AvailabilityModel;
+  /** Runs after selecting and before the before-pour gate. */
+  prepare?: (context: PourContext) => Promise<void> | void;
+  /** What to pour on, e.g. a GenericPour. Default: the nozzle. */
+  target?: PourStrategyAware;
+  /** Gesture strategy for this pour. Default: the kit's `pour.strategy`. */
+  strategy?: PourStrategy;
+  /** Pours the nozzle's named fixed volume instead of using the strategy. */
+  fixedPourName?: string;
+}
+
+/** How a pour ended, passed to `onPourComplete`. */
+export interface CuiPourResult {
+  /** End state of the pour's future, when it reached one. */
+  endState?: FutureEndState;
+  /** The error when starting the pour failed. */
+  error?: unknown;
+}

package/models/models/index.d.ts

@@ -1,6 +1,7 @@
 export * from './assembly';
 export * from './availability';
 export * from './board';
+export * from './cui-kit-state';
 export * from './device-assembly';
 export * from './generic-pour';
 export * from './holder';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-dispense-sdk/src/models/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC;AACxB,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC;AACvC,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,kBAAkB,CAAC;AACjC,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-dispense-sdk/src/models/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC;AACvC,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,kBAAkB,CAAC;AACjC,cAAc,SAAS,CAAC"}

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

@@ -5,10 +5,23 @@ export declare const registerDispenseModels: <R>(root: R) => () => {
     companion: (parentType: string, companion: import('@kosdev-code/kos-ui-sdk').KosCompanionModelType<any>) => RegistrationResult<R>;
     legacy: <T extends import('@kosdev-code/kos-ui-sdk').IKosModelRegistration>(type: string, registration: T) => RegistrationResult<R>;
 };
+/**
+ * Registers the CUI Kit's models together with the dispense models they depend on. The
+ * name a Consumer UI's registration chain uses; `dispense.models()` registers the same.
+ */
+export declare const registerCuiKitModels: <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) => RegistrationResult<R>;
+    companion: (parentType: string, companion: import('@kosdev-code/kos-ui-sdk').KosCompanionModelType<any>) => RegistrationResult<R>;
+    legacy: <T extends import('@kosdev-code/kos-ui-sdk').IKosModelRegistration>(type: string, registration: T) => RegistrationResult<R>;
+};
 export type DispenseKosModelRegistration<R> = typeof CoreKosModelRegistration & {
     dispense: {
         models: () => RegistrationResult<R>;
     };
+    cuiKit: {
+        models: () => RegistrationResult<R>;
+    };
     preload: ReturnType<typeof RegistrationManager.model.preloadModel>;
     model: ReturnType<typeof RegistrationManager.model.register>;
     companion: ReturnType<typeof RegistrationManager.companion.register>;

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

@@ -1 +1 @@
-{"version":3,"file":"dispense-registration-manager.d.ts","sourceRoot":"","sources":["../../../../../packages/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,GAChC,CAAC,EAAE,MAAM,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"}
+{"version":3,"file":"dispense-registration-manager.d.ts","sourceRoot":"","sources":["../../../../../packages/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;AAQjC,eAAO,MAAM,sBAAsB,GAChC,CAAC,EAAE,MAAM,CAAC;;;;;CAwCV,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,oBAAoB,GAC9B,CAAC,EAAE,MAAM,CAAC;;;;;CAEqB,CAAC;AAEnC,MAAM,MAAM,4BAA4B,CAAC,CAAC,IACxC,OAAO,wBAAwB,GAAG;IAChC,QAAQ,EAAE;QAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC,CAAC,CAAC,CAAA;KAAE,CAAC;IAClD,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC,CAAC,CAAC,CAAA;KAAE,CAAC;IAChD,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;AAiBF,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/pour-context.d.ts

@@ -0,0 +1,8 @@
+export declare class PourContext {
+    private _data;
+    get<T>(key: string): T | undefined;
+    set<T>(key: string, value: T): void;
+    remove(key: string): void;
+    has(key: string): boolean;
+}
+//# sourceMappingURL=pour-context.d.ts.map

package/models/utils/pour-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pour-context.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-dispense-sdk/src/models/utils/pour-context.ts"],"names":[],"mappings":"AAAA,qBAAa,WAAW;IACtB,OAAO,CAAC,KAAK,CAA0B;IAEvC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAGlC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAG5B,MAAM,CAAC,GAAG,EAAE,MAAM;IAGlB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;CAG1B"}

package/models.cjs

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const dispenseRegistrationManager = require("./dispense-registration-manager-Dtb31fcI.cjs");
-const extensionUtils = require("./extension-utils-Cfhe358W.cjs");
+const dispenseRegistrationManager = require("./dispense-registration-manager-OYGAiIZy.cjs");
+const extensionUtils = require("./extension-utils-Pd5ntKtv.cjs");
 exports.Assembly = dispenseRegistrationManager.Assembly;
 exports.Availability = dispenseRegistrationManager.Availability;
 exports.Board = dispenseRegistrationManager.Board;
@@ -12,6 +12,7 @@ Object.defineProperty(exports, "BoardContainerModel", {
 });
 exports.CONTEXT_ASSEMBLY_DATA = dispenseRegistrationManager.CONTEXT_ASSEMBLY_DATA;
 exports.CONTEXT_ASSEMBLY_RAW_DATA = dispenseRegistrationManager.CONTEXT_ASSEMBLY_RAW_DATA;
+exports.CuiKitState = dispenseRegistrationManager.CuiKitState;
 exports.DeviceAssembly = dispenseRegistrationManager.DeviceAssembly;
 exports.DispenseModelType = dispenseRegistrationManager.DispenseModelType;
 exports.ExtensionType = dispenseRegistrationManager.ExtensionType;
@@ -32,6 +33,7 @@ exports.TOPIC_GENERIC_POUR_CANCEL = dispenseRegistrationManager.TOPIC_GENERIC_PO
 exports.TOPIC_GENERIC_POUR_PROGRESS = dispenseRegistrationManager.TOPIC_GENERIC_POUR_PROGRESS;
 exports.TOPIC_GENERIC_POUR_STARTED = dispenseRegistrationManager.TOPIC_GENERIC_POUR_STARTED;
 exports.kosModels = dispenseRegistrationManager.kosModels;
+exports.registerCuiKitModels = dispenseRegistrationManager.registerCuiKitModels;
 exports.registerDispenseModels = dispenseRegistrationManager.registerDispenseModels;
 exports.AssemblyServices = extensionUtils.index;
 exports.AssemblyTypes = extensionUtils.assembly;

package/models.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"models.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"models.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/models.js

@@ -1,5 +1,5 @@
-import { A, a, B, b, c, C, d, D, e, E, G, H, f, I, g, K, N, P, h, i, j, T, k, l, m, n, o, r } from "./dispense-registration-manager-Da9CW_cN.js";
-import { i as i2, a as a2, D as D2, b as b2, c as c2, d as d2, K as K2, e as e2, f as f2, g as g2 } from "./extension-utils-D_dnBLH6.js";
+import { A, a, B, b, c, C, d, e, D, f, E, G, H, g, I, h, K, N, i, j, k, l, T, m, n, o, p, q, r, s } from "./dispense-registration-manager-J59_vyyY.js";
+import { i as i2, a as a2, D as D2, b as b2, c as c2, d as d2, K as K2, e as e2, f as f2, g as g2 } from "./extension-utils-DEM1emOY.js";
 export {
   A as Assembly,
   i2 as AssemblyServices,
@@ -10,34 +10,36 @@ export {
   c as BoardContainerModel,
   C as CONTEXT_ASSEMBLY_DATA,
   d as CONTEXT_ASSEMBLY_RAW_DATA,
+  e as CuiKitState,
   D as DeviceAssembly,
   D2 as DispenseExtensionManager,
-  e as DispenseModelType,
+  f as DispenseModelType,
   E as ExtensionType,
   G as GenericPour,
   b2 as GenericPourServices,
   H as Holder,
-  f as HolderContainer,
+  g as HolderContainer,
   c2 as HolderServices,
   I as Ingredient,
-  g as IngredientContainer,
+  h as IngredientContainer,
   d2 as IngredientServices,
   K2 as KosExtensionManager,
   K as KosModelRegistry,
   N as Nozzle,
   e2 as NozzleServices,
-  P as PourState,
-  h as Pump,
-  i as PumpContainer,
-  j as PumpIndex,
+  i as PourState,
+  j as Pump,
+  k as PumpContainer,
+  l as PumpIndex,
   f2 as PumpServices,
   T as TOPIC_BOARD_LINKED,
-  k as TOPIC_BOARD_UNLINKED,
-  l as TOPIC_GENERIC_POUR_CANCEL,
-  m as TOPIC_GENERIC_POUR_PROGRESS,
-  n as TOPIC_GENERIC_POUR_STARTED,
+  m as TOPIC_BOARD_UNLINKED,
+  n as TOPIC_GENERIC_POUR_CANCEL,
+  o as TOPIC_GENERIC_POUR_PROGRESS,
+  p as TOPIC_GENERIC_POUR_STARTED,
   g2 as getFuelGaugeValue,
-  o as kosModels,
-  r as registerDispenseModels
+  q as kosModels,
+  r as registerCuiKitModels,
+  s as registerDispenseModels
 };
 //# sourceMappingURL=models.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kosdev-code/kos-dispense-sdk",
-  "version": "0.1.0-next.970",
+  "version": "0.1.0-next.975",
   "type": "module",
   "types": "./index.d.ts",
   "main": "./index.js",
@@ -35,18 +35,18 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@kosdev-code/kos-api-levels": "0.1.0-next.970",
-    "@kosdev-code/kos-ui-sdk": "0.1.0-next.970"
+    "@kosdev-code/kos-api-levels": "0.1.0-next.975",
+    "@kosdev-code/kos-ui-sdk": "0.1.0-next.975"
   },
   "peerDependencies": {
-    "@kosdev-code/kos-ui-plugin": "0.1.0-next.970"
+    "@kosdev-code/kos-ui-plugin": "0.1.0-next.975"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
   "kos": {
     "build": {
-      "gitHash": "d5940a35064adbc3194fd9eca2be1831bb8614c2"
+      "gitHash": "85fce80fc3b2a32e4a2d792999a4afeec0db2cb3"
     }
   }
 }