@formo/analytics 2.0.0-alpha.4 → 2.0.0-alpha.6

package/package.json

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

package/src/FormoAnalytics.ts

@@ -10,10 +10,40 @@ 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>;
-  identify(userData: any): void;
+
+  /**
+   * Identifies the user with the provided user data.
+   */
+  identify(userData: Record<string, any>): void;
+
+  /**
+   * Tracks page visit events.
+   */
   page(): void;
-  track(eventName: string, eventData: any): void;
+
+  /**
+   * Tracks a specific event with a name and associated data.
+   */
+  track(eventName: string, eventData: Record<string, any>): void;
+
+  /**
+   * Connects to a wallet with the specified chain ID and address.
+   */
+  connect(params: { chainId: ChainID; address: string }): Promise<void>;
+
+  /**
+   * Disconnects the current wallet and clears the session information.
+   */
+  disconnect(attributes?: { account?: string; chainId?: ChainID }): void;
+  
+  /**
+   * Switches the blockchain chain context and optionally logs additional attributes.
+   */
+  chain(attributes: { chainId: ChainID; account?: string }): void;
 }
 export class FormoAnalytics implements IFormoAnalytics {
   private _provider?: EIP1193Provider;
@@ -40,7 +70,6 @@ export class FormoAnalytics implements IFormoAnalytics {
 
     const provider = window?.ethereum || window.web3?.currentProvider;
     if (provider) {
-      console.log('FormoAnalytics: Provider is set');
       this.trackProvider(provider);
     }
   }
@@ -111,8 +140,6 @@ export class FormoAnalytics implements IFormoAnalytics {
     const apiUrl = this.buildApiUrl();
     const address = await this.getCurrentWallet();
 
-    console.log('address: ', address);
-
     const requestData = {
       project_id: this.projectId,
       address: address,
@@ -265,10 +292,7 @@ export class FormoAnalytics implements IFormoAnalytics {
   }
 
   private trackProvider(provider: EIP1193Provider) {
-    console.log('Provider: ', provider);
-    console.log('this._provider: ', this._provider);
     if (provider === this._provider) {
-      console.log('provider === this._provider');
       return;
     }
 
@@ -305,7 +329,6 @@ export class FormoAnalytics implements IFormoAnalytics {
   }
 
   private registerChainChangedListener() {
-    console.log('registerChainChangedListener is emitted');
     const listener = (...args: unknown[]) =>
       this.onChainChanged(args[0] as string);
     this.provider?.on('chainChanged', listener);
@@ -383,7 +406,6 @@ export class FormoAnalytics implements IFormoAnalytics {
   }
 
   private registerAccountsChangedListener() {
-    console.log('registerAccountsChangedListener is emitted');
     const listener = (...args: unknown[]) =>
       this.onAccountsChanged(args[0] as string[]);
 
@@ -404,8 +426,6 @@ export class FormoAnalytics implements IFormoAnalytics {
       return false;
     }
 
-    console.log('trackSigning is emitted');
-
     if (
       Object.getOwnPropertyDescriptor(this.provider, 'request')?.writable ===
       false
@@ -480,7 +500,6 @@ export class FormoAnalytics implements IFormoAnalytics {
       const accounts = await this.provider.request<string[]>({
         method: 'eth_accounts',
       });
-
       if (accounts && accounts.length > 0 && accounts[0]) {
         this.handleAccountConnected(accounts[0]);
         return accounts && accounts.length > 0 && accounts[0];
@@ -511,18 +530,18 @@ export class FormoAnalytics implements IFormoAnalytics {
     return 'Error: No token provided';
   }
 
-  connect({ chainId, address }: { chainId: ChainID; address: string }): void {
+  connect({ chainId, address }: { chainId: ChainID; address: string }) {
     if (!chainId) {
-      throw new Error('FormoAnalytics::wallet: chainId cannot be empty');
+      throw new Error('FormoAnalytics::connect: chainId cannot be empty');
     }
     if (!address) {
-      throw new Error('FormoAnalytics::wallet: account cannot be empty');
+      throw new Error('FormoAnalytics::connect: account cannot be empty');
     }
 
     this.currentChainId = chainId.toString();
     this.currentConnectedAccount = address;
 
-    this.trackEvent(Event.CONNECT, {
+    return this.trackEvent(Event.CONNECT, {
       chainId,
       address,
     });
@@ -555,7 +574,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 wallet() first'
+        'FormoAnalytics::chain: account was empty and no previous account has been recorded. You can either pass an account or call connect() first'
       );
     }