@mparticle/web-braze-kit 3.0.5 → 3.0.8

package/README.md

@@ -1,37 +1,18 @@
-![Braze Logo](https://github.com/mparticle-integrations/mparticle-javascript-integration-appboy/blob/master/braze-logo.png)
+![Braze Logo](https://github.com/mparticle-integrations/mparticle-javascript-integration-appboy/blob/master/braze-logo.png) 
 
 ⚠️⚠️⚠️
-# Notice! Timeline for Breaking Changes for mParticle Web Braze Kit- 10/15/2022 - 2/15/2023
-Customers who use mParticle and Braze on their websites may require some code changes due to an update we are making to the mParticle Braze web kit.  The web kit, which previously used v3.5.0 of the Braze web SDK, will use Braze SDK 4.2.1 starting on 2/15/2023 on our CDN.
+# Notice! Opt in is now available for Braze Web SDK V4 - Action Required
 
-* <b>The Braze web SDK has several breaking changes and if you load mParticle via snippet/CDN, you should <a href="#update-to-braze-sdk-version-4-from-version-3---10152022---2152023">follow these instructions to ensure your code continues to work when our changes go live to the CDN on 2/15/2023</a>.  If you self-host mParticle and the Braze Web Kit via npm, you can update sooner. Follow the instructions below whether you self-host or load mParticle via snippet/CDN.</b>.
-* <b>Note that if you are here looking at source code, the `master` branch will continue to contain Braze Web Kit version 3.X until 2/15/2023.  The `braze-v4-npm-master` branch currently contains the source code for v4.X, and this will be merged to `master` on 2/15/2023 to be available via CDN.  </b>
-* If you are using version 2 of the @mparticle/web-appboy-kit, you will need to <a href="#transition-from-mparticleweb-appboy-kit-to-mparticleweb-braze-kit">transition to @mparticle/web-braze-kit per the instructions here</a> before following the below instructions as well.
+You can now select what version of the Braze SDK you want to use when setting up a Braze connection in the mParticle UI.  Braze occasionally makes breaking changes to their SDK, so if you call `appboy` directly in your code, you will have to update your code to ensure your website performs as expected when updating versions of Braze.
 
-## Braze Web Kit Citical Updates and Timelines
+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.
 
-Braze occasionally makes breaking changes to their SDK, so if you call Braze directly in your code, you may have to update your code to ensure your website performs as expected after mParticle updates to the latest Braze SDKs.  This section communicates migration steps for customers to make to their codebase to ensure compatibility.
+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 implement mParticle via NPM and self-host our SDK can choose when they want to update their code and [@mParticle/web-braze-kit version](https://www.npmjs.com/package/@mparticle/web-braze-kit), but customers who implement mParticle via our snippet/CDN must pay close attention to the following timelines and instructions.
+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.
 
-| mParticle Braze Web Kit Version |  Braze SDK Version Supported | Deadline/Date of CDN Release  | Link to Description |
-| ---|---|---|---|
-| v4.0.0 | v4.2.1 | 2/15/2023 | [Link](#update-to-braze-sdk-version-4-from-version-3---10152022---2152023) |
-| v3.0.4 | v3.5.0 | NA | [Link](#transition-from-mparticleweb-appboy-kit-to-mparticleweb-braze-kit) |
-
-### Update to Braze SDK Version 4 from Version 3 - 10/15/2022 - 2/15/2023
-
-Please review [Braze’s Changelog notes](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/changelog#400) as well as Braze’s [migration guide](https://github.com/braze-inc/braze-web-sdk/blob/master/UPGRADE_GUIDE.md) between version 3 and 4 to understand these changes and what code updates are needed from your side.  The largest change is the move from class name `appboy` to `braze`. Braze also removed and renamed some APIs.  As a result, we are also updating our mParticle Braze web kit from 3.0.X to 4.0.X in order to support Braze’s Web SDK version 4.2.1.
-
-We plan to release the updated mParticle Braze Kit on two different time frames depending on how you load mParticle:
-* Customers who self-host mParticle via npm - You will be able to update manually from npm on 10/15/2022
-* Customers who load mParticle via snippet/CDN - We will push an update to the CDN on 2/15/2023 to make it automatically available.
-
-We want to allow our customers to take advantage of the latest from Braze, so we are releasing the kit update via npm earlier.  However, due to the sensitive nature of the breaking changes in Braze’s latest version, we want to give ample notice to all of our customers who are on the CDN since these customers will get the update automatically.  We want to respect the end-of-year code freezes that a lot of our customers have and allow plenty of time to make the required code changes.  Striking this balance is important for us, so if you are on the CDN but need the update sooner, you can [switch to self-hosting on npm](https://docs.mparticle.com/developers/sdk/web/self-hosting/).
-
-If you load mParticle via snippet/CDN, you will have to make changes to your codebase before February 15, 2023 to be compatible with both version 3 and version 4 of the Braze SDK to ensure your code continues to work. We recommend a three-step approach. Here are some code samples of what this code could look like today (step 1), preparing for the update (step 2) and after the change is live (step 3). 
-
-The following recommendations apply only to customers who load mParticle via snippet. Customers who self-host via npm can ignore step 1 and jump straight to step 3 after updating their mParticle Braze kit.  Note that this is only one example.  Everywhere you manually call `appboy` needs to be updated similar to the below, and please refer to the Braze Changelog and migration guide as referenced earlier:
 
 * Step 1: Legacy code sample. Find all the places where your code references the `appboy.display` namespace.  Braze has removed all instances of the `display` namespace:
 ```javascript
@@ -40,8 +21,8 @@ window.appboy.display.destroyFeed();
 
 Step 2: Roll out code changes to be used before February 15, 2023:
 ```javascript
-	if (window.appboy) {
-window.appboy.display.destroyFeed();
+if (window.appboy) {
+	window.appboy.display.destroyFeed();
 } else if (window.braze) {
 	window.braze.destroyFeed();
 }
@@ -64,6 +45,7 @@ The legacy @mparticle/web-appboy-kit from npm includes version 2 of the Braze We
 
 
 
+
 # License
 
 Copyright 2022 mParticle, Inc.

package/dist/BrazeKit.common.js

@@ -304,8 +304,9 @@ window.appboy = appboy_min;
 //  limitations under the License.
 
 var name = 'Appboy',
+    suffix = 'v3',
     moduleId = 28,
-    version = '3.0.5',
+    version = '3.0.8',
     MessageType = {
         PageView: 3,
         PageEvent: 4,
@@ -332,6 +333,7 @@ var constructor = function () {
         mpCustomFlags;
 
     self.name = name;
+    self.suffix = suffix;
 
     var DefaultAttributeMethods = {
         $LastName: 'setLastName',
@@ -729,7 +731,7 @@ var constructor = function () {
         customFlags
     ) {
         console.warn(
-            'mParticle is upgrading the Braze web kit and Braze SDK that you are currently using from V3 to V4 on 2/15/2023.  You will AUTOMATICALLY receive this update if you see this message.  There are many breaking changes if you invoke deprecated Braze SDK methods in your code. Please see https://docs.mparticle.com/integrations/braze/event for more information and necessary upgrade steps to take to ensure code compatibility on 2/15/2023.'
+            'mParticle now supports V4 of the Braze SDK. This is an opt-in update, and we recommend you opt in to get the latest bug fixes and features from Braze.  Please see https://docs.mparticle.com/integrations/braze/event for more information and necessary upgrade steps when you decide to opt in.'
         );
         // check to see if there is a logger for backwards compatibility, and if not, mock one to avoid errors
         if (!self.logger) {
@@ -926,9 +928,11 @@ function getId() {
 }
 
 function register(config) {
+    var forwarderNameWithSuffix = [name, suffix].join('-');
     if (!config) {
         window.console.log(
-            'You must pass a config object to register the kit ' + name
+            'You must pass a config object to register the kit ' +
+                forwarderNameWithSuffix
         );
         return;
     }
@@ -941,17 +945,19 @@ function register(config) {
     }
 
     if (isObject(config.kits)) {
-        config.kits[name] = {
+        config.kits[forwarderNameWithSuffix] = {
             constructor: constructor,
         };
     } else {
         config.kits = {};
-        config.kits[name] = {
+        config.kits[forwarderNameWithSuffix] = {
             constructor: constructor,
         };
     }
     window.console.log(
-        'Successfully registered ' + name + ' to your mParticle configuration'
+        'Successfully registered ' +
+            forwarderNameWithSuffix +
+            ' to your mParticle configuration'
     );
 }
 
@@ -960,6 +966,9 @@ if (window && window.mParticle && window.mParticle.addForwarder) {
         name: name,
         constructor: constructor,
         getId: getId,
+        // A suffix is added if there are multiple different versions of
+        // a client kit.  This matches the suffix in the DB.
+        suffix: suffix,
     });
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-braze-kit",
-    "version": "3.0.5",
+    "version": "3.0.8",
     "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.17.0"
+        "@mparticle/web-sdk": "^2.23.0"
     },
     "license": "Apache-2.0"
 }

package/CHANGELOG.md

@@ -1,54 +0,0 @@
-## Releases
-
---
-
-#### 3.0.5 - 2022-10-20
--   docs: Update README to alert developers about v4 kit upgrade date, add console warning to current CDN users (#15)
-
-#### 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