@formo/analytics 1.11.13 → 1.11.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formo/analytics",
-  "version": "1.11.13",
+  "version": "1.11.14",
   "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

@@ -12,7 +12,7 @@ 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.
@@ -72,7 +72,10 @@ 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,
     };
@@ -139,11 +142,7 @@ export class FormoAnalytics implements IFormoAnalytics {
       timestamp: new Date().toISOString(),
       action,
       version: "1",
-      payload: {
-        // common fields
-        ...this.getCommonTrackingFields(),
-        ...payload,
-      },
+      payload: await this.buildEventPayload(...payload),
     };
 
     const sendRequest = async (): Promise<void> => {
@@ -190,24 +189,71 @@ export class FormoAnalytics implements IFormoAnalytics {
     await sendRequest();
   }
 
-  private getCommonTrackingFields() {
-    let location: string | undefined;
-    let language: string = "en";
+  // Function to track page hits
+  private trackPageHit() {
+    if (this.isAutomationEnvironment()) return;
+
+    const pathname = window.location.pathname;
+    const href = window.location.href;
+
+    setTimeout(async () => {
+      this.trackEvent(Event.PAGE, {
+        pathname,
+        href,
+      });
+    }, 300);
+  }
+
+  private isAutomationEnvironment(): boolean {
+    return (
+      window.__nightmare ||
+      window.navigator.webdriver ||
+      window.Cypress ||
+      false
+    );
+  }
+
+  private getUserLocation(): string | undefined {
     try {
       const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
-      location = this.timezoneToCountry[timezone];
-      language =
-        navigator.languages && navigator.languages.length
+      return this.timezoneToCountry[timezone];
+    } catch (error) {
+      console.error("Error resolving timezone:", error);
+      return undefined;
+    }
+  }
+
+  private getUserLanguage(): string {
+    try {
+      return (
+        (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 language:", error);
+      return "en";
     }
+  }
 
+  async buildEventPayload(
+    eventSpecificPayload: Record<string, unknown> = {}
+  ): Promise<Record<string, unknown>> {
     const url = new URL(window.location.href);
     const params = new URLSearchParams(url.search);
+
+    const location = this.getUserLocation();
+    const language = this.getUserLanguage();
+
+    const address = await this.getAndStoreConnectedAddress();
+    if (address === null) {
+      console.warn("Wallet address could not be retrieved.");
+    }
+
+    // common fields
     return {
       "user-agent": window.navigator.userAgent,
+      address,
       locale: language,
       location,
       referrer: document.referrer,
@@ -215,24 +261,13 @@ export class FormoAnalytics implements IFormoAnalytics {
       utm_medium: params.get("utm_medium"),
       utm_campaign: params.get("utm_campaign"),
       ref: params.get("ref"),
+      ...eventSpecificPayload,
     };
   }
 
-  // Function to track page hits
-  private trackPageHit() {
-    if (window.__nightmare || window.navigator.webdriver || window.Cypress)
-      return;
-
-    setTimeout(() => {
-      this.trackEvent(Event.PAGE, {
-        pathname: window.location.pathname,
-        href: window.location.href,
-      });
-    }, 300);
-  }
-
   private trackProvider(provider: EIP1193Provider) {
     if (provider === this._provider) {
+      console.log("Provider already tracked.");
       return;
     }
 
@@ -250,6 +285,7 @@ export class FormoAnalytics implements IFormoAnalytics {
       }
     }
 
+    console.log("Tracking new provider:", provider);
     this._provider = provider;
 
     this.getCurrentWallet();
@@ -257,14 +293,33 @@ export class FormoAnalytics implements IFormoAnalytics {
     this.registerChainChangedListener();
   }
 
+  private async getAndStoreConnectedAddress(): Promise<string | null> {
+    console.log(
+      "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");
       return;
     }
+
     const sessionData = sessionStorage.getItem(this.walletAddressSessionKey);
+
     if (!sessionData) {
-      return null;
+      return await this.getAndStoreConnectedAddress();
     }
 
     const parsedData = JSON.parse(sessionData);
@@ -281,13 +336,61 @@ export class FormoAnalytics implements IFormoAnalytics {
     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;
+    }
+  }
+
   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",
-    });
+
+    const chainIdHex = await this.fetchChainId();
     // Because we're connected, the chainId cannot be null
     if (!chainIdHex) {
       console.error(
@@ -349,7 +452,7 @@ export class FormoAnalytics implements IFormoAnalytics {
 
     const payload = {
       chain_id: this.currentChainId,
-      address: this.currentConnectedAddress,
+      address: this.getAndStoreConnectedAddress(),
     };
     this.currentChainId = undefined;
     this.currentConnectedAddress = undefined;
@@ -369,37 +472,31 @@ export class FormoAnalytics implements IFormoAnalytics {
         return;
       }
 
-      try {
-        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"
-          );
-          return;
-        }
-
-        this.currentConnectedAddress = res[0];
-      } catch (err) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        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",
-            `FormoAnalytics::onChainChanged: unable to get account. eth_accounts threw an error`,
-            err
-          );
-          return;
-        }
+      // Attempt to fetch and store the connected address
+      const address = await this.getAndStoreConnectedAddress();
+      if (!address) {
+        console.error(
+          "error",
+          "FormoAnalytics::onChainChanged: Unable to fetch or store connected address"
+        );
+        return;
       }
+
+      this.currentConnectedAddress = address[0];
     }
 
-    return this.chain({
-      chainId: this.currentChainId,
-      address: this.currentConnectedAddress,
-    });
+    // Proceed only if the address exists
+    if (this.currentConnectedAddress) {
+      return this.chain({
+        chainId: this.currentChainId,
+        address: this.currentConnectedAddress,
+      });
+    } else {
+      console.error(
+        "error",
+        "FormoAnalytics::onChainChanged: currentConnectedAddress is null despite fetch attempt"
+      );
+    }
   }
 
   /**

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