@useblu/blu-lytics 1.3.0 → 1.4.0

package/lib/dispatchers/dispatchers.spec.js

@@ -1,10 +1,12 @@
 import { sendCustomEvent, sendScreenEvent, sendUserIdentification, } from './index';
+import { providersList } from '../providers';
 jest.mock('../initializers', function () { return ({
     userSelectedEnvironment: 'development'
 }); });
 jest.mock('../providers', function () { return ({
     providersList: [
         {
+            name: 'FakeProvider',
             screenEvent: jest.fn(),
             customEvent: jest.fn(),
             userIdentification: jest.fn()
@@ -12,7 +14,8 @@ jest.mock('../providers', function () { return ({
     ]
 }); });
 jest.mock('../utils', function () { return ({
-    isValidProvidersList: jest.fn(function () { return true; })
+    isValidProvidersList: jest.fn(function () { return true; }),
+    checkIfMixPanelIsInitialized: jest.fn()
 }); });
 describe('Event dispatching functions', function () {
     afterEach(function () {
@@ -22,12 +25,63 @@ describe('Event dispatching functions', function () {
     var providers = ['Sentry', 'MixPanel'];
     beforeEach(function () {
         localStorage.setItem(localStorageKey, JSON.stringify([providers]));
+        localStorage.setItem('_bl_props', JSON.stringify({}));
     });
     it('should be dispatch sendScreenEvent', function () {
         var consoleLogSpy = jest.spyOn(console, 'log');
         sendScreenEvent('TestScreen');
         expect(consoleLogSpy).toHaveBeenCalledWith('[blu-lytics]: Screen event: TestScreen');
     });
+    it('should dispatch sendScreenEvent without properties keeping the legacy log format when _bl_props is empty', function () {
+        var consoleLogSpy = jest.spyOn(console, 'log');
+        sendScreenEvent('TestScreen');
+        expect(consoleLogSpy).toHaveBeenCalledWith('[blu-lytics]: Screen event: TestScreen');
+        expect(consoleLogSpy).not.toHaveBeenCalledWith(expect.stringContaining('TestScreen - '));
+    });
+    it('should include defaultProperties in log when _bl_props has content and no explicit properties are passed', function () {
+        localStorage.setItem('_bl_props', JSON.stringify({ client_uuid: 'abc123' }));
+        var consoleLogSpy = jest.spyOn(console, 'log');
+        sendScreenEvent('home_view');
+        expect(consoleLogSpy).toHaveBeenCalledWith('[blu-lytics]: Screen event: home_view - {"client_uuid":"abc123"}');
+    });
+    it('should dispatch sendScreenEvent merging defaultProperties with the provided properties', function () {
+        localStorage.setItem('_bl_props', JSON.stringify({ origin: 'home' }));
+        var consoleLogSpy = jest.spyOn(console, 'log');
+        sendScreenEvent('credit_list_view', { campaign_name: 'black_friday' });
+        expect(consoleLogSpy).toHaveBeenCalledWith('[blu-lytics]: Screen event: credit_list_view - {"origin":"home","campaign_name":"black_friday"}');
+    });
+    describe('production dispatch (non-development)', function () {
+        beforeEach(function () {
+            localStorage.setItem('_bl_env', 'production');
+            // Remove the providers allow-list so the dispatcher falls back to the
+            // full (mocked) providersList instead of filtering by name.
+            localStorage.removeItem('_bl_providers');
+        });
+        afterEach(function () {
+            localStorage.removeItem('_bl_env');
+        });
+        it('should call provider.screenEvent with only the screen when no properties are provided and _bl_props is empty', function () {
+            sendScreenEvent('TestScreen');
+            expect(providersList[0].screenEvent).toHaveBeenCalledWith('TestScreen', undefined);
+        });
+        it('should call provider.screenEvent with defaultProperties when _bl_props has content and no explicit properties are passed', function () {
+            localStorage.setItem('_bl_props', JSON.stringify({ client_uuid: 'abc123', is_economic_group: false }));
+            sendScreenEvent('home_view');
+            expect(providersList[0].screenEvent).toHaveBeenCalledWith('home_view', { client_uuid: 'abc123', is_economic_group: false });
+        });
+        it('should call provider.screenEvent with the screen and merged properties', function () {
+            localStorage.setItem('_bl_props', JSON.stringify({ origin: 'home' }));
+            sendScreenEvent('credit_list_view', {
+                campaign_name: 'black_friday',
+                opportunities_pagblu_count: 3
+            });
+            expect(providersList[0].screenEvent).toHaveBeenCalledWith('credit_list_view', {
+                origin: 'home',
+                campaign_name: 'black_friday',
+                opportunities_pagblu_count: 3
+            });
+        });
+    });
     it('should be dispatch sendCustomEvent', function () {
         var consoleLogSpy = jest.spyOn(console, 'log');
         sendCustomEvent('TestEvent', { prop1: 'value1' });

package/lib/dispatchers/index.d.ts

@@ -6,8 +6,8 @@ import { EventData, PropertiesType, UserPropertiesType } from './dispatchers.typ
  * @returns {void}
  */
 export declare const dispatchEventToAllProviders: (eventData: EventData) => void;
-declare const sendScreenEvent: (screen: string) => void;
 declare const setDefaultProperties: (properties: PropertiesType) => void;
+declare const sendScreenEvent: (screen: string, properties?: PropertiesType) => void;
 declare const sendCustomEvent: (event: string, properties: PropertiesType) => void;
 declare const sendUserIdentification: (id: string, userProperties: UserPropertiesType) => void;
 declare const resetMixpanel: () => void;

package/lib/dispatchers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/dispatchers/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,SAAS,EACT,cAAc,EACd,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAG7B;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B,cAAe,SAAS,KAAG,IAkClE,CAAC;AAOF,QAAA,MAAM,eAAe,WAAY,MAAM,KAAG,IAMzC,CAAC;AAeF,QAAA,MAAM,oBAAoB,eAAgB,cAAc,KAAG,IAG1D,CAAC;AAEF,QAAA,MAAM,eAAe,UAAW,MAAM,cAAc,cAAc,KAAG,IAyBpE,CAAC;AAEF,QAAA,MAAM,sBAAsB,OACtB,MAAM,kBACM,kBAAkB,KACjC,IAUF,CAAC;AAEF,QAAA,MAAM,aAAa,QAAO,IAUzB,CAAC;AAEF,OAAO,EACL,eAAe,EACf,eAAe,EACf,sBAAsB,EACtB,oBAAoB,EACpB,aAAa,GACd,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/dispatchers/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,SAAS,EACT,cAAc,EACd,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAG7B;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B,cAAe,SAAS,KAAG,IAkClE,CAAC;AAoBF,QAAA,MAAM,oBAAoB,eAAgB,cAAc,KAAG,IAG1D,CAAC;AAEF,QAAA,MAAM,eAAe,WACX,MAAM,eACD,cAAc,KAC1B,IA0BF,CAAC;AAEF,QAAA,MAAM,eAAe,UAAW,MAAM,cAAc,cAAc,KAAG,IAyBpE,CAAC;AAEF,QAAA,MAAM,sBAAsB,OACtB,MAAM,kBACM,kBAAkB,KACjC,IAUF,CAAC;AAEF,QAAA,MAAM,aAAa,QAAO,IAUzB,CAAC;AAEF,OAAO,EACL,eAAe,EACf,eAAe,EACf,sBAAsB,EACtB,oBAAoB,EACpB,aAAa,GACd,CAAC"}

package/lib/dispatchers/index.js

@@ -32,7 +32,7 @@ export var dispatchEventToAllProviders = function (eventData) {
                 screenEvent: function () {
                     return provider.screenEvent &&
                         eventData.screen &&
-                        provider.screenEvent(eventData.screen);
+                        provider.screenEvent(eventData.screen, eventData.properties);
                 },
                 customEvent: function () {
                     return provider.customEvent &&
@@ -55,14 +55,6 @@ var getIsDevelopment = function () {
     var currentEnvironment = localStorage.getItem('_bl_env') || 'development';
     return currentEnvironment === 'development';
 };
-var sendScreenEvent = function (screen) {
-    if (getIsDevelopment()) {
-        console.log("[blu-lytics]: Screen event: ".concat(screen));
-    }
-    else {
-        dispatchEventToAllProviders({ screen: screen });
-    }
-};
 var saveDefaultPropertiesToLocalStorage = function (properties) {
     localStorage.setItem('_bl_props', JSON.stringify(properties));
 };
@@ -75,6 +67,27 @@ var setDefaultProperties = function (properties) {
     defaultProperties = __assign({}, properties);
     saveDefaultPropertiesToLocalStorage(defaultProperties);
 };
+var sendScreenEvent = function (screen, properties) {
+    var rawStoredProperties = localStorage.getItem('_bl_props');
+    if (rawStoredProperties) {
+        try {
+            defaultProperties = JSON.parse(rawStoredProperties);
+        }
+        catch (error) {
+            console.error('[blu-lytics] Failed to parse stored properties', error);
+        }
+    }
+    var mergedProperties = __assign(__assign({}, defaultProperties), properties);
+    var hasProperties = Object.keys(mergedProperties).length > 0;
+    if (getIsDevelopment()) {
+        console.log(hasProperties
+            ? "[blu-lytics]: Screen event: ".concat(screen, " - ").concat(JSON.stringify(mergedProperties))
+            : "[blu-lytics]: Screen event: ".concat(screen));
+    }
+    else {
+        dispatchEventToAllProviders(__assign({ screen: screen }, (hasProperties ? { properties: mergedProperties } : {})));
+    }
+};
 var sendCustomEvent = function (event, properties) {
     var rawStoredProperties = localStorage.getItem('_bl_props');
     if (rawStoredProperties) {

package/lib/providers/provider.types.d.ts

@@ -3,7 +3,7 @@ export type ProviderType = {
     name: 'Clarity' | 'Sentry' | 'FullStory' | 'MixPanel';
     userIdentification: (id: string, userProperties: any) => void;
     customEvent: (event: string, properties: PropertiesType) => void;
-    screenEvent: (screen: string) => void;
+    screenEvent: (screen: string, properties?: PropertiesType) => void;
     reset?: () => void;
 };
 //# sourceMappingURL=provider.types.d.ts.map

package/lib/providers/provider.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"provider.types.d.ts","sourceRoot":"","sources":["../../src/providers/provider.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAElE,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,SAAS,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,CAAC;IACtD,kBAAkB,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,KAAK,IAAI,CAAC;IAC9D,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,cAAc,KAAK,IAAI,CAAC;IACjE,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC;CACpB,CAAC"}
+{"version":3,"file":"provider.types.d.ts","sourceRoot":"","sources":["../../src/providers/provider.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAElE,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,SAAS,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,CAAC;IACtD,kBAAkB,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,KAAK,IAAI,CAAC;IAC9D,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,cAAc,KAAK,IAAI,CAAC;IACjE,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;IACnE,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC;CACpB,CAAC"}

package/lib/providers/setups/clarity/clarity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clarity.d.ts","sourceRoot":"","sources":["../../../../src/providers/setups/clarity/clarity.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAyBpD,QAAA,MAAM,eAAe,EAAE,YAKtB,CAAC;AAEF,eAAe,eAAe,CAAC"}
+{"version":3,"file":"clarity.d.ts","sourceRoot":"","sources":["../../../../src/providers/setups/clarity/clarity.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AA4BpD,QAAA,MAAM,eAAe,EAAE,YAKtB,CAAC;AAEF,eAAe,eAAe,CAAC"}

package/lib/providers/setups/clarity/clarity.js

@@ -5,7 +5,7 @@ var dispatchUserIdentification = function (id, userProperties) {
 };
 var dispatchCustomEvent = function (event, properties) {
 };
-var dispatchScreenEvent = function (screen) {
+var dispatchScreenEvent = function (screen, properties) {
 };
 var ClarityProvider = {
     name: 'Clarity',

package/lib/providers/setups/fullstory/fullstory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fullstory.d.ts","sourceRoot":"","sources":["../../../../src/providers/setups/fullstory/fullstory.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AA2BpD,QAAA,MAAM,iBAAiB,EAAE,YAKxB,CAAC;AAEF,eAAe,iBAAiB,CAAC"}
+{"version":3,"file":"fullstory.d.ts","sourceRoot":"","sources":["../../../../src/providers/setups/fullstory/fullstory.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AA8BpD,QAAA,MAAM,iBAAiB,EAAE,YAKxB,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/lib/providers/setups/fullstory/fullstory.js

@@ -6,8 +6,8 @@ var dispatchUserIdentification = function (id, userProperties) {
 var dispatchCustomEvent = function (event, properties) {
     FullStory.event(event, { properties: properties });
 };
-var dispatchScreenEvent = function (screen) {
-    FullStory.event(screen, {});
+var dispatchScreenEvent = function (screen, properties) {
+    FullStory.event(screen, properties ? { properties: properties } : {});
 };
 var FullStoryProvider = {
     name: 'FullStory',

package/lib/providers/setups/fullstory/fullstory.spec.js

@@ -27,4 +27,10 @@ describe('FullStoryProvider', function () {
         FullStoryProvider.screenEvent(screen);
         expect(FullStory.event).toHaveBeenCalledWith(screen, {});
     });
+    it('dispatchScreenEvent should call FullStory.event with properties when provided', function () {
+        var screen = 'credit_list_view';
+        var properties = { origin: 'home', campaign_name: 'black_friday' };
+        FullStoryProvider.screenEvent(screen, properties);
+        expect(FullStory.event).toHaveBeenCalledWith(screen, { properties: properties });
+    });
 });

package/lib/providers/setups/mixpanel/mixpanel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mixpanel.d.ts","sourceRoot":"","sources":["../../../../src/providers/setups/mixpanel/mixpanel.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAkEpD,QAAA,MAAM,gBAAgB,EAAE,YAMvB,CAAC;AAEF,eAAe,gBAAgB,CAAC"}
+{"version":3,"file":"mixpanel.d.ts","sourceRoot":"","sources":["../../../../src/providers/setups/mixpanel/mixpanel.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAyEpD,QAAA,MAAM,gBAAgB,EAAE,YAMvB,CAAC;AAEF,eAAe,gBAAgB,CAAC"}

package/lib/providers/setups/mixpanel/mixpanel.js

@@ -1,3 +1,14 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __rest = (this && this.__rest) || function (s, e) {
     var t = {};
     for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
@@ -43,10 +54,15 @@ var dispatchCustomEvent = function (event, properties) {
         console.error('Error tracking screen event:', error);
     }
 };
-var dispatchScreenEvent = function (screen) {
+var dispatchScreenEvent = function (screen, properties) {
     try {
         setTimeout(function () {
-            mixpanel.track(screen);
+            if (properties) {
+                mixpanel.track(screen, __assign({}, properties));
+            }
+            else {
+                mixpanel.track(screen);
+            }
         }, 1000);
     }
     catch (error) {

package/lib/providers/setups/mixpanel/mixpanel.spec.js

@@ -1,3 +1,14 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __rest = (this && this.__rest) || function (s, e) {
     var t = {};
     for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
@@ -56,4 +67,15 @@ describe('MixPanelProvider', function () {
         jest.runAllTimers();
         expect(mixpanel.track).toHaveBeenCalledWith(screen);
     });
+    test('dispatchScreenEvent should call mixpanel.track with screen and properties', function () {
+        var screen = 'credit_list_view';
+        var properties = {
+            origin: 'home',
+            campaign_name: 'black_friday',
+            opportunities_pagblu_count: 3
+        };
+        MixPanelProvider.screenEvent(screen, properties);
+        jest.runAllTimers();
+        expect(mixpanel.track).toHaveBeenCalledWith(screen, __assign({}, properties));
+    });
 });

package/lib/providers/setups/sentry/sentry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sentry.d.ts","sourceRoot":"","sources":["../../../../src/providers/setups/sentry/sentry.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AA6CpD,QAAA,MAAM,cAAc,EAAE,YAKrB,CAAC;AAEF,eAAe,cAAc,CAAC"}
+{"version":3,"file":"sentry.d.ts","sourceRoot":"","sources":["../../../../src/providers/setups/sentry/sentry.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAiDpD,QAAA,MAAM,cAAc,EAAE,YAKrB,CAAC;AAEF,eAAe,cAAc,CAAC"}

package/lib/providers/setups/sentry/sentry.js

@@ -24,13 +24,8 @@ var dispatchCustomEvent = function (event, properties) {
     };
     Sentry.addBreadcrumb(breadcrumb);
 };
-var dispatchScreenEvent = function (screen) {
-    var breadcrumb = {
-        category: 'screen',
-        message: screen,
-        level: Sentry.Severity.Info,
-        type: 'info'
-    };
+var dispatchScreenEvent = function (screen, properties) {
+    var breadcrumb = __assign({ category: 'screen', message: screen, level: Sentry.Severity.Info, type: 'info' }, (properties ? { data: properties } : {}));
     Sentry.addBreadcrumb(breadcrumb);
 };
 var SentryProvider = {

package/lib/providers/setups/sentry/sentry.spec.js

@@ -53,4 +53,16 @@ describe('SentryProvider', function () {
             type: 'info'
         });
     });
+    it('dispatchScreenEvent should add breadcrumb with data when properties are provided', function () {
+        var screenName = 'credit_list_view';
+        var properties = { origin: 'home', campaign_name: 'black_friday' };
+        SentryProvider.screenEvent(screenName, properties);
+        expect(Sentry.addBreadcrumb).toHaveBeenCalledWith({
+            category: 'screen',
+            message: screenName,
+            level: 'info',
+            type: 'info',
+            data: properties
+        });
+    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@useblu/blu-lytics",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "private": false,
   "license": "MIT",
   "main": "lib/index.js",