@statsig/web-analytics 0.0.1-beta.41 → 1.0.0

package/package.json

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

package/src/AutoCapture.d.ts

@@ -1,5 +1,5 @@
 import { StatsigClient } from '@statsig/js-client';
-export declare function runStatsigAutoCapture(client: StatsigClient): void;
+export declare function runStatsigAutoCapture(client: StatsigClient): AutoCapture;
 export declare class AutoCapture {
     private _client;
     private _errorBoundary;

package/src/AutoCapture.js

@@ -12,8 +12,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AutoCapture = exports.runStatsigAutoCapture = void 0;
 const client_core_1 = require("@statsig/client-core");
 const Utils_1 = require("./Utils");
+const payloadUtils_1 = require("./payloadUtils");
 function runStatsigAutoCapture(client) {
-    new AutoCapture(client);
+    return new AutoCapture(client);
 }
 exports.runStatsigAutoCapture = runStatsigAutoCapture;
 class AutoCapture {
@@ -102,13 +103,12 @@ class AutoCapture {
     }
     _logPageView() {
         setTimeout(() => {
-            var _a, _b;
             const url = (0, Utils_1._getSafeUrl)();
-            this._enqueueAutoCapture('page_view', (0, Utils_1._getSanitizedPageUrl)(), {
-                title: (_a = (0, client_core_1._getDocumentSafe)()) === null || _a === void 0 ? void 0 : _a.title,
-                queryParams: Object.fromEntries(url.searchParams),
-                referrer: ((_b = (0, client_core_1._getDocumentSafe)()) === null || _b === void 0 ? void 0 : _b.referrer) || '',
-            }, { flushImmediately: true, addNewSessionMetadata: true });
+            const payload = (0, payloadUtils_1._gatherPageViewPayload)(url);
+            this._enqueueAutoCapture('page_view', (0, Utils_1._getSanitizedPageUrl)(), payload, {
+                flushImmediately: true,
+                addNewSessionMetadata: true,
+            });
         }, 1);
     }
     _logPerformance() {

package/src/payloadUtils.d.ts

@@ -0,0 +1 @@
+export declare function _gatherPageViewPayload(url: URL): Record<string, string | number>;

package/src/payloadUtils.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._gatherPageViewPayload = void 0;
+const client_core_1 = require("@statsig/client-core");
+function _gatherPageViewPayload(url) {
+    var _a, _b;
+    const safeDoc = (0, client_core_1._getDocumentSafe)();
+    const safeWnd = (0, client_core_1._getWindowSafe)();
+    if (!safeDoc || !safeWnd) {
+        return {};
+    }
+    const navigator = safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.navigator;
+    const referrer = (safeDoc === null || safeDoc === void 0 ? void 0 : safeDoc.referrer) || '';
+    let refUrl = new URL('empty:');
+    if (referrer) {
+        try {
+            refUrl = new URL(referrer || 'empty:');
+        }
+        catch (e) {
+            /* empty */
+        }
+    }
+    const searchInfo = getSearchInfo(refUrl);
+    const campaignParams = getCampaignParams(url);
+    const queryParams = {};
+    url.searchParams.forEach((v, k) => {
+        queryParams[k] = v;
+    });
+    return Object.assign(Object.assign(Object.assign(Object.assign({}, searchInfo), campaignParams), queryParams), { title: (safeDoc === null || safeDoc === void 0 ? void 0 : safeDoc.title) || '', locale: (navigator === null || navigator === void 0 ? void 0 : navigator.language) || 'unknown', referrer, screen_width: ((_a = safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.screen) === null || _a === void 0 ? void 0 : _a.width) || 'unknown', screen_height: ((_b = safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.screen) === null || _b === void 0 ? void 0 : _b.height) || 'unknown', viewport_width: (safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.innerWidth) || 'unknown', viewport_height: (safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.innerHeight) || 'unknown' });
+}
+exports._gatherPageViewPayload = _gatherPageViewPayload;
+function getCampaignParams(url) {
+    const urlParams = url.searchParams;
+    const campaignParams = {};
+    const commonUtms = [
+        'utm_source',
+        'utm_medium',
+        'utm_campaign',
+        'utm_term',
+        'utm_content',
+        'gclid', // Google
+        'gclsrc', // Google
+        'dclid', // DoubleClick
+        'fbclid', // Facebook
+        'msclkid', // Bing
+        'mc_eid', // Mailchimp
+        'mc_cid', // Mailchimp
+        'twclid', // Twitter
+        'li_fat_id', // LinkedIn
+        'igshid', // Instagram
+        'utm_id', // Hubspot
+        'ttc', // TikTok
+        'ttclid', // TikTok
+        'ttc_id', // TikTok
+    ];
+    commonUtms.forEach((p) => {
+        const val = urlParams.get(p);
+        if (val) {
+            campaignParams[p] = val;
+        }
+    });
+    return campaignParams;
+}
+function getSearchEngine(refUrl) {
+    const host = refUrl.hostname;
+    const engine = ['google', 'bing', 'yahoo', 'duckduckgo', 'baidu'].find((e) => host.includes(e + '.'));
+    return engine || '';
+}
+function getSearchInfo(refUrl) {
+    const searchEngine = getSearchEngine(refUrl);
+    const searchQuery = refUrl.searchParams.get(searchEngine === 'yahoo' ? 'p' : 'q') || '';
+    return { searchEngine, searchQuery };
+}