@statsig/web-analytics 3.0.0 → 3.2.0-beta.1

package/package.json

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

package/src/AutoCapture.d.ts

@@ -1,4 +1,8 @@
-import { PrecomputedEvaluationsInterface } from '@statsig/client-core';
+import { PrecomputedEvaluationsInterface, StatsigPlugin } from '@statsig/client-core';
+export declare class StatsigAutoCapturePlugin implements StatsigPlugin<PrecomputedEvaluationsInterface> {
+    readonly __plugin = "auto-capture";
+    bind(client: PrecomputedEvaluationsInterface): void;
+}
 export declare function runStatsigAutoCapture(client: PrecomputedEvaluationsInterface): AutoCapture;
 export declare class AutoCapture {
     private _client;
@@ -6,13 +10,15 @@ export declare class AutoCapture {
     private _startTime;
     private _deepestScroll;
     private _disabledEvents;
+    private _previousLoggedPageViewUrl;
     constructor(_client: PrecomputedEvaluationsInterface);
     private _addEventHandlers;
+    private _addPageViewTracking;
     private _autoLogEvent;
     private _initialize;
     private _logError;
     private _logSessionStart;
-    private _logPageView;
+    private _tryLogPageView;
     private _logPerformance;
     private _pageUnloadHandler;
     private _enqueueAutoCapture;

package/src/AutoCapture.js

@@ -1,9 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AutoCapture = exports.runStatsigAutoCapture = void 0;
+exports.AutoCapture = exports.runStatsigAutoCapture = exports.StatsigAutoCapturePlugin = void 0;
 const client_core_1 = require("@statsig/client-core");
 const Utils_1 = require("./Utils");
 const payloadUtils_1 = require("./payloadUtils");
+class StatsigAutoCapturePlugin {
+    constructor() {
+        this.__plugin = 'auto-capture';
+    }
+    bind(client) {
+        runStatsigAutoCapture(client);
+    }
+}
+exports.StatsigAutoCapturePlugin = StatsigAutoCapturePlugin;
 function runStatsigAutoCapture(client) {
     return new AutoCapture(client);
 }
@@ -15,6 +24,7 @@ class AutoCapture {
         this._startTime = Date.now();
         this._deepestScroll = 0;
         this._disabledEvents = {};
+        this._previousLoggedPageViewUrl = 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;
@@ -47,6 +57,21 @@ class AutoCapture {
         (0, Utils_1._registerEventHandler)(win, 'beforeunload', () => this._pageUnloadHandler());
         (0, Utils_1._registerEventHandler)(win, 'scroll', () => this._scrollEventHandler());
     }
+    _addPageViewTracking() {
+        const win = (0, client_core_1._getWindowSafe)();
+        const doc = (0, client_core_1._getDocumentSafe)();
+        if (!win || !doc) {
+            return;
+        }
+        (0, Utils_1._registerEventHandler)(win, 'popstate', () => this._tryLogPageView());
+        window.history.pushState = new Proxy(window.history.pushState, {
+            apply: (target, thisArg, [state, unused, url]) => {
+                target.apply(thisArg, [state, unused, url]);
+                this._tryLogPageView();
+            },
+        });
+        this._tryLogPageView();
+    }
     _autoLogEvent(event) {
         var _a;
         let eventType = (_a = event.type) === null || _a === void 0 ? void 0 : _a.toLowerCase();
@@ -69,8 +94,8 @@ class AutoCapture {
     }
     _initialize() {
         this._addEventHandlers();
+        this._addPageViewTracking();
         this._logSessionStart();
-        this._logPageView();
         this._logPerformance();
     }
     _logError(event) {
@@ -107,15 +132,18 @@ class AutoCapture {
             this._errorBoundary.logError('AC::logSession', err);
         }
     }
-    _logPageView() {
-        setTimeout(() => {
-            const url = (0, Utils_1._getSafeUrl)();
-            const payload = (0, payloadUtils_1._gatherPageViewPayload)(url);
-            this._enqueueAutoCapture('page_view', (0, Utils_1._getSanitizedPageUrl)(), payload, {
-                flushImmediately: true,
-                addNewSessionMetadata: true,
-            });
-        }, 1);
+    _tryLogPageView() {
+        const url = (0, Utils_1._getSafeUrl)();
+        const last = this._previousLoggedPageViewUrl;
+        if (last && url.href === last.href) {
+            return;
+        }
+        this._previousLoggedPageViewUrl = url;
+        const payload = (0, payloadUtils_1._gatherPageViewPayload)(url);
+        this._enqueueAutoCapture('page_view', (0, Utils_1._getSanitizedPageUrl)(), payload, {
+            flushImmediately: true,
+            addNewSessionMetadata: true,
+        });
     }
     _logPerformance() {
         const win = (0, client_core_1._getWindowSafe)();

package/src/index.d.ts

@@ -1,3 +1,3 @@
-import { AutoCapture, runStatsigAutoCapture } from './AutoCapture';
-export { AutoCapture, runStatsigAutoCapture };
+import { AutoCapture, StatsigAutoCapturePlugin, runStatsigAutoCapture } from './AutoCapture';
+export { AutoCapture, runStatsigAutoCapture, StatsigAutoCapturePlugin };
 export default __STATSIG__;

package/src/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.runStatsigAutoCapture = exports.AutoCapture = void 0;
+exports.StatsigAutoCapturePlugin = exports.runStatsigAutoCapture = exports.AutoCapture = void 0;
 const AutoCapture_1 = require("./AutoCapture");
 Object.defineProperty(exports, "AutoCapture", { enumerable: true, get: function () { return AutoCapture_1.AutoCapture; } });
+Object.defineProperty(exports, "StatsigAutoCapturePlugin", { enumerable: true, get: function () { return AutoCapture_1.StatsigAutoCapturePlugin; } });
 Object.defineProperty(exports, "runStatsigAutoCapture", { enumerable: true, get: function () { return AutoCapture_1.runStatsigAutoCapture; } });
 __STATSIG__ = Object.assign(Object.assign({}, (__STATSIG__ !== null && __STATSIG__ !== void 0 ? __STATSIG__ : {})), { AutoCapture: AutoCapture_1.AutoCapture,
-    runStatsigAutoCapture: AutoCapture_1.runStatsigAutoCapture });
+    runStatsigAutoCapture: AutoCapture_1.runStatsigAutoCapture,
+    StatsigAutoCapturePlugin: AutoCapture_1.StatsigAutoCapturePlugin });
 exports.default = __STATSIG__;