@bugspotter/sdk 2.0.5 → 2.1.0

package/dist/collectors/dom.d.ts

@@ -20,6 +20,10 @@ export interface DOMCollectorConfig {
     recordCanvas?: boolean;
     /** Whether to record cross-origin iframes (default: false) */
     recordCrossOriginIframes?: boolean;
+    /** CSS selectors for elements to block from recording */
+    blockSelectors?: string[];
+    /** CSS class name to block elements from recording */
+    blockClass?: string;
     /** Sanitizer for PII protection */
     sanitizer?: Sanitizer;
 }

package/dist/collectors/dom.js

@@ -26,6 +26,8 @@ class DOMCollector {
             collectFonts: (_h = config.collectFonts) !== null && _h !== void 0 ? _h : false,
             recordCanvas: (_j = config.recordCanvas) !== null && _j !== void 0 ? _j : false,
             recordCrossOriginIframes: (_k = config.recordCrossOriginIframes) !== null && _k !== void 0 ? _k : false,
+            blockSelectors: config.blockSelectors,
+            blockClass: config.blockClass,
             sanitizer: config.sanitizer,
         };
         this.buffer = new buffer_1.CircularBuffer({
@@ -36,30 +38,26 @@ class DOMCollector {
      * Start recording DOM events
      */
     startRecording() {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         if (this.isRecording) {
             (0, logger_1.getLogger)().warn('DOMCollector: Recording already in progress');
             return;
         }
         try {
-            const recordConfig = {
-                emit: (event) => {
+            const recordConfig = Object.assign(Object.assign({ emit: (event) => {
                     this.buffer.add(event);
-                },
-                sampling: {
+                }, sampling: {
                     mousemove: (_b = (_a = this.config.sampling) === null || _a === void 0 ? void 0 : _a.mousemove) !== null && _b !== void 0 ? _b : 50,
                     scroll: (_d = (_c = this.config.sampling) === null || _c === void 0 ? void 0 : _c.scroll) !== null && _d !== void 0 ? _d : 100,
                     // Record all mouse interactions for replay visibility
                     mouseInteraction: true,
-                },
-                recordCanvas: this.config.recordCanvas,
-                recordCrossOriginIframes: this.config.recordCrossOriginIframes,
+                }, recordCanvas: this.config.recordCanvas, recordCrossOriginIframes: this.config.recordCrossOriginIframes, 
                 // PII sanitization for text content
                 maskTextFn: this.sanitizer
                     ? (text, element) => {
                         return this.sanitizer.sanitizeTextNode(text, element);
                     }
-                    : undefined,
+                    : undefined, 
                 // Performance optimizations
                 slimDOMOptions: {
                     script: true, // Don't record script tags
@@ -71,12 +69,13 @@ class DOMCollector {
                     headMetaHttpEquiv: true, // Don't record http-equiv meta tags
                     headMetaAuthorship: true, // Don't record authorship meta tags
                     headMetaVerification: true, // Don't record verification meta tags
-                },
+                }, 
                 // Quality settings (controlled by backend or user config)
-                inlineStylesheet: this.config.inlineStylesheet,
-                inlineImages: this.config.inlineImages,
-                collectFonts: this.config.collectFonts,
-            };
+                inlineStylesheet: this.config.inlineStylesheet, inlineImages: this.config.inlineImages, collectFonts: this.config.collectFonts }, (((_e = this.config.blockSelectors) === null || _e === void 0 ? void 0 : _e.length) && {
+                blockSelector: this.config.blockSelectors.join(','),
+            })), (this.config.blockClass && {
+                blockClass: this.config.blockClass,
+            }));
             this.stopRecordingFn = (0, rrweb_1.record)(recordConfig);
             this.isRecording = true;
             (0, logger_1.getLogger)().debug('DOMCollector: Started recording');

package/dist/core/capture-manager.d.ts

@@ -22,6 +22,8 @@ export interface CaptureManagerConfig {
         collectFonts?: boolean;
         recordCanvas?: boolean;
         recordCrossOriginIframes?: boolean;
+        blockSelectors?: string[];
+        blockClass?: string;
     };
 }
 /**

package/dist/core/capture-manager.js

@@ -17,7 +17,7 @@ const constants_1 = require("../constants");
  */
 class CaptureManager {
     constructor(config) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
         // Initialize core capture modules
         this.screenshot = new screenshot_1.ScreenshotCapture();
         this.console = new console_1.ConsoleCapture({ sanitizer: config.sanitizer });
@@ -42,6 +42,8 @@ class CaptureManager {
                 collectFonts: (_h = config.replay) === null || _h === void 0 ? void 0 : _h.collectFonts,
                 recordCanvas: (_j = config.replay) === null || _j === void 0 ? void 0 : _j.recordCanvas,
                 recordCrossOriginIframes: (_k = config.replay) === null || _k === void 0 ? void 0 : _k.recordCrossOriginIframes,
+                blockSelectors: (_l = config.replay) === null || _l === void 0 ? void 0 : _l.blockSelectors,
+                blockClass: (_m = config.replay) === null || _m === void 0 ? void 0 : _m.blockClass,
                 sanitizer: config.sanitizer,
             });
             this.domCollector.startRecording();

package/dist/index.d.ts

@@ -12,9 +12,10 @@ export declare class BugSpotter {
     private config;
     private widget?;
     private sanitizer?;
-    private captureManager;
+    private captureManager?;
     private bugReporter;
-    constructor(config: BugSpotterConfig);
+    private _sampled;
+    constructor(config: BugSpotterConfig, sampled?: boolean);
     static init(config: BugSpotterConfig): Promise<BugSpotter>;
     /**
      * Internal factory method to create a new BugSpotter instance
@@ -27,6 +28,8 @@ export declare class BugSpotter {
      * Note: Screenshot is captured for modal preview only (_screenshotPreview)
      * File uploads use presigned URLs returned from the backend
      */
+    /** Whether this session was sampled for capture */
+    get isSampled(): boolean;
     capture(): Promise<BugReport>;
     private handleBugReport;
     /**
@@ -43,6 +46,13 @@ export interface BugSpotterConfig {
     endpoint?: string;
     /** API key for authentication (starts with 'bgs_'). Required. */
     apiKey: string;
+    /**
+     * Session sampling rate (0 to 1). Controls what fraction of sessions activate capture.
+     * - 1 = capture all sessions (default)
+     * - 0.1 = capture 10% of sessions
+     * - 0 = capture nothing (SDK initializes but is inactive)
+     */
+    sampleRate?: number;
     showWidget?: boolean;
     widgetOptions?: FloatingButtonOptions;
     /** Retry configuration for failed requests */
@@ -74,6 +84,19 @@ export interface BugSpotterConfig {
         recordCanvas?: boolean;
         /** Whether to record cross-origin iframes (default: backend controlled) */
         recordCrossOriginIframes?: boolean;
+        /**
+         * CSS selectors for DOM elements to exclude from session replay.
+         * Matched elements are replaced with a placeholder in the recording.
+         * Use for sensitive content that isn't PII (e.g., financial data, portfolios).
+         * Example: ['.portfolio-table', '#balance-widget', '[data-sensitive]']
+         */
+        blockSelectors?: string[];
+        /**
+         * CSS class name to mark elements for blocking. Any element with this class
+         * will be excluded from replay. Alternative to blockSelectors.
+         * Example: 'bugspotter-block'
+         */
+        blockClass?: string;
     };
     sanitize?: {
         /** Enable PII sanitization (default: true) */
@@ -83,7 +106,7 @@ export interface BugSpotterConfig {
          * - Can be a preset name: 'all', 'minimal', 'financial', 'contact', 'gdpr', 'pci', etc.
          * - Or an array of pattern names: ['email', 'phone', 'ip']
          */
-        patterns?: 'all' | 'minimal' | 'financial' | 'contact' | 'identification' | 'kazakhstan' | 'gdpr' | 'pci' | Array<'email' | 'phone' | 'creditcard' | 'ssn' | 'iin' | 'ip' | 'custom'>;
+        patterns?: 'all' | 'minimal' | 'financial' | 'contact' | 'identification' | 'credentials' | 'kazakhstan' | 'gdpr' | 'pci' | Array<'email' | 'phone' | 'creditcard' | 'ssn' | 'iin' | 'ip' | 'apikey' | 'token' | 'password' | 'custom'>;
         /** Custom regex patterns for PII detection */
         customPatterns?: Array<{
             name: string;

package/dist/index.esm.js

@@ -2344,6 +2344,7 @@ class StringSanitizer {
 class ValueSanitizer {
     constructor(stringSanitizer) {
         this.stringSanitizer = stringSanitizer;
+        this.seen = new WeakSet();
     }
     sanitize(value) {
         // Handle null/undefined
@@ -2354,26 +2355,40 @@ class ValueSanitizer {
         if (typeof value === 'string') {
             return this.stringSanitizer.sanitize(value);
         }
-        // Handle arrays
+        // Handle arrays (with circular reference protection)
         if (Array.isArray(value)) {
-            return value.map((item) => {
-                return this.sanitize(item);
-            });
+            if (this.seen.has(value))
+                return '[Circular]';
+            this.seen.add(value);
+            try {
+                return value.map((item) => this.sanitize(item));
+            }
+            finally {
+                this.seen.delete(value);
+            }
         }
-        // Handle objects
+        // Handle objects (with circular reference protection)
         if (typeof value === 'object') {
+            if (this.seen.has(value))
+                return '[Circular]';
             return this.sanitizeObject(value);
         }
         // Return primitives as-is
         return value;
     }
     sanitizeObject(obj) {
-        const sanitized = {};
-        for (const [key, val] of Object.entries(obj)) {
-            const sanitizedKey = this.stringSanitizer.sanitize(key);
-            sanitized[sanitizedKey] = this.sanitize(val);
+        this.seen.add(obj);
+        try {
+            const sanitized = {};
+            for (const [key, val] of Object.entries(obj)) {
+                const sanitizedKey = this.stringSanitizer.sanitize(key);
+                sanitized[sanitizedKey] = this.sanitize(val);
+            }
+            return sanitized;
+        }
+        finally {
+            this.seen.delete(obj);
         }
-        return sanitized;
     }
 }
 /**
@@ -2944,7 +2959,7 @@ const MAX_RECOMMENDED_REPLAY_DURATION_SECONDS = 30;
  * This file is automatically generated during the build process.
  * To update the version, modify package.json
  */
-const VERSION = '2.0.5';
+const VERSION = '2.1.0';
 
 /**
  * Configuration Validation Utilities
@@ -15451,6 +15466,8 @@ class DOMCollector {
             collectFonts: (_h = config.collectFonts) !== null && _h !== void 0 ? _h : false,
             recordCanvas: (_j = config.recordCanvas) !== null && _j !== void 0 ? _j : false,
             recordCrossOriginIframes: (_k = config.recordCrossOriginIframes) !== null && _k !== void 0 ? _k : false,
+            blockSelectors: config.blockSelectors,
+            blockClass: config.blockClass,
             sanitizer: config.sanitizer,
         };
         this.buffer = new CircularBuffer({
@@ -15461,30 +15478,26 @@ class DOMCollector {
      * Start recording DOM events
      */
     startRecording() {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         if (this.isRecording) {
             getLogger().warn('DOMCollector: Recording already in progress');
             return;
         }
         try {
-            const recordConfig = {
-                emit: (event) => {
+            const recordConfig = Object.assign(Object.assign({ emit: (event) => {
                     this.buffer.add(event);
-                },
-                sampling: {
+                }, sampling: {
                     mousemove: (_b = (_a = this.config.sampling) === null || _a === void 0 ? void 0 : _a.mousemove) !== null && _b !== void 0 ? _b : 50,
                     scroll: (_d = (_c = this.config.sampling) === null || _c === void 0 ? void 0 : _c.scroll) !== null && _d !== void 0 ? _d : 100,
                     // Record all mouse interactions for replay visibility
                     mouseInteraction: true,
-                },
-                recordCanvas: this.config.recordCanvas,
-                recordCrossOriginIframes: this.config.recordCrossOriginIframes,
+                }, recordCanvas: this.config.recordCanvas, recordCrossOriginIframes: this.config.recordCrossOriginIframes, 
                 // PII sanitization for text content
                 maskTextFn: this.sanitizer
                     ? (text, element) => {
                         return this.sanitizer.sanitizeTextNode(text, element);
                     }
-                    : undefined,
+                    : undefined, 
                 // Performance optimizations
                 slimDOMOptions: {
                     script: true, // Don't record script tags
@@ -15496,12 +15509,13 @@ class DOMCollector {
                     headMetaHttpEquiv: true, // Don't record http-equiv meta tags
                     headMetaAuthorship: true, // Don't record authorship meta tags
                     headMetaVerification: true, // Don't record verification meta tags
-                },
+                }, 
                 // Quality settings (controlled by backend or user config)
-                inlineStylesheet: this.config.inlineStylesheet,
-                inlineImages: this.config.inlineImages,
-                collectFonts: this.config.collectFonts,
-            };
+                inlineStylesheet: this.config.inlineStylesheet, inlineImages: this.config.inlineImages, collectFonts: this.config.collectFonts }, (((_e = this.config.blockSelectors) === null || _e === void 0 ? void 0 : _e.length) && {
+                blockSelector: this.config.blockSelectors.join(','),
+            })), (this.config.blockClass && {
+                blockClass: this.config.blockClass,
+            }));
             this.stopRecordingFn = record(recordConfig);
             this.isRecording = true;
             getLogger().debug('DOMCollector: Started recording');
@@ -15591,7 +15605,7 @@ class DOMCollector {
  */
 class CaptureManager {
     constructor(config) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
         // Initialize core capture modules
         this.screenshot = new ScreenshotCapture();
         this.console = new ConsoleCapture({ sanitizer: config.sanitizer });
@@ -15616,6 +15630,8 @@ class CaptureManager {
                 collectFonts: (_h = config.replay) === null || _h === void 0 ? void 0 : _h.collectFonts,
                 recordCanvas: (_j = config.replay) === null || _j === void 0 ? void 0 : _j.recordCanvas,
                 recordCrossOriginIframes: (_k = config.replay) === null || _k === void 0 ? void 0 : _k.recordCrossOriginIframes,
+                blockSelectors: (_l = config.replay) === null || _l === void 0 ? void 0 : _l.blockSelectors,
+                blockClass: (_m = config.replay) === null || _m === void 0 ? void 0 : _m.blockClass,
                 sanitizer: config.sanitizer,
             });
             this.domCollector.startRecording();
@@ -17220,13 +17236,20 @@ function fetchReplaySettings(endpoint, apiKey) {
     });
 }
 class BugSpotter {
-    constructor(config) {
+    constructor(config, sampled = true) {
         var _a, _b, _c, _d, _e, _f;
         // Validate deduplication configuration if provided
         if (config.deduplication) {
             validateDeduplicationConfig(config.deduplication);
         }
         this.config = config;
+        this._sampled = sampled;
+        this.bugReporter = new BugReporter(config);
+        // If not sampled, skip all capture initialization — true zero overhead
+        // No console/network interception, no DOM recording, no widget
+        if (!sampled) {
+            return;
+        }
         // Initialize sanitizer (enabled by default)
         const sanitizeEnabled = (_b = (_a = config.sanitize) === null || _a === void 0 ? void 0 : _a.enabled) !== null && _b !== void 0 ? _b : true;
         if (sanitizeEnabled) {
@@ -17239,8 +17262,6 @@ class BugSpotter {
         }
         // Initialize capture manager
         this.captureManager = new CaptureManager(Object.assign(Object.assign({ sanitizer: this.sanitizer }, (config.endpoint && { apiEndpoint: getApiBaseUrl(config.endpoint) })), { replay: config.replay }));
-        // Initialize bug reporter
-        this.bugReporter = new BugReporter(config);
         // Initialize widget (enabled by default)
         const widgetEnabled = (_f = config.showWidget) !== null && _f !== void 0 ? _f : true;
         if (widgetEnabled) {
@@ -17282,6 +17303,19 @@ class BugSpotter {
     static createInstance(config) {
         return __awaiter$1(this, void 0, void 0, function* () {
             var _a, _b;
+            // Check sampling rate — if this session is not sampled, disable all capture
+            if (config.sampleRate !== undefined) {
+                if (typeof config.sampleRate !== 'number' ||
+                    !Number.isFinite(config.sampleRate) ||
+                    config.sampleRate < 0 ||
+                    config.sampleRate > 1) {
+                    throw new Error('sampleRate must be a finite number between 0 and 1');
+                }
+                if (Math.random() >= config.sampleRate) {
+                    // Create a lightweight no-op instance — zero overhead (no console/network interception)
+                    return new BugSpotter(config, /* sampled */ false);
+                }
+            }
             // Fetch replay quality settings from backend if replay is enabled
             let backendSettings = null;
             const replayEnabled = (_b = (_a = config.replay) === null || _a === void 0 ? void 0 : _a.enabled) !== null && _b !== void 0 ? _b : true;
@@ -17310,8 +17344,29 @@ class BugSpotter {
      * Note: Screenshot is captured for modal preview only (_screenshotPreview)
      * File uploads use presigned URLs returned from the backend
      */
+    /** Whether this session was sampled for capture */
+    get isSampled() {
+        return this._sampled;
+    }
     capture() {
         return __awaiter$1(this, void 0, void 0, function* () {
+            if (!this.captureManager) {
+                // Unsampled session — return minimal valid report
+                return {
+                    console: [],
+                    network: [],
+                    metadata: {
+                        userAgent: typeof navigator !== 'undefined' ? navigator.userAgent : '',
+                        url: typeof window !== 'undefined' ? window.location.href : '',
+                        timestamp: Date.now(),
+                        viewport: typeof window !== 'undefined'
+                            ? { width: window.innerWidth, height: window.innerHeight }
+                            : { width: 0, height: 0 },
+                        browser: 'unknown',
+                        os: 'unknown',
+                    },
+                };
+            }
             return yield this.captureManager.captureAll();
         });
     }
@@ -17355,9 +17410,9 @@ class BugSpotter {
         return Object.assign({}, this.config);
     }
     destroy() {
-        var _a;
-        this.captureManager.destroy();
-        (_a = this.widget) === null || _a === void 0 ? void 0 : _a.destroy();
+        var _a, _b;
+        (_a = this.captureManager) === null || _a === void 0 ? void 0 : _a.destroy();
+        (_b = this.widget) === null || _b === void 0 ? void 0 : _b.destroy();
         this.bugReporter.destroy();
         BugSpotter.instance = undefined;
         BugSpotter.initPromise = undefined;