@formo/analytics 1.11.9 → 1.11.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formo/analytics",
-  "version": "1.11.9",
+  "version": "1.11.11",
   "repository": {
     "type": "git",
     "url": "https://github.com/getformo/sdk.git"

package/src/FormoAnalytics.ts

@@ -12,11 +12,7 @@ interface IFormoAnalytics {
   /**
    * Initializes the FormoAnalytics instance with the provided API key and project ID.
    */
-  init(
-    apiKey: string,
-    projectId: string,
-    options?: Options
-  ): Promise<FormoAnalytics>;
+  init(apiKey: string, options?: Options): Promise<FormoAnalytics>;
 
   /**
    * Tracks page visit events.
@@ -63,7 +59,6 @@ export class FormoAnalytics implements IFormoAnalytics {
 
   private constructor(
     public readonly apiKey: string,
-    public readonly projectId: string,
     public options: Options = {}
   ) {
     this.config = {
@@ -79,13 +74,12 @@ export class FormoAnalytics implements IFormoAnalytics {
 
   static async init(
     apiKey: string,
-    projectId: string,
     options?: Options
   ): Promise<FormoAnalytics> {
     const config = {
       token: apiKey,
     };
-    const instance = new FormoAnalytics(apiKey, projectId, options);
+    const instance = new FormoAnalytics(apiKey, options);
     instance.config = config;
 
     return instance;
@@ -197,39 +191,76 @@ export class FormoAnalytics implements IFormoAnalytics {
 
   // Function to track page hits
   private trackPageHit() {
-    if (window.__nightmare || window.navigator.webdriver || window.Cypress)
-      return;
+    if (this.isAutomationEnvironment()) return;
 
-    let location: string | undefined;
-    let language: string;
+    const location = this.getUserLocation();
+    const language = this.getUserLanguage();
+
+    setTimeout(async () => {
+      const eventData = await this.buildPageEventData(location, language);
+      this.trackEvent(Event.PAGE, eventData);
+    }, 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';
     }
+  }
 
-    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);
+  async buildPageEventData(location: string | undefined, language: string): Promise<Record<string, unknown>> {
+    const url = new URL(window.location.href);
+    const params = new URLSearchParams(url.search);
+  
+    const address = await this.getAndStoreConnectedAddress();
+    if (address === null) {
+      console.warn('Wallet address could not be retrieved.');
+    }
+  
+    const eventData: Record<string, unknown> = {
+      'user-agent': window.navigator.userAgent,
+      locale: language,
+      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'),
+    };
+  
+    if (address !== null) {
+      eventData['address'] = address;
+    }
+  
+    return eventData;
   }
 
   private trackProvider(provider: EIP1193Provider) {
@@ -260,6 +291,23 @@ 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');
@@ -269,22 +317,7 @@ export class FormoAnalytics implements IFormoAnalytics {
     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;
+      return await this.getAndStoreConnectedAddress();
     }
 
     const parsedData = JSON.parse(sessionData);
@@ -301,13 +334,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(
@@ -369,7 +450,7 @@ export class FormoAnalytics implements IFormoAnalytics {
 
     const payload = {
       chain_id: this.currentChainId,
-      address: this.currentConnectedAddress,
+      address: this.getAndStoreConnectedAddress(),
     };
     this.currentChainId = undefined;
     this.currentConnectedAddress = undefined;
@@ -389,37 +470,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'
+      );
+    }
   }
 
   /**
@@ -450,8 +525,8 @@ export class FormoAnalytics implements IFormoAnalytics {
     sessionStorage.removeItem(this.walletAddressSessionKey);
   }
 
-  init(apiKey: string, projectId: string, options: Options): Promise<FormoAnalytics> {
-    const instance = new FormoAnalytics(apiKey, projectId, options);
+  init(apiKey: string, options: Options): Promise<FormoAnalytics> {
+    const instance = new FormoAnalytics(apiKey, options);
     return Promise.resolve(instance);
   }
 

package/src/FormoAnalyticsProvider.tsx

@@ -19,7 +19,6 @@ export const FormoAnalyticsContext = createContext<FormoAnalytics | undefined>(
 export const FormoAnalyticsProvider = ({
   apiKey,
   options,
-  projectId,
   disabled,
   children,
 }: FormoAnalyticsProviderProps) => {
@@ -62,7 +61,7 @@ export const FormoAnalyticsProvider = ({
 
       // Initialize FormoAnalytics
       try {
-        const sdkInstance = await FormoAnalytics.init(apiKey, projectId, options);
+        const sdkInstance = await FormoAnalytics.init(apiKey, options);
         setSdk(sdkInstance);
         console.log('FormoAnalytics SDK initialized successfully');
       } catch (error) {

package/src/types/base.ts

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