@deriv-com/analytics 1.5.2 → 1.5.4

package/lib/analytics.d.ts

@@ -10,7 +10,7 @@ type Options = {
 };
 export declare function createAnalyticsInstance(options?: Options): {
     initialise: ({ growthbookKey, growthbookDecryptionKey, rudderstackKey, growthbookOptions }: Options) => void;
-    setAttributes: ({ country, user_language, device_language, device_type, account_type, user_id, app_id, utm_source, utm_medium, utm_campaign, is_authorised, url, }: TCoreAttributes) => void;
+    setAttributes: ({ country, user_language, device_language, device_type, account_type, user_id, app_id, utm_source, utm_medium, utm_campaign, is_authorised, url, domain, }: TCoreAttributes) => void;
     identifyEvent: () => void;
     getFeatureState: (id: string) => string | undefined;
     getFeatureValue: <K extends string | number, V extends GrowthbookConfigs[K]>(id: K, defaultValue: V) => import("@growthbook/growthbook").WidenPrimitives<V>;
@@ -27,7 +27,7 @@ export declare function createAnalyticsInstance(options?: Options): {
 };
 export declare const Analytics: {
     initialise: ({ growthbookKey, growthbookDecryptionKey, rudderstackKey, growthbookOptions }: Options) => void;
-    setAttributes: ({ country, user_language, device_language, device_type, account_type, user_id, app_id, utm_source, utm_medium, utm_campaign, is_authorised, url, }: TCoreAttributes) => void;
+    setAttributes: ({ country, user_language, device_language, device_type, account_type, user_id, app_id, utm_source, utm_medium, utm_campaign, is_authorised, url, domain, }: TCoreAttributes) => void;
     identifyEvent: () => void;
     getFeatureState: (id: string) => string | undefined;
     getFeatureValue: <K extends string | number, V extends GrowthbookConfigs[K]>(id: K, defaultValue: V) => import("@growthbook/growthbook").WidenPrimitives<V>;

package/lib/analytics.js

@@ -30,7 +30,7 @@ function createAnalyticsInstance(options) {
         }
     };
     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, utm_source = _a.utm_source, utm_medium = _a.utm_medium, utm_campaign = _a.utm_campaign, is_authorised = _a.is_authorised, url = _a.url;
+        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, url = _a.url, domain = _a.domain;
         if (!_growthbook && !_rudderstack)
             return;
         var user_identity = user_id !== null && user_id !== void 0 ? user_id : getId();
@@ -47,9 +47,10 @@ function createAnalyticsInstance(options) {
                 utm_campaign: utm_campaign,
                 is_authorised: is_authorised,
                 url: url,
+                domain: domain,
             });
         }
-        core_data = __assign(__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 })), (url !== undefined && { url: url }));
+        core_data = __assign(__assign(__assign(__assign(__assign(__assign(__assign({}, core_data), (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 })), (url !== undefined && { url: url }));
     };
     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); };

package/lib/growthbook.d.ts

@@ -10,7 +10,7 @@ export declare class Growthbook {
     private static _instance;
     constructor(clientKey: string, decryptionKey: string, settings?: Partial<Context>);
     static getGrowthBookInstance: (clientKey: string, decryptionKey: string, growthbookOptions?: Partial<Context>) => Growthbook;
-    setAttributes: ({ id, country, user_language, device_language, device_type, utm_source, utm_medium, utm_campaign, is_authorised, url, }: TGrowthbookAttributes) => void;
+    setAttributes: ({ id, country, user_language, device_language, device_type, utm_source, utm_medium, utm_campaign, is_authorised, url, domain, utm_content, }: TGrowthbookAttributes) => void;
     getFeatureValue: <K extends string | number, V extends GrowthbookConfigs[K]>(key: K, defaultValue: V) => import("@growthbook/growthbook").WidenPrimitives<V>;
     getFeatureState: (id: string) => import("@growthbook/growthbook").FeatureResult<string | boolean | Record<string, boolean> | [] | null>;
     setUrl: (href: string) => Promise<void>;

package/lib/growthbook.js

@@ -43,8 +43,9 @@ var Growthbook = /** @class */ (function () {
         if (settings === void 0) { settings = {}; }
         var _this = this;
         this.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, utm_source = _a.utm_source, utm_medium = _a.utm_medium, utm_campaign = _a.utm_campaign, is_authorised = _a.is_authorised, url = _a.url;
-            _this.GrowthBook.setAttributes(__assign(__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 })), (url !== undefined && { url: url })));
+            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, url = _a.url, domain = _a.domain, utm_content = _a.utm_content;
+            var CURRENT_ATTRIBUTES = _this.GrowthBook.getAttributes();
+            _this.GrowthBook.setAttributes(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, CURRENT_ATTRIBUTES), { 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 })), (url !== undefined && { url: url })), (domain !== undefined && { domain: domain })), (utm_content !== undefined && { utm_content: utm_content })));
         };
         this.getFeatureValue = function (key, defaultValue) {
             return _this.GrowthBook.getFeatureValue(key, defaultValue);

package/lib/types.d.ts

@@ -9,6 +9,8 @@ export type TGrowthbookAttributes = {
     utm_campaign?: string;
     is_authorised?: boolean;
     url?: string;
+    domain?: string;
+    utm_content?: string;
 };
 export type TCoreAttributes = {
     account_type?: string;
@@ -116,46 +118,21 @@ type TradeTypesForm = {
     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' | '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_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;
+type BotForm = {
+    action?: 'open' | 'close' | 'search' | 'run_bot' | 'run_quick_strategy' | 'edit_quick_strategy' | 'select_quick_strategy_guide' | 'switch_quick_strategy_tab' | 'choose_strategy_type';
+    form_name?: 'ce_bot_form';
+    subpage_source?: 'dashboard' | 'bot_builder';
+    subpage_name?: 'tutorials' | 'bot_builder' | 'charts' | 'dashboard';
+    subform_name?: 'quick_strategy';
+    subform_source?: 'dashboard' | 'bot_builder';
+    quick_strategy_tab?: 'learn more' | 'trade parameters';
+    strategy_name?: `d'alembert` | `martingale` | `oscar's-grind` | `reverse martingale` | `reverse d'alembert` | `1-3-2-6`;
+    strategy_type?: 'custom' | 'quick_strategy';
+    search_term?: string;
+    asset?: 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' | 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';
-    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;
+    purchase_condition?: string;
+    initial_stake?: string;
 };
 type IndicatorsTypesFormAction = {
     action: 'open' | 'close' | 'add_active' | 'clean_all_active' | 'delete_active' | 'edit_active' | 'search' | 'info_open' | 'info_close';
@@ -276,10 +253,7 @@ export type TEvents = {
     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_bot_form: BotForm;
     ce_contracts_set_up_form: ContractsSetupForm;
     ce_indicators_types_form: IndicatorsTypesFormAction;
     ce_trade_types_form: TradeTypesForm;

package/package.json

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