@kosdev-code/kos-ddk-model-components 0.1.0-dev.5197 → 0.1.0-dev.5202

package/components/pump-cards/super-pump/super-pump-card.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"super-pump-card.d.ts","sourceRoot":"","sources":["../../../../../../../packages/ddk/kos-ddk-model-components/src/components/pump-cards/super-pump/super-pump-card.tsx"],"names":[],"mappings":";AAQA,OAAO,EACL,KAAK,WAAW,EAEjB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAGL,KAAK,kBAAkB,EAExB,MAAM,gCAAgC,CAAC;AA2BxC,UAAU,iBAAiB;IACzB,MAAM,EAAE,WAAW,CAAC,kBAAkB,CAAC,CAAC;CACzC;AAED,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,iBAAiB,CAAC,iBAAiB,CA6HjE,CAAC;AAEL,eAAe,aAAa,CAAC"}
+{"version":3,"file":"super-pump-card.d.ts","sourceRoot":"","sources":["../../../../../../../packages/ddk/kos-ddk-model-components/src/components/pump-cards/super-pump/super-pump-card.tsx"],"names":[],"mappings":";AAQA,OAAO,EACL,KAAK,WAAW,EAEjB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAGL,KAAK,kBAAkB,EAExB,MAAM,gCAAgC,CAAC;AA4BxC,UAAU,iBAAiB;IACzB,MAAM,EAAE,WAAW,CAAC,kBAAkB,CAAC,CAAC;CACzC;AAED,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,iBAAiB,CAAC,iBAAiB,CA4IjE,CAAC;AAEL,eAAe,aAAa,CAAC"}

package/hooks/actions/use-pump-action.d.ts

@@ -10,6 +10,118 @@ export type PumpActionResponse = [
     (actionId: PumpAction) => Promise<void>,
     ActionLabels
 ];
-export declare const usePumpAction: (intentContainer: IntentAware, actionFactory?: Factory) => PumpActionResponse;
+/**
+ * React hook for executing pump maintenance and diagnostic actions.
+ *
+ * This hook provides a unified interface for triggering various pump operations
+ * including calibration, priming, purging, and flow tests. It manages action
+ * state, progress tracking via KOS Futures, and internationalized labels.
+ *
+ * The hook supports optional intent containers, returning safe defaults when
+ * no container is provided. This allows components to render UI before models
+ * are fully loaded, supporting progressive enhancement patterns.
+ *
+ * Available pump actions:
+ * - `calibrate` - Calibrate pump flow rate
+ * - `prime` - Prime the pump line
+ * - `purge` - Purge the pump line
+ * - `flush` - Flush the system
+ * - `low-flow-test` - Run low flow rate test
+ * - `high-flow-test` - Run high flow rate test
+ * - `fixed-45` - Fixed 45oz pour test
+ * - `hold-to-pour` - Hold-to-pour operation
+ * - `manual-override` - Manual pump override
+ * - `msv-reset` - MSV reset operation
+ *
+ * @param intentContainer - Optional model implementing {@link IntentAware} interface.
+ *                          When undefined, hook returns null action and safe handlers that
+ *                          won't execute operations. This enables components to render before
+ *                          models are available.
+ * @param actionFactory - Optional factory function for custom action types.
+ *                        Defaults to {@link pumpActionFactory} with standard pump actions.
+ *                        Provide custom factory to extend available actions.
+ *
+ * @returns Tuple containing:
+ *          - [0] {@link IntentAwareAction} instance or null (null when intentContainer undefined or before first action)
+ *          - [1] `handleAction` function accepting {@link PumpAction} type strings to trigger operations
+ *          - [2] {@link ActionLabels} object with internationalized strings (title, summary, success/failure messages, action label)
+ *
+ * @example
+ * Basic pump action controls:
+ * ```tsx
+ * import { usePumpAction } from '@kosdev-code/kos-ddk-model-components';
+ *
+ * function PumpControls({ pump }: { pump: PumpModel }) {
+ *   const [action, handleAction, labels] = usePumpAction(pump);
+ *
+ *   return (
+ *     <div>
+ *       <button onPointerDown={() => handleAction("calibrate")}>
+ *         Calibrate
+ *       </button>
+ *       <button onPointerDown={() => handleAction("prime")}>
+ *         Prime
+ *       </button>
+ *       <button onPointerDown={() => handleAction("purge")}>
+ *         Purge
+ *       </button>
+ *       {action && (
+ *         <FutureProgressBar
+ *           title={labels.title}
+ *           future={action.future}
+ *         />
+ *       )}
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * Handling optional pump (progressive enhancement):
+ * ```tsx
+ * function MaintenancePanel({ pump }: { pump?: PumpModel }) {
+ *   const [action, handleAction, labels] = usePumpAction(pump);
+ *
+ *   // Hook safely handles undefined pump - returns null action and safe handlers
+ *   return (
+ *     <div>
+ *       <button
+ *         disabled={!pump}
+ *         onClick={() => handleAction("prime")}
+ *       >
+ *         {labels.actionLabel || 'Prime'}
+ *       </button>
+ *       {action && <ProgressDisplay action={action} />}
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * Custom action factory:
+ * ```tsx
+ * const customFactory = (actionId: PumpAction) => {
+ *   if (actionId === "my-custom-action") return MyCustomAction;
+ *   return pumpActionFactory(actionId);
+ * };
+ *
+ * function CustomPumpControls({ pump }: { pump: PumpModel }) {
+ *   const [action, handleAction] = usePumpAction(pump, customFactory);
+ *
+ *   return (
+ *     <button onClick={() => handleAction("my-custom-action")}>
+ *       Custom Operation
+ *     </button>
+ *   );
+ * }
+ * ```
+ *
+ * @category Hooks - Actions
+ * @see {@link IntentAware} for required model interface
+ * @see {@link PumpAction} for available action types
+ * @see {@link IntentAwareAction} for action execution and progress tracking
+ * @see {@link ActionLabels} for internationalization label structure
+ */
+export declare const usePumpAction: (intentContainer?: IntentAware, actionFactory?: Factory) => PumpActionResponse;
 export {};
 //# sourceMappingURL=use-pump-action.d.ts.map

package/hooks/actions/use-pump-action.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-pump-action.d.ts","sourceRoot":"","sources":["../../../../../../packages/ddk/kos-ddk-model-components/src/hooks/actions/use-pump-action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAGjE,OAAO,EAWL,KAAK,iBAAiB,EACvB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAuB,KAAK,YAAY,EAAE,MAAM,SAAS,CAAC;AAEjE,KAAK,UAAU,GACX,WAAW,GACX,UAAU,GACV,OAAO,GACP,gBAAgB,GAChB,cAAc,GACd,eAAe,GACf,iBAAiB,GACjB,WAAW,GACX,OAAO,GACP,OAAO,CAAC;AAEZ,KAAK,OAAO,GAAG,CAAC,QAAQ,EAAE,UAAU,KAAK,eAAe,CAAC;AACzD,KAAK,eAAe,GAChB,CAAC,KAAK,eAAe,EAAE,WAAW,KAAK,iBAAiB,CAAC,GACzD,SAAS,CAAC;AAyCd,MAAM,MAAM,kBAAkB,GAAG;IAC/B,iBAAiB,GAAG,IAAI;IACxB,CAAC,QAAQ,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC;IACvC,YAAY;CACb,CAAC;AACF,eAAO,MAAM,aAAa,oBACP,WAAW,kBACb,OAAO,uBAsBvB,CAAC"}
+{"version":3,"file":"use-pump-action.d.ts","sourceRoot":"","sources":["../../../../../../packages/ddk/kos-ddk-model-components/src/hooks/actions/use-pump-action.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAGjE,OAAO,EAWL,KAAK,iBAAiB,EACvB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAuB,KAAK,YAAY,EAAE,MAAM,SAAS,CAAC;AAEjE,KAAK,UAAU,GACX,WAAW,GACX,UAAU,GACV,OAAO,GACP,gBAAgB,GAChB,cAAc,GACd,eAAe,GACf,iBAAiB,GACjB,WAAW,GACX,OAAO,GACP,OAAO,CAAC;AAEZ,KAAK,OAAO,GAAG,CAAC,QAAQ,EAAE,UAAU,KAAK,eAAe,CAAC;AACzD,KAAK,eAAe,GAChB,CAAC,KAAK,eAAe,EAAE,WAAW,KAAK,iBAAiB,CAAC,GACzD,SAAS,CAAC;AAyCd,MAAM,MAAM,kBAAkB,GAAG;IAC/B,iBAAiB,GAAG,IAAI;IACxB,CAAC,QAAQ,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC;IACvC,YAAY;CACb,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+GG;AACH,eAAO,MAAM,aAAa,qBACN,WAAW,kBACd,OAAO,uBA2BvB,CAAC"}

package/hooks/calibration/index.d.ts

@@ -0,0 +1,2 @@
+export * from './use-pump-calibration';
+//# sourceMappingURL=index.d.ts.map

package/hooks/calibration/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/ddk/kos-ddk-model-components/src/hooks/calibration/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC"}

package/hooks/calibration/use-pump-calibration.d.ts

@@ -0,0 +1,93 @@
+import { IntentAware, IntentContainer } from '../../../../../sdk/kos-dispense-sdk/src/index.ts';
+
+/**
+ * Combined interface representing a model that supports both intent operations
+ * and intent volume resolution for calibration purposes.
+ *
+ * This interface combines {@link IntentAware} for executing intents with
+ * {@link IntentContainer} for resolving appropriate volumes, enabling complete
+ * calibration workflows that determine the correct volume and execute the operation.
+ *
+ * @category Hooks - Calibration
+ * @see {@link IntentAware} for intent execution capabilities
+ * @see {@link IntentContainer} for volume resolution capabilities
+ */
+export type IntentAwareContainer = IntentAware & IntentContainer;
+/**
+ * React hook for managing pump calibration operations and state.
+ *
+ * This hook retrieves the calibration volume from the device, tracks whether
+ * calibration is possible, and provides an action handler for triggering
+ * calibration operations. It combines volume resolution with the pump action
+ * pattern for a complete calibration workflow.
+ *
+ * The hook automatically:
+ * - Resolves the appropriate calibration volume from the device based on ingredient type
+ * - Updates the volume when the ingredient assignment changes
+ * - Tracks calibration readiness state (requires volume > 0 and assigned ingredient)
+ * - Provides action handlers integrated with the KOS Future system for progress tracking
+ *
+ * @param intentContainer - Optional model implementing {@link IntentAware} and {@link IntentContainer}
+ *                          interfaces, typically a holder or pump model. When undefined, the hook
+ *                          returns safe defaults (undefined volume, cannot calibrate).
+ *
+ * @returns Object containing calibration state and handlers:
+ *          - `calibrateVolume`: Resolved calibration volume in oz (rounded to integer), or undefined if not yet resolved
+ *          - `canCalibrate`: Boolean indicating if calibration is ready (volume > 0 and ingredient assigned)
+ *          - `action`: Current {@link IntentAwareAction} instance or null (for progress tracking)
+ *          - `handleAction`: Function to trigger pump actions including calibration (accepts {@link PumpAction} type strings)
+ *
+ * @example
+ * Basic calibration button with volume display:
+ * ```tsx
+ * import { usePumpCalibration } from '@kosdev-code/kos-ddk-model-components';
+ *
+ * function PumpCard({ holder }: { holder: HolderModel }) {
+ *   const { calibrateVolume, canCalibrate, action, handleAction } =
+ *     usePumpCalibration(holder);
+ *
+ *   return (
+ *     <div>
+ *       <button
+ *         disabled={!canCalibrate}
+ *         onPointerDown={() => handleAction("calibrate")}
+ *       >
+ *         Calibrate {canCalibrate && `(${calibrateVolume} oz)`}
+ *       </button>
+ *       {action && <FutureProgressBar {...action} />}
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * Handling optional holder (graceful degradation):
+ * ```tsx
+ * function PumpControls({ holder }: { holder?: HolderModel }) {
+ *   const { calibrateVolume, canCalibrate, handleAction } =
+ *     usePumpCalibration(holder);
+ *
+ *   // Hook safely handles undefined holder
+ *   if (!holder) return <div>No pump selected</div>;
+ *
+ *   return (
+ *     <button disabled={!canCalibrate} onClick={() => handleAction("calibrate")}>
+ *       Calibrate ({calibrateVolume ?? '...'} oz)
+ *     </button>
+ *   );
+ * }
+ * ```
+ *
+ * @category Hooks - Calibration
+ * @see {@link usePumpAction} for the underlying action handler
+ * @see {@link IntentAware} for intent operation interface
+ * @see {@link IntentContainer} for volume resolution interface
+ * @see {@link IntentAwareAction} for action execution and progress tracking
+ */
+export declare const usePumpCalibration: (intentContainer?: IntentAwareContainer) => {
+    calibrateVolume: number | undefined;
+    canCalibrate: boolean | 0 | undefined;
+    action: import('../..').IntentAwareAction | null;
+    handleAction: (actionId: "calibrate" | "fixed-45" | "flush" | "high-flow-test" | "hold-to-pour" | "low-flow-test" | "manual-override" | "msv-reset" | "prime" | "purge") => Promise<void>;
+};
+//# sourceMappingURL=use-pump-calibration.d.ts.map

package/hooks/calibration/use-pump-calibration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-pump-calibration.d.ts","sourceRoot":"","sources":["../../../../../../packages/ddk/kos-ddk-model-components/src/hooks/calibration/use-pump-calibration.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EACV,WAAW,EACX,eAAe,EAChB,MAAM,+BAA+B,CAAC;AAIvC;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAAG,eAAe,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsEG;AACH,eAAO,MAAM,kBAAkB,qBAAsB,oBAAoB;;;;;CAgBxE,CAAC"}

package/hooks/index.d.ts

@@ -22,6 +22,7 @@ export * from './reboot';
 export * from './settings';
 export * from './setup-step';
 export * from './setup-step-container';
+export * from './calibration';
 export * from './start';
 export * from './trouble-action';
 export * from './troubles';

package/hooks/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/ddk/kos-ddk-model-components/src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC;AACpC,cAAc,WAAW,CAAC;AAC1B,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC;AAEvC,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/ddk/kos-ddk-model-components/src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC;AACpC,cAAc,WAAW,CAAC;AAC1B,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC;AAEvC,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC"}