@spotify-confidence/csr-recorder 0.0.0 → 0.17.2

package/dist/index.d.cts

@@ -0,0 +1,124 @@
+import { RecordingEvent } from "@spotify-confidence/csr-common";
+
+//#region src/engine/index.d.ts
+/**
+* Abstraction over the underlying recording library (rrweb, custom, etc.).
+* The Recorder class depends on this interface — never on rrweb directly.
+*/
+interface RecordingEngine {
+  start(config: RecordingConfig, onEvent: (event: RecordingEvent) => void): void;
+  stop(): void;
+}
+//#endregion
+//#region src/types.d.ts
+interface RecorderOptions {
+  /** Engine used to capture DOM events (defaults to rrweb). */
+  engine: RecordingEngine;
+  /** Called for each recorded event. */
+  onEvent: (event: import("@spotify-confidence/csr-common").RecordingEvent) => void;
+}
+declare const DEFAULT_MASK_SELECTORS: string[];
+declare const DEFAULT_BLOCK_SELECTORS: string[];
+interface RecordingConfig {
+  /**
+  * CSS selectors for text content that should be masked. Joined with `,` and
+  * passed to rrweb as `maskTextSelector`. Text inside matching elements is
+  * replaced with `*` of the same length on the wire.
+  */
+  maskSelectors?: string[];
+  /**
+  * CSS selectors for elements whose subtree should be blocked entirely.
+  * Joined with `,` and passed to rrweb as `blockSelector`. Matching elements
+  * are replaced with a same-sized placeholder; their contents are never
+  * serialized — stronger than masking, use for media, third-party widgets,
+  * or anything that shouldn't leave the page at all.
+  */
+  blockSelectors?: string[];
+  /**
+  * Mask the values of every `<input>` / `<textarea>` / `contenteditable`.
+  * Defaults to `true` — typed PII (emails, names, search queries) doesn't
+  * leave the page. Pass `false` to record raw input values; `<input
+  * type="password">` is masked by rrweb regardless.
+  */
+  maskInputs?: boolean;
+  /**
+  * Capture browser console output during the recording. Defaults to `false`
+  * because console output frequently contains PII, tokens, and other
+  * sensitive data that should not be ingested into the recording pipeline
+  * without explicit opt-in.
+  *
+  * - `true` — capture all levels (log, warn, error, debug, info).
+  * - `{ levels: [...] }` — capture only the listed levels.
+  */
+  captureConsoleLogs?: boolean | {
+    levels: import("@spotify-confidence/csr-common").ConsoleLogLevel[];
+  };
+  /**
+  * Capture network requests (fetch and XMLHttpRequest) during the recording.
+  * Defaults to `false` because request URLs and metadata can contain PII,
+  * tokens, or other sensitive data.
+  *
+  * Only metadata is captured (method, URL, status, duration, sizes) — no
+  * headers or bodies are recorded.
+  */
+  captureNetworkRequests?: boolean;
+  /**
+  * Capture client-side route changes during the recording. Defaults to
+  * `true`. Only the pathname is recorded; origin, query strings, and
+  * hashes are stripped.
+  */
+  captureRouteChanges?: boolean;
+}
+declare enum RecorderState {
+  Idle = "idle",
+  Recording = "recording",
+  Stopped = "stopped"
+}
+//#endregion
+//#region src/recorder.d.ts
+declare class Recorder {
+  private readonly engine;
+  private readonly onEvent;
+  private state;
+  private visibilityHandler;
+  private originalFetch;
+  private originalXhrOpen;
+  private originalXhrSend;
+  private originalPushState;
+  private originalReplaceState;
+  private popstateHandler;
+  constructor(options: RecorderOptions);
+  get currentState(): RecorderState;
+  start(config?: RecordingConfig): void;
+  private emitNetworkRequest;
+  private patchNetwork;
+  private patchFetch;
+  private patchXhr;
+  private emitRouteChange;
+  private static currentPathname;
+  private patchRouting;
+  private restoreRouting;
+  private restoreNetwork;
+  stop(): void;
+}
+//#endregion
+//#region src/engine/rrweb-engine.d.ts
+/**
+* rrweb adapter — bundles rrweb so consumers don't take a peer-dep on it.
+*/
+declare class RrwebEngine implements RecordingEngine {
+  private stopFn;
+  start(config: RecordingConfig, onEvent: (event: RecordingEvent) => void): void;
+  stop(): void;
+}
+//#endregion
+//#region src/start-recording.d.ts
+/**
+* Start recording DOM events. Each event is passed to the callback
+* as it is captured — no buffering or batching.
+*
+* Returns a function that stops the recording.
+*/
+declare function record(onEvent: (event: RecordingEvent) => void, config?: RecordingConfig): () => void;
+//#endregion
+export { DEFAULT_BLOCK_SELECTORS, DEFAULT_MASK_SELECTORS, Recorder, type RecorderOptions, RecorderState, type RecordingConfig, type RecordingEngine, RrwebEngine, record };

package/dist/index.d.ts

@@ -0,0 +1,124 @@
+import { RecordingEvent } from "@spotify-confidence/csr-common";
+
+//#region src/engine/index.d.ts
+/**
+* Abstraction over the underlying recording library (rrweb, custom, etc.).
+* The Recorder class depends on this interface — never on rrweb directly.
+*/
+interface RecordingEngine {
+  start(config: RecordingConfig, onEvent: (event: RecordingEvent) => void): void;
+  stop(): void;
+}
+//#endregion
+//#region src/types.d.ts
+interface RecorderOptions {
+  /** Engine used to capture DOM events (defaults to rrweb). */
+  engine: RecordingEngine;
+  /** Called for each recorded event. */
+  onEvent: (event: import("@spotify-confidence/csr-common").RecordingEvent) => void;
+}
+declare const DEFAULT_MASK_SELECTORS: string[];
+declare const DEFAULT_BLOCK_SELECTORS: string[];
+interface RecordingConfig {
+  /**
+  * CSS selectors for text content that should be masked. Joined with `,` and
+  * passed to rrweb as `maskTextSelector`. Text inside matching elements is
+  * replaced with `*` of the same length on the wire.
+  */
+  maskSelectors?: string[];
+  /**
+  * CSS selectors for elements whose subtree should be blocked entirely.
+  * Joined with `,` and passed to rrweb as `blockSelector`. Matching elements
+  * are replaced with a same-sized placeholder; their contents are never
+  * serialized — stronger than masking, use for media, third-party widgets,
+  * or anything that shouldn't leave the page at all.
+  */
+  blockSelectors?: string[];
+  /**
+  * Mask the values of every `<input>` / `<textarea>` / `contenteditable`.
+  * Defaults to `true` — typed PII (emails, names, search queries) doesn't
+  * leave the page. Pass `false` to record raw input values; `<input
+  * type="password">` is masked by rrweb regardless.
+  */
+  maskInputs?: boolean;
+  /**
+  * Capture browser console output during the recording. Defaults to `false`
+  * because console output frequently contains PII, tokens, and other
+  * sensitive data that should not be ingested into the recording pipeline
+  * without explicit opt-in.
+  *
+  * - `true` — capture all levels (log, warn, error, debug, info).
+  * - `{ levels: [...] }` — capture only the listed levels.
+  */
+  captureConsoleLogs?: boolean | {
+    levels: import("@spotify-confidence/csr-common").ConsoleLogLevel[];
+  };
+  /**
+  * Capture network requests (fetch and XMLHttpRequest) during the recording.
+  * Defaults to `false` because request URLs and metadata can contain PII,
+  * tokens, or other sensitive data.
+  *
+  * Only metadata is captured (method, URL, status, duration, sizes) — no
+  * headers or bodies are recorded.
+  */
+  captureNetworkRequests?: boolean;
+  /**
+  * Capture client-side route changes during the recording. Defaults to
+  * `true`. Only the pathname is recorded; origin, query strings, and
+  * hashes are stripped.
+  */
+  captureRouteChanges?: boolean;
+}
+declare enum RecorderState {
+  Idle = "idle",
+  Recording = "recording",
+  Stopped = "stopped"
+}
+//#endregion
+//#region src/recorder.d.ts
+declare class Recorder {
+  private readonly engine;
+  private readonly onEvent;
+  private state;
+  private visibilityHandler;
+  private originalFetch;
+  private originalXhrOpen;
+  private originalXhrSend;
+  private originalPushState;
+  private originalReplaceState;
+  private popstateHandler;
+  constructor(options: RecorderOptions);
+  get currentState(): RecorderState;
+  start(config?: RecordingConfig): void;
+  private emitNetworkRequest;
+  private patchNetwork;
+  private patchFetch;
+  private patchXhr;
+  private emitRouteChange;
+  private static currentPathname;
+  private patchRouting;
+  private restoreRouting;
+  private restoreNetwork;
+  stop(): void;
+}
+//#endregion
+//#region src/engine/rrweb-engine.d.ts
+/**
+* rrweb adapter — bundles rrweb so consumers don't take a peer-dep on it.
+*/
+declare class RrwebEngine implements RecordingEngine {
+  private stopFn;
+  start(config: RecordingConfig, onEvent: (event: RecordingEvent) => void): void;
+  stop(): void;
+}
+//#endregion
+//#region src/start-recording.d.ts
+/**
+* Start recording DOM events. Each event is passed to the callback
+* as it is captured — no buffering or batching.
+*
+* Returns a function that stops the recording.
+*/
+declare function record(onEvent: (event: RecordingEvent) => void, config?: RecordingConfig): () => void;
+//#endregion
+export { DEFAULT_BLOCK_SELECTORS, DEFAULT_MASK_SELECTORS, Recorder, type RecorderOptions, RecorderState, type RecordingConfig, type RecordingEngine, RrwebEngine, record };