rozmova-analytics 1.0.6 → 1.0.8

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.d.ts

@@ -1,8 +1,12 @@
 import { AnalyticsCommonParams, EventParams } from "./types";
 export declare const generateUserId: () => string;
 export declare const getUserId: () => string;
+export declare const setLocale: (newLocale: string) => void;
+export declare const getLocale: () => string;
+export declare const setPlatform: (newPlatform: string) => void;
+export declare const getPlatform: () => string;
 export declare const getCommonParams: () => AnalyticsCommonParams;
-export declare const init: (additionalParams?: EventParams) => void;
+export declare const init: (locale?: string, platform?: string) => void;
 export declare const trackEvent: (eventName: string, properties?: EventParams) => void;
 export declare const setUser: (userId: string, userParams: {
     email: string;

package/dist/analytics.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.trackEvent = exports.setUser = exports.resetUser = exports.init = exports.getUserId = exports.getCommonParams = exports.generateUserId = void 0;
+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");
@@ -50,6 +50,18 @@ var getCurrentParams = function getCurrentParams() {
   });
   return currentParams;
 };
+var setLocale = exports.setLocale = function setLocale(newLocale) {
+  window.analyticsLocale = newLocale;
+};
+var getLocale = exports.getLocale = function getLocale() {
+  return window.analyticsLocale;
+};
+var setPlatform = exports.setPlatform = function setPlatform(newPlatform) {
+  window.analyticsPlatform = newPlatform;
+};
+var getPlatform = exports.getPlatform = function getPlatform() {
+  return window.analyticsPlatform || "web";
+};
 var getCommonParams = exports.getCommonParams = function getCommonParams() {
   var persistedParams = getCurrentParams();
   return _objectSpread(_objectSpread({}, persistedParams), {}, {
@@ -61,55 +73,55 @@ var getCommonParams = exports.getCommonParams = function getCommonParams() {
     funnel_name: _jsCookie["default"].get("funnel_name"),
     funnel_type: _jsCookie["default"].get("funnel_type"),
     language: (0, _helpers.getBrowserLanguage)(),
-    platform: "web",
+    platform: getPlatform(),
     url: window.location.href,
     device: (0, _helpers.detectDeviceType)(),
     browser: (0, _helpers.detectBrowser)(),
-    system: (0, _helpers.detectOS)()
+    system: (0, _helpers.detectOS)(),
+    locale: getLocale()
   });
 };
-var init = exports.init = function init() {
-  var additionalParams = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+var init = exports.init = function init(locale, platform) {
   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
-    });
+  _mixpanelBrowser["default"].init(_constants.MIXPANEL_TOKEN, {
+    debug: false,
+    track_pageview: "url-with-path",
+    persistence: "cookie"
+  });
+  if (locale) setLocale(locale);
+  if (platform) setPlatform(platform);
+  var userProperties = getCommonParams();
+  _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);
-    }
-  });
+  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);
+  }
 };
 var setUser = exports.setUser = function setUser(userId, userParams) {
+  var email = userParams.email,
+    name = userParams.name;
   _mixpanelBrowser["default"].identify(userId);
   _mixpanelBrowser["default"].people.set({
-    $email: userParams.email,
-    name: userParams.name
+    $email: email,
+    name: name
   });
   gtag("config", _constants.GOOGLE_ANALYTICS_ID, {
     user_properties: getCommonParams(),