@kosdev-code/kos-freestyle-sdk 2.1.27 → 2.1.28

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

@@ -1,25 +1,215 @@
 import { AgitationRequiredTroubleOptions } from './types';
-import { DeferAware, FutureResponse, IKosDataModel, IKosIdentifiable, KosConfigProperty, KosCreationContext, PublicModelInterface, ResolveAware, TroubleModel } from '@kosdev-code/kos-ui-sdk';
-import { HolderModel } 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 { HolderModel, HolderTroubleData } from '@kosdev-code/kos-dispense-sdk';
 
+/**
+ * Agitation required trouble model type identifier.
+ *
+ * Used for model registration and type predicates when working with
+ * agitation-related troubles in the KOS framework.
+ *
+ * @category Trouble Models
+ */
 export declare const MODEL_TYPE = "agitation-required-trouble-model";
+/**
+ * Public interface for the AgitationRequiredTrouble model.
+ *
+ * This model manages troubles related to insufficient agitation in beverage
+ * holders, providing resolution capabilities and deferral logic based on
+ * configuration properties.
+ *
+ * @see {@link AgitationRequiredTroubleModelImpl} for the implementation
+ * @category Trouble Models
+ */
 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.
+ *
+ * @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;
+/**
+ * Trouble type identifier for insufficient agitation troubles.
+ *
+ * This constant is used to filter and identify agitation-related troubles
+ * in the trouble system.
+ *
+ * @category Trouble Models
+ */
 export declare const AGITATION_REQUIRED_TROUBLE = "InsufficientAgitationTrouble";
+export interface AgitationRequiredTroubleModelImpl extends KosLoggerAware, KosCompanionComposition<TroubleModel<HolderTroubleData>> {
+    /** Parent trouble model (set by @kosCompanion decorator via parentProperty: "trouble") */
+    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.
+ *
+ * @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();
+ * ```
+ *
+ * @category Trouble Models
+ * @author Mark Pomerant (mark@matrica.ca)
+ * @version 2.1.27
+ */
 export declare class AgitationRequiredTroubleModelImpl implements IKosDataModel, IKosIdentifiable, ResolveAware, DeferAware {
+    /**
+     * Registration factory for creating AgitationRequiredTrouble model instances.
+     *
+     * Automatically injected by the `@kosModel` decorator. Use the exported
+     * {@link AgitationRequiredTrouble} constant instead of accessing this directly.
+     *
+     * @see {@link AgitationRequiredTrouble}
+     */
+    static Registration: KosModelRegistrationFactory<AgitationRequiredTroubleModel, AgitationRequiredTroubleOptions>;
+    /**
+     * Unique identifier for this model instance.
+     */
     id: string;
-    private logger;
-    private trouble;
     private _deferred;
     private _holdersLoaded;
+    /**
+     * Configuration property controlling whether to wait for agitation before pouring.
+     *
+     * When enabled, pouring will be deferred if the holder has insufficient agitation troubles.
+     * This ensures beverage quality by preventing pours with inadequate carbonation or mixing.
+     */
     agitateBeforePour: KosConfigProperty<boolean>;
-    constructor(modelId: string, options: AgitationRequiredTroubleOptions, context: KosCreationContext);
+    /**
+     * Creates a new AgitationRequiredTrouble model instance.
+     *
+     * @param modelId - Unique identifier for this model instance (typically matches parent trouble ID)
+     */
+    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.
+     *
+     * @returns Promise resolving to the future response from the parent trouble's resolution
+     */
     resolve(): Promise<FutureResponse | undefined>;
+    /**
+     * Gets the holder model associated with this agitation trouble.
+     *
+     * The holder is the physical container (cartridge holder, ingredient holder, etc.)
+     * that requires agitation. Returns undefined if the holder model hasn't been
+     * loaded yet through the Assembly model initialization.
+     *
+     * @returns The holder model or undefined if not yet loaded
+     */
     get holder(): HolderModel<any> | undefined;
+    /**
+     * Handles Assembly model events to track when holder models become available.
+     *
+     * This topic handler listens for Assembly model lifecycle events to determine
+     * when holder models have been fully loaded and are accessible.
+     *
+     * @internal
+     */
     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.
+     *
+     * @returns true if trouble resolution should wait for agitation to complete
+     */
     get shouldDefer(): boolean;
+    /**
+     * Gets the current deferral state of this trouble.
+     *
+     * @returns true if this trouble resolution is currently deferred
+     */
     get deferred(): boolean;
+    /**
+     * Marks this trouble as deferred, preventing immediate resolution.
+     *
+     * Called by the trouble system to indicate that trouble resolution
+     * should wait for agitation to complete before being marked as resolved.
+     */
     defer(): void;
+    /**
+     * Clears the deferral state, allowing trouble resolution to proceed.
+     *
+     * Typically called after agitation has completed and the trouble can
+     * now be safely resolved.
+     */
     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');
+ * }
+ * ```
+ *
+ * @category Trouble Models
+ */
+export declare const AgitationRequiredTrouble: KosModelRegistrationFactory<AgitationRequiredTroubleModel, AgitationRequiredTroubleOptions>;
 //# sourceMappingURL=agitation-required-trouble-model.d.ts.map

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,OAAO,EAEL,WAAW,EAEZ,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EAEjB,kBAAkB,EAClB,oBAAoB,EACpB,YAAY,EACZ,YAAY,EACb,MAAM,yBAAyB,CAAC;AASjC,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAE/D,eAAO,MAAM,UAAU,qCAAqC,CAAC;AAE7D,MAAM,MAAM,6BAA6B,GACvC,oBAAoB,CAAC,iCAAiC,CAAC,CAAC;AAE1D,eAAO,MAAM,qBAAqB,iBAAkB,YAAY,mDAK/D,CAAC;AAEF,eAAO,MAAM,0BAA0B,iCAAiC,CAAC;AACzE,qBACa,iCACX,YAAW,aAAa,EAAE,gBAAgB,EAAE,YAAY,EAAE,UAAU;IAEpE,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,OAAO,CAAkC;IACjD,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,cAAc,CAAS;IAM/B,iBAAiB,EAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;gBAG7C,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,+BAA+B,EACxC,OAAO,EAAE,kBAAkB;IAQvB,OAAO,IAAI,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAKpD,IAAI,MAAM,iCAST;IAMD,YAAY;IAUZ,IAAI,WAAW,YASd;IAED,IAAI,QAAQ,YAEX;IACD,KAAK;IAIL,UAAU;CAGX"}
+{"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;IACH,IAAI,MAAM,iCAST;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"}

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

@@ -1,4 +1,6 @@
-export { AGITATION_REQUIRED_TROUBLE, type AgitationRequiredTroubleModel, } from './agitation-required-trouble-model';
-export { AgitationRequiredTrouble } from './agitation-required-trouble-registration';
+/**
+ * (C) Copyright 2024, TCCC, All rights reserved.
+ */
+export { AGITATION_REQUIRED_TROUBLE, AgitationRequiredTrouble, type AgitationRequiredTroubleModel, } from './agitation-required-trouble-model';
 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,OAAO,EACL,0BAA0B,EAC1B,KAAK,6BAA6B,GACnC,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,wBAAwB,EAAE,MAAM,2CAA2C,CAAC;AACrF,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;;GAEG;AAEH,OAAO,EACL,0BAA0B,EAC1B,wBAAwB,EACxB,KAAK,6BAA6B,GACnC,MAAM,oCAAoC,CAAC;AAC5C,mBAAmB,SAAS,CAAC"}

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

@@ -3,44 +3,302 @@ 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';
 
+/**
+ * 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.
+     */
     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
+     */
     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>;
 }
+/**
+ * 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":"AAEA,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,eAAO,MAAM,UAAU,wBAAwB,CAAC;AAGhD,oBAAY,iBAAiB;IAC3B,aAAa,kBAAkB;IAC/B,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;CACpB;AAED,MAAM,MAAM,iBAAiB,GACzB,UAAU,GACV,qBAAqB,GACrB,MAAM,GACN,OAAO,CAAC;AAEZ,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;AAE5E,MAAM,WAAW,qBACf,SAAQ,cAAc,EACpB,UAAU,EACV,oBAAoB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,EAC1D,kBAAkB,EAClB,uBAAuB,CAAC,aAAa,CAAC;CAAG;AAC7C,qBA+Ba,qBAAsB,YAAW,aAAa;IAEzD,MAAM,CAAC,YAAY,EAAE,wBAAwB,CAC3C,iBAAiB,EACjB,mBAAmB,CACpB,CAAC;IACF,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAKlB,YAAY,EAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAMrC,WAAW,EAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAMpC,OAAO,EAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAMhC,OAAO,EAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;gBAGnC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,kBAAkB;IAU7B,IAAI,MAAM,6DAGT;IACD,IAAI,IAAI,2DAEP;IAED,IAAI,SAAS,IAAI,OAAO,CAEvB;IACD,IAAI,iBAAiB,IAAI,OAAO,CAE/B;IAED,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED,IAAI,UAAU,IAAI,OAAO,CAKxB;IAGD,qBAAqB,IAAI,IAAI;IAK7B,wBAAwB,IAAI,IAAI;IAKhC,iBAAiB,IAAI,IAAI;IAKzB,aAAa,IAAI,IAAI;IAKf,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAMjC,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAMzC,IAAI,IAAI,IAAI;IAOZ,KAAK,IAAI,IAAI;IAKb,cAAc,IAAI,IAAI;IAStB,kBAAkB,CAAC,OAAO,CAAC,EAAE,MAAM;CAUpC;AAED,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;;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"}

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

@@ -1,4 +1,29 @@
 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.
+ *
+ * @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>;
 //# sourceMappingURL=carb-tank-services.d.ts.map

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,OAAO,EAIL,KAAK,cAAc,EAEpB,MAAM,yBAAyB,CAAC;AAWjC,eAAO,MAAM,YAAY,SAAgB,MAAM,WAAW,MAAM,4BAY/D,CAAC"}
+{"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"}

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

@@ -1 +1 @@
-{"version":3,"file":"freestyle-registration-manager.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-freestyle-sdk/src/models/utils/freestyle-registration-manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,gBAAgB,IAAI,yBAAyB,EAU9C,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAKL,mBAAmB,EAEnB,KAAK,kBAAkB,EAExB,MAAM,yBAAyB,CAAC;AAgBjC,eAAO,MAAM,uBAAuB,YACxB,CAAC;;;;;CA+GV,CAAC;AAEJ,KAAK,aAAa,CAAC,CAAC,IAAI,OAAO,yBAAyB,GAAG;IACzD,SAAS,EAAE;QAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC,CAAC,CAAC,CAAA;KAAE,CAAC;IACnD,OAAO,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACnE,KAAK,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC7D,SAAS,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;CACtE,CAAC;AAEF,QAAA,MAAM,iBAAiB;;;;;;;;;;;;;;;;;CAEtB,CAAC;AAcF,KAAK,oBAAoB,GAAG,aAAa,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEpE,QAAA,MAAM,gBAAgB,EAAE,oBAA+C,CAAC;AAExE,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"freestyle-registration-manager.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-freestyle-sdk/src/models/utils/freestyle-registration-manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,gBAAgB,IAAI,yBAAyB,EAU9C,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAKL,mBAAmB,EAEnB,KAAK,kBAAkB,EAExB,MAAM,yBAAyB,CAAC;AAmBjC,eAAO,MAAM,uBAAuB,YACxB,CAAC;;;;;CA+GV,CAAC;AAEJ,KAAK,aAAa,CAAC,CAAC,IAAI,OAAO,yBAAyB,GAAG;IACzD,SAAS,EAAE;QAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC,CAAC,CAAC,CAAA;KAAE,CAAC;IACnD,OAAO,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACnE,KAAK,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC7D,SAAS,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;CACtE,CAAC;AAEF,QAAA,MAAM,iBAAiB;;;;;;;;;;;;;;;;;CAEtB,CAAC;AAcF,KAAK,oBAAoB,GAAG,aAAa,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEpE,QAAA,MAAM,gBAAgB,EAAE,oBAA+C,CAAC;AAExE,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/models/utils/openapi-index.d.ts

@@ -1,3 +1,3 @@
-export * as freestyle from './services/freestyle/daily/openapi';
-export * as handle from './services/handle/daily/openapi';
+export * as freestyle from './services/freestyle/1.8.1/openapi';
+export * as handle from './services/handle/1.8.1/openapi';
 //# sourceMappingURL=openapi-index.d.ts.map