rozmova-analytics 1.0.23 → 1.0.25

package/README.md

@@ -33,60 +33,72 @@ import {
   setUser,
   trackEvent,
   setLocale,
-} from 'rozmova-analytics';
+} from "rozmova-analytics";
 
 // Initialize the library
-init('en', 'web');
+init({ locale: "en", platform: "web", isClearly: true });
 
 // Set user
-setUser('user-id-123', { email: 'user@example.com', name: 'John Doe' });
+setUser("user-id-123", { email: "user@example.com", name: "John Doe" });
 
 // Track an event
-trackEvent('button_click', { button_name: 'Sign Up' });
+trackEvent("button_click", { button_name: "Sign Up" });
 ```
 
 Or use in browser:
 
 ```javascript
-
 // Initialize the library
-window.Analytics.init('en', 'web');
+window.Analytics.init({ locale: "en", platform: "web" });
 
 // Set user
-window.Analytics.setUser('user-id-123', { email: 'user@example.com', name: 'John Doe' });
+window.Analytics.setUser("user-id-123", {
+  email: "user@example.com",
+  name: "John Doe",
+});
 
 // Track an event
-window.Analytics.trackEvent('button_click', { button_name: 'Sign Up' });
+window.Analytics.trackEvent("button_click", { button_name: "Sign Up" });
 ```
 
 ## API
 
-### `init(locale?: string, platform?: string)`
+### `init(initParams:{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
@@ -95,24 +107,25 @@ The package works on modern browsers and supports the following:
 ## Example Integration
 
 ```javascript
-import { init, trackEvent, setUser, resetUser } from 'rozmova-analytics';
+import { init, trackEvent, setUser, resetUser } from "rozmova-analytics";
 
 // Initialize analytics
-init('en', 'ios');
+init({ locale: "en", platform: "ios", isClearly: true });
 
 // Track a page view event
-trackEvent('page_view', { page: 'Home' });
+trackEvent("page_view", { page: "Home" });
 
 // Set user details
-setUser('user-456', { email: 'user456@example.com', name: 'Jane Doe' });
+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.
 
+This project is licensed under the MIT License.

package/dist/cookieConsentBanner.d.ts

@@ -0,0 +1 @@
+export declare const initCookieConsentBanner: (lng: string, isClearly: boolean) => void;

package/dist/helpers.d.ts

@@ -10,5 +10,4 @@ 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 isClearly: () => boolean;
-export declare const getLocaleFromURL: () => string;
+export declare const getLocaleFromURL: (isClearly?: boolean) => string;

package/dist/index.d.ts

@@ -4,7 +4,11 @@ declare class Analytics {
     private locale;
     private platform;
     private dataLayer;
-    init(locale?: string, platform?: string): void;
+    init({ locale, platform, isClearly, }?: {
+        locale?: string;
+        platform?: string;
+        isClearly?: boolean;
+    }): void;
     trackEvent(eventName: string, properties?: EventParams): void;
     setUser(userId: string, userParams: {
         email: string;