tracebck-sdk 0.3.1 → 0.4.1

package/dist/index.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Captured network request event passed to `sanitizeRequest`.
+ * Return the (modified) event to keep it, or `null` / `undefined` to drop it.
+ */
+export interface NetworkEvent {
+  method: string;
+  url: string;
+  statusCode: number;
+  startTime: number;
+  /** Duration in milliseconds */
+  duration: number;
+  requestHeaders: Record<string, string>;
+  requestBody: string | null;
+  requestBodyTruncated: boolean;
+  responseHeaders?: Record<string, string>;
+  responseBody?: string | null;
+  responseBodyTruncated?: boolean;
+  /** Present only when the request failed */
+  error?: string;
+  initiator: "fetch" | "xhr";
+}
+
+export interface InitOptions {
+  /** Your project API key (starts with `sk_`). Required. */
+  apiKey: string;
+  /** Milliseconds between automatic event flushes. Default: `5000`. */
+  flushInterval?: number;
+  /** Mask all input field values in the recording. Default: `false`. */
+  maskAllInputs?: boolean;
+  /** Capture network requests (fetch & XHR). Default: `true`. */
+  captureNetwork?: boolean;
+  /** Capture console output (log, warn, error, info, debug) and uncaught errors. Default: `true`. */
+  captureConsole?: boolean;
+  /** URL patterns to exclude from network capture. Strings use `includes()`, RegExp uses `test()`. */
+  networkDenyUrls?: (string | RegExp)[];
+  /** Hook to redact or drop captured network events before they are recorded. Return `null` to drop. */
+  sanitizeRequest?: (event: NetworkEvent) => NetworkEvent | null;
+  /** Extra rrweb `record()` options, spread into the recorder config. */
+  options?: Record<string, unknown>;
+}
+
+export interface SessionIdentifier {
+  /** Identifier type. Default: `"custom"`. */
+  type?: "email" | "custom";
+  /** Identifier value. Required. */
+  value: string;
+}
+
+export interface StartSessionOptions {
+  /** How to identify the user being recorded. `value` is required. */
+  identifier: SessionIdentifier;
+  /** Extra metadata attached to the session (merged with auto-collected browser info). */
+  metadata?: Record<string, unknown>;
+}
+
+/**
+ * Initialize the Tracebck SDK. Must be called before `startSession()`.
+ *
+ * @example
+ * ```js
+ * Tracebck.init({ apiKey: 'sk_...' });
+ * ```
+ */
+export function init(options: InitOptions): void;
+
+/**
+ * Start a recording session. Automatically stops any previous active session.
+ *
+ * @example
+ * ```js
+ * await Tracebck.startSession({
+ *   identifier: { type: 'email', value: 'user@example.com' },
+ *   metadata: { plan: 'pro' },
+ * });
+ * ```
+ */
+export function startSession(options: StartSessionOptions): Promise<void>;
+
+/**
+ * Stop the current recording session, flush remaining events, and notify the API.
+ */
+export function stopSession(): Promise<void>;