@formo/analytics 1.19.10 → 1.21.0

package/dist/cjs/src/utils/address.d.ts

@@ -18,5 +18,12 @@ export declare const isValidAddress: (address: Address | null | undefined) => ad
  * This function is the preferred way to get a validated, trimmed address for use in your application.
  */
 export declare const getValidAddress: (address: Address | null | undefined) => string | null;
+/**
+ * Checks if an address is in the blocked list and should not emit events.
+ * Blocked addresses include the zero address and dead address which are not normal user addresses.
+ * @param address The address to check
+ * @returns true if the address is blocked, false otherwise
+ */
+export declare const isBlockedAddress: (address: Address | null | undefined) => boolean;
 export declare const toChecksumAddress: (address: Address) => string;
 //# sourceMappingURL=address.d.ts.map

package/dist/cjs/src/utils/address.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toChecksumAddress = exports.getValidAddress = exports.isValidAddress = void 0;
+exports.toChecksumAddress = exports.isBlockedAddress = exports.getValidAddress = exports.isValidAddress = void 0;
 var keccak_js_1 = require("ethereum-cryptography/keccak.js");
 var utils_js_1 = require("ethereum-cryptography/utils.js");
 var validators_1 = require("../validators");
 var object_1 = require("../validators/object");
+var constants_1 = require("../constants");
 /**
  * Private helper function to validate and trim an address
  * @param address The address to validate and trim
@@ -41,6 +42,25 @@ var getValidAddress = function (address) {
     return _validateAndTrimAddress(address);
 };
 exports.getValidAddress = getValidAddress;
+/**
+ * Checks if an address is in the blocked list and should not emit events.
+ * Blocked addresses include the zero address and dead address which are not normal user addresses.
+ * @param address The address to check
+ * @returns true if the address is blocked, false otherwise
+ */
+var isBlockedAddress = function (address) {
+    if (!address)
+        return false;
+    var validAddress = (0, exports.getValidAddress)(address);
+    if (!validAddress)
+        return false;
+    // Normalize to checksum format for comparison
+    var checksumAddress = (0, exports.toChecksumAddress)(validAddress);
+    return constants_1.BLOCKED_ADDRESSES.some(function (blockedAddr) {
+        return (0, exports.toChecksumAddress)(blockedAddr) === checksumAddress;
+    });
+};
+exports.isBlockedAddress = isBlockedAddress;
 var toChecksumAddress = function (address) {
     if (!(0, validators_1.isAddress)(address, false)) {
         throw new Error("Invalid address " + address);

package/dist/cjs/src/utils/hash.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Hash utilities using ethereum-cryptography for secure, deterministic hashing
+ */
+/**
+ * Generate a secure hash of a string using SHA-256 for creating short, consistent identifiers
+ * @param str - The string to hash
+ * @returns Short hash string (first 8 characters of SHA-256 hex)
+ */
+export declare function secureHash(str: string): string;
+//# sourceMappingURL=hash.d.ts.map

package/dist/cjs/src/utils/hash.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * Hash utilities using ethereum-cryptography for secure, deterministic hashing
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.secureHash = secureHash;
+var sha256_1 = require("ethereum-cryptography/sha256");
+var utils_1 = require("ethereum-cryptography/utils");
+/**
+ * Generate a secure hash of a string using SHA-256 for creating short, consistent identifiers
+ * @param str - The string to hash
+ * @returns Short hash string (first 8 characters of SHA-256 hex)
+ */
+function secureHash(str) {
+    var bytes = (0, utils_1.utf8ToBytes)(str);
+    var hashBytes = (0, sha256_1.sha256)(bytes);
+    var hashHex = (0, utils_1.bytesToHex)(hashBytes);
+    // Return first 8 characters for reasonable cookie name length
+    return hashHex.slice(0, 8);
+}
+//# sourceMappingURL=hash.js.map

package/dist/cjs/src/utils/index.d.ts

@@ -2,4 +2,5 @@ export * from "./address";
 export * from "./base";
 export * from "./converter";
 export * from "./generate";
+export * from "./hash";
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/src/utils/index.js

@@ -18,4 +18,5 @@ __exportStar(require("./address"), exports);
 __exportStar(require("./base"), exports);
 __exportStar(require("./converter"), exports);
 __exportStar(require("./generate"), exports);
+__exportStar(require("./hash"), exports);
 //# sourceMappingURL=index.js.map

package/dist/esm/src/FormoAnalytics.d.ts

@@ -177,6 +177,22 @@ export declare class FormoAnalytics implements IFormoAnalytics {
      * @returns {Promise<void>}
      */
     track(event: string, properties?: IFormoEventProperties, context?: IFormoEventContext, callback?: (...args: unknown[]) => void): Promise<void>;
+    /**
+     * Opt out of tracking.
+     * @returns {void}
+     */
+    optOutTracking(): void;
+    /**
+     * Opt back into tracking after previously opting out. This will re-enable analytics tracking
+     * and switch back to persistent storage.
+     * @returns {void}
+     */
+    optInTracking(): void;
+    /**
+     * Check if the user has opted out of tracking.
+     * @returns {boolean} True if the user has opted out
+     */
+    hasOptedOutTracking(): boolean;
     private trackProvider;
     private trackProviders;
     private addProviderListener;
@@ -204,7 +220,7 @@ export declare class FormoAnalytics implements IFormoAnalytics {
     private trackPageHit;
     private trackEvent;
     /**
-     * Determines if tracking should be enabled based on configuration
+     * Determines if tracking should be enabled based on configuration and consent
      * @returns {boolean} True if tracking should be enabled
      */
     private shouldTrack;