@formo/analytics 1.12.0-alpha.3 → 2.0.0-alpha.1

package/package.json

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

package/src/FormoAnalytics.ts

@@ -10,49 +10,19 @@ import { H } from 'highlight.run';
 import { ChainID, EIP1193Provider, RequestArguments } from './types';
 
 interface IFormoAnalytics {
-  /**
-   * Initializes the FormoAnalytics instance with the provided API key and project ID.
-   */
   init(apiKey: string, projectId: string): Promise<FormoAnalytics>;
-
-  /**
-   * Identifies the user with the provided user data.
-   */
-  identify(userData: Record<string, any>): void;
-
-  /**
-   * Tracks page visit events.
-   */
+  identify(userData: any): void;
   page(): void;
-
-  /**
-   * Connects to a wallet with the specified chain ID and address.
-   */
-  connect(params: { account: string; chainId: ChainID }): Promise<void>;
-
-  /**
-   * Disconnects the current wallet and clears the session information.
-   */
-  disconnect(attributes?: { account?: string; chainId?: ChainID }): void;
-
-  /**
-   * Tracks a specific event with a name and associated data.
-   */
-  track(eventName: string, eventData: Record<string, any>): void;
-
-  /**
-   * Switches the blockchain chain context and optionally logs additional attributes.
-   */
-  chain(attributes: { chainId: ChainID; account?: string }): void;
+  track(eventName: string, eventData: any): void;
 }
 export class FormoAnalytics implements IFormoAnalytics {
   private _provider?: EIP1193Provider;
+  private _originalRequest?: EIP1193Provider['request'];
   private _registeredProviderListeners: Record<
     string,
     (...args: unknown[]) => void
   > = {};
 
-  private sessionKey = 'walletAddress';
   private config: any;
   private sessionIdKey: string = SESSION_STORAGE_ID_KEY;
   private timezoneToCountry: Record<string, string> = COUNTRY_LIST;
@@ -92,7 +62,7 @@ export class FormoAnalytics implements IFormoAnalytics {
   }
 
   private identifyUser(userData: any) {
-    this.trackEvent(Event.IDENTIFY, userData);
+    this.trackEvent('identify', userData);
   }
 
   private getSessionId() {
@@ -276,7 +246,7 @@ export class FormoAnalytics implements IFormoAnalytics {
     setTimeout(() => {
       const url = new URL(window.location.href);
       const params = new URLSearchParams(url.search);
-      this.trackEvent(Event.PAGE, {
+      this.trackEvent('page_hit', {
         'user-agent': window.navigator.userAgent,
         locale: language,
         location: location,
@@ -308,13 +278,24 @@ export class FormoAnalytics implements IFormoAnalytics {
         );
         delete this._registeredProviderListeners[eventName];
       }
+
+      // Restore original request
+      if (
+        this._originalRequest &&
+        Object.getOwnPropertyDescriptor(this._provider, 'request')?.writable !==
+          false
+      ) {
+        this._provider.request = this._originalRequest;
+      }
     }
 
     this._provider = provider;
+    this._originalRequest = provider?.request;
 
     this.getCurrentWallet();
     this.registerAccountsChangedListener();
     this.registerChainChangedListener();
+    this.trackSigning();
   }
 
   private registerChainChangedListener() {
@@ -330,12 +311,11 @@ export class FormoAnalytics implements IFormoAnalytics {
     }
 
     const disconnectAttributes = {
-      address: this.currentConnectedAccount,
+      account: this.currentConnectedAccount,
       chainId: this.currentChainId,
     };
     this.currentChainId = undefined;
     this.currentConnectedAccount = undefined;
-    this.clearWalletAddress();
 
     return this.trackEvent(Event.DISCONNECT, disconnectAttributes);
   }
@@ -353,12 +333,12 @@ export class FormoAnalytics implements IFormoAnalytics {
 
       try {
         const res: string[] | null | undefined = await this.provider.request({
-          method: 'eth_accounts',
+          method: 'eth_requestAccounts',
         });
         if (!res || res.length === 0) {
           console.error(
             'error',
-            'FormoAnalytics::onChainChanged: unable to get account. eth_accounts returned empty'
+            'FormoAnalytics::onChainChanged: unable to get account. eth_requestAccounts returned empty'
           );
           return;
         }
@@ -370,7 +350,7 @@ export class FormoAnalytics implements IFormoAnalytics {
           // 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`,
+            `FormoAnalytics::onChainChanged: unable to get account. eth_requestAccounts threw an error`,
             err
           );
           return;
@@ -386,10 +366,7 @@ export class FormoAnalytics implements IFormoAnalytics {
 
   private async onAccountsChanged(accounts: string[]) {
     if (accounts.length > 0) {
-      const newAccount = accounts[0];
-      if (newAccount !== this.currentConnectedAccount) {
-        this.handleAccountConnected(newAccount);
-      }
+      this.handleAccountConnected(accounts[0]);
     } else {
       this.handleAccountDisconnected();
     }
@@ -407,6 +384,49 @@ export class FormoAnalytics implements IFormoAnalytics {
     this._registeredProviderListeners['disconnect'] = handleAccountDisconnected;
   }
 
+  private trackSigning() {
+    if (!this.provider) {
+      console.error(
+        'error',
+        'FormoAnalytics::_trackSigning: provider not found'
+      );
+      return false;
+    }
+
+    if (
+      Object.getOwnPropertyDescriptor(this.provider, 'request')?.writable ===
+      false
+    ) {
+      console.error(
+        'warning',
+        'FormoAnalytics::_trackSigning: provider.request is not writable'
+      );
+      return false;
+    }
+
+    // Deliberately not using this._original request to not interfere with the transaction tracking's
+    // request modification
+    const request = this.provider.request.bind(this.provider);
+    this.provider.request = async ({ method, params }: RequestArguments) => {
+      if (Array.isArray(params)) {
+        if (['signTypedData_v4', 'eth_sign'].includes(method)) {
+          this.trackEvent(Event.SIGNING_TRIGGERED, {
+            account: params[0],
+            message: params[1],
+          });
+        }
+        if (method === 'personal_sign') {
+          this.trackEvent(Event.SIGNING_TRIGGERED, {
+            message: params[0],
+            account: params[1],
+          });
+        }
+      }
+      return request({ method, params });
+    };
+    return true;
+  }
+
   private async getCurrentChainId(): Promise<string> {
     if (!this.provider) {
       console.error('FormoAnalytics::getCurrentChainId: provider not set');
@@ -435,8 +455,7 @@ export class FormoAnalytics implements IFormoAnalytics {
 
     this.currentChainId = await this.getCurrentChainId();
 
-    this.connect({ account, chainId: this.currentChainId });
-    this.storeWalletAddress(account);
+    return this.connect({ chainId: this.currentChainId, address: account });
   }
 
   private async getCurrentWallet() {
@@ -444,49 +463,21 @@ export class FormoAnalytics implements IFormoAnalytics {
       console.warn('FormoAnalytics::getCurrentWallet: the provider is not set');
       return;
     }
-    const sessionData = sessionStorage.getItem(this.sessionKey);
-
-    if (!sessionData) {
-      return null;
-    }
+    try {
+      const accounts = await this.provider.request<string[]>({
+        method: 'eth_accounts',
+      });
 
-    const parsedData = JSON.parse(sessionData);
-    const sessionExpiry = 30 * 60 * 1000; // 30 minutes
-    const currentTime = Date.now();
+      if (accounts && accounts.length > 0 && accounts[0]) {
+        this.handleAccountConnected(accounts[0]);
+        return accounts && accounts.length > 0 && accounts[0];
+      }
 
-    if (currentTime - parsedData.timestamp > sessionExpiry) {
-      console.warn('Session expired. Ignoring wallet address.');
-      sessionStorage.removeItem(this.sessionKey); // Clear expired session data
+      return '';
+    } catch (error) {
+      console.error('Failed to fetch connected address:', error);
       return '';
     }
-
-    this.handleAccountConnected(parsedData.address);
-    return parsedData.address || '';
-  }
-
-  /**
-   * Stores the wallet address in session storage when connected.
-   * @param address - The wallet address to store.
-   */
-  private storeWalletAddress(address: string): void {
-    if (!address) {
-      console.error('No wallet address provided to store.');
-      return;
-    }
-
-    const sessionData = {
-      address,
-      timestamp: Date.now(),
-    };
-
-    sessionStorage.setItem(this.sessionKey, JSON.stringify(sessionData));
-  }
-
-  /**
-   * Clears the wallet address from session storage when disconnected.
-   */
-  private clearWalletAddress(): void {
-    sessionStorage.removeItem(this.sessionKey);
   }
 
   // Function to build the API URL
@@ -507,20 +498,20 @@ export class FormoAnalytics implements IFormoAnalytics {
     return 'Error: No token provided';
   }
 
-  connect({ account, chainId }: { account: string; chainId: ChainID }) {
+  connect({ chainId, address }: { chainId: ChainID; address: string }): void {
     if (!chainId) {
-      throw new Error('FormoAnalytics::connect: chainId cannot be empty');
+      throw new Error('FormoAnalytics::wallet: chainId cannot be empty');
     }
-    if (!account) {
-      throw new Error('FormoAnalytics::connect: account cannot be empty');
+    if (!address) {
+      throw new Error('FormoAnalytics::wallet: account cannot be empty');
     }
 
     this.currentChainId = chainId.toString();
-    this.currentConnectedAccount = account;
+    this.currentConnectedAccount = address;
 
-    return this.trackEvent(Event.CONNECT, {
+    this.trackEvent(Event.CONNECT, {
       chainId,
-      address: account,
+      address,
     });
   }
 
@@ -551,7 +542,7 @@ export class FormoAnalytics implements IFormoAnalytics {
 
     if (!account && !this.currentConnectedAccount) {
       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: account was empty and no previous account has been recorded. You can either pass an account or call wallet() first'
       );
     }
 

package/src/constants/events.ts

@@ -1,7 +1,9 @@
 export enum Event {
-  IDENTIFY = 'identify',
-  PAGE = 'page_hit',
+  PAGE = 'page',
   CONNECT = 'connect',
   DISCONNECT = 'disconnect',
   CHAIN_CHANGED = 'chain_changed',
-}
+  SIGNING_TRIGGERED = 'signing_triggered',
+  CLICK = 'click',
+  CUSTOM = 'custom',
+}

package/src/types/index.ts

@@ -1,2 +1,2 @@
 export * from './base';
-export * from './wallet'
+export * from './web3'

package/dist/cjs/src/types/wallet.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../../../../src/types/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,QAAQ,CAAA;AAEjC,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC7C;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,CAAA;IACjE,EAAE,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,GAAG,IAAI,CAAA;IAC5E,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,GAAG,IAAI,CAAA;CACzF"}

package/dist/cjs/src/types/wallet.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"wallet.js","sourceRoot":"","sources":["../../../../src/types/wallet.ts"],"names":[],"mappings":""}

package/dist/esm/src/types/wallet.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../../../../src/types/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,QAAQ,CAAA;AAEjC,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC7C;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC,CAAA;IACjE,EAAE,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,GAAG,IAAI,CAAA;IAC5E,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,GAAG,IAAI,CAAA;CACzF"}

package/dist/esm/src/types/wallet.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=wallet.js.map

package/dist/esm/src/types/wallet.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"wallet.js","sourceRoot":"","sources":["../../../../src/types/wallet.ts"],"names":[],"mappings":""}