@braze/web-sdk 6.7.1 → 6.9.0

package/index.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definitions for @braze/web-sdk v6.7.1
+* Type definitions for @braze/web-sdk v6.9.0
 * Project: https://github.com/braze-inc/braze-web-sdk
 * (c) Braze, Inc. 2026 - http://braze.com
 * License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE
@@ -1585,7 +1585,7 @@ export type PropertiesJson = Partial<
   >
 >;
 
-export interface eCommerceProductProperties {
+export interface EcommerceProductProperties {
   /**
    * A unique identifier for the product, such as product ID or SKU. Cannot exceed 255 characters in length.
    */
@@ -1622,19 +1622,15 @@ export interface eCommerceProductProperties {
   price: number;
 
   /**
-   * Additional metadata about the product. Keys are limited to 255 characters in length, cannot begin with a $ character, 
+   * Additional metadata about the product. Keys are limited to 255 characters in length, cannot begin with a $ character,
    * and can only contain alphanumeric characters and punctuation. Total size of metadata cannot exceed 50KB.
    */
   metadata?: {
-    /**
-     * Shopify SKU, only applicable to Shopify integrations. Cannot exceed 255 characters in length.
-     */
-    sku?: string;
     [key: string]: any;
   };
 }
 
-export interface eCommerceEventProperties {
+export interface EcommerceEventProperties {
   /**
    * Default USD. Currencies should be represented as an ISO 4217 currency code. Supported
    * currency symbols include: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF,
@@ -1657,14 +1653,14 @@ export interface eCommerceEventProperties {
 }
 
 export interface CheckoutStartedEventProperties
-  extends eCommerceEventProperties {
+  extends EcommerceEventProperties {
   /**
    * A unique identifier for the checkout. Cannot exceed 255 characters in length.
    */
   checkout_id: string;
 
   /**
-   * A unique identifier for the cart. If no value is passed, a default value is assumed 
+   * A unique identifier for the cart. If no value is passed, a default value is assumed
    * (shared across cart/checkout/order events) for user cart mapping.
    * Cannot exceed 255 characters in length.
    */
@@ -1675,13 +1671,28 @@ export interface CheckoutStartedEventProperties
    */
   total_value: number;
 
+  /**
+   * Subtotal value of the cart (post-discount, pre-tax/shipping).
+   */
+  subtotal_value?: number;
+
+  /**
+   * Total tax applied to the cart.
+   */
+  tax?: number;
+
+  /**
+   * Total shipping cost for the cart.
+   */
+  shipping?: number;
+
   /**
    * The products associated with the checkout.
    */
-  products: eCommerceProductProperties[];
+  products: EcommerceProductProperties[];
 
   /**
-   * Additional metadata about the checkout. Keys are limited to 255 characters in length, cannot begin with a $ character, 
+   * Additional metadata about the checkout. Keys are limited to 255 characters in length, cannot begin with a $ character,
    * and can only contain alphanumeric characters and punctuation. Total size of metadata cannot exceed 50KB.
    */
   metadata?: {
@@ -1690,34 +1701,75 @@ export interface CheckoutStartedEventProperties
   };
 }
 
-export interface CartUpdatedEventProperties extends eCommerceEventProperties {
+type CartUpdatedBaseProperties = EcommerceEventProperties & {
   /**
-   * A unique identifier for the cart. If no value is passed, a default value is assumed 
+   * A unique identifier for the cart. If no value is passed, a default value is assumed
    * (shared across cart/checkout/order events) for user cart mapping.
    * Cannot exceed 255 characters in length.
    */
   cart_id: string;
 
   /**
-   * The total monetary value of the cart (ex: 12.99).
+   * Subtotal value of the cart (post-discount, pre-tax/shipping).
    */
-  total_value: number;
+  subtotal_value?: number;
+
+  /**
+   * Total tax applied to the cart.
+   */
+  tax?: number;
+
+  /**
+   * Total shipping cost for the cart.
+   */
+  shipping?: number;
 
   /**
    * The products in the updated cart.
    */
-  products: eCommerceProductProperties[];
+  products: EcommerceProductProperties[];
 
   /**
-   * Additional metadata about the cart update. Keys are limited to 255 characters in length, cannot begin with a $ character, 
+   * Additional metadata about the cart update. Keys are limited to 255 characters in length, cannot begin with a $ character,
    * and can only contain alphanumeric characters and punctuation. Total size of metadata cannot exceed 50KB.
    */
   metadata?: {
     [key: string]: any;
   };
-}
+};
 
-export interface ProductViewedEventProperties extends eCommerceEventProperties {
+/**
+ * Properties for the `ecommerce.cart_updated` event.
+ *
+ * `total_value` is required when `action` is `"replace"` or omitted (defaults to `"replace"`).
+ * `total_value` is optional when `action` is `"add"` or `"remove"`.
+ */
+export type CartUpdatedEventProperties =
+  | (CartUpdatedBaseProperties & {
+      /**
+       * The action that triggered the cart update. Defaults to "replace" if not provided.
+       * - "replace": the cart contents were fully replaced (default)
+       */
+      action?: "replace";
+      /**
+       * The total monetary value of the cart (ex: 12.99). Required when action is "replace" or omitted.
+       */
+      total_value: number;
+    })
+  | (CartUpdatedBaseProperties & {
+      /**
+       * The action that triggered the cart update.
+       * - "add": one or more products were added to the cart
+       * - "remove": one or more products were removed from the cart
+       */
+      action: "add" | "remove";
+      /**
+       * The total monetary value of the cart (ex: 12.99). Optional when action is "add" or "remove".
+       */
+      total_value?: number;
+    });
+
+export interface ProductViewedEventProperties extends EcommerceEventProperties {
   /**
    * A unique identifier for the product that was viewed. Cannot exceed 255 characters in length.
    */
@@ -1749,32 +1801,28 @@ export interface ProductViewedEventProperties extends eCommerceEventProperties {
   price: number;
 
   /**
-   * Additional metadata about the product viewed. Keys are limited to 255 characters in length, cannot begin with a $ character, 
+   * A list of types for the product that was viewed. The `back_in_stock` and `price_drop` types can be used to trigger
+   * back-in-stock and price drop notifications. Each type cannot exceed 255 characters in length.
+   */
+  type?: string[];
+
+  /**
+   * Additional metadata about the product viewed. Keys are limited to 255 characters in length, cannot begin with a $ character,
    * and can only contain alphanumeric characters and punctuation. Total size of metadata cannot exceed 50KB.
    */
   metadata?: {
-    /**
-     * Shopify SKU, only applicable to Shopify integrations. Cannot exceed 255 characters in length.
-     */
-    sku?: string;
-
-    /**
-     * A list of types for the product that was viewed. The `back_in_stock` and `price_drop` types can be used to trigger
-     * back-in-stock and price drop notifications. Each type cannot exceed 255 characters in length.
-     */
-    type?: string[];
     [key: string]: any;
   };
 }
 
-export interface OrderPlacedEventProperties extends eCommerceEventProperties {
+export interface OrderPlacedEventProperties extends EcommerceEventProperties {
   /**
    * A unique identifier for the order that was placed. Cannot exceed 255 characters in length.
    */
   order_id: string;
 
   /**
-   * A unique identifier for the cart. If no value is passed, a default value is assumed 
+   * A unique identifier for the cart. If no value is passed, a default value is assumed
    * (shared across cart/checkout/order events) for user cart mapping.
    * Cannot exceed 255 characters in length.
    */
@@ -1785,6 +1833,21 @@ export interface OrderPlacedEventProperties extends eCommerceEventProperties {
    */
   total_value: number;
 
+  /**
+   * Subtotal value of the cart (post-discount, pre-tax/shipping).
+   */
+  subtotal_value?: number;
+
+  /**
+   * Total tax applied to the cart.
+   */
+  tax?: number;
+
+  /**
+   * Total shipping cost for the cart.
+   */
+  shipping?: number;
+
   /**
    * The total amount of discounts applied to the order (ex: 12.99).
    */
@@ -1798,10 +1861,10 @@ export interface OrderPlacedEventProperties extends eCommerceEventProperties {
   /**
    * The products in the order.
    */
-  products: eCommerceProductProperties[];
+  products: EcommerceProductProperties[];
 
   /**
-   * Additional metadata about the product viewed. Keys are limited to 255 characters in length, cannot begin with a $ character, 
+   * Additional metadata about the product viewed. Keys are limited to 255 characters in length, cannot begin with a $ character,
    * and can only contain alphanumeric characters and punctuation. Total size of metadata cannot exceed 50KB.
    */
   metadata?: {
@@ -1826,7 +1889,7 @@ export interface OrderPlacedEventProperties extends eCommerceEventProperties {
     referring_site?: string;
 
     /**
-     * A list of payment system sources (ex: POS, mobile, etc.), only applicable to Shopify integrations. 
+     * A list of payment system sources (ex: POS, mobile, etc.), only applicable to Shopify integrations.
      * Each payment gateway name cannot exceed 255 characters in length.
      */
     payment_gateway_names?: string[];
@@ -1834,6 +1897,22 @@ export interface OrderPlacedEventProperties extends eCommerceEventProperties {
   };
 }
 
+/**
+ * The `name` field selects which eCommerce event is logged,
+ * `properties` must match the corresponding properties interface.
+ */
+export type EcommerceEvent =
+  | {
+      name: "ecommerce.product_viewed";
+      properties: ProductViewedEventProperties;
+    }
+  | { name: "ecommerce.cart_updated"; properties: CartUpdatedEventProperties }
+  | {
+      name: "ecommerce.checkout_started";
+      properties: CheckoutStartedEventProperties;
+    }
+  | { name: "ecommerce.order_placed"; properties: OrderPlacedEventProperties };
+
 export class FeatureFlag {
   /** Indicates whether or not this feature flag is enabled. */
   enabled: boolean;
@@ -1923,6 +2002,28 @@ export class Banner {
   /** Whether this banner is a control banner. */
   isControl: boolean;
 
+  /** Remove all event subscriptions from this banner. */
+  removeAllSubscriptions(): void;
+
+  /**
+   * Remove an event subscription that you previously subscribed to.
+   *
+   * @param subscriptionGuid - The identifier of the subscription you wish to remove, returned by the method
+   *    you initially used to create it.
+   */
+  removeSubscription(subscriptionGuid: string): void;
+
+  /**
+   * Subscribe to receive dismissed events. The subscriber callback will be called whenever this banner is dismissed.
+   *
+   * @param subscriber - The callback function to receive dismissed events. This function will be invoked with
+   *    no arguments when this banner records a dismissal.
+   *
+   * @returns The identifier of the subscription created. This can be passed to `Banner.removeSubscription`
+   *    to cancel the subscription. Returns null if the subscriber passed is not a function.
+   */
+  subscribeToDismissedEvent(subscriber: () => void): string | null;
+
   /**
    * Properties of this object.
    *
@@ -2288,6 +2389,21 @@ export function logBannerClick(
   buttonId?: string,
 ): boolean | undefined;
 
+/**
+ * Dismisses the given Banner.
+ *
+ * Use this when rendering Banners with a custom UI and handling your own close button or dismissal gesture.
+ * The SDK will update its dismissal state, remove the Banner from the active Banner cache, notify
+ * `subscribeToBannersUpdates` subscribers, and sync the dismissal to Braze.
+ *
+ * @param banner - the `Banner` object to dismiss
+ *
+ * @returns `true` if the dismissal event was accepted for logging. Returns `false` if the dismissal was ignored,
+ *    including when no Banner is matched to the placement or when the Banner was already dismissed.
+ *    Returns `undefined` if the SDK has not been initialized.
+ */
+export function dismissBanner(banner: Banner): boolean | undefined;
+
 /**
  * Reports that the current user performed a custom named event.
  *
@@ -2305,6 +2421,17 @@ export function logCustomEvent(
   eventProperties?: object,
 ): boolean;
 
+/**
+ * Logs a typed eCommerce event through the custom event pipeline (`EventTypes.CustomEvent`): `n` is the event
+ * name (e.g. `ecommerce.product_viewed`) and `p` is the validated properties payload. On success, fires the same
+ * custom event trigger as `logCustomEvent` for backwards compatibility.
+ *
+ * @param event - Which eCommerce event to log and its validated properties object.
+ *
+ * @returns Whether the event was successfully queued for later flush.
+ */
+export function logEcommerceEvent(event: EcommerceEvent): boolean;
+
 /**
  * Logs that the user clicked the given in-app message button. This is done automatically when the user clicks on
  *    a button in a message generated by `showInAppMessage`,
@@ -2420,7 +2547,7 @@ export function openSession(): void;
  * - Create a `service-worker.js` file with the content below and place it in the root directory of your website:
  *
  * ```
- * self.importScripts('https://js.appboycdn.com/web-sdk/6.7/service-worker.js');
+ * self.importScripts('https://js.appboycdn.com/web-sdk/6.9/service-worker.js');
  * ```
  *
  * For more details, see [Our Product Documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
@@ -2842,7 +2969,7 @@ export type InitializationOptions = {
    *   lifecycle of, set this option to true and the Braze SDK will not register or unregister a service worker. If you set this
    *   option to true, in order for push to function correctly you must register the service worker yourself BEFORE calling
    *   `requestPushPermission`, and ensure that it contains Braze's service worker code, either with
-   *   `self.importScripts('https://js.appboycdn.com/web-sdk/6.7/service-worker.js');` or by including the content
+   *   `self.importScripts('https://js.appboycdn.com/web-sdk/6.9/service-worker.js');` or by including the content
    *   of that file directly. When this option is true, the `serviceWorkerLocation` option is irrelevant and is ignored.
    */
   manageServiceWorkerExternally?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@braze/web-sdk",
-  "version": "6.7.1",
+  "version": "6.9.0",
   "description": "Braze SDK for web sites and other JS platforms.",
   "main": "src/index.js",
   "scripts": {

package/shared-lib/encoding-utils.js

@@ -1,4 +1,4 @@
-const ui = {
+const ai = {
   Nu: function (t) {
     const r = (t + "=".repeat((4 - (t.length % 4)) % 4))
         .replace(/\-/g, "+")
@@ -9,4 +9,4 @@ const ui = {
     return o;
   },
 };
-export default ui;
+export default ai;

package/shared-lib/event-types.js

@@ -1,35 +1,35 @@
 const p = {
     CustomEvent: "ce",
     Pr: "p",
-    Uc: "pc",
-    ev: "ca",
+    $c: "pc",
+    Fc: "ca",
     gl: "i",
     Ya: "ie",
-    ds: "cci",
-    js: "ccic",
-    os: "ccc",
-    cs: "ccd",
+    vs: "cci",
+    ws: "ccic",
+    us: "ccc",
+    gs: "ccd",
     wm: "ss",
     hm: "se",
     Fn: "si",
     On: "sc",
     Xn: "sbc",
-    tv: "sfe",
+    Lc: "sfe",
     om: "iec",
-    Oc: "lr",
-    Nc: "uae",
-    Kc: "lcaa",
-    Jc: "lcar",
+    Dc: "lr",
+    Ac: "uae",
+    Mc: "lcaa",
+    Cc: "lcar",
     Zu: "inc",
     Qu: "add",
     Xu: "rem",
     Yu: "set",
     Vu: "ncam",
-    Wc: "sgu",
+    Tc: "sgu",
     xo: "ffi",
     ro: "bi",
-    Dt: "bc",
-    Ft: "bd",
+    Nt: "bc",
+    Rt: "bd",
   },
-  Qe = { nv: "content_cards_displayed" };
-export { p as EventTypes, Qe as InternalEventTypes };
+  We = { Gc: "content_cards_displayed" };
+export { p as EventTypes, We as InternalEventTypes };