@deriv-com/analytics 1.31.8 → 1.32.0

package/lib/analytics.d.ts

@@ -1,6 +1,6 @@
 import { Growthbook, GrowthbookConfigs } from './growthbook';
 import { RudderStack } from './rudderstack';
-import { TCoreAttributes, TEvents, TGrowthbookOptions } from './types';
+import { TCoreAttributes, TGrowthbookOptions, TAllEvents } from './types';
 declare global {
     interface Window {
         AnalyticsInstance: ReturnType<typeof createAnalyticsInstance>;
@@ -26,7 +26,7 @@ export declare function createAnalyticsInstance(options?: Options): {
     isFeatureOn: (key: string) => boolean;
     setUrl: (href: string) => Promise<void>;
     getId: () => string;
-    trackEvent: <T extends keyof TEvents>(event: T, analytics_data: TEvents[T]) => void;
+    trackEvent: <T extends keyof import("./types").TEvents | "ce_get_start_page">(event: T, analytics_data: TAllEvents[T]) => void;
     getInstances: () => {
         ab: Growthbook;
         tracking: RudderStack;
@@ -47,7 +47,7 @@ export declare const Analytics: {
     isFeatureOn: (key: string) => boolean;
     setUrl: (href: string) => Promise<void>;
     getId: () => string;
-    trackEvent: <T extends keyof TEvents>(event: T, analytics_data: TEvents[T]) => void;
+    trackEvent: <T extends keyof import("./types").TEvents | "ce_get_start_page">(event: T, analytics_data: TAllEvents[T]) => void;
     getInstances: () => {
         ab: Growthbook;
         tracking: RudderStack;

package/lib/analytics.js

@@ -220,7 +220,22 @@ function createAnalyticsInstance(options) {
             return;
         _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.reset();
     };
+    // Runtime guard for V2 Events
+    var isV2Payload = function (payload) {
+        return 'event_metadata' in payload || 'cta_information' in payload || 'error' in payload;
+    };
     var trackEvent = function (event, analytics_data) {
+        var userId = getId();
+        var final_payload = {};
+        if (isV2Payload(analytics_data)) {
+            // --- V2 LOGIC: Nest Core Data ---
+            var v2_data = analytics_data;
+            final_payload = __assign(__assign({}, v2_data), { event_metadata: __assign(__assign(__assign({}, core_data), (userId && { user_id: userId })), v2_data.event_metadata) });
+        }
+        else {
+            // --- 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 (event_cache.length > 0) {
                 event_cache.forEach(function (cache, index) {
@@ -228,19 +243,15 @@ function createAnalyticsInstance(options) {
                     delete event_cache[index];
                 });
             }
-            var userId = getId();
-            var payload = __assign(__assign(__assign({}, core_data), analytics_data), (userId && { user_id: userId }));
             if (event in tracking_config) {
-                tracking_config[event] && (_rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.track(event, payload));
+                tracking_config[event] && (_rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.track(event, final_payload));
             }
             else {
-                _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.track(event, payload);
+                _rudderstack === null || _rudderstack === void 0 ? void 0 : _rudderstack.track(event, final_payload);
             }
         }
         else {
-            var userId = getId();
-            var payload = __assign(__assign(__assign({}, core_data), analytics_data), (userId && { user_id: userId }));
-            event_cache.push({ event: event, payload: payload });
+            event_cache.push({ event: event, payload: final_payload });
         }
     };
     var getInstances = function () { return ({ ab: _growthbook, tracking: _rudderstack }); };

package/lib/rudderstack.d.ts

@@ -1,5 +1,5 @@
 import { RudderAnalytics } from '@rudderstack/analytics-js';
-import { TCoreAttributes, TEvents } from './types';
+import { TCoreAttributes, TAllEvents } from './types';
 export declare class RudderStack {
     analytics: RudderAnalytics;
     has_identified: boolean;
@@ -43,11 +43,7 @@ export declare class 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
+     * Pushes track events to Rudderstack.
      */
-    track: <T extends keyof TEvents>(event: T, payload: TEvents[T] & Partial<TCoreAttributes>) => void;
+    track: <T extends keyof import("./types").TEvents | "ce_get_start_page">(event: T, payload: TAllEvents[T] & Partial<TCoreAttributes>) => void;
 }

package/lib/rudderstack.js

@@ -150,11 +150,7 @@ var RudderStack = /** @class */ (function () {
             }
         };
         /**
-         * 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
+         * Pushes track events to Rudderstack.
          */
         this.track = function (event, payload) {
             var clean_payload = Object.fromEntries(Object.entries(payload).filter(function (_a) {
@@ -163,6 +159,7 @@ var RudderStack = /** @class */ (function () {
             }));
             if (_this.has_initialized) {
                 try {
+                    // Cast to 'any' allows passing complex V2 objects that RudderStack's strictest types might reject
                     _this.analytics.track(event, clean_payload);
                 }
                 catch (err) {

package/lib/types.d.ts

@@ -166,6 +166,18 @@ type IndicatorsTypesFormAction = {
     search_string?: string;
     subform_name?: string;
 };
+type DrawingToolsTypesFormAction = {
+    action: 'open' | 'add' | 'delete' | 'edit_px' | 'edit_color';
+    form_name?: string;
+    drawing_tool_name?: string;
+    pxthickness?: string;
+    color_name?: string;
+};
+type CrossHairFormAction = {
+    action: 'click';
+    form_name?: string;
+    cta_name?: 'enable' | 'disable';
+};
 type MarketTypesFormAction = {
     action: 'open' | 'close' | 'choose_market_type' | 'search' | 'info_redirect' | 'add_to_favorites' | 'delete_from_favorites';
     form_name?: string;
@@ -218,7 +230,7 @@ type ReportsFormAction = {
     form_source: string;
 };
 type ChartTypesFormAction = {
-    action?: 'open' | 'close' | 'choose_chart_type' | 'choose_time_interval';
+    action?: 'open' | 'close' | 'choose_chart_type' | 'choose_time_interval' | 'switch_toggle';
     form_name?: string;
     chart_type_name?: string;
     time_interval_name?: string;
@@ -316,6 +328,8 @@ export type TEvents = {
     ce_bot_form: BotForm;
     ce_contracts_set_up_form: ContractsSetupForm;
     ce_indicators_types_form: IndicatorsTypesFormAction;
+    ce_drawing_tools_form: DrawingToolsTypesFormAction;
+    ce_crosshair: CrossHairFormAction;
     ce_trade_types_form: TradeTypesForm;
     ce_chart_types_form: ChartTypesFormAction;
     ce_market_types_form: MarketTypesFormAction;
@@ -331,4 +345,28 @@ export type TEvents = {
     ce_cashier_deposit_onboarding_form: TCashierDepositOnboardingFormAction;
     ce_dtrader_trade_form: TDtraderTradeForm;
 };
+export type TCtaInformation = {
+    cta_name: string;
+    section_name?: string;
+    container_name?: string;
+};
+export type TErrorInformation = {
+    error_message: string;
+    error_code?: string;
+};
+export type TV2EventMetadata = {
+    page_name?: string;
+    marketing_data?: Record<string, any>;
+} & Partial<TCoreAttributes>;
+export type TV2EventPayload = {
+    action: string;
+    form_name?: string;
+    cta_information?: TCtaInformation | null;
+    error?: TErrorInformation | null;
+    event_metadata: TV2EventMetadata;
+};
+export type TEventsV2 = {
+    ce_get_start_page: TV2EventPayload;
+};
+export type TAllEvents = TEvents & TEventsV2;
 export {};

package/package.json

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