@deriv-com/analytics 1.4.10 → 1.4.12

package/README.md

@@ -1,4 +1,4 @@
-# `@deriv/analytics`
+# `@deriv-com/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.
 
@@ -18,7 +18,7 @@ Cross-project, connected user tracking events with A/B testing features
 To install the package, run the following command:
 
 ```
-$ npm i @deriv/analytics
+$ npm i @deriv-com/analytics
 ```
 
 To proper initialisation of the package, pass proper keys in special function in special for init functions place:
@@ -49,7 +49,7 @@ And you finally can use the tracking events and A/B testing features
 To start using it, let's observe on SDK usage examples:
 
 ```js
-import { Analytics } from '@deriv/analytics';
+import { Analytics } from '@deriv-com/analytics';
 
 // Tracking features:
 Analytics?.identifyEvent() // inentify the user
@@ -66,18 +66,18 @@ Analytics?.trackEvent('ce_virtual_signup_form', {
 })
 
 // the same as example below, to not to add repetable properties again and again
-const analyticsData: Parameters<typeof Analytics.trackEvent>[1] = {
+const analytics_data: Parameters<typeof Analytics.trackEvent>[1] = {
     form_name: 'default_diel_deriv',
 }
 Analytics?.trackEvent('ce_virtual_signup_form', {
     action: 'open',
     signup_provider: 'email',
-    ...analyticsData
+    ...analytics_data
 })
 Analytics?.trackEvent('ce_virtual_signup_form', {
     action: 'close',
     signup_provider: 'google',
-    ...analyticsData
+    ...analytics_data
 })
 
 // A/B testing features

package/lib/analytics.d.ts

@@ -8,7 +8,7 @@ type Options = {
 };
 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;
+    setAttributes: ({ country, user_language, device_language, device_type, account_type, user_id, app_id, utm_source, utm_medium, utm_campaign, is_authorised, }: 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]) | (() => {
@@ -25,7 +25,7 @@ export declare function createAnalyticsInstance(options?: Options): {
     isFeatureOn: (key: string) => boolean;
     setUrl: (href: string) => void;
     getId: () => string;
-    trackEvent: <T_2 extends keyof TEvents>(event: T_2, analyticsData: TEvents[T_2]) => void;
+    trackEvent: <T_2 extends keyof TEvents>(event: T_2, analytics_data: TEvents[T_2]) => void;
     getInstances: () => {
         ab: Growthbook;
         tracking: RudderStack;
@@ -35,7 +35,7 @@ export declare function createAnalyticsInstance(options?: Options): {
 };
 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;
+    setAttributes: ({ country, user_language, device_language, device_type, account_type, user_id, app_id, utm_source, utm_medium, utm_campaign, is_authorised, }: 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]) | (() => {
@@ -52,7 +52,7 @@ export declare const Analytics: {
     isFeatureOn: (key: string) => boolean;
     setUrl: (href: string) => void;
     getId: () => string;
-    trackEvent: <T_2 extends keyof TEvents>(event: T_2, analyticsData: TEvents[T_2]) => void;
+    trackEvent: <T_2 extends keyof TEvents>(event: T_2, analytics_data: TEvents[T_2]) => void;
     getInstances: () => {
         ab: Growthbook;
         tracking: RudderStack;

package/lib/analytics.js

@@ -15,7 +15,13 @@ exports.Analytics = exports.createAnalyticsInstance = void 0;
 var growthbook_1 = require("./growthbook");
 var rudderstack_1 = require("./rudderstack");
 function createAnalyticsInstance(options) {
-    var _growthbook, _rudderstack;
+    var _growthbook, _rudderstack, core_data = {}, cta_buttons = {}, offline_cache = {};
+    var interval = setInterval(function () {
+        if (Object.keys(cta_buttons).length > 0)
+            clearInterval(interval);
+        else
+            cta_buttons = getFeatureValue('tracking-buttons-config', {});
+    }, 1000);
     var initialise = function (_a) {
         var growthbookKey = _a.growthbookKey, growthbookDecryptionKey = _a.growthbookDecryptionKey, rudderstackKey = _a.rudderstackKey;
         _rudderstack = rudderstack_1.RudderStack.getRudderStackInstance(rudderstackKey);
@@ -23,12 +29,8 @@ function createAnalyticsInstance(options) {
             _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;
+        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, utm_source = _a.utm_source, utm_medium = _a.utm_medium, utm_campaign = _a.utm_campaign, is_authorised = _a.is_authorised;
         if (!_growthbook && !_rudderstack)
             return;
         var user_identity = user_id ? user_id : getId();
@@ -40,17 +42,19 @@ function createAnalyticsInstance(options) {
                 user_language: user_language,
                 device_language: device_language,
                 device_type: device_type,
+                utm_source: utm_source,
+                utm_medium: utm_medium,
+                utm_campaign: utm_campaign,
+                is_authorised: is_authorised,
             });
         }
-        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 }));
+        core_data = __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
      *
@@ -63,8 +67,8 @@ function createAnalyticsInstance(options) {
         _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' });
+        if ((core_data === null || core_data === void 0 ? void 0 : core_data.user_identity) && _rudderstack) {
+            _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.identifyEvent(core_data === null || core_data === void 0 ? void 0 : core_data.user_identity, { language: (core_data === null || core_data === void 0 ? void 0 : core_data.user_language) || 'en' });
         }
     };
     var reset = function () {
@@ -72,10 +76,26 @@ function createAnalyticsInstance(options) {
             return;
         _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.reset();
     };
-    var trackEvent = function (event, analyticsData) {
+    var trackEvent = function (event, analytics_data) {
         if (!_rudderstack)
             return;
-        _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.track(event, __assign(__assign({}, coreData), analyticsData));
+        if (navigator.onLine) {
+            if (Object.keys(offline_cache).length > 0) {
+                Object.keys(offline_cache).map(function (cache) {
+                    _rudderstack.track(offline_cache[cache].event, offline_cache[cache].payload);
+                    delete offline_cache[cache];
+                });
+            }
+            if (event in cta_buttons) {
+                // @ts-ignore
+                cta_buttons[event] && (_rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.track(event, __assign(__assign({}, core_data), analytics_data)));
+            }
+            else
+                _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.track(event, __assign(__assign({}, core_data), analytics_data));
+        }
+        else {
+            offline_cache[event + analytics_data.action] = { event: event, payload: __assign(__assign({}, core_data), analytics_data) };
+        }
     };
     var getInstances = function () { return ({ ab: _growthbook, tracking: _rudderstack }); };
     return {

package/lib/growthbook.d.ts

@@ -5,7 +5,7 @@ export declare class Growthbook {
     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;
+    setAttributes({ id, country, user_language, device_language, device_type, utm_source, utm_medium, utm_campaign, is_authorised, }: 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;

package/lib/growthbook.js

@@ -73,8 +73,8 @@ var Growthbook = /** @class */ (function () {
         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 })));
+        var id = _a.id, country = _a.country, user_language = _a.user_language, device_language = _a.device_language, device_type = _a.device_type, utm_source = _a.utm_source, utm_medium = _a.utm_medium, utm_campaign = _a.utm_campaign, is_authorised = _a.is_authorised;
+        return this.GrowthBook.setAttributes(__assign(__assign(__assign(__assign(__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 })), (utm_source !== undefined && { utm_source: utm_source })), (utm_medium !== undefined && { utm_medium: utm_medium })), (utm_campaign !== undefined && { utm_campaign: utm_campaign })), (is_authorised !== undefined && { is_authorised: is_authorised })));
     };
     Growthbook.prototype.getFeatureState = function (id) {
         // @ts-ignore

package/lib/types.d.ts

@@ -4,6 +4,10 @@ export type TGrowthbookAttributes = {
     user_language?: string;
     device_language?: string;
     device_type?: string;
+    utm_source?: string;
+    utm_medium?: 'ppc-native' | 'affiliate' | 'common' | string;
+    utm_campaign?: string;
+    is_authorised?: boolean;
 };
 export type TCoreAttributes = {
     account_type?: string;
@@ -87,28 +91,35 @@ type TradeTypesForm = {
     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';
+    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' | 'edit_your_bot' | 'choose_your_bot' | 'delete_your_bot';
     shortcut_name?: string;
     form_source?: string;
+    form_name?: string;
     search_string?: string;
     delete_popup_respond?: string;
     bot_last_modified_time?: number;
     bot_name?: string;
+    bot_status?: string;
+    preview_mode?: 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';
+    action?: 'open' | 'close' | 'choose_strategy_type' | 'switch_strategy_mode' | 'choose_asset' | 'choose_trade_type' | 'choose_trade_type_mode' | 'choose_duration' | 'change_parameter_value' | 'info_popup_open' | 'run_strategy' | 'loss_threshold_warning_popup' | 'learn_more_expansion' | 'learn_more_collapse' | 'edit_strategy';
+    form_source?: 'ce_bot_dashboard_form' | 'ce_bot_builder_form';
+    form_name?: 'ce_bot_quick_strategy_form';
+    strategy_type?: `d'alembert` | `martingale` | `oscar's-grind` | `reverse martingale` | `reverse d'alembert` | `1-3-2-6`;
+    strategy_switcher_mode?: 'learn more' | 'trade parameters';
+    asset_type?: string;
+    trade_type?: string;
+    trade_type_mode?: string;
     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;
+    parameter_type?: 'initial-stake' | 'duration' | 'profit-threshold' | 'loss-threshold' | 'size-unit' | 'max-stake' | string;
+    parameter_field_type?: 'input' | 'dropdown' | 'slider' | 'checkbox' | 'number';
+    parameter_value?: string | number | boolean;
+    plus_minus_push?: 'yes' | 'no';
     manual_parameter_input?: 'yes' | 'no';
+    dont_show_checkbox?: 'yes' | 'no';
+    cta_name?: 'edit_the_amount' | 'yes_continue';
+    learn_more_title?: string;
 };
 type BotBuilderForm = {
     action?: 'open' | 'close' | 'search';
@@ -185,6 +196,21 @@ type ChartTypesFormAction = {
     chart_type_name?: string;
     time_interval_name?: string;
 };
+type ContractsSetupForm = {
+    form_name: string;
+    trade_type_name: string;
+} & ({
+    action: 'change_parameter_value';
+    duration_type?: string;
+    input_type?: string;
+    parameter_field_type?: string;
+    parameter_type?: string;
+    parameter_value?: string;
+} | {
+    action: 'run_contract';
+    switcher_duration_mode_name?: string;
+    switcher_stakepayout_mode_name?: string;
+});
 type TradersHubOnboardingFormAction = {
     action?: 'open' | 'close' | 'step_passed' | 'step_back' | 'choose_step_navigation';
     form_source?: 'tradershub_dashboard_form' | 'tradershub_first_entrance' | 'repeat_tour';
@@ -208,6 +234,7 @@ export type TEvents = {
     ce_bot_quick_strategy_form: BotQuickStrategyForm;
     ce_bot_builder_form: BotBuilderForm;
     ce_bot_tutorial_form: BotTutorialForm;
+    ce_contracts_set_up_form: ContractsSetupForm;
     ce_indicators_types_form: IndicatorsTypesFormAction;
     ce_trade_types_form: TradeTypesForm;
     ce_chart_types_form: ChartTypesFormAction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deriv-com/analytics",
-  "version": "1.4.10",
+  "version": "1.4.12",
   "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",