@formo/analytics 1.17.9 → 1.18.0

package/dist/esm/src/FormoAnalytics.js

@@ -50,6 +50,7 @@ import { EVENTS_API_URL, EventType, LOCAL_ANONYMOUS_ID_KEY, SESSION_CURRENT_URL_
 import { cookie, EventManager, EventQueue, initStorageManager, logger, Logger, } from "./lib";
 import { SignatureStatus, TransactionStatus, } from "./types";
 import { isAddress, isLocalhost } from "./validators";
+import { parseChainId } from "./utils/chain";
 var FormoAnalytics = /** @class */ (function () {
     function FormoAnalytics(writeKey, options) {
         if (options === void 0) { options = {}; }
@@ -62,8 +63,8 @@ var FormoAnalytics = /** @class */ (function () {
         this.currentUserId = "";
         this.config = {
             writeKey: writeKey,
-            trackLocalhost: options.trackLocalhost || false,
         };
+        this.options = options;
         this.session = new FormoAnalyticsSession();
         this.currentUserId =
             cookie().get(SESSION_USER_ID_KEY) || undefined;
@@ -92,7 +93,7 @@ var FormoAnalytics = /** @class */ (function () {
         if (provider) {
             this.trackProvider(provider);
         }
-        this.trackFirstPageHit();
+        this.trackPageHit();
         this.trackPageHits();
     }
     FormoAnalytics.init = function (writeKey, options) {
@@ -126,13 +127,14 @@ var FormoAnalytics = /** @class */ (function () {
      * @param {string} name - The name of the page
      * @param {Record<string, any>} properties - Additional properties to include
      * @param {Record<string, any>} context - Additional context to include
+     * @param {(...args: unknown[]) => void} callback - Optional callback function
      * @returns {Promise<void>}
      */
-    FormoAnalytics.prototype.page = function (category, name, properties, context) {
+    FormoAnalytics.prototype.page = function (category, name, properties, context, callback) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.trackPageHit(category, name, properties, context)];
+                    case 0: return [4 /*yield*/, this.trackPageHit(category, name, properties, context, callback)];
                     case 1:
                         _a.sent();
                         return [2 /*return*/];
@@ -185,9 +187,9 @@ var FormoAnalytics = /** @class */ (function () {
         });
     };
     /**
-     * Emits a wallet disconnect event.
-     * @param {ChainID} params.chainId
-     * @param {Address} params.address
+     * Emits a disconnect wallet event.
+     * @param {ChainID} [params.chainId]
+     * @param {Address} [params.address]
      * @param {IFormoEventProperties} properties
      * @param {IFormoEventContext} context
      * @param {(...args: unknown[]) => void} callback
@@ -195,15 +197,21 @@ var FormoAnalytics = /** @class */ (function () {
      */
     FormoAnalytics.prototype.disconnect = function (params, properties, context, callback) {
         return __awaiter(this, void 0, void 0, function () {
-            var address, chainId;
+            var chainId, address;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        address = (params === null || params === void 0 ? void 0 : params.address) || this.currentAddress;
                         chainId = (params === null || params === void 0 ? void 0 : params.chainId) || this.currentChainId;
-                        return [4 /*yield*/, this.handleDisconnect(chainId, address, properties, context, callback)];
+                        address = (params === null || params === void 0 ? void 0 : params.address) || this.currentAddress;
+                        return [4 /*yield*/, this.trackEvent(EventType.DISCONNECT, {
+                                chainId: chainId,
+                                address: address,
+                            }, properties, context, callback)];
                     case 1:
                         _a.sent();
+                        this.currentAddress = undefined;
+                        this.currentChainId = undefined;
+                        logger.info("Wallet disconnected: Cleared currentAddress and currentChainId");
                         return [2 /*return*/];
                 }
             });
@@ -357,7 +365,7 @@ var FormoAnalytics = /** @class */ (function () {
                     case 8: return [2 /*return*/];
                     case 9:
                         userId = params.userId, address = params.address, providerName = params.providerName, rdns = params.rdns;
-                        logger.debug("Identify", address, userId, providerName, rdns);
+                        logger.info("Identify", address, userId, providerName, rdns);
                         if (address)
                             this.currentAddress = address;
                         if (userId) {
@@ -435,6 +443,7 @@ var FormoAnalytics = /** @class */ (function () {
       SDK tracking and event listener functions
     */
     FormoAnalytics.prototype.trackProvider = function (provider) {
+        logger.info("trackProvider", provider);
         try {
             if (provider === this._provider) {
                 logger.warn("TrackProvider: Provider already tracked.");
@@ -452,33 +461,65 @@ var FormoAnalytics = /** @class */ (function () {
             }
             this._provider = provider;
             // Register listeners for web3 provider events
-            this.registerAddressChangedListener();
+            this.registerAccountsChangedListener();
             this.registerChainChangedListener();
+            this.registerConnectListener();
             this.registerRequestListeners();
         }
         catch (error) {
             logger.error("Error tracking provider:", error);
         }
     };
-    FormoAnalytics.prototype.registerAddressChangedListener = function () {
+    FormoAnalytics.prototype.registerAccountsChangedListener = function () {
         var _this = this;
-        var _a, _b;
+        var _a;
+        logger.info("registerAccountsChangedListener");
         var listener = function () {
             var args = [];
             for (var _i = 0; _i < arguments.length; _i++) {
                 args[_i] = arguments[_i];
             }
-            return _this.onAddressChanged(args[0]);
+            return _this.onAccountsChanged(args[0]);
         };
         (_a = this._provider) === null || _a === void 0 ? void 0 : _a.on("accountsChanged", listener);
         this._providerListeners["accountsChanged"] = listener;
-        var onAddressDisconnected = this.onAddressDisconnected.bind(this);
-        (_b = this._provider) === null || _b === void 0 ? void 0 : _b.on("disconnect", onAddressDisconnected);
-        this._providerListeners["disconnect"] = onAddressDisconnected;
+    };
+    FormoAnalytics.prototype.onAccountsChanged = function (accounts) {
+        return __awaiter(this, void 0, void 0, function () {
+            var address, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        logger.info("onAccountsChanged", accounts);
+                        if (!(accounts.length === 0)) return [3 /*break*/, 2];
+                        // Handle wallet disconnect
+                        return [4 /*yield*/, this.disconnect()];
+                    case 1:
+                        // Handle wallet disconnect
+                        _b.sent();
+                        return [2 /*return*/];
+                    case 2:
+                        address = accounts[0];
+                        if (address === this.currentAddress) {
+                            // We have already reported this address
+                            return [2 /*return*/];
+                        }
+                        // Handle wallet connect
+                        this.currentAddress = address;
+                        _a = this;
+                        return [4 /*yield*/, this.getCurrentChainId()];
+                    case 3:
+                        _a.currentChainId = _b.sent();
+                        this.connect({ chainId: this.currentChainId, address: address });
+                        return [2 /*return*/];
+                }
+            });
+        });
     };
     FormoAnalytics.prototype.registerChainChangedListener = function () {
         var _this = this;
         var _a;
+        logger.info("registerChainChangedListener");
         var listener = function () {
             var args = [];
             for (var _i = 0; _i < arguments.length; _i++) {
@@ -489,10 +530,92 @@ var FormoAnalytics = /** @class */ (function () {
         (_a = this.provider) === null || _a === void 0 ? void 0 : _a.on("chainChanged", listener);
         this._providerListeners["chainChanged"] = listener;
     };
+    FormoAnalytics.prototype.onChainChanged = function (chainIdHex) {
+        return __awaiter(this, void 0, void 0, function () {
+            var address;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        logger.info("onChainChanged", chainIdHex);
+                        this.currentChainId = parseChainId(chainIdHex);
+                        if (!!this.currentAddress) return [3 /*break*/, 2];
+                        if (!this.provider) {
+                            logger.info("OnChainChanged: Provider not found. CHAIN_CHANGED not reported");
+                            return [2 /*return*/, Promise.resolve()];
+                        }
+                        return [4 /*yield*/, this.getAddress()];
+                    case 1:
+                        address = _a.sent();
+                        if (!address) {
+                            logger.info("OnChainChanged: Unable to fetch or store connected address");
+                            return [2 /*return*/, Promise.resolve()];
+                        }
+                        this.currentAddress = address;
+                        _a.label = 2;
+                    case 2:
+                        // Proceed only if the address exists
+                        if (this.currentAddress) {
+                            return [2 /*return*/, this.chain({
+                                    chainId: this.currentChainId,
+                                    address: this.currentAddress,
+                                })];
+                        }
+                        else {
+                            logger.info("OnChainChanged: Current connected address is null despite fetch attempt");
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    FormoAnalytics.prototype.registerConnectListener = function () {
+        var _this = this;
+        var _a;
+        logger.info("registerConnectListener");
+        var listener = function () {
+            var args = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                args[_i] = arguments[_i];
+            }
+            var connection = args[0];
+            _this.onConnected(connection);
+        };
+        (_a = this._provider) === null || _a === void 0 ? void 0 : _a.on("connect", listener);
+        this._providerListeners["connect"] = listener;
+    };
+    FormoAnalytics.prototype.onConnected = function (connection) {
+        return __awaiter(this, void 0, void 0, function () {
+            var chainId, address, e_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        logger.info("onConnected", connection);
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        if (!connection || typeof connection.chainId !== 'string')
+                            return [2 /*return*/];
+                        chainId = parseChainId(connection.chainId);
+                        return [4 /*yield*/, this.getAddress()];
+                    case 2:
+                        address = _a.sent();
+                        if (chainId !== null && chainId !== undefined && address) {
+                            this.connect({ chainId: chainId, address: address });
+                        }
+                        return [3 /*break*/, 4];
+                    case 3:
+                        e_2 = _a.sent();
+                        logger.error("Error handling connect event", e_2);
+                        return [3 /*break*/, 4];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
     FormoAnalytics.prototype.registerRequestListeners = function () {
         var _this = this;
         var _a;
-        logger.debug("registerRequestListeners");
+        logger.info("registerRequestListeners");
         if (!this.provider) {
             logger.error("Provider not found for request (signature, transaction) tracking");
             return;
@@ -567,7 +690,7 @@ var FormoAnalytics = /** @class */ (function () {
                             method === "eth_sendTransaction" &&
                             params[0])) return [3 /*break*/, 8];
                         (function () { return __awaiter(_this, void 0, void 0, function () {
-                            var payload, e_2;
+                            var payload, e_3;
                             return __generator(this, function (_a) {
                                 switch (_a.label) {
                                     case 0:
@@ -578,8 +701,8 @@ var FormoAnalytics = /** @class */ (function () {
                                         this.transaction(__assign({ status: TransactionStatus.STARTED }, payload));
                                         return [3 /*break*/, 3];
                                     case 2:
-                                        e_2 = _a.sent();
-                                        logger.error("Formo: Failed to track transaction start", e_2);
+                                        e_3 = _a.sent();
+                                        logger.error("Formo: Failed to track transaction start", e_3);
                                         return [3 /*break*/, 3];
                                     case 3: return [2 /*return*/];
                                 }
@@ -595,7 +718,7 @@ var FormoAnalytics = /** @class */ (function () {
                     case 6:
                         transactionHash_1 = (_c.sent());
                         (function () { return __awaiter(_this, void 0, void 0, function () {
-                            var payload, e_3;
+                            var payload, e_4;
                             return __generator(this, function (_a) {
                                 switch (_a.label) {
                                     case 0:
@@ -608,8 +731,8 @@ var FormoAnalytics = /** @class */ (function () {
                                         this.pollTransactionReceipt(transactionHash_1, payload);
                                         return [3 /*break*/, 3];
                                     case 2:
-                                        e_3 = _a.sent();
-                                        logger.error("Formo: Failed to track transaction broadcast", e_3);
+                                        e_4 = _a.sent();
+                                        logger.error("Formo: Failed to track transaction broadcast", e_4);
                                         return [3 /*break*/, 3];
                                     case 3: return [2 /*return*/];
                                 }
@@ -619,7 +742,7 @@ var FormoAnalytics = /** @class */ (function () {
                     case 7:
                         error_2 = _c.sent();
                         (function () { return __awaiter(_this, void 0, void 0, function () {
-                            var rpcError, payload, e_4;
+                            var rpcError, payload, e_5;
                             return __generator(this, function (_a) {
                                 switch (_a.label) {
                                     case 0:
@@ -633,8 +756,8 @@ var FormoAnalytics = /** @class */ (function () {
                                         _a.label = 2;
                                     case 2: return [3 /*break*/, 4];
                                     case 3:
-                                        e_4 = _a.sent();
-                                        logger.error("Formo: Failed to track transaction rejection", e_4);
+                                        e_5 = _a.sent();
+                                        logger.error("Formo: Failed to track transaction rejection", e_5);
                                         return [3 /*break*/, 4];
                                     case 4: return [2 /*return*/];
                                 }
@@ -646,116 +769,16 @@ var FormoAnalytics = /** @class */ (function () {
             });
         }); };
     };
-    FormoAnalytics.prototype.onAddressChanged = function (addresses) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                if (addresses.length > 0) {
-                    this.onAddressConnected(addresses[0]);
-                }
-                else {
-                    this.onAddressDisconnected();
-                }
-                return [2 /*return*/];
-            });
-        });
-    };
-    FormoAnalytics.prototype.onAddressConnected = function (address) {
-        return __awaiter(this, void 0, void 0, function () {
-            var _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        if (address === this.currentAddress)
-                            // We have already reported this address
-                            return [2 /*return*/];
-                        this.currentAddress = address;
-                        _a = this;
-                        return [4 /*yield*/, this.getCurrentChainId()];
-                    case 1:
-                        _a.currentChainId = _b.sent();
-                        this.connect({ chainId: this.currentChainId, address: address });
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    FormoAnalytics.prototype.handleDisconnect = function (chainId, address, properties, context, callback) {
-        return __awaiter(this, void 0, void 0, function () {
-            var payload;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        payload = {
-                            chainId: chainId || this.currentChainId,
-                            address: address || this.currentAddress,
-                        };
-                        this.currentChainId = undefined;
-                        this.currentAddress = undefined;
-                        cookie().remove(SESSION_USER_ID_KEY);
-                        return [4 /*yield*/, this.trackEvent(EventType.DISCONNECT, payload, properties, context, callback)];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    FormoAnalytics.prototype.onAddressDisconnected = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.handleDisconnect(this.currentChainId, this.currentAddress)];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    FormoAnalytics.prototype.onChainChanged = function (chainIdHex) {
-        return __awaiter(this, void 0, void 0, function () {
-            var address;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        this.currentChainId = parseInt(chainIdHex);
-                        if (!!this.currentAddress) return [3 /*break*/, 2];
-                        if (!this.provider) {
-                            logger.info("OnChainChanged: Provider not found. CHAIN_CHANGED not reported");
-                            return [2 /*return*/, Promise.resolve()];
-                        }
-                        return [4 /*yield*/, this.getAddress()];
-                    case 1:
-                        address = _a.sent();
-                        if (!address) {
-                            logger.info("OnChainChanged: Unable to fetch or store connected address");
-                            return [2 /*return*/, Promise.resolve()];
-                        }
-                        this.currentAddress = address;
-                        _a.label = 2;
-                    case 2:
-                        // Proceed only if the address exists
-                        if (this.currentAddress) {
-                            return [2 /*return*/, this.chain({
-                                    chainId: this.currentChainId,
-                                    address: this.currentAddress,
-                                })];
-                        }
-                        else {
-                            logger.info("OnChainChanged: Current connected address is null despite fetch attempt");
-                        }
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    FormoAnalytics.prototype.trackFirstPageHit = function () {
+    FormoAnalytics.prototype.onLocationChange = function () {
         return __awaiter(this, void 0, void 0, function () {
+            var currentUrl;
             return __generator(this, function (_a) {
-                if (cookie().get(SESSION_CURRENT_URL_KEY) === null) {
+                currentUrl = cookie().get(SESSION_CURRENT_URL_KEY);
+                if (currentUrl !== window.location.href) {
                     cookie().set(SESSION_CURRENT_URL_KEY, window.location.href);
+                    this.trackPageHit();
                 }
-                return [2 /*return*/, this.trackPageHit()];
+                return [2 /*return*/];
             });
         });
     };
@@ -790,25 +813,13 @@ var FormoAnalytics = /** @class */ (function () {
             });
         });
     };
-    FormoAnalytics.prototype.onLocationChange = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var currentUrl;
-            return __generator(this, function (_a) {
-                currentUrl = cookie().get(SESSION_CURRENT_URL_KEY);
-                if (currentUrl !== window.location.href) {
-                    cookie().set(SESSION_CURRENT_URL_KEY, window.location.href);
-                    this.trackPageHit();
-                }
-                return [2 /*return*/];
-            });
-        });
-    };
     FormoAnalytics.prototype.trackPageHit = function (category, name, properties, context, callback) {
         return __awaiter(this, void 0, void 0, function () {
             var _this = this;
             return __generator(this, function (_a) {
-                if (!this.config.trackLocalhost && isLocalhost()) {
-                    return [2 /*return*/, logger.warn("Track page hit: Ignoring event because website is running locally")];
+                if (!this.shouldTrack()) {
+                    logger.info("Track page hit: Skipping event due to tracking configuration");
+                    return [2 /*return*/];
                 }
                 setTimeout(function () { return __awaiter(_this, void 0, void 0, function () {
                     return __generator(this, function (_a) {
@@ -827,6 +838,10 @@ var FormoAnalytics = /** @class */ (function () {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
                 try {
+                    if (!this.shouldTrack()) {
+                        logger.info("Skipping ".concat(type, " event due to tracking configuration"));
+                        return [2 /*return*/];
+                    }
                     this.eventManager.addEvent(__assign(__assign({ type: type }, payload), { properties: properties, context: context, callback: callback }), this.currentAddress, this.currentUserId);
                 }
                 catch (error) {
@@ -836,6 +851,46 @@ var FormoAnalytics = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Determines if tracking should be enabled based on configuration
+     * @returns {boolean} True if tracking should be enabled
+     */
+    FormoAnalytics.prototype.shouldTrack = function () {
+        // Check if tracking is explicitly provided as a boolean
+        if (typeof this.options.tracking === 'boolean') {
+            return this.options.tracking;
+        }
+        // Handle object configuration with exclusion rules
+        if (this.options.tracking !== null &&
+            typeof this.options.tracking === 'object' &&
+            !Array.isArray(this.options.tracking)) {
+            var _a = this.options.tracking, _b = _a.excludeHosts, excludeHosts = _b === void 0 ? [] : _b, _c = _a.excludePaths, excludePaths = _c === void 0 ? [] : _c, _d = _a.excludeChains, excludeChains = _d === void 0 ? [] : _d;
+            // Check hostname exclusions - use exact matching
+            if (excludeHosts.length > 0 && typeof window !== 'undefined') {
+                var hostname = window.location.hostname;
+                if (excludeHosts.includes(hostname)) {
+                    return false;
+                }
+            }
+            // Check path exclusions - use exact matching
+            if (excludePaths.length > 0 && typeof window !== 'undefined') {
+                var pathname = window.location.pathname;
+                if (excludePaths.includes(pathname)) {
+                    return false;
+                }
+            }
+            // Check chainId exclusions
+            if (excludeChains.length > 0 &&
+                this.currentChainId &&
+                excludeChains.includes(this.currentChainId)) {
+                return false;
+            }
+            // If nothing is excluded, tracking is enabled
+            return true;
+        }
+        // Default behavior: track everywhere except localhost
+        return !isLocalhost();
+    };
     /*
       Utility functions
     */
@@ -991,7 +1046,7 @@ var FormoAnalytics = /** @class */ (function () {
                             logger.info("Chain id not found");
                             return [2 /*return*/, 0];
                         }
-                        return [2 /*return*/, parseInt(chainIdHex, 16)];
+                        return [2 /*return*/, parseChainId(chainIdHex)];
                     case 3:
                         err_5 = _b.sent();
                         logger.error("eth_chainId threw an error:", err_5);
@@ -1054,7 +1109,7 @@ var FormoAnalytics = /** @class */ (function () {
                 if (!provider)
                     return [2 /*return*/];
                 poll = function () { return __awaiter(_this, void 0, void 0, function () {
-                    var receipt, e_5;
+                    var receipt, e_6;
                     return __generator(this, function (_a) {
                         switch (_a.label) {
                             case 0:
@@ -1078,8 +1133,8 @@ var FormoAnalytics = /** @class */ (function () {
                                 }
                                 return [3 /*break*/, 3];
                             case 2:
-                                e_5 = _a.sent();
-                                logger.error("Error polling transaction receipt", e_5);
+                                e_6 = _a.sent();
+                                logger.error("Error polling transaction receipt", e_6);
                                 return [3 /*break*/, 3];
                             case 3:
                                 attempts++;