@braze/web-sdk 6.11.0 → 6.12.0

package/index.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definitions for @braze/web-sdk v6.11.0
+* Type definitions for @braze/web-sdk v6.12.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
@@ -1652,6 +1652,37 @@ export interface EcommerceEventProperties {
   source: string;
 }
 
+/**
+ * Optional metadata fields shared by `ecommerce.checkout_started` and `ecommerce.order_placed`,
+ * only applicable to Shopify integrations.
+ */
+export interface EcommerceEventMetadata {
+  /**
+   * ISO country code of the market, only applicable to Shopify integrations. Cannot exceed 255 characters in length.
+   */
+  country?: string;
+
+  /**
+   * Handle of the Shopify market, only applicable to Shopify integrations. Cannot exceed 255 characters in length.
+   */
+  market_handle?: string;
+
+  /**
+   * Currency and amount the shopper was charged, only applicable to Shopify integrations.
+   */
+  presentment_currency?: {
+    /**
+     * ISO 4217 currency code of the presentment currency.
+     */
+    code?: string;
+
+    /**
+     * Order total in presentment currency. Shopify stamps this as a string (e.g. `"525.00"`), not a number.
+     */
+    price?: string;
+  };
+}
+
 export interface CheckoutStartedEventProperties
   extends EcommerceEventProperties {
   /**
@@ -1695,7 +1726,7 @@ export interface CheckoutStartedEventProperties
    * 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?: {
+  metadata?: EcommerceEventMetadata & {
     checkout_url?: string;
     [key: string]: any;
   };
@@ -1867,7 +1898,7 @@ export interface OrderPlacedEventProperties extends EcommerceEventProperties {
    * 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?: {
+  metadata?: EcommerceEventMetadata & {
     /**
      * The URL to view the status of the order. Cannot exceed 255 characters in length.
      */
@@ -2559,7 +2590,7 @@ export function logout(
  * - 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.11/service-worker.js');
+ * self.importScripts('https://js.appboycdn.com/web-sdk/6.12/service-worker.js');
  * ```
  *
  * For more details, see [Our Product Documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
@@ -3005,7 +3036,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.11/service-worker.js');` or by including the content
+   *   `self.importScripts('https://js.appboycdn.com/web-sdk/6.12/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.11.0",
+  "version": "6.12.0",
   "description": "Braze SDK for web sites and other JS platforms.",
   "main": "src/index.js",
   "scripts": {

package/shared-lib/event-types.js

@@ -3,8 +3,8 @@ const p = {
     Pr: "p",
     $c: "pc",
     Fc: "ca",
-    kl: "i",
-    fl: "ie",
+    vl: "i",
+    _a: "ie",
     vs: "cci",
     ws: "ccic",
     us: "ccc",
@@ -31,5 +31,5 @@ const p = {
     Nt: "bc",
     Rt: "bd",
   },
-  We = { Gc: "content_cards_displayed" };
-export { p as EventTypes, We as InternalEventTypes };
+  Ee = { Gc: "content_cards_displayed" };
+export { p as EventTypes, Ee as InternalEventTypes };

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

@@ -1,21 +1,21 @@
 export default class et {
   constructor(t, e) {
     (this.database = t),
-      (this.kd = e),
+      (this.Bd = e),
       (this.parent = "undefined" == typeof window ? self : window),
       (this.database = t),
-      (this.kd = e);
+      (this.Bd = e);
   }
-  Kd() {
+  Ud() {
     if ("indexedDB" in this.parent) return this.parent.indexedDB;
   }
   isSupported() {
     var t;
     try {
-      if (null == this.Kd()) return !1;
+      if (null == this.Ud()) return !1;
       {
         const e =
-          null === (t = this.Kd()) || 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.Gd;
+            e = t.chrome || t.browser || t.Od;
           if (e && e.runtime && e.runtime.id)
             return (
-              this.kd.info(
+              this.Bd.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.kd.info(
+        this.Bd.info(
           "Not using IndexedDB for storage due to following error: " + t,
         ),
         !1
       );
     }
   }
-  Wd(t, e) {
+  kd(t, e) {
     var n;
     const o =
-      null === (n = this.Kd()) || void 0 === n
+      null === (n = this.Ud()) || void 0 === n
         ? void 0
-        : n.open(this.database.Jd, this.database.VERSION);
+        : n.open(this.database.Kd, this.database.VERSION);
     if (null == o) return "function" == typeof e && e(), !1;
     const i = this;
     return (
       (o.onupgradeneeded = (t) => {
         var e;
-        i.kd.info(
+        i.Bd.info(
           "Upgrading indexedDB " +
-            i.database.Jd +
+            i.database.Kd +
             " to v" +
             i.database.VERSION +
             "...",
@@ -77,7 +77,7 @@ export default class et {
         (r.onversionchange = () => {
           r.close(),
             "function" == typeof e && e(),
-            i.kd.error(
+            i.Bd.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.kd.info(
+          i.Bd.info(
             "Could not open indexedDB " +
-              i.database.Jd +
+              i.database.Kd +
               " 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.Wd((d) => {
+    return this.kd((d) => {
       if (!d.objectStoreNames.contains(t))
         return (
-          r.kd.error(
+          r.Bd.error(
             "Could not store object " +
               e +
               " in " +
               t +
               " on indexedDB " +
-              r.database.Jd +
+              r.database.Kd +
               " - " +
               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.kd.error(
+        r.Bd.error(
           "Could not store object " +
             e +
             " in " +
             t +
             " on indexedDB " +
-            r.database.Jd,
+            r.database.Kd,
         ),
           "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.Wd((i) => {
+    return this.kd((i) => {
       if (!i.objectStoreNames.contains(t))
         return (
-          o.kd.error(
+          o.Bd.error(
             "Could not retrieve object " +
               e +
               " in " +
               t +
               " on indexedDB " +
-              o.database.Jd +
+              o.database.Kd +
               " - " +
               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.kd.error(
+        o.Bd.error(
           "Could not retrieve object " +
             e +
             " in " +
             t +
             " on indexedDB " +
-            o.database.Jd,
+            o.database.Kd,
         );
       }),
         (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.Wd((i) => {
+    return this.kd((i) => {
       if (!i.objectStoreNames.contains(t))
         return (
-          o.kd.error(
+          o.Bd.error(
             "Could not retrieve last record from " +
               t +
               " on indexedDB " +
-              o.database.Jd +
+              o.database.Kd +
               " - " +
               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.kd.error(
-          "Could not open cursor for " + t + " on indexedDB " + o.database.Jd,
+        o.Bd.error(
+          "Could not open cursor for " + t + " on indexedDB " + o.database.Kd,
         ),
           "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.Wd((o) => {
+    return this.kd((o) => {
       if (!o.objectStoreNames.contains(t))
         return (
-          n.kd.error(
+          n.Bd.error(
             "Could not delete record " +
               e +
               " from " +
               t +
               " on indexedDB " +
-              n.database.Jd +
+              n.database.Kd +
               " - " +
               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.kd.error(
+        n.Bd.error(
           "Could not delete record " +
             e +
             " from " +
             t +
             " on indexedDB " +
-            n.database.Jd,
+            n.database.Kd,
         );
       };
     });
@@ -252,14 +252,14 @@ export default class et {
   Qs(t, e) {
     if (!this.isSupported()) return !1;
     const n = this;
-    return this.Wd((o) => {
+    return this.kd((o) => {
       if (!o.objectStoreNames.contains(t))
         return (
-          n.kd.error(
+          n.Bd.error(
             "Could not retrieve objects from " +
               t +
               " on indexedDB " +
-              n.database.Jd +
+              n.database.Kd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -273,18 +273,18 @@ export default class et {
         s = [];
       (d.onerror = () => {
         s.length > 0
-          ? (n.kd.info(
+          ? (n.Bd.info(
               "Cursor closed midway through for " +
                 t +
                 " on indexedDB " +
-                n.database.Jd,
+                n.database.Kd,
             ),
             e(s))
-          : n.kd.error(
+          : n.Bd.error(
               "Could not open cursor for " +
                 t +
                 " on indexedDB " +
-                n.database.Jd,
+                n.database.Kd,
             );
       }),
         (d.onsuccess = (t) => {
@@ -311,23 +311,23 @@ export default class et {
         t.push(this.database.Ws[n]);
     }
     const e = this;
-    return this.Wd(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.kd.error(
+          e.Bd.error(
             "Could not clear " +
               this.source.name +
               " on indexedDB " +
-              e.database.Jd,
+              e.database.Kd,
           );
         };
       }
       o.onerror = function () {
-        e.kd.error(
-          "Could not clear object stores on indexedDB " + e.database.Jd,
+        e.Bd.error(
+          "Could not clear object stores on indexedDB " + e.database.Kd,
         );
       };
     });
@@ -335,13 +335,13 @@ export default class et {
 }
 et._s = {
   Xs: {
-    Jd: "AppboyServiceWorkerAsyncStorage",
+    Kd: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
     Ws: {
-      pn: "data",
+      Cn: "data",
       yr: "pushClicks",
       Gu: "pushSubscribed",
-      qd: "fallbackDevice",
+      Gd: "fallbackDevice",
       Vs: "cardUpdates",
       pe: "optOut",
       Br: "pendingData",

package/shared-lib/logger.js

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

package/shared-lib/supported-options.js

@@ -4,26 +4,26 @@ export default {
   se: "cookieExpiryInDays",
   Oh: "noCookies",
   Th: "devicePropertyAllowlist",
-  Aa: "disablePushTokenMaintenance",
+  xa: "disablePushTokenMaintenance",
   Rh: "enableLogging",
   Ph: "enableSdkAuthentication",
-  qa: "manageServiceWorkerExternally",
+  wa: "manageServiceWorkerExternally",
   Dh: "minimumIntervalBetweenTriggerActionsInSeconds",
   Lh: "sessionTimeoutInSeconds",
   yh: "appVersion",
   Mh: "appVersionNumber",
-  Ma: "serviceWorkerLocation",
-  ka: "safariWebsitePushId",
-  Ba: "localization",
+  za: "serviceWorkerLocation",
+  ha: "safariWebsitePushId",
+  Ma: "localization",
   sr: "contentSecurityNonce",
   nr: "allowUserSuppliedJavascript",
-  va: "inAppMessageZIndex",
-  ya: "openInAppMessagesInNewTab",
+  ca: "inAppMessageZIndex",
+  da: "openInAppMessagesInNewTab",
   lh: "requireExplicitInAppMessageDismissal",
   Uh: "doNotLoadFontAwesome",
   Wh: "deviceId",
-  _a: "serviceWorkerScope",
-  Ye: "dustHost",
+  ba: "serviceWorkerScope",
+  Oi: "dustHost",
   Bh: "sdkFlavor",
   tn: "openCardsInNewTab",
 };

package/src/DUST/dust-config-store.js

@@ -0,0 +1,89 @@
+import { STORAGE_KEYS as s } from "../managers/storage-manager.js";
+import { Guid as V, logger as b } from "../../shared-lib/index.js";
+export const REFRESH_LOCK_TTL_MS = 2e3;
+export const CONFIG_POLL_INTERVAL_MS = 100;
+const ht = [s.It._i, s.It.Oi, s.It.Gi, s.It.Hi];
+export function isConfigExpired(t) {
+  return !!t && Math.floor(new Date().valueOf() / 1e3) >= t;
+}
+export function isConfigUsable(t) {
+  return Boolean(t.Ki && t.host) && !isConfigExpired(t.expiration);
+}
+export default class lt {
+  constructor(t) {
+    (this.j = t), (this.j = t), (this.Vi = null), (this.Wi = null);
+  }
+  read() {
+    return this.j
+      ? {
+          Ki: this.j.St(s.It._i),
+          host: this.j.St(s.It.Oi),
+          Qi: this.j.St(s.It.Gi),
+          expiration: this.j.St(s.It.Hi),
+        }
+      : { Ki: null, host: null, Qi: null, expiration: null };
+  }
+  write(t) {
+    const i = this.j;
+    i &&
+      (i.Pt(s.It._i, t.Ki),
+      i.Pt(s.It.Oi, t.host),
+      t.Qi ? i.Pt(s.It.Gi, t.Qi) : i.Vt(s.It.Gi),
+      t.expiration ? i.Pt(s.It.Hi, t.expiration) : i.Vt(s.It.Hi));
+  }
+  clear() {
+    const t = this.j;
+    t && (t.Vt(s.It._i), t.Vt(s.It.Oi), t.Vt(s.It.Gi), t.Vt(s.It.Hi));
+  }
+  Yi() {
+    const t = this.j;
+    if (!t) return V.de();
+    const i = t.St(s.It.Zi),
+      e = new Date().valueOf();
+    if (i && "number" == typeof i.e && i.e > e) return null;
+    const n = V.de();
+    t.Pt(s.It.Zi, { t: n, e: e + 2e3 });
+    const r = t.St(s.It.Zi);
+    return r && r.t === n ? n : null;
+  }
+  we(t) {
+    const i = this.j;
+    if (!i) return;
+    const e = i.St(s.It.Zi);
+    (e && e.t !== t) || i.Vt(s.It.Zi);
+  }
+  xe(t, i) {
+    if (this.Vi || null !== this.Wi) return !1;
+    const e = this.read();
+    if (isConfigUsable(e)) return t(e), !0;
+    const s = new Date().valueOf() + 2e3,
+      n = () => {
+        const e = this.read();
+        if (isConfigUsable(e)) return this.Le(), void t(e);
+        new Date().valueOf() >= s &&
+          (this.Le(),
+          b.info(
+            "Timed out waiting for another tab to refresh real-time messaging configuration",
+          ),
+          i());
+      };
+    return (
+      (this.Vi = (t) => {
+        if (t.key)
+          for (let i = 0; i < ht.length; i++)
+            if (0 === t.key.indexOf(ht[i])) return void n();
+      }),
+      window.addEventListener("storage", this.Vi),
+      (this.Wi = window.setInterval(n, 100)),
+      !0
+    );
+  }
+  Le() {
+    this.Vi &&
+      (window.removeEventListener("storage", this.Vi), (this.Vi = null)),
+      null !== this.Wi && (window.clearInterval(this.Wi), (this.Wi = null));
+  }
+  destroy() {
+    this.Le();
+  }
+}

package/src/DUST/dust-connection-core.js

@@ -1,24 +1,10 @@
-export const MIN_BACKOFF_MS = 1e4;
-export const MAX_BACKOFF_MS = 3e5;
-export const BACKOFF_SCALE_FACTOR = 3;
-export const MAX_RETRIES = 5;
-export const CONNECTION_VALID_THRESHOLD_MS = 3e3;
-export function randomInRange(t, e) {
-  return Math.floor(Math.random() * (e - t + 1)) + t;
-}
-export function calculateBackoff(t) {
-  let e = t;
-  return (
-    (null === e || e < 1e4) && (e = 1e4),
-    Math.min(3e5, randomInRange(1e4, 3 * e))
-  );
-}
-export function buildSseUrl(t, e, n, o, r) {
-  const c = /^https?:\/\//i.test(t) ? t : `https://${t}`;
-  let p = `mite=${encodeURIComponent(e)}&attempts=${n}`;
+export const MAX_RETRIES = 15;
+export function buildSseUrl(t, e, n, o, s) {
+  const p = /^https?:\/\//i.test(t) ? t : `https://${t}`;
+  let c = `mite=${encodeURIComponent(e)}&attempts=${n}`;
   return (
-    o && (p += `&auth=${encodeURIComponent(o)}`),
-    r && (p += `&rcs=${encodeURIComponent(r)}`),
-    `${c}/sse?${p}`
+    o && (c += `&auth=${encodeURIComponent(o)}`),
+    s && (c += `&rcs=${encodeURIComponent(s)}`),
+    `${p}/sse?${c}`
   );
 }

package/src/DUST/dust-message-dedup.js

@@ -0,0 +1,33 @@
+import { STORAGE_KEYS as s } from "../managers/storage-manager.js";
+export const MESSAGE_CLAIM_WINDOW_MS = 500;
+const ct = ["ccr", "ffr", "tgr"];
+export default class at {
+  constructor(t) {
+    (this.j = t), (this.j = t);
+  }
+  Mr(t) {
+    const r = this.j;
+    if (
+      !r ||
+      !(function (t) {
+        for (const r of ct) if (r === t) return !0;
+        return !1;
+      })(t)
+    )
+      return !0;
+    const n = new Date().valueOf(),
+      e = r.St(s.It._r);
+    if (e && this.Ir(e[t], n)) return !1;
+    const o = {};
+    if (e) for (const t in e) this.Ir(e[t], n) && (o[t] = e[t]);
+    (o[t] = n), r.Pt(s.It._r, o);
+    const i = r.St(s.It._r);
+    return !i || i[t] === n;
+  }
+  Wr() {
+    this.j && this.j.Vt(s.It._r);
+  }
+  Ir(t, r) {
+    return "number" == typeof t && Math.abs(r - t) < 500;
+  }
+}