@formo/analytics 1.16.0 → 1.16.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formo/analytics",
-  "version": "1.16.0",
+  "version": "1.16.2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/getformo/sdk.git"
@@ -21,6 +21,7 @@
   },
   "license": "MIT",
   "dependencies": {
+    "ethereum-cryptography": "^3.1.0",
     "fetch-retry": "^6.0.0",
     "is-network-error": "^1.1.0",
     "mipd": "^0.0.7"
@@ -32,6 +33,8 @@
     "@commitlint/cli": "^17.3.0",
     "@commitlint/config-conventional": "^17.3.0",
     "@semantic-release/github": "^8.0.7",
+    "@size-limit/esbuild": "^11.2.0",
+    "@size-limit/file": "^11.2.0",
     "@testing-library/react": "^13.4.0",
     "@types/chai": "^4.3.1",
     "@types/jsdom": "^20.0.1",
@@ -60,6 +63,7 @@
     "semantic-release-export-data": "^1.0.1",
     "sinon": "^14.0.0",
     "sinon-chai": "^3.7.0",
+    "size-limit": "^11.2.0",
     "ts-loader": "^9.3.1",
     "ts-node": "^10.8.2",
     "typescript": "^5.7.3",
@@ -68,7 +72,7 @@
   },
   "scripts": {
     "prebuild": "yarn clean",
-    "build": "yarn test && yarn build-cjs && yarn build-esm && yarn webpack --mode=production",
+    "build": "yarn test && yarn build-cjs && yarn build-esm && yarn webpack --mode=production && yarn size",
     "build-cjs": "yarn tsc --build",
     "build-esm": "yarn tsc -m es6 --outdir dist/esm",
     "clean": "rm -rf dist",
@@ -77,8 +81,15 @@
     "test-watch": "nodemon --config test.nodemon.json",
     "prepare": "husky install",
     "commit": "git add . && cz",
-    "pub": "yarn build && npm publish"
+    "pub": "yarn build && npm publish",
+    "size": "size-limit"
   },
+  "size-limit": [
+    {
+      "path": "dist/index.umd.min.js",
+      "limit": "50 KB"
+    }
+  ],
   "peerDependencies": {
     "@types/react": ">=16.14.34",
     "react": ">=16.14.0"

package/src/FormoAnalytics.ts

@@ -1,33 +1,35 @@
+import { UUID } from "crypto";
 import { createStore, EIP6963ProviderDetail } from "mipd";
 import {
+  Event,
+  EVENTS_API_URL,
   LOCAL_ANONYMOUS_ID_KEY,
-  COUNTRY_LIST,
   SESSION_CURRENT_URL_KEY,
-  EVENTS_API_URL,
-  Event,
   SESSION_USER_ID_KEY,
+  SESSION_WALLET_DETECTED_KEY,
 } from "./constants";
 import {
-  ChainID,
+  EventFactory,
+  EventQueue,
+  IEventFactory,
+  local,
+  logger,
+  Logger,
+  session,
+} from "./lib";
+import {
   Address,
+  ChainID,
+  Config,
   EIP1193Provider,
   Options,
-  Config,
   RequestArguments,
   RPCError,
   SignatureStatus,
   TransactionStatus,
-  RequestEvent,
 } from "./types";
-import { session, local, logger, EventQueue, Logger } from "./lib";
-import {
-  isLocalhost,
-  isAddress,
-  toSnakeCase,
-  generateNativeUUID,
-} from "./utils";
-import { SESSION_WALLET_DETECTED_KEY } from "./constants";
-import { UUID } from "crypto";
+import { generateNativeUUID } from "./utils";
+import { isAddress, isArray, isLocalhost } from "./validators";
 
 interface IFormoAnalytics {
   page(): void;
@@ -35,28 +37,14 @@ interface IFormoAnalytics {
   connect(params: { chainId: ChainID; address: Address }): Promise<void>;
   disconnect(params?: { chainId?: ChainID; address?: Address }): Promise<void>;
   chain(params: { chainId: ChainID; address?: Address }): Promise<void>;
-  signature({
-    status,
-    chainId,
-    address,
-    message,
-    signatureHash,
-  }: {
+  signature(params: {
     status: SignatureStatus;
     chainId?: ChainID;
     address: Address;
     message: string;
     signatureHash?: string;
   }): Promise<void>;
-  transaction({
-    status,
-    chainId,
-    address,
-    data,
-    to,
-    value,
-    transactionHash,
-  }: {
+  transaction(params: {
     status: TransactionStatus;
     chainId: ChainID;
     address: Address;
@@ -65,7 +53,16 @@ interface IFormoAnalytics {
     value?: string;
     transactionHash?: string;
   }): Promise<void>;
-  identify(params: { address: Address }): Promise<void>;
+  identify(
+    params:
+      | {
+          address: Address | null;
+          providerName?: string;
+          userId?: string;
+          rdns?: string;
+        }
+      | readonly EIP6963ProviderDetail[]
+  ): Promise<void>;
   track(action: string, payload: Record<string, any>): Promise<void>;
 }
 
@@ -76,6 +73,7 @@ export class FormoAnalytics implements IFormoAnalytics {
   private eventQueue: EventQueue;
   private anonymousId: UUID | null = null;
   private userId: string | null = null;
+  private eventFactory: IEventFactory;
 
   config: Config;
   currentChainId?: ChainID;
@@ -98,6 +96,8 @@ export class FormoAnalytics implements IFormoAnalytics {
       enabledLevels: options.logger?.levels || [],
     });
 
+    this.eventFactory = new EventFactory();
+
     this.eventQueue = new EventQueue(this.config.writeKey, {
       url: EVENTS_API_URL,
       flushAt: options.flushAt,
@@ -127,7 +127,7 @@ export class FormoAnalytics implements IFormoAnalytics {
 
     // Detect
     const providers = await analytics.getProviders();
-    await analytics.detectWallets(providers);
+    await analytics.detects(providers);
 
     return analytics;
   }
@@ -309,27 +309,66 @@ export class FormoAnalytics implements IFormoAnalytics {
   }
 
   /**
-   * Emits an identify event with current wallet address.
-   * @param {Address} params.address
+   * Emits an detect event with current wallet provider info.
+   * @param {string} params.providerName
+   * @param {string} params.rdns
+   * @param {string} params.userId
+   * @param {string} params.address
+   *
    * @returns {Promise<void>}
    */
-  public async identify({
-    address,
-    providerName,
-    userId,
-    rdns,
-  }: {
-    address: Address | null;
-    providerName?: string;
-    userId?: string;
-    rdns?: string;
-  }): Promise<void> {
-    if (userId) this.userId = userId || null;
-    await this.trackEvent(Event.IDENTIFY, {
-      address,
-      providerName,
-      rdns,
-    });
+  public async identify(
+    params:
+      | {
+          address: Address | null;
+          providerName?: string;
+          userId?: string;
+          rdns?: string;
+        }
+      | readonly EIP6963ProviderDetail[]
+  ): Promise<void> {
+    if (isArray(params)) {
+      try {
+        for (const eip6963ProviderDetail of params) {
+          if (!eip6963ProviderDetail) continue;
+          const accounts = await this.getAccounts(
+            eip6963ProviderDetail?.provider
+          );
+          // Identify with accounts
+          if (accounts && accounts.length > 0) {
+            for (const address of accounts) {
+              await this.identify({
+                address,
+                providerName: eip6963ProviderDetail?.info.name,
+                rdns: eip6963ProviderDetail?.info.rdns,
+              });
+            }
+          } else {
+            // Identify without accounts
+            await this.identify({
+              address: null,
+              providerName: eip6963ProviderDetail?.info.name,
+              rdns: eip6963ProviderDetail?.info.rdns,
+            });
+          }
+        }
+      } catch (err) {
+        logger.error("Error identifying all:", err);
+      }
+    } else {
+      const { userId, address, providerName, rdns } = params as {
+        address: Address | null;
+        providerName?: string;
+        userId?: string;
+        rdns?: string;
+      };
+      if (userId) this.userId = userId || null;
+      await this.trackEvent(Event.IDENTIFY, {
+        address,
+        providerName,
+        rdns,
+      });
+    }
   }
 
   /**
@@ -337,7 +376,7 @@ export class FormoAnalytics implements IFormoAnalytics {
    * @param {Address} params.address
    * @returns {Promise<void>}
    */
-  private async detectWallet({
+  private async detect({
     providerName,
     rdns,
   }: {
@@ -346,7 +385,7 @@ export class FormoAnalytics implements IFormoAnalytics {
   }): Promise<void> {
     if (this.session.isWalletDetected(rdns))
       return logger.warn(
-        `detectWallet: Wallet ${providerName} already detected in this session`
+        `detect: Wallet ${providerName} already detected in this session`
       );
 
     this.session.markWalletdetected(rdns);
@@ -646,9 +685,6 @@ export class FormoAnalytics implements IFormoAnalytics {
   }
 
   private trackPageHit(): void {
-    const pathname = window.location.pathname;
-    const hash = window.location.hash;
-
     if (!this.config.trackLocalhost && isLocalhost()) {
       return logger.warn(
         "Track page hit: Ignoring event because website is running locally"
@@ -656,31 +692,24 @@ export class FormoAnalytics implements IFormoAnalytics {
     }
 
     setTimeout(async () => {
-      this.trackEvent(Event.PAGE, {
-        pathname,
-        hash,
-      });
+      this.trackEvent(Event.PAGE);
     }, 300);
   }
 
-  private async trackEvent(action: string, payload: any): Promise<void> {
+  private async trackEvent(action: string, payload?: any): Promise<void> {
     try {
       const address = await this.getAddress();
       const user_id = this.userId;
 
-      if (payload?.userId) {
-        delete payload.userId;
-      }
-
-      const requestData: RequestEvent = {
-        anonymous_id: this.anonymousId as UUID,
+      const requestData = this.eventFactory.create(
+        this.anonymousId as UUID,
         user_id,
-        address: address?.toLowerCase() || null,
-        timestamp: new Date().toISOString(),
-        action,
-        version: "1",
-        payload: await this.buildEventPayload(toSnakeCase(payload)),
-      };
+        address,
+        {
+          action,
+          ...payload,
+        }
+      );
 
       await this.eventQueue.enqueue(requestData, (err, _, data) => {
         if (err) {
@@ -709,12 +738,12 @@ export class FormoAnalytics implements IFormoAnalytics {
     return providers;
   }
 
-  private async detectWallets(
+  private async detects(
     providers: readonly EIP6963ProviderDetail[]
   ): Promise<void> {
     try {
       for (const eip6963ProviderDetail of providers) {
-        await this.detectWallet({
+        await this.detect({
           providerName: eip6963ProviderDetail?.info.name,
           rdns: eip6963ProviderDetail?.info.rdns,
         });
@@ -724,39 +753,6 @@ export class FormoAnalytics implements IFormoAnalytics {
     }
   }
 
-  // TODO: Refactoring => public this function as API
-  // private async identifyAll(
-  //   providers: readonly EIP6963ProviderDetail[]
-  // ): Promise<void> {
-  //   try {
-  //     for (const eip6963ProviderDetail of providers) {
-  //       if (!eip6963ProviderDetail) continue;
-  //       const accounts = await this.getAccounts(
-  //         eip6963ProviderDetail?.provider
-  //       );
-  //       // Identify with accounts
-  //       if (accounts && accounts.length > 0) {
-  //         for (const address of accounts) {
-  //           await this.identify({
-  //             address,
-  //             providerName: eip6963ProviderDetail?.info.name,
-  //             rdns: eip6963ProviderDetail?.info.rdns,
-  //           });
-  //         }
-  //       } else {
-  //         // Identify without accounts
-  //         await this.identify({
-  //           address: null,
-  //           providerName: eip6963ProviderDetail?.info.name,
-  //           rdns: eip6963ProviderDetail?.info.rdns,
-  //         });
-  //       }
-  //     }
-  //   } catch (err) {
-  //     logger.error("Error identifying all:", err);
-  //   }
-  // }
-
   get provider(): EIP1193Provider | undefined {
     return this._provider;
   }
@@ -800,7 +796,7 @@ export class FormoAnalytics implements IFormoAnalytics {
         method: "eth_accounts",
       });
       if (!res || res.length === 0) return null;
-      return res.filter(isAddress);
+      return res.filter((e) => isAddress(e));
     } catch (err) {
       if ((err as any).code !== 4001) {
         logger.error(
@@ -833,58 +829,6 @@ export class FormoAnalytics implements IFormoAnalytics {
     }
   }
 
-  private getLocation(): string | undefined {
-    try {
-      const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
-      if (timezone in COUNTRY_LIST)
-        return COUNTRY_LIST[timezone as keyof typeof COUNTRY_LIST];
-      return timezone;
-    } catch (error) {
-      logger.error("Error resolving timezone:", error);
-      return "";
-    }
-  }
-
-  private getLanguage(): string {
-    try {
-      return (
-        (navigator.languages && navigator.languages.length
-          ? navigator.languages[0]
-          : navigator.language) || "en"
-      );
-    } catch (error) {
-      logger.error("Error resolving language:", error);
-      return "en";
-    }
-  }
-
-  // Adds browser properties to the user-supplied payload
-  private 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.getLocation();
-    const language = this.getLanguage();
-
-    // common browser properties
-    return {
-      "user-agent": window.navigator.userAgent,
-      href: url.href,
-      locale: language,
-      location,
-      referrer: document.referrer,
-      utm_source: params.get("utm_source")?.trim() || "",
-      utm_medium: params.get("utm_medium")?.trim() || "",
-      utm_campaign: params.get("utm_campaign")?.trim() || "",
-      utm_content: params.get("utm_content")?.trim() || "",
-      utm_term: params.get("utm_term")?.trim() || "",
-      ref: params.get("ref")?.trim() || "",
-      ...eventSpecificPayload,
-    };
-  }
-
   private buildSignatureEventPayload(
     method: string,
     params: unknown[],

package/src/FormoAnalyticsProvider.tsx

@@ -60,11 +60,11 @@ const InitializedAnalytics = ({
   );
 };
 
-export const useFormoAnalytics = () => {
+export const useFormo = () => {
   const context = useContext(FormoAnalyticsContext);
 
   if (!context) {
-    logger.warn("useFormoAnalytics called without a valid context");
+    logger.warn("useFormo called without a valid context");
   }
 
   return context; // Return undefined if SDK is not initialized, handle accordingly in consumer

package/src/constants/config.ts

@@ -657,4 +657,4 @@ export const COUNTRY_LIST = {
   WET: "WET",
   // Zulu
   Zulu: "Zulu",
-};
+} as const;

package/src/constants/index.ts

@@ -1,4 +1,3 @@
 export * from "./base";
 export * from "./config";
 export * from "./events";
-export * from "./regex";

package/src/global.d.ts

@@ -1,11 +1,11 @@
 declare global {
   interface Window {
     __nightmare?: boolean;
-    Cypress?: any; 
-    ethereum?: EIP1193Provider
+    Cypress?: any;
+    ethereum?: EIP1193Provider;
     web3?: {
-      currentProvider?: EIP1193Provider
-    }
+      currentProvider?: EIP1193Provider;
+    };
   }
 }