@formo/analytics 1.11.8 → 1.11.9-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formo/analytics",
-  "version": "1.11.8",
+  "version": "1.11.9-alpha.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/getformo/sdk.git"
@@ -63,7 +63,7 @@
     "sinon-chai": "^3.7.0",
     "ts-loader": "^9.3.1",
     "ts-node": "^10.8.2",
-    "typescript": "^5.6.3",
+    "typescript": "^5.7.2",
     "webpack": "^5.74.0",
     "webpack-cli": "^4.10.0"
   },

package/src/FormoAnalytics.ts

@@ -5,7 +5,6 @@ import {
   SESSION_STORAGE_ID_KEY,
   Event,
 } from './constants';
-import { isNotEmpty } from './utils';
 import { H } from 'highlight.run';
 import { ChainID, EIP1193Provider, Options } from './types';
 
@@ -13,12 +12,10 @@ interface IFormoAnalytics {
   /**
    * Initializes the FormoAnalytics instance with the provided API key and project ID.
    */
-  init(apiKey: string, options: Options): Promise<FormoAnalytics>;
-
-  /**
-   * Identifies the user with the provided user data.
-   */
-  identify(userData: Record<string, any>): void;
+  init(
+    apiKey: string,
+    options?: Options
+  ): Promise<FormoAnalytics>;
 
   /**
    * Tracks page visit events.
@@ -28,22 +25,22 @@ interface IFormoAnalytics {
   /**
    * Connects to a wallet with the specified chain ID and address.
    */
-  connect(params: { account: string; chainId: ChainID }): Promise<void>;
+  connect(params: { chainId: ChainID; address: string }): Promise<void>;
 
   /**
    * Disconnects the current wallet and clears the session information.
    */
-  disconnect(attributes?: { account?: string; chainId?: ChainID }): void;
+  disconnect(params?: { chainId?: ChainID; address?: string }): void;
 
   /**
-   * Tracks a specific event with a name and associated data.
+   * Switches the blockchain chain context and optionally logs additional params.
    */
-  track(eventName: string, eventData: Record<string, any>): void;
+  chain(params: { chainId: ChainID; address?: string }): void;
 
   /**
-   * Switches the blockchain chain context and optionally logs additional attributes.
+   * Tracks a specific event with a name and associated data.
    */
-  chain(attributes: { chainId: ChainID; account?: string }): void;
+  track(eventName: string, eventData: Record<string, any>): void;
 }
 interface Config {
   token: string;
@@ -61,7 +58,7 @@ export class FormoAnalytics implements IFormoAnalytics {
   private timezoneToCountry: Record<string, string> = COUNTRY_LIST;
 
   currentChainId?: string | null;
-  currentConnectedAccount?: string;
+  currentConnectedAddress?: string;
 
   private constructor(
     public readonly apiKey: string,
@@ -71,7 +68,8 @@ export class FormoAnalytics implements IFormoAnalytics {
       token: this.apiKey,
     };
 
-    const provider = window?.ethereum || window.web3?.currentProvider || options?.provider;
+    const provider =
+      window?.ethereum || window.web3?.currentProvider || options?.provider;
     if (provider) {
       this.trackProvider(provider);
     }
@@ -79,7 +77,7 @@ export class FormoAnalytics implements IFormoAnalytics {
 
   static async init(
     apiKey: string,
-    options: Options
+    options?: Options
   ): Promise<FormoAnalytics> {
     const config = {
       token: apiKey,
@@ -94,10 +92,6 @@ export class FormoAnalytics implements IFormoAnalytics {
     return this._provider;
   }
 
-  private identifyUser(userData: any) {
-    this.trackEvent(Event.IDENTIFY, userData);
-  }
-
   private getSessionId() {
     const existingSessionId = this.getCookieValue(this.sessionIdKey);
 
@@ -116,7 +110,9 @@ export class FormoAnalytics implements IFormoAnalytics {
   // Function to set the session cookie
   private setSessionCookie(): void {
     const sessionId = this.getSessionId();
-    let cookieValue = `${this.sessionIdKey}=${sessionId}; Max-Age=1800; path=/; secure; domain=${this.getOrigin()}`;
+    let cookieValue = `${
+      this.sessionIdKey
+    }=${sessionId}; Max-Age=1800; path=/; secure; domain=${this.getOrigin()}`;
     document.cookie = cookieValue;
   }
 
@@ -147,19 +143,23 @@ export class FormoAnalytics implements IFormoAnalytics {
       address: address,
       session_id: this.getSessionId(),
       timestamp: new Date().toISOString(),
-      action: action,
+      action,
       version: '1',
-      payload: isNotEmpty(payload) ? this.maskSensitiveData(payload) : payload,
+      payload,
     };
 
     const sendRequest = async (): Promise<void> => {
       try {
-        const response = await axios.post(EVENTS_API_URL, JSON.stringify(requestData), {
-          headers: {
-            'Content-Type': 'application/json',
-            Authorization: `Bearer ${this.apiKey}`
-          },
-        });
+        const response = await axios.post(
+          EVENTS_API_URL,
+          JSON.stringify(requestData),
+          {
+            headers: {
+              'Content-Type': 'application/json',
+              Authorization: `Bearer ${this.apiKey}`,
+            },
+          }
+        );
 
         if (response.status >= 200 && response.status < 300) {
           console.log('Event sent successfully:', action);
@@ -192,72 +192,6 @@ export class FormoAnalytics implements IFormoAnalytics {
     await sendRequest();
   }
 
-  // Function to mask sensitive data in the payload
-  private maskSensitiveData(
-    data: string | undefined | null
-  ): Record<string, any> | null {
-    // Check if data is null or undefined
-    if (data === null || data === undefined) {
-      console.warn('Data is null or undefined, returning null');
-      return null;
-    }
-
-    // Check if data is a string; if so, parse it to an object
-    if (typeof data === 'string') {
-      let parsedData: Record<string, any>;
-      try {
-        parsedData = JSON.parse(data);
-      } catch (error) {
-        console.error('Failed to parse JSON:', error);
-        return null; // Return null if parsing fails
-      }
-
-      const sensitiveFields = [
-        'username',
-        'user',
-        'user_id',
-        'password',
-        'email',
-        'phone',
-      ];
-
-      // Create a new object to store masked data
-      const maskedData = { ...parsedData };
-
-      // Mask sensitive fields
-      sensitiveFields.forEach((field) => {
-        if (field in maskedData) {
-          maskedData[field] = '********'; // Replace value with masked string
-        }
-      });
-
-      return maskedData; // Return the new object with masked fields
-    } else if (typeof data === 'object') {
-      // If data is already an object, handle masking directly
-      const sensitiveFields = [
-        'username',
-        'user',
-        'user_id',
-        'password',
-        'email',
-        'phone',
-      ];
-
-      const maskedData = { ...(data as Record<string, any>) };
-
-      // Mask sensitive fields
-      sensitiveFields.forEach((field) => {
-        if (field in maskedData) {
-          maskedData[field] = '********'; // Replace value with masked string
-        }
-      });
-
-      return maskedData; // Return the new object with masked fields
-    }
-
-    return data;
-  }
-
   // Function to track page hits
   private trackPageHit() {
     if (window.__nightmare || window.navigator.webdriver || window.Cypress)
@@ -281,6 +215,7 @@ export class FormoAnalytics implements IFormoAnalytics {
       const params = new URLSearchParams(url.search);
       this.trackEvent(Event.PAGE, {
         'user-agent': window.navigator.userAgent,
+        address: this.currentConnectedAddress,
         locale: language,
         location: location,
         referrer: document.referrer,
@@ -296,11 +231,12 @@ export class FormoAnalytics implements IFormoAnalytics {
 
   private trackProvider(provider: EIP1193Provider) {
     if (provider === this._provider) {
+      console.log('Provider already tracked.');
       return;
     }
 
     this.currentChainId = undefined;
-    this.currentConnectedAccount = undefined;
+    this.currentConnectedAddress = undefined;
 
     if (this._provider) {
       const eventNames = Object.keys(this._registeredProviderListeners);
@@ -313,13 +249,84 @@ export class FormoAnalytics implements IFormoAnalytics {
       }
     }
 
+    console.log('Tracking new provider:', provider);
     this._provider = provider;
 
     this.getCurrentWallet();
-    this.registerAccountsChangedListener();
+    this.registerAddressChangedListener();
     this.registerChainChangedListener();
   }
 
+  private async getCurrentWallet() {
+    if (!this.provider) {
+      console.warn('FormoAnalytics::getCurrentWallet: the provider is not set');
+      return;
+    }
+
+    const sessionData = sessionStorage.getItem(this.walletAddressSessionKey);
+
+    if (!sessionData) {
+      console.warn(
+        'Session data missing. Attempting to fetch address from provider.'
+      );
+      try {
+        const accounts = await this.provider.request<string[]>({
+          method: 'eth_accounts',
+        });
+        if (accounts && accounts.length > 0) {
+          const address = accounts[0];
+          this.storeWalletAddress(address);
+          return address;
+        }
+      } catch (err) {
+        console.error('Failed to fetch accounts from provider:', err);
+      }
+      return null;
+    }
+
+    const parsedData = JSON.parse(sessionData);
+    const sessionExpiry = 30 * 60 * 1000; // 30 minutes
+    const currentTime = Date.now();
+
+    if (currentTime - parsedData.timestamp > sessionExpiry) {
+      console.warn('Session expired. Ignoring wallet address.');
+      sessionStorage.removeItem(this.walletAddressSessionKey); // Clear expired session data
+      return '';
+    }
+
+    this.onAddressConnected(parsedData.address);
+    return parsedData.address || '';
+  }
+
+  private async getCurrentChainId(): Promise<string> {
+    if (!this.provider) {
+      console.error('FormoAnalytics::getCurrentChainId: provider not set');
+    }
+    const chainIdHex = await this.provider?.request<string>({
+      method: 'eth_chainId',
+    });
+    // Because we're connected, the chainId cannot be null
+    if (!chainIdHex) {
+      console.error(
+        `FormoAnalytics::getCurrentChainId: chainIdHex is: ${chainIdHex}`
+      );
+    }
+
+    return parseInt(chainIdHex as string, 16).toString();
+  }
+
+  private registerAddressChangedListener() {
+    const listener = (...args: unknown[]) =>
+      this.onAddressChanged(args[0] as string[]);
+
+    this._provider?.on('accountsChanged', listener);
+    this._registeredProviderListeners['accountsChanged'] = listener;
+
+    const onAddressDisconnected = this.onAddressDisconnected.bind(this);
+    this._provider?.on('disconnect', onAddressDisconnected);
+    this._registeredProviderListeners['disconnect'] = onAddressDisconnected;
+  }
+
   private registerChainChangedListener() {
     const listener = (...args: unknown[]) =>
       this.onChainChanged(args[0] as string);
@@ -327,25 +334,50 @@ export class FormoAnalytics implements IFormoAnalytics {
     this._registeredProviderListeners['chainChanged'] = listener;
   }
 
-  private handleAccountDisconnected() {
-    if (!this.currentConnectedAccount) {
+  private async onAddressChanged(addresses: string[]) {
+    if (addresses.length > 0) {
+      const newAccount = addresses[0];
+      if (newAccount !== this.currentConnectedAddress) {
+        this.onAddressConnected(newAccount);
+      }
+    } else {
+      this.onAddressDisconnected();
+    }
+  }
+
+  private async onAddressConnected(address: string) {
+    if (address === this.currentConnectedAddress) {
+      // We have already reported this address
       return;
+    } else {
+      this.currentConnectedAddress = address;
     }
 
-    const disconnectAttributes = {
-      address: this.currentConnectedAccount,
-      chainId: this.currentChainId,
+    this.currentChainId = await this.getCurrentChainId();
+
+    this.connect({ chainId: this.currentChainId, address });
+    this.storeWalletAddress(address);
+  }
+
+  private onAddressDisconnected() {
+    if (!this.currentConnectedAddress) {
+      return;
+    }
+
+    const payload = {
+      chain_id: this.currentChainId,
+      address: this.currentConnectedAddress,
     };
     this.currentChainId = undefined;
-    this.currentConnectedAccount = undefined;
+    this.currentConnectedAddress = undefined;
     this.clearWalletAddress();
 
-    return this.trackEvent(Event.DISCONNECT, disconnectAttributes);
+    return this.trackEvent(Event.DISCONNECT, payload);
   }
 
   private async onChainChanged(chainIdHex: string) {
     this.currentChainId = parseInt(chainIdHex).toString();
-    if (!this.currentConnectedAccount) {
+    if (!this.currentConnectedAddress) {
       if (!this.provider) {
         console.error(
           'error',
@@ -366,7 +398,7 @@ export class FormoAnalytics implements IFormoAnalytics {
           return;
         }
 
-        this.currentConnectedAccount = res[0];
+        this.currentConnectedAddress = res[0];
       } catch (err) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         if ((err as any).code !== 4001) {
@@ -383,90 +415,10 @@ export class FormoAnalytics implements IFormoAnalytics {
 
     return this.chain({
       chainId: this.currentChainId,
-      account: this.currentConnectedAccount,
+      address: this.currentConnectedAddress,
     });
   }
 
-  private async onAccountsChanged(accounts: string[]) {
-    if (accounts.length > 0) {
-      const newAccount = accounts[0];
-      if (newAccount !== this.currentConnectedAccount) {
-        this.handleAccountConnected(newAccount);
-      }
-    } else {
-      this.handleAccountDisconnected();
-    }
-  }
-
-  private registerAccountsChangedListener() {
-    const listener = (...args: unknown[]) =>
-      this.onAccountsChanged(args[0] as string[]);
-
-    this._provider?.on('accountsChanged', listener);
-    this._registeredProviderListeners['accountsChanged'] = listener;
-
-    const handleAccountDisconnected = this.handleAccountDisconnected.bind(this);
-    this._provider?.on('disconnect', handleAccountDisconnected);
-    this._registeredProviderListeners['disconnect'] = handleAccountDisconnected;
-  }
-
-  private async getCurrentChainId(): Promise<string> {
-    if (!this.provider) {
-      console.error('FormoAnalytics::getCurrentChainId: provider not set');
-    }
-
-    const chainIdHex = await this.provider?.request<string>({
-      method: 'eth_chainId',
-    });
-    // Because we're connected, the chainId cannot be null
-    if (!chainIdHex) {
-      console.error(
-        `FormoAnalytics::getCurrentChainId: chainIdHex is: ${chainIdHex}`
-      );
-    }
-
-    return parseInt(chainIdHex as string, 16).toString();
-  }
-
-  private async handleAccountConnected(account: string) {
-    if (account === this.currentConnectedAccount) {
-      // We have already reported this account
-      return;
-    } else {
-      this.currentConnectedAccount = account;
-    }
-
-    this.currentChainId = await this.getCurrentChainId();
-
-    this.connect({ account, chainId: this.currentChainId });
-    this.storeWalletAddress(account);
-  }
-
-  private async getCurrentWallet() {
-    if (!this.provider) {
-      console.warn('FormoAnalytics::getCurrentWallet: the provider is not set');
-      return;
-    }
-    const sessionData = sessionStorage.getItem(this.walletAddressSessionKey);
-
-    if (!sessionData) {
-      return null;
-    }
-
-    const parsedData = JSON.parse(sessionData);
-    const sessionExpiry = 30 * 60 * 1000; // 30 minutes
-    const currentTime = Date.now();
-
-    if (currentTime - parsedData.timestamp > sessionExpiry) {
-      console.warn('Session expired. Ignoring wallet address.');
-      sessionStorage.removeItem(this.walletAddressSessionKey); // Clear expired session data
-      return '';
-    }
-
-    this.handleAccountConnected(parsedData.address);
-    return parsedData.address || '';
-  }
-
   /**
    * Stores the wallet address in session storage when connected.
    * @param address - The wallet address to store.
@@ -482,7 +434,10 @@ export class FormoAnalytics implements IFormoAnalytics {
       timestamp: Date.now(),
     };
 
-    sessionStorage.setItem(this.walletAddressSessionKey, JSON.stringify(sessionData));
+    sessionStorage.setItem(
+      this.walletAddressSessionKey,
+      JSON.stringify(sessionData)
+    );
   }
 
   /**
@@ -492,54 +447,55 @@ export class FormoAnalytics implements IFormoAnalytics {
     sessionStorage.removeItem(this.walletAddressSessionKey);
   }
 
-  connect({ account, chainId }: { account: string; chainId: ChainID }) {
+  init(apiKey: string, options: Options): Promise<FormoAnalytics> {
+    const instance = new FormoAnalytics(apiKey, options);
+    return Promise.resolve(instance);
+  }
+
+  connect({ chainId, address }: { chainId: ChainID; address: string }) {
     if (!chainId) {
-      throw new Error('FormoAnalytics::connect: chainId cannot be empty');
+      throw new Error('FormoAnalytics::connect: chain ID cannot be empty');
     }
-    if (!account) {
-      throw new Error('FormoAnalytics::connect: account cannot be empty');
+    if (!address) {
+      throw new Error('FormoAnalytics::connect: address cannot be empty');
     }
 
     this.currentChainId = chainId.toString();
-    this.currentConnectedAccount = account;
+    this.currentConnectedAddress = address;
 
     return this.trackEvent(Event.CONNECT, {
-      chainId,
-      address: account,
+      chain_id: chainId,
+      address: address,
     });
   }
 
-  disconnect(attributes?: { account?: string; chainId?: ChainID }) {
-    const account = attributes?.account || this.currentConnectedAccount;
-    if (!account) {
+  disconnect(params?: { chainId?: ChainID; address?: string }) {
+    const address = params?.address || this.currentConnectedAddress;
+    if (!address) {
       // We have most likely already reported this disconnection with the automatic
       // `disconnect` detection
       return;
     }
 
-    const chainId = attributes?.chainId || this.currentChainId;
-    const eventAttributes = {
-      account,
-      ...(chainId && { chainId }),
+    const payload = {
+      chain_id: params?.chainId || this.currentChainId,
+      address,
     };
-
     this.currentChainId = undefined;
-    this.currentConnectedAccount = undefined;
+    this.currentConnectedAddress = undefined;
 
-    return this.trackEvent(Event.DISCONNECT, eventAttributes);
+    return this.trackEvent(Event.DISCONNECT, payload);
   }
 
-  chain({ chainId, account }: { chainId: ChainID; account?: string }) {
+  chain({ chainId, address }: { chainId: ChainID; address?: string }) {
     if (!chainId || Number(chainId) === 0) {
       throw new Error('FormoAnalytics::chain: chainId cannot be empty or 0');
     }
-
-    if (!account && !this.currentConnectedAccount) {
+    if (!address && !this.currentConnectedAddress) {
       throw new Error(
-        'FormoAnalytics::chain: account was empty and no previous account has been recorded. You can either pass an account or call connect() first'
+        'FormoAnalytics::chain: address was empty and no previous address has been recorded. You can either pass an address or call connect() first'
       );
     }
-
     if (isNaN(Number(chainId))) {
       throw new Error(
         'FormoAnalytics::chain: chainId must be a valid hex or decimal number'
@@ -549,20 +505,11 @@ export class FormoAnalytics implements IFormoAnalytics {
     this.currentChainId = chainId.toString();
 
     return this.trackEvent(Event.CHAIN_CHANGED, {
-      chainId,
-      account: account || this.currentConnectedAccount,
+      chain_id: chainId,
+      address: address || this.currentConnectedAddress,
     });
   }
 
-  init(apiKey: string, options: Options): Promise<FormoAnalytics> {
-    const instance = new FormoAnalytics(apiKey, options);
-    return Promise.resolve(instance);
-  }
-
-  identify(userData: any) {
-    this.identifyUser(userData);
-  }
-
   page() {
     this.trackPageHit();
   }

package/src/FormoAnalyticsProvider.tsx

@@ -32,15 +32,12 @@ export const FormoAnalyticsProvider = ({
         console.error('FormoAnalyticsProvider: No API key provided');
         return;
       }
-
       if (disabled) {
         console.warn('FormoAnalytics is disabled');
         return;
       }
-
       if (initializedStartedRef.current) return;
       initializedStartedRef.current = true;
-
       // Initialize Highlight.run if project ID is available
       if (HIGHLIGHT_PROJECT_ID) {
         try {

package/src/types/base.ts

@@ -8,7 +8,7 @@ export interface Options {
 
 export interface FormoAnalyticsProviderProps {
   apiKey: string;
-  options: Options;
+  options?: Options;
   disabled?: boolean;
   children: React.ReactNode;
 }