@statsig/web-analytics 3.20.3 → 3.20.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statsig/web-analytics",
-  "version": "3.20.3",
+  "version": "3.20.4",
   "license": "ISC",
   "homepage": "https://github.com/statsig-io/js-client-monorepo",
   "repository": {
@@ -9,8 +9,8 @@
     "directory": "packages/web-analytics"
   },
   "dependencies": {
-    "@statsig/client-core": "3.20.3",
-    "@statsig/js-client": "3.20.3",
+    "@statsig/client-core": "3.20.4",
+    "@statsig/js-client": "3.20.4",
     "web-vitals": "5.0.3"
   },
   "jsdelivr": "./build/statsig-web-analytics.min.js",

package/src/AutoCapture.js

@@ -13,6 +13,8 @@ const metadataUtils_1 = require("./utils/metadataUtils");
 const AUTO_EVENT_MAPPING = {
     submit: AutoCaptureEvent_1.AutoCaptureEventName.FORM_SUBMIT,
     click: AutoCaptureEvent_1.AutoCaptureEventName.CLICK,
+    copy: AutoCaptureEvent_1.AutoCaptureEventName.COPY,
+    cut: AutoCaptureEvent_1.AutoCaptureEventName.COPY,
 };
 class StatsigAutoCapturePlugin {
     constructor(_options) {
@@ -95,6 +97,8 @@ class AutoCapture {
         };
         (0, commonUtils_1._registerEventHandler)(doc, 'click', (e) => eventHandler(e));
         (0, commonUtils_1._registerEventHandler)(doc, 'submit', (e) => eventHandler(e));
+        (0, commonUtils_1._registerEventHandler)(doc, 'copy', (e) => eventHandler(e));
+        (0, commonUtils_1._registerEventHandler)(doc, 'cut', (e) => eventHandler(e));
         (0, commonUtils_1._registerEventHandler)(win, 'error', (e) => eventHandler(e, false));
         (0, commonUtils_1._registerEventHandler)(win, 'pagehide', () => this._tryLogPageViewEnd());
         (0, commonUtils_1._registerEventHandler)(win, 'beforeunload', () => this._tryLogPageViewEnd());
@@ -115,7 +119,7 @@ class AutoCapture {
         this._tryLogPageView();
     }
     _autoLogEvent(event) {
-        var _a;
+        var _a, _b, _c;
         const eventType = (_a = event.type) === null || _a === void 0 ? void 0 : _a.toLowerCase();
         if (eventType === 'error' && event instanceof ErrorEvent) {
             this._logError(event);
@@ -125,14 +129,26 @@ class AutoCapture {
         if (!target) {
             return;
         }
-        if (!(0, commonUtils_1._shouldLogEvent)(event, target)) {
-            return;
-        }
         const eventName = AUTO_EVENT_MAPPING[eventType];
         if (!eventName) {
             return;
         }
-        const { value, metadata } = (0, eventUtils_1._gatherEventData)(target);
+        const isCopyEvent = eventName === AutoCaptureEvent_1.AutoCaptureEventName.COPY;
+        if (!(0, commonUtils_1._shouldLogEvent)(event, target, isCopyEvent)) {
+            return;
+        }
+        const metadata = {};
+        if (isCopyEvent) {
+            const selectedText = (_c = (_b = (0, client_core_1._getWindowSafe)()) === null || _b === void 0 ? void 0 : _b.getSelection()) === null || _c === void 0 ? void 0 : _c.toString();
+            if (!selectedText) {
+                return;
+            }
+            metadata['selectedText'] = (0, commonUtils_1._sanitizeString)(selectedText);
+            const clipType = event.type || 'clipboard';
+            metadata['clipType'] = clipType;
+        }
+        const { value, metadata: eventMetadata } = (0, eventUtils_1._gatherEventData)(target);
+        Object.assign(metadata, eventMetadata);
         const allMetadata = (0, metadataUtils_1._gatherAllMetadata)((0, commonUtils_1._getSafeUrl)());
         this._enqueueAutoCapture(eventName, value, Object.assign(Object.assign({}, allMetadata), metadata));
     }

package/src/AutoCaptureEvent.d.ts

@@ -10,6 +10,7 @@ export declare const AutoCaptureEventName: {
     readonly RAGE_CLICK: "auto_capture::rage_click";
     readonly WEB_VITALS: "auto_capture::web_vitals";
     readonly DEAD_CLICK: "auto_capture::dead_click";
+    readonly COPY: "auto_capture::copy";
 };
 export type AutoCaptureEventName = (typeof AutoCaptureEventName)[keyof typeof AutoCaptureEventName] & string;
 export type AutoCaptureEvent = StatsigEvent & {

package/src/AutoCaptureEvent.js

@@ -12,4 +12,5 @@ exports.AutoCaptureEventName = {
     RAGE_CLICK: 'auto_capture::rage_click',
     WEB_VITALS: 'auto_capture::web_vitals',
     DEAD_CLICK: 'auto_capture::dead_click',
+    COPY: 'auto_capture::copy',
 };

package/src/utils/commonUtils.d.ts

@@ -7,7 +7,7 @@ interface NetworkInformation {
 export declare const interactiveElements: string[];
 export declare function _stripEmptyValues<T extends Record<string, string | number | null | undefined>>(obj: T): Partial<Record<keyof T, string | number>>;
 export declare function _getTargetNode(e: Event): Element | null;
-export declare function _shouldLogEvent(e: Event, el: Element): boolean;
+export declare function _shouldLogEvent(e: Event, el: Element, isCopyEvent?: boolean): boolean;
 export declare function _getSafeUrl(): URL;
 export declare function _getSafeUrlString(): string;
 export declare function _getSanitizedPageUrl(): string;
@@ -16,5 +16,6 @@ export declare function _getSafeNetworkInformation(): NetworkInformation | null;
 export declare function _getSafeTimezone(): string | null;
 export declare function _getSafeTimezoneOffset(): number | null;
 export declare function _getAnchorNodeInHierarchy(node: Element | null): Element | null;
+export declare function _sanitizeString(maybeString: string | null | undefined): string | null;
 export declare function throttle<T extends (...args: unknown[]) => void>(fn: T, limit: number): T;
 export {};

package/src/utils/commonUtils.js

@@ -1,7 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.throttle = exports._getAnchorNodeInHierarchy = exports._getSafeTimezoneOffset = exports._getSafeTimezone = exports._getSafeNetworkInformation = exports._registerEventHandler = exports._getSanitizedPageUrl = exports._getSafeUrlString = exports._getSafeUrl = exports._shouldLogEvent = exports._getTargetNode = exports._stripEmptyValues = exports.interactiveElements = void 0;
+exports.throttle = exports._sanitizeString = exports._getAnchorNodeInHierarchy = exports._getSafeTimezoneOffset = exports._getSafeTimezone = exports._getSafeNetworkInformation = exports._registerEventHandler = exports._getSanitizedPageUrl = exports._getSafeUrlString = exports._getSafeUrl = exports._shouldLogEvent = exports._getTargetNode = exports._stripEmptyValues = exports.interactiveElements = void 0;
 const client_core_1 = require("@statsig/client-core");
+const coreCCPattern = `(4[0-9]{12}(?:[0-9]{3})?)|(5[1-5][0-9]{14})|(6(?:011|5[0-9]{2})[0-9]{12})|(3[47][0-9]{13})|(3(?:0[0-5]|[68][0-9])[0-9]{11})|((?:2131|1800|35[0-9]{3})[0-9]{11})`;
+const CC_REGEX = new RegExp(`^(?:${coreCCPattern})$`);
+const coreSSNPattern = `\\d{3}-?\\d{2}-?\\d{4}`;
+const SSN_REGEX = new RegExp(`^(${coreSSNPattern})$`);
 exports.interactiveElements = [
     'button',
     'a',
@@ -30,7 +34,7 @@ function _getTargetNode(e) {
     return target;
 }
 exports._getTargetNode = _getTargetNode;
-function _shouldLogEvent(e, el) {
+function _shouldLogEvent(e, el, isCopyEvent = false) {
     if (!e || !el || el.nodeType !== 1) {
         return false;
     }
@@ -40,15 +44,19 @@ function _shouldLogEvent(e, el) {
     if (classList.contains('statsig-no-capture')) {
         return false;
     }
+    if (isCopyEvent) {
+        // We don't want to force strict event filtering for copy events
+        return true;
+    }
     switch (tagName) {
         case 'html':
             return false;
         case 'form':
-            return eventType === 'submit';
+            return ['submit'].indexOf(eventType) >= 0;
         case 'input':
         case 'select':
         case 'textarea':
-            return ['change'].includes(eventType);
+            return ['change', 'click'].indexOf(eventType) >= 0;
         default:
             if (eventType === 'click') {
                 if (tagName === 'button') {
@@ -143,6 +151,30 @@ function _getAnchorNodeInHierarchy(node) {
     return null;
 }
 exports._getAnchorNodeInHierarchy = _getAnchorNodeInHierarchy;
+function _sanitizeString(maybeString) {
+    if (!maybeString) {
+        return null;
+    }
+    return maybeString
+        .replace(/<[^>]*>/g, '')
+        .trim()
+        .split(/(\s+)/)
+        .filter((s) => _shouldCaptureTextValue(s))
+        .join('')
+        .replace(/[\r\n]/g, ' ')
+        .replace(/[ ]+/g, ' ')
+        .substring(0, 255);
+}
+exports._sanitizeString = _sanitizeString;
+function _shouldCaptureTextValue(text) {
+    if (CC_REGEX.test((text || '').replace(/[- ]/g, ''))) {
+        return false;
+    }
+    if (SSN_REGEX.test((text || '').replace(/[- ]/g, ''))) {
+        return false;
+    }
+    return true;
+}
 function throttle(fn, limit) {
     let lastCall = 0;
     return function (...args) {

package/src/utils/eventUtils.d.ts

@@ -2,4 +2,5 @@ export declare function _gatherEventData(target: Element): {
     value: string;
     metadata: Record<string, unknown>;
 };
+export declare function _gatherCopyEventData(e: Event): Record<string, unknown>;
 export declare function _getMetadataFromElement(target: Element): Record<string, unknown>;

package/src/utils/eventUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._getMetadataFromElement = exports._gatherEventData = void 0;
+exports._getMetadataFromElement = exports._gatherCopyEventData = exports._gatherEventData = void 0;
 const client_core_1 = require("@statsig/client-core");
 const commonUtils_1 = require("./commonUtils");
 const MAX_ATTRIBUTE_LENGTH = 1000;
@@ -30,6 +30,16 @@ function _gatherEventData(target) {
     return { value, metadata };
 }
 exports._gatherEventData = _gatherEventData;
+function _gatherCopyEventData(e) {
+    var _a, _b;
+    const selectedText = (_b = (_a = (0, client_core_1._getWindowSafe)()) === null || _a === void 0 ? void 0 : _a.getSelection()) === null || _b === void 0 ? void 0 : _b.toString();
+    const metadata = {};
+    metadata['selectedText'] = (0, commonUtils_1._sanitizeString)(selectedText);
+    const clipType = e.type || 'clipboard';
+    metadata['clipType'] = clipType;
+    return metadata;
+}
+exports._gatherCopyEventData = _gatherCopyEventData;
 function _getFormMetadata(target) {
     var _a;
     const metadata = {};