@nivaro/react 0.1.67 → 0.1.68

package/dist/index.d.ts

@@ -235,6 +235,14 @@ export declare function canOpenDm(): boolean;
 
 export declare function canPreviewFile(type: string | null | undefined): boolean;
 
+/**
+ * Grab the replay link for an error being reported right now. Resolves null
+ * when no recorder is active (both settings off, recording failed, or the
+ * clip upload took longer than 4s) — error reporting must never wait on or
+ * break because of replay capture.
+ */
+export declare function captureErrorClip(): Promise<ErrorReplayLink | null>;
+
 export { CascadeFilterRule }
 
 declare type CascadeRule = {
@@ -796,6 +804,13 @@ export declare function ErpFailureBanner({ collection, itemId }: {
     itemId: string;
 }): JSX.Element | null;
 
+export declare interface ErrorReplayLink {
+    recording_id: string;
+    /** Milliseconds into the recording where the error happened. Null for
+     *  clips — the whole clip IS the error context. */
+    offset_ms: number | null;
+}
+
 /** Boolean convenience — for guards and conditions. */
 export declare function evaluateBoolean(src: string, row: TokenResolver | Record<string, unknown>, opts?: EvaluateOptions): boolean;
 
@@ -2834,20 +2849,27 @@ export declare type SectionState = {
 export declare function SelectField({ field, value, onChange, error, disabled, readOnly, inputId, errorId }: FieldComponentProps): JSX.Element;
 
 /**
- * rrweb session recorder for headless frontends.
+ * rrweb session recorder for headless frontends — two modes, one hook
+ * (the exact model the admin app runs; see admin/src/lib/use-session-recorder.ts).
+ *
+ * FULL mode (`session_recording_enabled` on the instance): events stream to
+ * the server continuously.
+ *
+ * ERROR-CLIP mode (`error_replay_enabled`, when full recording is off):
+ * rrweb records into a rolling IN-MEMORY buffer — two 30s checkout windows,
+ * so 30–60s of history — and uploads NOTHING. When the host reports an error,
+ * `captureErrorClip()` flushes the buffer as a short recording labelled
+ * app='error-clip'; attach the returned `recording_id`/`offset_ms` to your
+ * `POST /issues/client` body and the issue links straight to the replay.
  *
  * Drop `useSessionRecorder({ app: 'customer-portal' })` anywhere inside a
- * NivaroProvider (or pass a client explicitly) and the app records itself —
- * ONLY when the Nivaro instance has session recording enabled in Settings,
- * and ONLY if the host app has `rrweb` installed (optional peer dependency;
- * without it the hook warns once and no-ops).
+ * NivaroProvider (or pass a client explicitly). Needs `rrweb` installed in
+ * the host (optional peer dependency; without it the hook warns once and
+ * no-ops). Privacy in both modes: every input masked, `nvr-no-record`
+ * class blocked; in clip mode events never leave the browser except on error.
  *
- * Privacy defaults match the admin recorder: every input masked before
- * events leave the browser, elements with the `nvr-no-record` class blocked.
- * Events flush every 10s (or 150 events); the server enforces size caps and
- * a 7-day retention. Recordings attribute to the authenticated SDK identity
- * (usually your service token's user) with the `app` label telling replays
- * apart per frontend.
+ * `captureErrorClip` is a module singleton so an error boundary — a class
+ * component far from this hook — can call it without plumbing.
  */
 export declare interface SessionRecorderOptions {
     /** Label shown in the admin replay list — which frontend this is. */