@formo/analytics 1.17.2 → 1.17.4

package/src/lib/logger/Logger.ts

@@ -1,115 +0,0 @@
-import { ILogger, LogLevel } from "./type";
-
-export class Logger implements ILogger {
-  private static instance: ILogger;
-  private enabledLevels: Set<LogLevel>;
-  private enabled: boolean;
-
-  private constructor(
-    enabled: boolean = false,
-    enabledLevels: LogLevel[] = []
-  ) {
-    this.enabled = enabled;
-    this.enabledLevels = new Set(enabledLevels);
-  }
-
-  public static init(config: {
-    enabled?: boolean;
-    enabledLevels?: LogLevel[];
-  }): void {
-    // Get or create instance
-    const instance = Logger.getInstance();
-
-    // Update configuration
-    if (config.enabled !== undefined) {
-      instance.setEnabled(config.enabled);
-    }
-    if (config.enabledLevels !== undefined) {
-      instance.setEnabledLevels(config.enabledLevels);
-    }
-  }
-
-  public static getInstance(config?: {
-    enabled?: boolean;
-    enabledLevels?: LogLevel[];
-  }): ILogger {
-    if (!Logger.instance) {
-      Logger.instance = new Logger(
-        config?.enabled ?? false,
-        config?.enabledLevels ?? []
-      );
-    }
-    return Logger.instance;
-  }
-
-  public setEnabled(enabled: boolean): void {
-    this.enabled = enabled;
-  }
-
-  public isLoggingEnabled(): boolean {
-    return this.enabled;
-  }
-
-  public setEnabledLevels(levels: LogLevel[]): void {
-    this.enabledLevels = new Set(levels);
-  }
-
-  public getEnabledLevels(): LogLevel[] {
-    return Array.from(this.enabledLevels);
-  }
-
-  private shouldLog(level: LogLevel): boolean {
-    if (!this.enabled) return false;
-    return this.enabledLevels.has(level);
-  }
-
-  private formatMessage(message: string): string {
-    const timestamp = new Date().toLocaleString("en-US", {
-      year: "numeric",
-      month: "2-digit",
-      day: "2-digit",
-      hour: "2-digit",
-      minute: "2-digit",
-      second: "2-digit",
-      hour12: false,
-    });
-    return `[Formo Analytics][${timestamp}] ${message}`;
-  }
-
-  public debug(message: string, ...args: any[]): void {
-    if (this.shouldLog("debug")) {
-      console.debug(this.formatMessage(message), ...args);
-    }
-  }
-
-  public info(message: string, ...args: any[]): void {
-    if (this.shouldLog("info")) {
-      console.info(this.formatMessage(message), ...args);
-    }
-  }
-
-  public warn(message: string, ...args: any[]): void {
-    if (this.shouldLog("warn")) {
-      console.warn(this.formatMessage(message), ...args);
-    }
-  }
-
-  public error(message: string, ...args: any[]): void {
-    if (this.shouldLog("error")) {
-      console.error(this.formatMessage(message), ...args);
-    }
-  }
-
-  public trace(message: string, ...args: any[]): void {
-    if (this.shouldLog("trace")) {
-      console.trace(this.formatMessage(message), ...args);
-    }
-  }
-
-  public log(message: string, ...args: any[]): void {
-    this.info(message, ...args);
-  }
-}
-
-// Export a default instance for easy use
-export const logger = Logger.getInstance();

package/src/lib/logger/index.ts

@@ -1,2 +0,0 @@
-export * from "./Logger";
-export * from "./type";

package/src/lib/logger/type.ts

@@ -1,14 +0,0 @@
-export interface ILogger {
-  setEnabledLevels(levels: LogLevel[]): void;
-  getEnabledLevels(): LogLevel[];
-  setEnabled(enabled: boolean): void;
-  isLoggingEnabled(): boolean;
-  log(...data: any[]): void;
-  info(...data: any[]): void;
-  debug(...data: any[]): void;
-  warn(...data: any[]): void;
-  error(...data: any[]): void;
-  trace(...data: any[]): void;
-}
-
-export type LogLevel = "debug" | "info" | "warn" | "error" | "trace";

package/src/lib/queue/EventQueue.ts

@@ -1,306 +0,0 @@
-import { isNetworkError } from "../../validators";
-import { IFormoEvent, IFormoEventPayload } from "../../types";
-import {
-  clampNumber,
-  getActionDescriptor,
-  hash,
-  millisecondsToSecond,
-  toDateHourMinute,
-} from "../../utils";
-import { logger } from "../logger";
-import { EVENTS_API_REQUEST_HEADER } from "../../constants";
-import fetch from "../fetch";
-import { IEventQueue } from "./type";
-const noop = () => {};
-
-type QueueItem = {
-  message: IFormoEventPayload;
-  callback: (...args: any) => any;
-};
-
-type IFormoEventFlushPayload = IFormoEventPayload & {
-  sent_at: string;
-};
-
-type Options = {
-  url: string;
-  flushAt?: number;
-  flushInterval?: number;
-  host?: string;
-  retryCount?: number;
-  errorHandler?: any;
-  maxQueueSize?: number;
-};
-
-const DEFAULT_RETRY = 3;
-const MAX_RETRY = 5;
-const MIN_RETRY = 1;
-
-const DEFAULT_FLUSH_AT = 20;
-const MAX_FLUSH_AT = 20;
-const MIN_FLUSH_AT = 1;
-
-const DEFAULT_QUEUE_SIZE = 1_024 * 500; // 500kB
-const MAX_QUEUE_SIZE = 1_024 * 500; // 500kB
-const MIN_QUEUE_SIZE = 200; // 200 bytes
-
-const DEFAULT_FLUSH_INTERVAL = 1_000 * 30; // 1 MINUTE
-const MAX_FLUSH_INTERVAL = 1_000 * 300; // 5 MINUTES
-const MIN_FLUSH_INTERVAL = 1_000 * 10; // 10 SECONDS
-
-export class EventQueue implements IEventQueue {
-  private writeKey: string;
-  private url: string;
-  private queue: QueueItem[] = [];
-  private timer: null | NodeJS.Timeout;
-  private flushAt: number;
-  private flushIntervalMs: number;
-  private flushed: boolean;
-  private maxQueueSize: number; // min 200 bytes, max 500kB
-  private errorHandler: any;
-  private retryCount: number;
-  private pendingFlush: Promise<any> | null;
-  private payloadHashes: Set<string> = new Set();
-
-  constructor(writeKey: string, options: Options) {
-    options = options || {};
-
-    this.queue = [];
-    this.writeKey = writeKey;
-    this.url = options.url;
-    this.retryCount = clampNumber(
-      options.retryCount || DEFAULT_RETRY,
-      MAX_RETRY,
-      MIN_RETRY
-    );
-    this.flushAt = clampNumber(
-      options.flushAt || DEFAULT_FLUSH_AT,
-      MAX_FLUSH_AT,
-      MIN_FLUSH_AT
-    );
-    this.maxQueueSize = clampNumber(
-      options.maxQueueSize || DEFAULT_QUEUE_SIZE,
-      MAX_QUEUE_SIZE,
-      MIN_QUEUE_SIZE
-    );
-    this.flushIntervalMs = clampNumber(
-      options.flushInterval || DEFAULT_FLUSH_INTERVAL,
-      MAX_FLUSH_INTERVAL,
-      MIN_FLUSH_INTERVAL
-    );
-    this.flushed = true;
-    this.errorHandler = options.errorHandler;
-    this.pendingFlush = null;
-    this.timer = null;
-
-    this.onPageLeave(async (isAccessible: boolean) => {
-      if (isAccessible === false) {
-        await this.flush();
-      }
-    });
-  }
-
-  //#region Public functions
-  private async generateMessageId(event: IFormoEvent): Promise<string> {
-    const formattedTimestamp = toDateHourMinute(new Date(event.original_timestamp));
-    const eventForHashing = { ...event, original_timestamp: formattedTimestamp };
-    const eventString = JSON.stringify(eventForHashing);
-    return hash(eventString);
-  }
-
-  async enqueue(event: IFormoEvent, callback?: (...args: any) => void) {
-    callback = callback || noop;
-
-    const message_id = await this.generateMessageId(event);
-    // check if the message already exists
-    if (await this.isDuplicate(message_id)) {
-      logger.warn(
-        `Event already enqueued, try again after ${millisecondsToSecond(
-          this.flushIntervalMs
-        )} seconds.`
-      );
-      return;
-    }
-
-    this.queue.push({
-      message: { ...event, message_id },
-      callback,
-    });
-
-    logger.log(
-      `Event enqueued: ${getActionDescriptor(event.type, event.properties)}`
-    );
-
-    if (!this.flushed) {
-      this.flushed = true;
-      this.flush();
-      return;
-    }
-
-    const hasReachedFlushAt = this.queue.length >= this.flushAt;
-    const hasReachedQueueSize =
-      this.queue.reduce((acc, item) => acc + JSON.stringify(item).length, 0) >=
-      this.maxQueueSize;
-
-    if (hasReachedFlushAt || hasReachedQueueSize) {
-      this.flush();
-      return;
-    }
-
-    if (this.flushIntervalMs && !this.timer) {
-      this.timer = setTimeout(this.flush.bind(this), this.flushIntervalMs);
-    }
-  }
-
-  async flush(callback?: (...args: any) => void) {
-    callback = callback || noop;
-
-    if (this.timer) {
-      clearTimeout(this.timer);
-      this.timer = null;
-    }
-
-    if (!this.queue.length) {
-      callback();
-      return Promise.resolve();
-    }
-
-    try {
-      if (this.pendingFlush) {
-        await this.pendingFlush;
-      }
-    } catch (err) {
-      this.pendingFlush = null;
-      throw err;
-    }
-
-    const items = this.queue.splice(0, this.flushAt);
-    this.payloadHashes.clear();
-    
-    // Generate sent_at once for the entire batch
-    const sentAt = new Date().toISOString();
-    const data: IFormoEventFlushPayload[] = items.map((item) => ({
-      ...item.message,
-      sent_at: sentAt
-    }));
-
-    const done = (err?: Error) => {
-      items.forEach(({ message, callback }) => callback(err, message, data));
-      callback(err, data);
-    };
-
-    return (this.pendingFlush = fetch(`${this.url}`, {
-      headers: EVENTS_API_REQUEST_HEADER(this.writeKey),
-      method: "POST",
-      body: JSON.stringify(data),
-      keepalive: true,
-      retries: this.retryCount,
-      retryDelay: (attempt) => Math.pow(2, attempt) * 1_000, // exponential backoff
-      retryOn: (_, error) => this.isErrorRetryable(error),
-    })
-      .then(() => {
-        done();
-        return Promise.resolve(data);
-      })
-      .catch((err) => {
-        if (typeof this.errorHandler === "function") {
-          done(err);
-          return this.errorHandler(err);
-        }
-
-        if (err.response) {
-          const error = new Error(err.response.statusText);
-          done(error);
-          throw error;
-        }
-
-        done(err);
-        throw err;
-      }));
-  }
-
-  //#region Utility functions
-  private isErrorRetryable(error: any) {
-    // Retry Network Errors.
-    if (isNetworkError(error)) return true;
-
-    // Cannot determine if the request can be retried
-    if (!error?.response) return false;
-
-    // Retry Server Errors (5xx).
-    if (error?.response?.status >= 500 && error?.response?.status <= 599)
-      return true;
-
-    // Retry if rate limited.
-    if (error?.response?.status === 429) return true;
-
-    return false;
-  }
-
-  private async isDuplicate(eventId: string) {
-    // check if exists a message with identical payload within 1 minute
-    if (this.payloadHashes.has(eventId)) return true;
-
-    this.payloadHashes.add(eventId);
-    return false;
-  }
-
-  private onPageLeave = (callback: (isAccessible: boolean) => void) => {
-    // To ensure the callback is only called once even if more than one events
-    // are fired at once.
-    let pageLeft = false;
-    let isAccessible = false;
-
-    function handleOnLeave() {
-      if (pageLeft) {
-        return;
-      }
-
-      pageLeft = true;
-
-      callback(isAccessible);
-
-      // Reset pageLeft on the next tick
-      // to ensure callback executes for other listeners
-      // when closing an inactive browser tab.
-      setTimeout(() => {
-        pageLeft = false;
-      }, 0);
-    }
-
-    // Catches the unloading of the page (e.g., closing the tab or navigating away).
-    // Includes user actions like clicking a link, entering a new URL,
-    // refreshing the page, or closing the browser tab
-    // Note that 'pagehide' is not supported in IE.
-    // So, this is a fallback.
-    (globalThis as typeof window).addEventListener("beforeunload", () => {
-      isAccessible = false;
-      handleOnLeave();
-    });
-
-    (globalThis as typeof window).addEventListener("blur", () => {
-      isAccessible = true;
-      handleOnLeave();
-    });
-
-    (globalThis as typeof window).addEventListener("focus", () => {
-      pageLeft = false;
-    });
-
-    // Catches the page being hidden, including scenarios like closing the tab.
-    document.addEventListener("pagehide", () => {
-      isAccessible = document.visibilityState === "hidden";
-      handleOnLeave();
-    });
-
-    // Catches visibility changes, such as switching tabs or minimizing the browser.
-    document.addEventListener("visibilitychange", () => {
-      isAccessible = true;
-      if (document.visibilityState === "hidden") {
-        handleOnLeave();
-      } else {
-        pageLeft = false;
-      }
-    });
-  };
-}

package/src/lib/queue/index.ts

@@ -1,2 +0,0 @@
-export * from "./EventQueue";
-export * from "./type";

package/src/lib/queue/type.ts

@@ -1,6 +0,0 @@
-import { IFormoEvent } from "../../types";
-
-export interface IEventQueue {
-  enqueue(event: IFormoEvent, callback?: (...args: any) => void): Promise<void>;
-  flush(callback?: (...args: any) => void): Promise<any>;
-}

package/src/lib/ramda/internal/_curry1.ts

@@ -1,19 +0,0 @@
-import _isPlaceholder from "./_isPlaceholder";
-
-/**
- * Optimized internal one-arity curry function.
- *
- * @private
- * @category Function
- * @param {Function} fn The function to curry.
- * @return {Function} The curried function.
- */
-export default function _curry1(fn: Function) {
-  return function f1(a: any) {
-    if (arguments.length === 0 || _isPlaceholder(a)) {
-      return f1;
-    } else {
-      return fn.apply(this, arguments);
-    }
-  };
-}

package/src/lib/ramda/internal/_curry2.ts

@@ -1,37 +0,0 @@
-import _curry1 from "./_curry1";
-import _isPlaceholder from "./_isPlaceholder";
-
-/**
- * Optimized internal two-arity curry function.
- *
- * @private
- * @category Function
- * @param {Function} fn The function to curry.
- * @return {Function} The curried function.
- */
-export default function _curry2(fn: Function) {
-  return function f2(a: any, b: any) {
-    switch (arguments.length) {
-      case 0:
-        return f2;
-      case 1:
-        return _isPlaceholder(a)
-          ? f2
-          : _curry1(function (_b: any) {
-              return fn(a, _b);
-            });
-      default:
-        return _isPlaceholder(a) && _isPlaceholder(b)
-          ? f2
-          : _isPlaceholder(a)
-          ? _curry1(function (_a: any) {
-              return fn(_a, b);
-            })
-          : _isPlaceholder(b)
-          ? _curry1(function (_b: any) {
-              return fn(a, _b);
-            })
-          : fn(a, b);
-    }
-  };
-}

package/src/lib/ramda/internal/_curry3.ts

@@ -1,68 +0,0 @@
-import _curry1 from "./_curry1";
-import _curry2 from "./_curry2";
-import _isPlaceholder from "./_isPlaceholder";
-
-/**
- * Optimized internal three-arity curry function.
- *
- * @private
- * @category Function
- * @param {Function} fn The function to curry.
- * @return {Function} The curried function.
- */
-export default function _curry3(fn: Function) {
-  return function f3(a: any, b: any, c: any) {
-    switch (arguments.length) {
-      case 0:
-        return f3;
-      case 1:
-        return _isPlaceholder(a)
-          ? f3
-          : _curry2(function (_b: any, _c: any) {
-              return fn(a, _b, _c);
-            });
-      case 2:
-        return _isPlaceholder(a) && _isPlaceholder(b)
-          ? f3
-          : _isPlaceholder(a)
-          ? _curry2(function (_a: any, _c: any) {
-              return fn(_a, b, _c);
-            })
-          : _isPlaceholder(b)
-          ? _curry2(function (_b: any, _c: any) {
-              return fn(a, _b, _c);
-            })
-          : _curry1(function (_c: any) {
-              return fn(a, b, _c);
-            });
-      default:
-        return _isPlaceholder(a) && _isPlaceholder(b) && _isPlaceholder(c)
-          ? f3
-          : _isPlaceholder(a) && _isPlaceholder(b)
-          ? _curry2(function (_a: any, _b: any) {
-              return fn(_a, _b, c);
-            })
-          : _isPlaceholder(a) && _isPlaceholder(c)
-          ? _curry2(function (_a: any, _c: any) {
-              return fn(_a, b, _c);
-            })
-          : _isPlaceholder(b) && _isPlaceholder(c)
-          ? _curry2(function (_b: any, _c: any) {
-              return fn(a, _b, _c);
-            })
-          : _isPlaceholder(a)
-          ? _curry1(function (_a: any) {
-              return fn(_a, b, c);
-            })
-          : _isPlaceholder(b)
-          ? _curry1(function (_b: any) {
-              return fn(a, _b, c);
-            })
-          : _isPlaceholder(c)
-          ? _curry1(function (_c: any) {
-              return fn(a, b, _c);
-            })
-          : fn(a, b, c);
-    }
-  };
-}

package/src/lib/ramda/internal/_has.ts

@@ -1,3 +0,0 @@
-export default function _has(prop: any, obj: any) {
-  return Object.prototype.hasOwnProperty.call(obj, prop);
-}

package/src/lib/ramda/internal/_isObject.ts

@@ -1,3 +0,0 @@
-export default function _isObject(x: any) {
-  return Object.prototype.toString.call(x) === "[object Object]";
-}

package/src/lib/ramda/internal/_isPlaceholder.ts

@@ -1,5 +0,0 @@
-export default function _isPlaceholder(a: any) {
-  return (
-    a != null && typeof a === "object" && a["@@functional/placeholder"] === true
-  );
-}

package/src/lib/ramda/mergeDeepRight.ts

@@ -1,13 +0,0 @@
-import _curry2 from "./internal/_curry2";
-import mergeDeepWithKey from "./mergeDeepWithKey";
-
-const mergeDeepRight = _curry2(function mergeDeepRight(lObj: any, rObj: any) {
-  return mergeDeepWithKey(
-    function (_: Function, __: any, rVal: any) {
-      return rVal;
-    },
-    lObj,
-    rObj
-  );
-});
-export default mergeDeepRight;

package/src/lib/ramda/mergeDeepWithKey.ts

@@ -1,22 +0,0 @@
-import _curry3 from "./internal/_curry3";
-import _isObject from "./internal/_isObject";
-import mergeWithKey from "./mergeWithKey";
-
-const mergeDeepWithKey = _curry3(function mergeDeepWithKey(
-  fn: Function,
-  lObj: any,
-  rObj: any
-) {
-  return mergeWithKey(
-    function (k: Function, lVal: any, rVal: any) {
-      if (_isObject(lVal) && _isObject(rVal)) {
-        return mergeDeepWithKey(fn, lVal, rVal);
-      } else {
-        return fn(k, lVal, rVal);
-      }
-    },
-    lObj,
-    rObj
-  );
-});
-export default mergeDeepWithKey;

package/src/lib/ramda/mergeWithKey.ts

@@ -1,28 +0,0 @@
-import _curry3 from "./internal/_curry3";
-import _has from "./internal/_has";
-
-const mergeWithKey = _curry3(function mergeWithKey(
-  fn: Function,
-  l: any,
-  r: any
-) {
-  const result: any = {};
-  let k;
-  l = l || {};
-  r = r || {};
-
-  for (k in l) {
-    if (_has(k, l)) {
-      result[k] = _has(k, r) ? fn(k, l[k], r[k]) : l[k];
-    }
-  }
-
-  for (k in r) {
-    if (_has(k, r) && !_has(k, result)) {
-      result[k] = r[k];
-    }
-  }
-
-  return result;
-});
-export default mergeWithKey;