rozmova-analytics 1.0.7 → 1.0.9

package/README.md

@@ -0,0 +1,104 @@
+# rozmova-analytics
+
+[![npm-version](https://img.shields.io/npm/v/rozmova-analytics.svg)](https://www.npmjs.com/package/rozmova-analytics)
+[![minified-size](https://img.shields.io/bundlephobia/minzip/rozmova-analytics@1.0.7)](https://bundlephobia.com/package/rozmova-analytics)
+
+A lightweight JavaScript analytics library designed to streamline event tracking, user identification, and common analytics parameter management. This package integrates with Mixpanel and Google Analytics to provide seamless data collection and insights.
+
+## Installation
+
+Install the package using npm:
+
+```bash
+npm install rozmova-analytics
+```
+
+Alternatively, you can include the library via jsDelivr:
+
+```bash
+<script src="https://cdn.jsdelivr.net/npm/rozmova-analytics/dist/index.js"></script>
+```
+
+## Usage
+
+Import the library in your project and initialize it:
+
+```javascript
+import {
+  generateUserId,
+  getCommonParams,
+  getUserId,
+  init,
+  resetUser,
+  setUser,
+  trackEvent,
+  setLocale,
+} from 'rozmova-analytics';
+
+// Initialize the library
+init('en', 'web');
+
+// Set user
+setUser('user-id-123', { email: 'user@example.com', name: 'John Doe' });
+
+// Track an event
+trackEvent('button_click', { button_name: 'Sign Up' });
+```
+
+## API
+
+### `init(locale?: string, platform?: string)`
+Initializes the analytics library, setting up Mixpanel and Google Analytics integrations. Optionally, set a locale and platform.
+
+### `generateUserId()`
+Generates a unique user ID, stores it in cookies and localStorage, and returns the ID.
+
+### `getUserId()`
+Retrieves the user ID from cookies, localStorage, or URL query parameters. If not found, generates a new one.
+
+### `getCommonParams()`
+Returns an object with common analytics parameters such as device, browser, referrer, and UTM parameters.
+
+### `setLocale(newLocale: string)`
+Sets the locale for analytics data.
+
+### `setUser(userId: string, userParams: { email: string; name: string })`
+Associates a user with the provided user ID and sets user properties in Mixpanel and Google Analytics.
+
+### `resetUser()`
+Resets the current user, generating a new user ID and reinitializing the library.
+
+### `trackEvent(eventName: string, properties?: EventParams)`
+Tracks an event with the specified name and optional properties.
+
+## Browser Support
+The package works on modern browsers and supports the following:
+- Chrome
+- Firefox
+- Safari
+- Edge
+
+## Example Integration
+
+```javascript
+import { init, trackEvent, setUser, resetUser } from 'rozmova-analytics';
+
+// Initialize analytics
+init('en', 'ios');
+
+// Track a page view event
+trackEvent('page_view', { page: 'Home' });
+
+// Set user details
+setUser('user-456', { email: 'user456@example.com', name: 'Jane Doe' });
+
+// Reset the user
+resetUser();
+```
+
+## Contributing
+Contributions are welcome! Please fork the repository and create a pull request with your changes.
+
+## License
+This project is licensed under the MIT License.
+

package/dist/analytics.js

@@ -1,92 +1,85 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.trackEvent = exports.setUser = exports.setPlatform = exports.setLocale = exports.resetUser = exports.init = exports.getUserId = exports.getPlatform = exports.getLocale = 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, {
+import Cookies from "js-cookie";
+import mixpanel from "mixpanel-browser";
+import { nanoid } from "nanoid";
+import { GA_SERVER_CONTAINER_URL, GOOGLE_ANALYTICS_ID, MIXPANEL_TOKEN, PARAMS_COOKIE_NAME, USER_ID_KEY, UTM_KEYS } from "./constants";
+import { detectBrowser, detectDeviceType, detectOS, getBrowserLanguage, getDomain, getGAClientId, getGASessionId, getQueryParam, getReferrer, getSearchQueryFromReferrer, isMetaBrowser, setQueryParam } from "./helpers";
+export var generateUserId = function generateUserId() {
+  var userId = nanoid();
+  var domain = getDomain();
+  Cookies.set(USER_ID_KEY, userId, {
     domain: domain
   });
-  localStorage.setItem(_constants.USER_ID_KEY, userId);
+  localStorage.setItem(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();
+export var getUserId = function getUserId() {
+  return Cookies.get(USER_ID_KEY) || localStorage.getItem(USER_ID_KEY) || getQueryParam(USER_ID_KEY) || generateUserId();
 };
 var getCurrentParams = function getCurrentParams() {
-  var paramsFromCookie = _jsCookie["default"].get(_constants.PARAMS_COOKIE_NAME);
+  var paramsFromCookie = Cookies.get(PARAMS_COOKIE_NAME);
   var prevParams = paramsFromCookie ? JSON.parse(paramsFromCookie) : {};
   var searchParams = new URLSearchParams(window.location.search);
-  var isNewSetUTM = _constants.UTM_KEYS.some(function (utmKey) {
+  var isNewSetUTM = UTM_KEYS.some(function (utmKey) {
     return searchParams.get(utmKey) && searchParams.get(utmKey) !== prevParams[utmKey];
   });
-  var currentUTMParams = isNewSetUTM ? _constants.UTM_KEYS.reduce(function (prev, curr) {
+  var currentUTMParams = isNewSetUTM ? UTM_KEYS.reduce(function (prev, curr) {
     return _objectSpread(_objectSpread({}, prev), {}, _defineProperty({}, curr, searchParams.get(curr)));
-  }, {}) : _constants.UTM_KEYS.reduce(function (prev, curr) {
+  }, {}) : 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,
+    referrer: getReferrer() || prevParams.referrer,
+    search_query: 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)()
+  Cookies.set(PARAMS_COOKIE_NAME, JSON.stringify(currentParams), {
+    domain: getDomain()
   });
   return currentParams;
 };
-var setLocale = exports.setLocale = function setLocale(newLocale) {
+export var setLocale = function setLocale(newLocale) {
   window.analyticsLocale = newLocale;
 };
-var getLocale = exports.getLocale = function getLocale() {
+export var getLocale = function getLocale() {
   return window.analyticsLocale;
 };
-var setPlatform = exports.setPlatform = function setPlatform(newPlatform) {
+export var setPlatform = function setPlatform(newPlatform) {
   window.analyticsPlatform = newPlatform;
 };
-var getPlatform = exports.getPlatform = function getPlatform() {
+export var getPlatform = function getPlatform() {
   return window.analyticsPlatform || "web";
 };
-var getCommonParams = exports.getCommonParams = function getCommonParams() {
+export var 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)(),
+    fbc: Cookies.get("_fbc"),
+    fbp: Cookies.get("_fbp"),
+    session_id: getGASessionId(),
+    user_pseudo_id: getGAClientId(),
     rid: getUserId(),
-    funnel_name: _jsCookie["default"].get("funnel_name"),
-    funnel_type: _jsCookie["default"].get("funnel_type"),
-    language: (0, _helpers.getBrowserLanguage)(),
+    funnel_name: Cookies.get("funnel_name"),
+    funnel_type: Cookies.get("funnel_type"),
+    language: getBrowserLanguage(),
     platform: getPlatform(),
     url: window.location.href,
-    device: (0, _helpers.detectDeviceType)(),
-    browser: (0, _helpers.detectBrowser)(),
-    system: (0, _helpers.detectOS)(),
+    device: detectDeviceType(),
+    browser: detectBrowser(),
+    system: detectOS(),
     locale: getLocale()
   });
 };
-var init = exports.init = function init(locale, platform) {
+export var init = function init(locale, platform) {
   var userId = getUserId();
-  if ((0, _helpers.isMetaBrowser)()) {
-    (0, _helpers.setQueryParam)(_constants.USER_ID_KEY, userId);
+  if (isMetaBrowser()) {
+    setQueryParam(USER_ID_KEY, userId);
   }
-  _mixpanelBrowser["default"].init(_constants.MIXPANEL_TOKEN, {
+  mixpanel.init(MIXPANEL_TOKEN, {
     debug: false,
     track_pageview: "url-with-path",
     persistence: "cookie"
@@ -94,18 +87,18 @@ var init = exports.init = function init(locale, platform) {
   if (locale) setLocale(locale);
   if (platform) setPlatform(platform);
   var userProperties = getCommonParams();
-  _mixpanelBrowser["default"].register(userProperties);
-  gtag("config", _constants.GOOGLE_ANALYTICS_ID, {
+  mixpanel.register(userProperties);
+  gtag("config", GOOGLE_ANALYTICS_ID, {
     user_properties: userProperties,
-    server_container_url: _constants.GA_SERVER_CONTAINER_URL
+    server_container_url: GA_SERVER_CONTAINER_URL
   });
 };
-var trackEvent = exports.trackEvent = function trackEvent(eventName) {
+export var trackEvent = function trackEvent(eventName) {
   var properties = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   var commonParams = getCommonParams();
   var params = _objectSpread(_objectSpread({}, commonParams), properties);
   try {
-    _mixpanelBrowser["default"].track(eventName, params);
+    mixpanel.track(eventName, params);
   } catch (e) {
     console.log(e);
   }
@@ -115,22 +108,22 @@ var trackEvent = exports.trackEvent = function trackEvent(eventName) {
     console.log(e);
   }
 };
-var setUser = exports.setUser = function setUser(userId, userParams) {
+export var setUser = function setUser(userId, userParams) {
   var email = userParams.email,
     name = userParams.name;
-  _mixpanelBrowser["default"].identify(userId);
-  _mixpanelBrowser["default"].people.set({
+  mixpanel.identify(userId);
+  mixpanel.people.set({
     $email: email,
     name: name
   });
-  gtag("config", _constants.GOOGLE_ANALYTICS_ID, {
+  gtag("config", GOOGLE_ANALYTICS_ID, {
     user_properties: getCommonParams(),
     user_id: userId,
-    server_container_url: _constants.GA_SERVER_CONTAINER_URL
+    server_container_url: GA_SERVER_CONTAINER_URL
   });
 };
-var resetUser = exports.resetUser = function resetUser() {
-  _mixpanelBrowser["default"].reset();
+export var resetUser = function resetUser() {
+  mixpanel.reset();
   generateUserId();
   init();
 };