@formo/analytics 1.16.19 → 1.17.0

package/src/global.d.ts

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

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from './FormoAnalyticsProvider';
-export * from './FormoAnalytics';
-export * from './types';

package/src/lib/event/EventFactory.ts

@@ -1,519 +0,0 @@
-import {
-  COUNTRY_LIST,
-  LOCAL_ANONYMOUS_ID_KEY,
-  SESSION_TRAFFIC_SOURCE_KEY,
-} from "../../constants";
-import {
-  Address,
-  APIEvent,
-  ChainID,
-  IFormoEvent,
-  IFormoEventContext,
-  IFormoEventProperties,
-  ITrafficSource,
-  Nullable,
-  SignatureStatus,
-  TransactionStatus,
-  UTMParameters,
-} from "../../types";
-import { toChecksumAddress, toSnakeCase } from "../../utils";
-import { getCurrentTimeFormatted } from "../../utils/timestamp";
-import { isUndefined } from "../../validators";
-import { logger } from "../logger";
-import mergeDeepRight from "../ramda/mergeDeepRight";
-import { session } from "../storage";
-import { version } from "../version";
-import { CHANNEL, VERSION } from "./constants";
-import { IEventFactory } from "./type";
-import { generateAnonymousId } from "./utils";
-
-class EventFactory implements IEventFactory {
-  private getTimezone(): string {
-    try {
-      return Intl.DateTimeFormat().resolvedOptions().timeZone;
-    } catch (error) {
-      logger.error("Error resolving timezone:", error);
-      return "";
-    }
-  }
-
-  private getLocation(): string | undefined {
-    try {
-      const timezone = this.getTimezone();
-      if (timezone in COUNTRY_LIST)
-        return COUNTRY_LIST[timezone as keyof typeof COUNTRY_LIST];
-      return timezone;
-    } catch (error) {
-      logger.error("Error resolving location:", 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";
-    }
-  }
-
-  private getLibraryVersion(): string {
-    return version;
-  }
-
-  private extractUTMParameters = (url: string): UTMParameters => {
-    const result: UTMParameters = {
-      utm_campaign: "",
-      utm_content: "",
-      utm_medium: "",
-      utm_source: "",
-      utm_term: "",
-    };
-    try {
-      const urlObj = new URL(url);
-      const UTM_PREFIX = "utm_";
-      urlObj.searchParams.forEach((value, sParam) => {
-        if (sParam.startsWith(UTM_PREFIX)) {
-          result[sParam as keyof UTMParameters] = value.trim();
-        }
-      });
-    } catch (error) {}
-    return result;
-  };
-
-  private getTrafficSources = (url: string): ITrafficSource => {
-    const urlObj = new URL(url);
-    const contextTrafficSources: ITrafficSource = {
-      ...this.extractUTMParameters(url),
-      ref: urlObj.searchParams.get("ref")?.trim() || "",
-      referrer: document.referrer,
-    };
-    const storedTrafficSources =
-      (session().get(SESSION_TRAFFIC_SOURCE_KEY) as ITrafficSource) || {};
-
-    const finalTrafficSources: ITrafficSource = {
-      ref: contextTrafficSources.ref || storedTrafficSources?.ref || "",
-      referrer:
-        contextTrafficSources.referrer || storedTrafficSources?.referrer,
-      utm_campaign:
-        contextTrafficSources.utm_campaign ||
-        storedTrafficSources?.utm_campaign ||
-        "",
-      utm_content:
-        contextTrafficSources.utm_content ||
-        storedTrafficSources?.utm_content ||
-        "",
-      utm_medium:
-        contextTrafficSources.utm_medium ||
-        storedTrafficSources?.utm_medium ||
-        "",
-      utm_source:
-        contextTrafficSources.utm_source ||
-        storedTrafficSources?.utm_source ||
-        "",
-      utm_term:
-        contextTrafficSources.utm_term || storedTrafficSources?.utm_term || "",
-    };
-
-    // Store to session
-    const sessionStoredTrafficSources = Object.keys(finalTrafficSources).reduce(
-      (res: any, key: any) => {
-        const value = finalTrafficSources[key as keyof ITrafficSource];
-        if (!isUndefined(value) && value !== "") {
-          res[key as keyof ITrafficSource] = value;
-        }
-        return res;
-      },
-      {}
-    );
-
-    if (Object.keys(sessionStoredTrafficSources).length)
-      session().set(SESSION_TRAFFIC_SOURCE_KEY, sessionStoredTrafficSources);
-
-    return finalTrafficSources;
-  };
-
-  // Contextual fields that are automatically collected and populated by the Formo SDK
-  private generateContext(context?: IFormoEventContext): IFormoEventContext {
-    const path = globalThis.location.pathname;
-    const language = this.getLanguage();
-    const timezone = this.getTimezone();
-    const location = this.getLocation();
-    const library_version = this.getLibraryVersion();
-
-    // contextual properties
-    const defaultContext = {
-      user_agent: globalThis.navigator.userAgent,
-      locale: language,
-      timezone,
-      location,
-      ...this.getTrafficSources(globalThis.location.href),
-      page_path: path,
-      page_title: document.title,
-      page_url: globalThis.location.href,
-      library_name: "Formo Web SDK",
-      library_version,
-    };
-
-    const mergedContext = mergeDeepRight(
-      defaultContext,
-      context || {}
-    ) as IFormoEventContext;
-
-    return mergedContext;
-  }
-
-  /**
-   * Add any missing default page properties using values from options and defaults
-   * @param properties Input page properties
-   * @param options API options
-   */
-  private getPageProperties = (
-    properties: IFormoEventProperties
-  ): IFormoEventProperties => {
-    const pageProps = properties;
-
-    if (isUndefined(pageProps.url)) {
-      pageProps.url = new URL(globalThis.location.href).href;
-    }
-
-    if (isUndefined(pageProps.path)) {
-      pageProps.path = globalThis.location.pathname;
-    }
-
-    if (isUndefined(pageProps.hash)) {
-      pageProps.hash = globalThis.location.hash;
-    }
-
-    return pageProps;
-  };
-
-  private getEnrichedEvent = (
-    formoEvent: Partial<IFormoEvent>,
-    context?: IFormoEventContext
-  ): IFormoEvent => {
-    const commonEventData = {
-      context: this.generateContext(context),
-      original_timestamp: getCurrentTimeFormatted(),
-      user_id: formoEvent.user_id,
-      type: formoEvent.type,
-      channel: CHANNEL,
-      version: VERSION,
-    } as Partial<IFormoEvent>;
-
-    commonEventData.anonymous_id = generateAnonymousId(LOCAL_ANONYMOUS_ID_KEY);
-
-    if (formoEvent.address) {
-      commonEventData.address = toChecksumAddress(formoEvent.address);
-    } else {
-      commonEventData.address = formoEvent.address;
-    }
-
-    const processedEvent = mergeDeepRight(
-      formoEvent,
-      commonEventData
-    ) as IFormoEvent;
-
-    if (processedEvent.event === undefined) {
-      processedEvent.event = null;
-    }
-
-    if (processedEvent.properties === undefined) {
-      processedEvent.properties = null;
-    }
-
-    return toSnakeCase(processedEvent);
-  };
-
-  generatePageEvent(
-    category?: string,
-    name?: string,
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext
-  ): IFormoEvent {
-    let props = properties ?? {};
-    props.category = category;
-    props.name = name;
-    props = this.getPageProperties(props);
-
-    const pageEvent: Partial<IFormoEvent> = {
-      properties: props,
-      type: "page",
-    };
-
-    return this.getEnrichedEvent(pageEvent, context);
-  }
-
-  generateDetectWalletEvent(
-    providerName: string,
-    rdns: string,
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext
-  ) {
-    const detectEvent: Partial<IFormoEvent> = {
-      properties: {
-        providerName,
-        rdns,
-        ...properties,
-      },
-      type: "detect",
-    };
-
-    return this.getEnrichedEvent(detectEvent, context);
-  }
-
-  generateIdentifyEvent(
-    providerName: string,
-    rdns: string,
-    address: Nullable<Address>,
-    userId?: Nullable<string>,
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext
-  ) {
-    const identifyEvent: Partial<IFormoEvent> = {
-      properties: {
-        providerName,
-        rdns,
-        ...properties,
-      },
-      user_id: userId,
-      address,
-      type: "identify",
-    };
-
-    return this.getEnrichedEvent(identifyEvent, context);
-  }
-
-  generateConnectEvent(
-    chainId: ChainID,
-    address: Address,
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext
-  ) {
-    const connectEvent: Partial<IFormoEvent> = {
-      properties: {
-        chainId,
-        ...properties,
-      },
-      address,
-      type: "connect",
-    };
-
-    return this.getEnrichedEvent(connectEvent, context);
-  }
-
-  generateDisconnectEvent(
-    chainId: ChainID,
-    address: Address,
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext
-  ) {
-    const disconnectEvent: Partial<IFormoEvent> = {
-      properties: {
-        chainId,
-        ...properties,
-      },
-      address,
-      type: "disconnect",
-    };
-
-    return this.getEnrichedEvent(disconnectEvent, context);
-  }
-
-  generateChainChangedEvent(
-    chainId: ChainID,
-    address: Address,
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext
-  ) {
-    const chainEvent: Partial<IFormoEvent> = {
-      properties: {
-        chainId,
-        ...properties,
-      },
-      address,
-      type: "chain",
-    };
-
-    return this.getEnrichedEvent(chainEvent, context);
-  }
-
-  generateSignatureEvent(
-    status: SignatureStatus,
-    chainId: ChainID,
-    address: Address,
-    message: string,
-    signatureHash: string,
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext
-  ) {
-    const signatureEvent: Partial<IFormoEvent> = {
-      properties: {
-        status,
-        chainId,
-        message,
-        signatureHash,
-        ...properties,
-      },
-      address,
-      type: "signature",
-    };
-
-    return this.getEnrichedEvent(signatureEvent, context);
-  }
-
-  generateTransactionEvent(
-    status: TransactionStatus,
-    chainId: ChainID,
-    address: Address,
-    data: string,
-    to: string,
-    value: string,
-    transactionHash: string,
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext
-  ) {
-    const transactionEvent: Partial<IFormoEvent> = {
-      properties: {
-        status,
-        chainId,
-        data,
-        to,
-        value,
-        transactionHash,
-        ...properties,
-      },
-      address,
-      type: "transaction",
-    };
-
-    return this.getEnrichedEvent(transactionEvent, context);
-  }
-
-  generateTrackEvent(
-    event: string,
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext
-  ) {
-    const trackEvent: Partial<IFormoEvent> = {
-      properties: {
-        ...properties,
-        ...(properties?.revenue !== undefined && {
-          revenue: Number(properties.revenue),
-          currency: (typeof properties?.currency === "string"
-            ? properties.currency
-            : "USD"
-          ).toLowerCase(),
-        }),
-        ...(properties?.points !== undefined && {
-          points: Number(properties.points),
-        }),
-      },
-      event,
-      type: "track",
-    };
-
-    return this.getEnrichedEvent(trackEvent, context);
-  }
-
-  // Returns an event with type, context, properties, and common properties
-  create(event: APIEvent, address?: Address, userId?: string): IFormoEvent {
-    let formoEvent: Partial<IFormoEvent> = {};
-
-    formoEvent.address = address || null;
-    formoEvent.user_id = userId || null;
-
-    switch (event.type) {
-      case "page":
-        formoEvent = this.generatePageEvent(
-          event.category,
-          event.name,
-          event.properties,
-          event.context
-        );
-        break;
-      case "detect":
-        formoEvent = this.generateDetectWalletEvent(
-          event.providerName,
-          event.rdns,
-          event.properties,
-          event.context
-        );
-        break;
-      case "identify":
-        formoEvent = this.generateIdentifyEvent(
-          event.providerName,
-          event.rdns,
-          event.address,
-          event.userId,
-          event.properties,
-          event.context
-        );
-        break;
-      case "chain":
-        formoEvent = this.generateChainChangedEvent(
-          event.chainId,
-          event.address,
-          event.properties,
-          event.context
-        );
-        break;
-      case "connect":
-        formoEvent = this.generateConnectEvent(
-          event.chainId,
-          event.address,
-          event.properties,
-          event.context
-        );
-        break;
-      case "disconnect":
-        formoEvent = this.generateDisconnectEvent(
-          event.chainId,
-          event.address,
-          event.properties,
-          event.context
-        );
-        break;
-      case "signature":
-        formoEvent = this.generateSignatureEvent(
-          event.status,
-          event.chainId,
-          event.address,
-          event.message,
-          event.signatureHash,
-          event.properties,
-          event.context
-        );
-        break;
-      case "transaction":
-        formoEvent = this.generateTransactionEvent(
-          event.status,
-          event.chainId,
-          event.address,
-          event.data,
-          event.to,
-          event.value,
-          event.transactionHash,
-          event.properties,
-          event.context
-        );
-        break;
-      case "track":
-      default:
-        formoEvent = this.generateTrackEvent(
-          event.event,
-          event.properties,
-          event.context
-        );
-        break;
-    }
-    return formoEvent as IFormoEvent;
-  }
-}
-
-export { EventFactory };

package/src/lib/event/EventManager.ts

@@ -1,39 +0,0 @@
-import { Address, APIEvent } from "../../types";
-import { logger } from "../logger";
-import { IEventQueue } from "../queue";
-import { EventFactory } from "./EventFactory";
-import { IEventFactory, IEventManager } from "./type";
-
-/**
- * A service to generate valid event payloads and queue them for processing
- */
-class EventManager implements IEventManager {
-  eventQueue: IEventQueue;
-  eventFactory: IEventFactory;
-
-  /**
-   *
-   * @param eventQueue Event queue instance
-   */
-  constructor(eventQueue: IEventQueue) {
-    this.eventQueue = eventQueue;
-    this.eventFactory = new EventFactory();
-  }
-
-  /**
-   * Consumes a new incoming event
-   * @param event Incoming event data
-   */
-  addEvent(event: APIEvent, address?: Address, userId?: string): void {
-    const { callback, ..._event } = event;
-    const formoEvent = this.eventFactory.create(_event, address, userId);
-    this.eventQueue.enqueue(formoEvent, (err, _, data) => {
-      if (err) {
-        logger.error("Error sending events:", err);
-      } else logger.info(`Events sent successfully: ${data.length} events`);
-      callback?.(err, _, data);
-    });
-  }
-}
-
-export { EventManager };

package/src/lib/event/constants.ts

@@ -1,4 +0,0 @@
-const CHANNEL = "web";
-const VERSION = "0";
-
-export { CHANNEL, VERSION };

package/src/lib/event/index.ts

@@ -1,3 +0,0 @@
-export * from "./EventFactory";
-export * from "./EventManager";
-export * from "./type";

package/src/lib/event/type.ts

@@ -1,9 +0,0 @@
-import { Address, APIEvent, IFormoEvent } from "../../types";
-
-export interface IEventManager {
-  addEvent(event: APIEvent, address?: Address, userId?: string): void;
-}
-
-export interface IEventFactory {
-  create(event: APIEvent, address?: Address, userId?: string): IFormoEvent;
-}

package/src/lib/event/utils.ts

@@ -1,33 +0,0 @@
-import { AnonymousID } from "../../types";
-import { generateNativeUUID } from "../../utils";
-import { cookie } from "../storage";
-
-const generateAnonymousId = (key: string): AnonymousID => {
-  const storedAnonymousId = cookie().get(key);
-  if (storedAnonymousId && typeof storedAnonymousId === "string")
-    return storedAnonymousId as AnonymousID;
-  const newAnonymousId = generateNativeUUID();
-  cookie().set(key, newAnonymousId, {
-    maxAge: Date.now() + 1000 * 60 * 60 * 24 * 365, // 1 year
-    domain: getCookieDomain(),
-    path: "/",
-  });
-  return newAnonymousId;
-};
-
-function getCookieDomain(hostname: string = window.location.hostname): string {
-  // Special cases
-  if (
-    hostname.includes("localhost") ||
-    /^\d{1,3}(\.\d{1,3}){3}$/.test(hostname)
-  ) {
-    // Localhost or IP address
-    return "";
-  }
-
-  const parts = hostname.split(".");
-  if (parts.includes("www")) parts.splice(parts.indexOf("www"), 1);
-  return `.${parts.join(".")}`;
-}
-
-export { generateAnonymousId, getCookieDomain };

package/src/lib/fetch.ts

@@ -1,3 +0,0 @@
-import fetch from "fetch-retry";
-
-export default fetch(global.fetch);

package/src/lib/index.ts

@@ -1,5 +0,0 @@
-export * from "./event";
-export * from "./logger";
-export * from "./queue";
-export * from "./storage";
-export { default as fetch } from "./fetch";