@mparticle/web-braze-kit 4.0.2 → 4.1.1

package/README.md

@@ -19,7 +19,7 @@ Note that the following is only one example.  Everywhere you manually call `appb
 window.appboy.display.destroyFeed();
 ```
 
-Step 2: Roll out code changes to be used before February 15, 2023:
+Step 2: Roll out code changes prior to opting in to V4
 ```javascript
 if (window.appboy) {
 	window.appboy.display.destroyFeed();
@@ -27,12 +27,14 @@ if (window.appboy) {
 	window.braze.destroyFeed();
 }
 ```
-Step 3: After February 1, 2023, you can simplify your code after the mParticle Braze Web kit, which includes Braze SDK V4, has been released to our CDN:
+Step 3: Opt into Version 4.  Simply navigate to your connection settings and selection `Version 4` from the new Braze Web SDK Version drop down.  
+
+Step 4: After you opt in, you can simplify your code. We recommend testing and waiting at least 24 hours between opting in and removing previous instances of `appboy` and doing thorough testing of your application in a development environment to ensure everything is working:
 ```javascript
 window.braze.destroyFeed();
 ```
 
-Step 4: Push Notifications via service-worker.js
+Step 5: Push Notifications via service-worker.js
 If you use Push Notifications, we have updated the `service-worker.js` file.  In our testing, Braze’s push notifications work as expected regardless of what version of the service-worker is used, but we recommend updating this file to ensure future compatibility.  In your `service-worker.js` file, update the code to reference `https://static.mparticle.com/sdk/js/braze/service-worker-4.2.0.js` instead of `https://static.mparticle.com/sdk/js/braze/service-worker-3.5.0.js`.  Your `service-worker.js` file should now contain:
 
 ```javascript

package/dist/BrazeKit.common.js

@@ -9172,12 +9172,13 @@ window.braze = require$$0;
 var name = 'Appboy',
     suffix = 'v4',
     moduleId = 28,
-    version = '4.0.2',
+    version = '4.1.1',
     MessageType = {
         PageView: 3,
         PageEvent: 4,
         Commerce: 16,
-    };
+    },
+    CommerceEventType = mParticle.CommerceEventType;
 
 var clusterMapping = {
     '01': 'sdk.iad-01.braze.com',
@@ -9222,32 +9223,94 @@ var constructor = function () {
         dob: 'setDateOfBirth',
     };
 
+    var bundleCommerceEventData = false;
+
+    // A purchase event can either log a single event with all products
+    // or multiple purchase events (one per product)
     function logPurchaseEvent(event) {
         var reportEvent = false;
+
+        if (bundleCommerceEventData) {
+            reportEvent = logSinglePurchaseEventWithProducts(event);
+        } else {
+            reportEvent = logPurchaseEventPerProduct(event);
+        }
+        return reportEvent === true;
+    }
+
+    function logSinglePurchaseEventWithProducts(event) {
+        var quantity = 1;
+        var eventAttributes = mergeObjects(event.EventAttributes, {
+            products: [],
+        });
+        var eventName = getCommerceEventName(event.EventCategory);
+
+        // All commerce events except for promotion/impression events will have a
+        // ProductAction property, but if this ever changes in the future, this
+        // check will prevent errors
+        if (!event.ProductAction) {
+            return false;
+        }
+
+        if (event.ProductAction.TransactionId) {
+            eventAttributes['Transaction Id'] =
+                event.ProductAction.TransactionId;
+        }
+
+        if (
+            event.ProductAction.ProductList &&
+            event.ProductAction.ProductList.length
+        ) {
+            eventAttributes.products = addProducts(
+                event.ProductAction.ProductList
+            );
+        }
+
+        kitLogger(
+            'braze.logPurchase',
+            eventName,
+            event.ProductAction.TotalAmount,
+            event.CurrencyCode,
+            quantity,
+            eventAttributes
+        );
+
+        reportEvent = braze.logPurchase(
+            eventName,
+            event.ProductAction.TotalAmount,
+            event.CurrencyCode,
+            quantity,
+            eventAttributes
+        );
+    }
+
+    function logPurchaseEventPerProduct(event) {
         if (event.ProductAction.ProductList) {
-            event.ProductAction.ProductList.forEach(function (product) {
-                if (product.Attributes == null) {
-                    product.Attributes = {};
-                }
-                product.Attributes['Sku'] = product.Sku;
+            event.ProductAction.ProductList.forEach(function(product) {
+                var productName;
 
-                var sanitizedProductName;
                 if (forwarderSettings.forwardSkuAsProductName === 'True') {
-                    sanitizedProductName = getSanitizedValueForBraze(
-                        String(product.Sku)
-                    );
+                    productName = product.Sku;
                 } else {
-                    sanitizedProductName = getSanitizedValueForBraze(
-                        String(product.Name)
-                    );
+                    productName = product.Name;
+                }
+                var sanitizedProductName = getSanitizedValueForBraze(
+                    productName
+                );
+
+                if (product.Attributes == null) {
+                    product.Attributes = {};
                 }
 
+                product.Attributes['Sku'] = product.Sku;
+
                 var productAttributes = mergeObjects(product.Attributes, {
                     'Transaction Id': event.ProductAction.TransactionId,
                 });
 
-                var sanitizedProperties =
-                    getSanitizedCustomProperties(productAttributes);
+                var sanitizedProperties = getSanitizedCustomProperties(
+                    productAttributes
+                );
 
                 if (sanitizedProperties == null) {
                     return (
@@ -9278,6 +9341,57 @@ var constructor = function () {
         return reportEvent === true;
     }
 
+    function getCommerceEventName(eventType) {
+        const eventNamePrefix = 'eCommerce';
+        let eventName;
+
+        switch (eventType) {
+            case CommerceEventType.ProductAddToCart:
+                eventName = 'add_to_cart';
+                break;
+            case CommerceEventType.ProductRemoveFromCart:
+                eventName = 'remove_from_cart';
+                break;
+            case CommerceEventType.ProductCheckout:
+                eventName = 'checkout';
+                break;
+            case CommerceEventType.ProductCheckoutOption:
+                eventName = 'checkout_option';
+                break;
+            case CommerceEventType.ProductClick:
+                eventName = 'click';
+                break;
+            case CommerceEventType.ProductViewDetail:
+                eventName = 'view_detail';
+                break;
+            case CommerceEventType.ProductPurchase:
+                eventName = 'purchase';
+                break;
+            case CommerceEventType.ProductRefund:
+                eventName = 'refund';
+                break;
+            case CommerceEventType.ProductAddToWishlist:
+                eventName = 'add_to_wishlist';
+                break;
+            case CommerceEventType.ProductRemoveFromWishlist:
+                eventName = 'remove_from_wishlist';
+                break;
+            case CommerceEventType.PromotionView:
+                eventName = 'view';
+                break;
+            case CommerceEventType.PromotionClick:
+                eventName = 'click';
+                break;
+            case CommerceEventType.ProductImpression:
+                eventName = 'Impression';
+                break;
+            default:
+                eventName = 'unknown';
+                break;
+        }
+        return [eventNamePrefix, eventName].join(' - ');
+    }
+
     function logBrazePageViewEvent(event) {
         var sanitizedEventName,
             sanitizedAttrs,
@@ -9402,29 +9516,8 @@ var constructor = function () {
     function processEvent(event) {
         var reportEvent = false;
 
-        if (
-            event.EventDataType == MessageType.Commerce &&
-            event.EventCategory == mParticle.CommerceEventType.ProductPurchase
-        ) {
-            reportEvent = logPurchaseEvent(event);
-        } else if (event.EventDataType == MessageType.Commerce) {
-            var listOfPageEvents =
-                mParticle.eCommerce.expandCommerceEvent(event);
-            if (listOfPageEvents != null) {
-                for (var i = 0; i < listOfPageEvents.length; i++) {
-                    // finalLoopResult keeps track of if any logBrazeEvent in this loop returns true or not
-                    var finalLoopResult = false;
-                    try {
-                        reportEvent = logBrazeEvent(listOfPageEvents[i]);
-                        if (reportEvent === true) {
-                            finalLoopResult = true;
-                        }
-                    } catch (err) {
-                        return 'Error logging page event' + err.message;
-                    }
-                }
-                reportEvent = finalLoopResult === true;
-            }
+        if (event.EventDataType == MessageType.Commerce) {
+            reportEvent = logCommerceEvent(event);
         } else if (event.EventDataType == MessageType.PageEvent) {
             reportEvent = logBrazeEvent(event);
         } else if (event.EventDataType == MessageType.PageView) {
@@ -9444,6 +9537,173 @@ var constructor = function () {
         }
     }
 
+    // mParticle commerce events use different Braze methods depending on if they are
+    // a purchase event or a non-purchase commerce event
+    function logCommerceEvent(event) {
+        if (event.EventCategory === CommerceEventType.ProductPurchase) {
+            reportEvent = logPurchaseEvent(event);
+            return reportEvent === true;
+        } else {
+            reportEvent = logNonPurchaseCommerceEvent(event);
+            return reportEvent === true;
+        }
+    }
+
+    // A non-purchase commerce event can either log a single event with all products
+    // or one event per product when the commerce event is expanded
+    function logNonPurchaseCommerceEvent(event) {
+        if (bundleCommerceEventData) {
+            return logNonPurchaseCommerceEventWithProducts(event);
+        } else {
+            return logExpandedNonPurchaseCommerceEvents(event);
+        }
+    }
+
+    function logNonPurchaseCommerceEventWithProducts(mpEvent) {
+        const commerceEventAttrs = {};
+        const eventName = getCommerceEventName(mpEvent.EventCategory);
+
+        try {
+            switch (mpEvent.EventCategory) {
+                case CommerceEventType.PromotionClick:
+                case CommerceEventType.PromotionView:
+                    commerceEventAttrs.promotions = addPromotions(
+                        mpEvent.PromotionAction
+                    );
+                    break;
+                case CommerceEventType.ProductImpression:
+                    commerceEventAttrs.impressions = addImpressions(
+                        mpEvent.ProductImpressions
+                    );
+                    break;
+                default:
+                    if (mpEvent.ProductAction.ProductList) {
+                        commerceEventAttrs.products = addProducts(
+                            mpEvent.ProductAction.ProductList
+                        );
+                    }
+                    var transactionId = mpEvent.ProductAction.TransactionId;
+                    var totalAmount = mpEvent.ProductAction.TotalAmount;
+                    var taxAmount = mpEvent.ProductAction.TaxAmount;
+                    var shippingAmount = mpEvent.ProductAction.ShippingAmount;
+                    var affiliation = mpEvent.ProductAction.Affiliation;
+
+                    if (transactionId) {
+                        commerceEventAttrs['Transaction Id'] = transactionId;
+                    }
+                    if (totalAmount) {
+                        commerceEventAttrs['Total Amount'] = totalAmount;
+                    }
+                    if (taxAmount) {
+                        commerceEventAttrs['Tax Amount'] = taxAmount;
+                    }
+                    if (shippingAmount) {
+                        commerceEventAttrs['Shipping Amount'] = shippingAmount;
+                    }
+                    if (affiliation) {
+                        commerceEventAttrs['Affiliation'] = affiliation;
+                    }
+            }
+
+            var sanitizedProperties = getSanitizedCustomProperties(
+                mpEvent.EventAttributes
+            );
+
+            const brazeEvent = {
+                EventName: eventName,
+                EventAttributes: mergeObjects(
+                    commerceEventAttrs,
+                    sanitizedProperties
+                ),
+            };
+
+            reportEvent = logBrazeEvent(brazeEvent);
+            return reportEvent;
+        } catch (err) {
+            return 'Error logging commerce event' + err.message;
+        }
+    }
+
+    function addPromotions(promotionAction) {
+        if (promotionAction && promotionAction.PromotionList) {
+            return promotionAction.PromotionList;
+        }
+        return [];
+    }
+
+    function addImpressions(productImpressions) {
+        if (productImpressions.length) {
+            return productImpressions.map(function(impression) {
+                return {
+                    'Product Impression List': impression.ProductImpressionList,
+                    products: addProducts(impression.ProductList),
+                };
+            });
+        } else {
+            return [];
+        }
+    }
+
+    function addProducts(productList) {
+        const productArray = [];
+        if (!productList || productList.length === 0) {
+            return productArray;
+        }
+
+        productList.forEach(function(product) {
+            {
+                var sanitizedProduct = parseProduct(
+                    getSanitizedCustomProperties(product)
+                );
+                productArray.push(sanitizedProduct);
+            }
+        });
+
+        return productArray;
+    }
+
+    function parseProduct(_product) {
+        var product = {};
+
+        for (var key in _product) {
+            switch (key) {
+                case 'Sku':
+                    product.Id = _product[key];
+                    break;
+                case 'CouponCode':
+                    product['Coupon Code'] = _product[key];
+                    break;
+                case 'TotalAmount':
+                    product['Total Product Amount'] = _product[key];
+                    break;
+                default:
+                    product[key] = _product[key];
+            }
+        }
+
+        return product;
+    }
+
+    function logExpandedNonPurchaseCommerceEvents(event) {
+        var listOfPageEvents = mParticle.eCommerce.expandCommerceEvent(event);
+        if (listOfPageEvents !== null) {
+            for (var i = 0; i < listOfPageEvents.length; i++) {
+                // finalLoopResult keeps track of if any logBrazeEvent in this loop returns true or not
+                var finalLoopResult = false;
+                try {
+                    reportEvent = logBrazeEvent(listOfPageEvents[i]);
+                    if (reportEvent === true) {
+                        finalLoopResult = true;
+                    }
+                } catch (err) {
+                    return 'Error logging page event' + err.message;
+                }
+            }
+            reportEvent = finalLoopResult === true;
+        }
+        return reportEvent;
+    }
+
     function removeUserAttribute(key) {
         if (!(key in DefaultAttributeMethods)) {
             var sanitizedKey = getSanitizedValueForBraze(key);
@@ -9600,13 +9860,15 @@ var constructor = function () {
         if (!self.logger) {
             // create a logger
             self.logger = {
-                verbose: function () {},
+                verbose: function() {},
             };
         }
         // eslint-disable-line no-unused-vars
         mpCustomFlags = customFlags;
         try {
             forwarderSettings = settings;
+            bundleCommerceEventData =
+                forwarderSettings.bundleCommerceEventData === 'True';
             reportingService = service;
             // 30 min is Braze default
             options.sessionTimeoutInSeconds =
@@ -9773,7 +10035,7 @@ var constructor = function () {
         var nonMethodArguments = Array.prototype.slice.call(arguments, 1);
         msg += '\n' + method + ':\n';
 
-        nonMethodArguments.forEach(function (arg) {
+        nonMethodArguments.forEach(function(arg) {
             if (isObject(arg) || Array.isArray(arg)) {
                 msg += JSON.stringify(arg);
             } else {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-braze-kit",
-    "version": "4.0.2",
+    "version": "4.1.1",
     "author": "mParticle Developers <developers@mparticle.com> (https://www.mparticle.com)",
     "description": "mParticle integration sdk for Braze",
     "main": "dist/BrazeKit.common.js",