@braze/web-sdk 5.8.0 → 5.9.0

package/index.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definitions for @braze/web-sdk v5.8.0
+* Type definitions for @braze/web-sdk v5.9.0
 * Project: https://github.com/braze-inc/braze-web-sdk
 * (c) Braze, Inc. 2025 - http://braze.com
 * License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE
@@ -58,7 +58,8 @@ export class DeviceProperties {
 
 /**
  * Abstract base for news feed and Content Cards cards. Use subclasses `ClassicCard`, `CaptionedImage`,
- *   `ImageOnly`, and `ControlCard`.
+ *   `ImageOnly`, and `ControlCard`. For example, you can check `if (card instanceof ClassicCard)` to
+ *   determine if the card is of the type `ClassicCard`.
  */
 export class Card {
   /**
@@ -517,7 +518,8 @@ type CropType =
 
 /**
  *  Abstract base for in-app messages. Use subclasses `SlideUpMessage`,
- *    `ModalMessage`, `FullScreenMessage`, and `HtmlMessage`.
+ *    `ModalMessage`, `FullScreenMessage`, and `HtmlMessage`. For example, you can check `if (message instanceof FullScreenMessage)` to
+ *   determine if the message is of the type `FullScreenMessage`.
  */
 export class InAppMessage {
   static SlideFrom: {
@@ -1446,7 +1448,7 @@ export class User {
   /**
    * Sets the LINE user ID for the user.
    *
-   * @param lineId - Must be a non-empty string no greater than 33 characters in length. 
+   * @param lineId - Must be a non-empty string no greater than 33 characters in length.
    *   Accepts an explicit null value to null out attribute.
    *
    * @returns Whether the update was successfully enqueued.
@@ -2162,7 +2164,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-develop/5.8/service-worker.js');
+ * self.importScripts('https://js.appboycdn.com/web-sdk-develop/5.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).
@@ -2402,8 +2404,8 @@ export function handleBrazeAction(
  * Gets a feature flag by its ID.
  *
  * @param id - The ID of the feature flag.
- * @returns - An object of type `FeatureFlag`, if feature flag with given ID exists. The method returns null if feature flag does not exist,
- *    or if feature flags are disabled. Returns undefined if the SDK has not been initialized.
+ * @returns - An object of type `FeatureFlag`, if feature flag with given ID is enabled or explicitly disabled via experiment or canvas.
+ * The method returns `null` if feature flag is not rolled out to the user or does not exist, or returns `undefined` if the SDK has not been initialized.
  */
 export function getFeatureFlag(id: string): FeatureFlag | null | undefined;
 
@@ -2475,7 +2477,10 @@ export function getBanner(placementId: string): Banner | null | undefined;
  * @param banner - The `Banner` to insert onto the page.
  * @param parentNode - The HTML element to render the banner into.
  */
-export function insertBanner(banner: Banner | null | undefined, parentNode: HTMLElement): void;
+export function insertBanner(
+  banner: Banner | null | undefined,
+  parentNode: HTMLElement,
+): void;
 
 /**
  * Logs that the user clicked the given banner. This should generally be called through the Braze JavaScript bridge
@@ -2630,7 +2635,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-develop/5.8/service-worker.js');` or by including the content
+   *   `self.importScripts('https://js.appboycdn.com/web-sdk-develop/5.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": "5.8.0",
+  "version": "5.9.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 = {
-  Cn: function (t) {
+  qn: function (t) {
     const r = (t + "=".repeat((4 - (t.length % 4)) % 4))
         .replace(/\-/g, "+")
         .replace(/_/g, "/"),

package/shared-lib/event-types.js

@@ -1,36 +1,36 @@
 const d = {
     CustomEvent: "ce",
     Pr: "p",
-    gc: "pc",
+    bc: "pc",
     Ac: "ca",
-    zu: "i",
-    Du: "ie",
-    xt: "cci",
-    $t: "ccic",
-    lt: "ccc",
-    dt: "ccd",
-    Il: "ss",
+    Su: "i",
+    qu: "ie",
+    ts: "cci",
+    rs: "ccic",
+    Mt: "ccc",
+    Wt: "ccd",
+    Fl: "ss",
     Dl: "se",
-    Ir: "si",
-    Mr: "sc",
-    Tr: "sbc",
+    Ki: "si",
+    Li: "sc",
+    Qi: "sbc",
     Mc: "sfe",
-    qo: "iec",
-    fc: "lr",
-    mc: "uae",
-    yt: "ci",
-    ut: "cc",
-    wc: "lcaa",
-    bc: "lcar",
-    Jn: "inc",
-    Mn: "add",
-    Yn: "rem",
-    Hn: "set",
-    Kn: "ncam",
-    kc: "sgu",
+    Do: "iec",
+    vc: "lr",
+    fc: "uae",
+    ss: "ci",
+    Ot: "cc",
+    yc: "lcaa",
+    kc: "lcar",
+    Hn: "inc",
+    On: "add",
+    Gn: "rem",
+    $n: "set",
+    Bn: "ncam",
+    jc: "sgu",
     yr: "ffi",
     ro: "bi",
-    ds: "bc",
+    ct: "bc",
   },
   dr = { Fr: "feed_displayed", Sc: "content_cards_displayed" };
 export { d as EventTypes, dr as InternalEventTypes };

package/shared-lib/guid.js

@@ -1,5 +1,5 @@
-const G = {
-  Rt: function () {
+const K = {
+  ce: function () {
     const t = (t = !1) => {
       const n = (Math.random().toString(16) + "000000000").substr(2, 8);
       return t ? "-" + n.substr(0, 4) + "-" + n.substr(4, 4) : n;
@@ -7,4 +7,4 @@ const G = {
     return t() + t(!0) + t(!0) + t();
   },
 };
-export default G;
+export default K;

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

@@ -1,4 +1,4 @@
-export default class tt {
+export default class st {
   constructor(t, e) {
     (this.database = t),
       (this.vd = e),
@@ -64,11 +64,11 @@ export default class tt {
             "...",
         );
         const n = null === (e = t.target) || void 0 === e ? void 0 : e.result;
-        for (const t in i.database.Ks) {
+        for (const t in i.database.Ms) {
           const e = t;
-          i.database.Ks.hasOwnProperty(t) &&
-            !n.objectStoreNames.contains(i.database.Ks[e]) &&
-            n.createObjectStore(i.database.Ks[e]);
+          i.database.Ms.hasOwnProperty(t) &&
+            !n.objectStoreNames.contains(i.database.Ms[e]) &&
+            n.createObjectStore(i.database.Ms[e]);
         }
       }),
       (o.onsuccess = (n) => {
@@ -216,7 +216,7 @@ export default class tt {
         });
     }, n);
   }
-  me(t, e) {
+  ge(t, e) {
     if (!this.isSupported()) return !1;
     const n = this;
     return this.Bd((o) => {
@@ -249,7 +249,7 @@ export default class tt {
       };
     });
   }
-  Gs(t, e) {
+  Ns(t, e) {
     if (!this.isSupported()) return !1;
     const n = this;
     return this.Bd((o) => {
@@ -304,11 +304,11 @@ export default class tt {
   clearData() {
     if (!this.isSupported()) return !1;
     const t = [];
-    for (const e in this.database.Ks) {
+    for (const e in this.database.Ms) {
       const n = e;
-      this.database.Ks.hasOwnProperty(e) &&
-        this.database.Ks[n] !== this.database.Ks.oe &&
-        t.push(this.database.Ks[n]);
+      this.database.Ms.hasOwnProperty(e) &&
+        this.database.Ms[n] !== this.database.Ms.pe &&
+        t.push(this.database.Ms[n]);
     }
     const e = this;
     return this.Bd(function (n) {
@@ -333,20 +333,20 @@ export default class tt {
     });
   }
 }
-tt._s = {
-  Xs: {
+st.Ls = {
+  Fs: {
     Sd: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
-    Ks: {
-      Su: "data",
+    Ms: {
+      Nu: "data",
       jr: "pushClicks",
       cu: "pushSubscribed",
       Cd: "fallbackDevice",
-      Hs: "cardUpdates",
-      oe: "optOut",
+      Js: "cardUpdates",
+      pe: "optOut",
       kr: "pendingData",
       yh: "sdkAuthenticationSignature",
     },
-    te: 1,
+    be: 1,
   },
 };

package/shared-lib/logger.js

@@ -24,13 +24,13 @@ const N = {
   },
   warn: function (n) {
     if (N.zg) {
-      const o = "Braze SDK Warning: " + n + " (v5.8.0)";
+      const o = "Braze SDK Warning: " + n + " (v5.9.0)";
       null != N.vd ? N.vd(o) : console.warn(o);
     }
   },
   error: function (n) {
     if (N.zg) {
-      const o = "Braze SDK Error: " + n + " (v5.8.0)";
+      const o = "Braze SDK Error: " + n + " (v5.9.0)";
       null != N.vd ? N.vd(o) : console.error(o);
     }
   },

package/shared-lib/supported-options.js

@@ -1,28 +1,28 @@
 export default {
-  Wo: "allowCrawlerActivity",
-  Vo: "baseUrl",
-  Ko: "noCookies",
-  Yo: "devicePropertyAllowlist",
+  Yo: "allowCrawlerActivity",
+  Zo: "baseUrl",
+  Wh: "noCookies",
+  Vh: "devicePropertyAllowlist",
   Da: "disablePushTokenMaintenance",
-  Xo: "enableLogging",
-  Zo: "enableSdkAuthentication",
+  $h: "enableLogging",
+  Yh: "enableSdkAuthentication",
   Ca: "manageServiceWorkerExternally",
-  Qo: "minimumIntervalBetweenTriggerActionsInSeconds",
-  Wh: "sessionTimeoutInSeconds",
-  Vh: "appVersion",
-  $h: "appVersionNumber",
+  Xh: "minimumIntervalBetweenTriggerActionsInSeconds",
+  Zh: "sessionTimeoutInSeconds",
+  Qh: "appVersion",
+  Ea: "appVersionNumber",
   _a: "serviceWorkerLocation",
   Ba: "safariWebsitePushId",
-  Ea: "localization",
+  Zn: "localization",
   er: "contentSecurityNonce",
   re: "allowUserSuppliedJavascript",
-  To: "inAppMessageZIndex",
-  Fo: "openInAppMessagesInNewTab",
+  Go: "inAppMessageZIndex",
+  Ko: "openInAppMessagesInNewTab",
   en: "openNewsFeedCardsInNewTab",
   mh: "requireExplicitInAppMessageDismissal",
-  Yh: "doNotLoadFontAwesome",
-  Xh: "deviceId",
+  Ia: "doNotLoadFontAwesome",
+  Na: "deviceId",
   Aa: "serviceWorkerScope",
-  Zh: "sdkFlavor",
+  Oa: "sdkFlavor",
   tn: "openCardsInNewTab",
 };

package/src/Banner/banner-provider.js

@@ -1,5 +1,5 @@
-import s from "../common/base-provider.js";
-import { STORAGE_KEYS as t } from "../managers/storage-manager.js";
+import t from "../common/base-provider.js";
+import { STORAGE_KEYS as s } from "../managers/storage-manager.js";
 import {
   newBannerFromJson as n,
   newBannerFromSerializedValue as o,
@@ -11,40 +11,40 @@ import u from "../managers/subscription-manager.js";
 import r from "../managers/braze-instance.js";
 import c from "../common/event-logger.js";
 import { EventTypes as d } from "../../shared-lib/event-types.js";
-export default class e extends s {
-  constructor(s, t, i, e) {
+export default class e extends t {
+  constructor(t, s, i, e) {
     super(),
-      (this.B = s),
-      (this.S = t),
+      (this.B = t),
+      (this.S = s),
       (this.C = i),
       (this.T = e),
       (this.banners = {}),
-      (this.B = s),
-      (this.S = t),
+      (this.B = t),
+      (this.S = s),
       (this.C = i),
       (this.T = e),
       (this.R = 10),
       (this.I = null),
       (this.q = null),
-      (this.F = new u()),
-      r.N(this.F),
-      (this.k = null),
-      (this.D = null);
+      (this.D = new u()),
+      r.F(this.D),
+      (this.N = null),
+      (this.k = null);
   }
-  U(s) {
-    if (this.L() && null != s && s.banners) {
+  U(t) {
+    if (this.L() && null != t && t.banners) {
       this.banners = {};
-      const t = s.banners;
-      for (const s in t) {
-        const i = t[s];
+      const s = t.banners;
+      for (const t in s) {
+        const i = s[t];
         let e = null;
         null != i && null != i.banner && (e = n(i.banner)),
-          e && (this.banners[s] = e);
+          e && (this.banners[t] = e);
       }
-      this.M(), this.F.X(this.banners);
+      this.M(), this.D.X(this.banners);
     }
   }
-  $(s, t, i, e = !0) {
+  $(t, s, i, e = !0) {
     var n;
     const r = () => {
       "function" == typeof i && i();
@@ -54,7 +54,7 @@ export default class e extends s {
         null === (n = this.B) ||
         void 0 === n ||
         n.A(() => {
-          this.$(s, t, i);
+          this.$(t, s, i);
         })
       );
     const o = this.S;
@@ -62,7 +62,7 @@ export default class e extends s {
     e && this.G();
     const u = o.H({}, !0),
       c = [];
-    for (const t of s) c.push({ id: t });
+    for (const s of t) c.push({ id: s });
     u.placements = c;
     const d = o.J(u, h.O.K);
     let m = !1;
@@ -78,27 +78,27 @@ export default class e extends s {
             url: `${n.Z()}/banners/sync`,
             headers: d,
             data: u,
-            ss: (s) => {
-              if (!n.ts(u, s, d)) return (m = !0), void r();
-              n.es(), this.U(s), (m = !1), "function" == typeof t && t();
+            tt: (t) => {
+              if (!n.st(u, t, d)) return (m = !0), void r();
+              n.it(), this.U(t), (m = !1), "function" == typeof s && s();
             },
-            error: (s) => {
-              n.ns(s, "retrieving banners"), (m = !0), r();
+            error: (t) => {
+              n.et(t, "retrieving banners"), (m = !0), r();
             },
-            rs: (e, r) => {
+            nt: (e, r) => {
               let o;
-              if (((this.D = s), m)) {
-                let s = this.I;
-                (null == s || s < 1e3 * this.R) && (s = 1e3 * this.R),
-                  (o = Math.min(3e5, a(1e3 * this.R, 3 * s)));
+              if (((this.k = t), m)) {
+                let t = this.I;
+                (null == t || t < 1e3 * this.R) && (t = 1e3 * this.R),
+                  (o = Math.min(3e5, a(1e3 * this.R, 3 * t)));
               }
-              n.os(
+              n.rt(
                 r,
                 () => {
-                  this.$(s, t, i, !1);
+                  this.$(t, s, i, !1);
                 },
                 h.O.K,
-                (s) => this.hs(s),
+                (t) => this.ot(t),
                 () => this.G(),
                 o,
               );
@@ -109,93 +109,96 @@ export default class e extends s {
       i,
     );
   }
-  ls() {
-    return this.D;
+  ht() {
+    return this.k;
   }
-  us(s, t) {
-    const i = { id: s.id };
-    t && (i.bid = t);
-    return c.cs(d.ds, i).ss;
+  lt(t, s) {
+    const i = { id: t.id };
+    s && (i.bid = s);
+    return c.ut(d.ct, i).tt;
   }
   G() {
     null != this.q && (clearTimeout(this.q), (this.q = null));
   }
-  hs(s) {
-    this.G(), (this.q = s);
+  ot(t) {
+    this.G(), (this.q = t);
   }
-  fs() {
-    let s = {};
-    this.C && (s = this.C.vs(t.gs.ps));
+  dt() {
+    let t = {};
+    this.C && (t = this.C.ft(s.gt.vt));
     const i = {};
-    for (const t in s) {
+    for (const s in t) {
       let e = null;
-      null != s[t] && (e = o(s[t])), e && (i[e.placementId] = e);
+      null != t[s] && (e = o(t[s])), e && (i[e.placementId] = e);
     }
     return i;
   }
   M() {
-    var s;
+    var t;
     if (!this.C) return;
     const i = {};
-    for (const t in this.banners) {
+    for (const s in this.banners) {
       const e =
-        (null === (s = this.banners[t]) || void 0 === s ? void 0 : s.bs()) ||
+        (null === (t = this.banners[s]) || void 0 === t ? void 0 : t.bt()) ||
         null;
-      i[t] = e;
+      i[s] = e;
     }
-    this.C.Bs(t.gs.ps, i), this.js();
+    this.C.Bt(s.gt.vt, i), this.jt();
   }
-  js() {
-    var s, i;
-    null === (s = this.C) ||
-      void 0 === s ||
-      s.Bs(t.gs.ys, null === (i = this.T) || void 0 === i ? void 0 : i.Ss());
+  jt() {
+    var t, i;
+    null === (t = this.C) ||
+      void 0 === t ||
+      t.Bt(s.gt.yt, null === (i = this.T) || void 0 === i ? void 0 : i.St());
   }
-  ws() {
-    var s;
+  wt() {
+    var t;
     return (
-      (null === (s = this.C) || void 0 === s ? void 0 : s.vs(t.gs.ys)) || null
+      (null === (t = this.C) || void 0 === t ? void 0 : t.ft(s.gt.yt)) || null
     );
   }
-  Cs() {
-    return this.k;
+  Ct() {
+    return this.N;
   }
-  Ts(s) {
-    this.k = s;
+  Tt(t) {
+    this.N = t;
   }
-  Rs() {
-    var s;
-    const t = null === (s = this.T) || void 0 === s ? void 0 : s.Ss(),
-      i = this.ws();
-    return null != i && t === i;
+  Rt() {
+    var t;
+    const s = null === (t = this.T) || void 0 === t ? void 0 : t.St(),
+      i = this.wt();
+    return null != i && s === i;
   }
-  Is() {
-    var s;
-    const t = null === (s = this.T) || void 0 === s ? void 0 : s.Ss(),
-      i = this.ws();
-    return null == i || t === i;
+  It() {
+    var t;
+    const s = null === (t = this.T) || void 0 === t ? void 0 : t.St(),
+      i = this.wt();
+    return null == i || s === i;
   }
-  qs(s) {
-    return this.F.Fs(s);
+  qt(t) {
+    return this.D.Dt(t);
   }
-  Ns() {
-    var s;
+  Ft() {
+    var t;
     return (
-      (null === (s = this.C) || void 0 === s ? void 0 : s.vs(t.gs.ks)) || {}
+      (null === (t = this.C) || void 0 === t ? void 0 : t.ft(s.gt.Nt)) || {}
     );
   }
-  xs(s) {
-    this.C && this.C.Bs(t.gs.ks, s);
+  kt(t) {
+    this.C && this.C.Bt(s.gt.Nt, t);
   }
   changeUser() {
-    this.zs();
+    this.xt(), this.G();
+  }
+  clearData() {
+    this.G();
   }
   L() {
-    return !!this.B && (!!this.B.Ds() || (0 !== this.B.Us() && this.zs(), !1));
+    return !!this.B && (!!this.B.zt() || (0 !== this.B.Et() && this.xt(), !1));
   }
-  zs() {
+  xt() {
     (this.banners = {}),
-      this.C && (this.C.Es(t.gs.ps), this.C.Es(t.gs.ks)),
-      this.F.X({});
+      this.C && (this.C.Ut(s.gt.vt), this.C.Ut(s.gt.Nt)),
+      this.D.X({});
   }
 }

package/src/Banner/banner.js

@@ -3,28 +3,28 @@ export default class Banner {
     (this.id = t),
       (this.placementId = i),
       (this.html = s),
-      (this.tt = h),
+      (this.At = h),
       (this.isControl = r),
-      (this.it = e),
+      (this.Gt = e),
       (this.id = t),
       (this.placementId = i),
       (this.html = s),
-      (this.tt = h),
+      (this.At = h),
       (this.isControl = r),
-      (this.it = e),
-      (this.st = !1);
+      (this.Gt = e),
+      (this.Ht = !1);
   }
-  ht() {
+  Jt() {
     return this.isControl;
   }
-  bs() {
+  bt() {
     return {
       id: this.id,
       o: this.placementId,
       html: this.html,
-      t: this.tt,
+      t: this.At,
       i: this.isControl,
-      u: this.it,
+      u: this.Gt,
     };
   }
 }