@braze/web-sdk 6.3.1 → 6.5.0

package/README.md

@@ -8,5 +8,5 @@ Note: The Braze Web SDK is meant to be used client-side in a web application and
 
 See the [Public Github Repo](https://github.com/braze-inc/braze-web-sdk#readme) for getting started instructions or [our documentation pages](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/initial_sdk_setup/) for use-case based documentation.
 
-(c) Braze, Inc. 2025 - http://braze.com  
+(c) Braze, Inc. 2026 - http://braze.com  
 License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE

package/index.d.ts

@@ -1,7 +1,7 @@
 /*
-* Type definitions for @braze/web-sdk v6.3.1
+* Type definitions for @braze/web-sdk v6.5.0
 * Project: https://github.com/braze-inc/braze-web-sdk
-* (c) Braze, Inc. 2025 - http://braze.com
+* (c) Braze, Inc. 2026 - http://braze.com
 * License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE
 */
 
@@ -1668,7 +1668,8 @@ export class Banner {
   /** The placement ID this banner is matched to. */
   placementId: string;
 
-  // intentionally omitting `html` since it's not meant to be accessed by integrators directly.
+  /** HTML to display for the banner. */
+  html: string;
 
   /** Whether this banner is a control banner. */
   isControl: boolean;
@@ -2006,6 +2007,38 @@ export function logContentCardImpressions(contentCards: Card[]): boolean;
  */
 export function logContentCardClick(contentCard: Card): boolean;
 
+/**
+ * Logs that the user saw the given Banners.
+ *    This is done automatically when you use Braze's display module and should only be called
+ *    if you're bypassing that and manually building the DOM for displaying banners in
+ *    your own code.
+ *
+ * @param placementIds - array of placement IDs (strings) that received impressions
+ *
+ * @returns Whether or not the event was successfully logged (to be flushed later).
+ *    Returns undefined if the SDK has not been initialized.
+ */
+export function logBannerImpressions(
+  placementIds: Array<string>,
+): boolean | undefined;
+
+/**
+ * Logs when user clicks on a Banner.
+ *    This is done automatically when you use Braze's display module and should only be called
+ *    if you're bypassing that and manually building the DOM for displaying banners in
+ *    your own code.
+ *
+ * @param banner - the `Banner` object that received a click
+ * @param buttonId - optional button ID if the click was on a specific button within the banner
+ *
+ * @returns Whether or not the event was successfully logged (to be flushed later).
+ *    Returns undefined if the SDK has not been initialized.
+ */
+export function logBannerClick(
+  banner: Banner,
+  buttonId?: string,
+): boolean | undefined;
+
 /**
  * Reports that the current user performed a custom named event.
  *
@@ -2138,7 +2171,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.3/service-worker.js');
+ * self.importScripts('https://js.appboycdn.com/web-sdk/6.5/service-worker.js');
  * ```
  *
  * For more details, see [Our Product Documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
@@ -2561,7 +2594,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.3/service-worker.js');` or by including the content
+   *   `self.importScripts('https://js.appboycdn.com/web-sdk/6.5/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.3.1",
+  "version": "6.5.0",
   "description": "Braze SDK for web sites and other JS platforms.",
   "main": "src/index.js",
   "scripts": {

package/shared-lib/encoding-utils.js

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

package/shared-lib/event-types.js

@@ -1,34 +1,34 @@
-const m = {
+const f = {
     CustomEvent: "ce",
     Pr: "p",
-    uc: "pc",
-    Cc: "ca",
-    wu: "i",
-    pu: "ie",
-    Ut: "cci",
-    Wt: "ccic",
-    Ht: "ccc",
-    Mt: "ccd",
-    Al: "ss",
-    Dl: "se",
-    Gi: "si",
-    $i: "sc",
-    Fi: "sbc",
-    yc: "sfe",
-    zo: "iec",
-    lc: "lr",
-    nc: "uae",
-    mc: "lcaa",
-    dc: "lcar",
-    Gn: "inc",
-    Rn: "add",
-    On: "rem",
-    $n: "set",
-    Bn: "ncam",
-    fc: "sgu",
-    Fr: "ffi",
+    jd: "pc",
+    ev: "ca",
+    Fl: "i",
+    wl: "ie",
+    Xt: "cci",
+    Zt: "ccic",
+    Lt: "ccc",
+    Qt: "ccd",
+    Sm: "ss",
+    hm: "se",
+    wn: "si",
+    zn: "sc",
+    Sn: "sbc",
+    tv: "sfe",
+    om: "iec",
+    yd: "lr",
+    kd: "uae",
+    Dd: "lcaa",
+    Ad: "lcar",
+    Zu: "inc",
+    Qu: "add",
+    Xu: "rem",
+    Yu: "set",
+    Vu: "ncam",
+    $d: "sgu",
+    xo: "ffi",
     ro: "bi",
-    ot: "bc",
+    ut: "bc",
   },
-  Ee = { Mc: "content_cards_displayed" };
-export { m as EventTypes, Ee as InternalEventTypes };
+  Ee = { nv: "content_cards_displayed" };
+export { f as EventTypes, Ee as InternalEventTypes };

package/shared-lib/guid.js

@@ -1,5 +1,5 @@
 const P = {
-  oe: function () {
+  se: function () {
     if ("undefined" != typeof window && window.crypto) {
       if ("function" == typeof window.crypto.randomUUID)
         return window.crypto.randomUUID();

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.Rd = e),
       (this.parent = "undefined" == typeof window ? self : window),
       (this.database = t),
-      (this.vd = e);
+      (this.Rd = e);
   }
-  Dd() {
+  Ud() {
     if ("indexedDB" in this.parent) return this.parent.indexedDB;
   }
   isSupported() {
     var t;
     try {
-      if (null == this.Dd()) return !1;
+      if (null == this.Ud()) return !1;
       {
         const e =
-          null === (t = this.Dd()) || void 0 === t
+          null === (t = this.Ud()) || 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.pd;
+            e = t.chrome || t.browser || t.Od;
           if (e && e.runtime && e.runtime.id)
             return (
-              this.vd.info(
+              this.Rd.info(
                 "Not using IndexedDB for storage because we are running inside an extension",
               ),
               !1
@@ -38,27 +38,27 @@ export default class et {
       }
     } catch (t) {
       return (
-        this.vd.info(
+        this.Rd.info(
           "Not using IndexedDB for storage due to following error: " + t,
         ),
         !1
       );
     }
   }
-  Bd(t, e) {
+  Kd(t, e) {
     var n;
     const o =
-      null === (n = this.Dd()) || void 0 === n
+      null === (n = this.Ud()) || void 0 === n
         ? void 0
-        : n.open(this.database.Sd, this.database.VERSION);
+        : n.open(this.database.Ld, 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.Rd.info(
           "Upgrading indexedDB " +
-            i.database.Sd +
+            i.database.Ld +
             " to v" +
             i.database.VERSION +
             "...",
@@ -77,7 +77,7 @@ export default class et {
         (r.onversionchange = () => {
           r.close(),
             "function" == typeof e && e(),
-            i.vd.error(
+            i.Rd.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.Rd.info(
             "Could not open indexedDB " +
-              i.database.Sd +
+              i.database.Ld +
               " 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.Bd((d) => {
+    return this.Kd((d) => {
       if (!d.objectStoreNames.contains(t))
         return (
-          r.vd.error(
+          r.Rd.error(
             "Could not store object " +
               e +
               " in " +
               t +
               " on indexedDB " +
-              r.database.Sd +
+              r.database.Ld +
               " - " +
               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.Rd.error(
           "Could not store object " +
             e +
             " in " +
             t +
             " on indexedDB " +
-            r.database.Sd,
+            r.database.Ld,
         ),
           "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.Bd((i) => {
+    return this.Kd((i) => {
       if (!i.objectStoreNames.contains(t))
         return (
-          o.vd.error(
+          o.Rd.error(
             "Could not retrieve object " +
               e +
               " in " +
               t +
               " on indexedDB " +
-              o.database.Sd +
+              o.database.Ld +
               " - " +
               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.Rd.error(
           "Could not retrieve object " +
             e +
             " in " +
             t +
             " on indexedDB " +
-            o.database.Sd,
+            o.database.Ld,
         );
       }),
         (d.onsuccess = (t) => {
@@ -180,17 +180,17 @@ export default class et {
         });
     });
   }
-  jr(t, e, n) {
+  kr(t, e, n) {
     if (!this.isSupported()) return "function" == typeof n && n(), !1;
     const o = this;
-    return this.Bd((i) => {
+    return this.Kd((i) => {
       if (!i.objectStoreNames.contains(t))
         return (
-          o.vd.error(
+          o.Rd.error(
             "Could not retrieve last record from " +
               t +
               " on indexedDB " +
-              o.database.Sd +
+              o.database.Ld +
               " - " +
               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.Sd,
+        o.Rd.error(
+          "Could not open cursor for " + t + " on indexedDB " + o.database.Ld,
         ),
           "function" == typeof n && n();
       }),
@@ -216,19 +216,19 @@ export default class et {
         });
     }, n);
   }
-  be(t, e) {
+  je(t, e) {
     if (!this.isSupported()) return !1;
     const n = this;
-    return this.Bd((o) => {
+    return this.Kd((o) => {
       if (!o.objectStoreNames.contains(t))
         return (
-          n.vd.error(
+          n.Rd.error(
             "Could not delete record " +
               e +
               " from " +
               t +
               " on indexedDB " +
-              n.database.Sd +
+              n.database.Ld +
               " - " +
               t +
               " is not a valid objectStore",
@@ -238,13 +238,13 @@ export default class et {
       const i = o.transaction([t], "readwrite");
       i.oncomplete = () => o.close();
       i.objectStore(t).delete(e).onerror = () => {
-        n.vd.error(
+        n.Rd.error(
           "Could not delete record " +
             e +
             " from " +
             t +
             " on indexedDB " +
-            n.database.Sd,
+            n.database.Ld,
         );
       };
     });
@@ -252,14 +252,14 @@ export default class et {
   Ds(t, e) {
     if (!this.isSupported()) return !1;
     const n = this;
-    return this.Bd((o) => {
+    return this.Kd((o) => {
       if (!o.objectStoreNames.contains(t))
         return (
-          n.vd.error(
+          n.Rd.error(
             "Could not retrieve objects from " +
               t +
               " on indexedDB " +
-              n.database.Sd +
+              n.database.Ld +
               " - " +
               t +
               " is not a valid objectStore",
@@ -273,18 +273,18 @@ export default class et {
         s = [];
       (d.onerror = () => {
         s.length > 0
-          ? (n.vd.info(
+          ? (n.Rd.info(
               "Cursor closed midway through for " +
                 t +
                 " on indexedDB " +
-                n.database.Sd,
+                n.database.Ld,
             ),
             e(s))
-          : n.vd.error(
+          : n.Rd.error(
               "Could not open cursor for " +
                 t +
                 " on indexedDB " +
-                n.database.Sd,
+                n.database.Ld,
             );
       }),
         (d.onsuccess = (t) => {
@@ -307,27 +307,27 @@ export default class et {
     for (const e in this.database.Fs) {
       const n = e;
       this.database.Fs.hasOwnProperty(e) &&
-        this.database.Fs[n] !== this.database.Fs.le &&
+        this.database.Fs[n] !== this.database.Fs.be &&
         t.push(this.database.Fs[n]);
     }
     const e = this;
-    return this.Bd(function (n) {
+    return this.Kd(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.Rd.error(
             "Could not clear " +
               this.source.name +
               " on indexedDB " +
-              e.database.Sd,
+              e.database.Ld,
           );
         };
       }
       o.onerror = function () {
-        e.vd.error(
-          "Could not clear object stores on indexedDB " + e.database.Sd,
+        e.Rd.error(
+          "Could not clear object stores on indexedDB " + e.database.Ld,
         );
       };
     });
@@ -335,18 +335,18 @@ export default class et {
 }
 et.Us = {
   Rs: {
-    Sd: "AppboyServiceWorkerAsyncStorage",
+    Ld: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
     Fs: {
-      Tu: "data",
-      hr: "pushClicks",
-      cu: "pushSubscribed",
-      Cd: "fallbackDevice",
+      Ze: "data",
+      vr: "pushClicks",
+      Fu: "pushSubscribed",
+      Gd: "fallbackDevice",
       As: "cardUpdates",
-      le: "optOut",
-      wr: "pendingData",
-      xh: "sdkAuthenticationSignature",
+      be: "optOut",
+      zr: "pendingData",
+      qh: "sdkAuthenticationSignature",
     },
-    me: 1,
+    fe: 1,
   },
 };

package/shared-lib/logger.js

@@ -3,11 +3,11 @@ const E = {
     (void 0 === n && void 0 !== E.zg) || (E.zg = !!n), E.i || (E.i = !0);
   },
   destroy: function () {
-    (E.i = !1), (E.zg = void 0), (E.vd = void 0);
+    (E.i = !1), (E.zg = void 0), (E.Rd = void 0);
   },
   setLogger: function (n) {
     "function" == typeof n
-      ? (E.init(), (E.vd = n))
+      ? (E.init(), (E.Rd = n))
       : E.info("Ignoring setLogger call since logger is not a function");
   },
   toggleLogging: function () {
@@ -19,19 +19,19 @@ const E = {
   info: function (n) {
     if (E.zg) {
       const o = "Braze: " + n;
-      null != E.vd ? E.vd(o) : console.log(o);
+      null != E.Rd ? E.Rd(o) : console.log(o);
     }
   },
   warn: function (n) {
     if (E.zg) {
-      const o = "Braze SDK Warning: " + n + " (v6.3.1)";
-      null != E.vd ? E.vd(o) : console.warn(o);
+      const o = "Braze SDK Warning: " + n + " (v6.5.0)";
+      null != E.Rd ? E.Rd(o) : console.warn(o);
     }
   },
   error: function (n) {
     if (E.zg) {
-      const o = "Braze SDK Error: " + n + " (v6.3.1)";
-      null != E.vd ? E.vd(o) : console.error(o);
+      const o = "Braze SDK Error: " + n + " (v6.5.0)";
+      null != E.Rd ? E.Rd(o) : console.error(o);
     }
   },
 };

package/shared-lib/supported-options.js

@@ -1,27 +1,28 @@
 export default {
-  _o: "allowCrawlerActivity",
-  Ro: "baseUrl",
-  Wo: "noCookies",
-  Vo: "devicePropertyAllowlist",
-  Aa: "disablePushTokenMaintenance",
-  Yo: "enableLogging",
-  Xo: "enableSdkAuthentication",
-  qa: "manageServiceWorkerExternally",
-  Zo: "minimumIntervalBetweenTriggerActionsInSeconds",
-  Wh: "sessionTimeoutInSeconds",
-  Vh: "appVersion",
-  Kh: "appVersionNumber",
-  Ma: "serviceWorkerLocation",
-  ka: "safariWebsitePushId",
-  Xn: "localization",
+  Ph: "allowCrawlerActivity",
+  Wh: "baseUrl",
+  Vh: "noCookies",
+  Kh: "devicePropertyAllowlist",
+  La: "disablePushTokenMaintenance",
+  $h: "enableLogging",
+  Yh: "enableSdkAuthentication",
+  Ka: "manageServiceWorkerExternally",
+  Xh: "minimumIntervalBetweenTriggerActionsInSeconds",
+  Zh: "sessionTimeoutInSeconds",
+  Qh: "appVersion",
+  Xa: "appVersionNumber",
+  Ga: "serviceWorkerLocation",
+  Ia: "safariWebsitePushId",
+  Wa: "localization",
   er: "contentSecurityNonce",
-  re: "allowUserSuppliedJavascript",
-  Jo: "inAppMessageZIndex",
-  Do: "openInAppMessagesInNewTab",
-  Lh: "requireExplicitInAppMessageDismissal",
-  $h: "doNotLoadFontAwesome",
-  Jh: "deviceId",
-  _a: "serviceWorkerScope",
-  Yh: "sdkFlavor",
+  te: "allowUserSuppliedJavascript",
+  $a: "inAppMessageZIndex",
+  Ja: "openInAppMessagesInNewTab",
+  Oh: "requireExplicitInAppMessageDismissal",
+  Za: "doNotLoadFontAwesome",
+  tl: "deviceId",
+  Ha: "serviceWorkerScope",
+  Ne: "dustHost",
+  il: "sdkFlavor",
   tn: "openCardsInNewTab",
 };