@braze/web-sdk 5.6.1 → 5.8.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. 2024 - http://braze.com  
+(c) Braze, Inc. 2025 - 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 v5.6.1
+* Type definitions for @braze/web-sdk v5.8.0
 * Project: https://github.com/braze-inc/braze-web-sdk
-* (c) Braze, Inc. 2024 - http://braze.com
+* (c) Braze, Inc. 2025 - http://braze.com
 * License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE
 */
 
@@ -1442,6 +1442,16 @@ export class User {
   setPushNotificationSubscriptionType(
     notificationSubscriptionType: NotificationSubscriptionTypes,
   ): boolean;
+
+  /**
+   * Sets the LINE user ID for the user.
+   *
+   * @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.
+   */
+  setLineId(lineId: string | null): boolean;
 }
 
 export class InAppMessageButton {
@@ -2152,7 +2162,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.6/service-worker.js');
+ * self.importScripts('https://js.appboycdn.com/web-sdk-develop/5.8/service-worker.js');
  * ```
  *
  * For more details, see [Our Product Documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
@@ -2465,7 +2475,7 @@ 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, 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
@@ -2620,7 +2630,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.6/service-worker.js');` or by including the content
+   *   `self.importScripts('https://js.appboycdn.com/web-sdk-develop/5.8/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.6.1",
+  "version": "5.8.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 = {
-  Jn: function (t) {
+  Cn: 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",
-    mc: "pc",
-    Cc: "ca",
-    Mu: "i",
-    Li: "ie",
+    gc: "pc",
+    Ac: "ca",
+    zu: "i",
+    Du: "ie",
     xt: "cci",
     $t: "ccic",
     lt: "ccc",
     dt: "ccd",
-    Jl: "ss",
-    Gl: "se",
-    Nr: "si",
-    Cr: "sc",
-    Or: "sbc",
-    yc: "sfe",
-    zo: "iec",
-    dc: "lr",
-    cc: "uae",
+    Il: "ss",
+    Dl: "se",
+    Ir: "si",
+    Mr: "sc",
+    Tr: "sbc",
+    Mc: "sfe",
+    qo: "iec",
+    fc: "lr",
+    mc: "uae",
     yt: "ci",
     ut: "cc",
-    vc: "lcaa",
-    gc: "lcar",
-    fu: "inc",
-    pu: "add",
-    bu: "rem",
-    au: "set",
-    du: "ncam",
-    bc: "sgu",
+    wc: "lcaa",
+    bc: "lcar",
+    Jn: "inc",
+    Mn: "add",
+    Yn: "rem",
+    Hn: "set",
+    Kn: "ncam",
+    kc: "sgu",
     yr: "ffi",
     ro: "bi",
-    fs: "bc",
+    ds: "bc",
   },
-  dr = { Fr: "feed_displayed", Mc: "content_cards_displayed" };
+  dr = { Fr: "feed_displayed", Sc: "content_cards_displayed" };
 export { d as EventTypes, dr as InternalEventTypes };

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

@@ -1,4 +1,4 @@
-export default class it {
+export default class tt {
   constructor(t, e) {
     (this.database = t),
       (this.vd = e),
@@ -64,11 +64,11 @@ export default class it {
             "...",
         );
         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.Ks) {
           const e = t;
-          i.database.Os.hasOwnProperty(t) &&
-            !n.objectStoreNames.contains(i.database.Os[e]) &&
-            n.createObjectStore(i.database.Os[e]);
+          i.database.Ks.hasOwnProperty(t) &&
+            !n.objectStoreNames.contains(i.database.Ks[e]) &&
+            n.createObjectStore(i.database.Ks[e]);
         }
       }),
       (o.onsuccess = (n) => {
@@ -180,7 +180,7 @@ export default class it {
         });
     });
   }
-  jr(t, e, n) {
+  cr(t, e, n) {
     if (!this.isSupported()) return "function" == typeof n && n(), !1;
     const o = this;
     return this.Bd((i) => {
@@ -249,7 +249,7 @@ export default class it {
       };
     });
   }
-  Hs(t, e) {
+  Gs(t, e) {
     if (!this.isSupported()) return !1;
     const n = this;
     return this.Bd((o) => {
@@ -304,11 +304,11 @@ export default class it {
   clearData() {
     if (!this.isSupported()) return !1;
     const t = [];
-    for (const e in this.database.Os) {
+    for (const e in this.database.Ks) {
       const n = e;
-      this.database.Os.hasOwnProperty(e) &&
-        this.database.Os[n] !== this.database.Os.ie &&
-        t.push(this.database.Os[n]);
+      this.database.Ks.hasOwnProperty(e) &&
+        this.database.Ks[n] !== this.database.Ks.oe &&
+        t.push(this.database.Ks[n]);
     }
     const e = this;
     return this.Bd(function (n) {
@@ -333,20 +333,20 @@ export default class it {
     });
   }
 }
-it.Gs = {
-  _s: {
+tt._s = {
+  Xs: {
     Sd: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
-    Os: {
-      Xu: "data",
-      hr: "pushClicks",
+    Ks: {
+      Su: "data",
+      jr: "pushClicks",
       cu: "pushSubscribed",
       Cd: "fallbackDevice",
-      Ks: "cardUpdates",
-      ie: "optOut",
-      $r: "pendingData",
+      Hs: "cardUpdates",
+      oe: "optOut",
+      kr: "pendingData",
       yh: "sdkAuthenticationSignature",
     },
-    oe: 1,
+    te: 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.6.1)";
+      const o = "Braze SDK Warning: " + n + " (v5.8.0)";
       null != N.vd ? N.vd(o) : console.warn(o);
     }
   },
   error: function (n) {
     if (N.zg) {
-      const o = "Braze SDK Error: " + n + " (v5.6.1)";
+      const o = "Braze SDK Error: " + n + " (v5.8.0)";
       null != N.vd ? N.vd(o) : console.error(o);
     }
   },

package/shared-lib/supported-options.js

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

package/src/Banner/banner-provider.js

@@ -68,33 +68,40 @@ export default class e extends s {
     let m = !1;
     o.V(
       u,
-      (n = -1) => {
-        if (!this.S) return void r();
+      (e = -1) => {
+        const n = this.S;
+        if (!n) return void r();
         const o = new Date().valueOf();
         h.W(this.C, h.O.K, o),
-          -1 !== n && d.push(["X-Braze-Req-Tokens-Remaining", n.toString()]),
+          -1 !== e && d.push(["X-Braze-Req-Tokens-Remaining", e.toString()]),
           l.Y({
-            url: `${this.S.Z()}/banners/sync`,
+            url: `${n.Z()}/banners/sync`,
             headers: d,
             data: u,
             ss: (s) => {
-              if (!this.S.ts(u, s, d)) return (m = !0), void r();
-              this.S.es(),
-                this.U(s),
-                (m = !1),
-                h.ns(this.C, h.O.K, 1),
-                "function" == typeof t && t();
+              if (!n.ts(u, s, d)) return (m = !0), void r();
+              n.es(), this.U(s), (m = !1), "function" == typeof t && t();
             },
             error: (s) => {
-              this.S.rs(s, "retrieving banners"), (m = !0), r();
+              n.ns(s, "retrieving banners"), (m = !0), r();
             },
-            os: () => {
-              if (((this.D = s), e && m && !this.q)) {
-                h.hs(this.C, h.O.K);
-                let e = this.I;
-                (null == e || e < 1e3 * this.R) && (e = 1e3 * this.R),
-                  this.ls(s, t, i, Math.min(3e5, a(1e3 * this.R, 3 * e)));
+            rs: (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)));
               }
+              n.os(
+                r,
+                () => {
+                  this.$(s, t, i, !1);
+                },
+                h.O.K,
+                (s) => this.hs(s),
+                () => this.G(),
+                o,
+              );
             },
           });
       },
@@ -102,27 +109,23 @@ export default class e extends s {
       i,
     );
   }
-  us() {
+  ls() {
     return this.D;
   }
-  cs(s, t) {
+  us(s, t) {
     const i = { id: s.id };
     t && (i.bid = t);
-    return c.ds(d.fs, i).ss;
+    return c.cs(d.ds, i).ss;
   }
   G() {
     null != this.q && (clearTimeout(this.q), (this.q = null));
   }
-  ls(s, t, i, e = 1e3 * this.R) {
-    this.G(),
-      (this.q = window.setTimeout(() => {
-        this.$(s, t, i);
-      }, e)),
-      (this.I = e);
+  hs(s) {
+    this.G(), (this.q = s);
   }
-  vs() {
+  fs() {
     let s = {};
-    this.C && (s = this.C.ps(t.bs.gs));
+    this.C && (s = this.C.vs(t.gs.ps));
     const i = {};
     for (const t in s) {
       let e = null;
@@ -136,63 +139,63 @@ export default class e extends s {
     const i = {};
     for (const t in this.banners) {
       const e =
-        (null === (s = this.banners[t]) || void 0 === s ? void 0 : s.Bs()) ||
+        (null === (s = this.banners[t]) || void 0 === s ? void 0 : s.bs()) ||
         null;
       i[t] = e;
     }
-    this.C.js(t.bs.gs, i), this.ws();
+    this.C.Bs(t.gs.ps, i), this.js();
   }
-  ws() {
+  js() {
     var s, i;
     null === (s = this.C) ||
       void 0 === s ||
-      s.js(t.bs.ys, null === (i = this.T) || void 0 === i ? void 0 : i.Ss());
+      s.Bs(t.gs.ys, null === (i = this.T) || void 0 === i ? void 0 : i.Ss());
   }
-  Cs() {
+  ws() {
     var s;
     return (
-      (null === (s = this.C) || void 0 === s ? void 0 : s.ps(t.bs.ys)) || null
+      (null === (s = this.C) || void 0 === s ? void 0 : s.vs(t.gs.ys)) || null
     );
   }
-  Ts() {
+  Cs() {
     return this.k;
   }
-  Rs(s) {
+  Ts(s) {
     this.k = s;
   }
-  Is() {
+  Rs() {
     var s;
     const t = null === (s = this.T) || void 0 === s ? void 0 : s.Ss(),
-      i = this.Cs();
+      i = this.ws();
     return null != i && t === i;
   }
-  qs() {
+  Is() {
     var s;
     const t = null === (s = this.T) || void 0 === s ? void 0 : s.Ss(),
-      i = this.Cs();
+      i = this.ws();
     return null == i || t === i;
   }
-  Fs(s) {
-    return this.F.Ns(s);
+  qs(s) {
+    return this.F.Fs(s);
   }
-  ks() {
+  Ns() {
     var s;
     return (
-      (null === (s = this.C) || void 0 === s ? void 0 : s.ps(t.bs.xs)) || {}
+      (null === (s = this.C) || void 0 === s ? void 0 : s.vs(t.gs.ks)) || {}
     );
   }
-  zs(s) {
-    this.C && this.C.js(t.bs.xs, s);
+  xs(s) {
+    this.C && this.C.Bs(t.gs.ks, s);
   }
   changeUser() {
-    this.Ds();
+    this.zs();
   }
   L() {
-    return !!this.B && (!!this.B.Us() || (0 !== this.B.Es() && this.Ds(), !1));
+    return !!this.B && (!!this.B.Ds() || (0 !== this.B.Us() && this.zs(), !1));
   }
-  Ds() {
+  zs() {
     (this.banners = {}),
-      this.C && (this.C.Ls(t.bs.gs), this.C.Ls(t.bs.xs)),
+      this.C && (this.C.Es(t.gs.ps), this.C.Es(t.gs.ks)),
       this.F.X({});
   }
 }

package/src/Banner/banner.js

@@ -17,7 +17,7 @@ export default class Banner {
   ht() {
     return this.isControl;
   }
-  Bs() {
+  bs() {
     return {
       id: this.id,
       o: this.placementId,

package/src/Banner/get-all-banners.js

@@ -1,13 +1,12 @@
-import { logger as N } from "../../shared-lib/index.js";
 import r from "../managers/braze-instance.js";
 import i from "./banner-provider-factory.js";
 import { getBannerIfNotExpired as v } from "./get-banner.js";
 export function getAllBanners() {
   if (!r.rr()) return;
   const n = {},
-    e = r.v();
-  if (e && !e.Us()) return N.info("Banners are not enabled."), n;
-  const o = i.m().vs();
+    t = r.v();
+  if (t && !t.Ds()) return n;
+  const o = i.m().fs();
   for (const r in o) n[r] = v(o, r);
   return n;
 }

package/src/Banner/get-banner.js

@@ -1,19 +1,19 @@
 import { logger as N } from "../../shared-lib/index.js";
 import r from "../managers/braze-instance.js";
 import i from "./banner-provider-factory.js";
-export function getBannerIfNotExpired(n, e) {
-  const r = n[e];
-  if (!r) return null;
-  const t = r.it,
-    a = new Date().valueOf();
-  return -1 !== t && 1e3 * t < a
-    ? (N.info(`Banner with ID: ${r.id} and placement ID: ${e} has expired.`),
+export function getBannerIfNotExpired(n, r) {
+  const e = n[r];
+  if (!e) return null;
+  const t = e.it,
+    o = new Date().valueOf();
+  return -1 !== t && 1e3 * t < o
+    ? (N.info(`Banner with ID: ${e.id} and placement ID: ${r} has expired.`),
       null)
-    : r;
+    : e;
 }
 export function getBanner(n) {
   if (!r.rr()) return;
-  const e = r.v();
-  if (e && !e.Us()) return N.info("Banners are not enabled."), null;
-  return getBannerIfNotExpired(i.m().vs(), n);
+  const e = i.m();
+  if (!e.L()) return null;
+  return getBannerIfNotExpired(e.fs(), n);
 }

package/src/Banner/log-banner-click.js

@@ -10,7 +10,7 @@ export function logBannerClick(n, o) {
       N.error("Banner argument to logBannerClick must be an Banner object."), !1
     );
   const e = i.m(),
-    t = e.vs();
+    t = e.fs();
   return 0 === y(t).length
     ? (N.info("Not logging banner click. No banners exist."), !1)
     : t[n.placementId]

package/src/Banner/log-banner-impressions.js

@@ -7,10 +7,10 @@ export function logBannerImpressions(o) {
   if (!r.rr()) return;
   if (!o || o.length <= 0) return !1;
   const n = i.m(),
-    s = n.vs();
+    s = n.fs();
   if (0 === y(s).length)
     return N.info("Not logging banners impression. No banners exist."), !1;
-  const e = n.ks(),
+  const e = n.Ns(),
     t = [];
   for (const r of o) {
     const o = s[r];
@@ -25,7 +25,7 @@ export function logBannerImpressions(o) {
         );
   }
   if (0 === t.length) return !1;
-  n.zs(e);
+  n.xs(e);
   const a = { ids: t };
-  return c.ds(d.ro, a).ss;
+  return c.cs(d.ro, a).ss;
 }

package/src/Banner/request-banners-refresh.js

@@ -1,26 +1,34 @@
 import { logger as N } from "../../shared-lib/index.js";
 import { BRAZE_MUST_BE_INITIALIZED_ERROR as p } from "../common/constants.js";
-import r from "../managers/braze-instance.js";
-import { isArray as w } from "../util/code-utils.js";
+import r, { OPTIONS as w } from "../managers/braze-instance.js";
+import { isArray as z } from "../util/code-utils.js";
 import { isValidBannerPlacementId as D } from "../util/validation-utils.js";
 import i from "./banner-provider-factory.js";
-export function requestBannersRefresh(e, n, o) {
+export function requestBannersRefresh(e, n, t) {
   if (!r.rr()) return void N.warn(p);
-  const t = r.v();
-  if (!t) return void N.warn(p);
-  if (!t.Us()) return void N.info("Banners are not enabled.");
-  if (!w(e) || 0 === e.length)
+  const s = r.v();
+  if (!s) return;
+  if (!z(e) || 0 === e.length)
     return void N.warn("placementIds should be a non-empty array.");
-  if (i.m().Is())
+  if (!r.ee(w.re))
+    return void N.error(
+      "Banners are disabled. Use the 'allowUserSuppliedJavascript' option for braze.initialize to enable these messages.",
+    );
+  const o = i.m();
+  if (i.m().Rs())
     return void N.warn(
       "Banners can be refreshed only once per session per user.",
     );
-  const s = t.ee();
-  e.length > s &&
+  if (!s || !o.L())
+    return void s.A(() => {
+      requestBannersRefresh(e, n, t);
+    });
+  const a = s.ne();
+  e.length > a &&
     (N.warn(
-      `Number of placement IDs requested exceeds the max allowed. Trimming placementIds array from length ${e.length} to ${s} (max allowed).`,
+      `Number of placement IDs requested exceeds the max allowed. Trimming placementIds array from length ${e.length} to ${a} (max allowed).`,
     ),
-    (e = e.slice(0, s))),
+    (e = e.slice(0, a))),
     0 !==
       (e = e.filter(
         (e) =>
@@ -31,5 +39,5 @@ export function requestBannersRefresh(e, n, o) {
           !1),
       )).length &&
       (N.info(`Requesting banners for placement IDs: ${JSON.stringify(e)}`),
-      i.m().$(e, n, o));
+      i.m().$(e, n, t));
 }

package/src/Banner/subscribe-to-banners-updates.js

@@ -2,22 +2,23 @@ import r from "../managers/braze-instance.js";
 import i from "./banner-provider-factory.js";
 import { getAllBanners } from "./get-all-banners.js";
 export function subscribeToBannersUpdates(n) {
+  var o;
   if (!r.rr()) return;
-  const o = i.m();
-  if (o.qs()) {
+  const t = i.m();
+  if (t.Is()) {
     const r = getAllBanners();
     r && "function" == typeof n && n(r);
   }
-  const t = o.Fs(n);
-  if (!o.Ts()) {
-    const n = r.nn();
-    if (n) {
-      const r = n.rn(() => {
-        const n = o.us();
-        n && n.length > 0 && o.$(n);
-      });
-      r && o.Rs(r);
-    }
+  const s = t.qs(n);
+  if (!t.Cs()) {
+    const n =
+      null === (o = r.nn()) || void 0 === o
+        ? void 0
+        : o.rn(() => {
+            const n = t.ls();
+            n && n.length > 0 && t.$(n);
+          });
+    n && t.Ts(n);
   }
-  return t;
+  return s;
 }