@hueest/xray 0.1.0 → 0.2.0

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { s as ViewCapture } from "./plate-DboxMKg-.js";
+import { s as ViewCapture } from "./plate-Bv6W-GkA.js";
 
 //#region src/client.d.ts
 /**
@@ -34,8 +34,43 @@ interface ClientOptions {
    * Defaults to `true` — the plugin passes its own (off-by-default) policy.
    */
   capture?: boolean;
-  /** Where finished captures go. */
-  sink: (payload: CapturePayload) => void;
+  /**
+   * Where finished captures go. May be synchronous (fire-and-forget) or return
+   * a promise that resolves once the write is server-confirmed. Browse-time
+   * capture ignores the return value; the capture-all sweep awaits it so it
+   * does not advance to the next emulated width until the current writes have
+   * been accepted by the dev server (backpressure — capture-all-backpressure plan).
+   */
+  sink: (payload: CapturePayload) => void | Promise<void>;
+  /**
+   * Re-pull the on-disk per-plate coverage and feed it into the coverage store.
+   * The capture-all sweep calls this after each pass so the next `sweepWidths()`
+   * sees the breakpoints just written by that pass, rather than racing the
+   * async `xray:plate` HMR event (coverage freshness — capture-all-backpressure
+   * plan). Optional: browse-time capture never needs it, and the unit tests
+   * drive coverage directly through the store.
+   */
+  refreshCoverage?: () => void | Promise<void>;
+  /**
+   * Fixtures boot state (ADR 0015). `record` is when to write the live `data` to a
+   * sidecar (`'manual'` — HUD button only, the default; `'first-ready'`; or
+   * `'always'`); `replay` is whether to substitute a recorded Fixture for live
+   * `data` (`false`, `'prefer'`, or `'missing-only'`). The HUD overrides the
+   * replay toggle per tab. Absent ≡ defaults (`'manual'` / `false`).
+   */
+  record?: 'manual' | 'first-ready' | 'always';
+  replay?: false | 'prefer' | 'missing-only';
+  /**
+   * Where a recorded Fixture's OPAQUE devalue string is POSTed (the sidecar write
+   * endpoint). The client owns the devalue stringify; this only ships the bytes.
+   * Resolves once the write is server-confirmed, rejects on a non-2xx so the HUD
+   * Record button can surface a failed write. Absent ≡ Record is a no-op (the
+   * unit tests inject their own).
+   */
+  recordFixtureSink?: (payload: {
+    name: string;
+    data: string;
+  }) => void | Promise<void>;
 }
 declare function installXrayClient(options: ClientOptions): () => void;
 //#endregion