@mate-academy/analytics-client 1.0.0 → 1.1.0

package/dist/index.d.ts

@@ -35,10 +35,100 @@ interface AmplitudePluginOptions {
 }
 declare function createAmplitudePlugin(options: AmplitudePluginOptions): AnalyticsPlugin;
 
+interface SourceParams {
+    typ: string;
+    src: string;
+    mdm: string;
+    cmp: string;
+    cnt: string;
+    trm: string;
+    ac_id: string;
+    cmp_id: string;
+    adg_id: string;
+    ad_id: string;
+    trm_id: string;
+}
+interface ExtraData {
+    fd: string;
+    ep: string;
+    rf: string;
+}
+interface SessionData {
+    pgs: string;
+    cpg: string;
+    sid: string;
+}
+interface UserData {
+    vst: string;
+    uip: string;
+    uag: string;
+}
+interface Sourcebuster {
+    init(options: {
+        domain: string;
+        user_ip?: string;
+    }): void;
+    get: {
+        current: SourceParams;
+        current_add: ExtraData;
+        first: SourceParams;
+        first_add: ExtraData;
+        session: SessionData;
+        udata: UserData;
+    };
+}
+declare global {
+    interface Window {
+        sbjs?: Sourcebuster;
+    }
+}
+
+interface ClickIds {
+    gclid: string | null;
+    gbraid: string | null;
+    wbraid: string | null;
+    gClientid: string;
+    fbc: string | null;
+    fbp: string | null;
+    fbclid: string | null;
+    ttclid: string | null;
+    sdclid: string | null;
+    ksclid: string | null;
+}
+interface SourceData {
+    fvPage: string | null;
+    lvPage: string | null;
+    lvType: string | null;
+    lvSource: string | null;
+    lvMedium: string | null;
+    lvCampaign: string | null;
+    lvContent: string | null;
+    lvTerm: string | null;
+    lvAccountId: string | null;
+    lvCampaignId: string | null;
+    lvAdGroupId: string | null;
+    lvAdId: string | null;
+    lvTermId: string | null;
+}
+interface TrackingData extends SourceData, ClickIds {
+    locationIpAddress: string;
+    sessionId: string;
+    userAgent: string;
+}
+interface TrackingDataOptions {
+    sourceTracker: Sourcebuster | undefined;
+    sessionId: string;
+}
+declare function getUserIp(): string;
+declare function getTrackingData({ sourceTracker, sessionId, }: TrackingDataOptions): TrackingData;
+declare function getSourceData(sourceTracker: Sourcebuster | undefined): SourceData;
+declare function getClickIds(): ClickIds;
+declare function getFacebookParams(): Pick<ClickIds, 'fbc' | 'fbp' | 'fbclid'>;
+
 declare const PLUGIN_NAMES: {
     readonly DWH: "dwh";
     readonly AMPLITUDE: "amplitude";
 };
 type PluginName = typeof PLUGIN_NAMES[keyof typeof PLUGIN_NAMES];
 
-export { type AnalyticsPlugin, type DwhErrorContext, PLUGIN_NAMES, type PluginName, createAmplitudePlugin, createDwhPlugin, identify, registerPlugins, reset, track };
+export { type AnalyticsPlugin, type ClickIds, type DwhErrorContext, PLUGIN_NAMES, type PluginName, type SourceData, type Sourcebuster, type TrackingData, type TrackingDataOptions, createAmplitudePlugin, createDwhPlugin, getClickIds, getFacebookParams, getSourceData, getTrackingData, getUserIp, identify, registerPlugins, reset, track };

package/dist/index.js

@@ -116,6 +116,115 @@ var PLUGIN_NAMES = {
   AMPLITUDE: "amplitude"
 };
 
+// src/attribution.ts
+var UNKNOWN_USER_AGENT = "unknown";
+function getUserIp() {
+  return getCookieValue("_mate-user-ip") || "8.8.8.8";
+}
+function getTrackingData({
+  sourceTracker,
+  sessionId
+}) {
+  return {
+    ...getSourceData(sourceTracker),
+    ...getClickIds(),
+    locationIpAddress: getUserIp(),
+    sessionId,
+    userAgent: getUserAgent(sourceTracker)
+  };
+}
+function getSourceData(sourceTracker) {
+  if (!sourceTracker) {
+    return {
+      fvPage: null,
+      lvPage: null,
+      lvType: null,
+      lvSource: null,
+      lvMedium: null,
+      lvCampaign: null,
+      lvContent: null,
+      lvTerm: null,
+      lvAccountId: null,
+      lvCampaignId: null,
+      lvAdGroupId: null,
+      lvAdId: null,
+      lvTermId: null
+    };
+  }
+  const current = sourceTracker.get.current;
+  return {
+    fvPage: toPageValue(sourceTracker.get.first_add.ep),
+    lvPage: toPageValue(sourceTracker.get.current_add.ep),
+    lvType: current.typ,
+    lvSource: current.src,
+    lvMedium: current.mdm,
+    lvCampaign: current.cmp,
+    lvContent: current.cnt,
+    lvTerm: current.trm,
+    lvAccountId: current.ac_id,
+    lvCampaignId: current.cmp_id,
+    lvAdGroupId: current.adg_id,
+    lvAdId: current.ad_id,
+    lvTermId: current.trm_id
+  };
+}
+function getClickIds() {
+  const facebookParams = getFacebookParams();
+  return {
+    gclid: getCookieValue("_mate-gclid"),
+    gbraid: getCookieValue("_mate-gbraid"),
+    wbraid: getCookieValue("_mate-wbraid"),
+    gClientid: getCookieValue("_ga") ?? "0.0",
+    fbc: facebookParams.fbc,
+    fbp: facebookParams.fbp,
+    fbclid: facebookParams.fbclid,
+    ttclid: getCookieValue("_mate-ttclid"),
+    sdclid: getCookieValue("_mate-sdclid"),
+    ksclid: getCookieValue("_mate-ksclid")
+  };
+}
+function getFacebookParams() {
+  const fbp = getCookieValue("_fbp");
+  let fbc = getCookieValue("_fbc");
+  let fbclid = getCookieValue("_mate-fbclid");
+  if (fbclid?.includes("https://")) {
+    const queryParamsString = fbclid.split("?")[1];
+    const queryParams = new URLSearchParams(queryParamsString);
+    fbclid = queryParams.get("fbclid") ?? null;
+  }
+  if (!fbc && fbclid) {
+    fbc = `fb.1.${Date.now()}.${fbclid}`;
+  }
+  if (fbc?.includes("https://")) {
+    const queryParamsString = fbc.split("?")[1];
+    const fbcTimestamp = fbc.split(".")[2] ?? Date.now().toString();
+    const queryParams = new URLSearchParams(queryParamsString);
+    fbclid = queryParams.get("fbclid") ?? null;
+    fbc = `fb.1.${fbcTimestamp}.${fbclid}`;
+  }
+  return { fbp, fbc, fbclid };
+}
+function getUserAgent(sourceTracker) {
+  if (sourceTracker) {
+    return sourceTracker.get.udata.uag;
+  }
+  if (typeof navigator === "undefined") {
+    return UNKNOWN_USER_AGENT;
+  }
+  return navigator.userAgent;
+}
+function toPageValue(entrancePoint) {
+  if (!entrancePoint) {
+    return null;
+  }
+  try {
+    const pathname = new URL(entrancePoint).pathname.slice(1);
+    return pathname || "home";
+  } catch {
+    return null;
+  }
+}
+
 // src/plugins/dwh.ts
 var USER_ANALYTICS_ID_KEY = "_mate-user-analytics-id";
 var USER_SESSION_ID_KEY = "_mate-user-session-id";
@@ -127,9 +236,6 @@ function createDwhPlugin(options = {}) {
   const cookieDomain = options.cookieDomain ?? "mate.academy";
   const onError = options.onError;
   let sourceTracker;
-  function getUserIp() {
-    return getCookieValue("_mate-user-ip") || "8.8.8.8";
-  }
   function getUserId() {
     let fromStorage = null;
     try {
@@ -163,99 +269,6 @@ function createDwhPlugin(options = {}) {
     setCookie(USER_SESSION_ID_KEY, currentSessionId, SESSION_MAX_AGE_SECONDS);
     return { sessionId: currentSessionId, isNewSession: false };
   }
-  function getFirstVisitPage() {
-    if (!sourceTracker) {
-      return null;
-    }
-    const entrancePoint = sourceTracker.get.first_add.ep;
-    if (!entrancePoint) {
-      return null;
-    }
-    try {
-      const pathname = new URL(entrancePoint).pathname.slice(1);
-      return pathname || "home";
-    } catch {
-      return entrancePoint;
-    }
-  }
-  function getSourceData() {
-    if (!sourceTracker) {
-      return {
-        fvPage: null,
-        lvType: null,
-        lvSource: null,
-        lvMedium: null,
-        lvCampaign: null,
-        lvContent: null,
-        lvTerm: null,
-        lvAccountId: null,
-        lvCampaignId: null,
-        lvAdGroupId: null,
-        lvAdId: null,
-        lvTermId: null
-      };
-    }
-    const current = sourceTracker.get.current;
-    return {
-      fvPage: getFirstVisitPage(),
-      lvType: current.typ,
-      lvSource: current.src,
-      lvMedium: current.mdm,
-      lvCampaign: current.cmp,
-      lvContent: current.cnt,
-      lvTerm: current.trm,
-      lvAccountId: current.ac_id,
-      lvCampaignId: current.cmp_id,
-      lvAdGroupId: current.adg_id,
-      lvAdId: current.ad_id,
-      lvTermId: current.trm_id
-    };
-  }
-  function getFacebookParams() {
-    const fbp = getCookieValue("_fbp");
-    let fbc = getCookieValue("_fbc");
-    let fbclid = getCookieValue("_mate-fbclid");
-    if (fbclid?.includes("https://")) {
-      const queryParamsString = fbclid.split("?")[1];
-      const queryParams = new URLSearchParams(queryParamsString);
-      fbclid = queryParams.get("fbclid") ?? null;
-    }
-    if (!fbc && fbclid) {
-      fbc = `fb.1.${Date.now()}.${fbclid}`;
-    }
-    if (fbc?.includes("https://")) {
-      const queryParamsString = fbc.split("?")[1];
-      const fbcTimestamp = fbc.split(".")[2] ?? Date.now().toString();
-      const queryParams = new URLSearchParams(queryParamsString);
-      fbclid = queryParams.get("fbclid") ?? null;
-      fbc = `fb.1.${fbcTimestamp}.${fbclid}`;
-    }
-    return { fbp, fbc, fbclid };
-  }
-  function getClickIds() {
-    const facebookParams = getFacebookParams();
-    return {
-      gclid: getCookieValue("_mate-gclid"),
-      gbraid: getCookieValue("_mate-gbraid"),
-      wbraid: getCookieValue("_mate-wbraid"),
-      gClientid: getCookieValue("_ga") ?? "0.0",
-      fbc: facebookParams.fbc,
-      fbp: facebookParams.fbp,
-      fbclid: facebookParams.fbclid,
-      ttclid: getCookieValue("_mate-ttclid"),
-      sdclid: getCookieValue("_mate-sdclid"),
-      ksclid: getCookieValue("_mate-ksclid")
-    };
-  }
-  function getTrackingData(sessionId) {
-    return {
-      ...getSourceData(),
-      ...getClickIds(),
-      locationIpAddress: getUserIp(),
-      sessionId,
-      userAgent: sourceTracker ? sourceTracker.get.udata.uag : navigator.userAgent
-    };
-  }
   function sleep(ms) {
     return new Promise((resolve) => {
       setTimeout(resolve, ms);
@@ -286,7 +299,7 @@ function createDwhPlugin(options = {}) {
       const { sessionId, isNewSession } = ensureSessionId();
       const userId = getUserId();
       const deviceId = getOrCreateDeviceId();
-      const tracking = getTrackingData(sessionId);
+      const tracking = getTrackingData({ sourceTracker, sessionId });
       const basePayload = {
         session_id: sessionId,
         platform_user_id: userId,
@@ -402,6 +415,11 @@ export {
   PLUGIN_NAMES,
   createAmplitudePlugin,
   createDwhPlugin,
+  getClickIds,
+  getFacebookParams,
+  getSourceData,
+  getTrackingData,
+  getUserIp,
   identify,
   registerPlugins,
   reset,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mate-academy/analytics-client",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Pluggable analytics client for Mate academy external pages",
   "type": "module",
   "exports": {
@@ -13,7 +13,9 @@
     "dist/"
   ],
   "scripts": {
-    "build": "tsup"
+    "build": "tsup",
+    "type-check": "tsc --noEmit",
+    "test": "jest"
   },
   "dependencies": {
     "@amplitude/analytics-browser": "^2.40.0",
@@ -22,7 +24,10 @@
   },
   "devDependencies": {
     "@types/cookie": "^0.6.0",
+    "@types/jest": "^30.0.0",
     "@typescript-eslint/parser": "^8.58.1",
+    "jest": "^30.4.2",
+    "ts-jest": "^29.4.12",
     "tsup": "^8.0.0",
     "typescript": "^5.8.0"
   },