@mparticle/web-braze-kit 4.1.2 → 4.2.0

package/CHANGELOG.md

@@ -0,0 +1,93 @@
+## Releases
+
+--
+
+## 4.2.0 - 2024-10-24
+
+-   fix: Report purchase events to mParticle when bundling ecommerce data [#50](https://github.com/mparticle-integrations/mparticle-javascript-integration-braze/pull/50)
+-   feat: Implement Google EU Consent [#51](https://github.com/mparticle-integrations/mparticle-javascript-integration-braze/pull/51)
+
+## 4.1.5 - 2024-05-07
+
+-   fix: Allow any userIdentificationType to be used when initializing kit (#48)
+
+## 4.1.4 - 2024-01-24
+
+-   fix: Forward SKU as product name when ecommerce events are bundled [#47](https://github.com/mparticle-integrations/mparticle-javascript-integration-braze/pull/47)
+
+## 4.1.3 - 2023-09-25
+
+-   fix: Add custom logging for onUserIdentified [#42](https://github.com/mparticle-integrations/mparticle-javascript-integration-braze/pull/42))
+
+## 4.1.2 - 2023-07-25
+
+-   fix: Set MPID before open session ([#41](https://github.com/mparticle-integrations/mparticle-javascript-integration-braze/pull/41))
+
+## 4.1.1 - 2023-06-30
+- fix: Support bundling products, impressions, and promotions as a single event (#36)
+
+## 4.1.0 - 2023-06-28
+- feat: Support bundling products, impressions, and promotions as a single event (#36)
+
+## 4.0.2 - 2023-06-26
+- fix: Update @mparticle/web-sdk version in package.json
+- ci: Update node version (#35)
+- docs: Update readme to include Braze V4 SDK option (#28)
+
+## 4.0.1 - 2023-06-12
+- fix: Add suffix of v4 to forwarder (#21)
+
+## 4.0.0 - 2022-10-19
+
+⚠️ **Breaking** - The mParticle web Braze kit now supports Braze's Web SDK V4.2.1.  
+* Our partner, Braze, has made significant changes to their web SDK.  As a result, we are also updating our mParticle Braze web kit to support Braze’s Web SDK version 4.2.1.  The updated mParticle Braze Web kit will be available via CDN on Feb 15, 2023 and is currently available on npm at @mparticle/web-braze-kit v4.0.0.  
+* There are lots of breaking changes, most notably Braze deprecating the entire `appboy` namespace in favor of `braze`, so please proceed with caution when updating to v4.0.0 via NPM.  If you implement mParticle via snippet, you will have to make changes to your codebase before Feb 15, 2023 to be compatible with both version 3 and version 4 of the Braze SDK to ensure your code continues to work.
+* Full details about the changes and recommended code changes can be found on mParticle's [Braze integration docs page](https://docs.mparticle.com/integrations/braze/event).
+
+#### 3.0.4 - 2022-09-06
+-   fix: Add Transaction Id to Purchase Commerce Events
+
+#### 3.0.3 - 2022-08-24
+-   feat: Add logging for debugging
+
+#### 3.0.2 - 2022-06-16
+-   fix: add register_inapp and pushPrimer variables
+
+#### 3.0.1 - 2022-05-18
+
+-   consume initOptions customFlags - this allows a customer to pass a callback to include additional options that mParticle doesn't support in the UI
+
+#### 3.0.0 - 2022-03-28
+
+⚠️ **Breaking** - If you reference any of the below deprecations and implement mParticle via snippet, you will have to make changes to your codebase before June 8, 2022 to be compatible with both version 2 and version 3 of the Braze SDK to ensure your code continues to work.
+* Our partner, Braze, has made a few significant changes to their web SDK.  As a result, we are also updating our mParticle Braze web kit to support Braze’s Web SDK version 3.5.0, which includes breaking changes to the Braze SDK behavior.  The updated mParticle Braze Web kit will be available via CDN on June 8, 2022 and is currently available on NPM at @mparticle/web-braze-kit v3.0.0.  Also note that we have updated the name of our npm package from @mparticle/web-appboy-kit to @mparticle/web-braze-kit.
+* We highly recommend that you review the changes between version 2 and 3 of the Braze Web SDK to understand these changes, which can be found here.  To summarize:
+  * The `appboy.ab` namespace has been removed and everything lives under the `appboy` namespace now.
+  * `InAppMessage.Button` has been renamed to `InAppMessageButton`
+* Full details can be found in the README at our [AppBoy Repo](https://github.com/mparticle-integrations/mparticle-javascript-integration-appboy#readme).
+
+#### 2.0.7 - 2022-02-09
+
+-   Feat - add new Braze clusters
+
+#### 2.0.6 - 2020-12-10
+
+-   Feat - Add additional Braze clusters to URL mapping table
+
+#### 2.0.5 - 2020-06-04
+
+-   Update Braze to 2.5.2
+
+#### 2.0.4 - 2020-02-12
+
+-   Send SKU if forwardSkuAsProductName is set
+
+#### 2.0.2 - 2020-01-23
+
+-   Feat - Set event name sent to Braze as user provided pageName
+
+#### 2.0.1 - 2019-12-03
+
+-   Bugfix - Respect userId choice in mParticle UI dropdown
+-   Add version number
+-   Remove isObject dependency

package/README.md

@@ -8,8 +8,8 @@ You can now select what version of the Braze SDK you want to use when setting up
 Please review the [Braze Changelog](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/changelog#400) and [V4 migration guide](https://github.com/braze-inc/braze-web-sdk/blob/master/UPGRADE_GUIDE.md) to learn about the differences between V3 and V4 and what changes you will need to make in your code. The most significant breaking changes are the replacement of the `appboy` class name with `braze`, in addition to the removal and renaming of several APIs.
 
 You can opt into the latest major version of the Braze Web SDK whether you implement mParticle's Web SDK using npm or our snippet/CDN.
-* Customers who self-host mParticle via npm - You can use @mparticle/web-braze-kit version 4.0.0 in your package.json now! This has been available since 10/15/2022.
-* Customers who load mParticle via snippet/CDN - Opting in is available via the mParticle UI in your Braze connection settings.
+* Customers who self-host mParticle via npm - You should add @mparticle/web-braze-kit version 4.0.0 or greater in your package.json.  You must also select `Version 4` under `Braze Web SDK Version`  in the Braze connection settings.
+* Customers who load mParticle via snippet/CDN - You must  select `Version 4` under `Braze Web SDK Version`  in the Braze connection settings.
 
 Note that the following is only one example.  Everywhere you manually call `appboy` needs to be updated similar to the below. If you are using NPM, you can skip to step 3.  Please be sure to test your site fully in development prior to releasing.
 
@@ -27,7 +27,7 @@ if (window.appboy) {
 	window.braze.destroyFeed();
 }
 ```
-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 3: Whether you are using the snippet or self hosting, you need to navigate to your Braze connection settings and select `Version 4` from the `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

package/dist/BrazeKit.common.js

@@ -9172,7 +9172,7 @@ window.braze = require$$0;
 var name = 'Appboy',
     suffix = 'v4',
     moduleId = 28,
-    version = '4.1.2',
+    version = '4.2.0',
     MessageType = {
         PageView: 3,
         PageEvent: 4,
@@ -9197,6 +9197,8 @@ var constructor = function () {
         forwarderSettings,
         options = {},
         reportingService,
+        hasConsentMappings,
+        parsedConsentMappings,
         mpCustomFlags;
 
     self.name = name;
@@ -9224,6 +9226,14 @@ var constructor = function () {
     };
 
     var bundleCommerceEventData = false;
+    var forwardSkuAsProductName = false;
+
+    var brazeConsentKeys = [
+        '$google_ad_user_data',
+        '$google_ad_personalization'
+    ];
+
+    var latestUserBrazeConsentString;
 
     // A purchase event can either log a single event with all products
     // or multiple purchase events (one per product)
@@ -9282,6 +9292,8 @@ var constructor = function () {
             quantity,
             eventAttributes
         );
+
+        return reportEvent === true;
     }
 
     function logPurchaseEventPerProduct(event) {
@@ -9289,7 +9301,7 @@ var constructor = function () {
             event.ProductAction.ProductList.forEach(function(product) {
                 var productName;
 
-                if (forwarderSettings.forwardSkuAsProductName === 'True') {
+                if (forwardSkuAsProductName) {
                     productName = product.Sku;
                 } else {
                     productName = product.Name;
@@ -9515,6 +9527,7 @@ var constructor = function () {
     /**************************/
     function processEvent(event) {
         var reportEvent = false;
+        maybeSetConsentBeforeEventLogged(event);
 
         if (event.EventDataType == MessageType.Commerce) {
             reportEvent = logCommerceEvent(event);
@@ -9664,12 +9677,16 @@ var constructor = function () {
 
     function parseProduct(_product) {
         var product = {};
-
         for (var key in _product) {
             switch (key) {
                 case 'Sku':
                     product.Id = _product[key];
                     break;
+                case 'Name':
+                    product.Name = forwardSkuAsProductName
+                        ? _product.Sku
+                        : _product.Name;
+                    break;
                 case 'CouponCode':
                     product['Coupon Code'] = _product[key];
                     break;
@@ -9766,26 +9783,37 @@ var constructor = function () {
 
     // onUserIdentified is not used in version 1 so there is no need to check for version number
     function onUserIdentified(user) {
-        var brazeUserIDType,
-            userIdentities = user.getUserIdentities().userIdentities;
+        kitLogger('calling MpBrazeKit.onUserIdentified');
 
-        if (forwarderSettings.userIdentificationType === 'MPID') {
-            brazeUserIDType = user.getMPID();
-        } else {
-            brazeUserIDType =
-                userIdentities[
-                    forwarderSettings.userIdentificationType.toLowerCase()
-                ];
-        }
+        try {
+            var brazeUserIDType,
+                userIdentities = user.getUserIdentities().userIdentities;
 
-        kitLogger('braze.changeUser', brazeUserIDType);
+            if (forwarderSettings.userIdentificationType === 'MPID') {
+                brazeUserIDType = user.getMPID();
+            } else {
+                brazeUserIDType =
+                    userIdentities[
+                        forwarderSettings.userIdentificationType.toLowerCase()
+                    ];
+            }
 
-        braze.changeUser(brazeUserIDType);
+            if (brazeUserIDType) {
+                kitLogger('braze.changeUser', brazeUserIDType);
+
+                braze.changeUser(brazeUserIDType);
+            }
 
-        if (userIdentities.email) {
-            kitLogger('braze.getUser().setEmail', userIdentities.email);
+            if (userIdentities.email) {
+                kitLogger('braze.getUser().setEmail', userIdentities.email);
 
-            braze.getUser().setEmail(userIdentities.email);
+                braze.getUser().setEmail(userIdentities.email);
+            }
+        } catch (e) {
+            kitLogger(
+                'Error in calling MpBrazeKit.onUserIdentified',
+                e.message
+            );
         }
     }
 
@@ -9845,6 +9873,110 @@ var constructor = function () {
         }
     }
 
+    function prepareInitialConsent(user) {
+        var userConsentState = getUserConsentState(user);
+
+        var currentConsentPayload = generateBrazeConsentStatePayload(
+            userConsentState
+        );
+
+        if (!isEmpty(currentConsentPayload)) {
+            latestUserBrazeConsentString = JSON.stringify(
+                currentConsentPayload
+            );
+
+            setConsentOnBraze(currentConsentPayload);
+        }
+    }
+
+    function setConsentOnBraze(currentConsentPayload) {
+        for (var key in currentConsentPayload) {
+            braze
+                .getUser()
+                .setCustomUserAttribute(key, currentConsentPayload[key]);
+        }
+    }
+
+    function maybeSetConsentBeforeEventLogged(event) {
+        if (latestUserBrazeConsentString && !isEmpty(parsedConsentMappings)) {
+            var eventConsentState = getEventConsentState(event.ConsentState);
+
+            if (!isEmpty(eventConsentState)) {
+                var eventBrazeConsent = generateBrazeConsentStatePayload(
+                    eventConsentState
+                );
+                var eventBrazeConsentAsString = JSON.stringify(
+                    eventBrazeConsent
+                );
+
+                if (
+                    eventBrazeConsentAsString !== latestUserBrazeConsentString
+                ) {
+                    setConsentOnBraze(eventBrazeConsent);
+                    latestUserBrazeConsentString = eventBrazeConsentAsString;
+                }
+            }
+        }
+    }
+
+    function getEventConsentState(eventConsentState) {
+        return eventConsentState && eventConsentState.getGDPRConsentState
+            ? eventConsentState.getGDPRConsentState()
+            : {};
+    }
+
+    function generateBrazeConsentStatePayload(consentState) {
+        if (!parsedConsentMappings) return {};
+
+        var payload = {};
+
+        // These are Braze's consent constants for Braze's Audience Sync to Google
+        // https://www.braze.com/docs/partners/canvas_steps/google_audience_sync
+
+        var googleToBrazeConsentMap = {
+            google_ad_user_data: '$google_ad_user_data',
+            google_ad_personalization: '$google_ad_personalization',
+        };
+
+        for (var i = 0; i <= parsedConsentMappings.length - 1; i++) {
+            var mappingEntry = parsedConsentMappings[i];
+            // Although consent purposes can be inputted into the UI in any casing
+            // the SDK will automatically lowercase them to prevent pseudo-duplicate
+            // consent purposes, so we call `toLowerCase` on the consentMapping purposes here
+            var mpMappedConsentName = mappingEntry.map.toLowerCase();
+            // that mappingEntry.value returned from the server does not have a $ appended, so we have to add it
+            var brazeMappedConsentName =
+                googleToBrazeConsentMap[mappingEntry.value];
+
+            if (
+                consentState[mpMappedConsentName] &&
+                brazeMappedConsentName &&
+                brazeConsentKeys.indexOf(brazeMappedConsentName) !== -1
+            ) {
+                payload[brazeMappedConsentName] =
+                    consentState[mpMappedConsentName].Consented;
+            }
+        }
+
+        return payload;
+    }
+
+    function getUserConsentState(user) {
+        var userConsentState = {};
+
+        var consentState = user.getConsentState();
+
+        if (consentState && consentState.getGDPRConsentState) {
+            userConsentState = consentState.getGDPRConsentState();
+        }
+
+        return userConsentState;
+    }
+
+    function parseConsentSettingsString(consentMappingString) {
+        return JSON.parse(consentMappingString.replace(/&quot;/g, '"'));
+    }
+
     function initForwarder(
         settings,
         service,
@@ -9869,6 +10001,8 @@ var constructor = function () {
             forwarderSettings = settings;
             bundleCommerceEventData =
                 forwarderSettings.bundleCommerceEventData === 'True';
+            forwardSkuAsProductName =
+                forwarderSettings.forwardSkuAsProductName === 'True';
             reportingService = service;
             // 30 min is Braze default
             options.sessionTimeoutInSeconds =
@@ -9889,6 +10023,15 @@ var constructor = function () {
                     forwarderSettings.serviceWorkerLocation;
             }
 
+            if (forwarderSettings.consentMappingSDK) {
+                parsedConsentMappings = parseConsentSettingsString(
+                    forwarderSettings.consentMappingSDK
+                );
+                if (parsedConsentMappings.length) {
+                    hasConsentMappings = true;
+                }
+            }
+
             var cluster =
                 forwarderSettings.cluster ||
                 forwarderSettings.dataCenterLocation;
@@ -9930,10 +10073,19 @@ var constructor = function () {
         braze.addSdkMetadata(['mp']);
         primeBrazeWebPush();
 
-        if (forwarderSettings.userIdentificationType === 'MPID' && mParticle.Identity != null && mParticle.Identity.getCurrentUser().getMPID() != null) {
-            onUserIdentified(mParticle.Identity.getCurrentUser());
+        const currentUser =
+            mParticle.Identity !== null
+                ? mParticle.Identity.getCurrentUser()
+                : null;
+        const mpid = currentUser ? currentUser.getMPID() : null;
+
+        if (currentUser && mpid) {
+            onUserIdentified(currentUser);
+            if (hasConsentMappings) {
+                prepareInitialConsent(currentUser);
+            }
         }
-        
+
         openSession(forwarderSettings);
     }
 
@@ -10120,6 +10272,10 @@ function isObject(val) {
     );
 }
 
+function isEmpty(value) {
+    return value == null || !(Object.keys(value) || value).length;
+}
+
 var BrazeKitDev = {
     register: register,
     getVersion: function () {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-braze-kit",
-    "version": "4.1.2",
+    "version": "4.2.0",
     "author": "mParticle Developers <developers@mparticle.com> (https://www.mparticle.com)",
     "description": "mParticle integration sdk for Braze",
     "main": "dist/BrazeKit.common.js",
@@ -12,7 +12,9 @@
     "scripts": {
         "build": "rollup --config rollup.config.js",
         "watch": "rollup --config rollup.config.js -w",
-        "test": "node test/boilerplate/test-karma.js"
+        "test": "node test/boilerplate/test-karma.js",
+        "watch:tests": "ENVIRONMENT=production rollup --config rollup.test.config.js -w",
+        "test:debug": "npm run build && npm run build:test && DEBUG=true karma start test/karma.config.js"
     },
     "devDependencies": {
         "@rollup/plugin-commonjs": "22.0.1",