@braze/web-sdk - npm Package Versions

5.1.0

Changed

• The subscribeToFeatureFlagsUpdates() callback will be triggered first with cached feature flags only if this cache is from the current session.

Fixed

• Fixed an issue where in-app messages failed to render a transparent background when using color-scheme.
• Fixed an issue where impressions for a given feature flag ID were limited to once-per-user instead of once-per-session.

4.10.2

Fixed

• Fixed a CSS templating issue in the npm version of the SDK introduced in 4.10.1 that caused in-app messages to display without the expected styles when using Braze built-in UI.

5.0.1

Fixed

• Fixed a bug where toggling noCookies initialization option from true to false did not create all the necessary cookies.
• Fixed an issue where user attributes could not be nulled out by setting a specific null value.

4.10.1

Fixed

• Fixed an issue where user attributes could not be nulled out by setting a specific null value.

5.0.0

⚠️ Breaking

• The subscribeToFeatureFlagsUpdates() callback will now always be called, regardless of refresh success/failure. If there is a failure in receiving updates, the callback will be called with currently cached feature flags.
• The getFeatureFlag() method now returns a null if the feature flag does not exist, or if feature flags are disabled.
• Removed logContentCardsDisplayed() method that was previously deprecated in 4.0.4.
• Removed the deprecated initialization option enableHtmlInAppMessages. This should be replaced with the allowUserSuppliedJavascript option instead.
• Removed Banner class that was previously deprecated in 4.9.0 in favor of ImageOnly.
• Removed ab-banner CSS classname as part of Banner class removal. CSS customizations should instead target the ab-image-only class.
• The SDK no longer throws runtime errors anywhere. If Braze methods are called prior to initialization, a warning will be logged to the console instead.
• The SDK no longer adds default Braze in-app message styles to custom HTML in-app messages. These styles were previously used by legacy in-app message types.

4.10.0

Added

• Added a new appVersionNumber initialization option for targeting via numerical comparison.

Changed

• The SDK now ensures that cached messages for user (content cards, deferred in-app message, and feature flags) are cleared upon changeUser().
• getDeviceId and getUserId now return results directly. Their callback parameters are deprecated and will be removed in a future major version.

4.9.0

Added

• Introduced a new ImageOnly Card subclass, which has the same functionality as the Banner class.
• Added a new ab-image-only CSS class to Banner and ImageOnly cards when displayed through the built-in UI. New CSS customizations should target this class. The ab-banner classname will remain on both card types until the Banner class is removed in a future release.
• Introduced two new methods deferInAppMessage() and getDeferredInAppMessage() that can be used together to delay the display of an in-app message for a future pageload.
  • [deferInAppMessage()] method defers the given in-app message.
  • The deferred in-app message can be retrieved by calling the [getDeferredInAppMessage] method.

Changed

• Deprecated the Banner class.

Fixed

• Fixed an issue where in-app messages with images would fail to display when a parent node is supplied to showInAppMessage() and the parent node has not been attached to the DOM before the display callback is invoked.
• Fixed an issue where the callbacks passed to requestContentCardsRefresh() were sometimes not triggered when this call was queued behind another requestContentCardsRefresh() or subscribeToContentCardsUpdates() request.
• Fixed an issue where dismissCard() did not work as expected on cached content cards.
• Fixed an issue where calling destroy() soonafter wipeData() incorrectly created a device ID cookie.

4.8.3

Fixed

• Fixed an issue where manageServiceWorkerExternally initialization option failed to register service-worker when trying to register from a path higher than the service-worker location.

4.8.2

Fixed

• Fixed an issue where slow / failed image loading prevents subsequent in-app messages from displaying.
• Fixed a regression introduced in 4.8.0 where push notifications failed to display in Safari versions <= 15.

4.8.1

Fixed

• Fixed an issue where content cards were sometimes not marked as read upon card impression.
• Improved the typings for the isControl field on In-App Message and Card classes.