@deriv-com/analytics 1.4.11 → 1.4.13

package/lib/analytics.d.ts

@@ -1,4 +1,4 @@
-import { Growthbook } from './growthbook';
+import { Growthbook, GrowthbookConfigs } from './growthbook';
 import { RudderStack } from './rudderstack';
 import { TCoreAttributes, TEvents } from './types';
 type Options = {
@@ -11,21 +11,11 @@ export declare function createAnalyticsInstance(options?: Options): {
     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]) | (() => {
-        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);
+    getFeatureValue: <K extends string | number, V extends GrowthbookConfigs[K]>(id: K, defaultValue: V) => import("@growthbook/growthbook").WidenPrimitives<V>;
     isFeatureOn: (key: string) => boolean;
     setUrl: (href: string) => void;
     getId: () => string;
-    trackEvent: <T_2 extends keyof TEvents>(event: T_2, analytics_data: TEvents[T_2]) => void;
+    trackEvent: <T extends keyof TEvents>(event: T, analytics_data: TEvents[T]) => void;
     getInstances: () => {
         ab: Growthbook;
         tracking: RudderStack;
@@ -38,21 +28,11 @@ export declare const Analytics: {
     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]) | (() => {
-        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);
+    getFeatureValue: <K extends string | number, V extends GrowthbookConfigs[K]>(id: K, defaultValue: V) => import("@growthbook/growthbook").WidenPrimitives<V>;
     isFeatureOn: (key: string) => boolean;
     setUrl: (href: string) => void;
     getId: () => string;
-    trackEvent: <T_2 extends keyof TEvents>(event: T_2, analytics_data: TEvents[T_2]) => void;
+    trackEvent: <T extends keyof TEvents>(event: T, analytics_data: TEvents[T]) => void;
     getInstances: () => {
         ab: Growthbook;
         tracking: RudderStack;

package/lib/analytics.js

@@ -15,25 +15,25 @@ exports.Analytics = exports.createAnalyticsInstance = void 0;
 var growthbook_1 = require("./growthbook");
 var rudderstack_1 = require("./rudderstack");
 function createAnalyticsInstance(options) {
-    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 _growthbook, _rudderstack, core_data = {}, tracking_config = {}, offline_cache = {};
     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);
+            var interval_1 = setInterval(function () {
+                if (Object.keys(tracking_config).length > 0)
+                    clearInterval(interval_1);
+                else
+                    tracking_config = getFeatureValue('tracking-buttons-config', {});
+            }, 1000);
         }
     };
     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;
         if (!_growthbook && !_rudderstack)
             return;
-        var user_identity = user_id ? user_id : getId();
+        var user_identity = user_id !== null && user_id !== void 0 ? user_id : getId();
         // Check if we have Growthbook instance
         if (_growthbook) {
             _growthbook.setAttributes({
@@ -81,14 +81,13 @@ function createAnalyticsInstance(options) {
             return;
         if (navigator.onLine) {
             if (Object.keys(offline_cache).length > 0) {
-                Object.keys(offline_cache).map(function (cache) {
+                Object.keys(offline_cache).forEach(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)));
+            if (event in tracking_config) {
+                tracking_config[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));

package/lib/growthbook.d.ts

@@ -1,34 +1,19 @@
 import { GrowthBook } from '@growthbook/growthbook';
 import { TGrowthbookAttributes } from './types';
+export type GrowthbookConfigs = {
+    'tracking-buttons-config': Record<string, boolean>;
+} & {
+    [key: string]: Record<string, boolean> | string | boolean | [];
+};
 export declare class Growthbook {
-    GrowthBook: GrowthBook<GrowthBook<Record<string, any>>>;
+    GrowthBook: GrowthBook<GrowthbookConfigs>;
     private static _instance;
     constructor(clientKey: string, decryptionKey: string);
-    static getGrowthBookInstance(clientKey: string, decryptionKey: string): Growthbook;
-    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;
-        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;
+    static getGrowthBookInstance: (clientKey: string, decryptionKey: string) => Growthbook;
+    setAttributes: ({ id, country, user_language, device_language, device_type, utm_source, utm_medium, utm_campaign, is_authorised, }: 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) => void;
+    isOn: (key: string) => boolean;
+    init: () => Promise<void>;
 }

package/lib/growthbook.js

@@ -40,6 +40,18 @@ 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) {
+        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;
+            _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 })));
+        };
+        this.getFeatureValue = function (key, defaultValue) {
+            return _this.GrowthBook.getFeatureValue(key, defaultValue);
+        };
+        this.getFeatureState = function (id) { return _this.GrowthBook.evalFeature(id); };
+        this.setUrl = function (href) { return _this.GrowthBook.setURL(href); };
+        this.isOn = function (key) { return _this.GrowthBook.isOn(key); };
+        this.init = function () { return _this.GrowthBook.loadFeatures().catch(function (err) { return console.error(err); }); };
         this.GrowthBook = new growthbook_1.GrowthBook({
             apiHost: 'https://cdn.growthbook.io',
             clientKey: clientKey,
@@ -72,28 +84,6 @@ 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, 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
-        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/rudderstack.d.ts

@@ -1,25 +1,25 @@
-import { TEvents } from './types';
+import { TCoreAttributes, 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;
+    static getRudderStackInstance: (RUDDERSTACK_KEY: string) => RudderStack;
     /**
      * @returns The anonymous ID assigned to the user before the identify event was called
      */
-    getAnonymousId(): string;
+    getAnonymousId: () => string;
     /**
      * @returns The user ID that was assigned to the user after calling identify event
      */
-    getUserId(): string;
+    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;
+    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
@@ -33,11 +33,11 @@ export declare class 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;
+    pageView: (current_page: string, platform: string | undefined, user_id: string) => void;
     /**
      * Pushes reset event to rudderstack
      */
-    reset(): void;
+    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.
@@ -45,5 +45,5 @@ export declare class RudderStack {
      * @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;
+    track: <T extends keyof TEvents>(event: T, payload: TEvents[T] & Partial<TCoreAttributes>) => void;
 }

package/lib/rudderstack.js

@@ -31,6 +31,28 @@ var RudderStack = /** @class */ (function () {
         this.has_identified = false;
         this.has_initialized = false;
         this.current_page = '';
+        /**
+         * @returns The anonymous ID assigned to the user before the identify event was called
+         */
+        this.getAnonymousId = function () { return RudderAnalytics.getAnonymousId(); };
+        /**
+         * @returns The user ID that was assigned to the user after calling identify event
+         */
+        this.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.
+         */
+        this.init = function (RUDDERSTACK_KEY) {
+            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());
+                });
+            }
+        };
         /**
          *
          * @param user_id The user ID of the user to identify and associate all events with that particular user ID
@@ -40,6 +62,48 @@ var RudderStack = /** @class */ (function () {
             RudderAnalytics.identify(user_id, payload);
             _this.has_identified = true;
         };
+        /**
+         * Pushes page view event to Rudderstack
+         *
+         * @param curret_page The name or URL of the current page to track the page view event
+         */
+        this.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
+         */
+        this.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
+         */
+        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 && _this.has_identified) {
+                try {
+                    RudderAnalytics.track(event, clean_payload);
+                }
+                catch (err) {
+                    console.error(err);
+                }
+            }
+        };
         this.init(RUDDERSTACK_KEY);
     }
     RudderStack.getRudderStackInstance = function (RUDDERSTACK_KEY) {
@@ -49,71 +113,6 @@ var RudderStack = /** @class */ (function () {
         }
         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

@@ -65,13 +65,38 @@ type QuestionnaireForm = {
     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';
+    action: 'open_wizard';
+    email: string;
+} | {
+    action: 'step_passed';
+    step_num: number;
+    step_codename: string;
+} | {
+    action: 'step_back';
+    step_num: number;
+    step_codename: string;
+} | {
+    action: 'push_learn_more';
+} | {
+    action: 'close_wizard';
+} | {
+    action: 'partners_signup_error';
+    partner_signup_error_message: string;
+    form_name?: string;
+} | {
+    action: 'other_error';
     partner_signup_error_message?: string;
+} | {
+    action: 'try_submit';
+} | {
+    action: 'failed_popup_cta';
+} | {
+    action: 'success_popup_opened';
+    user_choice: string;
+    success_source: string;
+    affiliate_id: string;
+} | {
+    action: 'success_popup_cta';
 };
 type VirtualSignupEmailConfirmation = {
     action?: 'received' | 'expired' | 'confirmed' | 'error';
@@ -196,6 +221,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';
@@ -219,6 +259,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.11",
+  "version": "1.4.13",
   "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",