@deriv-com/analytics 1.4.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Deriv
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,98 @@
+# `@deriv/analytics`
+
+The analytics package contains all the utility functions used for tracking user events and sending them to the respective platform such as Rudderstack and GrowthBook.
+
+**In this document**
+
+-   [Analytics](#analytics)
+    -   [What is Analytics?](#what-is-analytics)
+    -   [Installation and initialisation](#installation)
+    -   [Usage](#usage)
+
+### What is Analytics?
+
+Cross-project, connected user tracking events with A/B testing features
+
+### Installation
+
+To install the package, run the following command:
+
+```
+$ npm i @deriv/analytics
+```
+
+To proper initialisation of the package, pass proper keys in special function in special for init functions place:
+
+```js
+Analytics?.initialise({
+    growthbookKey: process.env.GROWTHBOOK_CLIENT_KEY, // optional key to enable A/B tests
+    growthbookDecryptionKey: process.env.GROWTHBOOK_DECRYPTION_KEY, // optional key to enable A/B tests
+    // mandatory key to enable userevent tracking
+    rudderstackKey: RUDDERSTACK_KEY,
+})
+```
+
+To make good strategy for A/B testing we need to create some condition depends on data:
+
+```js
+Analytics?.setAttributes({
+    user_language: getLanguage(),
+    device_language: navigator?.language,
+    country: this.country,
+})
+```
+
+And you finally can use the tracking events and A/B testing features
+
+### Usage
+
+To start using it, let's observe on SDK usage examples:
+
+```js
+import { Analytics } from '@deriv/analytics';
+
+// Tracking features:
+Analytics?.identifyEvent() // inentify the user
+Analytics?.pageView() // track that page is showed for user
+const user_id = Analytics?.getId() // get an user anon or real id
+
+
+// Track Event
+Analytics?.trackEvent('ce_virtual_signup_form', {
+    action: 'open',
+    form_name: 'default_diel_deriv',
+    form_source: document?.referrer,
+    signup_provider: 'email',
+})
+
+// the same as example below, to not to add repetable properties again and again
+const analyticsData: Parameters<typeof Analytics.trackEvent>[1] = {
+    form_name: 'default_diel_deriv',
+}
+Analytics?.trackEvent('ce_virtual_signup_form', {
+    action: 'open',
+    signup_provider: 'email',
+    ...analyticsData
+})
+Analytics?.trackEvent('ce_virtual_signup_form', {
+    action: 'close',
+    signup_provider: 'google',
+    ...analyticsData
+})
+
+// A/B testing features
+const test_toggle_aa_test = Analytics?.getFeatureState('test-toggle-aa-test') // returns value of experiment
+const common_test = Analytics?.getFeatureValue('common-test', 'fallback') // returns feature flag's boolen
+```
+
+If you need to get entire instance directly:
+
+```js
+const { ab, tracking } = Analytics?.getInstances()
+```
+
+If you want to check your ID
+
+```js
+window.getMyId()
+```

package/lib/analytics.d.ts

@@ -0,0 +1,63 @@
+import { Growthbook } from './growthbook';
+import { RudderStack } from './rudderstack';
+import { TCoreAttributes, TEvents } from './types';
+type Options = {
+    growthbookKey?: string;
+    growthbookDecryptionKey?: string;
+    rudderstackKey: string;
+};
+export declare function createAnalyticsInstance(options?: Options): {
+    initialise: ({ growthbookKey, growthbookDecryptionKey, rudderstackKey }: Options) => void;
+    setAttributes: ({ country, user_language, device_language, device_type, account_type, user_id, app_id, }: TCoreAttributes) => void;
+    identifyEvent: () => void;
+    getFeatureState: (id: string) => string | undefined;
+    getFeatureValue: <T>(id: string, defaultValue?: T | undefined) => boolean | ((attributes: import("@growthbook/growthbook").Attributes) => void) | ((options?: import("@growthbook/growthbook").LoadFeaturesOptions | undefined) => Promise<void>) | ((options?: import("@growthbook/growthbook").RefreshFeaturesOptions | undefined) => Promise<void>) | (() => [string, string]) | (() => {
+        apiHost: string;
+        streamingHost: string;
+        apiRequestHeaders?: Record<string, string> | undefined;
+        streamingHostRequestHeaders?: Record<string, string> | undefined;
+    }) | (() => string) | (() => boolean) | (() => string[] | undefined) | ((features: Record<string, import("@growthbook/growthbook").FeatureDefinition<any>>) => void) | ((encryptedString: string, decryptionKey?: string | undefined, subtle?: SubtleCrypto | undefined) => Promise<void>) | ((experiments: import("@growthbook/growthbook").AutoExperiment[]) => void) | ((encryptedString: string, decryptionKey?: string | undefined, subtle?: SubtleCrypto | undefined) => Promise<void>) | ((overrides: import("@growthbook/growthbook").Attributes) => void) | ((vars: Record<string, number>) => void) | ((map: Map<string, any>) => void) | ((url: string) => void) | (() => {
+        [x: string]: any;
+    }) | (() => Record<string, number>) | (() => Map<string, any>) | (() => string) | (() => Record<string, import("@growthbook/growthbook").FeatureDefinition<any>>) | (() => import("@growthbook/growthbook").AutoExperiment[]) | ((cb: import("@growthbook/growthbook").SubscriptionFunction) => () => void) | (() => Map<string, {
+        experiment: import("@growthbook/growthbook").Experiment<any>;
+        result: import("@growthbook/growthbook").Result<any>;
+    }>) | (() => void) | ((renderer: () => void) => void) | ((key: string, variation: number) => void) | (<T_1>(experiment: import("@growthbook/growthbook").Experiment<T_1>) => import("@growthbook/growthbook").Result<T_1>) | ((key: string) => import("@growthbook/growthbook").Result<import("@growthbook/growthbook").AutoExperimentVariation> | null) | (<K extends string = string>(key: K) => boolean) | (<K_1 extends string = string>(key: K_1) => boolean) | (<V extends any, K_2 extends string = string>(key: K_2, defaultValue: V) => import("@growthbook/growthbook").WidenPrimitives<V>) | (<V_1 extends any, K_3 extends string = string>(id: K_3) => import("@growthbook/growthbook").FeatureResult<V_1 | null>) | (<V_2 extends any, K_4 extends string = string>(id: K_4) => import("@growthbook/growthbook").FeatureResult<V_2 | null>) | ((msg: string, ctx: Record<string, unknown>) => void);
+    isFeatureOn: (key: string) => boolean;
+    setUrl: (href: string) => void;
+    getId: () => string;
+    trackEvent: <T_2 extends keyof TEvents>(event: T_2, analyticsData: TEvents[T_2]) => void;
+    getInstances: () => {
+        ab: Growthbook;
+        tracking: RudderStack;
+    };
+    pageView: (current_page: string, platform?: string) => void;
+    reset: () => void;
+};
+export declare const Analytics: {
+    initialise: ({ growthbookKey, growthbookDecryptionKey, rudderstackKey }: Options) => void;
+    setAttributes: ({ country, user_language, device_language, device_type, account_type, user_id, app_id, }: TCoreAttributes) => void;
+    identifyEvent: () => void;
+    getFeatureState: (id: string) => string | undefined;
+    getFeatureValue: <T>(id: string, defaultValue?: T | undefined) => boolean | ((attributes: import("@growthbook/growthbook").Attributes) => void) | ((options?: import("@growthbook/growthbook").LoadFeaturesOptions | undefined) => Promise<void>) | ((options?: import("@growthbook/growthbook").RefreshFeaturesOptions | undefined) => Promise<void>) | (() => [string, string]) | (() => {
+        apiHost: string;
+        streamingHost: string;
+        apiRequestHeaders?: Record<string, string> | undefined;
+        streamingHostRequestHeaders?: Record<string, string> | undefined;
+    }) | (() => string) | (() => boolean) | (() => string[] | undefined) | ((features: Record<string, import("@growthbook/growthbook").FeatureDefinition<any>>) => void) | ((encryptedString: string, decryptionKey?: string | undefined, subtle?: SubtleCrypto | undefined) => Promise<void>) | ((experiments: import("@growthbook/growthbook").AutoExperiment[]) => void) | ((encryptedString: string, decryptionKey?: string | undefined, subtle?: SubtleCrypto | undefined) => Promise<void>) | ((overrides: import("@growthbook/growthbook").Attributes) => void) | ((vars: Record<string, number>) => void) | ((map: Map<string, any>) => void) | ((url: string) => void) | (() => {
+        [x: string]: any;
+    }) | (() => Record<string, number>) | (() => Map<string, any>) | (() => string) | (() => Record<string, import("@growthbook/growthbook").FeatureDefinition<any>>) | (() => import("@growthbook/growthbook").AutoExperiment[]) | ((cb: import("@growthbook/growthbook").SubscriptionFunction) => () => void) | (() => Map<string, {
+        experiment: import("@growthbook/growthbook").Experiment<any>;
+        result: import("@growthbook/growthbook").Result<any>;
+    }>) | (() => void) | ((renderer: () => void) => void) | ((key: string, variation: number) => void) | (<T_1>(experiment: import("@growthbook/growthbook").Experiment<T_1>) => import("@growthbook/growthbook").Result<T_1>) | ((key: string) => import("@growthbook/growthbook").Result<import("@growthbook/growthbook").AutoExperimentVariation> | null) | (<K extends string = string>(key: K) => boolean) | (<K_1 extends string = string>(key: K_1) => boolean) | (<V extends any, K_2 extends string = string>(key: K_2, defaultValue: V) => import("@growthbook/growthbook").WidenPrimitives<V>) | (<V_1 extends any, K_3 extends string = string>(id: K_3) => import("@growthbook/growthbook").FeatureResult<V_1 | null>) | (<V_2 extends any, K_4 extends string = string>(id: K_4) => import("@growthbook/growthbook").FeatureResult<V_2 | null>) | ((msg: string, ctx: Record<string, unknown>) => void);
+    isFeatureOn: (key: string) => boolean;
+    setUrl: (href: string) => void;
+    getId: () => string;
+    trackEvent: <T_2 extends keyof TEvents>(event: T_2, analyticsData: TEvents[T_2]) => void;
+    getInstances: () => {
+        ab: Growthbook;
+        tracking: RudderStack;
+    };
+    pageView: (current_page: string, platform?: string) => void;
+    reset: () => void;
+};
+export {};

package/lib/analytics.js

@@ -0,0 +1,97 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Analytics = exports.createAnalyticsInstance = void 0;
+var growthbook_1 = require("./growthbook");
+var rudderstack_1 = require("./rudderstack");
+function createAnalyticsInstance(options) {
+    var _growthbook, _rudderstack;
+    var initialise = function (_a) {
+        var growthbookKey = _a.growthbookKey, growthbookDecryptionKey = _a.growthbookDecryptionKey, rudderstackKey = _a.rudderstackKey;
+        _rudderstack = rudderstack_1.RudderStack.getRudderStackInstance(rudderstackKey);
+        if (growthbookKey && growthbookDecryptionKey) {
+            _growthbook = growthbook_1.Growthbook.getGrowthBookInstance(growthbookKey, growthbookDecryptionKey);
+        }
+    };
+    if (options) {
+        initialise(options);
+    }
+    var coreData = {};
+    var setAttributes = function (_a) {
+        var country = _a.country, user_language = _a.user_language, device_language = _a.device_language, device_type = _a.device_type, account_type = _a.account_type, user_id = _a.user_id, app_id = _a.app_id;
+        if (!_growthbook && !_rudderstack)
+            return;
+        var user_identity = user_id ? user_id : getId();
+        // Check if we have Growthbook instance
+        if (_growthbook) {
+            _growthbook.setAttributes({
+                id: user_identity || getId(),
+                country: country,
+                user_language: user_language,
+                device_language: device_language,
+                device_type: device_type,
+            });
+        }
+        coreData = __assign(__assign(__assign(__assign(__assign({}, (user_language !== undefined && { user_language: user_language })), (account_type !== undefined && { account_type: account_type })), (app_id !== undefined && { app_id: app_id })), (device_type !== undefined && { device_type: device_type })), (user_identity !== undefined && { user_identity: user_identity }));
+    };
+    var getFeatureState = function (id) { var _a, _b; return (_b = (_a = _growthbook === null || _growthbook === void 0 ? void 0 : _growthbook.getFeatureState(id)) === null || _a === void 0 ? void 0 : _a.experimentResult) === null || _b === void 0 ? void 0 : _b.name; };
+    var getFeatureValue = function (id, defaultValue) { return _growthbook === null || _growthbook === void 0 ? void 0 : _growthbook.getFeatureValue(id, defaultValue); };
+    var isFeatureOn = function (key) { return _growthbook === null || _growthbook === void 0 ? void 0 : _growthbook.isOn(key); };
+    var setUrl = function (href) { return _growthbook === null || _growthbook === void 0 ? void 0 : _growthbook.setUrl(href); };
+    var getId = function () { return (_rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.getUserId()) || (_rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.getAnonymousId()); };
+    // for QA testing purposes
+    window.getMyId = getId;
+    /**
+     * Pushes page view event to Rudderstack
+     *
+     * @param curret_page The name or URL of the current page to track the page view event
+     */
+    var pageView = function (current_page, platform) {
+        if (platform === void 0) { platform = 'Deriv App'; }
+        if (!_rudderstack)
+            return;
+        _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.pageView(current_page, platform, getId());
+    };
+    var identifyEvent = function () {
+        if ((coreData === null || coreData === void 0 ? void 0 : coreData.user_identity) && _rudderstack) {
+            _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.identifyEvent(coreData === null || coreData === void 0 ? void 0 : coreData.user_identity, { language: (coreData === null || coreData === void 0 ? void 0 : coreData.user_language) || 'en' });
+        }
+    };
+    var reset = function () {
+        if (!_rudderstack)
+            return;
+        _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.reset();
+    };
+    var trackEvent = function (event, analyticsData) {
+        if (!_rudderstack)
+            return;
+        _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.track(event, __assign(__assign({}, coreData), analyticsData));
+    };
+    var getInstances = function () { return ({ ab: _growthbook, tracking: _rudderstack }); };
+    return {
+        initialise: initialise,
+        setAttributes: setAttributes,
+        identifyEvent: identifyEvent,
+        getFeatureState: getFeatureState,
+        getFeatureValue: getFeatureValue,
+        isFeatureOn: isFeatureOn,
+        setUrl: setUrl,
+        getId: getId,
+        trackEvent: trackEvent,
+        getInstances: getInstances,
+        pageView: pageView,
+        reset: reset,
+    };
+}
+exports.createAnalyticsInstance = createAnalyticsInstance;
+exports.Analytics = createAnalyticsInstance();

package/lib/growthbook.d.ts

@@ -0,0 +1,34 @@
+import { GrowthBook } from '@growthbook/growthbook';
+import { TGrowthbookAttributes } from './types';
+export declare class Growthbook {
+    GrowthBook: GrowthBook<GrowthBook<Record<string, any>>>;
+    private static _instance;
+    constructor(clientKey: string, decryptionKey: string);
+    static getGrowthBookInstance(clientKey: string, decryptionKey: string): Growthbook;
+    setAttributes({ id, country, user_language, device_language, device_type }: TGrowthbookAttributes): void;
+    getFeatureState<K, V>(id: K): import("@growthbook/growthbook").FeatureResult<boolean | ((attributes: import("@growthbook/growthbook").Attributes) => void) | ((options?: import("@growthbook/growthbook").LoadFeaturesOptions | undefined) => Promise<void>) | ((options?: import("@growthbook/growthbook").RefreshFeaturesOptions | undefined) => Promise<void>) | (() => [string, string]) | (() => {
+        apiHost: string;
+        streamingHost: string;
+        apiRequestHeaders?: Record<string, string> | undefined;
+        streamingHostRequestHeaders?: Record<string, string> | undefined;
+    }) | (() => string) | (() => boolean) | (() => string[] | undefined) | ((features: Record<string, import("@growthbook/growthbook").FeatureDefinition<any>>) => void) | ((encryptedString: string, decryptionKey?: string | undefined, subtle?: SubtleCrypto | undefined) => Promise<void>) | ((experiments: import("@growthbook/growthbook").AutoExperiment[]) => void) | ((encryptedString: string, decryptionKey?: string | undefined, subtle?: SubtleCrypto | undefined) => Promise<void>) | ((overrides: import("@growthbook/growthbook").Attributes) => void) | ((vars: Record<string, number>) => void) | ((map: Map<string, any>) => void) | ((url: string) => void) | (() => {
+        [x: string]: any;
+    }) | (() => Record<string, number>) | (() => Map<string, any>) | (() => string) | (() => Record<string, import("@growthbook/growthbook").FeatureDefinition<any>>) | (() => import("@growthbook/growthbook").AutoExperiment[]) | ((cb: import("@growthbook/growthbook").SubscriptionFunction) => () => void) | (() => Map<string, {
+        experiment: import("@growthbook/growthbook").Experiment<any>;
+        result: import("@growthbook/growthbook").Result<any>;
+    }>) | (() => void) | ((renderer: () => void) => void) | ((key: string, variation: number) => void) | (<T>(experiment: import("@growthbook/growthbook").Experiment<T>) => import("@growthbook/growthbook").Result<T>) | ((key: string) => import("@growthbook/growthbook").Result<import("@growthbook/growthbook").AutoExperimentVariation> | null) | (<K_1 extends string = string>(key: K_1) => boolean) | (<K_2 extends string = string>(key: K_2) => boolean) | (<V_1 extends any, K_3 extends string = string>(key: K_3, defaultValue: V_1) => import("@growthbook/growthbook").WidenPrimitives<V_1>) | (<V_2 extends any, K_4 extends string = string>(id: K_4) => import("@growthbook/growthbook").FeatureResult<V_2 | null>) | (<V_3 extends any, K_5 extends string = string>(id: K_5) => import("@growthbook/growthbook").FeatureResult<V_3 | null>) | ((msg: string, ctx: Record<string, unknown>) => void) | null>;
+    getFeatureValue<K, V>(key: K, defaultValue?: V): boolean | ((attributes: import("@growthbook/growthbook").Attributes) => void) | ((options?: import("@growthbook/growthbook").LoadFeaturesOptions | undefined) => Promise<void>) | ((options?: import("@growthbook/growthbook").RefreshFeaturesOptions | undefined) => Promise<void>) | (() => [string, string]) | (() => {
+        apiHost: string;
+        streamingHost: string;
+        apiRequestHeaders?: Record<string, string> | undefined;
+        streamingHostRequestHeaders?: Record<string, string> | undefined;
+    }) | (() => string) | (() => boolean) | (() => string[] | undefined) | ((features: Record<string, import("@growthbook/growthbook").FeatureDefinition<any>>) => void) | ((encryptedString: string, decryptionKey?: string | undefined, subtle?: SubtleCrypto | undefined) => Promise<void>) | ((experiments: import("@growthbook/growthbook").AutoExperiment[]) => void) | ((encryptedString: string, decryptionKey?: string | undefined, subtle?: SubtleCrypto | undefined) => Promise<void>) | ((overrides: import("@growthbook/growthbook").Attributes) => void) | ((vars: Record<string, number>) => void) | ((map: Map<string, any>) => void) | ((url: string) => void) | (() => {
+        [x: string]: any;
+    }) | (() => Record<string, number>) | (() => Map<string, any>) | (() => string) | (() => Record<string, import("@growthbook/growthbook").FeatureDefinition<any>>) | (() => import("@growthbook/growthbook").AutoExperiment[]) | ((cb: import("@growthbook/growthbook").SubscriptionFunction) => () => void) | (() => Map<string, {
+        experiment: import("@growthbook/growthbook").Experiment<any>;
+        result: import("@growthbook/growthbook").Result<any>;
+    }>) | (() => void) | ((renderer: () => void) => void) | ((key: string, variation: number) => void) | (<T>(experiment: import("@growthbook/growthbook").Experiment<T>) => import("@growthbook/growthbook").Result<T>) | ((key: string) => import("@growthbook/growthbook").Result<import("@growthbook/growthbook").AutoExperimentVariation> | null) | (<K_1 extends string = string>(key: K_1) => boolean) | (<K_2 extends string = string>(key: K_2) => boolean) | (<V_1 extends any, K_3 extends string = string>(key: K_3, defaultValue: V_1) => import("@growthbook/growthbook").WidenPrimitives<V_1>) | (<V_2 extends any, K_4 extends string = string>(id: K_4) => import("@growthbook/growthbook").FeatureResult<V_2 | null>) | (<V_3 extends any, K_5 extends string = string>(id: K_5) => import("@growthbook/growthbook").FeatureResult<V_3 | null>) | ((msg: string, ctx: Record<string, unknown>) => void);
+    setUrl(href: string): void;
+    isOn(key: string): boolean;
+    init(): void;
+}

package/lib/growthbook.js

@@ -0,0 +1,99 @@
+"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 __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Growthbook = void 0;
+var growthbook_1 = require("@growthbook/growthbook");
+var RudderAnalytics = __importStar(require("rudder-sdk-js"));
+var Growthbook = /** @class */ (function () {
+    // we have to pass settings due the specific framework implementation
+    function Growthbook(clientKey, decryptionKey) {
+        this.GrowthBook = new growthbook_1.GrowthBook({
+            apiHost: 'https://cdn.growthbook.io',
+            clientKey: clientKey,
+            decryptionKey: decryptionKey,
+            subscribeToChanges: true,
+            enableDevMode: window === null || window === void 0 ? void 0 : window.location.hostname.includes('localhost'),
+            trackingCallback: function (experiment, result) {
+                if (window.dataLayer) {
+                    window.dataLayer.push({
+                        event: 'experiment_viewed',
+                        event_category: 'experiment',
+                        rudder_anonymous_id: RudderAnalytics.getAnonymousId(),
+                        experiment_id: experiment.key,
+                        variation_id: result.variationId,
+                    });
+                }
+                RudderAnalytics.track('experiment_viewed', {
+                    experimentId: experiment.key,
+                    variationId: result.variationId,
+                });
+            },
+        });
+        this.init();
+    }
+    // for make instance by singleton
+    Growthbook.getGrowthBookInstance = function (clientKey, decryptionKey) {
+        if (!Growthbook._instance) {
+            Growthbook._instance = new Growthbook(clientKey, decryptionKey);
+            return Growthbook._instance;
+        }
+        return Growthbook._instance;
+    };
+    Growthbook.prototype.setAttributes = function (_a) {
+        var id = _a.id, country = _a.country, user_language = _a.user_language, device_language = _a.device_language, device_type = _a.device_type;
+        return this.GrowthBook.setAttributes(__assign(__assign(__assign(__assign({ id: id }, (country !== undefined && { country: country })), (user_language !== undefined && { user_language: user_language })), (device_language !== undefined && { device_language: device_language })), (device_type !== undefined && { device_type: device_type })));
+    };
+    Growthbook.prototype.getFeatureState = function (id) {
+        // @ts-ignore
+        return this.GrowthBook.evalFeature(id);
+    };
+    Growthbook.prototype.getFeatureValue = function (key, defaultValue) {
+        // @ts-ignore
+        return this.GrowthBook.getFeatureValue(key, defaultValue);
+    };
+    Growthbook.prototype.setUrl = function (href) {
+        return this.GrowthBook.setURL(href);
+    };
+    Growthbook.prototype.isOn = function (key) {
+        // @ts-ignore
+        return this.GrowthBook.isOn(key);
+    };
+    Growthbook.prototype.init = function () {
+        this.GrowthBook.loadFeatures().catch(function (err) { return console.error(err); });
+    };
+    return Growthbook;
+}());
+exports.Growthbook = Growthbook;

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { Analytics } from './analytics';
+export { TEvents } from './types';

package/lib/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Analytics = void 0;
+var analytics_1 = require("./analytics");
+Object.defineProperty(exports, "Analytics", { enumerable: true, get: function () { return analytics_1.Analytics; } });

package/lib/rudderstack.d.ts

@@ -0,0 +1,49 @@
+import { TEvents } from './types';
+export declare class RudderStack {
+    has_identified: boolean;
+    has_initialized: boolean;
+    current_page: string;
+    private static _instance;
+    constructor(RUDDERSTACK_KEY: string);
+    static getRudderStackInstance(RUDDERSTACK_KEY: string): RudderStack;
+    /**
+     * @returns The anonymous ID assigned to the user before the identify event was called
+     */
+    getAnonymousId(): string;
+    /**
+     * @returns The user ID that was assigned to the user after calling identify event
+     */
+    getUserId(): string;
+    /**
+     * Initializes the Rudderstack SDK. Ensure that the appropriate environment variables are set before this is called.
+     * For local/staging environment, ensure that `RUDDERSTACK_STAGING_KEY` and `RUDDERSTACK_URL` is set.
+     * For production environment, ensure that `RUDDERSTACK_PRODUCTION_KEY` and `RUDDERSTACK_URL` is set.
+     */
+    init(RUDDERSTACK_KEY: string): 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 Rudderstack
+     *
+     * @param curret_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): void;
+    /**
+     * Pushes reset event to rudderstack
+     */
+    reset(): void;
+    /**
+     * Pushes track events to Rudderstack. When this method is called before `identifyEvent` method is called, the events tracked will be associated with an anonymous ID.
+     * Otherwise, if the events needs to be associated with a user ID, call `identifyEvent` with the user ID passed first before calling this method.
+     *
+     * @param event The event name to track
+     * @param payload Additional information related to the event
+     */
+    track<T extends keyof TEvents>(event: T, payload: TEvents[T]): void;
+}

package/lib/rudderstack.js

@@ -0,0 +1,119 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RudderStack = void 0;
+var RudderAnalytics = __importStar(require("rudder-sdk-js"));
+var RudderStack = /** @class */ (function () {
+    function RudderStack(RUDDERSTACK_KEY) {
+        var _this = this;
+        this.has_identified = false;
+        this.has_initialized = false;
+        this.current_page = '';
+        /**
+         *
+         * @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) {
+            RudderAnalytics.identify(user_id, payload);
+            _this.has_identified = true;
+        };
+        this.init(RUDDERSTACK_KEY);
+    }
+    RudderStack.getRudderStackInstance = function (RUDDERSTACK_KEY) {
+        if (!RudderStack._instance) {
+            RudderStack._instance = new RudderStack(RUDDERSTACK_KEY);
+            return RudderStack._instance;
+        }
+        return RudderStack._instance;
+    };
+    /**
+     * @returns The anonymous ID assigned to the user before the identify event was called
+     */
+    RudderStack.prototype.getAnonymousId = function () {
+        return RudderAnalytics.getAnonymousId();
+    };
+    /**
+     * @returns The user ID that was assigned to the user after calling identify event
+     */
+    RudderStack.prototype.getUserId = function () {
+        return RudderAnalytics.getUserId();
+    };
+    /**
+     * Initializes the Rudderstack SDK. Ensure that the appropriate environment variables are set before this is called.
+     * For local/staging environment, ensure that `RUDDERSTACK_STAGING_KEY` and `RUDDERSTACK_URL` is set.
+     * For production environment, ensure that `RUDDERSTACK_PRODUCTION_KEY` and `RUDDERSTACK_URL` is set.
+     */
+    RudderStack.prototype.init = function (RUDDERSTACK_KEY) {
+        var _this = this;
+        if (RUDDERSTACK_KEY) {
+            RudderAnalytics.load(RUDDERSTACK_KEY, 'https://deriv-dataplane.rudderstack.com');
+            RudderAnalytics.ready(function () {
+                _this.has_initialized = true;
+                _this.has_identified = !!(_this.getUserId() || !!_this.getAnonymousId());
+            });
+        }
+    };
+    /**
+     * Pushes page view event to Rudderstack
+     *
+     * @param curret_page The name or URL of the current page to track the page view event
+     */
+    RudderStack.prototype.pageView = function (current_page, platform, user_id) {
+        if (platform === void 0) { platform = 'Deriv App'; }
+        if (this.has_initialized && this.has_identified && current_page !== this.current_page) {
+            RudderAnalytics.page(platform, current_page, { user_id: user_id });
+            this.current_page = current_page;
+        }
+    };
+    /**
+     * Pushes reset event to rudderstack
+     */
+    RudderStack.prototype.reset = function () {
+        if (this.has_initialized) {
+            RudderAnalytics.reset();
+            this.has_identified = false;
+        }
+    };
+    /**
+     * Pushes track events to Rudderstack. When this method is called before `identifyEvent` method is called, the events tracked will be associated with an anonymous ID.
+     * Otherwise, if the events needs to be associated with a user ID, call `identifyEvent` with the user ID passed first before calling this method.
+     *
+     * @param event The event name to track
+     * @param payload Additional information related to the event
+     */
+    RudderStack.prototype.track = function (event, payload) {
+        if (this.has_initialized && this.has_identified) {
+            try {
+                RudderAnalytics.track(event, payload);
+            }
+            catch (err) {
+                console.error(err);
+            }
+        }
+    };
+    return RudderStack;
+}());
+exports.RudderStack = RudderStack;

package/lib/types.d.ts

@@ -0,0 +1,219 @@
+export type TGrowthbookAttributes = {
+    id: string;
+    country?: string;
+    user_language?: string;
+    device_language?: string;
+    device_type?: string;
+};
+export type TCoreAttributes = {
+    account_type?: string;
+    user_id?: string;
+    app_id?: string;
+    user_identity?: string;
+} & Partial<TGrowthbookAttributes>;
+type SignupProvider = 'email' | 'phone' | 'google' | 'facebook' | 'apple';
+type VirtualSignupForm = {
+    action?: 'open' | 'started' | 'email_confirmation_sent' | 'email_confirmed' | 'signup_continued' | 'country_selection_screen_opened' | 'password_screen_opened' | 'signup_done' | 'signup_flow_error' | 'go_to_login';
+    signup_provider?: SignupProvider;
+    form_source?: string;
+    form_name?: string;
+    error_message?: string;
+    email?: string;
+    app_id?: string;
+};
+type EmailVerificationForm = {
+    action?: 'verify_popup_opened' | 'verify_popup_closed' | 'verify_popup_cta' | 'email_verification_sent' | 'email_verification_opened' | 'success_popup_opened' | 'success_popup_closed' | 'success_popup_cta';
+    form_source?: 'ce_tradershub_real_form' | 'ce_virtual_signup_form' | 'account_setting';
+    form_name?: string;
+    app_id?: string;
+};
+type RealAccountSignupForm = {
+    action?: 'open' | 'step_passed' | 'save' | 'restore' | 'close' | 'real_signup_error' | 'other_error' | 'real_signup_finished';
+    step_codename?: string;
+    step_num?: number;
+    user_choice?: string;
+    form_source?: string;
+    form_name?: string;
+    real_signup_error_message?: string;
+    landing_company?: string;
+};
+type RealAccountSignupIdentifyForm = {
+    action?: 'open' | 'step_passed' | 'step_back' | 'save' | 'close' | 'real_signup_error' | 'other_error' | 'real_signup_finished';
+    step_codename?: string;
+    step_num?: string;
+    user_choice?: string;
+    form_source?: string;
+    form_name?: string;
+    real_signup_error_message?: string;
+    landing_company?: string;
+};
+type LoginForm = {
+    action: 'open' | 'login_cta' | 'go_to_forgot' | 'email_reset_password_sent' | 'email_reset_password_opened' | 'reset_password_continued' | 'reset_password_done' | 'login_flow_error' | 'go_to_signup';
+    login_provider?: 'email' | 'phone' | 'google' | 'facebook' | 'apple';
+    form_source?: 'virtual_signup_form' | 'deriv.com (log in CTA)' | 'mobile_derivGo' | string;
+    error_message?: string;
+    email?: string;
+};
+type QuestionnaireForm = {
+    action: 'open' | 'choose_answer' | 'close';
+    question_code?: string;
+    question_content?: string;
+    answer_code?: string;
+};
+type PartnerAccountSignupForm = {
+    action: 'open' | 'open_wizard' | 'step_passed' | 'step_back' | 'push_learn_more' | 'close_wizard' | 'close' | 'partners_signup_error' | 'other_error' | 'try_submit' | 'failed_popup_cta' | 'success_popup_opened' | 'success_popup_cta';
+    step_codename?: string;
+    step_num?: number;
+    user_choice?: string;
+    form_source?: string;
+    form_name?: 'ce_partner_account_signup_form';
+    partner_signup_error_message?: string;
+};
+type VirtualSignupEmailConfirmation = {
+    action?: 'received' | 'expired' | 'confirmed' | 'error';
+    signup_provider?: SignupProvider;
+    form_source?: string;
+    email_md5?: string;
+    error_message?: string;
+};
+type TradeTypesForm = {
+    action?: 'open' | 'close' | 'choose_trade_type' | 'search' | 'info_open' | 'info_switcher' | 'info_close';
+    trade_type_name?: string;
+    tab_name?: string;
+    search_string?: string;
+    info_switcher_mode?: 'description' | 'glossary';
+    form_source?: string;
+    form_name?: string;
+    subform_name?: string;
+};
+type BotDashboardForm = {
+    action?: 'open' | 'close' | 'search' | 'delete' | 'yes' | 'no' | 'search_string' | 'choose_shortcut' | 'bot_last_modified_time' | 'delete_popup_respond' | 'push_open_button' | 'push_user_guide' | 'save_your_bot' | 'choose_your_bot' | 'delete_your_bot';
+    shortcut_name?: string;
+    form_source?: string;
+    search_string?: string;
+    delete_popup_respond?: string;
+    bot_last_modified_time?: number;
+    bot_name?: string;
+};
+type BotQuickStrategyForm = {
+    action?: 'open' | 'close' | 'choose_strategy' | 'switch_strategy_mode' | 'choose_asset' | 'choose_trade_type' | 'choose_trade_type_mode' | 'choose_duration' | 'change_parameter_value' | 'info_popup_open' | 'run_strategy';
+    form_source?: 'bot_dashboard' | 'bot_builder_form';
+    strategy_type?: "d'alembert" | 'martingale' | "oscar's-grind";
+    strategy_switcher_mode?: 'trade-parameters' | 'description';
+    asset_type?: 'gbp-basket' | 'eur-basket' | 'etc';
+    trade_type?: 'rise/fall' | 'rise-equals/fall-equals' | 'etc';
+    trade_type_mode?: 'rise' | 'fall' | 'rise-equals' | 'fall-equals' | 'etc';
+    duration_type?: 'ticks' | 'seconds' | 'minutes' | 'hours' | 'days';
+    parameter_type?: 'initial-stake' | 'duration' | 'profit-threshold' | 'loss-threshold' | 'size-unit' | 'max-stake';
+    parameter_value?: string;
+    plus_push_amount?: string;
+    minus_push_amount?: string;
+    manual_parameter_input?: 'yes' | 'no';
+};
+type BotBuilderForm = {
+    action?: 'open' | 'close' | 'search';
+    form_source?: 'bot_header_form' | 'bot_dashboard_form';
+    search_string?: string;
+};
+type BotTutorialForm = {
+    action?: 'open' | 'close' | 'search';
+    form_source?: 'bot_header_form' | 'bot_dashboard_form-shortcut' | 'bot_dashboard_form-edit' | 'bot_dashboard_form-open';
+    search_string?: string;
+};
+type IndicatorsTypesFormAction = {
+    action: 'open' | 'close' | 'add_active' | 'clean_all_active' | 'delete_active' | 'edit_active' | 'search' | 'info_open' | 'info_close';
+    form_name?: string;
+    indicator_type_name?: string;
+    indicators_category_name?: string;
+    search_string?: string;
+    subform_name?: string;
+};
+type MarketTypesFormAction = {
+    action: 'open' | 'close' | 'choose_market_type' | 'search' | 'info_redirect' | 'add_to_favorites' | 'delete_from_favorites';
+    form_name?: string;
+    market_type_name?: string;
+    search_string?: string;
+    tab_market_name?: string;
+};
+type ReportsFormAction = {
+    action: 'choose_report_type';
+    form_name: string;
+    subform_name: 'open_positions_form' | 'statement_form' | 'trade_table_form';
+    trade_type_filter?: string;
+    growth_type_filter?: string;
+    start_date_filter?: string;
+    end_date_filter?: string;
+    transaction_type_filter?: string;
+} | {
+    action: 'filter_trade_type';
+    form_name: string;
+    subform_name: 'open_positions_form';
+    trade_type_filter: string;
+} | {
+    action: 'filter_growth_rate';
+    form_name: string;
+    subform_name: 'open_positions_form';
+    growth_type_filter: string;
+} | {
+    action: 'filter_dates';
+    form_name: string;
+    subform_name: 'trade_table_form' | 'statement_form';
+    start_date_filter?: string;
+    end_date_filter?: string;
+} | {
+    action: 'filter_transaction_type';
+    form_name: string;
+    subform_name: 'statement_form';
+    transaction_type_filter: string;
+} | {
+    action: 'open';
+    form_name: string;
+    subform_name: string;
+    form_source: string;
+} | {
+    action: 'close';
+    form_name: string;
+    subform_name: string;
+} | {
+    action: 'open_contract_details';
+    form_name: string;
+    form_source: string;
+};
+type ChartTypesFormAction = {
+    action?: 'open' | 'close' | 'choose_chart_type' | 'choose_time_interval';
+    form_name?: string;
+    chart_type_name?: string;
+    time_interval_name?: string;
+};
+type TradersHubOnboardingFormAction = {
+    action?: 'open' | 'close' | 'step_passed' | 'step_back' | 'choose_step_navigation';
+    form_source?: 'tradershub_dashboard_form' | 'tradershub_first_entrance' | 'repeat_tour';
+    step_num?: number;
+    step_codename?: string;
+};
+type UpgradeMT5BannerAction = {
+    action: 'open' | 'push_cta_upgrade';
+};
+export type TEvents = {
+    ce_virtual_signup_form: VirtualSignupForm;
+    ce_email_verification_form: EmailVerificationForm;
+    ce_real_account_signup_form: RealAccountSignupForm;
+    ce_real_account_signup_setup_form: RealAccountSignupForm;
+    ce_real_account_signup_identity_form: RealAccountSignupIdentifyForm;
+    ce_login_form: LoginForm;
+    ce_questionnaire_form: QuestionnaireForm;
+    ce_partner_account_signup_form: PartnerAccountSignupForm;
+    ce_virtual_signup_email_confirmation: VirtualSignupEmailConfirmation;
+    ce_bot_dashboard_form: BotDashboardForm;
+    ce_bot_quick_strategy_form: BotQuickStrategyForm;
+    ce_bot_builder_form: BotBuilderForm;
+    ce_bot_tutorial_form: BotTutorialForm;
+    ce_indicators_types_form: IndicatorsTypesFormAction;
+    ce_trade_types_form: TradeTypesForm;
+    ce_chart_types_form: ChartTypesFormAction;
+    ce_market_types_form: MarketTypesFormAction;
+    ce_reports_form: ReportsFormAction;
+    ce_tradershub_onboarding_form: TradersHubOnboardingFormAction;
+    ce_upgrade_mt5_banner: UpgradeMT5BannerAction;
+};
+export {};

package/lib/types.js

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

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@deriv-com/analytics",
+  "version": "1.4.10",
+  "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",
+    "growthbook",
+    "react"
+  ],
+  "author": "Amir Ali, Addriene, Nikita",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "test": "./node_modules/.bin/jest",
+    "build": "tsc",
+    "prepare": "npm run build && husky install",
+    "prepublishOnly": "npm test"
+  },
+  "files": [
+    "lib/**/*"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/binary-com/deriv-analytics"
+  },
+  "homepage": "https://github.com/binary-com/deriv-analytics",
+  "devDependencies": {
+    "@types/jest": "^29.5.3",
+    "@types/node": "^20.4.1",
+    "husky": "^8.0.3",
+    "jest": "^29.6.1",
+    "jest-environment-jsdom": "^29.6.1",
+    "lint-staged": "^15.0.1",
+    "prettier": "^3.0.3",
+    "ts-jest": "^29.1.1",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "@growthbook/growthbook": "^0.29.0",
+    "rudder-sdk-js": "^2.35.0"
+  },
+  "engines": {
+    "node": "18.x",
+    "npm": "9.x"
+  },
+  "license": "MIT",
+  "lint-staged": {
+    "*.{js,md,ts}": "prettier --write"
+  }
+}