@kosdev-code/kos-freestyle-sdk 2.0.45 → 2.0.46

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

@@ -0,0 +1,87 @@
+import { AgitationRequiredTroubleOptions } from './types';
+import { AgitationRequiredTroubleModel } from './agitation-required-trouble-model';
+import { KosModelRegistrationFactory } from '@kosdev-code/kos-ui-sdk';
+
+/**
+ * # AgitationRequiredTrouble
+ *
+ * The registration bean includes convenience methods for creating and working with AgitationRequiredTroubleModel 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: AgitationRequiredTrouble.type, id: "agitationRequiredTroubleId"})
+ * private agitationRequiredTroubleModel: AgitationRequiredTroubleModel;
+ * ```
+ *
+ *
+ * ## factory
+ *
+ * The factory method creates a factory function that can be used to create new AgitationRequiredTroubleModel 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 = AgitationRequiredTrouble.factory("agitationRequiredTroubleId")({
+ *   // 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 AgitationRequiredTroubleModel.
+ *
+ * @example
+ * ```typescript
+ *
+ * const model: IKosDataModel = ...; // some model
+ *
+ * if (AgitationRequiredTrouble.predicate(model)) {
+ *    // if the function evaluates to true, the model is narrowed down to AgitationRequiredTroubleModel
+ *    // and the compiler will know that the model has the AgitationRequiredTroubleModel 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 { AgitationRequiredTrouble } 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(AgitationRequiredTrouble);
+ * ```
+ *
+ * ## registration.singleton
+ 
+ * The agitationRequiredTrouble 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 AgitationRequiredTrouble: KosModelRegistrationFactory<AgitationRequiredTroubleModel, AgitationRequiredTroubleOptions>;
+//# sourceMappingURL=agitation-required-trouble-registration.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"agitation-required-trouble-registration.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/agitation-required-trouble/agitation-required-trouble-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AAKxF,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAgFK;AACL,eAAO,MAAM,wBAAwB,6FAMnC,CAAC"}

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

@@ -1,6 +1,4 @@
-/**
- * (C) Copyright 2024, TCCC, All rights reserved.
- */
-export { AGITATION_REQUIRED_TROUBLE, AgitationRequiredTrouble, type AgitationRequiredTroubleModel, } from './agitation-required-trouble-model';
+export { AGITATION_REQUIRED_TROUBLE, type AgitationRequiredTroubleModel, } from './agitation-required-trouble-model';
+export { AgitationRequiredTrouble } from './agitation-required-trouble-registration';
 export type * from './types';
 //# sourceMappingURL=index.d.ts.map

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/sdk/kos-freestyle-sdk/src/models/models/agitation-required-trouble/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,0BAA0B,EAC1B,KAAK,6BAA6B,GACnC,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,wBAAwB,EAAE,MAAM,2CAA2C,CAAC;AACrF,mBAAmB,SAAS,CAAC"}

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

@@ -1,304 +1,14 @@
-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 { CarbAgitatorModel, CarbAgitatorOptions } from './types';
+import { IKosDataModel, KosCreationContext } from '@kosdev-code/kos-ui-sdk';
 
-/**
- * Unique identifier for the carb agitator model type used in KOS model registration.
- *
- * @category Constants
- */
 export declare const MODEL_TYPE = "carb-agitator-model";
-/**
- * State machine states for carb agitator initialization workflow.
- *
- * The carb agitator progresses through these states during setup and operation:
- * - UNINITIALIZED: Initial state, awaiting user action
- * - ACTIVATING: Carb tank is being initialized
- * - INITIALIZED: Carb tank is ready for operation
- * - SKIPPED: User chose to proceed without carbonation
- *
- * @category State Machine
- */
-export declare enum CarbAgitatorState {
-    /**
-     * Initial state before any action is taken.
-     * Can transition to ACTIVATING or SKIPPED.
-     */
-    UNINITIALIZED = "UNINITIALIZED",
-    /**
-     * Carb tank activation is in progress.
-     * Transitions to INITIALIZED when complete.
-     */
-    ACTIVATING = "ACTIVATING",
-    /**
-     * Carb tank is initialized and ready for operation.
-     * Can transition back to UNINITIALIZED via RESET.
-     */
-    INITIALIZED = "INITIALIZED",
-    /**
-     * User chose to skip carbonation for this workflow.
-     * Can transition back to UNINITIALIZED via RESET.
-     */
-    SKIPPED = "SKIPPED"
-}
-/**
- * Events that trigger state transitions in the carb agitator state machine.
- *
- * - ACTIVATE: Begin carb tank activation process
- * - ACTIVATION_COMPLETE: Carb tank activation finished successfully
- * - SKIP: Bypass carbonation for this workflow
- * - RESET: Return to uninitialized state
- *
- * @category State Machine
- */
-export type CarbAgitatorEvent = "ACTIVATE" | "ACTIVATION_COMPLETE" | "SKIP" | "RESET";
-/**
- * Public interface type for the carb agitator model.
- *
- * This type represents the public-facing API of the carb agitator model,
- * exposing only public methods and properties while hiding internal implementation details.
- *
- * @category Types
- */
-export type CarbAgitatorModel = PublicModelInterface<CarbAgitatorModelImpl>;
-/**
- * Interface defining the capabilities of the carb agitator model implementation.
- *
- * This interface combines multiple KOS aware interfaces to provide:
- * - Logging capabilities via KosLoggerAware
- * - Probe monitoring via ProbeAware (high/low probes, filling status)
- * - State machine management via KosStateMachineAware
- * - Async operations via KosFutureAwareFull
- * - Parent-child relationships via KosCompanionComposition
- *
- * @category Types
- */
-export interface CarbAgitatorModelImpl extends KosLoggerAware, ProbeAware, KosStateMachineAware<CarbAgitatorState, CarbAgitatorEvent>, KosFutureAwareFull, KosCompanionComposition<AssemblyModel> {
-}
-export declare class CarbAgitatorModelImpl implements IKosDataModel {
-    /**
-     * Registration factory for creating CarbAgitator model instances.
-     *
-     * Automatically injected by the `@kosModel` decorator.
-     *
-     * @see {@link CarbAgitator}
-     */
-    static Registration: KosModelRegistrationType<CarbAgitatorModel, CarbAgitatorOptions>;
-    /**
-     * Unique identifier for this carb agitator instance.
-     */
+export declare class CarbAgitatorModelImpl implements CarbAgitatorModel, IKosDataModel {
     id: string;
-    /**
-     * Display name for this carb agitator.
-     */
     name: string;
-    /**
-     * Device path for carb tank operations.
-     */
     path: string;
-    /**
-     * State path for accessing probe and filling status.
-     */
-    statePath: string;
-    /**
-     * High probe wet status indicator.
-     *
-     * Monitors whether the high-level probe in the carb tank is detecting liquid.
-     */
-    highProbeWet: KosStateProp<boolean>;
-    /**
-     * Low probe wet status indicator.
-     *
-     * Monitors whether the low-level probe in the carb tank is detecting liquid.
-     */
-    lowProbeWet: KosStateProp<boolean>;
-    /**
-     * Carb tank filling status indicator.
-     *
-     * Indicates whether the carb tank is currently being filled with liquid.
-     */
-    filling: KosStateProp<boolean>;
-    /**
-     * Configuration property controlling carb tank enable/disable state.
-     *
-     * When enabled, the carb tank is operational and carbonation is active.
-     * When disabled, carbonation is bypassed.
-     */
-    enabled: KosConfigProperty<boolean>;
-    /**
-     * Creates a new carb agitator model instance.
-     *
-     * @param modelId - Unique identifier for this instance
-     * @param options - Configuration options including name
-     * @param context - KOS creation context providing assembly paths
-     */
+    private logger;
     constructor(modelId: string, options: CarbAgitatorOptions, context: KosCreationContext);
-    /**
-     * Gets the carb holder associated with this agitator.
-     *
-     * Retrieves the first holder from the "carb" group in the parent assembly.
-     *
-     * @returns The carb holder model, or undefined if not found
-     */
-    get holder(): import('@kosdev-code/kos-dispense-sdk').HolderModel<any>;
-    /**
-     * Gets the pump associated with the carb holder.
-     *
-     * Returns the first pump from the holder's pump collection.
-     *
-     * @returns The pump model, or undefined if holder or pump not available
-     */
-    get pump(): import('@kosdev-code/kos-dispense-sdk').PumpModel<any>;
-    /**
-     * Indicates whether the carb tank is currently being filled.
-     *
-     * @returns true if the filling state property indicates active filling
-     */
-    get isFilling(): boolean;
-    /**
-     * Indicates whether the carb tank has been initialized.
-     *
-     * @returns true if the carb tank enabled configuration is set to true
-     */
-    get isCarbInitialized(): boolean;
-    /**
-     * Indicates whether carb tank activation is allowed.
-     *
-     * Activation is only allowed when the carb tank is not already enabled.
-     *
-     * @returns true if the carb tank can be activated
-     */
-    get canActivate(): boolean;
-    /**
-     * Indicates whether the workflow can proceed past carb initialization.
-     *
-     * The workflow can proceed when the state machine is in either INITIALIZED
-     * (carb tank activated) or SKIPPED (user chose to bypass carbonation).
-     *
-     * @returns true if ready to proceed with beverage operations
-     */
-    get canProceed(): boolean;
-    /**
-     * State entry handler when entering ACTIVATING state.
-     *
-     * Logs the start of carb tank activation process.
-     *
-     * @internal
-     */
-    handleActivationStart(): void;
-    /**
-     * State exit handler when leaving ACTIVATING state.
-     *
-     * Logs successful completion of carb tank initialization.
-     *
-     * @internal
-     */
-    handleActivationComplete(): void;
-    /**
-     * State entry handler when entering INITIALIZED state.
-     *
-     * Logs that the carb tank is ready for beverage operations.
-     *
-     * @internal
-     */
-    handleInitialized(): void;
-    /**
-     * State entry handler when entering SKIPPED state.
-     *
-     * Logs that the user has chosen to proceed without carbonation.
-     *
-     * @internal
-     */
-    handleSkipped(): void;
-    /**
-     * Activates the carb tank and transitions through initialization workflow.
-     *
-     * This method:
-     * 1. Transitions to ACTIVATING state
-     * 2. Updates the enabled configuration property to true
-     * 3. Transitions to INITIALIZED state
-     *
-     * Can only be called when in UNINITIALIZED state (enforced by state guard).
-     *
-     * @throws {Error} If called from an invalid state
-     */
-    activateCarbTank(): Promise<void>;
-    /**
-     * Deactivates the carb tank and resets to uninitialized state.
-     *
-     * This method:
-     * 1. Updates the enabled configuration property to false
-     * 2. Transitions back to UNINITIALIZED state
-     *
-     * Can be called from any state.
-     */
-    deactivateCarbTank(): Promise<void>;
-    /**
-     * Skips carb tank initialization and proceeds without carbonation.
-     *
-     * Allows the workflow to continue without activating the carb tank.
-     * Transitions from UNINITIALIZED to SKIPPED state.
-     *
-     * Can only be called when in UNINITIALIZED state (enforced by state guard).
-     *
-     * @throws {Error} If called from an invalid state
-     */
-    skip(): void;
-    /**
-     * Resets the carb tank to uninitialized state.
-     *
-     * This method:
-     * 1. Updates the enabled configuration property to false
-     * 2. Transitions back to UNINITIALIZED state
-     *
-     * Can only be called when in INITIALIZED or SKIPPED states (enforced by state guard).
-     *
-     * @throws {Error} If called from an invalid state
-     */
-    reset(): void;
-    /**
-     * Toggles the carb tank between enabled and disabled states.
-     *
-     * If currently enabled, calls {@link deactivateCarbTank}.
-     * If currently disabled, calls {@link activateCarbTank}.
-     */
-    toggleCarbTank(): void;
-    /**
-     * Tests the carb tank operation and returns a future for tracking progress.
-     *
-     * Initiates a carb tank test operation on the device and returns a future
-     * that can be monitored for progress and completion status.
-     *
-     * @param tracker - Future tracker ID (injected by @kosFuture decorator)
-     * @returns Promise resolving to a FutureResponse for operation tracking
-     * @throws {Error} If tracker is not provided by the decorator
-     */
-    handleTestCarbTank(tracker?: string): Promise<import('@kosdev-code/kos-ui-sdk').FutureResponse>;
+    init(): Promise<void>;
+    load(): Promise<void>;
 }
-/**
- * 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");
- * }
- * ```
- *
- * @category Models
- */
-export declare const CarbAgitator: KosModelRegistrationType<CarbAgitatorModel, CarbAgitatorOptions>;
 //# sourceMappingURL=carb-agitator-model.d.ts.map

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/sdk/kos-freestyle-sdk/src/models/models/carb-agitator/carb-agitator-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EAEb,kBAAkB,EACnB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAEtE,eAAO,MAAM,UAAU,wBAAwB,CAAC;AAEhD,qBACa,qBAAsB,YAAW,iBAAiB,EAAE,aAAa;IAC5E,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,CAAC,MAAM,CAAmB;gBAE/B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,kBAAkB;IAavB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}

package/models/models/{fcm-pump/fcm-pump-registration.d.ts → carb-agitator/carb-agitator-registration.d.ts}

@@ -1,11 +1,10 @@
-import { FcmPumpModel } from './fcm-pump-model';
-import { FcmPumpOptions } from './types';
+import { CarbAgitatorModel, CarbAgitatorOptions } from './types';
 import { KosModelRegistrationFactory } from '@kosdev-code/kos-ui-sdk';
 
 /**
- * # FcmPump
+ * # CarbAgitator
  *
- * The registration bean includes convenience methods for creating and working with FcmPumpModel instances.
+ * The registration bean includes convenience methods for creating and working with CarbAgitatorModel instances.
  *
  * ## type
  * The type property is a string that identifies the model type.
@@ -15,14 +14,14 @@ import { KosModelRegistrationFactory } from '@kosdev-code/kos-ui-sdk';
  * @example
  * ```typescript
  *
- * @kosDependency({modelType: FcmPump.type, id: "fcmPumpId"})
- * private fcmPumpModel: FcmPumpModel;
+ * @kosDependency({modelType: CarbAgitator.type, id: "carbAgitatorId"})
+ * private carbAgitatorModel: CarbAgitatorModel;
  * ```
  *
  *
  * ## factory
  *
- * The factory method creates a factory function that can be used to create new FcmPumpModel instances.
+ * The factory method creates a factory function that can be used to create new CarbAgitatorModel instances.
  *
  
  * The factory function is a curried function that takes the model id as the first argument and the options as the second argument.
@@ -32,7 +31,7 @@ import { KosModelRegistrationFactory } from '@kosdev-code/kos-ui-sdk';
  *
  * @example
  * ```typescript
- * const model = FcmPump.factory("fcmPumpId")({
+ * const model = CarbAgitator.factory("carbAgitatorId")({
  *   // Add option data
  * });
  * ```
@@ -41,16 +40,16 @@ import { KosModelRegistrationFactory } from '@kosdev-code/kos-ui-sdk';
  *
  * ## 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 FcmPumpModel.
+ * [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 CarbAgitatorModel.
  *
  * @example
  * ```typescript
  *
  * const model: IKosDataModel = ...; // some model
  *
- * if (FcmPump.predicate(model)) {
- *    // if the function evaluates to true, the model is narrowed down to FcmPumpModel
- *    // and the compiler will know that the model has the FcmPumpModel interface
+ * if (CarbAgitator.predicate(model)) {
+ *    // if the function evaluates to true, the model is narrowed down to CarbAgitatorModel
+ *    // and the compiler will know that the model has the CarbAgitatorModel interface
  *    model.updateAvailability(false);
  * }
  * ```
@@ -67,21 +66,19 @@ import { KosModelRegistrationFactory } from '@kosdev-code/kos-ui-sdk';
  *
  * **registration.ts**
  * ```typescript
- * import { FcmPump } 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(FcmPump);
+ * import { CarbAgitator } from "@kos-ui/kos-dispenser-model";
+ * ...
+ * import { ExtensionManager, IKosRegistry } from "@kosdev-code/kos-ui-sdk";
+ * export const kosModels: IKosRegistry["models"] = {
+ *  ...CarbAgitator.registration,
+ * };
  * ```
  *
  * ## registration.singleton
  
- * The fcmPump 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.
+ * The carbAgitator 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 FcmPump: KosModelRegistrationFactory<FcmPumpModel, FcmPumpOptions>;
-//# sourceMappingURL=fcm-pump-registration.d.ts.map
+export declare const CarbAgitator: KosModelRegistrationFactory<CarbAgitatorModel, CarbAgitatorOptions>;
+//# sourceMappingURL=carb-agitator-registration.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"carb-agitator-registration.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/carb-agitator/carb-agitator-registration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AAEtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KA8EK;AAEL,eAAO,MAAM,YAAY,qEAMvB,CAAC"}

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

@@ -1,3 +1,3 @@
-export { CarbAgitator, type CarbAgitatorModel } from './carb-agitator-model';
+export { CarbAgitator } from './carb-agitator-registration';
 export type * from './types';
 //# sourceMappingURL=index.d.ts.map

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/sdk/kos-freestyle-sdk/src/models/models/carb-agitator/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,mBAAmB,SAAS,CAAC"}

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

@@ -1,7 +1,14 @@
+import { IKosIdentifiable } from '@kosdev-code/kos-ui-sdk';
+
+
 export interface CarbAgitatorOptions {
   name: string;
   path: string;
-  statePath: string;
+}
+
+export interface CarbAgitatorModel extends IKosIdentifiable {
+  name: string;
+  path: string;
 }
 
 export {};

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

@@ -1,5 +1,5 @@
 import { CartridgeAgitatorOptions } from './types';
-import { ExternalFutureInterface, IKosDataModel, IKosIdentifiable, KosFutureAwareFull, KosLoggerAware, PublicModelInterface } from '@kosdev-code/kos-ui-sdk';
+import { ExternalFutureInterface, FutureAwareContainer, IKosDataModel, IKosIdentifiable, KosCreationContext, PublicModelInterface } from '@kosdev-code/kos-ui-sdk';
 
 export declare const MODEL_TYPE = "cartridge-agitator-model";
 export type CartridgeAgitatorModel = PublicModelInterface<CartridgeAgitatorModelImpl> & ExternalFutureInterface;
@@ -7,17 +7,20 @@ export declare class CartridgeAgitatorEvents {
     static TOPIC_AGITATION_STARTED: string;
     static TOPIC_AGITATION_ENDED: string;
 }
-export interface CartridgeAgitatorModelImpl extends KosFutureAwareFull, KosLoggerAware {
-}
 export declare class CartridgeAgitatorModelImpl implements IKosDataModel, IKosIdentifiable {
     id: string;
+    futureHandler: FutureAwareContainer;
+    private logger;
+    private disposer?;
     private agitating;
     path: string;
     statePath: string;
     name: string;
-    constructor(modelId: string, options: CartridgeAgitatorOptions);
+    constructor(modelId: string, options: CartridgeAgitatorOptions, context: KosCreationContext);
     get isAgitating(): boolean;
     testAgitate(tracker?: string): Promise<import('@kosdev-code/kos-ui-sdk').FutureResponse>;
-    handleAgitation(): void;
+    init(): Promise<void>;
+    unload(): void;
+    load(): Promise<void>;
 }
 //# sourceMappingURL=cartridge-agitator-model.d.ts.map

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/sdk/kos-freestyle-sdk/src/models/models/cartridge-agitator/cartridge-agitator-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,oBAAoB,EACpB,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAElB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAWjC,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;AAED,qBACa,0BACX,YAAW,aAAa,EAAE,gBAAgB;IAE1C,EAAE,EAAE,MAAM,CAAC;IACJ,aAAa,EAAG,oBAAoB,CAAC;IAC5C,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,QAAQ,CAAC,CAAe;IAEhC,OAAO,CAAC,SAAS,CAAyB;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;gBAEX,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,wBAAwB,EACjC,OAAO,EAAE,kBAAkB;IAY7B,IAAI,WAAW,IAAI,OAAO,CAEzB;IAGK,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM;IAY5B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B,MAAM;IAIA,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAoB5B"}

package/models/models/freestyle-assembly/freestyle-assembly-model.d.ts

@@ -9,12 +9,11 @@ import { IKosDataModel, IKosIdentifiable, KosCreationContext, PublicModelInterfa
 
 export declare const MODEL_TYPE = "freestyle-assembly-model";
 export declare const FEATURE_SUPPORTS_ICE = "iceAgitator";
-export declare const FEATURE_SUPPORTS_CARB = "carbTank";
+export declare const FEATURE_SUPPORTS_CARB = "carbAgitator";
 export declare const FEATURE_SUPPORTS_REMOTE_TRAYS = "remoteTrays";
 export type FreestyleAssemblyModel = PublicModelInterface<FreestyleAssemblyModelImpl> & AssemblyModel<FreestyleModelAssemblyExt, FreestyleHolderModelExt>;
 export declare class FreestyleAssemblyModelImpl implements IKosDataModel, IKosIdentifiable, AssemblyModel<FreestyleModelAssemblyExt, FreestyleHolderModelExt> {
     id: string;
-    private _carbTankModel?;
     private logger;
     private assembly;
     private _remoteTrays;
@@ -29,7 +28,7 @@ export declare class FreestyleAssemblyModelImpl implements IKosDataModel, IKosId
     get boards(): BoardModel<any>[];
     updateModel(options: AssemblyOptions): void;
     get iceAgitator(): IceAgitatorModel;
-    get carbTank(): CarbAgitatorModel | undefined;
+    get carbAgitator(): CarbAgitatorModel;
     get cartridgeAgitators(): CartridgeAgitatorContainerModel;
     get defaultCartridgeAgitator(): CartridgeAgitatorModel;
     get cartridgeAgitatorModels(): CartridgeAgitatorModel[];
@@ -40,6 +39,5 @@ export declare class FreestyleAssemblyModelImpl implements IKosDataModel, IKosId
     get supportsIce(): boolean;
     get supportsCarb(): boolean;
     init(): Promise<void>;
-    ready(): Promise<void>;
 }
 //# sourceMappingURL=freestyle-assembly-model.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"freestyle-assembly-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/freestyle-assembly/freestyle-assembly-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAQjC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAExD,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,SAAS,EACf,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAgB,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EACL,KAAK,+BAA+B,EACpC,KAAK,sBAAsB,EAC5B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,KAAK,EACV,uBAAuB,EACvB,yBAAyB,EAC1B,MAAM,mBAAmB,CAAC;AAE3B,eAAO,MAAM,UAAU,6BAA6B,CAAC;AAErD,eAAO,MAAM,oBAAoB,gBAAgB,CAAC;AAClD,eAAO,MAAM,qBAAqB,aAAa,CAAC;AAChD,eAAO,MAAM,6BAA6B,gBAAgB,CAAC;AAE3D,MAAM,MAAM,sBAAsB,GAChC,oBAAoB,CAAC,0BAA0B,CAAC,GAC9C,aAAa,CAAC,yBAAyB,EAAE,uBAAuB,CAAC,CAAC;AAEtE,qBAEa,0BACX,YACE,aAAa,EACb,gBAAgB,EAChB,aAAa,CAAC,yBAAyB,EAAE,uBAAuB,CAAC;IAEnE,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,CAAC,cAAc,CAAC,CAAoB;IAC3C,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,QAAQ,CAGd;IAGF,OAAO,CAAC,YAAY,CAA4B;gBAG9C,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,wBAAwB,EACjC,OAAO,EAAE,kBAAkB;IAW7B,IAAI,YAAY,IAAI,MAAM,EAAE,CAE3B;IACD,IAAI,WAAW,IAAI,MAAM,EAAE,CAE1B;IACD,IAAI,UAAU,IAAI,WAAW,CAAC,uBAAuB,CAAC,EAAE,CAEvD;IACD,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CAAC,uBAAuB,CAAC,EAAE;IAGxE,kBAAkB,CAChB,UAAU,EAAE,MAAM,GACjB,WAAW,CAAC,uBAAuB,CAAC,EAAE;IAGzC,IAAI,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAEpD;IACD,IAAI,SAAS,IAAI,MAAM,EAAE,CAExB;IAED,IAAI,MAAM,IAAI,UAAU,CAAC,GAAG,CAAC,EAAE,CAE9B;IACD,WAAW,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAG3C,IAAI,WAAW,IAAI,gBAAgB,CAElC;IACD,IAAI,QAAQ,IAAI,iBAAiB,GAAG,SAAS,CAE5C;IAED,IAAI,kBAAkB,IAAI,+BAA+B,CAExD;IAED,IAAI,wBAAwB,IAAI,sBAAsB,CAErD;IACD,IAAI,uBAAuB,IAAI,sBAAsB,EAAE,CAEtD;IAED,IAAI,qBAAqB,IAAI,OAAO,CAEnC;IAED,IAAI,WAAW,IAAI,wBAAwB,CAE1C;IAED,IAAI,cAAc,IAAI,OAAO,CAI5B;IAID,IAAI,mBAAmB,IAAI,OAAO,CAEjC;IACD,IAAI,WAAW,YAEd;IAED,IAAI,YAAY,YAEf;IAEK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAQ7B"}
+{"version":3,"file":"freestyle-assembly-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-freestyle-sdk/src/models/models/freestyle-assembly/freestyle-assembly-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAOjC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAExD,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,SAAS,EACf,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EACL,KAAK,+BAA+B,EACpC,KAAK,sBAAsB,EAC5B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,KAAK,EACV,uBAAuB,EACvB,yBAAyB,EAC1B,MAAM,mBAAmB,CAAC;AAE3B,eAAO,MAAM,UAAU,6BAA6B,CAAC;AAErD,eAAO,MAAM,oBAAoB,gBAAgB,CAAC;AAClD,eAAO,MAAM,qBAAqB,iBAAiB,CAAC;AACpD,eAAO,MAAM,6BAA6B,gBAAgB,CAAC;AAE3D,MAAM,MAAM,sBAAsB,GAChC,oBAAoB,CAAC,0BAA0B,CAAC,GAC9C,aAAa,CAAC,yBAAyB,EAAE,uBAAuB,CAAC,CAAC;AAEtE,qBAEa,0BACX,YACE,aAAa,EACb,gBAAgB,EAChB,aAAa,CAAC,yBAAyB,EAAE,uBAAuB,CAAC;IAEnE,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,QAAQ,CAGd;IAGF,OAAO,CAAC,YAAY,CAA4B;gBAG9C,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,wBAAwB,EACjC,OAAO,EAAE,kBAAkB;IAW7B,IAAI,YAAY,IAAI,MAAM,EAAE,CAE3B;IACD,IAAI,WAAW,IAAI,MAAM,EAAE,CAE1B;IACD,IAAI,UAAU,IAAI,WAAW,CAAC,uBAAuB,CAAC,EAAE,CAEvD;IACD,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CAAC,uBAAuB,CAAC,EAAE;IAGxE,kBAAkB,CAChB,UAAU,EAAE,MAAM,GACjB,WAAW,CAAC,uBAAuB,CAAC,EAAE;IAGzC,IAAI,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAEpD;IACD,IAAI,SAAS,IAAI,MAAM,EAAE,CAExB;IAED,IAAI,MAAM,IAAI,UAAU,CAAC,GAAG,CAAC,EAAE,CAE9B;IACD,WAAW,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAG3C,IAAI,WAAW,IAAI,gBAAgB,CAElC;IACD,IAAI,YAAY,IAAI,iBAAiB,CAEpC;IAED,IAAI,kBAAkB,IAAI,+BAA+B,CAExD;IAED,IAAI,wBAAwB,IAAI,sBAAsB,CAErD;IACD,IAAI,uBAAuB,IAAI,sBAAsB,EAAE,CAEtD;IAED,IAAI,qBAAqB,IAAI,OAAO,CAEnC;IAED,IAAI,WAAW,IAAI,wBAAwB,CAE1C;IAED,IAAI,cAAc,IAAI,OAAO,CAI5B;IAID,IAAI,mBAAmB,IAAI,OAAO,CAEjC;IACD,IAAI,WAAW,YAEd;IAED,IAAI,YAAY,YAEf;IAEK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAG5B"}

package/models/models/freestyle-nozzle/freestyle-nozzle-model.d.ts

@@ -10,14 +10,10 @@ export declare class FreestyleNozzleModelImpl implements IKosDataModel, IKosIden
     private nozzleModel;
     private _cupSizes;
     private _nutritionInfo?;
+    private _disposer;
     constructor(modelId: string, options: FreestyleNozzleOptions, context: KosCreationContext);
     set cupSizes(cupSizes: number[]);
     get nutritionInfo(): FreestyleNutritionInfoResponse | undefined;
-    get selectedPourable(): {
-        beverage: import('@kosdev-code/kos-dispense-sdk').AvailabilityModel<any, Record<string, any>> | undefined;
-        additional: import('@kosdev-code/kos-dispense-sdk').AvailabilityModel<any, Record<string, any>>[] | undefined;
-    };
-    handleBeverageSelection(): Promise<void>;
     init(): Promise<void>;
     unload(): void;
     load(): Promise<void>;