@braze/web-sdk - npm Package Versions

4.0.1

Fixed

• The created field is now set for Card objects when using Content Cards.
• Added "type": "module" to the package.json so frameworks like Next.js recognize the SDK as an ES Module.

4.0.0

⚠️ Breaking

• See our upgrade guide for more information on how to migrate from v3.
• The appboy-web-sdk, @braze/web-sdk-core, and @braze/web-sdk-no-amd npm packages are deprecated in favor of the @braze/web-sdk package and will no longer receive updates.
• The SDK's exported object has been renamed from appboy to braze. CDN users must update their loading snippet when upgrading to 4.0.
• The file name for the bundled version of the SDK has changed to braze.min.js. CDN users must ensure that the URL points to this new file name when upgrading to 4.0.
• The Braze Web SDK now supports importing individual features and methods as native ES Modules that can be tree-shaken. For example, if you only use In-App Messages with a custom UI, you can now import our InAppMessage classes and subscribeToInAppMesssage() and Javascript module bundlers such as webpack will remove any unused code. If you prefer to continue using a compiled version of the SDK, it can be found through our CDN.
• The prefix for SDK logs has changed from Appboy to Braze. If you use the Appboy prefix as a filter in your logging tools, you should update it to include Braze.
• As a result of the above changes, many of our method signatures have changed. See our upgrade guide for more information on how to migrate.
• Dropped support for Internet Explorer.

Changed

• Updated default z-index of InAppMessage to 9001. This can be still be overwritten using the inAppMessageZIndex initialization option.

Added

• Introduced support for the new Braze Actions feature. When displaying In-App Messages and Content Cards through our built-in UI, this feature requires no additional code.
• Added braze.handleBrazeAction() to handle Braze Action URLs when using a custom UI.

3.5.1

Changed

• Added Shopify to BrazeSdkMetadata

3.5.0

Added

• Added appboy.addSdkMetadata() to allow self reporting of SDK Metadata fields via the appboy.BrazeSdkMetadata enum.
• Deprecated the appboy.stopWebTracking() method in favor of using appboy.disableSDK(), which has the same functionality.
• Deprecated the appboy.resumeWebTracking() method in favor of using appboy.enableSDK(), which has the same functionality.
• Added getter method appboy.isDisabled() to determine if SDK has been disabled via appboy.disableSDK().
• Accessibility improvements to in-app messages with scrollable text.

Changed

• Calling changeUser() with an SDK Authentication signature will now update the signature when it is called with the current user's ID.

Fixed

• Fixed an issue where removing the ab-pause-scrolling class was not sufficient to allow scrolling on touchscreen devices during the display of an in-app message.

3.4.1

Fixed

• Fixed an issue introduced in 3.3.0 where event timestamps could become incorrect when a network request fails and the event is placed back in the queue.

3.4.0

Added

• Added User.addToSubscriptionGroup() and User.removeFromSubscriptionGroup() to manage SMS/Email Subscription Groups.

Changed

• Cards with subclass ControlCard are no longer counted in Feed.getUnreadCardCount or ContentCards.getUnviewedCardCount.

Fixed

• Fixed an issue where globally-scoped CSS could cause the text and close button of In-App Messages to display incorrectly when using the built-in UI.
• Fixed an accessibility issue with Content Cards where some feed children did not have the article role.
• Fixed an issue where service worker network requests, including push click analytics, could not be made when SDK Authentication is enabled. If SDK Authentication is enabled and the service worker does not have a valid authentication signature, push click analytics will now be sent to the backend on the user's next session.
• Fixed an issue where network requests that failed due to SDK Authentication errors did not use exponential backoff for retries.
• Fixed an issue where iPads would be detected as Mac devices when using the "Request Desktop Site" iOS feature.
• Fixed an issue where aspectRatio had an incorrect type in Card subclasses.

3.3.0

Added

• Introduced support for new SDK Authentication feature.
• Introduced an inAppMessageZIndex initialization option that allows you to easily customize the z-index of In-App Messages displayed by the built-in UI.
• Added successCallback and errorCallback parameters to requestContentCardsRefresh.
• The SDK now logs deprecation warnings for deprecated methods and initialization options when logging is enabled.
• Added support for brazeBridge, which has the same API as appboyBridge. appboyBridge is now deprecated but will continue to function.
• Introduced support for the upcoming nested properties feature in appboy.logCustomEvent and appboy.logPurchase.

Changed

• Removed appboyQueue replay snippet from the npm publication of the SDK. This avoids possible race conditions when referencing the SDK simultaneously from npm and the CDN, and removes use of eval from the npm package
• appboy.logCustomEvent and appboy.logPurchase now impose a 50KB limit on custom properties. If the supplied properties are too large, the event is not logged.
• Deprecated the trackLocation method in favor of using the native Geolocation API and passing the location data to 'User.setLastKnownLocation`. See our public docs for more information.
• Deprecated the enableHtmlInAppMessages initialization option in favor of allowUserSuppliedJavascript. These options are functionally equivalent and no other changes are required.

Fixed

• Fixed incorrect typing for User.setCountry.
• Added missing dismissed property to TypeScript definition and docs for Card subclasses.

3.2.0

Added

• Added an optional parentNode parameter to appboy.display.hideContentCards that allows you to specify a particular Content Cards feed to hide.

Changed

• Cookies set by the SDK are now renewed when a new session is started. This fixes an issue where the SDK would stop setting cookies that had been deleted or expired when identification information existed in localStorage, preventing cross-subdomain identification from functioning in certain circumstances.
• Increased clickable area of all buttons in the built-in UI to be at least 45x45px to comply with mobile accessibility best-practices. This includes some minor changes to the Content Cards and News Feed UI to accommodate the larger buttons.

Fixed

• Fixed an issue where some network requests fail on websites using certain libraries that overwrite the native Promise object.

3.1.2

Fixed

• Added default alt text to In-App Message and Content Card images to improve screen-reader experience.
• Improved the display of different aspect ratios for ClassicCard images when using the built-in UI.
• Fixed a regression introduced in 3.1.0 where the SDK would sometimes make multiple network requests when starting a new session.
• Fixed an issue where globally-scoped float CSS caused certain elements of the built-in UI to display incorrectly.
• Fixed an incorrect TypeScript definition for DeviceProperties.

3.1.1

Fixed

• Fixed an issue where a javascript error could be thrown when showing Content Cards or In-App Messages in certain environments where this is undefined.