@mparticle/web-braze-kit 3.0.2 → 3.0.3

package/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 --
 
+#### 3.0.3 - 2022-08-24
+-   feat: Add logging for debugging
+
 #### 3.0.2 - 2022-06-16
 -   fix: add register_inapp and pushPrimer variables
 

package/dist/BrazeKit.common.js

@@ -305,7 +305,7 @@ window.appboy = appboy_min;
 
 var name = 'Appboy',
     moduleId = 28,
-    version = '3.0.1',
+    version = '3.0.3',
     MessageType = {
         PageView: 3,
         PageEvent: 4,
@@ -385,10 +385,20 @@ var constructor = function() {
                         sanitizedProductName
                     );
                 }
+                var price = parseFloat(product.Price);
+
+                kitLogger(
+                    'appboy.logPurchase',
+                    sanitizedProductName,
+                    price,
+                    event.CurrencyCode,
+                    product.Quantity,
+                    sanitizedProperties
+                );
 
                 reportEvent = appboy.logPurchase(
                     sanitizedProductName,
-                    parseFloat(product.Price),
+                    price,
                     event.CurrencyCode,
                     product.Quantity,
                     sanitizedProperties
@@ -414,6 +424,9 @@ var constructor = function() {
         }
         sanitizedEventName = getSanitizedValueForAppboy(eventName);
         sanitizedAttrs = getSanitizedCustomProperties(attrs);
+
+        kitLogger('appboy.logCustomEvent', sanitizedEventName, sanitizedAttrs);
+
         var reportEvent = appboy.logCustomEvent(
             sanitizedEventName,
             sanitizedAttrs
@@ -430,6 +443,13 @@ var constructor = function() {
                     ", removeUserAttribute or setUserAttribute must set 'dob' to a date"
                 );
             } else {
+                kitLogger(
+                    'appoy.getUser().setDateOfBirth',
+                    value.getFullYear(),
+                    value.getMonth() + 1,
+                    value.getDate()
+                );
+
                 appboy
                     .getUser()
                     .setDateOfBirth(
@@ -441,6 +461,9 @@ var constructor = function() {
         } else if (key === '$Age') {
             if (typeof value === 'number') {
                 var year = new Date().getFullYear() - value;
+
+                kitLogger('appboy.getUser().setDateOfBirth', year, 1, 1);
+
                 appboy.getUser().setDateOfBirth(year, 1, 1);
             } else {
                 return '$Age must be a number';
@@ -458,6 +481,12 @@ var constructor = function() {
             }
             var params = [];
             params.push(value);
+
+            kitLogger(
+                'appboy.getUser().' + DefaultAttributeMethods[key],
+                params
+            );
+
             var u = appboy.getUser();
             //This method uses the setLastName, setFirstName, setEmail, setCountry, setHomeCity, setPhoneNumber, setAvatarImageUrl, setDateOfBirth, setGender, setEmailNotificationSubscriptionType, and setPushNotificationSubscriptionType methods
             if (!u[DefaultAttributeMethods[key]].apply(u, params)) {
@@ -482,10 +511,17 @@ var constructor = function() {
             );
         }
 
+        kitLogger(
+            'appboy.logCustomEvent',
+            sanitizedEventName,
+            sanitizedProperties
+        );
+
         var reportEvent = appboy.logCustomEvent(
             sanitizedEventName,
             sanitizedProperties
         );
+
         return reportEvent === true;
     }
 
@@ -541,6 +577,13 @@ var constructor = function() {
     function removeUserAttribute(key) {
         if (!(key in DefaultAttributeMethods)) {
             var sanitizedKey = getSanitizedValueForAppboy(key);
+
+            kitLogger(
+                'appboy.getUser().setCustomUserAttribute',
+                sanitizedKey,
+                null
+            );
+
             appboy.getUser().setCustomUserAttribute(sanitizedKey, null);
         } else {
             return setDefaultAttribute(key, null);
@@ -554,6 +597,13 @@ var constructor = function() {
             if (value != null && sanitizedValue == null) {
                 return 'Value did not pass validation for ' + key;
             }
+
+            kitLogger(
+                'appboy.getUser().setCustomUserAttribute',
+                sanitizedKey,
+                sanitizedValue
+            );
+
             appboy
                 .getUser()
                 .setCustomUserAttribute(sanitizedKey, sanitizedValue);
@@ -567,8 +617,12 @@ var constructor = function() {
         // Other versions use onUserIdentified, which is called after setUserIdentity from core SDK
         if (window.mParticle.getVersion().split('.')[0] === '1') {
             if (type == window.mParticle.IdentityType.CustomerId) {
+                kitLogger('appboy.changeUser', id);
+
                 appboy.changeUser(id);
             } else if (type == window.mParticle.IdentityType.Email) {
+                kitLogger('appboy.getUser().setEmail', id);
+
                 appboy.getUser().setEmail(id);
             } else {
                 return (
@@ -594,9 +648,13 @@ var constructor = function() {
                 ];
         }
 
+        kitLogger('appboy.changeUser', appboyUserIDType);
+
         appboy.changeUser(appboyUserIDType);
 
         if (userIdentities.email) {
+            kitLogger('appboy.getUser().setEmail', userIdentities.email);
+
             appboy.getUser().setEmail(userIdentities.email);
         }
     }
@@ -648,11 +706,33 @@ var constructor = function() {
     function openSession(forwarderSettings) {
         appboy.openSession();
         if (forwarderSettings.softPushCustomEventName) {
+            kitLogger(
+                'appboy.logCustomEvent',
+                forwarderSettings.softPushCustomEventName
+            );
+
             appboy.logCustomEvent(forwarderSettings.softPushCustomEventName);
         }
     }
 
-    function initForwarder(settings, service, testMode, trackerId, userAttributes, userIdentities, appVersion, appName, customFlags) {
+    function initForwarder(
+        settings,
+        service,
+        testMode,
+        trackerId,
+        userAttributes,
+        userIdentities,
+        appVersion,
+        appName,
+        customFlags
+    ) {
+        // check to see if there is a logger for backwards compatibility, and if not, mock one to avoid errors
+        if (!self.logger) {
+            // create a logger
+            self.logger = {
+                verbose: function() {},
+            };
+        }
         // eslint-disable-line no-unused-vars
         mpCustomFlags = customFlags;
         try {
@@ -689,14 +769,14 @@ var constructor = function() {
                     options.baseUrl = customUrl;
                 }
             }
-            
+
             if (mpCustomFlags && mpCustomFlags[moduleId.toString()]) {
                 var brazeFlags = mpCustomFlags[moduleId.toString()];
                 if (typeof brazeFlags.initOptions === 'function') {
                     brazeFlags.initOptions(options);
                 }
             }
-            
+
             if (testMode !== true) {
                 appboy.initialize(forwarderSettings.apiKey, options);
                 finishAppboyInitialization(forwarderSettings);
@@ -805,6 +885,35 @@ var constructor = function() {
     this.onUserIdentified = onUserIdentified;
     this.removeUserAttribute = removeUserAttribute;
     this.decodeClusterSetting = decodeClusterSetting;
+
+    /* An example output of this logger if we pass in a purchase event for 1 iPhone
+     with a SKU of iphoneSku that cost $999 with a product attribute of 
+     color: blue would be:
+     mParticle - Braze Web Kit log:
+     appboy.logPurchase:
+     iphone,
+     999,
+     USD,
+     1,
+     {\"color\":\"blue\",\"Sku":"iphoneSKU"},\n`;
+     */
+    function kitLogger(method) {
+        var msg = 'mParticle - Braze Web Kit log:';
+
+        var nonMethodArguments = Array.prototype.slice.call(arguments, 1);
+        msg += '\n' + method + ':\n';
+
+        nonMethodArguments.forEach(function(arg) {
+            if (isObject(arg) || Array.isArray(arg)) {
+                msg += JSON.stringify(arg);
+            } else {
+                msg += arg;
+            }
+            msg += ',\n';
+        });
+
+        self.logger.verbose(msg);
+    }
 };
 
 function getId() {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-braze-kit",
-    "version": "3.0.2",
+    "version": "3.0.3",
     "author": "mParticle Developers <developers@mparticle.com> (https://www.mparticle.com)",
     "description": "mParticle integration sdk for Braze",
     "main": "dist/BrazeKit.common.js",
@@ -31,7 +31,7 @@
     },
     "dependencies": {
         "@braze/web-sdk": "^3.5.0",
-        "@mparticle/web-sdk": "^2.11.3"
+        "@mparticle/web-sdk": "^2.17.0"
     },
     "license": "Apache-2.0"
 }