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

package/models/models/holder/holder-model.d.ts

@@ -1,6 +1,9 @@
-import { HolderModel, HolderOptions } from './types';
 import { KosModelRegistrationBean } from '@kosdev-code/kos-ui-sdk';
-
+import { HolderModel, HolderOptions } from './types';
+/**
+ * @kosService dispense.holder
+ * @kosApiLevel 2
+ */
 export interface HolderTroubleData {
     holderPaths: string[];
     holderNames: string[];
@@ -10,84 +13,22 @@ export interface ContainerTroubleData {
     unknonwnIngredientId?: string;
 }
 /**
- * # Holder
+ * Registration bean for {@link HolderModel}.
  *
- * The registration bean includes convenience methods for creating and working with HolderModel instances.
+ * - `type`: the model type, used by the model registry and in `@kosDependency` declarations.
+ * - `factory`: curried factory, `Holder.factory(id)(options)`. Returns the existing model when the id is already in use and ignores the options.
+ * - `predicate`: type guard that narrows an `IKosDataModel` to `HolderModel`.
+ * - `registration`: registry entry that can be spread into an `IKosRegistry["models"]` map.
  *
- * ## 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.
+ * Holder is not a singleton: each id has its own instance. `KosModelRegistry.dispense.models()` registers it.
  *
  * @example
  * ```typescript
- *
- * @kosDependency({modelType: Holder.type, id: "holderId"})
- * private holderModel: HolderModel;
+ * @kosDependency({ modelType: Holder.type, id: "holderId" })
+ * private holder!: HolderModel;
  * ```
- *
- *
- * ## factory
- *
- * The factory method creates a factory function that can be used to create new HolderModel 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 = Holder.factory("S1")({
- *  path: "core.dispenser.holder.s1",
- *  name: "S1",
- *  ingredientId: "1234532",
- *  assemblyName: "",
- *  type: "syrup",
- *  });
- * ```
- *
- * ## 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 HolderModel.
- *
- * @example
- * ```typescript
- *
- * const model: IKosDataModel = ...; // some model
- *
- * if (Holder.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to HolderModel
- *    // and the compiler will know that the model has the HolderModel 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 { Holder } from "@kosdev-code/kos-dispense-sdk";
- * ...
- * import { IKosRegistry } from "@kosdev-code/kos-ui-sdk";
- * export const kosModels: IKosRegistry["models"] = {
- *  ...Holder.registration,
- * };
- * ```
- *
- * ## registration.singleton
- *
- * The holder 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.holder
+ * @kosApiLevel 2
+ */
 export declare const Holder: Readonly<KosModelRegistrationBean<HolderModel, HolderOptions>>;
 //# sourceMappingURL=holder-model.d.ts.map

package/models/models/holder/holder-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"holder-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/holder/holder-model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAIV,wBAAwB,EAGzB,MAAM,yBAAyB,CAAC;AAiCjC,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAM1D,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAsZD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KA+EK;AACL,eAAO,MAAM,MAAM,EAAE,QAAQ,CAC3B,wBAAwB,CAAC,WAAW,EAAE,aAAa,CAAC,CAWrD,CAAC"}
+{"version":3,"file":"holder-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/holder/holder-model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAIV,wBAAwB,EAGzB,MAAM,yBAAyB,CAAC;AAkCjC,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAS1D;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAsZD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,MAAM,EAAE,QAAQ,CAC3B,wBAAwB,CAAC,WAAW,EAAE,aAAa,CAAC,CAWrD,CAAC"}

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

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

package/models/models/holder/services/assignment-services.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assignment-services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/holder/services/assignment-services.ts"],"names":[],"mappings":"AAaA,MAAM,WAAW,UAAU;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AACD;;;GAGG;AACH,eAAO,MAAM,cAAc,+FAG1B,CAAC;AACF,MAAM,MAAM,mBAAmB,GAC3B,UAAU,GACV,YAAY,GACZ,aAAa,GACb,eAAe,GACf,WAAW,GACX,YAAY,GACZ,cAAc,CAAC;AACnB,KAAK,kBAAkB,GAAG;IACxB,mBAAmB,GAAG,SAAS;IAC/B,UAAU,GAAG,SAAS;CACvB,CAAC;AACF,eAAO,MAAM,gBAAgB,eACf,MAAM,aACP,GAAG,KACb,QAAQ,kBAAkB,CAsB5B,CAAC;AAEF,eAAO,MAAM,aAAa,eAAsB,UAAU,mFAUzD,CAAC;AAEF,eAAO,MAAM,gBAAgB,OAAc,MAAM,uFAGhD,CAAC"}
+{"version":3,"file":"assignment-services.d.ts","sourceRoot":"","sources":["../../../../../../../packages/kos-dispense-sdk/src/models/models/holder/services/assignment-services.ts"],"names":[],"mappings":"AAaA,MAAM,WAAW,UAAU;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AACD;;;GAGG;AACH,eAAO,MAAM,cAAc,+FAG1B,CAAC;AACF,MAAM,MAAM,mBAAmB,GAC3B,UAAU,GACV,YAAY,GACZ,aAAa,GACb,eAAe,GACf,WAAW,GACX,YAAY,GACZ,cAAc,CAAC;AACnB,KAAK,kBAAkB,GAAG;IACxB,mBAAmB,GAAG,SAAS;IAC/B,UAAU,GAAG,SAAS;CACvB,CAAC;AACF,eAAO,MAAM,gBAAgB,GAC3B,YAAY,MAAM,EAClB,WAAW,GAAG,KACb,OAAO,CAAC,kBAAkB,CAsB5B,CAAC;AAEF,eAAO,MAAM,aAAa,GAAU,YAAY,UAAU,mFAUzD,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAU,IAAI,MAAM,uFAGhD,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"holder-services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/holder/services/holder-services.ts"],"names":[],"mappings":"AAeA,MAAM,WAAW,IAAI;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,OAAO,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,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;CACd;AACD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AACD;;;GAGG;AACH,eAAO,MAAM,UAAU,mGAGtB,CAAC;AAEF,eAAO,MAAM,sBAAsB,eACrB,MAAM,gBACJ,MAAM,mFAYrB,CAAC;AAEF,eAAO,MAAM,wBAAwB,eAAsB,MAAM,uFAWhE,CAAC;AAEF,eAAO,MAAM,WAAW,eAAsB,MAAM,mFAanD,CAAC"}
+{"version":3,"file":"holder-services.d.ts","sourceRoot":"","sources":["../../../../../../../packages/kos-dispense-sdk/src/models/models/holder/services/holder-services.ts"],"names":[],"mappings":"AAgBA,MAAM,WAAW,IAAI;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,OAAO,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,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;CACd;AACD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AACD;;;GAGG;AACH,eAAO,MAAM,UAAU,mGAGtB,CAAC;AAEF,eAAO,MAAM,sBAAsB,GACjC,YAAY,MAAM,EAClB,cAAc,MAAM,mFAYrB,CAAC;AAEF,eAAO,MAAM,wBAAwB,GAAU,YAAY,MAAM,uFAWhE,CAAC;AAEF,eAAO,MAAM,WAAW,GAAU,YAAY,MAAM,mFAanD,CAAC"}

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

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

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

@@ -1,11 +1,13 @@
-import { Assignment } from '../services';
-import { IntentAware } from '../../types/intent';
-import { HolderSlice } from '../../types/assembly';
-import { PumpModel } from '../../pump/types';
-import { IngredientModel } from '../../ingredient';
 import { IKosDataModel, IKosModelContainer, TroubleAware } from '@kosdev-code/kos-ui-sdk';
-
-
+import { IngredientModel } from '../../ingredient';
+import { PumpModel } from '../../pump/types';
+import { HolderSlice } from '../../types/assembly';
+import { IntentAware } from '../../types/intent';
+import { Assignment } from '../services';
+/**
+ * @kosService dispense.holder
+ * @kosApiLevel 2
+ */
 export interface HolderOptions<AdditionalData extends object = any> {
   path: string;
   name: string;
@@ -27,6 +29,8 @@ export interface HolderOptions<AdditionalData extends object = any> {
  * state about the availability of a pump to pump the connected ingredient.
  *
  * @category Model
+ * @kosService dispense.holder
+ * @kosApiLevel 2
  */
 export interface HolderModel<AdditionalData extends object = any>
   extends IKosDataModel,

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

@@ -1,5 +1,4 @@
 import { HolderModel } from '../types';
-
 export declare const getFuelGaugeValue: (holder: HolderModel) => {
     maxVolume: number;
     remainingVolume: number;

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

@@ -1 +1 @@
-{"version":3,"file":"holder-utils.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/holder/utils/holder-utils.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE5C,eAAO,MAAM,iBAAiB,WAAY,WAAW;;;;;CA8CpD,CAAC"}
+{"version":3,"file":"holder-utils.d.ts","sourceRoot":"","sources":["../../../../../../../packages/kos-dispense-sdk/src/models/models/holder/utils/holder-utils.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE5C,eAAO,MAAM,iBAAiB,GAAI,QAAQ,WAAW;;;;;CA8CpD,CAAC"}

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

@@ -1,80 +1,22 @@
-import { HolderContainerModel, HolderContainerOptions } from './types';
 import { SingletonKosModelRegistrationBean } from '@kosdev-code/kos-ui-sdk';
-
+import { HolderContainerModel, HolderContainerOptions } from './types';
 /**
- * # HolderContainer
+ * Registration bean for {@link HolderContainerModel}.
  *
- * The registration bean includes convenience methods for creating and working with HolderContainerModel instances.
+ * - `type`: the model type, used by the model registry and in `@kosDependency` declarations.
+ * - `factory`: `HolderContainer.factory(options)` returns the single instance, creating it on the first call.
+ * - `predicate`: type guard that narrows an `IKosDataModel` to `HolderContainerModel`.
+ * - `registration`: registry entry that can be spread into an `IKosRegistry["models"]` map.
  *
- * ## 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.
+ * HolderContainer is a singleton. `KosModelRegistry.dispense.models()` registers it.
  *
  * @example
  * ```typescript
- *
- * @kosDependency({modelType: HolderContainer.type})
- * private holderContainerModel: HolderContainerModel;
+ * @kosDependency({ modelType: HolderContainer.type })
+ * private holderContainer!: HolderContainerModel;
  * ```
- *
- *
- * ## factory
- *
- * The factory function that can be used to create new HolderContainerModel 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 = HolderContainer.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 HolderContainerModel.
- *
- * @example
- * ```typescript
- *
- * const model: IKosDataModel = ...; // some model
- *
- * if (HolderContainer.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to HolderContainerModel
- *    // and the compiler will know that the model has the HolderContainerModel 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 { HolderContainer } from "@kosdev-code/kos-dispense-sdk";
- * ...
- * import { IKosRegistry } from "@kosdev-code/kos-ui-sdk";
- * export const kosModels: IKosRegistry["models"] = {
- *  ...HolderContainer.registration,
- * };
- * ```
- *
- * ## registration.singleton
- * The HolderContainer 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.
- *
- * * */
+ * @kosService dispense.holder
+ * @kosApiLevel 2
+ */
 export declare const HolderContainer: SingletonKosModelRegistrationBean<HolderContainerModel, HolderContainerOptions>;
 //# sourceMappingURL=holder-container-model.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"holder-container-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/holder-container/holder-container-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAIV,iCAAiC,EAClC,MAAM,yBAAyB,CAAC;AAYjC,OAAO,KAAK,EACV,oBAAoB,EACpB,sBAAsB,EAGvB,MAAM,SAAS,CAAC;AA4HjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0EO;AACP,eAAO,MAAM,eAAe,EAAE,iCAAiC,CAC7D,oBAAoB,EACpB,sBAAsB,CAavB,CAAC"}
+{"version":3,"file":"holder-container-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/holder-container/holder-container-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAIV,iCAAiC,EAClC,MAAM,yBAAyB,CAAC;AAYjC,OAAO,KAAK,EACV,oBAAoB,EACpB,sBAAsB,EAGvB,MAAM,SAAS,CAAC;AAkIjB;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,eAAe,EAAE,iCAAiC,CAC7D,oBAAoB,EACpB,sBAAsB,CAavB,CAAC"}

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

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

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

@@ -1,12 +1,18 @@
-import { HolderModel } from '../../holder/types';
 import { IKosDataModel, IKosModelContainer } from '@kosdev-code/kos-ui-sdk';
-
-
+import { HolderModel } from '../../holder/types';
+/**
+ * @kosService dispense.holder
+ * @kosApiLevel 2
+ */
 export interface HolderContainerOptions {}
 
 export interface PathAware {
   path: string;
 }
+/**
+ * @kosService dispense.holder
+ * @kosApiLevel 2
+ */
 export interface HolderPathAware extends PathAware {
   slice: {
     pos: number;
@@ -28,9 +34,10 @@ export interface HolderPathAware extends PathAware {
  *
  *
  * @category Model
+ * @kosService dispense.holder
+ * @kosApiLevel 2
  */
-export interface HolderContainerModel<T extends object = any>
-  extends IKosDataModel {
+export interface HolderContainerModel extends IKosDataModel {
   /** the unique identifier for the model */
   id: string;
 
@@ -41,6 +48,10 @@ export interface HolderContainerModel<T extends object = any>
   updateModel(options: HolderContainerOptions): void;
 }
 
+/**
+ * @kosService dispense.pump
+ * @kosApiLevel 2
+ */
 export interface InsertionPump {
   inserted: boolean;
   type: string;

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/sdk/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/models/ingredient/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/ingredient/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,mBAAmB,SAAS,CAAC;AAC7B,OAAO,KAAK,kBAAkB,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/ingredient/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,mBAAmB,SAAS,CAAC;AAC7B,OAAO,KAAK,kBAAkB,MAAM,YAAY,CAAC"}

package/models/models/ingredient/ingredient-model.d.ts

@@ -1,86 +1,22 @@
-import { IngredientModel, IngredientOptions } from './types';
 import { KosModelRegistrationBean } from '@kosdev-code/kos-ui-sdk';
-
+import { IngredientModel, IngredientOptions } from './types';
 /**
- * # Ingredient
- *
- * The registration bean includes convenience methods for creating and working with IngredientModel 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: Ingredient.type, id: "ingredientId"})
- * private ingredientModel: IngredientModel;
- * ```
- *
- *
- * ## factory
- *
- * The factory method creates a factory function that can be used to create new IngredientModel 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
+ * Registration bean for {@link IngredientModel}.
  *
- * ```typescript
- * const model = Ingredient.factory("S1")({
- *    name: "S1",
- *    ingredientId: "1234532",
- *    type: "syrup",
- *    data: {
- *      // mapped from an extension point
- *    }
- *  });
- * ```
- *
- * ## 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 IngredientModel.
- *
- * @example
- * ```typescript
- *
- * const model: IKosDataModel = ...; // some model
- *
- * if (Ingredient.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to IngredientModel
- *    // and the compiler will know that the model has the IngredientModel 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.
+ * - `type`: the model type, used by the model registry and in `@kosDependency` declarations.
+ * - `factory`: curried factory, `Ingredient.factory(id)(options)`. Returns the existing model when the id is already in use and ignores the options.
+ * - `predicate`: type guard that narrows an `IKosDataModel` to `IngredientModel`.
+ * - `registration`: registry entry that can be spread into an `IKosRegistry["models"]` map.
  *
+ * Ingredient is not a singleton: each id has its own instance. `KosModelRegistry.dispense.models()` registers it.
  *
  * @example
- *
- * In an application registration file you can declare the model registration as follows:
- *
- * **registration.ts**
  * ```typescript
- * import { Ingredient } from "@kosdev-code/kos-dispense-sdk";
- * ...
- * import { IKosRegistry } from "@kosdev-code/kos-ui-sdk";
- * export const kosModels: IKosRegistry["models"] = {
- *  ...Ingredient.registration,
- * };
+ * @kosDependency({ modelType: Ingredient.type, id: "ingredientId" })
+ * private ingredient!: IngredientModel;
  * ```
- *
- * ## registration.singleton
- *
- * The ingredient 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.ingredient
+ * @kosApiLevel 2
+ */
 export declare const Ingredient: Readonly<KosModelRegistrationBean<IngredientModel, IngredientOptions>>;
 //# sourceMappingURL=ingredient-model.d.ts.map

package/models/models/ingredient/ingredient-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ingredient-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/ingredient/ingredient-model.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,wBAAwB,EAGzB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAuDlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAgFK;AACL,eAAO,MAAM,UAAU,EAAE,QAAQ,CAC/B,wBAAwB,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAW7D,CAAC"}
+{"version":3,"file":"ingredient-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/ingredient/ingredient-model.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,wBAAwB,EAGzB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAuDlE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,UAAU,EAAE,QAAQ,CAC/B,wBAAwB,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAW7D,CAAC"}

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"ingredient-services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/ingredient/services/ingredient-services.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,kBAAkB,EAAE,CAAC;CAChC;AACD;;;KAGK;AACL,MAAM,WAAW,kBAAkB;IACjC,wBAAwB;IACxB,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AACD;;;GAGG;AACH,eAAO,MAAM,cAAc,mGAK1B,CAAC"}
+{"version":3,"file":"ingredient-services.d.ts","sourceRoot":"","sources":["../../../../../../../packages/kos-dispense-sdk/src/models/models/ingredient/services/ingredient-services.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,kBAAkB,EAAE,CAAC;CAChC;AACD;;;KAGK;AACL,MAAM,WAAW,kBAAkB;IACjC,wBAAwB;IACxB,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AACD;;;GAGG;AACH,eAAO,MAAM,cAAc,mGAK1B,CAAC"}

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

@@ -1,9 +1,8 @@
 import { IKosDataModel } from '@kosdev-code/kos-ui-sdk';
-
-
 /**
  * Represents the options for creating an ingredient.
- *
+ * @kosService dispense.ingredient
+ * @kosApiLevel 2
  */
 export interface IngredientOptions<AdditionalData extends object = any> {
   /**
@@ -27,18 +26,13 @@ export interface IngredientOptions<AdditionalData extends object = any> {
  *
  * These will typically be created as part of the overall dispenser lifecycle as part of the Nozzle model.
  *
- * @typeParam AdditionalData - Any additional data that is added to an ingredient at the application layer.
- *
- *  @example The base Ingredient from the backend will have an id, type and name properties.  However,
- * a given implementation might extend the Ingredient node to include additional data, such as the image url.
- * This additional data would be added to the model and would be represented by the AdditionalData type parameter.
- * ```typescript
- * const model: IngredientModel<{icon: string}> = ...;
- * ```
- * would allow for visibility of all the base properties as well as the additional data (icon) that might be on the message payload from
- * the backend.
+ * @typeParam AdditionalData - Application data added to an ingredient by the
+ * {@link ExtensionType.IngredientMapper} extension point, such as an image url. It is exposed on
+ * `data`, so `IngredientModel<{ icon: string }>` types `model.data.icon`.
  *
  * @category Model
+ * @kosService dispense.ingredient
+ * @kosApiLevel 2
  */
 export interface IngredientModel<AdditionalData extends object = any>
   extends IKosDataModel,

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

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

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

@@ -1,80 +1,22 @@
-import { IngredientContainerModel, IngredientContainerOptions } from './types';
 import { SingletonKosModelRegistrationBean } from '@kosdev-code/kos-ui-sdk';
-
+import { IngredientContainerModel, IngredientContainerOptions } from './types';
 /**
- * # IngredientContainer
+ * Registration bean for {@link IngredientContainerModel}.
  *
- * The registration bean includes convenience methods for creating and working with IngredientContainerModel instances.
+ * - `type`: the model type, used by the model registry and in `@kosDependency` declarations.
+ * - `factory`: `IngredientContainer.factory(options)` returns the single instance, creating it on the first call.
+ * - `predicate`: type guard that narrows an `IKosDataModel` to `IngredientContainerModel`.
+ * - `registration`: registry entry that can be spread into an `IKosRegistry["models"]` map.
  *
- * ## 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.
+ * IngredientContainer is a singleton. `KosModelRegistry.dispense.models()` registers it.
  *
  * @example
  * ```typescript
- *
- * @kosDependency({modelType: IngredientContainer.type})
- * private holderContainerModel: IngredientContainerModel;
+ * @kosDependency({ modelType: IngredientContainer.type })
+ * private ingredientContainer!: IngredientContainerModel;
  * ```
- *
- *
- * ## factory
- *
- * The factory function that can be used to create new IngredientContainerModel 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 = IngredientContainer.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 IngredientContainerModel.
- *
- * @example
- * ```typescript
- *
- * const model: IKosDataModel = ...; // some model
- *
- * if (IngredientContainer.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to IngredientContainerModel
- *    // and the compiler will know that the model has the IngredientContainerModel 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 { IngredientContainer } from "@kosdev-code/kos-dispense-sdk";
- * ...
- * import { IKosRegistry } from "@kosdev-code/kos-ui-sdk";
- * export const kosModels: IKosRegistry["models"] = {
- *  ...IngredientContainer.registration,
- * };
- * ```
- *
- * ## registration.singleton
- * The IngredientContainer 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.
- *
- * * */
+ * @kosService dispense.ingredient
+ * @kosApiLevel 2
+ */
 export declare const IngredientContainer: SingletonKosModelRegistrationBean<IngredientContainerModel, IngredientContainerOptions>;
 //# sourceMappingURL=ingredient-container-model.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ingredient-container-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/ingredient-container/ingredient-container-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,iCAAiC,EAClC,MAAM,yBAAyB,CAAC;AAajC,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,SAAS,CAAC;AAwFjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0EO;AACP,eAAO,MAAM,mBAAmB,EAAE,iCAAiC,CACjE,wBAAwB,EACxB,0BAA0B,CAc3B,CAAC"}
+{"version":3,"file":"ingredient-container-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/ingredient-container/ingredient-container-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,iCAAiC,EAClC,MAAM,yBAAyB,CAAC;AAcjC,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,SAAS,CAAC;AA2FjB;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,mBAAmB,EAAE,iCAAiC,CACjE,wBAAwB,EACxB,0BAA0B,CAc3B,CAAC"}

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

@@ -1,7 +1,9 @@
-import { IngredientModel } from '../../ingredient/types';
 import { IKosDataModel, IKosModelContainer } from '@kosdev-code/kos-ui-sdk';
-
-
+import { IngredientModel } from '../../ingredient/types';
+/**
+ * @kosService dispense.ingredient
+ * @kosApiLevel 2
+ */
 export interface IngredientContainerOptions {}
 
 /**
@@ -43,6 +45,8 @@ export interface IngredientContainerOptions {}
  * @see {@link IngredientContainer}
  *
  * @category Model
+ * @kosService dispense.ingredient
+ * @kosApiLevel 2
  */
 export interface IngredientContainerModel<AdditionalData extends object = {}>
   extends IngredientContainerOptions,

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-dispense-sdk/src/models/models/nozzle/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC1D,YAAY,EACV,aAAa,EACb,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,SAAS,CAAC;AAEjB,6BAA6B;AAC7B,OAAO,KAAK,cAAc,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-dispense-sdk/src/models/models/nozzle/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC1D,YAAY,EACV,aAAa,EACb,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,SAAS,CAAC;AAEjB,6BAA6B;AAC7B,OAAO,KAAK,cAAc,MAAM,YAAY,CAAC"}