@statsig/web-analytics 3.5.0 → 3.6.0

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@statsig/web-analytics",
-  "version": "3.5.0",
+  "version": "3.6.0",
   "dependencies": {
-    "@statsig/client-core": "3.5.0",
-    "@statsig/js-client": "3.5.0"
+    "@statsig/client-core": "3.6.0",
+    "@statsig/js-client": "3.6.0"
   },
   "jsdelivr": "./build/statsig-web-analytics.min.js",
   "type": "commonjs",

package/src/AutoCapture.d.ts

@@ -1,9 +1,15 @@
 import { PrecomputedEvaluationsInterface, StatsigPlugin } from '@statsig/client-core';
+import { AutoCaptureEvent } from './AutoCaptureEvent';
+export type AutoCaptureOptions = {
+    eventFilterFunc?: (event: AutoCaptureEvent) => boolean;
+};
 export declare class StatsigAutoCapturePlugin implements StatsigPlugin<PrecomputedEvaluationsInterface> {
+    private _options?;
     readonly __plugin = "auto-capture";
+    constructor(_options?: AutoCaptureOptions | undefined);
     bind(client: PrecomputedEvaluationsInterface): void;
 }
-export declare function runStatsigAutoCapture(client: PrecomputedEvaluationsInterface): AutoCapture;
+export declare function runStatsigAutoCapture(client: PrecomputedEvaluationsInterface, options?: AutoCaptureOptions): AutoCapture;
 export declare class AutoCapture {
     private _client;
     private _errorBoundary;
@@ -11,7 +17,8 @@ export declare class AutoCapture {
     private _deepestScroll;
     private _disabledEvents;
     private _previousLoggedPageViewUrl;
-    constructor(_client: PrecomputedEvaluationsInterface);
+    private _eventFilterFunc?;
+    constructor(_client: PrecomputedEvaluationsInterface, options?: AutoCaptureOptions);
     private _addEventHandlers;
     private _addPageViewTracking;
     private _autoLogEvent;

package/src/AutoCapture.js

@@ -2,23 +2,29 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AutoCapture = exports.runStatsigAutoCapture = exports.StatsigAutoCapturePlugin = void 0;
 const client_core_1 = require("@statsig/client-core");
+const AutoCaptureEvent_1 = require("./AutoCaptureEvent");
 const Utils_1 = require("./Utils");
 const payloadUtils_1 = require("./payloadUtils");
+const AUTO_EVENT_MAPPING = {
+    submit: AutoCaptureEvent_1.AutoCaptureEventName.FORM_SUBMIT,
+    click: AutoCaptureEvent_1.AutoCaptureEventName.CLICK,
+};
 class StatsigAutoCapturePlugin {
-    constructor() {
+    constructor(_options) {
+        this._options = _options;
         this.__plugin = 'auto-capture';
     }
     bind(client) {
-        runStatsigAutoCapture(client);
+        runStatsigAutoCapture(client, this._options);
     }
 }
 exports.StatsigAutoCapturePlugin = StatsigAutoCapturePlugin;
-function runStatsigAutoCapture(client) {
-    return new AutoCapture(client);
+function runStatsigAutoCapture(client, options) {
+    return new AutoCapture(client, options);
 }
 exports.runStatsigAutoCapture = runStatsigAutoCapture;
 class AutoCapture {
-    constructor(_client) {
+    constructor(_client, options) {
         var _a, _b, _c;
         this._client = _client;
         this._startTime = Date.now();
@@ -29,6 +35,7 @@ class AutoCapture {
         this._disabledEvents = (_b = (_a = values === null || values === void 0 ? void 0 : values.auto_capture_settings) === null || _a === void 0 ? void 0 : _a.disabled_events) !== null && _b !== void 0 ? _b : {};
         this._errorBoundary = errorBoundary;
         this._errorBoundary.wrap(this);
+        this._eventFilterFunc = options === null || options === void 0 ? void 0 : options.eventFilterFunc;
         const doc = (0, client_core_1._getDocumentSafe)();
         if (!(0, client_core_1._isServerEnv)()) {
             __STATSIG__ = (0, client_core_1._getStatsigGlobal)();
@@ -74,7 +81,7 @@ class AutoCapture {
     }
     _autoLogEvent(event) {
         var _a;
-        let eventType = (_a = event.type) === null || _a === void 0 ? void 0 : _a.toLowerCase();
+        const eventType = (_a = event.type) === null || _a === void 0 ? void 0 : _a.toLowerCase();
         if (eventType === 'error' && event instanceof ErrorEvent) {
             this._logError(event);
             return;
@@ -86,11 +93,12 @@ class AutoCapture {
         if (!(0, Utils_1._shouldLogEvent)(event, target)) {
             return;
         }
-        if (eventType === 'submit') {
-            eventType = 'form_submit';
+        const eventName = AUTO_EVENT_MAPPING[eventType];
+        if (!eventName) {
+            return;
         }
         const { value, metadata } = (0, Utils_1._gatherEventData)(target);
-        this._enqueueAutoCapture(eventType, value, metadata);
+        this._enqueueAutoCapture(eventName, value, metadata);
     }
     _initialize() {
         this._addEventHandlers();
@@ -112,7 +120,7 @@ class AutoCapture {
                         : 'Unknown Error';
             }
         }
-        this._enqueueAutoCapture('error', event.message, {
+        this._enqueueAutoCapture(AutoCaptureEvent_1.AutoCaptureEventName.ERROR, event.message, {
             message: event.message,
             filename: event.filename,
             lineno: event.lineno,
@@ -126,7 +134,7 @@ class AutoCapture {
             if (!this._isNewSession(session)) {
                 return;
             }
-            this._enqueueAutoCapture('session_start', (0, Utils_1._getSanitizedPageUrl)(), { sessionID: session.data.sessionID }, { flushImmediately: true });
+            this._enqueueAutoCapture(AutoCaptureEvent_1.AutoCaptureEventName.SESSION_START, (0, Utils_1._getSanitizedPageUrl)(), { sessionID: session.data.sessionID }, { flushImmediately: true });
         }
         catch (err) {
             this._errorBoundary.logError('AC::logSession', err);
@@ -140,7 +148,7 @@ class AutoCapture {
         }
         this._previousLoggedPageViewUrl = url;
         const payload = (0, payloadUtils_1._gatherPageViewPayload)(url);
-        this._enqueueAutoCapture('page_view', (0, Utils_1._getSanitizedPageUrl)(), payload, {
+        this._enqueueAutoCapture(AutoCaptureEvent_1.AutoCaptureEventName.PAGE_VIEW, (0, Utils_1._getSanitizedPageUrl)(), payload, {
             flushImmediately: true,
             addNewSessionMetadata: true,
         });
@@ -178,18 +186,19 @@ class AutoCapture {
                 metadata['downlink_kbps'] = networkInfo.downlink;
                 metadata['save_data'] = networkInfo.saveData;
             }
-            this._enqueueAutoCapture('performance', (0, Utils_1._getSanitizedPageUrl)(), metadata);
+            this._enqueueAutoCapture(AutoCaptureEvent_1.AutoCaptureEventName.PERFORMANCE, (0, Utils_1._getSanitizedPageUrl)(), metadata);
         }, 1);
     }
     _pageUnloadHandler() {
-        this._enqueueAutoCapture('page_view_end', (0, Utils_1._getSanitizedPageUrl)(), {
+        this._enqueueAutoCapture(AutoCaptureEvent_1.AutoCaptureEventName.PAGE_VIEW_END, (0, Utils_1._getSanitizedPageUrl)(), {
             scrollDepth: this._deepestScroll,
             pageViewLength: Date.now() - this._startTime,
         }, { flushImmediately: true });
     }
-    _enqueueAutoCapture(name, value, metadata, options) {
+    _enqueueAutoCapture(eventName, value, metadata, options) {
         var _a, _b, _c;
-        if (this._disabledEvents[name]) {
+        const subname = eventName.slice('auto_capture::'.length);
+        if (this._disabledEvents[eventName] || this._disabledEvents[subname]) {
             return;
         }
         const session = this._getSessionFromClient();
@@ -199,10 +208,13 @@ class AutoCapture {
                 logMetadata['isNewSession'] = String(this._isNewSession(session));
             }
             const event = {
-                eventName: `auto_capture::${name}`,
+                eventName,
                 value,
                 metadata: logMetadata,
             };
+            if (this._eventFilterFunc && !this._eventFilterFunc(event)) {
+                return;
+            }
             this._client.logEvent(event);
             if (options === null || options === void 0 ? void 0 : options.flushImmediately) {
                 this._client.flush().catch((e) => {

package/src/AutoCaptureEvent.d.ts

@@ -0,0 +1,14 @@
+import { StatsigEvent } from '@statsig/client-core';
+export declare const AutoCaptureEventName: {
+    readonly PAGE_VIEW: "auto_capture::page_view";
+    readonly PAGE_VIEW_END: "auto_capture::page_view_end";
+    readonly ERROR: "auto_capture::error";
+    readonly SESSION_START: "auto_capture::session_start";
+    readonly PERFORMANCE: "auto_capture::performance";
+    readonly FORM_SUBMIT: "auto_capture::form_submit";
+    readonly CLICK: "auto_capture::click";
+};
+export type AutoCaptureEventName = (typeof AutoCaptureEventName)[keyof typeof AutoCaptureEventName] & string;
+export type AutoCaptureEvent = StatsigEvent & {
+    eventName: AutoCaptureEventName;
+};

package/src/AutoCaptureEvent.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutoCaptureEventName = void 0;
+exports.AutoCaptureEventName = {
+    PAGE_VIEW: 'auto_capture::page_view',
+    PAGE_VIEW_END: 'auto_capture::page_view_end',
+    ERROR: 'auto_capture::error',
+    SESSION_START: 'auto_capture::session_start',
+    PERFORMANCE: 'auto_capture::performance',
+    FORM_SUBMIT: 'auto_capture::form_submit',
+    CLICK: 'auto_capture::click',
+};