@deriv-com/analytics 1.4.13 → 1.5.0

package/README.md

@@ -29,6 +29,20 @@ Analytics?.initialise({
     growthbookDecryptionKey: process.env.GROWTHBOOK_DECRYPTION_KEY, // optional key to enable A/B tests
     // mandatory key to enable userevent tracking
     rudderstackKey: RUDDERSTACK_KEY,
+
+    growthbookOptions: {
+        // optional options for overriding growthbook default options
+        // if you want e.g
+        antiFlicker: false,
+        navigateDelay: 0,
+        antiFlickerTimeout: 3500,
+        subscribeToChanges: true,
+        enableDevMode: window?.location.hostname.includes('localhost'),
+        trackingCallback: (experiment, result) => {
+            console.log('Tracking callback', experiment, result)
+        }
+        navigate: (url) => window.location.href = url,
+    }
 })
 ```
 

package/lib/analytics.d.ts

@@ -1,19 +1,21 @@
+import type { Context } from '@growthbook/growthbook';
 import { Growthbook, GrowthbookConfigs } from './growthbook';
 import { RudderStack } from './rudderstack';
 import { TCoreAttributes, TEvents } from './types';
 type Options = {
     growthbookKey?: string;
+    growthbookOptions?: Partial<Context>;
     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, utm_source, utm_medium, utm_campaign, is_authorised, }: TCoreAttributes) => void;
+    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;
     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>;
     isFeatureOn: (key: string) => boolean;
-    setUrl: (href: string) => void;
+    setUrl: (href: string) => Promise<void>;
     getId: () => string;
     trackEvent: <T extends keyof TEvents>(event: T, analytics_data: TEvents[T]) => void;
     getInstances: () => {
@@ -24,13 +26,13 @@ export declare function createAnalyticsInstance(options?: Options): {
     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, utm_source, utm_medium, utm_campaign, is_authorised, }: TCoreAttributes) => void;
+    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;
     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>;
     isFeatureOn: (key: string) => boolean;
-    setUrl: (href: string) => void;
+    setUrl: (href: string) => Promise<void>;
     getId: () => string;
     trackEvent: <T extends keyof TEvents>(event: T, analytics_data: TEvents[T]) => void;
     getInstances: () => {

package/lib/analytics.js

@@ -17,10 +17,10 @@ var rudderstack_1 = require("./rudderstack");
 function createAnalyticsInstance(options) {
     var _growthbook, _rudderstack, core_data = {}, tracking_config = {}, offline_cache = {};
     var initialise = function (_a) {
-        var growthbookKey = _a.growthbookKey, growthbookDecryptionKey = _a.growthbookDecryptionKey, rudderstackKey = _a.rudderstackKey;
+        var growthbookKey = _a.growthbookKey, growthbookDecryptionKey = _a.growthbookDecryptionKey, rudderstackKey = _a.rudderstackKey, growthbookOptions = _a.growthbookOptions;
         _rudderstack = rudderstack_1.RudderStack.getRudderStackInstance(rudderstackKey);
         if (growthbookKey && growthbookDecryptionKey) {
-            _growthbook = growthbook_1.Growthbook.getGrowthBookInstance(growthbookKey, growthbookDecryptionKey);
+            _growthbook = growthbook_1.Growthbook.getGrowthBookInstance(growthbookKey, growthbookDecryptionKey, growthbookOptions);
             var interval_1 = setInterval(function () {
                 if (Object.keys(tracking_config).length > 0)
                     clearInterval(interval_1);
@@ -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;
+        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;
         if (!_growthbook && !_rudderstack)
             return;
         var user_identity = user_id !== null && user_id !== void 0 ? user_id : getId();
@@ -46,9 +46,10 @@ function createAnalyticsInstance(options) {
                 utm_medium: utm_medium,
                 utm_campaign: utm_campaign,
                 is_authorised: is_authorised,
+                url: url,
             });
         }
-        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 }));
+        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 }));
     };
     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

@@ -1,4 +1,4 @@
-import { GrowthBook } from '@growthbook/growthbook';
+import { Context, GrowthBook } from '@growthbook/growthbook';
 import { TGrowthbookAttributes } from './types';
 export type GrowthbookConfigs = {
     'tracking-buttons-config': Record<string, boolean>;
@@ -8,12 +8,12 @@ export type GrowthbookConfigs = {
 export declare class Growthbook {
     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;
+    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;
     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;
+    setUrl: (href: string) => Promise<void>;
     isOn: (key: string) => boolean;
     init: () => Promise<void>;
 }

package/lib/growthbook.js

@@ -39,11 +39,12 @@ 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) {
+    function Growthbook(clientKey, decryptionKey, settings) {
+        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;
-            _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 })));
+            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 })));
         };
         this.getFeatureValue = function (key, defaultValue) {
             return _this.GrowthBook.getFeatureValue(key, defaultValue);
@@ -52,13 +53,7 @@ var Growthbook = /** @class */ (function () {
         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,
-            decryptionKey: decryptionKey,
-            subscribeToChanges: true,
-            enableDevMode: window === null || window === void 0 ? void 0 : window.location.hostname.includes('localhost'),
-            trackingCallback: function (experiment, result) {
+        this.GrowthBook = new growthbook_1.GrowthBook(__assign({ apiHost: 'https://cdn.growthbook.io', clientKey: clientKey, decryptionKey: decryptionKey, antiFlicker: false, navigateDelay: 0, antiFlickerTimeout: 3500, 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',
@@ -72,14 +67,13 @@ var Growthbook = /** @class */ (function () {
                     experimentId: experiment.key,
                     variationId: result.variationId,
                 });
-            },
-        });
+            } }, settings));
         this.init();
     }
     // for make instance by singleton
-    Growthbook.getGrowthBookInstance = function (clientKey, decryptionKey) {
+    Growthbook.getGrowthBookInstance = function (clientKey, decryptionKey, growthbookOptions) {
         if (!Growthbook._instance) {
-            Growthbook._instance = new Growthbook(clientKey, decryptionKey);
+            Growthbook._instance = new Growthbook(clientKey, decryptionKey, growthbookOptions);
             return Growthbook._instance;
         }
         return Growthbook._instance;

package/lib/types.d.ts

@@ -8,6 +8,7 @@ export type TGrowthbookAttributes = {
     utm_medium?: 'ppc-native' | 'affiliate' | 'common' | string;
     utm_campaign?: string;
     is_authorised?: boolean;
+    url?: string;
 };
 export type TCoreAttributes = {
     account_type?: string;
@@ -17,7 +18,7 @@ export type TCoreAttributes = {
 } & 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';
+    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_modal_open' | 'signup_modal_close';
     signup_provider?: SignupProvider;
     form_source?: string;
     form_name?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deriv-com/analytics",
-  "version": "1.4.13",
+  "version": "1.5.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",
@@ -36,7 +36,7 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "@growthbook/growthbook": "^0.29.0",
+    "@growthbook/growthbook": "^0.36.0",
     "rudder-sdk-js": "^2.35.0"
   },
   "engines": {