@statsig/web-analytics 3.9.1 → 3.11.0

package/package.json

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

package/src/AutoCapture.d.ts

@@ -19,10 +19,12 @@ export declare class AutoCapture {
     private _previousLoggedPageViewUrl;
     private _eventFilterFunc?;
     private _hasLoggedPageViewEnd;
+    private _inactiveTimer;
     constructor(_client: PrecomputedEvaluationsInterface, options?: AutoCaptureOptions);
     private _addEventHandlers;
     private _addPageViewTracking;
     private _autoLogEvent;
+    private _bumpInactiveTimer;
     private _initialize;
     private _logError;
     private _logSessionStart;

package/src/AutoCapture.js

@@ -5,6 +5,7 @@ const client_core_1 = require("@statsig/client-core");
 const AutoCaptureEvent_1 = require("./AutoCaptureEvent");
 const Utils_1 = require("./Utils");
 const payloadUtils_1 = require("./payloadUtils");
+const PAGE_INACTIVE_TIMEOUT = 600000;
 const AUTO_EVENT_MAPPING = {
     submit: AutoCaptureEvent_1.AutoCaptureEventName.FORM_SUBMIT,
     click: AutoCaptureEvent_1.AutoCaptureEventName.CLICK,
@@ -32,6 +33,7 @@ class AutoCapture {
         this._disabledEvents = {};
         this._previousLoggedPageViewUrl = null;
         this._hasLoggedPageViewEnd = false;
+        this._inactiveTimer = null;
         const { sdkKey, errorBoundary, values } = _client.getContext();
         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;
@@ -56,12 +58,15 @@ class AutoCapture {
         if (!win || !doc) {
             return;
         }
-        const eventHandler = (event) => {
+        const eventHandler = (event, userAction = true) => {
             this._autoLogEvent(event || win.event);
+            if (userAction) {
+                this._bumpInactiveTimer();
+            }
         };
-        (0, Utils_1._registerEventHandler)(doc, 'click', eventHandler);
-        (0, Utils_1._registerEventHandler)(doc, 'submit', eventHandler);
-        (0, Utils_1._registerEventHandler)(win, 'error', eventHandler);
+        (0, Utils_1._registerEventHandler)(doc, 'click', (e) => eventHandler(e));
+        (0, Utils_1._registerEventHandler)(doc, 'submit', (e) => eventHandler(e));
+        (0, Utils_1._registerEventHandler)(win, 'error', (e) => eventHandler(e, false));
         (0, Utils_1._registerEventHandler)(win, 'pagehide', () => this._tryLogPageViewEnd());
         (0, Utils_1._registerEventHandler)(win, 'beforeunload', () => this._tryLogPageViewEnd());
         (0, Utils_1._registerEventHandler)(win, 'scroll', () => this._scrollEventHandler());
@@ -102,6 +107,18 @@ class AutoCapture {
         const { value, metadata } = (0, Utils_1._gatherEventData)(target);
         this._enqueueAutoCapture(eventName, value, metadata);
     }
+    _bumpInactiveTimer() {
+        const win = (0, client_core_1._getWindowSafe)();
+        if (!win) {
+            return;
+        }
+        if (this._inactiveTimer) {
+            clearTimeout(this._inactiveTimer);
+        }
+        this._inactiveTimer = win.setTimeout(() => {
+            this._tryLogPageViewEnd(true);
+        }, PAGE_INACTIVE_TIMEOUT);
+    }
     _initialize() {
         this._addEventHandlers();
         this._addPageViewTracking();
@@ -155,8 +172,9 @@ class AutoCapture {
             flushImmediately: true,
             addNewSessionMetadata: true,
         });
+        this._bumpInactiveTimer();
     }
-    _tryLogPageViewEnd() {
+    _tryLogPageViewEnd(dueToInactivity = false) {
         if (this._hasLoggedPageViewEnd) {
             return;
         }
@@ -164,6 +182,7 @@ class AutoCapture {
         this._enqueueAutoCapture(AutoCaptureEvent_1.AutoCaptureEventName.PAGE_VIEW_END, (0, Utils_1._getSanitizedPageUrl)(), {
             scrollDepth: this._deepestScroll,
             pageViewLength: Date.now() - this._startTime,
+            dueToInactivity,
         }, { flushImmediately: true });
     }
     _logPerformance() {
@@ -240,6 +259,7 @@ class AutoCapture {
         const scrollY = (_c = win === null || win === void 0 ? void 0 : win.scrollY) !== null && _c !== void 0 ? _c : 1;
         const innerHeight = (_d = win === null || win === void 0 ? void 0 : win.innerHeight) !== null && _d !== void 0 ? _d : 1;
         this._deepestScroll = Math.max(this._deepestScroll, Math.min(100, Math.round(((scrollY + innerHeight) / scrollHeight) * 100)));
+        this._bumpInactiveTimer();
     }
     _isNewSession(session) {
         // within the last second