@kosdev-code/kos-dispense-sdk 0.1.0-dev.5873 → 0.1.0-next.1000

package/models/models/cui-kit-state/cui-kit-state-model.d.ts

@@ -0,0 +1,133 @@
+import { IKosDataModel, IKosIdentifiable, KosRegistrationFor, PublicModelInterface, KosLoggerAware } from '@kosdev-code/kos-ui-sdk';
+import { PourStrategy } from '../../../ui/hooks/utils/pour-strategy/pour-strategy';
+import { PourContext } from '../../utils/pour-context';
+import { AvailabilityModel } from '../availability/types';
+import { NozzleModel } from '../nozzle';
+import { PourStrategyAware } from '../nozzle/types';
+import { CuiKitGroup, CuiKitStateOptions, CuiKitSteps, CuiPourOptions, CuiPourResult } from './types';
+export declare const MODEL_TYPE = "cui-kit-state-model";
+/** @internal */
+export type CuiKitStateModel = PublicModelInterface<CuiKitStateModelImpl>;
+export interface CuiKitStateModelImpl extends KosLoggerAware {
+}
+export declare const MODEL_CONFIG: {
+    readonly modelTypeId: "cui-kit-state-model";
+    readonly singleton: false;
+};
+/** The model id of the CUI Kit driving the nozzle at `nozzlePath`. */
+export declare const cuiKitId: (nozzlePath: string) => string;
+/**
+ * The state behind a nozzle's CUI Kit: the step being shown, the selections, and the
+ * navigation between steps. `useCuiKit` exposes it to React; the lifecycle events
+ * (`/kos/dispense/{nozzlePath}/...`) are published from here.
+ *
+ * Without `steps`, navigation keeps the original flow: brand → beverage → flavor, with
+ * `back()` returning to the start. With `steps`, only the declared steps are shown and
+ * `back()` moves to the previous one.
+ *
+ * @kosService dispense.cui-kit-state
+ */
+export declare class CuiKitStateModelImpl implements IKosDataModel, IKosIdentifiable {
+    static Registration: KosRegistrationFor<typeof MODEL_CONFIG, CuiKitStateModel, CuiKitStateOptions>;
+    id: string;
+    nozzlePath: string;
+    initialGroup: "brands" | "beverages";
+    steps?: CuiKitSteps;
+    companionTypes: NonNullable<CuiKitStateOptions["companionTypes"]>;
+    currentGroup: CuiKitGroup;
+    selectedBrand: AvailabilityModel | null;
+    selectedBeverage: AvailabilityModel | null;
+    selectedFlavors: AvailabilityModel[];
+    pourStrategy?: PourStrategy;
+    onPourComplete?: (result: CuiPourResult) => void;
+    /** Data passed to the before-pour gate; carries `selectedBeverage`. */
+    pourContext: PourContext;
+    /** The target of the last pour the kit started. */
+    activeTarget?: PourStrategyAware;
+    private beforePour?;
+    private pressCount;
+    private released;
+    private lastPourState?;
+    private lastPourError?;
+    nozzle: NozzleModel;
+    constructor(modelId: string, options: CuiKitStateOptions);
+    updateModel(options: CuiKitStateOptions): void;
+    /** The steps shown, in order. */
+    get enabledSteps(): CuiKitGroup[];
+    /** The step navigation starts at and `home()` returns to. */
+    get firstGroup(): "brands" | "beverages";
+    /** The step `back()` moves to, or undefined when there is none. */
+    get previousGroup(): CuiKitGroup | undefined;
+    get canBack(): boolean;
+    get brands(): AvailabilityModel[];
+    /** Whether the kit shows a brands step; without `steps` it follows `initialGroup`. */
+    get hasBrands(): boolean;
+    get beverages(): AvailabilityModel[];
+    get flavors(): AvailabilityModel[];
+    get brandCompanions(): IKosDataModel[];
+    get beverageCompanions(): IKosDataModel[];
+    get flavorCompanions(): IKosDataModel[];
+    private companionsOf;
+    selectBrand(brand: AvailabilityModel, context?: Record<string, any>): void;
+    clearBrand(): void;
+    selectBeverage(beverage: AvailabilityModel, context?: Record<string, any>, forceUpdate?: boolean): Promise<void>;
+    clearBeverage(): Promise<void>;
+    /** Toggles a flavor and sends the beverage with the resulting flavors to the nozzle. */
+    selectFlavor(flavor: AvailabilityModel, context?: Record<string, any>, forceUpdate?: boolean): Promise<void>;
+    clearFlavors(): Promise<void>;
+    /** Moves to the previous step. Without `steps`, returns to the start and clears brand and beverage. */
+    back(): void;
+    /** Returns to the first step and clears the selections. */
+    home(): void;
+    /** Number of `useCuiKit` hooks attached to this kit. */
+    attached: number;
+    /**
+     * Attaches a `useCuiKit` hook. A nozzle has one kit hook; components read it through
+     * the kit's context. Returns false, and logs an error, for a second hook.
+     */
+    attach(): boolean;
+    detach(): void;
+    /**
+     * Returns the kit to the first step with nothing selected, as a newly mounted kit
+     * starts. The nozzle's own selection is left as it is.
+     */
+    reset(): void;
+    /**
+     * Moves to the pour step. Only available when `steps.pour` is on. With `start`, also
+     * starts a pour; ignored, with a warning, when the pour needs a held button.
+     */
+    toPour(options?: CuiPourOptions & {
+        start?: boolean;
+    }): void;
+    /** Sets the before-pour gate the kit calls before every pour. */
+    setBeforePour(callback?: (context?: PourContext) => Promise<boolean>): void;
+    /** Starts a pour without a gesture (a click-to-pour button or an automated pour). */
+    startPour(options?: CuiPourOptions): Promise<boolean>;
+    /** The press half of a pour gesture; `releasePour` is the release. */
+    pressPour(options?: CuiPourOptions): Promise<boolean>;
+    /** The release half of a pour gesture. */
+    releasePour(options?: CuiPourOptions): void;
+    /** Cancels the pour the kit started last. */
+    cancelPour(): Promise<void>;
+    /** The pour target whose state the kit reports: the last one poured, else the nozzle. */
+    get pourTarget(): PourStrategyAware | undefined;
+    private strategyFor;
+    /**
+     * select → prepare → before-pour gate → pour. While the target is pouring nothing is
+     * selected; for a gesture, a release before the pour starts stops the sequence.
+     */
+    private runPour;
+    /**
+     * Selects a beverage, and its brand first when the kit has a brands step, and waits
+     * for the nozzle.
+     */
+    private selectForPour;
+    /** Calls onPourComplete when the pour target returns to idle without being cancelled. */
+    trackPourCompletion(): void;
+    publishBeverageList(): void;
+    private publish;
+    init(): Promise<void>;
+}
+/** @internal */
+export declare const CuiKitState: import('@kosdev-code/kos-ui-sdk').KosModelRegistrationFactory<CuiKitStateModel, CuiKitStateOptions>;
+//# sourceMappingURL=cui-kit-state-model.d.ts.map

package/models/models/cui-kit-state/cui-kit-state-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cui-kit-state-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/cui-kit-state/cui-kit-state-model.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAML,cAAc,EAGf,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qDAAqD,CAAC;AACxF,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAU,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEzD,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EAClB,WAAW,EACX,cAAc,EACd,aAAa,EACd,MAAM,SAAS,CAAC;AAEjB,eAAO,MAAM,UAAU,wBAAwB,CAAC;AAEhD,gBAAgB;AAChB,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;AAI1E,MAAM,WAAW,oBAAqB,SAAQ,cAAc;CAAG;AAE/D,eAAO,MAAM,YAAY;;;CAGf,CAAC;AAEX,sEAAsE;AACtE,eAAO,MAAM,QAAQ,GAAI,YAAY,MAAM,WAA4B,CAAC;AAExE;;;;;;;;;;GAUG;AACH,qBAEa,oBAAqB,YAAW,aAAa,EAAE,gBAAgB;IAC1E,MAAM,CAAC,YAAY,EAAE,kBAAkB,CACrC,OAAO,YAAY,EACnB,gBAAgB,EAChB,kBAAkB,CACnB,CAAC;IAEF,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,QAAQ,GAAG,WAAW,CAAC;IACrC,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,cAAc,EAAE,WAAW,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAElE,YAAY,EAAE,WAAW,CAAC;IAC1B,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAAQ;IAC/C,gBAAgB,EAAE,iBAAiB,GAAG,IAAI,CAAQ;IAClD,eAAe,EAAE,iBAAiB,EAAE,CAAM;IAE1C,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,IAAI,CAAC;IACjD,uEAAuE;IACvE,WAAW,cAAqB;IAChC,mDAAmD;IACnD,YAAY,CAAC,EAAE,iBAAiB,CAAC;IACjC,OAAO,CAAC,UAAU,CAAC,CAA8C;IACjE,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,aAAa,CAAC,CAAY;IAClC,OAAO,CAAC,aAAa,CAAC,CAAU;IAMhC,MAAM,EAAG,WAAW,CAAC;gBAET,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB;IAgBxD,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI;IAM9C,iCAAiC;IACjC,IAAI,YAAY,IAAI,WAAW,EAAE,CAYhC;IAED,6DAA6D;IAC7D,IAAI,UAAU,IAAI,QAAQ,GAAG,WAAW,CAGvC;IAED,mEAAmE;IACnE,IAAI,aAAa,IAAI,WAAW,GAAG,SAAS,CAO3C;IAED,IAAI,OAAO,IAAI,OAAO,CAErB;IAID,IAAI,MAAM,IAAI,iBAAiB,EAAE,CAEhC;IAED,sFAAsF;IACtF,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED,IAAI,SAAS,IAAI,iBAAiB,EAAE,CASnC;IAED,IAAI,OAAO,IAAI,iBAAiB,EAAE,CAMjC;IAED,IAAI,eAAe,IAAI,aAAa,EAAE,CAErC;IAED,IAAI,kBAAkB,IAAI,aAAa,EAAE,CAExC;IAED,IAAI,gBAAgB,IAAI,aAAa,EAAE,CAEtC;IAED,OAAO,CAAC,YAAY;IAOpB,WAAW,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAOnE,UAAU;IAMJ,cAAc,CAClB,QAAQ,EAAE,iBAAiB,EAC3B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC7B,WAAW,CAAC,EAAE,OAAO,GACpB,OAAO,CAAC,IAAI,CAAC;IAUV,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAOpC,wFAAwF;IAClF,YAAY,CAChB,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC7B,WAAW,CAAC,EAAE,OAAO,GACpB,OAAO,CAAC,IAAI,CAAC;IAeV,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAWnC,uGAAuG;IACvG,IAAI;IAeJ,2DAA2D;IAC3D,IAAI;IAeJ,wDAAwD;IACxD,QAAQ,SAAK;IAEb;;;OAGG;IACH,MAAM,IAAI,OAAO;IAYjB,MAAM;IAIN;;;OAGG;IACH,KAAK;IAQL;;;OAGG;IACH,MAAM,CAAC,OAAO,GAAE,cAAc,GAAG;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO;IAkBzD,iEAAiE;IACjE,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,OAAO,CAAC;IAIpE,qFAAqF;IACrF,SAAS,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIzD,sEAAsE;IACtE,SAAS,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIzD,0CAA0C;IAC1C,WAAW,CAAC,OAAO,GAAE,cAAmB;IAWxC,6CAA6C;IACvC,UAAU;IAKhB,yFAAyF;IACzF,IAAI,UAAU,IAAI,iBAAiB,GAAG,SAAS,CAE9C;IAED,OAAO,CAAC,WAAW;IAInB;;;OAGG;YACW,OAAO;IA0CrB;;;OAGG;YACW,aAAa;IAY3B,yFAAyF;IAMzF,mBAAmB;IAsBnB,mBAAmB;IAInB,OAAO,CAAC,OAAO;IAMT,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B;AAED,gBAAgB;AAChB,eAAO,MAAM,WAAW,qGAAoC,CAAC"}

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

@@ -0,0 +1,4 @@
+export { CuiKitState } from './cui-kit-state-model';
+export type { CuiKitStateModel } from './cui-kit-state-model';
+export type * from './types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/cui-kit-state/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAGpD,YAAY,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,mBAAmB,SAAS,CAAC"}

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

@@ -0,0 +1,82 @@
+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.
+ * @internal
+ */
+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.
+ * @kosService dispense.cui-kit
+ * @kosApiLevel 17
+ */
+export interface CuiKitSteps {
+  brands?: boolean;
+  flavors?: boolean;
+  pour?: boolean;
+}
+
+/** @internal */
+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.
+ * @kosService dispense.cui-kit
+ * @kosApiLevel 17
+ */
+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`.
+ * @kosService dispense.cui-kit
+ * @kosApiLevel 17
+ */
+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/device-assembly/device-assembly-model.d.ts

@@ -1,8 +1,11 @@
-import { DeviceAssemblyOptions } from './types';
-import { NozzleModel } from '../nozzle';
 import { IKosDataModel, IKosIdentifiable, KosCreationContext, PublicModelInterface } from '@kosdev-code/kos-ui-sdk';
-
+import { NozzleModel } from '../nozzle';
+import { DeviceAssemblyOptions } from './types';
 export declare const MODEL_TYPE = "device-assembly-model";
+/**
+ * @kosService dispense.device-assembly
+ * @kosApiLevel 2
+ */
 export type DeviceAssemblyModel = PublicModelInterface<DeviceAssemblyModelImpl>;
 /**
  * @kosService dispense.device-assembly

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

@@ -1 +1 @@
-{"version":3,"file":"device-assembly-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/device-assembly/device-assembly-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAGhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAGjC,OAAO,EAAU,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAErD,eAAO,MAAM,UAAU,0BAA0B,CAAC;AAElD,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;AAEhF;;;GAGG;AACH,qBACa,uBACX,YAAW,aAAa,EAAE,gBAAgB;IAE1C,EAAE,EAAE,MAAM,CAAC;IACD,OAAO,CAAC,aAAa,CAAkC;IACjE,OAAO,CAAC,MAAM,CAAmB;gBAE/B,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,qBAAqB,EAC/B,OAAO,EAAE,kBAAkB;IASvB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAIhD,IAAI,WAAW,IAAI,MAAM,EAAE,CAE1B;IAEK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAwB5B"}
+{"version":3,"file":"device-assembly-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/device-assembly/device-assembly-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAGhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAGjC,OAAO,EAAU,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAErD,eAAO,MAAM,UAAU,0BAA0B,CAAC;AAElD;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;AAEhF;;;GAGG;AACH,qBACa,uBACX,YAAW,aAAa,EAAE,gBAAgB;IAE1C,EAAE,EAAE,MAAM,CAAC;IACD,OAAO,CAAC,aAAa,CAAkC;IACjE,OAAO,CAAC,MAAM,CAAmB;gBAE/B,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,qBAAqB,EAC/B,OAAO,EAAE,kBAAkB;IASvB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAIhD,IAAI,WAAW,IAAI,MAAM,EAAE,CAE1B;IAEK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAwB5B"}

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

@@ -1,89 +1,24 @@
-import { DeviceAssemblyOptions } from './types';
-import { DeviceAssemblyModel } from './device-assembly-model';
 import { SingletonKosModelRegistrationFactory } from '@kosdev-code/kos-ui-sdk';
-
+import { DeviceAssemblyModel } from './device-assembly-model';
+import { DeviceAssemblyOptions } from './types';
 /**
- * # DeviceAssembly
- *
- * The registration bean includes convenience methods for creating and working with DeviceAssemblyModel 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
+ * Registration bean for {@link DeviceAssemblyModel}.
  *
- * @kosDependency({modelType: DeviceAssembly.type, id: "deviceAssemblyId"})
- * private deviceAssemblyModel: DeviceAssemblyModel;
- * ```
- *
- *
- * ## factory
- *
- * The factory method creates a factory function that can be used to create new DeviceAssemblyModel instances.
- *
- 
- * As this is a singleton model, the factory function accepts the model options as its argument.
+ * - `type`: the model type, used by the model registry and in `@kosDependency` declarations.
+ * - `factory`: `DeviceAssembly.factory(options)` returns the single instance, creating it on the first call.
+ * - `guard`: type guard that narrows an `IKosDataModel` to `DeviceAssemblyModel`.
+ * - `instance()`: reads the model, or builds it from options.
+ * - `register()`: registers the model, and any related models, with the model registry.
  *
- * 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.
+ * DeviceAssembly is a singleton. `KosModelRegistry.dispense.models()` registers it.
  *
  * @example
  * ```typescript
- * const model = DeviceAssembly.factory({
- *   // Add option data
- * });
+ * @kosDependency({ modelType: DeviceAssembly.type })
+ * private deviceAssembly!: DeviceAssemblyModel;
  * ```
- 
-
- *
- * ## 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 DeviceAssemblyModel.
- *
- * @example
- * ```typescript
- *
- * const model: IKosDataModel = ...; // some model
- *
- * if (DeviceAssembly.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to DeviceAssemblyModel
- *    // and the compiler will know that the model has the DeviceAssemblyModel 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 { DeviceAssembly } 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(DeviceAssembly);
- * ```
- *
- * ## registration.singleton
- 
- * The deviceAssembly 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.
- 
- * */
+ * @kosService dispense.device-assembly
+ * @kosApiLevel 2
+ */
 export declare const DeviceAssembly: SingletonKosModelRegistrationFactory<DeviceAssemblyModel, DeviceAssemblyOptions>;
 //# sourceMappingURL=device-assembly-registration.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"device-assembly-registration.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/device-assembly/device-assembly-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oCAAoC,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAEnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAkFK;AACL,eAAO,MAAM,cAAc,kFAMzB,CAAC"}
+{"version":3,"file":"device-assembly-registration.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/device-assembly/device-assembly-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oCAAoC,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAEnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAErD;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,cAAc,kFAMzB,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/device-assembly/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,mBAAmB,SAAS,CAAC;AAC7B,YAAY,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/device-assembly/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,mBAAmB,SAAS,CAAC;AAC7B,YAAY,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC"}

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

@@ -1 +1,5 @@
+/**
+ * @kosService dispense.device-assembly
+ * @kosApiLevel 2
+ */
 export interface DeviceAssemblyOptions {}

package/models/models/generic-pour/generic-pour-model.d.ts

@@ -1,12 +1,27 @@
-import { GenericPourOptions } from './types';
-import { PourState } from '../types';
-import { PourStrategyAware } from '../nozzle/types';
 import { FutureContainer, IFutureModel, IKosDataModel, PublicModelInterface, KosData, KosFutureAwareFull, KosLoggerAware, KosStateMachineAware } from '@kosdev-code/kos-ui-sdk';
-
+import { PourStrategyAware } from '../nozzle/types';
+import { PourState } from '../types';
+import { GenericPourOptions } from './types';
 export declare const MODEL_TYPE = "generic-pour-model";
+/**
+ * @kosService dispense.generic-pour
+ * @kosApiLevel 4
+ */
 export type GenericPourModel = PublicModelInterface<GenericPourModelImpl>;
+/**
+ * @kosService dispense.generic-pour
+ * @kosApiLevel 4
+ */
 export declare const TOPIC_GENERIC_POUR_STARTED = "/kos/generic/pour/started";
+/**
+ * @kosService dispense.generic-pour
+ * @kosApiLevel 4
+ */
 export declare const TOPIC_GENERIC_POUR_PROGRESS = "/kos/generic/pour/progress";
+/**
+ * @kosService dispense.generic-pour
+ * @kosApiLevel 4
+ */
 export declare const TOPIC_GENERIC_POUR_CANCEL = "/kos/generic/pour/cancel";
 type PourEvent = "START_POUR" | "POUR_ACTIVE" | "CANCEL_POUR" | "POUR_CANCELED" | "POUR_COMPLETED";
 export interface GenericPourModelImpl extends KosLoggerAware, KosFutureAwareFull<any>, KosStateMachineAware<PourState, PourEvent> {

package/models/models/generic-pour/generic-pour-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generic-pour-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/generic-pour/generic-pour-model.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,eAAe,EAGf,YAAY,EACZ,aAAa,EAEb,oBAAoB,EAWpB,KAAK,OAAO,EACZ,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EAC1B,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAa,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElD,eAAO,MAAM,UAAU,uBAAuB,CAAC;AAE/C,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;AAE1E,eAAO,MAAM,0BAA0B,8BAA8B,CAAC;AACtE,eAAO,MAAM,2BAA2B,+BAA+B,CAAC;AACxE,eAAO,MAAM,yBAAyB,6BAA6B,CAAC;AAMpE,KAAK,SAAS,GACV,YAAY,GACZ,aAAa,GACb,aAAa,GACb,eAAe,GACf,gBAAgB,CAAC;AAqCrB,MAAM,WAAW,oBACf,SAAQ,cAAc,EACpB,kBAAkB,CAAC,GAAG,CAAC,EACvB,oBAAoB,CAAC,SAAS,EAAE,SAAS,CAAC;CAAG;AAEjD;;;GAGG;AACH,qBAsCa,oBACX,YAAW,aAAa,EAAE,iBAAiB,EAAE,eAAe;IAE5D,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,kBAAkB,EAAE,CAClB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,KACnC,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,KAAK,CAA+B;gBAEhC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB;IAUxD,IAAI,WAAW,WAKd;IAED;;OAEG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAIzC;;OAEG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM;IAI7B;;OAEG;IACH,gBAAgB;IAIhB;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI;IAa9C;;OAEG;IAEH,kBAAkB,IAAI,IAAI;IAkB1B;;OAEG;IAEH,gBAAgB,IAAI,IAAI;IAIxB;;OAEG;IAEH,iBAAiB,IAAI,IAAI;IAIzB;;OAEG;IAEH,cAAc,IAAI,IAAI;IAqBtB;;;;;;;SAOK;IAGQ,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM;IA8BrB,UAAU;IAUvB;;;OAGG;IACH,IAAI,SAAS,YAOZ;IAED;;;;;;;;OAQG;IACH,IAAI,OAAO,YAEV;IAED,IAAI,YAAY,WAEf;IAMD,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,CAAC;CA6BzC"}
+{"version":3,"file":"generic-pour-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/generic-pour/generic-pour-model.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,eAAe,EAGf,YAAY,EACZ,aAAa,EAEb,oBAAoB,EAWpB,KAAK,OAAO,EACZ,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EAC1B,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAa,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElD,eAAO,MAAM,UAAU,uBAAuB,CAAC;AAE/C;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;AAE1E;;;GAGG;AACH,eAAO,MAAM,0BAA0B,8BAA8B,CAAC;AACtE;;;GAGG;AACH,eAAO,MAAM,2BAA2B,+BAA+B,CAAC;AACxE;;;GAGG;AACH,eAAO,MAAM,yBAAyB,6BAA6B,CAAC;AAMpE,KAAK,SAAS,GACV,YAAY,GACZ,aAAa,GACb,aAAa,GACb,eAAe,GACf,gBAAgB,CAAC;AAqCrB,MAAM,WAAW,oBACf,SAAQ,cAAc,EACpB,kBAAkB,CAAC,GAAG,CAAC,EACvB,oBAAoB,CAAC,SAAS,EAAE,SAAS,CAAC;CAAG;AAEjD;;;GAGG;AACH,qBAsCa,oBACX,YAAW,aAAa,EAAE,iBAAiB,EAAE,eAAe;IAE5D,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,kBAAkB,EAAE,CAClB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,KACnC,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,KAAK,CAA+B;gBAEhC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB;IAUxD,IAAI,WAAW,WAKd;IAED;;OAEG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAIzC;;OAEG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM;IAI7B;;OAEG;IACH,gBAAgB;IAIhB;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI;IAa9C;;OAEG;IAEH,kBAAkB,IAAI,IAAI;IAkB1B;;OAEG;IAEH,gBAAgB,IAAI,IAAI;IAIxB;;OAEG;IAEH,iBAAiB,IAAI,IAAI;IAIzB;;OAEG;IAEH,cAAc,IAAI,IAAI;IAqBtB;;;;;;;SAOK;IAGQ,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM;IA8BrB,UAAU;IAUvB;;;OAGG;IACH,IAAI,SAAS,YAOZ;IAED;;;;;;;;OAQG;IACH,IAAI,OAAO,YAEV;IAED,IAAI,YAAY,WAEf;IAMD,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,CAAC;CA6BzC"}

package/models/models/generic-pour/generic-pour-registration.d.ts

@@ -1,87 +1,25 @@
-import { GenericPourModel } from './generic-pour-model';
-import { GenericPourOptions } from './types';
 import { KosModelRegistrationFactory } from '@kosdev-code/kos-ui-sdk';
-
+import { GenericPourOptions } from './types';
+import { GenericPourModel } from './generic-pour-model';
 /**
- * # GenericPour
+ * Registration bean for {@link GenericPourModel}.
  *
- * The registration bean includes convenience methods for creating and working with GenericPourModel instances.
+ * - `type`: the model type, used by the model registry and in `@kosDependency` declarations.
+ * - `factory`: curried factory, `GenericPour.factory(id)(options)`. Returns the existing model when the id is already in use and ignores the options.
+ * - `guard`: type guard that narrows an `IKosDataModel` to `GenericPourModel`.
+ * - `instance(id)`: reads the model, or builds it from options.
+ * - `register()`: registers the model, and any related models, with the model registry.
  *
- * ## 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.
+ * GenericPour is not a singleton: each id has its own instance.
  *
  * @example
  * ```typescript
- *
- * @kosDependency({modelType: GenericPour.type, id: "genericPourId"})
- * private genericPourModel: GenericPourModel;
- * ```
- *
- *
- * ## factory
- *
- * The factory method creates a factory function that can be used to create new GenericPourModel 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 = GenericPour.factory("genericPourId")({
- *   // 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 GenericPourModel.
- *
- * @example
- * ```typescript
- *
- * const model: IKosDataModel = ...; // some model
- *
- * if (GenericPour.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to GenericPourModel
- *    // and the compiler will know that the model has the GenericPourModel 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 { GenericPour } 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(GenericPour);
+ * KosModelRegistry.dispense.models().model(GenericPour);
  * ```
- *
- * ## registration.singleton
- 
- * The genericPour 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.
- 
- * */
+ * @kosService dispense.generic-pour
+ * @kosApiLevel 4
+ */
 export declare const GenericPour: KosModelRegistrationFactory<GenericPourModel, GenericPourOptions>;
 //# sourceMappingURL=generic-pour-registration.d.ts.map

package/models/models/generic-pour/generic-pour-registration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generic-pour-registration.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/generic-pour/generic-pour-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAgFK;AACL,eAAO,MAAM,WAAW,mEAMtB,CAAC"}
+{"version":3,"file":"generic-pour-registration.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/generic-pour/generic-pour-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,WAAW,mEAMtB,CAAC"}

package/models/models/generic-pour/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/generic-pour/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,0BAA0B,EAC1B,KAAK,gBAAgB,GACtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,KAAK,mBAAmB,MAAM,YAAY,CAAC;AAClD,mBAAmB,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/generic-pour/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,0BAA0B,EAC1B,KAAK,gBAAgB,GACtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,KAAK,mBAAmB,MAAM,YAAY,CAAC;AAClD,mBAAmB,SAAS,CAAC"}

package/models/models/generic-pour/services/generic-pour-services.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generic-pour-services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/generic-pour/services/generic-pour-services.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;IAaI;AACJ,eAAO,MAAM,YAAY,SAAgB,MAAM,WAAW,MAAM,mFAW/D,CAAC"}
+{"version":3,"file":"generic-pour-services.d.ts","sourceRoot":"","sources":["../../../../../../../packages/kos-dispense-sdk/src/models/models/generic-pour/services/generic-pour-services.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;IAaI;AACJ,eAAO,MAAM,YAAY,GAAU,MAAM,MAAM,EAAE,SAAS,MAAM,mFAW/D,CAAC"}

package/models/models/generic-pour/services/index.d.ts.map

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

package/models/models/generic-pour/types/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @kosService dispense.generic-pour
+ * @kosApiLevel 4
+ */
 export interface GenericPourOptions {
   servicePathFactory: (selectedId: string) => string;
   selectedId?: string;