@deriv-com/analytics 1.32.6 → 1.33.0

package/lib/analytics.d.ts

@@ -1,5 +1,6 @@
 import { Growthbook, GrowthbookConfigs } from './growthbook';
 import { RudderStack } from './rudderstack';
+import { PostHogAnalytics } from './posthog';
 import { TCoreAttributes, TGrowthbookOptions, TAllEvents } from './types';
 declare global {
     interface Window {
@@ -10,11 +11,13 @@ type Options = {
     growthbookKey?: string;
     growthbookDecryptionKey?: string;
     rudderstackKey: string;
+    posthogKey?: string;
+    posthogHost?: string;
     growthbookOptions?: TGrowthbookOptions;
     disableRudderstackAMD?: boolean;
 };
 export declare function createAnalyticsInstance(options?: Options): {
-    initialise: ({ growthbookKey, growthbookDecryptionKey, rudderstackKey, growthbookOptions, disableRudderstackAMD, }: Options) => Promise<void>;
+    initialise: ({ growthbookKey, growthbookDecryptionKey, rudderstackKey, posthogKey, posthogHost, growthbookOptions, disableRudderstackAMD, }: Options) => Promise<void>;
     setAttributes: ({ country, user_language, device_language, device_type, account_type, user_id, anonymous_id, app_id, utm_source, utm_medium, utm_campaign, is_authorised, residence_country, url, domain, geo_location, loggedIn, network_downlink, network_rtt, network_type, account_currency, account_mode, }: TCoreAttributes) => void;
     identifyEvent: (user_id?: string) => void;
     getFeatureState: (id: string) => string | undefined;
@@ -30,12 +33,13 @@ export declare function createAnalyticsInstance(options?: Options): {
     getInstances: () => {
         ab: Growthbook;
         tracking: RudderStack;
+        posthog: PostHogAnalytics;
     };
     pageView: (current_page: string, platform?: string, properties?: {}) => void;
     reset: () => void;
 };
 export declare const Analytics: {
-    initialise: ({ growthbookKey, growthbookDecryptionKey, rudderstackKey, growthbookOptions, disableRudderstackAMD, }: Options) => Promise<void>;
+    initialise: ({ growthbookKey, growthbookDecryptionKey, rudderstackKey, posthogKey, posthogHost, growthbookOptions, disableRudderstackAMD, }: Options) => Promise<void>;
     setAttributes: ({ country, user_language, device_language, device_type, account_type, user_id, anonymous_id, app_id, utm_source, utm_medium, utm_campaign, is_authorised, residence_country, url, domain, geo_location, loggedIn, network_downlink, network_rtt, network_type, account_currency, account_mode, }: TCoreAttributes) => void;
     identifyEvent: (user_id?: string) => void;
     getFeatureState: (id: string) => string | undefined;
@@ -51,6 +55,7 @@ export declare const Analytics: {
     getInstances: () => {
         ab: Growthbook;
         tracking: RudderStack;
+        posthog: PostHogAnalytics;
     };
     pageView: (current_page: string, platform?: string, properties?: {}) => void;
     reset: () => void;

package/lib/analytics.js

@@ -53,11 +53,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Analytics = exports.createAnalyticsInstance = void 0;
 var growthbook_1 = require("./growthbook");
 var rudderstack_1 = require("./rudderstack");
+var posthog_1 = require("./posthog");
 var js_cookie_1 = __importDefault(require("js-cookie"));
 var utils_1 = require("@deriv-com/utils");
 function createAnalyticsInstance(options) {
     var _this = this;
-    var _growthbook, _rudderstack, core_data = {}, tracking_config = {}, event_cache = [], _pending_identify_calls = [];
+    var _growthbook, _rudderstack, _posthog, core_data = {}, tracking_config = {}, event_cache = [], _pending_identify_calls = [];
     var getClientCountry = function () { return __awaiter(_this, void 0, void 0, function () {
         var countryFromCloudflare, countryFromCookie, websiteStatus, countryFromWebsiteStatus;
         var _a;
@@ -82,7 +83,7 @@ function createAnalyticsInstance(options) {
         });
     }); };
     var initialise = function (_a) {
-        var growthbookKey = _a.growthbookKey, growthbookDecryptionKey = _a.growthbookDecryptionKey, rudderstackKey = _a.rudderstackKey, growthbookOptions = _a.growthbookOptions, _b = _a.disableRudderstackAMD, disableRudderstackAMD = _b === void 0 ? false : _b;
+        var growthbookKey = _a.growthbookKey, growthbookDecryptionKey = _a.growthbookDecryptionKey, rudderstackKey = _a.rudderstackKey, posthogKey = _a.posthogKey, posthogHost = _a.posthogHost, growthbookOptions = _a.growthbookOptions, _b = _a.disableRudderstackAMD, disableRudderstackAMD = _b === void 0 ? false : _b;
         return __awaiter(_this, void 0, void 0, function () {
             var country, _c, interval_1, error_1;
             var _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z;
@@ -99,16 +100,35 @@ function createAnalyticsInstance(options) {
                         _2.label = 2;
                     case 2:
                         country = _c;
+                        // Initialize RudderStack
                         _rudderstack = rudderstack_1.RudderStack.getRudderStackInstance(rudderstackKey, disableRudderstackAMD, function () {
                             _pending_identify_calls.forEach(function (userId) {
                                 if (userId) {
                                     _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.identifyEvent(userId, {
                                         language: (core_data === null || core_data === void 0 ? void 0 : core_data.user_language) || 'en',
                                     });
+                                    // Also identify in PostHog if initialized
+                                    if (_posthog === null || _posthog === void 0 ? void 0 : _posthog.has_initialized) {
+                                        _posthog === null || _posthog === void 0 ? void 0 : _posthog.identifyEvent(userId, {
+                                            language: (core_data === null || core_data === void 0 ? void 0 : core_data.user_language) || 'en',
+                                        });
+                                    }
                                 }
                             });
                             _pending_identify_calls = [];
                         });
+                        // Initialize PostHog only if key is provided
+                        if (posthogKey) {
+                            _posthog = posthog_1.PostHogAnalytics.getPostHogInstance(posthogKey, posthogHost || 'https://ph.deriv.com', disableRudderstackAMD, function () {
+                                _pending_identify_calls.forEach(function (userId) {
+                                    if (userId) {
+                                        _posthog === null || _posthog === void 0 ? void 0 : _posthog.identifyEvent(userId, {
+                                            language: (core_data === null || core_data === void 0 ? void 0 : core_data.user_language) || 'en',
+                                        });
+                                    }
+                                });
+                            });
+                        }
                         if ((growthbookOptions === null || growthbookOptions === void 0 ? void 0 : growthbookOptions.attributes) && Object.keys(growthbookOptions.attributes).length > 0)
                             core_data = __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, core_data), { country: country }), (((_e = growthbookOptions === null || growthbookOptions === void 0 ? void 0 : growthbookOptions.attributes) === null || _e === void 0 ? void 0 : _e.user_language) && {
                                 user_language: growthbookOptions === null || growthbookOptions === void 0 ? void 0 : growthbookOptions.attributes.user_language,
@@ -192,23 +212,35 @@ function createAnalyticsInstance(options) {
         return userId && !isUUID(userId) ? userId : '';
     };
     /**
-     * Pushes page view event to Rudderstack
+     * Pushes page view event to RudderStack and PostHog
      *
-     * @param curret_page The name or URL of the current page to track the page view event
+     * @param current_page The name or URL of the current page to track the page view event
      */
     var pageView = function (current_page, platform, properties) {
         if (platform === void 0) { platform = 'Deriv App'; }
         if (!_rudderstack)
             return;
         var userId = getId();
+        // Send to RudderStack
         _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.pageView(current_page, platform, userId, properties);
+        // Send to PostHog (if initialized)
+        _posthog === null || _posthog === void 0 ? void 0 : _posthog.pageView(current_page, platform, userId, properties);
     };
     var identifyEvent = function (user_id) {
         var stored_user_id = user_id || getId();
-        if ((_rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.has_initialized) && stored_user_id) {
-            _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.identifyEvent(stored_user_id, {
-                language: (core_data === null || core_data === void 0 ? void 0 : core_data.user_language) || 'en',
-            });
+        if (((_rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.has_initialized) || (_posthog === null || _posthog === void 0 ? void 0 : _posthog.has_initialized)) && stored_user_id) {
+            // Identify in RudderStack
+            if (_rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.has_initialized) {
+                _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.identifyEvent(stored_user_id, {
+                    language: (core_data === null || core_data === void 0 ? void 0 : core_data.user_language) || 'en',
+                });
+            }
+            // Identify in PostHog (if initialized)
+            if (_posthog === null || _posthog === void 0 ? void 0 : _posthog.has_initialized) {
+                _posthog === null || _posthog === void 0 ? void 0 : _posthog.identifyEvent(stored_user_id, {
+                    language: (core_data === null || core_data === void 0 ? void 0 : core_data.user_language) || 'en',
+                });
+            }
             return;
         }
         if (stored_user_id) {
@@ -216,9 +248,12 @@ function createAnalyticsInstance(options) {
         }
     };
     var reset = function () {
-        if (!_rudderstack)
+        if (!_rudderstack && !_posthog)
             return;
+        // Reset RudderStack
         _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.reset();
+        // Reset PostHog (if initialized)
+        _posthog === null || _posthog === void 0 ? void 0 : _posthog.reset();
     };
     var isV2Payload = function (payload) {
         return 'event_metadata' in payload || 'cta_information' in payload || 'error' in payload;
@@ -235,25 +270,33 @@ function createAnalyticsInstance(options) {
             // --- V1 LOGIC: Flatten Core Data (Backward Compatible) ---
             final_payload = __assign(__assign(__assign({}, core_data), analytics_data), (userId && { user_id: userId }));
         }
-        if (navigator.onLine && _rudderstack) {
+        if (navigator.onLine && (_rudderstack || _posthog)) {
             if (event_cache.length > 0) {
                 event_cache.forEach(function (cache, index) {
-                    _rudderstack.track(cache.event, cache.payload);
+                    // Send cached events to both providers
+                    _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.track(cache.event, cache.payload);
+                    _posthog === null || _posthog === void 0 ? void 0 : _posthog.track(cache.event, cache.payload);
                     delete event_cache[index];
                 });
             }
             if (event in tracking_config) {
-                tracking_config[event] && (_rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.track(event, final_payload));
+                if (tracking_config[event]) {
+                    // Send to both RudderStack and PostHog
+                    _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.track(event, final_payload);
+                    _posthog === null || _posthog === void 0 ? void 0 : _posthog.track(event, final_payload);
+                }
             }
             else {
+                // Send to both RudderStack and PostHog
                 _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.track(event, final_payload);
+                _posthog === null || _posthog === void 0 ? void 0 : _posthog.track(event, final_payload);
             }
         }
         else {
             event_cache.push({ event: event, payload: final_payload });
         }
     };
-    var getInstances = function () { return ({ ab: _growthbook, tracking: _rudderstack }); };
+    var getInstances = function () { return ({ ab: _growthbook, tracking: _rudderstack, posthog: _posthog }); };
     var AnalyticsInstance = {
         initialise: initialise,
         setAttributes: setAttributes,

package/lib/posthog.d.ts

@@ -0,0 +1,53 @@
+import { TCoreAttributes, TAllEvents } from './types';
+export declare class PostHogAnalytics {
+    has_identified: boolean;
+    has_initialized: boolean;
+    current_page: string;
+    rudderstack_anonymous_cookie_key: string;
+    private static _instance;
+    private onLoadedCallback?;
+    constructor(POSTHOG_KEY: string, POSTHOG_HOST?: string, disableAMD?: boolean, onLoaded?: () => void);
+    static getPostHogInstance: (POSTHOG_KEY: string, POSTHOG_HOST?: string, disableAMD?: boolean, onLoaded?: () => void) => PostHogAnalytics;
+    getAnonymousId: () => string | undefined;
+    setCookieIfNotExists: () => void;
+    /**
+     * @returns The user ID that was assigned to the user after calling identify event
+     */
+    getUserId: () => string;
+    /** For caching mechanism, PostHog SDK, first page load */
+    handleCachedEvents: () => void;
+    /**
+     * Initializes the PostHog SDK using proxy endpoint.
+     * For local/staging environment, ensure that `POSTHOG_STAGING_KEY` is set.
+     * For production environment, ensure that `POSTHOG_PRODUCTION_KEY` is set.
+     *
+     * Proxy Setup:
+     * - Using https://ph.deriv.com as proxy endpoint (same for staging and production)
+     * - Proxy forwards requests to PostHog Cloud
+     * - X-headers are configured on the proxy server (not client-side)
+     * - See: https://posthog.com/docs/advanced/proxy
+     */
+    init: (POSTHOG_KEY: string, POSTHOG_HOST?: string, disableAMD?: boolean) => void;
+    /**
+     *
+     * @param user_id The user ID of the user to identify and associate all events with that particular user ID
+     * @param payload Additional information passed to identify the user
+     */
+    identifyEvent: (user_id: string, payload: {
+        language: string;
+    }) => void;
+    /**
+     * Pushes page view event to PostHog
+     *
+     * @param current_page The name or URL of the current page to track the page view event
+     */
+    pageView: (current_page: string, platform: string | undefined, user_id: string, properties?: {}) => void;
+    /**
+     * Pushes reset event to PostHog
+     */
+    reset: () => void;
+    /**
+     * Pushes track events to PostHog.
+     */
+    track: <T extends keyof import("./types").TEvents | "ce_get_start_page">(event: T, payload: TAllEvents[T] & Partial<TCoreAttributes>) => void;
+}

package/lib/posthog.js

@@ -0,0 +1,206 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostHogAnalytics = void 0;
+var posthog_js_1 = __importDefault(require("posthog-js"));
+var uuid_1 = require("uuid");
+var js_cookie_1 = __importDefault(require("js-cookie"));
+var PostHogAnalytics = /** @class */ (function () {
+    function PostHogAnalytics(POSTHOG_KEY, POSTHOG_HOST, disableAMD, onLoaded) {
+        if (disableAMD === void 0) { disableAMD = false; }
+        var _this = this;
+        this.has_identified = false;
+        this.has_initialized = false;
+        this.current_page = '';
+        // Share the same anonymous ID cookie with RudderStack
+        this.rudderstack_anonymous_cookie_key = 'rudder_anonymous_id';
+        this.getAnonymousId = function () {
+            var _a;
+            return (_a = document.cookie.match('(^|;)\\s*' + _this.rudderstack_anonymous_cookie_key + '\\s*=\\s*([^;]+)')) === null || _a === void 0 ? void 0 : _a.pop();
+        };
+        this.setCookieIfNotExists = function () {
+            var anonymous_id = _this.getAnonymousId();
+            if (!anonymous_id) {
+                var hostname_1 = window.location.hostname;
+                // List of external domains where we should use the full hostname
+                var external_domains = ['webflow.io'];
+                // Check if the hostname ends with any of the external domains
+                var is_external_domain = external_domains.some(function (domain) { return hostname_1.endsWith(domain); });
+                // If it's an external domain, use the full hostname, otherwise use the last two parts
+                var domain_name = is_external_domain ? hostname_1 : hostname_1.split('.').slice(-2).join('.');
+                // Set cookie to expire in 2 years
+                document.cookie = "".concat(_this.rudderstack_anonymous_cookie_key, "=").concat((0, uuid_1.v6)(), "; path=/; Domain=").concat(domain_name, "; max-age=").concat(2 * 365 * 24 * 60 * 60);
+            }
+        };
+        /**
+         * @returns The user ID that was assigned to the user after calling identify event
+         */
+        this.getUserId = function () { return posthog_js_1.default.get_distinct_id(); };
+        /** For caching mechanism, PostHog SDK, first page load */
+        this.handleCachedEvents = function () {
+            var allowedDomains = ['deriv.com', 'deriv.team', 'deriv.ae'];
+            var domain = allowedDomains.some(function (d) { return window.location.hostname.includes(d); })
+                ? ".".concat(allowedDomains.find(function (d) { return window.location.hostname.includes(d); }))
+                : ".".concat(allowedDomains[0]);
+            var storedEventsString = js_cookie_1.default.get('cached_analytics_events');
+            var storedPagesString = js_cookie_1.default.get('cached_analytics_page_views');
+            try {
+                // Handle cached analytics events
+                if (storedEventsString) {
+                    var storedEvents = JSON.parse(storedEventsString);
+                    if (Array.isArray(storedEvents) && storedEvents.length > 0) {
+                        storedEvents.forEach(function (event) {
+                            posthog_js_1.default.capture(event.name, event.properties);
+                        });
+                        // Clear the stored events cookie
+                        js_cookie_1.default.remove('cached_analytics_events', { domain: domain });
+                    }
+                }
+                // Handle cached page views
+                if (storedPagesString) {
+                    var storedPages = JSON.parse(storedPagesString);
+                    if (Array.isArray(storedPages) && storedPages.length > 0) {
+                        storedPages.forEach(function (page) {
+                            posthog_js_1.default.capture('$pageview', __assign({ $current_url: window.location.href, page_name: page === null || page === void 0 ? void 0 : page.name }, page === null || page === void 0 ? void 0 : page.properties));
+                        });
+                        // Clear the stored page views cookie
+                        js_cookie_1.default.remove('cached_analytics_page_views', { domain: domain });
+                    }
+                }
+            }
+            catch (error) {
+                // eslint-disable-next-line no-console
+                console.log(error);
+            }
+        };
+        /**
+         * Initializes the PostHog SDK using proxy endpoint.
+         * For local/staging environment, ensure that `POSTHOG_STAGING_KEY` is set.
+         * For production environment, ensure that `POSTHOG_PRODUCTION_KEY` is set.
+         *
+         * Proxy Setup:
+         * - Using https://ph.deriv.com as proxy endpoint (same for staging and production)
+         * - Proxy forwards requests to PostHog Cloud
+         * - X-headers are configured on the proxy server (not client-side)
+         * - See: https://posthog.com/docs/advanced/proxy
+         */
+        this.init = function (POSTHOG_KEY, POSTHOG_HOST, disableAMD) {
+            if (disableAMD === void 0) { disableAMD = false; }
+            if (POSTHOG_KEY) {
+                var _define_1;
+                if (disableAMD) {
+                    _define_1 = window.define;
+                    window.define = undefined;
+                }
+                _this.setCookieIfNotExists();
+                // Get the shared anonymous ID from cookie
+                var anonymous_id_1 = _this.getAnonymousId();
+                posthog_js_1.default.init(POSTHOG_KEY, {
+                    // Use proxy endpoint for both staging and production
+                    // Default to https://ph.deriv.com, can be overridden via POSTHOG_HOST parameter
+                    api_host: POSTHOG_HOST || 'https://ph.deriv.com',
+                    // UI host should point to PostHog Cloud for dashboard links
+                    ui_host: 'https://us.posthog.com',
+                    // Use the same anonymous ID as RudderStack
+                    bootstrap: {
+                        distinctID: anonymous_id_1,
+                    },
+                    // Disable automatic pageview capture since we'll handle it manually
+                    capture_pageview: false,
+                    // Disable automatic pageleave capture
+                    capture_pageleave: false,
+                    autocapture: true,
+                    loaded: function (ph) {
+                        var _a;
+                        if (disableAMD) {
+                            window.define = _define_1;
+                        }
+                        _this.has_initialized = true;
+                        // Check if user is already identified
+                        _this.has_identified = posthog_js_1.default.get_distinct_id() !== anonymous_id_1;
+                        _this.handleCachedEvents();
+                        (_a = _this.onLoadedCallback) === null || _a === void 0 ? void 0 : _a.call(_this);
+                    },
+                });
+            }
+        };
+        /**
+         *
+         * @param user_id The user ID of the user to identify and associate all events with that particular user ID
+         * @param payload Additional information passed to identify the user
+         */
+        this.identifyEvent = function (user_id, payload) {
+            var currentUserId = _this.getUserId();
+            var anonymousId = _this.getAnonymousId();
+            // Only identify if not already identified or if it's still using anonymous ID
+            if (!currentUserId || currentUserId === anonymousId) {
+                posthog_js_1.default.identify(user_id, payload);
+            }
+            _this.has_identified = true;
+        };
+        /**
+         * Pushes page view event to PostHog
+         *
+         * @param current_page The name or URL of the current page to track the page view event
+         */
+        this.pageView = function (current_page, platform, user_id, properties) {
+            if (platform === void 0) { platform = 'Deriv App'; }
+            if (_this.has_initialized && current_page !== _this.current_page) {
+                var pageProperties = user_id ? __assign({ user_id: user_id, platform: platform }, properties) : __assign({ platform: platform }, properties);
+                posthog_js_1.default.capture('$pageview', __assign({ $current_url: window.location.href, page_name: current_page }, pageProperties));
+                _this.current_page = current_page;
+            }
+        };
+        /**
+         * Pushes reset event to PostHog
+         */
+        this.reset = function () {
+            if (_this.has_initialized) {
+                posthog_js_1.default.reset();
+                _this.has_identified = false;
+            }
+        };
+        /**
+         * Pushes track events to PostHog.
+         */
+        this.track = function (event, payload) {
+            var clean_payload = Object.fromEntries(Object.entries(payload).filter(function (_a) {
+                var _ = _a[0], value = _a[1];
+                return value !== undefined;
+            }));
+            if (_this.has_initialized) {
+                try {
+                    posthog_js_1.default.capture(event, clean_payload);
+                }
+                catch (err) {
+                    console.error(err);
+                }
+            }
+        };
+        this.onLoadedCallback = onLoaded;
+        this.init(POSTHOG_KEY, POSTHOG_HOST, disableAMD);
+    }
+    PostHogAnalytics.getPostHogInstance = function (POSTHOG_KEY, POSTHOG_HOST, disableAMD, onLoaded) {
+        if (disableAMD === void 0) { disableAMD = false; }
+        if (!PostHogAnalytics._instance) {
+            PostHogAnalytics._instance = new PostHogAnalytics(POSTHOG_KEY, POSTHOG_HOST, disableAMD, onLoaded);
+            return PostHogAnalytics._instance;
+        }
+        return PostHogAnalytics._instance;
+    };
+    return PostHogAnalytics;
+}());
+exports.PostHogAnalytics = PostHogAnalytics;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deriv-com/analytics",
-  "version": "1.32.6",
+  "version": "1.33.0",
   "description": "The analytics package contains all the utility functions used for tracking user events and sending them to the respective platform such as Rudderstack.",
   "keywords": [
     "rudderstack",
@@ -56,6 +56,7 @@
     "@growthbook/growthbook": "^1.1.0",
     "@rudderstack/analytics-js": "^3.5.1",
     "js-cookie": "^3.0.5",
+    "posthog-js": "^1.313.0",
     "uuid": "^10.0.0"
   },
   "engines": {