@jitsu/functions-lib 1.10.4 → 2.14.0-beta.101

package/__tests__/data/classic-events.ts

@@ -1,168 +0,0 @@
-export const classicEvents = [
-  {
-    _timestamp: "2024-12-25T14:23:48.606561Z",
-    api_key: "js.123.123",
-    click_id: {},
-    doc_encoding: "UTF-8",
-    doc_host: "events.example.com",
-    doc_path: "/a-v/123",
-    doc_search: "",
-    event_type: "user_identify",
-    eventn_ctx_event_id: "1d199165-fdf3-4051-82fc-08a8c5502f33",
-    ids: {
-      ga: "GA1.1.123.123",
-    },
-    local_tz_offset: 420,
-    page_title: "aa.aa.24",
-    referer: "",
-    screen_resolution: "1680x1050",
-    source_ip: "127.0.13.36",
-    src: "jitsu",
-    url: "https://events.example.com/a-v/123",
-    user: {
-      anonymous_id: "5adv25gea6",
-      email: "user@example.com",
-      hashed_anonymous_id: "41217f4f06dba2b145dbd7d0879a871e",
-      name: "John Doe",
-      uid: "123",
-    },
-    user_agent:
-      "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36",
-    user_language: "en-US",
-    utc_time: "2024-12-25T14:23:46.483000Z",
-    utm: {},
-    vp_size: "1384x775",
-  },
-  {
-    _timestamp: "2024-12-25T14:31:48.875505Z",
-    api_key: "s2s.123.123",
-    common_properties: {
-      c_version: "1.1.11",
-      client: {
-        creation_timestamp: "2024-12-25T14:31:48.794613+00:00",
-        id: "123",
-      },
-      in_v: false,
-      a_version: null,
-    },
-    event_type: "serve_init",
-    eventn_ctx_event_id: "99406a96-3bc3-4939-a3cc-6f5eeb458078",
-    session_id: "abc",
-    source_ip: "127.0.41.132",
-    src: "api",
-  },
-  {
-    _timestamp: "2024-12-25T14:26:22.484904Z",
-    api_key: "js.123.123",
-    chromeVersion: "131",
-    click_id: {},
-    companyId: 123,
-    email: "john.doe@example.com",
-    event_type: "workflow-complete",
-    eventn_ctx_event_id: "62615da7-a605-420f-9b73-d88ca488fa6d",
-    ids: {},
-    info: {
-      billing: {
-        nodeTypeCounts: {
-          "click-element": 13,
-        },
-        ticketDurationsMs: [],
-      },
-      callCount: 1,
-      metrics: {
-        actual: {},
-      },
-      results: [
-        {
-          callCount: 1,
-        },
-      ],
-      status: "complete",
-    },
-    jobId: "f3b97b73-15e5-4d5b-af73-43bbbf237b24",
-    local_tz_offset: 0,
-    manifestVersion: "1.0.0",
-    runtimeEnvironment: "production",
-    source_ip: "127.0.32.11",
-    src: "jitsu",
-    teamId: 1,
-    timestamp: 1735136772062,
-    type: "workflow-complete",
-    user: {
-      anonymous_id: "",
-      hashed_anonymous_id: "bef91c4d78dbf5b10b791d1f483faa9a",
-    },
-    user_agent:
-      "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36",
-    utc_time: "2024-12-25T14:26:12.097000Z",
-    utm: {},
-  },
-  {
-    _timestamp: "2024-12-25T00:26:56.305721Z",
-    api_key: "js.123.123",
-    click_id: {
-      gclid: "123",
-      dclid: "1233",
-    },
-    doc_encoding: "UTF-8",
-    doc_host: "app.example.com",
-    doc_path: "/login",
-    doc_search: "?next=%2F",
-    event_type: "pageview",
-    eventn_ctx_event_id: "15fea8d7-14af-4488-92a9-0ae52eba5499",
-    ids: {},
-    local_tz_offset: 300,
-    page_title: "Login - Litnerd",
-    referer: "",
-    screen_resolution: "1920x1080",
-    source_ip: "127.0.56.1",
-    src: "jitsu",
-    url: "https://app.example.com/login?next=%2F",
-    user: {
-      anonymous_id: "123",
-      hashed_anonymous_id: "49a8381a0fe28827b68a48416dd69a23",
-      id: "student:123",
-      name: "JOHN DOE",
-      role: "student",
-      school_id: 123,
-    },
-    user_agent:
-      "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36",
-    user_language: "en-US",
-    utc_time: "2024-12-25T00:26:56.481000Z",
-    utm: {},
-    vp_size: "1920x911",
-  },
-  {
-    _timestamp: "2024-12-25T15:33:08.369746Z",
-    api_key: "s2s.123.123",
-    click_id: {
-      gclid: "123",
-      dclid: "1233",
-    },
-    doc_host: "localhost:3000",
-    doc_path: "/auth/login",
-    doc_search: "",
-    event_type: "page_view",
-    eventn_ctx_event_id: "98373e80-6228-4163-957e-90703182e9de",
-    ids: {
-      ga: "GA1.1.123.123",
-    },
-    isAuthorized: false,
-    nextPrefetch: false,
-    onVercel: false,
-    page_title: "",
-    page_url: "http://localhost:3000/auth/login",
-    referer: "",
-    source_ip: "",
-    src: "api",
-    url: "http://localhost:3000/auth/login",
-    user: {
-      anonymous_id: "123",
-      hashed_anonymous_id: "ee3cd46ca7a46adb9fa1c9599e64249f",
-    },
-    user_agent: "Wget/1.21.3",
-    utc_time: "2024-12-25T15:33:07.992Z",
-    utm: {},
-  },
-];

package/jest.config.js

@@ -1,8 +0,0 @@
-/** @type {import("ts-jest").JestConfigWithTsJest} */
-module.exports = {
-  preset: "ts-jest",
-  testMatch: ["**/__tests__/**/*.test.ts"],
-  testEnvironment: "node",
-  runner: "jest-runner",
-  "setupFiles": ["./jest.setup.js"]
-};

package/jest.setup.js

@@ -1,8 +0,0 @@
-
-global.console = {
-  log: message => process.stdout.write(message + '\n'),
-  error: console.error,
-  warn: console.warn,
-  info: console.info,
-  debug: console.debug,
-};

package/rollup.config.js

@@ -1,14 +0,0 @@
-const typescript = require("@rollup/plugin-typescript");
-const resolve = require("@rollup/plugin-node-resolve");
-const commonjs = require("@rollup/plugin-commonjs");
-
-module.exports = [
-  {
-    plugins: [typescript(), resolve({ preferBuiltins: false }), commonjs()],
-    input: ["./src/index.ts"],
-    output: [
-      { file: "dist/index.es.js", format: "es" },
-      { file: "dist/index.cjs.js", format: "cjs" },
-    ],
-  },
-];

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from "./lib/functions";
-export * from "./lib/objects";
-export * from "./lib/strings";

package/src/lib/functions.ts

@@ -1,341 +0,0 @@
-import { AnyEvent, FullContext, UserAgent } from "@jitsu/protocols/functions";
-import { AnalyticsServerEvent } from "@jitsu/protocols/analytics";
-import { removeUndefined, transferAsSnakeCase, transfer, transferAsClassic } from "./objects";
-
-export const TableNameParameter = "JITSU_TABLE_NAME";
-
-export const DropRetryErrorName = "Drop & RetryError";
-export const RetryErrorName = "RetryError";
-
-export class RetryError extends Error {
-  status: number;
-  response: string;
-  message: string;
-  constructor(message?: any, options?: { drop: boolean }) {
-    if (typeof message === "object") {
-      super(message.message);
-      this.message = message.message;
-      this.status = message.status;
-      this.response = message.response;
-    } else {
-      super(message);
-      this.message = message;
-    }
-    this.name = options?.drop ? `${DropRetryErrorName}` : `${RetryErrorName}`;
-  }
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      status: this.status,
-      response: this.response,
-    };
-  }
-}
-
-export class HTTPError extends Error {
-  status: number;
-  response: string;
-  message: string;
-  constructor(message: string, status: number, response: string) {
-    super(message);
-    this.message = message;
-    this.name = "HTTPError";
-    this.status = status;
-    this.response = response.length > 1000 ? response.slice(0, 1000) + "..." : response;
-  }
-
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      status: this.status,
-      response: this.response,
-    };
-  }
-}
-
-function anonymizeIp(ip: string | undefined) {
-  if (!ip) {
-    return;
-  }
-  const parts = ip.split(".");
-  if (parts.length === 4) {
-    return `${parts[0]}.${parts[1]}.${parts[2]}.0`;
-  }
-}
-
-export function toJitsuClassic(event: AnalyticsServerEvent, ctx: FullContext): AnyEvent {
-  const keepOriginalNames = !!ctx.props.keepOriginalNames;
-  const fileStorage = ctx.destination.type === "s3" || ctx.destination.type === "gcs";
-  let transferFunc = transferAsSnakeCase;
-  if (keepOriginalNames) {
-    if (fileStorage) {
-      transferFunc = transfer;
-    } else {
-      transferFunc = transferAsClassic;
-    }
-  }
-  let url: URL | undefined = undefined;
-  const analyticsContext = event.context || {};
-  const urlStr = analyticsContext.page?.url || event.properties?.url;
-  try {
-    if (urlStr) {
-      url = new URL(urlStr as string);
-    }
-  } catch (e) {}
-  const click_id = {};
-  transferFunc(click_id, analyticsContext.clientIds, ["ga4", "fbp", "fbc"]);
-  let ids: any = {};
-  if (Object.keys(analyticsContext.clientIds || {}).length > 0) {
-    ids = removeUndefined({
-      ga: analyticsContext.clientIds.ga4?.clientId,
-      fbp: analyticsContext.clientIds.fbp,
-      fbc: analyticsContext.clientIds.fbc,
-    });
-  }
-  const geo = analyticsContext.geo || {};
-  const ua: UserAgent = ctx?.ua || ({} as UserAgent);
-  const user = removeUndefined({
-    id: event.userId,
-    anonymous_id: event.anonymousId,
-    email: (analyticsContext.traits?.email || event.traits?.email || undefined) as string | undefined,
-    name: (analyticsContext.traits?.name || event.traits?.name || undefined) as string | undefined,
-  });
-  transferFunc(user, analyticsContext.traits, ["email", "name"]);
-  transferFunc(user, event.traits, ["email", "name"]);
-  const classic = {
-    [TableNameParameter]: event[TableNameParameter],
-    anon_ip: analyticsContext.ip ? anonymizeIp(analyticsContext.ip) : undefined,
-    api_key: event.writeKey || "",
-    click_id: Object.keys(click_id).length > 0 ? click_id : undefined,
-    doc_encoding: analyticsContext.page?.encoding ?? event.properties?.encoding,
-    doc_host: (analyticsContext.page?.host ?? event.properties?.host) || url?.host,
-    doc_path: (analyticsContext.page?.path ?? event.properties?.path) || url?.pathname,
-    doc_search: (analyticsContext.page?.search ?? event.properties?.search) || url?.search,
-    eventn_ctx_event_id: event.messageId,
-    event_type: event.event || event.type,
-    local_tz_offset: analyticsContext.page?.timezoneOffset ?? event.properties?.timezoneOffset,
-    page_title: analyticsContext.page?.title,
-    referer: analyticsContext.page?.referrer,
-    screen_resolution:
-      Object.keys(analyticsContext.screen || {}).length > 0
-        ? Math.max(analyticsContext.screen.width || 0) + "x" + Math.max(analyticsContext.screen.height || 0)
-        : undefined,
-    source_ip: analyticsContext.ip,
-    src: event.properties?.src || "jitsu",
-    url: urlStr as string,
-    user: Object.keys(user).length > 0 ? user : undefined,
-    location:
-      Object.keys(geo).length > 0
-        ? {
-            city: geo.city?.name,
-            continent: geo.continent?.name,
-            country: geo.country?.code,
-            country_name: geo.country?.name,
-            latitude: geo.location?.latitude,
-            longitude: geo.location?.longitude,
-            region: geo.region?.code,
-            zip: geo.postalCode?.code,
-            timezone: geo.location?.timezone,
-            autonomous_system_number: geo.provider?.as?.num,
-            autonomous_system_organization: geo.provider?.as?.name,
-            isp: geo.provider?.isp,
-            domain: geo.provider?.domain,
-          }
-        : undefined,
-    ids: Object.keys(ids).length > 0 ? ids : undefined,
-    parsed_ua:
-      event.parsed_ua ||
-      (Object.keys(ua).length > 0
-        ? {
-            os_family: ua.os?.name,
-            os_version: ua.os?.version,
-            ua_family: ua.browser?.name,
-            ua_version: ua.browser?.version,
-            device_brand: ua.device?.vendor,
-            device_type: ua.device?.type,
-            device_model: ua.device?.model,
-            bot: ua.bot,
-          }
-        : undefined),
-    user_agent: analyticsContext.userAgent,
-    user_language: analyticsContext.locale,
-    utc_time: event.timestamp,
-    _timestamp: event.receivedAt,
-    utm: analyticsContext.campaign,
-    vp_size:
-      Object.keys(analyticsContext.screen || {}).length > 0
-        ? Math.max(analyticsContext.screen.innerWidth || 0) + "x" + Math.max(analyticsContext.screen.innerHeight || 0)
-        : undefined,
-  };
-  if (event.type === "track") {
-    transferFunc(classic, event.properties);
-  } else {
-    transferFunc(classic, event.properties, ["url", "title", "referrer", "search", "host", "path", "width", "height"]);
-  }
-
-  return removeUndefined(classic);
-}
-
-export function fromJitsuClassic(event: AnyEvent): AnyEvent {
-  let type = "track";
-  let eventName: string | undefined = undefined;
-  switch ((event.event_type ?? "").toLowerCase()) {
-    case "pageview":
-    case "page_view":
-    case "page":
-      type = "page";
-      eventName = event.event_type;
-      break;
-    case "identify":
-      type = "identify";
-      break;
-    case "screen":
-      type = "screen";
-      break;
-    case "group":
-      type = "group";
-      break;
-    case "alias":
-      type = "alias";
-      break;
-    default:
-      type = "track";
-      eventName = event.event_type;
-      break;
-  }
-  const clientIds =
-    Object.keys(event.ids || event.click_id || {}).length > 0
-      ? {
-          ga4: event.ids?.ga
-            ? {
-                clientId: event.ids.ga,
-              }
-            : undefined,
-          fbp: event.ids?.fbp,
-          fbc: event.ids?.fbc,
-          ...event.click_id,
-        }
-      : undefined;
-  const loc = event.location || {};
-  const geo =
-    Object.keys(loc).length > 0
-      ? {
-          city: {
-            name: loc.city,
-          },
-          continent: {
-            code: loc.continent,
-          },
-          country: {
-            code: loc.country,
-            name: loc.country_name,
-          },
-          location: {
-            latitude: loc.latitude,
-            longitude: loc.longitude,
-            timezone: loc.timezone,
-          },
-          region: {
-            code: loc.region,
-          },
-          postalCode: {
-            code: loc.zip,
-          },
-          provider: {
-            as: {
-              num: loc.autonomous_system_number,
-              name: loc.autonomous_system_organization,
-            },
-            isp: loc.isp,
-            domain: loc.domain,
-          },
-        }
-      : undefined;
-  const traits = {};
-  transfer(traits, event.user, ["id", "anonymous_id"]);
-  const properties: any = {};
-  transfer(properties, event, [
-    TableNameParameter,
-    "anon_ip",
-    "api_key",
-    "click_id",
-    "doc_encoding",
-    "doc_host",
-    "doc_path",
-    "doc_search",
-    "eventn_ctx_event_id",
-    "event_type",
-    "local_tz_offset",
-    "page_title",
-    "referer",
-    "screen_resolution",
-    "source_ip",
-    "url",
-    "user",
-    "location",
-    "parsed_ua",
-    "user_agent",
-    "user_language",
-    "utc_time",
-    "_timestamp",
-    "utm",
-    "vp_size",
-  ]);
-  if (type === "page") {
-    properties.url = event.url;
-    properties.title = event.page_title;
-    properties.referrer = event.referer;
-    properties.search = event.doc_search;
-    properties.host = event.doc_host;
-    properties.path = event.doc_path;
-    properties.width = parseInt(event.vp_size?.split("x")[0]);
-    properties.height = parseInt(event.vp_size?.split("x")[1]);
-  }
-  const screen: any = {};
-  const sr = event.screen_resolution?.split("x");
-  if (sr?.length === 2) {
-    screen.width = parseInt(sr[0]);
-    screen.height = parseInt(sr[1]);
-  }
-  const vs = event.vp_size?.split("x");
-  if (vs?.length === 2) {
-    screen.innerWidth = parseInt(vs[0]);
-    screen.innerHeight = parseInt(vs[1]);
-  }
-
-  return removeUndefined({
-    [TableNameParameter]: event[TableNameParameter],
-    messageId: event.eventn_ctx_event_id,
-    userId: event.user?.id,
-    anonymousId: event.user?.anonymous_id,
-    timestamp: event.utc_time,
-    receivedAt: event._timestamp,
-    writeKey: event.api_key,
-    type,
-    event: eventName,
-    context: {
-      ip: event.source_ip,
-      locale: event.user_language,
-      userAgent: event.user_agent,
-      page: {
-        url: event.url,
-        title: event.page_title,
-        referrer: event.referer,
-        search: event.doc_search,
-        host: event.doc_host,
-        path: event.doc_path,
-        encoding: event.doc_encoding,
-        timezoneOffset: event.local_tz_offset,
-      },
-      screen: Object.keys(screen).length > 0 ? screen : undefined,
-      clientIds,
-      campaign: event.utm,
-      traits,
-      geo,
-    },
-    properties,
-    traits: type === "identify" || type === "group" ? traits : undefined,
-  });
-}

package/src/lib/objects.ts

@@ -1,96 +0,0 @@
-import { idToClassic, idToSnakeCaseFast } from "./strings";
-
-export function toSnakeCase(param: any): any {
-  if (Array.isArray(param)) {
-    return param.map(toSnakeCase);
-  } else if (typeof param === "object" && param !== null) {
-    const r = {};
-    for (const [key, value] of Object.entries(param)) {
-      r[idToSnakeCaseFast(key)] = toSnakeCase(value);
-    }
-    return r;
-  } else {
-    return param;
-  }
-}
-
-export function toClassic(param: any): any {
-  if (Array.isArray(param)) {
-    return param.map(toClassic);
-  } else if (typeof param === "object" && param !== null) {
-    const r = {};
-    for (const [key, value] of Object.entries(param)) {
-      r[idToClassic(key)] = toClassic(value);
-    }
-    return r;
-  } else {
-    return param;
-  }
-}
-
-export function removeUndefined(param: any): any {
-  if (Array.isArray(param)) {
-    return param.map(removeUndefined);
-  } else if (typeof param === "object" && param !== null) {
-    for (const [key, value] of Object.entries(param)) {
-      switch (typeof value) {
-        case "undefined":
-          delete param[key];
-          break;
-        case "object":
-          if (value !== null) {
-            removeUndefined(value);
-          }
-          break;
-      }
-    }
-  }
-  return param;
-}
-
-export function transferAsSnakeCase(target: Record<string, any>, source: any, omit?: string[]) {
-  if (typeof source !== "object") {
-    return;
-  }
-  for (const [k, v] of Object.entries(source)) {
-    if (!omit || !omit.includes(k)) {
-      target[idToSnakeCaseFast(k)] = toSnakeCase(v);
-    }
-  }
-}
-
-export function transferAsClassic(target: Record<string, any>, source: any, omit?: string[]) {
-  if (typeof source !== "object") {
-    return;
-  }
-  for (const [k, v] of Object.entries(source)) {
-    if (!omit || !omit.includes(k)) {
-      target[idToClassic(k)] = toClassic(v);
-    }
-  }
-}
-
-export function transferValueAsSnakeCase(target: Record<string, any>, property: string, source: any) {
-  if (typeof source === "undefined") {
-    return;
-  }
-  target[property] = toSnakeCase(source);
-}
-
-export function transfer(target: Record<string, any>, source: any, omit?: string[]) {
-  if (typeof source !== "object") {
-    return;
-  }
-  for (const [k, v] of Object.entries(source)) {
-    if (!omit || !omit.includes(k)) {
-      target[k] = v;
-    }
-  }
-}
-
-export function transferValue(target: Record<string, any>, property: string, source: any) {
-  if (typeof source === "undefined") {
-    return;
-  }
-  target[property] = source;
-}

package/src/lib/strings.ts

@@ -1,60 +0,0 @@
-const ACode = "A".charCodeAt(0);
-const ZCode = "Z".charCodeAt(0);
-const aCode = "a".charCodeAt(0);
-const zCode = "z".charCodeAt(0);
-const zeroCode = "0".charCodeAt(0);
-const nineCode = "9".charCodeAt(0);
-const spaceCode = " ".charCodeAt(0);
-const underscodeCode = "_".charCodeAt(0);
-
-export function idToSnakeCaseFast(id: string) {
-  let res = "";
-  let concatIndex = 0;
-  let i = 0;
-  let needUnderscore = false;
-  for (; i < id.length; i++) {
-    const c = id.charCodeAt(i);
-    if (c >= ACode && c <= ZCode) {
-      res += id.substring(concatIndex, i) + (needUnderscore ? "_" : "") + id.charAt(i).toLowerCase();
-      concatIndex = i + 1;
-    } else if (c == spaceCode) {
-      res += id.substring(concatIndex, i) + "_";
-      concatIndex = i + 1;
-    }
-    // needUnderscore is used in case next char is a capital latin letter
-    // we add underscore only between latin letters
-    needUnderscore = (c >= aCode && c <= zCode) || (c >= ACode && c <= ZCode);
-  }
-  if (concatIndex == 0) {
-    return id;
-  } else if (concatIndex < i) {
-    res += id.substring(concatIndex, i);
-  }
-  return res;
-}
-
-export function idToClassic(id: string) {
-  let needConvert = false;
-  for (let i = 0; i < id.length; i++) {
-    const c = id.charCodeAt(i);
-    if (!((c >= aCode && c <= zCode) || (c >= zeroCode && c <= nineCode) || c == underscodeCode)) {
-      needConvert = true;
-      break;
-    }
-  }
-  if (!needConvert) {
-    return id;
-  }
-  let res = "";
-  for (let i = 0; i < id.length; i++) {
-    const c = id.charCodeAt(i);
-    if (c >= ACode && c <= ZCode) {
-      res += id.charAt(i).toLowerCase();
-    } else if ((c >= aCode && c <= zCode) || (c >= zeroCode && c <= nineCode)) {
-      res += id.charAt(i);
-    } else {
-      res += "_";
-    }
-  }
-  return res;
-}