@bentolabs/sdk 1.2.2 → 2.0.0

package/dist/index.d.ts

@@ -1,5 +1,24 @@
-import { generateSelector } from 'rrweb';
-export { generateSelector };
+import { generateSelector, generateSelectorFromElement, generateSelectorFromHTML } from 'rrweb';
+export { generateSelector, generateSelectorFromElement, generateSelectorFromHTML };
+interface NetworkOptions {
+    skipUrls?: string[];
+    captureHeaders?: boolean;
+    captureBody?: boolean;
+    maxBodySize?: number;
+    sampleRate?: number;
+}
+interface StorageOptions {
+    localStorage?: boolean;
+    sessionStorage?: boolean;
+    cookies?: boolean;
+    sensitiveKeys?: string[];
+}
+interface ConsoleOptions {
+    levels?: ('log' | 'warn' | 'error' | 'info' | 'debug')[];
+    maxLogs?: number;
+    maxPayloadSize?: number;
+    captureStackTrace?: boolean;
+}
 interface SDKConfig {
     apiKey: string;
     endpoint: string;
@@ -9,6 +28,22 @@ interface SDKConfig {
     enableRecording: boolean;
     maxRetries: number;
     baseRetryDelay: number;
+    enableCompression: boolean;
+    persistence: 'localStorage' | 'cookie' | 'localStorage+cookie' | 'memory' | 'none';
+    respect_dnt: boolean;
+    autocapture: boolean;
+    capture_pageview: boolean;
+    capture_pageleave: boolean;
+    capture_network: boolean;
+    networkOptions: NetworkOptions;
+    capture_storage: boolean;
+    storageOptions: StorageOptions;
+    capture_console: boolean;
+    consoleOptions: ConsoleOptions;
+    bootstrap?: {
+        distinctID?: string;
+        isIdentifiedID?: boolean;
+    };
 }
 interface SDKOptions {
     endpoint?: string;
@@ -18,6 +53,64 @@ interface SDKOptions {
     enableRecording?: boolean;
     maxRetries?: number;
     baseRetryDelay?: number;
+    enableCompression?: boolean;
+    persistence?: 'localStorage' | 'cookie' | 'localStorage+cookie' | 'memory' | 'none';
+    respect_dnt?: boolean;
+    autocapture?: boolean;
+    capture_pageview?: boolean;
+    capture_pageleave?: boolean;
+    capture_network?: boolean;
+    networkOptions?: NetworkOptions;
+    capture_storage?: boolean;
+    storageOptions?: StorageOptions;
+    capture_console?: boolean;
+    consoleOptions?: ConsoleOptions;
+    bootstrap?: {
+        distinctID?: string;
+        isIdentifiedID?: boolean;
+    };
+}
+interface UserProperties {
+    [key: string]: string | number | boolean | null | undefined;
+}
+interface NetworkLog {
+    url: string;
+    method: string;
+    status: number;
+    duration: number;
+    responseSize: number;
+    initiator: 'fetch' | 'xhr';
+    error?: string;
+    timestamp: number;
+}
+interface StorageLog {
+    storageType: 'localStorage' | 'sessionStorage' | 'cookie';
+    operation: 'get' | 'set' | 'remove' | 'clear';
+    key: string;
+    valueType?: string;
+    timestamp: number;
+}
+interface ConsoleLog {
+    level: 'log' | 'warn' | 'error' | 'info' | 'debug';
+    payload: string[];
+    trace: string[];
+    timestamp: number;
+}
+declare class PeopleAPI {
+    private sdk;
+    constructor(sdk: BentoLabsSDK);
+    /**
+     * Set properties on the current user
+     */
+    set(properties: UserProperties): void;
+    /**
+     * Set properties on the current user only if they haven't been set already
+     */
+    setOnce(properties: UserProperties): void;
+    /**
+     * Remove properties from the current user
+     */
+    unset(propertyNames: string[]): void;
 }
 export declare class BentoLabsSDK {
     private config;
@@ -26,46 +119,107 @@ export declare class BentoLabsSDK {
     private isRecording;
     private batchTimer;
     private retryTimer;
-    private stopRecording;
+    private stopRecordingFn;
+    private distinctId;
+    private identity;
+    private superProperties;
+    private persistence;
+    private initialized;
+    private optedOut;
+    private networkMonitor;
+    private storageMonitor;
+    private consoleMonitor;
+    people: PeopleAPI;
+    private autocaptureCleanup;
     constructor();
     /**
      * Initialize the BentoLabs SDK
-     * @param apiKey - Your API key for authentication
-     * @param options - Optional configuration options
      */
     init(apiKey: string, options?: SDKOptions): void;
     /**
-     * Generate a unique session ID with 'sess_' prefix
+     * Identify a user with a distinct ID and optional properties
      */
-    private generateSessionId;
+    identify(distinctId: string, properties?: UserProperties): void;
     /**
-     * Generate a simple UUID v4
+     * Reset the user to an anonymous state
      */
-    private generateUUID;
+    reset(): void;
     /**
-     * Start recording user interactions
+     * Get the current distinct ID
      */
-    private startRecording;
+    getDistinctId(): string;
     /**
-     * Start batching events for transmission
+     * Register super properties to be sent with every event
      */
-    private startBatching;
+    register(properties: Record<string, unknown>): void;
     /**
-     * Add an event to the events array
+     * Register super properties only if they haven't been set
      */
-    private addEvent;
+    registerOnce(properties: Record<string, unknown>): void;
     /**
-     * Send batched events to the API with exponential backoff retry
+     * Remove a super property
      */
-    private sendBatch;
+    unregister(propertyName: string): void;
     /**
-     * Schedule retry attempts for failed events
+     * Capture an event
      */
-    private scheduleRetry;
+    capture(eventName: string, properties?: Record<string, unknown>): void;
     /**
-     * Internal method to stop recording without logging (used during re-init)
+     * Track a custom event (legacy method, delegates to capture)
      */
-    private stopRecordingInternal;
+    trackCustomEvent(eventName: string, data?: Record<string, unknown>): void;
+    /**
+     * Opt out of tracking
+     */
+    opt_out_capturing(): void;
+    /**
+     * Opt back into tracking
+     */
+    opt_in_capturing(): void;
+    /**
+     * Check if user has opted out
+     */
+    has_opted_out_capturing(): boolean;
+    /**
+     * Check if user has opted in (not opted out)
+     */
+    has_opted_in_capturing(): boolean;
+    /**
+     * Start network request monitoring
+     */
+    startNetworkCapture(): void;
+    /**
+     * Stop network request monitoring
+     */
+    stopNetworkCapture(): void;
+    /**
+     * Start storage monitoring
+     */
+    startStorageCapture(): void;
+    /**
+     * Stop storage monitoring
+     */
+    stopStorageCapture(): void;
+    /**
+     * Start console monitoring
+     */
+    startConsoleCapture(): void;
+    /**
+     * Stop console monitoring
+     */
+    stopConsoleCapture(): void;
+    /**
+     * Get network logs
+     */
+    getNetworkLogs(): NetworkLog[];
+    /**
+     * Get storage logs
+     */
+    getStorageLogs(): StorageLog[];
+    /**
+     * Get console logs
+     */
+    getConsoleLogs(): ConsoleLog[];
     /**
      * Stop recording and clean up resources
      */
@@ -92,12 +246,19 @@ export declare class BentoLabsSDK {
      * Manually trigger a batch send
      */
     flushEvents(): Promise<void>;
-    /**
-     * Track a custom event with custom data
-     * @param eventName - Name of the custom event
-     * @param data - Custom event data (will be JSON stringified)
-     */
-    trackCustomEvent(eventName: string, data?: Record<string, any>): void;
+    private generateSessionId;
+    private generateAnonymousId;
+    private generateUUID;
+    private isDNTEnabled;
+    private loadPersistedState;
+    private startRecording;
+    private startBatching;
+    private addEvent;
+    private sendBatch;
+    private scheduleRetry;
+    private stopRecordingInternal;
+    private setupAutocapture;
+    private handlePageLeave;
 }
 declare const sdk: BentoLabsSDK;
 export default sdk;