@brainfish-ai/web-tracker 0.0.22 → 0.0.24

package/dist/tracker.d.ts

@@ -2,7 +2,7 @@ declare global {
     interface Window {
         BrainfishAnalytics: {
             q?: [string, ...any[]];
-            (method: string, ...args: any[]): void;
+            (method: string, ...args: any[]): any;
         };
     }
 }

package/dist/tracker.es.js

@@ -3468,7 +3468,7 @@ var NudgeCTABlockType;
   NudgeCTABlockType2["Button"] = "button";
   NudgeCTABlockType2["Link"] = "link";
 })(NudgeCTABlockType || (NudgeCTABlockType = {}));
-class TrackerSdk {
+const _TrackerSdk = class _TrackerSdk {
   constructor(options) {
     __publicField(this, "options");
     __publicField(this, "client");
@@ -3480,6 +3480,7 @@ class TrackerSdk {
     __publicField(this, "eventListeners", {});
     // this set is used to prevent showing the same nudge multiple times in a short period
     __publicField(this, "recentNudgeIds", new TTLSet(1e3));
+    __publicField(this, "trackingDisabled", false);
     this.options = options;
     const query = {
       sdk_name: options.sdk || "node",
@@ -3500,6 +3501,9 @@ class TrackerSdk {
         version: options.sdkVersion || ""
       }
     });
+    if (typeof window !== "undefined" && typeof localStorage !== "undefined") {
+      this.trackingDisabled = localStorage.getItem(_TrackerSdk.TRACKING_DISABLED_KEY) === "true";
+    }
     this.setupIncomingPayloadHandler();
   }
   // placeholder for future use
@@ -3552,6 +3556,9 @@ class TrackerSdk {
     if (this.options.disabled) {
       return Promise.resolve();
     }
+    if (this.trackingDisabled) {
+      return Promise.resolve();
+    }
     if (this.options.filter && !this.options.filter(payload)) {
       return Promise.resolve();
     }
@@ -3589,6 +3596,22 @@ class TrackerSdk {
     } else {
       console.warn("BrainfishWidgetWarn: `.identify` called without a userId. User identification requires a valid userId to be provided.");
     }
+    const allowedFields = /* @__PURE__ */ new Set([
+      "userId",
+      "firstName",
+      "lastName",
+      "email",
+      "phone",
+      "avatar",
+      "properties"
+    ]);
+    const extraFields = Object.keys(payload).filter((key) => !allowedFields.has(key));
+    if (extraFields.length > 0) {
+      console.warn(`BrainfishWidgetWarn: The following fields are not recognized as main identifier fields: ${extraFields.join(", ")}. Please place custom fields under the 'properties' object instead. Note: Using fields incorrectly may cause user identification to not work as expected.`);
+    }
+    if (payload.phone && !/^\+[1-9]\d{1,14}$/.test(payload.phone)) {
+      console.warn("BrainfishWidgetWarn: phone should be in E.164 format (e.g., +14155552671). Providing the correct format ensures accurate user identification.");
+    }
     const iframe = document.querySelector("#bf-iframe-container .trigger-iframe");
     if (iframe) {
       const sendMessage = () => {
@@ -3621,6 +3644,9 @@ class TrackerSdk {
     if (this.options.disabled) {
       return Promise.resolve(null);
     }
+    if (this.trackingDisabled) {
+      return Promise.resolve(null);
+    }
     const payload = {
       type: "event.record",
       payload: {
@@ -3662,8 +3688,6 @@ class TrackerSdk {
     this.queue.forEach((item) => {
       this.send({
         ...item,
-        // Not sure why ts-expect-error is needed here
-        // @ts-expect-error
         payload: {
           ...item.payload,
           userId: item.payload.userId ?? this.userId
@@ -3672,7 +3696,37 @@ class TrackerSdk {
     });
     this.queue = [];
   }
-}
+  /**
+   * Disables privacy-sensitive tracking features (recording, screenshots).
+   * This setting persists across page reloads via localStorage.
+   */
+  disableTracking() {
+    this.trackingDisabled = true;
+    if (typeof window !== "undefined" && typeof localStorage !== "undefined") {
+      localStorage.setItem(_TrackerSdk.TRACKING_DISABLED_KEY, "true");
+    }
+  }
+  /**
+   * Re-enables privacy-sensitive tracking features (recording, screenshots).
+   * Note: Full effect requires a page reload to restart recording.
+   */
+  enableTracking() {
+    this.trackingDisabled = false;
+    if (typeof window !== "undefined" && typeof localStorage !== "undefined") {
+      localStorage.removeItem(_TrackerSdk.TRACKING_DISABLED_KEY);
+    }
+    console.log("Brainfish tracking re-enabled. Refresh page for full effect.");
+  }
+  /**
+   * Returns whether privacy-sensitive tracking is currently disabled.
+   * @returns true if tracking is disabled, false otherwise
+   */
+  isTrackingDisabled() {
+    return this.trackingDisabled;
+  }
+};
+__publicField(_TrackerSdk, "TRACKING_DISABLED_KEY", "bf_tracking_disabled");
+let TrackerSdk = _TrackerSdk;
 var cache = {
   image: /* @__PURE__ */ new Map(),
   background: /* @__PURE__ */ new Map(),
@@ -38426,9 +38480,8 @@ function toCamelCase(str) {
     ($1) => $1.toUpperCase().replace("-", "").replace("_", "")
   );
 }
-const VERSION = "0.0.22";
+const VERSION = "0.0.24";
 class Tracker extends TrackerSdk {
-  // 750KB
   constructor(options) {
     super({
       sdk: "web",
@@ -38441,6 +38494,8 @@ class Tracker extends TrackerSdk {
     __publicField(this, "sessionManager", SessionManager.getInstance());
     __publicField(this, "recordingBlocklist", []);
     __publicField(this, "MAX_SCREENSHOT_SIZE", 750 * 1024);
+    // 750KB
+    __publicField(this, "isRecordingActive", false);
     this.options = options;
     this.agent = new Agent();
     this.recordingBlocklist = options.recordingBlocklist || [];
@@ -38448,17 +38503,19 @@ class Tracker extends TrackerSdk {
       this.setGlobalProperties({
         __referrer: document.referrer
       });
-      if (this.options.trackOutgoingLinks) {
+      const trackingDisabled = this.isTrackingDisabled();
+      if (this.options.trackOutgoingLinks && !trackingDisabled) {
         this.trackOutgoingLinks();
       }
       if (this.options.trackScreenViews) {
         this.trackScreenViews();
       }
-      if (this.options.trackAttributes) {
+      if (this.options.trackAttributes && !trackingDisabled) {
         this.trackAttributes();
       }
-      if (this.options.enableRecording && this.options._allowScreenRecording) {
+      if (this.options.enableRecording && this.options._allowScreenRecording && !trackingDisabled) {
         this.startRecording();
+        this.isRecordingActive = true;
         console.log("Brainfish has started ambient learning");
       }
     }
@@ -38573,7 +38630,7 @@ class Tracker extends TrackerSdk {
       __path: path,
       __title: document.title
     };
-    if (this.options.enableRecording && canDiscover(
+    if (this.options.enableRecording && !this.isTrackingDisabled() && canDiscover(
       this.recordingBlocklist,
       this.options._allowLocalhostRecording
     )) {
@@ -38611,6 +38668,26 @@ class Tracker extends TrackerSdk {
     super.track("screen_view", props);
     this.sessionManager.updateLastScreenViewEventTime();
   }
+  /**
+   * Disables privacy-sensitive tracking features and stops active recording.
+   */
+  disableTracking() {
+    super.disableTracking();
+    if (this.isRecordingActive) {
+      if (this.agent.recordingManager.recorder.stop) {
+        this.agent.recordingManager.recorder.stop();
+      }
+      this.isRecordingActive = false;
+      console.log("Brainfish has stopped ambient learning");
+    }
+  }
+  /**
+   * Re-enables privacy-sensitive tracking features.
+   * Note: Full effect requires a page reload to restart recording and event listeners.
+   */
+  enableTracking() {
+    super.enableTracking();
+  }
 }
 ((window2) => {
   if (window2.BrainfishAnalytics && "q" in window2.BrainfishAnalytics) {
@@ -38630,7 +38707,7 @@ class Tracker extends TrackerSdk {
     window2.BrainfishAnalytics = (t, ...args) => {
       const fn = tracker[t] ? tracker[t].bind(tracker) : void 0;
       if (typeof fn === "function") {
-        fn(...args);
+        return fn(...args);
       } else {
         console.warn(`Method ${t} does not exist on BrainfishAnalytics`);
       }