rozmova-analytics 1.0.1 → 1.0.3

package/dist/analytics.d.ts

@@ -0,0 +1,6 @@
+import { AnalyticsCommonParams } from "./types";
+export declare const generateUserId: () => string;
+export declare const getUserId: () => string;
+export declare const getCommonParams: () => AnalyticsCommonParams;
+export declare const init: (additionalParams?: Record<string, string>) => void;
+export declare const trackEvent: (eventName: string, properties?: {}) => void;

package/dist/analytics.js

@@ -0,0 +1,107 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.trackEvent = exports.init = exports.getUserId = exports.getCommonParams = exports.generateUserId = void 0;
+var _jsCookie = _interopRequireDefault(require("js-cookie"));
+var _mixpanelBrowser = _interopRequireDefault(require("mixpanel-browser"));
+var _nanoid = require("nanoid");
+var _constants = require("./constants");
+var _helpers = require("./helpers");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+var generateUserId = exports.generateUserId = function generateUserId() {
+  var userId = (0, _nanoid.nanoid)();
+  var domain = (0, _helpers.getDomain)();
+  _jsCookie["default"].set(_constants.USER_ID_KEY, userId, {
+    domain: domain
+  });
+  localStorage.setItem(_constants.USER_ID_KEY, userId);
+  return userId;
+};
+var getUserId = exports.getUserId = function getUserId() {
+  return _jsCookie["default"].get(_constants.USER_ID_KEY) || localStorage.getItem(_constants.USER_ID_KEY) || (0, _helpers.getQueryParam)(_constants.USER_ID_KEY) || generateUserId();
+};
+var getCurrentParams = function getCurrentParams() {
+  var paramsFromCookie = _jsCookie["default"].get(_constants.PARAMS_COOKIE_NAME);
+  var prevParams = paramsFromCookie ? JSON.parse(paramsFromCookie) : {};
+  var searchParams = new URLSearchParams(window.location.search);
+  var isNewSetUTM = _constants.UTM_KEYS.some(function (utmKey) {
+    return searchParams.get(utmKey) && searchParams.get(utmKey) !== prevParams[utmKey];
+  });
+  var currentUTMParams = isNewSetUTM ? _constants.UTM_KEYS.reduce(function (prev, curr) {
+    return _objectSpread(_objectSpread({}, prev), {}, _defineProperty({}, curr, searchParams.get(curr)));
+  }, {}) : _constants.UTM_KEYS.reduce(function (prev, curr) {
+    return _objectSpread(_objectSpread({}, prev), {}, _defineProperty({}, curr, prevParams[curr]));
+  }, {});
+  var currentParams = _objectSpread(_objectSpread({}, currentUTMParams), {}, {
+    referrer: (0, _helpers.getReferrer)() || prevParams.referrer,
+    search_query: (0, _helpers.getSearchQueryFromReferrer)() || prevParams.search_query,
+    landing_page_url: prevParams.landing_page_url || window.location.href
+  });
+  _jsCookie["default"].set(_constants.PARAMS_COOKIE_NAME, JSON.stringify(currentParams), {
+    domain: (0, _helpers.getDomain)()
+  });
+  return currentParams;
+};
+var getCommonParams = exports.getCommonParams = function getCommonParams() {
+  var persistedParams = getCurrentParams();
+  return _objectSpread(_objectSpread({}, persistedParams), {}, {
+    fbc: _jsCookie["default"].get("_fbc"),
+    fbp: _jsCookie["default"].get("_fbp"),
+    session_id: (0, _helpers.getGASessionId)(),
+    user_pseudo_id: (0, _helpers.getGAClientId)(),
+    rid: getUserId(),
+    funnel_name: _jsCookie["default"].get("funnel_name"),
+    funnel_type: _jsCookie["default"].get("funnel_type"),
+    language: (0, _helpers.getBrowserLanguage)(),
+    platform: "web",
+    url: window.location.href,
+    device: (0, _helpers.detectDeviceType)(),
+    browser: (0, _helpers.detectBrowser)(),
+    system: (0, _helpers.detectOS)()
+  });
+};
+var init = exports.init = function init() {
+  var additionalParams = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var userId = getUserId();
+  if ((0, _helpers.isMetaBrowser)()) {
+    (0, _helpers.setQueryParam)(_constants.USER_ID_KEY, userId);
+  }
+  (0, _helpers.waitForGA)(function () {
+    _mixpanelBrowser["default"].init(_constants.MIXPANEL_TOKEN, {
+      debug: false,
+      track_pageview: "url-with-path",
+      persistence: "cookie"
+    });
+    var userProperties = _objectSpread(_objectSpread({}, getCommonParams()), additionalParams);
+    _mixpanelBrowser["default"].register(userProperties);
+    gtag("config", _constants.GOOGLE_ANALYTICS_ID, {
+      user_properties: userProperties,
+      server_container_url: _constants.GA_SERVER_CONTAINER_URL
+    });
+  });
+};
+var trackEvent = exports.trackEvent = function trackEvent(eventName) {
+  var properties = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  (0, _helpers.waitForGA)(function () {
+    var commonParams = getCommonParams();
+    var params = _objectSpread(_objectSpread({}, commonParams), properties);
+    try {
+      _mixpanelBrowser["default"].track(eventName, params);
+    } catch (e) {
+      console.log(e);
+    }
+    try {
+      gtag("event", eventName, params);
+    } catch (e) {
+      console.log(e);
+    }
+  });
+};

package/dist/constants.d.ts

@@ -0,0 +1,6 @@
+export declare const USER_ID_KEY = "rid";
+export declare const PARAMS_COOKIE_NAME = "rozmovaAnalyticsParams";
+export declare const UTM_KEYS: string[];
+export declare const GOOGLE_ANALYTICS_ID = "G-9PCTLFE0F6";
+export declare const GA_SERVER_CONTAINER_URL = "https://tagging.clearly.help";
+export declare const MIXPANEL_TOKEN = "9d4cb3d213e5aee689ea01dd68ad65ad";

package/dist/constants.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.UTM_KEYS = exports.USER_ID_KEY = exports.PARAMS_COOKIE_NAME = exports.MIXPANEL_TOKEN = exports.GOOGLE_ANALYTICS_ID = exports.GA_SERVER_CONTAINER_URL = void 0;
+var USER_ID_KEY = exports.USER_ID_KEY = "rid";
+var PARAMS_COOKIE_NAME = exports.PARAMS_COOKIE_NAME = "rozmovaAnalyticsParams";
+var UTM_KEYS = exports.UTM_KEYS = ["utm_source", "utm_medium", "utm_campaign", "utm_campaign_id", "utm_advertiser_id", "utm_adset_id", "utm_adset_name", "utm_ad_id", "utm_ad_name", "utm_keyword"];
+var GOOGLE_ANALYTICS_ID = exports.GOOGLE_ANALYTICS_ID = "G-9PCTLFE0F6";
+var GA_SERVER_CONTAINER_URL = exports.GA_SERVER_CONTAINER_URL = "https://tagging.clearly.help";
+var MIXPANEL_TOKEN = exports.MIXPANEL_TOKEN = "9d4cb3d213e5aee689ea01dd68ad65ad";

package/dist/helpers.d.ts

@@ -0,0 +1,13 @@
+export declare const setQueryParam: (name: string, value: string) => void;
+export declare const getQueryParam: (name: string) => string | null;
+export declare const isMetaBrowser: () => any;
+export declare const getBrowserLanguage: () => string;
+export declare function detectBrowser(): "Microsoft Edge" | "Chrome" | "Firefox" | "Safari" | "Opera" | "Internet Explorer" | "Unknown";
+export declare function detectDeviceType(): "Mobile" | "Desktop";
+export declare function detectOS(): "Windows" | "macOS" | "Linux" | "Android" | "iOS" | "Unknown OS";
+export declare const getDomain: () => string;
+export declare const getReferrer: () => string | null;
+export declare function getSearchQueryFromReferrer(): string | null;
+export declare const getGAClientId: () => string;
+export declare function getGASessionId(): string | null;
+export declare const waitForGA: (callback: () => void) => void;

package/dist/helpers.js

@@ -0,0 +1,152 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.detectBrowser = detectBrowser;
+exports.detectDeviceType = detectDeviceType;
+exports.detectOS = detectOS;
+exports.getGAClientId = exports.getDomain = exports.getBrowserLanguage = void 0;
+exports.getGASessionId = getGASessionId;
+exports.getReferrer = exports.getQueryParam = void 0;
+exports.getSearchQueryFromReferrer = getSearchQueryFromReferrer;
+exports.waitForGA = exports.setQueryParam = exports.isMetaBrowser = void 0;
+var _jsCookie = _interopRequireDefault(require("js-cookie"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+var setQueryParam = exports.setQueryParam = function setQueryParam(name, value) {
+  var url = new URL(window.location.href);
+  url.searchParams.set(name, value);
+  window.history.replaceState({
+    path: url.toString()
+  }, "", url.toString());
+};
+var getQueryParam = exports.getQueryParam = function getQueryParam(name) {
+  var searchParams = new URLSearchParams(window.location.search);
+  return searchParams.get(name);
+};
+var isMetaBrowser = exports.isMetaBrowser = function isMetaBrowser() {
+  // @ts-expect-error opera property
+  var ua = navigator.userAgent || navigator.vendor || window.opera;
+  return ua.match(/FBAN|FBAV|Instagram/i);
+};
+var getBrowserLanguage = exports.getBrowserLanguage = function getBrowserLanguage() {
+  return window.navigator.language;
+};
+function detectBrowser() {
+  var userAgent = navigator.userAgent;
+  if (userAgent.indexOf("Edg") > -1) {
+    return "Microsoft Edge";
+  } else if (userAgent.indexOf("Chrome") > -1) {
+    return "Chrome";
+  } else if (userAgent.indexOf("Firefox") > -1) {
+    return "Firefox";
+  } else if (userAgent.indexOf("Safari") > -1) {
+    return "Safari";
+  } else if (userAgent.indexOf("Opera") > -1) {
+    return "Opera";
+  } else if (userAgent.indexOf("Trident") > -1 || userAgent.indexOf("MSIE") > -1) {
+    return "Internet Explorer";
+  }
+  return "Unknown";
+}
+function detectDeviceType() {
+  var userAgent = navigator.userAgent;
+  if (/Mobi|Android|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(userAgent)) {
+    return "Mobile";
+  } else {
+    return "Desktop";
+  }
+}
+function detectOS() {
+  var userAgent = navigator.userAgent;
+  if (userAgent.includes("Win")) {
+    return "Windows";
+  } else if (userAgent.includes("Mac")) {
+    return "macOS";
+  } else if (userAgent.includes("X11") || userAgent.includes("Linux")) {
+    return "Linux";
+  } else if (userAgent.includes("Android")) {
+    return "Android";
+  } else if (userAgent.includes("like Mac")) {
+    return "iOS";
+  } else {
+    return "Unknown OS";
+  }
+}
+var getDomain = exports.getDomain = function getDomain() {
+  var domainParts = window.location.hostname.split(".");
+  var domainPartsLength = domainParts.length;
+  if (domainParts.length === 1) return domainParts[0];
+  return domainParts.slice(domainPartsLength - 2, domainPartsLength).join(".");
+};
+var getReferrer = exports.getReferrer = function getReferrer() {
+  var referrer = document.referrer;
+  if (referrer) {
+    var url = new URL(referrer);
+    if (url.hostname.includes(getDomain())) {
+      return null;
+    }
+  }
+  return referrer;
+};
+function getSearchQueryFromReferrer() {
+  // Get the referrer URL (the page that linked to your site)
+  var referrer = getReferrer();
+  if (!referrer) {
+    return null; // No referrer, likely a direct visit or from a link without referrer
+  }
+
+  // Define search engine domains and their query parameter for search terms
+  var searchEngines = {
+    "google.com": "q",
+    "bing.com": "q",
+    "yahoo.com": "p",
+    "duckduckgo.com": "q",
+    "ask.com": "q",
+    "baidu.com": "wd",
+    "yandex.com": "text"
+  };
+
+  // Create a URL object for the referrer
+  var referrerUrl = new URL(referrer);
+
+  // Check if the referrer is a known search engine
+  for (var _i = 0, _Object$entries = Object.entries(searchEngines); _i < _Object$entries.length; _i++) {
+    var _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
+      domain = _Object$entries$_i[0],
+      queryParam = _Object$entries$_i[1];
+    if (referrerUrl.hostname.includes(domain)) {
+      // If the referrer is a search engine, extract the search query
+      var searchQuery = referrerUrl.searchParams.get(queryParam);
+      return searchQuery ? decodeURIComponent(searchQuery) : null;
+    }
+  }
+
+  // If no match with search engines, return null
+  return null;
+}
+var getGAClientId = exports.getGAClientId = function getGAClientId() {
+  var clientId = _jsCookie["default"].get("_ga");
+  if (!clientId) return "";
+  var splitedClientId = clientId.split(".");
+  return splitedClientId[2] + "." + splitedClientId[3];
+};
+function getGASessionId() {
+  // Use your own ID here ↓
+  var pattern = /_ga_9PCTLFE0F6=GS\d\.\d\.(.+?)(?:;|$)/;
+  var match = document.cookie.match(pattern);
+  var parts = match === null || match === void 0 ? void 0 : match[1].split(".");
+  if (parts) return parts[0];
+  return null;
+}
+var _waitForGA = exports.waitForGA = function waitForGA(callback) {
+  if (getGASessionId()) callback();else setTimeout(function () {
+    return _waitForGA(callback);
+  }, 1000);
+};

package/dist/index.d.ts

@@ -1,4 +1,7 @@
-declare const Analytics: {
-    init(): void;
+export declare const Analytics: {
+    getUserId: () => string;
+    generateUserId: () => string;
+    init: (additionalParams?: Record<string, string>) => void;
+    getCommonParams: () => import("./types").AnalyticsCommonParams;
+    trackEvent: (eventName: string, properties?: {}) => void;
 };
-export default Analytics;

package/dist/index.js

@@ -3,10 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports["default"] = void 0;
-var Analytics = {
-  init: function init() {
-    console.log("init");
-  }
-};
-var _default = exports["default"] = Analytics;
+exports.Analytics = void 0;
+var _analytics = require("./analytics");
+var Analytics = exports.Analytics = {
+  getUserId: _analytics.getUserId,
+  generateUserId: _analytics.generateUserId,
+  init: _analytics.init,
+  getCommonParams: _analytics.getCommonParams,
+  trackEvent: _analytics.trackEvent
+};

package/dist/types.d.ts

@@ -0,0 +1,28 @@
+export type AnalyticsCommonParams = {
+    utm_source: string;
+    utm_medium: string;
+    utm_campaign: string;
+    utm_campaign_id: string;
+    utm_advertiser_id: string;
+    utm_adset_id: string;
+    utm_adset_name: string;
+    utm_ad_id: string;
+    utm_ad_name: string;
+    utm_keyword: string;
+    referrer: string;
+    search_query: string;
+    landing_page_url: string;
+    fbp?: string;
+    fbc?: string;
+    session_id: string | null;
+    user_pseudo_id: string;
+    funnel_name?: string;
+    funnel_type?: string;
+    language: string;
+    platform: string;
+    url: string;
+    device: string;
+    browser: string;
+    system: string;
+    rid: string;
+};

package/dist/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "rozmova-analytics",
-  "version": "1.0.1",
-  "description": "A collection of JavaScript functions for analytics (Google Analytics, Mixpanel, etc.).",
+  "version": "1.0.3",
+  "description": "A collection of JavaScript functions for Rozmova analytics",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "babel src --out-dir dist --extensions .ts,.tsx && npm run build:types",
-    "build:types": "tsc --emitDeclarationOnly"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/uptechteam/rozmova-analytics.git"
+    "build:types": "tsc --emitDeclarationOnly",
+    "lint": "eslint 'src/**/*.{ts,tsx}'",
+    "lint:fix": "eslint 'src/**/*.{ts,tsx}' --fix",
+    "format": "prettier --write 'src/**/*.{ts,tsx}'",
+    "prepare": "husky install"
   },
   "keywords": [
     "analytics",
@@ -19,7 +19,7 @@
     "javascript",
     "npm-package"
   ],
-  "author": "Your Name",
+  "author": "Bohdan Solokha",
   "license": "MIT",
   "files": [
     "dist"
@@ -29,6 +29,23 @@
     "@babel/core": "^7.22.0",
     "@babel/preset-env": "^7.22.0",
     "@babel/preset-typescript": "^7.26.0",
+    "@types/gtag.js": "^0.0.20",
+    "@types/js-cookie": "^3.0.6",
+    "@types/mixpanel-browser": "^2.50.2",
+    "@types/node": "^22.10.2",
+    "@typescript-eslint/eslint-plugin": "^8.18.2",
+    "@typescript-eslint/parser": "^8.18.2",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "husky": "^8.0.0",
+    "prettier": "^3.4.2",
     "typescript": "^5.7.2"
+  },
+  "dependencies": {
+    "js-cookie": "^3.0.5",
+    "mixpanel-browser": "^2.58.0",
+    "nanoid": "^5.0.9"
   }
 }