@braze/web-sdk 6.8.0 → 6.10.0

package/index.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definitions for @braze/web-sdk v6.8.0
+* Type definitions for @braze/web-sdk v6.10.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
@@ -1626,10 +1626,6 @@ export interface EcommerceProductProperties {
    * 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;
   };
 }
@@ -1675,6 +1671,21 @@ 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.
    */
@@ -1698,6 +1709,21 @@ type CartUpdatedBaseProperties = EcommerceEventProperties & {
    */
   cart_id: string;
 
+  /**
+   * 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 in the updated cart.
    */
@@ -1774,21 +1800,17 @@ export interface ProductViewedEventProperties extends EcommerceEventProperties {
    */
   price: number;
 
+  /**
+   * 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;
   };
 }
@@ -1811,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).
    */
@@ -1865,9 +1902,15 @@ export interface OrderPlacedEventProperties extends EcommerceEventProperties {
  * `properties` must match the corresponding properties interface.
  */
 export type EcommerceEvent =
-  | { name: "ecommerce.product_viewed"; properties: ProductViewedEventProperties }
+  | {
+      name: "ecommerce.product_viewed";
+      properties: ProductViewedEventProperties;
+    }
   | { name: "ecommerce.cart_updated"; properties: CartUpdatedEventProperties }
-  | { name: "ecommerce.checkout_started"; properties: CheckoutStartedEventProperties }
+  | {
+      name: "ecommerce.checkout_started";
+      properties: CheckoutStartedEventProperties;
+    }
   | { name: "ecommerce.order_placed"; properties: OrderPlacedEventProperties };
 
 export class FeatureFlag {
@@ -1959,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.
    *
@@ -2324,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.
  *
@@ -2455,6 +2535,18 @@ export function logPurchase(
  */
 export function openSession(): void;
 
+/**
+ * Logs out the current user. This unregisters push for this browser via `unregisterPush`, and on success
+ *    wipes all locally stored SDK data (see `wipeData`) and disables the SDK (see `disableSDK`).
+ *
+ * @param successCallback - When the user is successfully logged out, this callback will be invoked.
+ * @param errorCallback - If the logout fails for unknown reasons, this callback will be invoked.
+ */
+export function logout(
+  successCallback?: () => void,
+  errorCallback?: () => void,
+): void;
+
 /**
  * Register this browser environment to receive web push for this user. Supports browsers which implement the
  *      [W3C Push API](https://developer.mozilla.org/en-US/docs/Web/API/Push_API) (browsers in which
@@ -2467,7 +2559,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.8/service-worker.js');
+ * self.importScripts('https://js.appboycdn.com/web-sdk/6.10/service-worker.js');
  * ```
  *
  * For more details, see [Our Product Documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
@@ -2658,8 +2750,8 @@ export function toggleLogging(): void;
  * Note that for Safari, Apple does not offer any unsubscribe mechanism, so on Safari this method leaves the user
  *    with push permission granted and simply sets their subscription status to unsubscribed.
  *
- * @param successCallback - When the unsubscribe is successfully recorded and processed by Braze, this
- *    callback will be invoked.
+ * @param successCallback - Invoked when unregister processing completes. This includes when push is not supported
+ *    in the browser or the device is already unsubscribed.
  * @param errorCallback - If the unsubscribe fails for unknown reasons, this callback will be invoked.
  */
 export function unregisterPush(
@@ -2889,7 +2981,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.8/service-worker.js');` or by including the content
+   *   `self.importScripts('https://js.appboycdn.com/web-sdk/6.10/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.8.0",
+  "version": "6.10.0",
   "description": "Braze SDK for web sites and other JS platforms.",
   "main": "src/index.js",
   "scripts": {

package/shared-lib/event-types.js

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

package/shared-lib/indexed-db-adapter.js

@@ -1,21 +1,21 @@
 export default class et {
   constructor(t, e) {
     (this.database = t),
-      (this.vd = e),
+      (this.Ud = e),
       (this.parent = "undefined" == typeof window ? self : window),
       (this.database = t),
-      (this.vd = e);
+      (this.Ud = e);
   }
-  Dd() {
+  kd() {
     if ("indexedDB" in this.parent) return this.parent.indexedDB;
   }
   isSupported() {
     var t;
     try {
-      if (null == this.Dd()) return !1;
+      if (null == this.kd()) return !1;
       {
         const e =
-          null === (t = this.Dd()) || void 0 === t
+          null === (t = this.kd()) || void 0 === t
             ? void 0
             : t.open("Braze IndexedDB Support Test");
         if (
@@ -25,10 +25,10 @@ export default class et {
           "undefined" != typeof window)
         ) {
           const t = window,
-            e = t.chrome || t.browser || t.Bd;
+            e = t.chrome || t.browser || t.Kd;
           if (e && e.runtime && e.runtime.id)
             return (
-              this.vd.info(
+              this.Ud.info(
                 "Not using IndexedDB for storage because we are running inside an extension",
               ),
               !1
@@ -38,37 +38,37 @@ export default class et {
       }
     } catch (t) {
       return (
-        this.vd.info(
+        this.Ud.info(
           "Not using IndexedDB for storage due to following error: " + t,
         ),
         !1
       );
     }
   }
-  Cd(t, e) {
+  Gd(t, e) {
     var n;
     const o =
-      null === (n = this.Dd()) || void 0 === n
+      null === (n = this.kd()) || void 0 === n
         ? void 0
-        : n.open(this.database.xd, this.database.VERSION);
+        : n.open(this.database.Hd, this.database.VERSION);
     if (null == o) return "function" == typeof e && e(), !1;
     const i = this;
     return (
       (o.onupgradeneeded = (t) => {
         var e;
-        i.vd.info(
+        i.Ud.info(
           "Upgrading indexedDB " +
-            i.database.xd +
+            i.database.Hd +
             " to v" +
             i.database.VERSION +
             "...",
         );
         const n = null === (e = t.target) || void 0 === e ? void 0 : e.result;
-        for (const t in i.database.Os) {
+        for (const t in i.database.Ws) {
           const e = t;
-          i.database.Os.hasOwnProperty(t) &&
-            !n.objectStoreNames.contains(i.database.Os[e]) &&
-            n.createObjectStore(i.database.Os[e]);
+          i.database.Ws.hasOwnProperty(t) &&
+            !n.objectStoreNames.contains(i.database.Ws[e]) &&
+            n.createObjectStore(i.database.Ws[e]);
         }
       }),
       (o.onsuccess = (n) => {
@@ -77,7 +77,7 @@ export default class et {
         (r.onversionchange = () => {
           r.close(),
             "function" == typeof e && e(),
-            i.vd.error(
+            i.Ud.error(
               "Needed to close the database unexpectedly because of an upgrade in another tab",
             );
         }),
@@ -87,9 +87,9 @@ export default class et {
         var n;
         const o = t;
         return (
-          i.vd.info(
+          i.Ud.info(
             "Could not open indexedDB " +
-              i.database.xd +
+              i.database.Hd +
               " v" +
               i.database.VERSION +
               ": " +
@@ -105,16 +105,16 @@ export default class et {
   setItem(t, e, n, o, i) {
     if (!this.isSupported()) return "function" == typeof i && i(), !1;
     const r = this;
-    return this.Cd((d) => {
+    return this.Gd((d) => {
       if (!d.objectStoreNames.contains(t))
         return (
-          r.vd.error(
+          r.Ud.error(
             "Could not store object " +
               e +
               " in " +
               t +
               " on indexedDB " +
-              r.database.xd +
+              r.database.Hd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -126,13 +126,13 @@ export default class et {
       s.oncomplete = () => d.close();
       const u = s.objectStore(t).put(n, e);
       (u.onerror = () => {
-        r.vd.error(
+        r.Ud.error(
           "Could not store object " +
             e +
             " in " +
             t +
             " on indexedDB " +
-            r.database.xd,
+            r.database.Hd,
         ),
           "function" == typeof i && i();
       }),
@@ -144,16 +144,16 @@ export default class et {
   getItem(t, e, n) {
     if (!this.isSupported()) return !1;
     const o = this;
-    return this.Cd((i) => {
+    return this.Gd((i) => {
       if (!i.objectStoreNames.contains(t))
         return (
-          o.vd.error(
+          o.Ud.error(
             "Could not retrieve object " +
               e +
               " in " +
               t +
               " on indexedDB " +
-              o.database.xd +
+              o.database.Hd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -164,13 +164,13 @@ export default class et {
       r.oncomplete = () => i.close();
       const d = r.objectStore(t).get(e);
       (d.onerror = () => {
-        o.vd.error(
+        o.Ud.error(
           "Could not retrieve object " +
             e +
             " in " +
             t +
             " on indexedDB " +
-            o.database.xd,
+            o.database.Hd,
         );
       }),
         (d.onsuccess = (t) => {
@@ -183,14 +183,14 @@ export default class et {
   kr(t, e, n) {
     if (!this.isSupported()) return "function" == typeof n && n(), !1;
     const o = this;
-    return this.Cd((i) => {
+    return this.Gd((i) => {
       if (!i.objectStoreNames.contains(t))
         return (
-          o.vd.error(
+          o.Ud.error(
             "Could not retrieve last record from " +
               t +
               " on indexedDB " +
-              o.database.xd +
+              o.database.Hd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -202,8 +202,8 @@ export default class et {
       r.oncomplete = () => i.close();
       const d = r.objectStore(t).openCursor(null, "prev");
       (d.onerror = () => {
-        o.vd.error(
-          "Could not open cursor for " + t + " on indexedDB " + o.database.xd,
+        o.Ud.error(
+          "Could not open cursor for " + t + " on indexedDB " + o.database.Hd,
         ),
           "function" == typeof n && n();
       }),
@@ -219,16 +219,16 @@ export default class et {
   ge(t, e) {
     if (!this.isSupported()) return !1;
     const n = this;
-    return this.Cd((o) => {
+    return this.Gd((o) => {
       if (!o.objectStoreNames.contains(t))
         return (
-          n.vd.error(
+          n.Ud.error(
             "Could not delete record " +
               e +
               " from " +
               t +
               " on indexedDB " +
-              n.database.xd +
+              n.database.Hd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -238,28 +238,28 @@ export default class et {
       const i = o.transaction([t], "readwrite");
       i.oncomplete = () => o.close();
       i.objectStore(t).delete(e).onerror = () => {
-        n.vd.error(
+        n.Ud.error(
           "Could not delete record " +
             e +
             " from " +
             t +
             " on indexedDB " +
-            n.database.xd,
+            n.database.Hd,
         );
       };
     });
   }
-  Xs(t, e) {
+  Qs(t, e) {
     if (!this.isSupported()) return !1;
     const n = this;
-    return this.Cd((o) => {
+    return this.Gd((o) => {
       if (!o.objectStoreNames.contains(t))
         return (
-          n.vd.error(
+          n.Ud.error(
             "Could not retrieve objects from " +
               t +
               " on indexedDB " +
-              n.database.xd +
+              n.database.Hd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -273,18 +273,18 @@ export default class et {
         s = [];
       (d.onerror = () => {
         s.length > 0
-          ? (n.vd.info(
+          ? (n.Ud.info(
               "Cursor closed midway through for " +
                 t +
                 " on indexedDB " +
-                n.database.xd,
+                n.database.Hd,
             ),
             e(s))
-          : n.vd.error(
+          : n.Ud.error(
               "Could not open cursor for " +
                 t +
                 " on indexedDB " +
-                n.database.xd,
+                n.database.Hd,
             );
       }),
         (d.onsuccess = (t) => {
@@ -304,45 +304,45 @@ export default class et {
   clearData() {
     if (!this.isSupported()) return !1;
     const t = [];
-    for (const e in this.database.Os) {
+    for (const e in this.database.Ws) {
       const n = e;
-      this.database.Os.hasOwnProperty(e) &&
-        this.database.Os[n] !== this.database.Os.pe &&
-        t.push(this.database.Os[n]);
+      this.database.Ws.hasOwnProperty(e) &&
+        this.database.Ws[n] !== this.database.Ws.pe &&
+        t.push(this.database.Ws[n]);
     }
     const e = this;
-    return this.Cd(function (n) {
+    return this.Gd(function (n) {
       const o = n.transaction(t, "readwrite");
       o.oncomplete = () => n.close();
       for (let n = 0; n < t.length; n++) {
         const i = t[n];
         o.objectStore(i).clear().onerror = function () {
-          e.vd.error(
+          e.Ud.error(
             "Could not clear " +
               this.source.name +
               " on indexedDB " +
-              e.database.xd,
+              e.database.Hd,
           );
         };
       }
       o.onerror = function () {
-        e.vd.error(
-          "Could not clear object stores on indexedDB " + e.database.xd,
+        e.Ud.error(
+          "Could not clear object stores on indexedDB " + e.database.Hd,
         );
       };
     });
   }
 }
-et.Ps = {
-  $s: {
-    xd: "AppboyServiceWorkerAsyncStorage",
+et._s = {
+  Xs: {
+    Hd: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
-    Os: {
-      wn: "data",
+    Ws: {
+      pn: "data",
       yr: "pushClicks",
       Fu: "pushSubscribed",
-      yd: "fallbackDevice",
-      _s: "cardUpdates",
+      Vd: "fallbackDevice",
+      Vs: "cardUpdates",
       pe: "optOut",
       Br: "pendingData",
       wh: "sdkAuthenticationSignature",