@formo/analytics 1.11.10 → 1.11.12

package/README.md

@@ -217,7 +217,7 @@ yarn build-cjs && yarn build-esm && yarn webpack --mode=production
 or if you're using NPM:
 
 ```jsx
-npm run build
+yarn build
 ```
 
 2. Authenticate with NPM

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formo/analytics",
-  "version": "1.11.10",
+  "version": "1.11.12",
   "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.7.2",
+    "typescript": "^5.6.3",
     "webpack": "^5.74.0",
     "webpack-cli": "^4.10.0"
   },

package/src/FormoAnalytics.ts

@@ -1,18 +1,18 @@
-import axios from 'axios';
+import axios from "axios";
 import {
   COUNTRY_LIST,
   EVENTS_API_URL,
   SESSION_STORAGE_ID_KEY,
   Event,
-} from './constants';
-import { H } from 'highlight.run';
-import { ChainID, EIP1193Provider, Options } from './types';
+} from "./constants";
+import { H } from "highlight.run";
+import { ChainID, EIP1193Provider, Options } from "./types";
 
 interface IFormoAnalytics {
   /**
    * Initializes the FormoAnalytics instance with the provided API key and project ID.
    */
-  init(apiKey: string, options?: Options): Promise<FormoAnalytics>;
+  init(apiKey: string, options: Options): Promise<FormoAnalytics>;
 
   /**
    * Tracks page visit events.
@@ -49,7 +49,7 @@ export class FormoAnalytics implements IFormoAnalytics {
     (...args: unknown[]) => void
   > = {};
 
-  private walletAddressSessionKey = 'walletAddress';
+  private walletAddressSessionKey = "walletAddress";
   private config: Config;
   private sessionIdKey: string = SESSION_STORAGE_ID_KEY;
   private timezoneToCountry: Record<string, string> = COUNTRY_LIST;
@@ -72,10 +72,7 @@ export class FormoAnalytics implements IFormoAnalytics {
     }
   }
 
-  static async init(
-    apiKey: string,
-    options?: Options
-  ): Promise<FormoAnalytics> {
+  static async init(apiKey: string, options: Options): Promise<FormoAnalytics> {
     const config = {
       token: apiKey,
     };
@@ -101,7 +98,7 @@ export class FormoAnalytics implements IFormoAnalytics {
   }
 
   private getOrigin(): string {
-    return window.location.origin || 'ORIGIN_NOT_FOUND';
+    return window.location.origin || "ORIGIN_NOT_FOUND";
   }
 
   // Function to set the session cookie
@@ -120,8 +117,8 @@ export class FormoAnalytics implements IFormoAnalytics {
 
   // Function to get a cookie value by name
   private getCookieValue(name: string): string | undefined {
-    const cookies = document.cookie.split(';').reduce((acc, cookie) => {
-      const [key, value] = cookie.split('=');
+    const cookies = document.cookie.split(";").reduce((acc, cookie) => {
+      const [key, value] = cookie.split("=");
       acc[key.trim()] = value;
       return acc;
     }, {} as Record<string, string>);
@@ -141,8 +138,12 @@ export class FormoAnalytics implements IFormoAnalytics {
       session_id: this.getSessionId(),
       timestamp: new Date().toISOString(),
       action,
-      version: '1',
-      payload,
+      version: "1",
+      payload: {
+        // common fields
+        ...this.getCommonTrackingFields(),
+        ...payload,
+      },
     };
 
     const sendRequest = async (): Promise<void> => {
@@ -152,14 +153,14 @@ export class FormoAnalytics implements IFormoAnalytics {
           JSON.stringify(requestData),
           {
             headers: {
-              'Content-Type': 'application/json',
+              "Content-Type": "application/json",
               Authorization: `Bearer ${this.apiKey}`,
             },
           }
         );
 
         if (response.status >= 200 && response.status < 300) {
-          console.log('Event sent successfully:', action);
+          console.log("Event sent successfully:", action);
         } else {
           throw new Error(`Failed with status: ${response.status}`);
         }
@@ -189,46 +190,49 @@ export class FormoAnalytics implements IFormoAnalytics {
     await sendRequest();
   }
 
-  // Function to track page hits
-  private trackPageHit() {
-    if (window.__nightmare || window.navigator.webdriver || window.Cypress)
-      return;
-
+  private getCommonTrackingFields() {
     let location: string | undefined;
-    let language: string;
+    let language: string = "en";
     try {
       const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
       location = this.timezoneToCountry[timezone];
       language =
         navigator.languages && navigator.languages.length
           ? navigator.languages[0]
-          : navigator.language || 'en';
+          : navigator.language || "en";
     } catch (error) {
-      console.error('Error resolving timezone or language:', error);
+      console.error("Error resolving timezone or language:", error);
     }
 
+    const url = new URL(window.location.href);
+    const params = new URLSearchParams(url.search);
+    return {
+      "user-agent": window.navigator.userAgent,
+      locale: language,
+      location,
+      referrer: document.referrer,
+      utm_source: params.get("utm_source"),
+      utm_medium: params.get("utm_medium"),
+      utm_campaign: params.get("utm_campaign"),
+      ref: params.get("ref"),
+    };
+  }
+
+  // Function to track page hits
+  private trackPageHit() {
+    if (window.__nightmare || window.navigator.webdriver || window.Cypress)
+      return;
+
     setTimeout(() => {
-      const url = new URL(window.location.href);
-      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,
         pathname: window.location.pathname,
         href: window.location.href,
-        utm_source: params.get('utm_source'),
-        utm_medium: params.get('utm_medium'),
-        utm_campaign: params.get('utm_campaign'),
-        ref: params.get('ref'),
       });
     }, 300);
   }
 
   private trackProvider(provider: EIP1193Provider) {
     if (provider === this._provider) {
-      console.log('Provider already tracked.');
       return;
     }
 
@@ -246,7 +250,6 @@ export class FormoAnalytics implements IFormoAnalytics {
       }
     }
 
-    console.log('Tracking new provider:', provider);
     this._provider = provider;
 
     this.getCurrentWallet();
@@ -254,33 +257,14 @@ export class FormoAnalytics implements IFormoAnalytics {
     this.registerChainChangedListener();
   }
 
-  private async getAndStoreConnectedAddress(): Promise<string | null> {
-    console.warn(
-      'Session data missing. Attempting to fetch address from provider.'
-    );
-    try {
-      const accounts = await this.fetchAccounts();
-      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;
-  }
-
   private async getCurrentWallet() {
     if (!this.provider) {
-      console.warn('FormoAnalytics::getCurrentWallet: the provider is not set');
+      console.warn("FormoAnalytics::getCurrentWallet: the provider is not set");
       return;
     }
-
     const sessionData = sessionStorage.getItem(this.walletAddressSessionKey);
-
     if (!sessionData) {
-      return await this.getAndStoreConnectedAddress();
+      return null;
     }
 
     const parsedData = JSON.parse(sessionData);
@@ -288,70 +272,22 @@ export class FormoAnalytics implements IFormoAnalytics {
     const currentTime = Date.now();
 
     if (currentTime - parsedData.timestamp > sessionExpiry) {
-      console.warn('Session expired. Ignoring wallet address.');
+      console.warn("Session expired. Ignoring wallet address.");
       sessionStorage.removeItem(this.walletAddressSessionKey); // Clear expired session data
-      return '';
+      return "";
     }
 
     this.onAddressConnected(parsedData.address);
-    return parsedData.address || '';
-  }
-
-  // Utility to fetch accounts
-  private async fetchAccounts(): Promise<string[] | null> {
-    try {
-      const res: string[] | null | undefined = await this.provider?.request({
-        method: 'eth_accounts',
-      });
-      if (!res || res.length === 0) {
-        console.error(
-          'error',
-          'FormoAnalytics::fetchAccounts: unable to get account. eth_accounts returned empty'
-        );
-        return null;
-      }
-      return res;
-    } catch (err) {
-      if ((err as any).code !== 4001) {
-        console.error(
-          'error',
-          'FormoAnalytics::fetchAccounts: eth_accounts threw an error',
-          err
-        );
-      }
-      return null;
-    }
-  }
-
-  // Utility to fetch chain ID
-  private async fetchChainId(): Promise<string | null> {
-    try {
-      const chainIdHex = await this.provider?.request<string>({
-        method: 'eth_chainId',
-      });
-      if (!chainIdHex) {
-        console.error(
-          'FormoAnalytics::fetchChainId: chainIdHex is null or undefined'
-        );
-        return null;
-      }
-      return chainIdHex;
-    } catch (err) {
-      console.error(
-        'error',
-        'FormoAnalytics::fetchChainId: eth_chainId threw an error',
-        err
-      );
-      return null;
-    }
+    return parsedData.address || "";
   }
 
   private async getCurrentChainId(): Promise<string> {
     if (!this.provider) {
-      console.error('FormoAnalytics::getCurrentChainId: provider not set');
+      console.error("FormoAnalytics::getCurrentChainId: provider not set");
     }
-
-    const chainIdHex = await this.fetchChainId();
+    const chainIdHex = await this.provider?.request<string>({
+      method: "eth_chainId",
+    });
     // Because we're connected, the chainId cannot be null
     if (!chainIdHex) {
       console.error(
@@ -366,19 +302,19 @@ export class FormoAnalytics implements IFormoAnalytics {
     const listener = (...args: unknown[]) =>
       this.onAddressChanged(args[0] as string[]);
 
-    this._provider?.on('accountsChanged', listener);
-    this._registeredProviderListeners['accountsChanged'] = listener;
+    this._provider?.on("accountsChanged", listener);
+    this._registeredProviderListeners["accountsChanged"] = listener;
 
     const onAddressDisconnected = this.onAddressDisconnected.bind(this);
-    this._provider?.on('disconnect', onAddressDisconnected);
-    this._registeredProviderListeners['disconnect'] = onAddressDisconnected;
+    this._provider?.on("disconnect", onAddressDisconnected);
+    this._registeredProviderListeners["disconnect"] = onAddressDisconnected;
   }
 
   private registerChainChangedListener() {
     const listener = (...args: unknown[]) =>
       this.onChainChanged(args[0] as string);
-    this.provider?.on('chainChanged', listener);
-    this._registeredProviderListeners['chainChanged'] = listener;
+    this.provider?.on("chainChanged", listener);
+    this._registeredProviderListeners["chainChanged"] = listener;
   }
 
   private async onAddressChanged(addresses: string[]) {
@@ -427,19 +363,20 @@ export class FormoAnalytics implements IFormoAnalytics {
     if (!this.currentConnectedAddress) {
       if (!this.provider) {
         console.error(
-          'error',
-          'FormoAnalytics::onChainChanged: provider not found. CHAIN_CHANGED not reported'
+          "error",
+          "FormoAnalytics::onChainChanged: provider not found. CHAIN_CHANGED not reported"
         );
         return;
       }
 
       try {
-        const res: string[] | null | undefined = await this.fetchAccounts();
-
+        const res: string[] | null | undefined = await this.provider.request({
+          method: "eth_accounts",
+        });
         if (!res || res.length === 0) {
           console.error(
-            'error',
-            'FormoAnalytics::onChainChanged: unable to get account. eth_accounts returned empty'
+            "error",
+            "FormoAnalytics::onChainChanged: unable to get account. eth_accounts returned empty"
           );
           return;
         }
@@ -450,7 +387,7 @@ export class FormoAnalytics implements IFormoAnalytics {
         if ((err as any).code !== 4001) {
           // 4001: The request is rejected by the user , see https://docs.metamask.io/wallet/reference/provider-api/#errors
           console.error(
-            'error',
+            "error",
             `FormoAnalytics::onChainChanged: unable to get account. eth_accounts threw an error`,
             err
           );
@@ -471,7 +408,7 @@ export class FormoAnalytics implements IFormoAnalytics {
    */
   private storeWalletAddress(address: string): void {
     if (!address) {
-      console.error('No wallet address provided to store.');
+      console.error("No wallet address provided to store.");
       return;
     }
 
@@ -500,10 +437,10 @@ export class FormoAnalytics implements IFormoAnalytics {
 
   connect({ chainId, address }: { chainId: ChainID; address: string }) {
     if (!chainId) {
-      throw new Error('FormoAnalytics::connect: chain ID cannot be empty');
+      throw new Error("FormoAnalytics::connect: chain ID cannot be empty");
     }
     if (!address) {
-      throw new Error('FormoAnalytics::connect: address cannot be empty');
+      throw new Error("FormoAnalytics::connect: address cannot be empty");
     }
 
     this.currentChainId = chainId.toString();
@@ -535,16 +472,16 @@ export class FormoAnalytics implements IFormoAnalytics {
 
   chain({ chainId, address }: { chainId: ChainID; address?: string }) {
     if (!chainId || Number(chainId) === 0) {
-      throw new Error('FormoAnalytics::chain: chainId cannot be empty or 0');
+      throw new Error("FormoAnalytics::chain: chainId cannot be empty or 0");
     }
     if (!address && !this.currentConnectedAddress) {
       throw new Error(
-        'FormoAnalytics::chain: address was empty and no previous address has been recorded. You can either pass an address 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'
+        "FormoAnalytics::chain: chainId must be a valid hex or decimal number"
       );
     }
 

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;
 }