@mparticle/web-braze-kit 4.2.1 → 5.0.1

package/CHANGELOG.md

@@ -2,8 +2,15 @@
 
 --
 
-## 4.2.1 - 2024-10-24
--   fix: Declare reportEvent where previously undeclared [#55](https://github.com/mparticle-integrations/mparticle-javascript-integration-braze/pull/55)
+## 5.0.1 - 2024-11-13
+-   ci: Add esm support [#53](https://github.com/mparticle-integrations/mparticle-javascript-integration-braze/pull/53)
+-   fix: Update package.json to support esm, define missing variable declarations [#54](https://github.com/mparticle-integrations/mparticle-javascript-integration-braze/pull/54)
+
+## 5.0.0 - 2024-10-30
+
+⚠️ **Breaking** - The mParticle web Braze kit now supports Braze's Web SDK v5.5.0.  Breaking changes cna be viewed at [Braze's changelog](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/changelog/#500). There may be API changes that affect you if you call `braze` directly from your code.
+-   feat: Support Braze Web SDK V5 [#52)](https://github.com/mparticle-integrations/mparticle-javascript-integration-braze/pull/52)
+    * 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).
 
 ## 4.2.0 - 2024-10-24
 

package/dist/BrazeKit.common.js

@@ -10019,9 +10019,9 @@ window.braze = require$$0;
 
 // This should remain Appboy and not Braze until the core SDK is able to parse the moduleID and not the name (go.mparticle.com/work/SQDSDKS-4655)
 var name = 'Appboy',
-    suffix = 'v4',
+    suffix = 'v5',
     moduleId = 28,
-    version = '4.2.1',
+    version = '5.0.1',
     MessageType = {
         PageView: 3,
         PageEvent: 4,
@@ -10672,27 +10672,31 @@ var constructor = function () {
     function primeBrazeWebPush() {
         // The following code block is based on Braze's best practice for implementing
         // their push primer.  We only modify it to include pushPrimer and register_inapp settings.
-        // https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration/#soft-push-prompts
+        // https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/soft_push_prompt
         braze.subscribeToInAppMessage(function (inAppMessage) {
             var shouldDisplay = true;
             var pushPrimer = false;
             if (inAppMessage instanceof braze.InAppMessage) {
-                // Read the key-value pair for msg-id
-                var msgId = inAppMessage.extras['msg-id'];
-
-                // If this is our push primer message
-                if (msgId == 'push-primer') {
+                // access the key-value pairs, defined as `extras`
+                const keyValuePairs = inAppMessage.extras || {};
+                // check the value of our key `msg-id` defined in the Braze dashboard
+                if (keyValuePairs['msg-id'] === 'push-primer') {
                     pushPrimer = true;
-                    // We don't want to display the soft push prompt to users on browsers that don't support push, or if the user
-                    // has already granted/blocked permission
+                    // We don't want to display the soft push prompt to users on browsers
+                    // that don't support push, or if the user has already granted/blocked permission
                     if (
-                        !braze.isPushSupported() ||
+                        braze.isPushSupported() === false ||
                         braze.isPushPermissionGranted() ||
                         braze.isPushBlocked()
                     ) {
+                        // do not call `showInAppMessage`
                         shouldDisplay = false;
+                        return;
                     }
-                    if (inAppMessage.buttons[0] != null) {
+
+                    // user is eligible to receive the native prompt
+                    // register a click handler on one of the two buttons
+                    if (inAppMessage.buttons[0]) {
                         // Prompt the user when the first button is clicked
                         inAppMessage.buttons[0].subscribeToClickedEvent(
                             function() {
@@ -10704,6 +10708,7 @@ var constructor = function () {
             }
 
             // Display the message if it's a push primer message and shouldDisplay is true
+            // If it is not a push primer, we should show the message if the setting for register_inapp === 'True'
             if (
                 (pushPrimer && shouldDisplay) ||
                 (!pushPrimer && forwarderSettings.register_inapp === 'True')
@@ -10860,7 +10865,7 @@ var constructor = function () {
             options.sessionTimeoutInSeconds =
                 forwarderSettings.ABKSessionTimeoutKey || 1800;
             options.sdkFlavor = 'mparticle';
-            options.enableHtmlInAppMessages =
+            options.allowUserSuppliedJavascript =
                 forwarderSettings.enableHtmlInAppMessages == 'True';
             options.doNotLoadFontAwesome =
                 forwarderSettings.doNotLoadFontAwesome == 'True';