@kosdev-code/kos-freestyle-sdk 0.1.0-dev.5880 → 0.1.0-next.1000

package/models/models/agitation-required-trouble/agitation-required-trouble-model.d.ts

@@ -1,7 +1,6 @@
-import { AgitationRequiredTroubleOptions } from './types';
-import { DeferAware, FutureResponse, IKosDataModel, IKosIdentifiable, KosCompanionComposition, KosConfigProperty, KosLoggerAware, KosModelRegistrationFactory, PublicModelInterface, ResolveAware, TroubleModel } from '@kosdev-code/kos-ui-sdk';
 import { HolderModel, HolderTroubleData } from '@kosdev-code/kos-dispense-sdk';
-
+import { DeferAware, FutureResponse, IKosDataModel, IKosIdentifiable, KosCompanionComposition, KosConfigProperty, KosLoggerAware, KosModelRegistrationFactory, PublicModelInterface, ResolveAware, TroubleModel } from '@kosdev-code/kos-ui-sdk';
+import { AgitationRequiredTroubleOptions } from './types';
 /**
  * Agitation required trouble model type identifier.
  *
@@ -23,27 +22,13 @@ export declare const MODEL_TYPE = "agitation-required-trouble-model";
  */
 export type AgitationRequiredTroubleModel = PublicModelInterface<AgitationRequiredTroubleModelImpl>;
 /**
- * Factory function to determine if a trouble requires agitation handling.
- *
- * Examines the trouble model's data to determine if it represents an
- * insufficient agitation condition that requires a dedicated agitation
- * trouble model.
+ * Companion factory for trouble models. Returns the agitation trouble model type when the trouble's
+ * data has `agitationRequired` set, so the framework creates an {@link AgitationRequiredTroubleModel}
+ * companion for it.
  *
  * @param troubleModel - The trouble model to examine
  * @returns The agitation model type if agitation is required, undefined otherwise
  *
- * @example
- * ```typescript
- * const modelType = agitationModelFactory(troubleModel);
- * if (modelType) {
- *   // Create agitation trouble model
- *   const agitationModel = AgitationRequiredTrouble
- *     .instance(troubleModel.id)
- *     .options({ companionParent: troubleModel })
- *     .build();
- * }
- * ```
- *
  * @category Trouble Models
  */
 export declare const agitationModelFactory: (troubleModel: TroubleModel) => "agitation-required-trouble-model" | undefined;
@@ -61,37 +46,13 @@ export interface AgitationRequiredTroubleModelImpl extends KosLoggerAware, KosCo
     trouble: TroubleModel<HolderTroubleData>;
 }
 /**
- * Companion model for managing agitation-required troubles in KOS beverage dispensers.
- *
- * This model represents troubles caused by insufficient agitation in ingredient holders,
- * typically occurring when carbonation levels are too low or agitation mechanisms fail.
- * It provides resolution capabilities and deferral logic to prevent pouring until
- * agitation conditions are met.
- *
- * The model integrates with the KOS configuration system to respect the
- * `ncui.agitateBeforePour` setting, allowing operators to control whether
- * pouring should wait for agitation to complete.
+ * Companion model for troubles that need the holder to be agitated first, typically because
+ * carbonation is too low. It resolves through the parent trouble and defers resolution while the
+ * holder has insufficient-agitation troubles and the `ncui.agitateBeforePour` setting is enabled.
  *
  * @remarks
- * This is a companion model to the parent trouble model, created via the
- * {@link agitationModelFactory} when a trouble's `agitationRequired` flag is set.
- *
- * @example
- * ```typescript
- * // Factory-based creation (typical usage)
- * const agitationTrouble = AgitationRequiredTrouble
- *   .instance(troubleId)
- *   .options({ companionParent: parentTroubleModel })
- *   .build();
- *
- * // Check if pouring should be deferred
- * if (agitationTrouble.shouldDefer) {
- *   await agitationTrouble.defer();
- * }
- *
- * // Resolve the trouble
- * await agitationTrouble.resolve();
- * ```
+ * Created by the framework through {@link agitationModelFactory} when a trouble's
+ * `agitationRequired` flag is set.
  *
  * @category Trouble Models
  * @author Mark Pomerant (mark@matrica.ca)
@@ -127,10 +88,7 @@ export declare class AgitationRequiredTroubleModelImpl implements IKosDataModel,
      */
     constructor(modelId: string);
     /**
-     * Resolves the agitation trouble by delegating to the parent trouble model.
-     *
-     * Resolution typically involves completing the agitation process and clearing
-     * the trouble state once carbonation or mixing levels are acceptable.
+     * Resolves the trouble through the parent trouble model.
      *
      * @returns Promise resolving to the future response from the parent trouble's resolution
      */
@@ -155,15 +113,8 @@ export declare class AgitationRequiredTroubleModelImpl implements IKosDataModel,
      */
     updateHolder(): void;
     /**
-     * Determines if trouble resolution should be deferred until agitation completes.
-     *
-     * Trouble resolution is deferred when:
-     * 1. The holder has active insufficient agitation troubles
-     * 2. The `agitateBeforePour` configuration is enabled
-     *
-     * This ensures that operations requiring agitation (prime, purge, or other
-     * holder-related troubles) wait for proper carbonation or mixing before
-     * being marked as resolved.
+     * Whether trouble resolution should wait for agitation: true when the holder has insufficient
+     * agitation troubles and `agitateBeforePour` is enabled, or when the holder is not loaded yet.
      *
      * @returns true if trouble resolution should wait for agitation to complete
      */
@@ -190,24 +141,7 @@ export declare class AgitationRequiredTroubleModelImpl implements IKosDataModel,
     clearDefer(): void;
 }
 /**
- * Registration factory for creating AgitationRequiredTrouble model instances.
- *
- * Use this constant to create new instances of the agitation trouble model
- * using the fluent factory pattern.
- *
- * @example
- * ```typescript
- * // Create a new agitation trouble model
- * const agitationTrouble = AgitationRequiredTrouble
- *   .instance(troubleId)
- *   .options({ companionParent: parentTroubleModel })
- *   .build();
- *
- * // Check deferral status
- * if (agitationTrouble.shouldDefer) {
- *   console.log('Pouring deferred due to agitation');
- * }
- * ```
+ * Registration factory for the AgitationRequiredTrouble model.
  *
  * @category Trouble Models
  */

package/models/models/agitation-required-trouble/agitation-required-trouble-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"agitation-required-trouble-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/agitation-required-trouble/agitation-required-trouble-model.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAEL,WAAW,EACX,KAAK,iBAAiB,EACvB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,uBAAuB,EACvB,iBAAiB,EACjB,cAAc,EACd,2BAA2B,EAC3B,oBAAoB,EACpB,YAAY,EACZ,YAAY,EACb,MAAM,yBAAyB,CAAC;AAWjC,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAE/D;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,qCAAqC,CAAC;AAE7D;;;;;;;;;GASG;AACH,MAAM,MAAM,6BAA6B,GACvC,oBAAoB,CAAC,iCAAiC,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,qBAAqB,iBAAkB,YAAY,mDAK/D,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B,iCAAiC,CAAC;AAEzE,MAAM,WAAW,iCACf,SAAQ,cAAc,EACpB,uBAAuB,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;IAC1D,0FAA0F;IAC1F,OAAO,EAAE,YAAY,CAAC,iBAAiB,CAAC,CAAC;CAC1C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAGa,iCACX,YAAW,aAAa,EAAE,gBAAgB,EAAE,YAAY,EAAE,UAAU;IAEpE;;;;;;;OAOG;IACH,MAAM,CAAC,YAAY,EAAE,2BAA2B,CAC9C,6BAA6B,EAC7B,+BAA+B,CAChC,CAAC;IAEF;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,cAAc,CAAS;IAE/B;;;;;OAKG;IAKH,iBAAiB,EAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAE/C;;;;OAIG;gBACS,OAAO,EAAE,MAAM;IAK3B;;;;;;;OAOG;IACG,OAAO,IAAI,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAIpD;;;;;;;;OAQG;IAEH,IAAI,MAAM,iCAYT;IAED;;;;;;;OAOG;IAKH,YAAY;IAUZ;;;;;;;;;;;;OAYG;IACH,IAAI,WAAW,YASd;IAED;;;;OAIG;IACH,IAAI,QAAQ,YAEX;IAED;;;;;OAKG;IACH,KAAK;IAIL;;;;;OAKG;IACH,UAAU;CAGX;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,wBAAwB,6FACW,CAAC"}
+{"version":3,"file":"agitation-required-trouble-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/agitation-required-trouble/agitation-required-trouble-model.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAEL,WAAW,EACX,KAAK,iBAAiB,EACvB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,uBAAuB,EACvB,iBAAiB,EACjB,cAAc,EACd,2BAA2B,EAC3B,oBAAoB,EACpB,YAAY,EACZ,YAAY,EACb,MAAM,yBAAyB,CAAC;AAWjC,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAE/D;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,qCAAqC,CAAC;AAE7D;;;;;;;;;GASG;AACH,MAAM,MAAM,6BAA6B,GACvC,oBAAoB,CAAC,iCAAiC,CAAC,CAAC;AAE1D;;;;;;;;;GASG;AACH,eAAO,MAAM,qBAAqB,GAAI,cAAc,YAAY,mDAK/D,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B,iCAAiC,CAAC;AAEzE,MAAM,WAAW,iCACf,SAAQ,cAAc,EACpB,uBAAuB,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;IAC1D,0FAA0F;IAC1F,OAAO,EAAE,YAAY,CAAC,iBAAiB,CAAC,CAAC;CAC1C;AAED;;;;;;;;;;;;GAYG;AACH,qBAGa,iCACX,YAAW,aAAa,EAAE,gBAAgB,EAAE,YAAY,EAAE,UAAU;IAEpE;;;;;;;OAOG;IACH,MAAM,CAAC,YAAY,EAAE,2BAA2B,CAC9C,6BAA6B,EAC7B,+BAA+B,CAChC,CAAC;IAEF;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,cAAc,CAAS;IAE/B;;;;;OAKG;IAKH,iBAAiB,EAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAE/C;;;;OAIG;gBACS,OAAO,EAAE,MAAM;IAK3B;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAIpD;;;;;;;;OAQG;IAEH,IAAI,MAAM,iCAYT;IAED;;;;;;;OAOG;IAKH,YAAY;IAUZ;;;;;OAKG;IACH,IAAI,WAAW,YASd;IAED;;;;OAIG;IACH,IAAI,QAAQ,YAEX;IAED;;;;;OAKG;IACH,KAAK;IAIL;;;;;OAKG;IACH,UAAU;CAGX;AAED;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,6FACW,CAAC"}

package/models/models/agitation-required-trouble/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/agitation-required-trouble/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,0BAA0B,EAC1B,wBAAwB,EACxB,KAAK,6BAA6B,GACnC,MAAM,oCAAoC,CAAC;AAC5C,mBAAmB,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/agitation-required-trouble/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,0BAA0B,EAC1B,wBAAwB,EACxB,KAAK,6BAA6B,GACnC,MAAM,oCAAoC,CAAC;AAC5C,mBAAmB,SAAS,CAAC"}

package/models/models/agitation-required-trouble/types/index.d.ts

@@ -1,7 +1,5 @@
-import { IKosCompanionOptions, TroubleModel, TroubleOptions } from '@kosdev-code/kos-ui-sdk';
 import { HolderTroubleData } from '@kosdev-code/kos-dispense-sdk';
-
-
+import { IKosCompanionOptions, TroubleModel, TroubleOptions } from '@kosdev-code/kos-ui-sdk';
 export type AgitationRequiredTroubleOptions = IKosCompanionOptions<
   TroubleModel<HolderTroubleData>,
   TroubleOptions

package/models/models/carb-agitator/carb-agitator-model.d.ts

@@ -1,8 +1,7 @@
-import { CarbAgitatorOptions } from './types';
-import { ProbeAware } from '../types/assembly';
-import { IKosDataModel, KosCompanionComposition, KosConfigProperty, KosCreationContext, KosFutureAwareFull, KosLoggerAware, KosModelRegistrationType, KosStateMachineAware, KosStateProp, PublicModelInterface } from '@kosdev-code/kos-ui-sdk';
 import { AssemblyModel } from '@kosdev-code/kos-dispense-sdk';
-
+import { IKosDataModel, KosCompanionComposition, KosConfigProperty, KosCreationContext, KosFutureAwareFull, KosLoggerAware, KosModelRegistrationType, KosStateMachineAware, KosStateProp, PublicModelInterface } from '@kosdev-code/kos-ui-sdk';
+import { ProbeAware } from '../types/assembly';
+import { CarbAgitatorOptions } from './types';
 /**
  * Unique identifier for the carb agitator model type used in KOS model registration.
  *
@@ -277,26 +276,7 @@ export declare class CarbAgitatorModelImpl implements IKosDataModel {
     handleTestCarbTank(tracker?: string): Promise<import('@kosdev-code/kos-ui-sdk').FutureResponse>;
 }
 /**
- * Registration factory for creating CarbAgitator model instances.
- *
- * Use this constant to create new carb agitator instances using the fluent factory pattern.
- *
- * @example
- * ```typescript
- * // Create a new carb agitator model
- * const carbAgitator = CarbAgitator
- *   .instance("carb-agitator-1")
- *   .options({ name: "Carb Tank" })
- *   .build();
- *
- * // Activate carb tank
- * await carbAgitator.activateCarbTank();
- *
- * // Check readiness
- * if (carbAgitator.canProceed) {
- *   console.log("Ready for beverage operations");
- * }
- * ```
+ * Registration factory for the CarbAgitator model.
  *
  * @category Models
  */

package/models/models/carb-agitator/carb-agitator-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"carb-agitator-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/carb-agitator/carb-agitator-model.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EACV,aAAa,EACb,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,YAAY,EACZ,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAiBjC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAEnD;;;;GAIG;AACH,eAAO,MAAM,UAAU,wBAAwB,CAAC;AAShD;;;;;;;;;;GAUG;AACH,oBAAY,iBAAiB;IAC3B;;;OAGG;IACH,aAAa,kBAAkB;IAE/B;;;OAGG;IACH,UAAU,eAAe;IAEzB;;;OAGG;IACH,WAAW,gBAAgB;IAE3B;;;OAGG;IACH,OAAO,YAAY;CACpB;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,iBAAiB,GACzB,UAAU,GACV,qBAAqB,GACrB,MAAM,GACN,OAAO,CAAC;AAEZ;;;;;;;GAOG;AACH,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;AAE5E;;;;;;;;;;;GAWG;AAEH,MAAM,WAAW,qBACf,SAAQ,cAAc,EACpB,UAAU,EACV,oBAAoB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,EAC1D,kBAAkB,EAClB,uBAAuB,CAAC,aAAa,CAAC;CAAG;AAC7C,qBAwEa,qBAAsB,YAAW,aAAa;IACzD;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,EAAE,wBAAwB,CAC3C,iBAAiB,EACjB,mBAAmB,CACpB,CAAC;IAEF;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IAKH,YAAY,EAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAErC;;;;OAIG;IAKH,WAAW,EAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAEpC;;;;OAIG;IAKH,OAAO,EAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAEhC;;;;;OAKG;IAKH,OAAO,EAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAErC;;;;;;OAMG;gBAED,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,kBAAkB;IAU7B;;;;;;OAMG;IACH,IAAI,MAAM,6DAGT;IAED;;;;;;OAMG;IACH,IAAI,IAAI,2DAEP;IAED;;;;OAIG;IACH,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED;;;;OAIG;IACH,IAAI,iBAAiB,IAAI,OAAO,CAE/B;IAED;;;;;;OAMG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;;;;;OAOG;IACH,IAAI,UAAU,IAAI,OAAO,CAKxB;IAED;;;;;;OAMG;IAEH,qBAAqB,IAAI,IAAI;IAI7B;;;;;;OAMG;IAEH,wBAAwB,IAAI,IAAI;IAIhC;;;;;;OAMG;IAEH,iBAAiB,IAAI,IAAI;IAIzB;;;;;;OAMG;IAEH,aAAa,IAAI,IAAI;IAIrB;;;;;;;;;;;OAWG;IAEG,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAMvC;;;;;;;;OAQG;IACG,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAKzC;;;;;;;;;OASG;IAEH,IAAI,IAAI,IAAI;IAIZ;;;;;;;;;;OAUG;IAIH,KAAK,IAAI,IAAI;IAKb;;;;;OAKG;IACH,cAAc,IAAI,IAAI;IAQtB;;;;;;;;;OASG;IAEH,kBAAkB,CAAC,OAAO,CAAC,EAAE,MAAM;CAUpC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,YAAY,kEAAqC,CAAC"}
+{"version":3,"file":"carb-agitator-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/carb-agitator/carb-agitator-model.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EACV,aAAa,EACb,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,YAAY,EACZ,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAiBjC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAEnD;;;;GAIG;AACH,eAAO,MAAM,UAAU,wBAAwB,CAAC;AAShD;;;;;;;;;;GAUG;AACH,oBAAY,iBAAiB;IAC3B;;;OAGG;IACH,aAAa,kBAAkB;IAE/B;;;OAGG;IACH,UAAU,eAAe;IAEzB;;;OAGG;IACH,WAAW,gBAAgB;IAE3B;;;OAGG;IACH,OAAO,YAAY;CACpB;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,iBAAiB,GACzB,UAAU,GACV,qBAAqB,GACrB,MAAM,GACN,OAAO,CAAC;AAEZ;;;;;;;GAOG;AACH,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;AAE5E;;;;;;;;;;;GAWG;AAEH,MAAM,WAAW,qBACf,SAAQ,cAAc,EACpB,UAAU,EACV,oBAAoB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,EAC1D,kBAAkB,EAClB,uBAAuB,CAAC,aAAa,CAAC;CAAG;AAC7C,qBAgDa,qBAAsB,YAAW,aAAa;IACzD;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,EAAE,wBAAwB,CAC3C,iBAAiB,EACjB,mBAAmB,CACpB,CAAC;IAEF;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IAKH,YAAY,EAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAErC;;;;OAIG;IAKH,WAAW,EAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAEpC;;;;OAIG;IAKH,OAAO,EAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAEhC;;;;;OAKG;IAKH,OAAO,EAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAErC;;;;;;OAMG;gBAED,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,kBAAkB;IAU7B;;;;;;OAMG;IACH,IAAI,MAAM,6DAGT;IAED;;;;;;OAMG;IACH,IAAI,IAAI,2DAEP;IAED;;;;OAIG;IACH,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED;;;;OAIG;IACH,IAAI,iBAAiB,IAAI,OAAO,CAE/B;IAED;;;;;;OAMG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;;;;;OAOG;IACH,IAAI,UAAU,IAAI,OAAO,CAKxB;IAED;;;;;;OAMG;IAEH,qBAAqB,IAAI,IAAI;IAI7B;;;;;;OAMG;IAEH,wBAAwB,IAAI,IAAI;IAIhC;;;;;;OAMG;IAEH,iBAAiB,IAAI,IAAI;IAIzB;;;;;;OAMG;IAEH,aAAa,IAAI,IAAI;IAIrB;;;;;;;;;;;OAWG;IAEG,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAMvC;;;;;;;;OAQG;IACG,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAKzC;;;;;;;;;OASG;IAEH,IAAI,IAAI,IAAI;IAIZ;;;;;;;;;;OAUG;IAIH,KAAK,IAAI,IAAI;IAKb;;;;;OAKG;IACH,cAAc,IAAI,IAAI;IAQtB;;;;;;;;;OASG;IAEH,kBAAkB,CAAC,OAAO,CAAC,EAAE,MAAM;CAUpC;AAED;;;;GAIG;AACH,eAAO,MAAM,YAAY,kEAAqC,CAAC"}

package/models/models/carb-agitator/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/carb-agitator/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,KAAK,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE7E,mBAAmB,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/carb-agitator/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,KAAK,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE7E,mBAAmB,SAAS,CAAC"}

package/models/models/carb-agitator/services/carb-tank-services.d.ts

@@ -1,28 +1,14 @@
 import { FutureResponse } from '@kosdev-code/kos-ui-sdk';
-
 /**
  * Initiates a carb tank test operation on the device.
  *
- * Sends a test command to the carb tank hardware at the specified path and returns
- * a future response that can be used to track the test operation's progress and
- * completion status.
+ * Returns the future response that tracks the test's progress and completion.
  *
  * @param path - Device path to the carb tank hardware (e.g., "assembly:core:board:macksm:carbTank:carbTank")
  * @param tracker - Future tracker ID for monitoring operation progress
  * @returns Promise resolving to a FutureResponse for operation tracking
  * @throws {Error} If the server returns no response data
  *
- * @example
- * ```typescript
- * const future = await testCarbTank(
- *   "assembly:core:board:macksm:carbTank:carbTank",
- *   "tracker-123"
- * );
- *
- * // Monitor future progress
- * console.log(`Test status: ${future.status}`);
- * ```
- *
  * @category Services
  */
 export declare const testCarbTank: (path: string, tracker: string) => Promise<FutureResponse>;

package/models/models/carb-agitator/services/carb-tank-services.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"carb-tank-services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/carb-agitator/services/carb-tank-services.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAIL,KAAK,cAAc,EAEpB,MAAM,yBAAyB,CAAC;AAYjC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,YAAY,SAAgB,MAAM,WAAW,MAAM,4BAY/D,CAAC"}
+{"version":3,"file":"carb-tank-services.d.ts","sourceRoot":"","sources":["../../../../../../../packages/kos-freestyle-sdk/src/models/models/carb-agitator/services/carb-tank-services.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAGL,KAAK,cAAc,EAEpB,MAAM,yBAAyB,CAAC;AAOjC;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,GAAU,MAAM,MAAM,EAAE,SAAS,MAAM,4BAY/D,CAAC"}

package/models/models/cartridge-agitator/cartridge-agitator-container-model.d.ts

@@ -1,7 +1,6 @@
-import { CartridgeAgitatorContainerOptions } from './types';
-import { CartridgeAgitatorModel } from './cartridge-agitator-model';
 import { IKosDataModel, IKosIdentifiable, IKosModelContainer, IKosModelHolder, KosCreationContext, PublicModelInterface } from '@kosdev-code/kos-ui-sdk';
-
+import { CartridgeAgitatorModel } from './cartridge-agitator-model';
+import { CartridgeAgitatorContainerOptions } from './types';
 export declare const MODEL_TYPE = "cartridge-agitator-container-model";
 export type CartridgeAgitatorContainerModel = PublicModelInterface<CartridgeAgitatorContainerModelImpl>;
 export declare class CartridgeAgitatorContainerModelImpl implements IKosIdentifiable, IKosModelHolder<CartridgeAgitatorModel>, IKosDataModel {

package/models/models/cartridge-agitator/cartridge-agitator-container-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cartridge-agitator-container-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/cartridge-agitator/cartridge-agitator-container-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EAEf,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACzE,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,SAAS,CAAC;AAEjE,eAAO,MAAM,UAAU,uCAAuC,CAAC;AAE/D,MAAM,MAAM,+BAA+B,GACzC,oBAAoB,CAAC,mCAAmC,CAAC,CAAC;AAE5D,qBACa,mCACX,YACE,gBAAgB,EAChB,eAAe,CAAC,sBAAsB,CAAC,EACvC,aAAa;IAEf,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACvB,OAAO,CAAC,OAAO,CAA6C;gBAEpE,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,iCAAiC,EAC1C,OAAO,EAAE,kBAAkB;IAY7B,QAAQ,CAAC,EAAE,EAAE,MAAM;IAGnB,IAAI,MAAM,+CAET;IACD,IAAI,IAAI,6BAEP;IAED,QAAQ,CAAC,KAAK,EAAE,sBAAsB;IAItC,WAAW,CAAC,EAAE,EAAE,MAAM;IAKhB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAMrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAK5B"}
+{"version":3,"file":"cartridge-agitator-container-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/cartridge-agitator/cartridge-agitator-container-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EAEf,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACzE,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,SAAS,CAAC;AAEjE,eAAO,MAAM,UAAU,uCAAuC,CAAC;AAE/D,MAAM,MAAM,+BAA+B,GACzC,oBAAoB,CAAC,mCAAmC,CAAC,CAAC;AAE5D,qBACa,mCACX,YACE,gBAAgB,EAChB,eAAe,CAAC,sBAAsB,CAAC,EACvC,aAAa;IAEf,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACvB,OAAO,CAAC,OAAO,CAA6C;gBAEpE,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,iCAAiC,EAC1C,OAAO,EAAE,kBAAkB;IAY7B,QAAQ,CAAC,EAAE,EAAE,MAAM;IAGnB,IAAI,MAAM,+CAET;IACD,IAAI,IAAI,6BAEP;IAED,QAAQ,CAAC,KAAK,EAAE,sBAAsB;IAItC,WAAW,CAAC,EAAE,EAAE,MAAM;IAKhB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAMrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAK5B"}

package/models/models/cartridge-agitator/cartridge-agitator-container-registration.d.ts

@@ -1,87 +1,22 @@
-import { CartridgeAgitatorContainerOptions } from './types';
-import { CartridgeAgitatorContainerModel } from './cartridge-agitator-container-model';
 import { SingletonKosModelRegistrationFactory } from '@kosdev-code/kos-ui-sdk';
-
+import { CartridgeAgitatorContainerModel } from './cartridge-agitator-container-model';
+import { CartridgeAgitatorContainerOptions } from './types';
 /**
- * # CartridgeAgitatorContainer
+ * Registration bean for {@link CartridgeAgitatorContainerModel}.
  *
- * The registration bean includes convenience methods for creating and working with CartridgeAgitatorContainerModel instances.
+ * - `type`: the model type, used by the model registry and in `@kosDependency` declarations.
+ * - `factory`: `CartridgeAgitatorContainer.factory(options)` returns the single instance, creating it on the first call.
+ * - `guard`: type guard that narrows an `IKosDataModel` to `CartridgeAgitatorContainerModel`.
+ * - `instance()`: 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.
+ * CartridgeAgitatorContainer is a singleton. `KosModelRegistry.freestyle.models()` registers it.
  *
  * @example
  * ```typescript
- *
- * @kosDependency({modelType: CartridgeAgitatorContainer.type, id: "cartridgeAgitatorContainerId"})
- * private cartridgeAgitatorContainerModel: CartridgeAgitatorContainerModel;
+ * @kosDependency({ modelType: CartridgeAgitatorContainer.type })
+ * private cartridgeAgitatorContainer!: CartridgeAgitatorContainerModel;
  * ```
- *
- *
- * ## factory
- *
- * The factory method creates a factory function that can be used to create new CartridgeAgitatorContainerModel 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 = CartridgeAgitatorContainer.factory({
- *   // 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 CartridgeAgitatorContainerModel.
- *
- * @example
- * ```typescript
- *
- * const model: IKosDataModel = ...; // some model
- *
- * if (CartridgeAgitatorContainer.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to CartridgeAgitatorContainerModel
- *    // and the compiler will know that the model has the CartridgeAgitatorContainerModel 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 { CartridgeAgitatorContainer } from "@kosdev-code/kos-dispense-sdk";
- * ...
- * import { ExtensionManager, IKosRegistry } from "@kosdev-code/kos-ui-sdk";
- * export const kosModels: IKosRegistry["models"] = {
- *  ...CartridgeAgitatorContainer.registration,
- * };
- * ```
- *
- * ## registration.singleton
- 
- * The cartridgeAgitatorContainer 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.
- 
- * */
+ */
 export declare const CartridgeAgitatorContainer: SingletonKosModelRegistrationFactory<CartridgeAgitatorContainerModel, CartridgeAgitatorContainerOptions>;
 //# sourceMappingURL=cartridge-agitator-container-registration.d.ts.map

package/models/models/cartridge-agitator/cartridge-agitator-container-registration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cartridge-agitator-container-registration.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/cartridge-agitator/cartridge-agitator-container-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oCAAoC,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AAM5F,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,SAAS,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAgFK;AACL,eAAO,MAAM,0BAA0B,0GAOnC,CAAC"}
+{"version":3,"file":"cartridge-agitator-container-registration.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/cartridge-agitator/cartridge-agitator-container-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oCAAoC,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AAM5F,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,SAAS,CAAC;AAEjE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,0BAA0B,0GAOnC,CAAC"}

package/models/models/cartridge-agitator/cartridge-agitator-model.d.ts

@@ -1,6 +1,5 @@
-import { CartridgeAgitatorOptions } from './types';
 import { ExternalFutureInterface, IKosDataModel, IKosIdentifiable, KosFutureAwareFull, KosLoggerAware, PublicModelInterface } from '@kosdev-code/kos-ui-sdk';
-
+import { CartridgeAgitatorOptions } from './types';
 export declare const MODEL_TYPE = "cartridge-agitator-model";
 export type CartridgeAgitatorModel = PublicModelInterface<CartridgeAgitatorModelImpl> & ExternalFutureInterface;
 export declare class CartridgeAgitatorEvents {

package/models/models/cartridge-agitator/cartridge-agitator-model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cartridge-agitator-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/cartridge-agitator/cartridge-agitator-model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,uBAAuB,EACvB,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EAEd,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAYjC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAExD,eAAO,MAAM,UAAU,6BAA6B,CAAC;AAErD,MAAM,MAAM,sBAAsB,GAChC,oBAAoB,CAAC,0BAA0B,CAAC,GAAG,uBAAuB,CAAC;AAE7E,qBAAa,uBAAuB;IAClC,MAAM,CAAC,uBAAuB,SAAuC;IACrE,MAAM,CAAC,qBAAqB,SAAqC;CAClE;AAGD,MAAM,WAAW,0BACf,SAAQ,kBAAkB,EACxB,cAAc;CAAG;AAGrB,qBAGa,0BACX,YAAW,aAAa,EAAE,gBAAgB;IAE1C,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,CAAC,SAAS,CAAyB;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;gBACD,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,wBAAwB;IAQ9D,IAAI,WAAW,IAAI,OAAO,CAEzB;IAGK,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM;IAclC,eAAe;CAahB"}
+{"version":3,"file":"cartridge-agitator-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/cartridge-agitator/cartridge-agitator-model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,uBAAuB,EACvB,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EAEd,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAYjC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAExD,eAAO,MAAM,UAAU,6BAA6B,CAAC;AAErD,MAAM,MAAM,sBAAsB,GAChC,oBAAoB,CAAC,0BAA0B,CAAC,GAAG,uBAAuB,CAAC;AAE7E,qBAAa,uBAAuB;IAClC,MAAM,CAAC,uBAAuB,SAAuC;IACrE,MAAM,CAAC,qBAAqB,SAAqC;CAClE;AAGD,MAAM,WAAW,0BACf,SAAQ,kBAAkB,EACxB,cAAc;CAAG;AAGrB,qBAGa,0BACX,YAAW,aAAa,EAAE,gBAAgB;IAE1C,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,CAAC,SAAS,CAAyB;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;gBACD,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,wBAAwB;IAQ9D,IAAI,WAAW,IAAI,OAAO,CAEzB;IAGK,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM;IAclC,eAAe;CAahB"}

package/models/models/cartridge-agitator/cartridge-agitator-registration.d.ts

@@ -1,89 +1,22 @@
-import { CartridgeAgitatorOptions } from './types';
-import { CartridgeAgitatorModel } from './cartridge-agitator-model';
 import { KosModelRegistrationFactory } from '@kosdev-code/kos-ui-sdk';
-
+import { CartridgeAgitatorModel } from './cartridge-agitator-model';
+import { CartridgeAgitatorOptions } from './types';
 /**
- * # CartridgeAgitator
- *
- * The registration bean includes convenience methods for creating and working with CartridgeAgitatorModel 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 CartridgeAgitatorModel}.
  *
- * import type { CartridgeAgitatorModel } from "./cartridge-agitator-model";
+ * - `type`: the model type, used by the model registry and in `@kosDependency` declarations.
+ * - `factory`: curried factory, `CartridgeAgitator.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 `CartridgeAgitatorModel`.
+ * - `instance(id)`: reads the model, or builds it from options.
+ * - `register()`: registers the model, and any related models, with the model registry.
  *
- * @kosDependency({modelType: CartridgeAgitator.type, id: "cartridgeAgitatorId"})
- * private cartridgeAgitatorModel: CartridgeAgitatorModel;
- * ```
- *
- *
- * ## factory
- *
- * The factory method creates a factory function that can be used to create new CartridgeAgitatorModel 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.
+ * CartridgeAgitator is not a singleton: each id has its own instance. `KosModelRegistry.freestyle.models()` registers it.
  *
  * @example
  * ```typescript
- * const model = CartridgeAgitator.factory("cartridgeAgitatorId")({
- *   // Add option data
- * });
+ * @kosDependency({ modelType: CartridgeAgitator.type, id: "cartridgeAgitatorId" })
+ * private cartridgeAgitator!: CartridgeAgitatorModel;
  * ```
- 
-
- *
- * ## 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 CartridgeAgitatorModel.
- *
- * @example
- * ```typescript
- *
- * const model: IKosDataModel = ...; // some model
- *
- * if (CartridgeAgitator.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to CartridgeAgitatorModel
- *    // and the compiler will know that the model has the CartridgeAgitatorModel 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 { CartridgeAgitator } 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(CartridgeAgitator);
- * ```
- *
- * ## registration.singleton
- 
- * The cartridgeAgitator model is NOT a singleton model.  This means that each time the factory function is called with a unique ID, a new model instance will be created.
- * If the factory function is called with an ID that already exists, the existing model will be returned.
- 
- * */
+ */
 export declare const CartridgeAgitator: KosModelRegistrationFactory<CartridgeAgitatorModel, CartridgeAgitatorOptions>;
 //# sourceMappingURL=cartridge-agitator-registration.d.ts.map

package/models/models/cartridge-agitator/cartridge-agitator-registration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cartridge-agitator-registration.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/cartridge-agitator/cartridge-agitator-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EACL,sBAAsB,EAGvB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAkFK;AACL,eAAO,MAAM,iBAAiB,+EAM5B,CAAC"}
+{"version":3,"file":"cartridge-agitator-registration.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/cartridge-agitator/cartridge-agitator-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EACL,sBAAsB,EAGvB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAExD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,iBAAiB,+EAM5B,CAAC"}

package/models/models/cartridge-agitator/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/cartridge-agitator/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AAC5F,OAAO,EAAE,0BAA0B,EAAE,MAAM,6CAA6C,CAAC;AACzF,OAAO,EACL,uBAAuB,EACvB,KAAK,sBAAsB,GAC5B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACtE,mBAAmB,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/cartridge-agitator/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AAC5F,OAAO,EAAE,0BAA0B,EAAE,MAAM,6CAA6C,CAAC;AACzF,OAAO,EACL,uBAAuB,EACvB,KAAK,sBAAsB,GAC5B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACtE,mBAAmB,SAAS,CAAC"}

package/models/models/cartridge-agitator/services/cartridge-agitator-services.d.ts

@@ -1,5 +1,4 @@
 import { FutureResponse } from '@kosdev-code/kos-ui-sdk';
-
 /**
  * @category Service
  * Retrieves the initial screen data.

package/models/models/cartridge-agitator/services/cartridge-agitator-services.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cartridge-agitator-services.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/cartridge-agitator/services/cartridge-agitator-services.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EAEf,MAAM,yBAAyB,CAAC;AAOjC;;;GAGG;AACH,eAAO,MAAM,OAAO,SAAgB,MAAM,WAAW,MAAM,4BAY1D,CAAC"}
+{"version":3,"file":"cartridge-agitator-services.d.ts","sourceRoot":"","sources":["../../../../../../../packages/kos-freestyle-sdk/src/models/models/cartridge-agitator/services/cartridge-agitator-services.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EAEf,MAAM,yBAAyB,CAAC;AAOjC;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAU,MAAM,MAAM,EAAE,SAAS,MAAM,4BAY1D,CAAC"}

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

@@ -1,8 +1,7 @@
-import { ProbeAware } from '../types/assembly';
-import { PumpModel } from '@kosdev-code/kos-dispense-sdk';
-import { CgpPumpOptions } from './types';
 import { IKosDataModel, IKosIdentifiable, KosCompanionComposition, KosLoggerAware, KosModelRegistrationType, KosStateProp, PublicModelInterface } from '@kosdev-code/kos-ui-sdk';
-
+import { CgpPumpOptions } from './types';
+import { PumpModel } from '@kosdev-code/kos-dispense-sdk';
+import { ProbeAware } from '../types/assembly';
 export declare const MODEL_TYPE = "cgp-pump-model";
 export type CgpPumpModel = PublicModelInterface<CgpPumpModelImpl>;
 export interface CgpPumpModelImpl extends KosLoggerAware, ProbeAware, KosCompanionComposition<PumpModel> {

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

@@ -1 +1 @@
-{"version":3,"file":"cgp-pump-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/cgp-pump/cgp-pump-model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAChB,uBAAuB,EACvB,cAAc,EACd,wBAAwB,EACxB,YAAY,EACZ,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AASjC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,UAAU,mBAAmB,CAAC;AAE3C,MAAM,MAAM,YAAY,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;AAGlE,MAAM,WAAW,gBACf,SAAQ,cAAc,EACpB,UAAU,EACV,uBAAuB,CAAC,SAAS,CAAC;CAAG;AAGzC,qBAKa,gBAAiB,YAAW,aAAa,EAAE,gBAAgB;IAEtE,MAAM,CAAC,YAAY,EAAE,wBAAwB,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IAM5E,YAAY,EAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAMrC,WAAW,EAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAMpC,OAAO,EAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;gBAE1B,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc;IAMpD,IAAI,SAAS,WAEZ;CACF;AAED,eAAO,MAAM,OAAO,wDAAgC,CAAC"}
+{"version":3,"file":"cgp-pump-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/cgp-pump/cgp-pump-model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAChB,uBAAuB,EACvB,cAAc,EACd,wBAAwB,EACxB,YAAY,EACZ,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AASjC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,UAAU,mBAAmB,CAAC;AAE3C,MAAM,MAAM,YAAY,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;AAGlE,MAAM,WAAW,gBACf,SAAQ,cAAc,EACpB,UAAU,EACV,uBAAuB,CAAC,SAAS,CAAC;CAAG;AAGzC,qBAKa,gBAAiB,YAAW,aAAa,EAAE,gBAAgB;IAEtE,MAAM,CAAC,YAAY,EAAE,wBAAwB,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IAM5E,YAAY,EAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAMrC,WAAW,EAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAMpC,OAAO,EAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;gBAE1B,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc;IAMpD,IAAI,SAAS,WAEZ;CACF;AAED,eAAO,MAAM,OAAO,wDAAgC,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/cgp-pump/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,mBAAmB,SAAS,CAAC;AAE7B,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/cgp-pump/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,mBAAmB,SAAS,CAAC;AAE7B,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC"}

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

@@ -1,5 +1,3 @@
-import { IKosCompanionOptions } from '@kosdev-code/kos-ui-sdk';
 import { PumpModel, PumpOptions } from '@kosdev-code/kos-dispense-sdk';
-
-
+import { IKosCompanionOptions } from '@kosdev-code/kos-ui-sdk';
 export type CgpPumpOptions = IKosCompanionOptions<PumpModel, PumpOptions>;

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

@@ -1,10 +1,9 @@
-import { FcmPumpOptions } from './types';
+import { IntentAware, IntentAwareProps, IntentContainer } from '@kosdev-code/kos-dispense-sdk';
 import { FutureAwareContainer, FutureContainer, FutureResponse, IKosDataModel, IKosIdentifiable, KosCreationContext, PublicModelInterface } from '@kosdev-code/kos-ui-sdk';
-import { IntentAware, IntentAwareProps } from '@kosdev-code/kos-dispense-sdk';
-
+import { FcmPumpOptions } from './types';
 export declare const MODEL_TYPE = "fcm-pump-model";
 export type FcmPumpModel = PublicModelInterface<FcmPumpModelImpl>;
-export declare class FcmPumpModelImpl implements IKosDataModel, IKosIdentifiable, IntentAware, FutureContainer {
+export declare class FcmPumpModelImpl implements IKosDataModel, IKosIdentifiable, IntentAware, IntentContainer, FutureContainer {
     id: string;
     private logger;
     private pumpModel;
@@ -16,6 +15,10 @@ export declare class FcmPumpModelImpl implements IKosDataModel, IKosIdentifiable
     get isPouring(): boolean;
     cancelPour(): Promise<void>;
     performIntent(props: IntentAwareProps | string): Promise<FutureResponse | undefined>;
+    get ingredientId(): string | undefined;
+    resolveIntentVolume(intent: string): Promise<{
+        volume: number;
+    }>;
     performElectricalTest(): Promise<import('./services').ElectricalTestData>;
     getChildren(): import('@kosdev-code/kos-ui-sdk').IFutureModel<Record<string, unknown>>[];
     performPreCalibrate(tracker?: string): Promise<FutureResponse>;

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

@@ -1 +1 @@
-{"version":3,"file":"fcm-pump-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/fcm-pump/fcm-pump-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,gBAAgB,EAEjB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,oBAAoB,EACpB,eAAe,EACf,cAAc,EACd,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAcjC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,eAAO,MAAM,UAAU,mBAAmB,CAAC;AAI3C,MAAM,MAAM,YAAY,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;AAElE,qBACa,gBACX,YAAW,aAAa,EAAE,gBAAgB,EAAE,WAAW,EAAE,eAAe;IAExE,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,SAAS,CAAY;IAC7B,aAAa,EAAE,oBAAoB,CAAC;gBAElC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,cAAc,EACvB,OAAO,EAAE,kBAAkB;IAQ7B,IAAI,MAAM,wFAET;IAED,IAAI,IAAI,WAEP;IAED,IAAI,OAAO,YAEV;IAED,IAAI,SAAS,YAEZ;IAEK,UAAU;IAIhB,aAAa,CACX,KAAK,EAAE,gBAAgB,GAAG,MAAM,GAC/B,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAIhC,qBAAqB;IAS3B,WAAW;IAML,mBAAmB,CAAC,OAAO,CAAC,EAAE,MAAM;IAKpC,gBAAgB,CAAC,OAAO,CAAC,EAAE,MAAM;IAKjC,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;IAI9C,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAMhD,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}
+{"version":3,"file":"fcm-pump-model.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-freestyle-sdk/src/models/models/fcm-pump/fcm-pump-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,gBAAgB,EAEhB,eAAe,EAChB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,oBAAoB,EACpB,eAAe,EACf,cAAc,EACd,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAejC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,eAAO,MAAM,UAAU,mBAAmB,CAAC;AAO3C,MAAM,MAAM,YAAY,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;AAElE,qBACa,gBACX,YACE,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,eAAe;IAEjB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,SAAS,CAAY;IAC7B,aAAa,EAAE,oBAAoB,CAAC;gBAElC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,cAAc,EACvB,OAAO,EAAE,kBAAkB;IAQ7B,IAAI,MAAM,wFAET;IAED,IAAI,IAAI,WAEP;IAED,IAAI,OAAO,YAEV;IAED,IAAI,SAAS,YAEZ;IAEK,UAAU;IAIhB,aAAa,CACX,KAAK,EAAE,gBAAgB,GAAG,MAAM,GAC/B,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAItC,IAAI,YAAY,uBAEf;IAED,mBAAmB,CAAC,MAAM,EAAE,MAAM;;;IAI5B,qBAAqB;IAS3B,WAAW;IAML,mBAAmB,CAAC,OAAO,CAAC,EAAE,MAAM;IAKpC,gBAAgB,CAAC,OAAO,CAAC,EAAE,MAAM;IAKjC,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;IAI9C,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAMhD,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}