@sailfish-ai/recorder 1.12.7 → 1.12.8

package/dist/recording.js

@@ -504,6 +504,33 @@ backendApi, apiKey, sessionId, envValue, deferRecordingStart = true, useWsWorker
                     recordCanvas: false,
                 });
             }
+            // Hover action (DIAGPLAT-1790): rrweb has no native hover, so we detect
+            // dwell over hover-affordance elements and emit them (at hover-end, with
+            // duration) as SailfishCustom "hover" events. Opt-out via
+            // captureSettings.recordHover === false.
+            if (captureSettings.recordHover !== false) {
+                try {
+                    const { installHoverDetection } = await import("./hoverDetection");
+                    const num = (v, d) => typeof v === "number" ? v : d;
+                    // installHoverDetection is idempotent (one detector per document), but
+                    // keep its teardown and reclaim the listeners when the page ends so a
+                    // re-init never stacks duplicate capture-phase handlers.
+                    const teardownHover = installHoverDetection(record, {
+                        dwellMs: num(captureSettings.hoverDwellMs, 500),
+                        // default true: only elements with a genuine hover effect qualify
+                        strictAffordance: captureSettings.hoverStrictAffordance !== false,
+                        cooldownMs: num(captureSettings.hoverCooldownMs, 3000),
+                        maxPerSession: num(captureSettings.hoverMaxPerSession, 300),
+                        maxPerSecond: num(captureSettings.hoverMaxPerSecond, 1),
+                    });
+                    window.addEventListener("pagehide", () => teardownHover(), {
+                        once: true,
+                    });
+                }
+                catch (hoverError) {
+                    console.warn("[Sailfish] Failed to enable hover detection:", hoverError);
+                }
+            }
             // ── Sailfish canvas recording (SFCV pipeline) — opt-in ──────────────
             // Dynamic import keeps the capture core out of the main bundle path.
             if (captureSettings.recordCanvas) {

package/dist/types/hoverDetection.d.ts

@@ -0,0 +1,37 @@
+/** Minimal shape of the rrweb record function we depend on. */
+type SailfishRecord = {
+    addSailfishEvent?: (type: number, payload: Record<string, unknown>) => void;
+    mirror?: {
+        getId?: (node: Node) => number;
+    };
+};
+export interface HoverDetectionOptions {
+    /** Dwell (ms) before a hover counts as intentional (≈ tooltip delay). */
+    dwellMs: number;
+    /** Don't re-emit a hover on the same element within this window (ms). */
+    cooldownMs?: number;
+    /** Hard ceiling of hover events per session. */
+    maxPerSession?: number;
+    /** Sustained hover-event rate (events/sec) via a token bucket. */
+    maxPerSecond?: number;
+    /** Emit (and stop tracking) once a single hover exceeds this duration (ms). */
+    maxDwellMs?: number;
+    /** How many ancestors to search for an affordance (default 5). */
+    maxAncestorDepth?: number;
+    /**
+     * Strict affordance (default true): an element only counts as "hover-able" if
+     * it has a genuine hover effect — a matching `:hover` CSS rule, a tooltip, or
+     * a menu/popover trigger. Bare `cursor:pointer` (which most clickable elements
+     * set, with no actual hover effect) does NOT qualify. Set false to also treat
+     * `cursor:pointer` as a hover affordance (looser, but catches elements whose
+     * `:hover` rule lives in an unreadable cross-origin stylesheet).
+     */
+    strictAffordance?: boolean;
+}
+/**
+ * Install document-level hover detection. Returns a teardown function. No-op
+ * (returns a no-op teardown) outside the browser. Idempotent: a second call
+ * tears down the previous install before arming a new one.
+ */
+export declare function installHoverDetection(record: SailfishRecord, options: HoverDetectionOptions): () => void;
+export {};

package/dist/types/hoverDetection.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/types.d.ts

@@ -58,6 +58,12 @@ export interface CaptureSettings {
     blockSelector?: string;
     unmaskSelector?: string;
     maskInputOptions?: MaskInputOptions;
+    recordHover?: boolean;
+    hoverDwellMs?: number;
+    hoverStrictAffordance?: boolean;
+    hoverCooldownMs?: number;
+    hoverMaxPerSession?: number;
+    hoverMaxPerSecond?: number;
     /**
      * Canvas text masking. `true` redacts drawn text on every recorded canvas;
      * `false` opts out of the mirror-DOM default; unset = mirror-DOM (if DOM text

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sailfish-ai/recorder",
-  "version": "1.12.7",
+  "version": "1.12.8",
   "publishPublicly": true,
   "publishToCdn": {
     "jsdelivr": true,