@formo/analytics 1.16.19 → 1.17.0

package/src/lib/storage/StorageManager.ts

@@ -1,51 +0,0 @@
-import { logger } from "../logger";
-import CookieStorage from "./built-in/cookie";
-import MemoryStorage from "./built-in/memory";
-import WebStorage from "./built-in/web";
-import { IStorage, StorageType } from "./type";
-
-// Fallback as follows: cookieStorage, localStorage, sessionStorage, memoryStorage
-const TYPES: StorageType[] = [
-  "cookieStorage",
-  "localStorage",
-  "sessionStorage",
-  "memoryStorage",
-];
-
-export class StorageManager {
-  private storages: Map<StorageType, IStorage> = new Map();
-
-  constructor(private readonly writeKey: string) {}
-
-  getStorage(type: StorageType): IStorage {
-    if (!this.storages.has(type)) {
-      let storage = this.createStorage(type);
-      // If storage is not available, try next
-      while (!storage.isAvailable()) {
-        const index = TYPES.indexOf(type);
-        logger.warn(
-          `Storage ${type} is not available, trying ${TYPES[index + 1]}`
-        );
-        storage = this.createStorage(TYPES[index + 1]);
-      }
-
-      // Add to cache
-      this.storages.set(type, storage);
-    }
-    return this.storages.get(type)!;
-  }
-
-  private createStorage(type: StorageType): IStorage {
-    switch (type) {
-      case "cookieStorage":
-        return new CookieStorage(this.writeKey);
-      case "localStorage":
-        return new WebStorage(this.writeKey, localStorage);
-      case "sessionStorage":
-        return new WebStorage(this.writeKey, sessionStorage);
-      case "memoryStorage":
-      default:
-        return new MemoryStorage(this.writeKey);
-    }
-  }
-}

package/src/lib/storage/built-in/blueprint.ts

@@ -1,17 +0,0 @@
-import { KEY_PREFIX } from "../constant";
-import { CookieOptions, IStorage } from "../type";
-
-abstract class StorageBlueprint implements IStorage {
-  constructor(private readonly writeKey: string) {}
-
-  abstract isAvailable(): boolean;
-  abstract set(key: string, value: string, options?: CookieOptions): void;
-  abstract get(key: string): any;
-  abstract remove(key: string): void;
-
-  protected getKey(key: string): string {
-    return `${KEY_PREFIX}_${this.writeKey}.${key}`;
-  }
-}
-
-export default StorageBlueprint;

package/src/lib/storage/built-in/cookie.ts

@@ -1,60 +0,0 @@
-import StorageBlueprint from "./blueprint";
-import { CookieOptions } from "../type";
-
-class CookieStorage extends StorageBlueprint {
-  public override isAvailable(): boolean {
-    return (
-      typeof document !== "undefined" && typeof document.cookie === "string"
-    );
-  }
-
-  public override set(
-    key: string,
-    value: string,
-    options?: CookieOptions
-  ): void {
-    const expires = options?.expires;
-    const maxAge = options?.maxAge;
-    const path = options?.path || "/";
-    const domain = options?.domain;
-    const sameSite = options?.sameSite;
-    const secure = options?.secure || false;
-
-    let cookie = `${encodeURIComponent(this.getKey(key))}=${encodeURIComponent(
-      value
-    )}`;
-    if (maxAge) {
-      cookie += "; max-age=" + maxAge;
-    } else if (expires) {
-      cookie += "; expires=" + expires;
-    }
-    if (path) {
-      cookie += "; path=" + path;
-    }
-    if (domain) {
-      cookie += "; domain=" + domain;
-    }
-    if (sameSite) {
-      cookie += "; samesite=" + sameSite;
-    }
-    if (secure) {
-      cookie += "; secure";
-    }
-    document.cookie = cookie;
-  }
-
-  public override get(key: string): string | null {
-    const match = document.cookie.match(
-      new RegExp(`(?:^|; )${encodeURIComponent(this.getKey(key))}=([^;]*)`)
-    );
-    return match ? decodeURIComponent(match[1]) : null;
-  }
-
-  public override remove(key: string): void {
-    document.cookie = `${encodeURIComponent(
-      this.getKey(key)
-    )}=; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT`;
-  }
-}
-
-export default CookieStorage;

package/src/lib/storage/built-in/memory.ts

@@ -1,23 +0,0 @@
-import StorageBlueprint from "./blueprint";
-
-class MemoryStorage extends StorageBlueprint {
-  private memoryStorage: Record<string, string> = {};
-
-  public override isAvailable(): boolean {
-    return true;
-  }
-
-  public override set(key: string, value: string): void {
-    this.memoryStorage[this.getKey(key)] = value;
-  }
-
-  public override get(key: string): string | null {
-    return this.memoryStorage[this.getKey(key)] || null;
-  }
-
-  public override remove(key: string): void {
-    delete this.memoryStorage[this.getKey(key)];
-  }
-}
-
-export default MemoryStorage;

package/src/lib/storage/built-in/web.ts

@@ -1,57 +0,0 @@
-import { logger } from "../../logger";
-import { JSON_PREFIX } from "../constant";
-import StorageBlueprint from "./blueprint";
-
-class WebStorage extends StorageBlueprint {
-  constructor(writeKey: string, private readonly backend: Storage) {
-    super(writeKey);
-  }
-
-  public override isAvailable(): boolean {
-    try {
-      const testKey = "__storage_test__";
-      this.backend.setItem(testKey, "1");
-      this.backend.removeItem(testKey);
-      return true;
-    } catch {
-      return false;
-    }
-  }
-
-  public override set(key: string, value: any): void {
-    if (typeof value === "boolean") value = value === true ? "true" : "false";
-    if (typeof value === "object") value = JSON_PREFIX + JSON.stringify(value);
-    this.backend.setItem(this.getKey(key), value);
-  }
-
-  public override get(key: string): string | boolean | Record<any, any> | null {
-    const value = this.backend.getItem(this.getKey(key));
-
-    if (!value || typeof value !== "string") return null;
-    if (["null", "undefined"].some((item) => item == value)) return null;
-
-    if (value.startsWith(JSON_PREFIX)) {
-      try {
-        return JSON.parse(value.slice(JSON_PREFIX.length));
-      } catch (error) {
-        logger.error(
-          `[FORMO_ERROR] ${this.backend.constructor.name} failed to parse JSON`,
-          error
-        );
-        return null;
-      }
-    }
-
-    if (["true", "false"].some((item) => item == value)) {
-      return JSON.parse(value);
-    }
-
-    return value;
-  }
-
-  public override remove(key: string): void {
-    this.backend.removeItem(this.getKey(key));
-  }
-}
-
-export default WebStorage;

package/src/lib/storage/constant.ts

@@ -1,2 +0,0 @@
-export const JSON_PREFIX = "__json=";
-export const KEY_PREFIX = "formo";

package/src/lib/storage/index.ts

@@ -1,25 +0,0 @@
-import { IStorage, StorageType } from "./type";
-import { StorageManager } from "./StorageManager";
-export * from "./type";
-
-let globalManager: StorageManager | null = null;
-
-export function initStorageManager(writeKey: string): void {
-  if (!globalManager) {
-    globalManager = new StorageManager(writeKey);
-  }
-}
-
-function getStorageInstance(type: StorageType): IStorage {
-  if (!globalManager) {
-    throw new Error(
-      "StorageManager not initialized. Call initStorageManager(writeKey) first."
-    );
-  }
-  return globalManager.getStorage(type);
-}
-
-export const cookie = () => getStorageInstance("cookieStorage");
-export const local = () => getStorageInstance("localStorage");
-export const session = () => getStorageInstance("sessionStorage");
-export const memory = () => getStorageInstance("memoryStorage");

package/src/lib/storage/type.ts

@@ -1,21 +0,0 @@
-export type StorageType =
-  | "cookieStorage"
-  | "localStorage"
-  | "sessionStorage"
-  | "memoryStorage";
-
-export type CookieOptions = {
-  maxAge?: number;
-  expires?: string;
-  path?: string;
-  domain?: string;
-  secure?: boolean;
-  sameSite?: "lax" | "strict" | "none";
-};
-
-export interface IStorage {
-  isAvailable(): boolean;
-  set(key: string, value: string, options?: CookieOptions): void;
-  get(key: string): any;
-  remove(key: string): void;
-}

package/src/lib/version.ts

@@ -1,2 +0,0 @@
-// Generated by genversion.
-export const version = '1.16.19';

package/src/types/base.ts

@@ -1,120 +0,0 @@
-import { LogLevel } from "../lib";
-import {
-  IFormoEventContext,
-  IFormoEventProperties,
-  SignatureStatus,
-  TransactionStatus,
-} from "./events";
-import { EIP1193Provider } from "./provider";
-
-export type Nullable<T> = T | null;
-// Decimal chain ID
-export type ChainID = number;
-
-// Address (EVM, Solana, etc.)
-export type Address = string;
-
-export type ValidInputTypes = Uint8Array | bigint | string | number | boolean;
-export interface IFormoAnalytics {
-  page(
-    category?: string,
-    name?: string,
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext,
-    callback?: (...args: unknown[]) => void
-  ): void;
-  reset(): void;
-  detect(
-    params: { rdns: string; providerName: string },
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext,
-    callback?: (...args: unknown[]) => void
-  ): Promise<void>;
-  connect(
-    params: { chainId: ChainID; address: Address },
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext,
-    callback?: (...args: unknown[]) => void
-  ): Promise<void>;
-  disconnect(
-    params?: { chainId?: ChainID; address?: Address },
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext,
-    callback?: (...args: unknown[]) => void
-  ): Promise<void>;
-  chain(
-    params: { chainId: ChainID; address?: Address },
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext,
-    callback?: (...args: unknown[]) => void
-  ): Promise<void>;
-  signature(
-    params: {
-      status: SignatureStatus;
-      chainId?: ChainID;
-      address: Address;
-      message: string;
-      signatureHash?: string;
-    },
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext,
-    callback?: (...args: unknown[]) => void
-  ): Promise<void>;
-  transaction(
-    params: {
-      status: TransactionStatus;
-      chainId: ChainID;
-      address: Address;
-      data?: string;
-      to?: string;
-      value?: string;
-      transactionHash?: string;
-    },
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext,
-    callback?: (...args: unknown[]) => void
-  ): Promise<void>;
-  identify(
-    params: {
-      address: Address;
-      providerName?: string;
-      userId?: string;
-      rdns?: string;
-    },
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext,
-    callback?: (...args: unknown[]) => void
-  ): Promise<void>;
-  track(
-    event: string,
-    properties?: IFormoEventProperties,
-    context?: IFormoEventContext,
-    callback?: (...args: unknown[]) => void
-  ): Promise<void>;
-}
-
-export interface Options {
-  provider?: EIP1193Provider;
-  trackLocalhost?: boolean;
-
-  flushAt?: number;
-  flushInterval?: number;
-  retryCount?: number;
-  maxQueueSize?: number;
-  logger?: {
-    enabled: boolean;
-    levels?: LogLevel[];
-  };
-}
-
-export interface FormoAnalyticsProviderProps {
-  writeKey: string;
-  options?: Options;
-  disabled?: boolean;
-  children: React.ReactNode;
-}
-
-export interface Config {
-  writeKey: string;
-  trackLocalhost?: boolean;
-}

package/src/types/events.ts

@@ -1,126 +0,0 @@
-import { UUID } from "crypto";
-import { Address, ChainID, Nullable } from "./base";
-import { TEventChannel, TEventType } from "../constants";
-
-export type AnonymousID = UUID;
-
-export interface ICommonProperties {
-  anonymous_id: AnonymousID;
-  user_id: Nullable<string>;
-  address: Nullable<string>;
-  type: TEventType;
-  channel: TEventChannel;
-  version: string;
-  original_timestamp: string;
-  event?: Nullable<string>;
-}
-
-export type IFormoEventProperties = Record<string, unknown>;
-export type IFormoEventContext = Record<string, unknown>;
-export type UTMParameters = {
-  utm_source: string;
-  utm_medium: string;
-  utm_campaign: string;
-  utm_term: string;
-  utm_content: string;
-};
-export type ITrafficSource = UTMParameters & {
-  ref: string;
-  referrer: string;
-};
-
-export interface IFormoEvent extends ICommonProperties {
-  context: Nullable<IFormoEventContext>;
-  properties: Nullable<IFormoEventProperties>;
-}
-
-export type IFormoEventPayload = IFormoEvent & {
-  message_id: string;
-};
-
-//#region Specific Event Types
-export interface PageAPIEvent {
-  type: "page";
-  name?: string;
-  category?: string;
-}
-export interface DetectAPIEvent {
-  type: "detect";
-  providerName: string;
-  rdns: string;
-}
-export interface IdentifyAPIEvent {
-  type: "identify";
-  address: string;
-  providerName: string;
-  rdns: string;
-  userId?: Nullable<string>;
-}
-export interface ChainAPIEvent {
-  type: "chain";
-  chainId: ChainID;
-  address: Address;
-}
-export interface TransactionAPIEvent {
-  type: "transaction";
-  status: TransactionStatus;
-  chainId: ChainID;
-  address: Address;
-  data: string;
-  to: string;
-  value: string;
-  transactionHash: string;
-}
-export interface SignatureAPIEvent {
-  type: "signature";
-  status: SignatureStatus;
-  chainId: ChainID;
-  address: Address;
-  message: string;
-  signatureHash: string;
-}
-export interface ConnectAPIEvent {
-  type: "connect";
-  chainId: ChainID;
-  address: Address;
-}
-export interface DisconnectAPIEvent {
-  type: "disconnect";
-  chainId: ChainID;
-  address: Address;
-}
-export interface TrackAPIEvent {
-  type: "track";
-  event: string;
-  revenue?: number;
-  currency?: string;
-  points?: number;
-}
-
-export type APIEvent = {
-  properties?: IFormoEventProperties;
-  context?: IFormoEventContext;
-  callback?: (...args: unknown[]) => void;
-} & (
-  | PageAPIEvent
-  | DetectAPIEvent
-  | IdentifyAPIEvent
-  | ChainAPIEvent
-  | TransactionAPIEvent
-  | SignatureAPIEvent
-  | ConnectAPIEvent
-  | DisconnectAPIEvent
-  | TrackAPIEvent
-);
-
-export enum SignatureStatus {
-  REQUESTED = "requested",
-  REJECTED = "rejected",
-  CONFIRMED = "confirmed",
-}
-
-export enum TransactionStatus {
-  STARTED = "started",
-  REJECTED = "rejected",
-  BROADCASTED = "broadcasted",
-}

package/src/types/index.ts

@@ -1,3 +0,0 @@
-export * from './base';
-export * from './events';
-export * from './provider';

package/src/types/provider.ts

@@ -1,17 +0,0 @@
-import EventEmitter from 'events'
-
-export interface RequestArguments {
-  method: string
-  params?: unknown[] | Record<string, unknown>
-}
-
-export interface EIP1193Provider extends EventEmitter {
-  request<T>(args: RequestArguments): Promise<T | null | undefined>
-  on(eventName: string | symbol, listener: (...args: unknown[]) => void): this
-  removeListener(eventName: string | symbol, listener: (...args: unknown[]) => void): this
-}
-
-export interface RPCError extends Error {
-  code: number;
-  data?: unknown;
-}

package/src/utils/address.ts

@@ -1,43 +0,0 @@
-import { Address } from "../types";
-import { keccak256 } from "ethereum-cryptography/keccak.js";
-import { utf8ToBytes } from "ethereum-cryptography/utils.js";
-import {
-  ensureIfUint8Array,
-  isAddress,
-  uint8ArrayToHexString,
-} from "../validators";
-import { isNullish } from "../validators/object";
-
-export const toChecksumAddress = (address: Address): string => {
-  if (!isAddress(address, false)) {
-    throw new Error("Invalid address " + address);
-  }
-
-  const lowerCaseAddress = address.toLowerCase().replace(/^0x/i, "");
-
-  const hash = uint8ArrayToHexString(
-    keccak256(ensureIfUint8Array(utf8ToBytes(lowerCaseAddress)))
-  );
-
-  if (
-    isNullish(hash) ||
-    hash ===
-      "0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470"
-  )
-    return ""; // // EIP-1052 if hash is equal to c5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470, keccak was given empty data
-
-  let checksumAddress = "0x";
-
-  const addressHash = hash.replace(/^0x/i, "");
-
-  for (let i = 0; i < lowerCaseAddress.length; i += 1) {
-    // If ith character is 8 to f then make it uppercase
-    if (parseInt(addressHash[i], 16) > 7) {
-      checksumAddress += lowerCaseAddress[i].toUpperCase();
-    } else {
-      checksumAddress += lowerCaseAddress[i];
-    }
-  }
-
-  return checksumAddress;
-};

package/src/utils/base.ts

@@ -1,3 +0,0 @@
-export const getActionDescriptor = (type: string, properties: any): string => {
-  return `${type}${properties?.status ? ` ${properties?.status}` : ""}`;
-};

package/src/utils/converter.ts

@@ -1,44 +0,0 @@
-const toSnake = (str: string) =>
-  str
-    .replace(/([a-z])([A-Z])/g, "$1_$2")
-    .replace(/[\s-]+/g, "_")
-    .toLowerCase();
-
-// Converts object keys to snake_case, omitting keys in the omitKeys array
-export function toSnakeCase(obj: any, omitKeys: string[] = []) {
-  const convert = (data: any): any => {
-    if (Array.isArray(data)) {
-      return data.map(convert); // Recursively handle array elements
-    } else if (data !== null && typeof data === "object") {
-      return Object.keys(data).reduce((acc: any, key) => {
-        // If the key is in omitKeys, keep it as it is
-        const resultKey = omitKeys.includes(key) ? key : toSnake(key);
-        acc[resultKey] = omitKeys.includes(key)
-          ? data[key]
-          : convert(data[key]);
-        return acc;
-      }, {});
-    }
-    return data;
-  };
-
-  return convert(obj);
-}
-
-export const millisecondsToSecond = (milliseconds: number): number =>
-  Math.ceil(milliseconds / 1_000);
-
-export const toDateHourMinute = (date: Date) =>
-  date.getUTCFullYear() +
-  "-" +
-  ("0" + (date.getUTCMonth() + 1)).slice(-2) +
-  "-" +
-  ("0" + date.getUTCDate()).slice(-2) +
-  " " +
-  ("0" + date.getUTCHours()).slice(-2) +
-  ":" +
-  ("0" + date.getUTCMinutes()).slice(-2);
-
-export const clampNumber = (value: number, max: number, min: number) => {
-  return Math.min(Math.max(value, min), max);
-};

package/src/utils/generate.ts

@@ -1,16 +0,0 @@
-import type { UUID } from "crypto";
-
-export async function hash(input: string): Promise<string> {
-  const hashBuffer = await crypto.subtle.digest(
-    "SHA-256",
-    new TextEncoder().encode(input)
-  );
-  const byteArray = new Uint8Array(hashBuffer);
-  return Array.from(byteArray)
-    .map((byte) => byte.toString(16).padStart(2, "0"))
-    .join("");
-}
-
-export function generateNativeUUID(): UUID {
-  return crypto.randomUUID();
-}

package/src/utils/index.ts

@@ -1,4 +0,0 @@
-export * from "./address";
-export * from "./base";
-export * from "./converter";
-export * from "./generate";

package/src/utils/timestamp.ts

@@ -1,9 +0,0 @@
-const getFormattedTimestamp = (date: Date): string => date.toISOString();
-
-/**
- * To get the current timestamp in ISO string format
- * @returns ISO formatted timestamp string
- */
-const getCurrentTimeFormatted = (): string => getFormattedTimestamp(new Date());
-
-export { getCurrentTimeFormatted, getFormattedTimestamp };