@braze/web-sdk 5.3.2 → 5.5.0

package/index.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definitions for @braze/web-sdk v5.3.2
+* Type definitions for @braze/web-sdk v5.5.0
 * Project: https://github.com/braze-inc/braze-web-sdk
 * (c) Braze, Inc. 2024 - http://braze.com
 * License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE
@@ -2138,7 +2138,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.3/service-worker.js');
+ * self.importScripts('https://js.appboycdn.com/web-sdk-develop/5.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).
@@ -2408,7 +2408,7 @@ export function subscribeToFeatureFlagsUpdates(
 export function getAllFeatureFlags(): FeatureFlag[];
 
 /**
- * Logs impression for a given feature flag.
+ * Logs impression for a given feature flag. This is limited to one impression per session per feature flag ID.
  *
  * @param featureFlagId - ID of the feature flag that has received the impression.
  *
@@ -2418,6 +2418,11 @@ export function logFeatureFlagImpression(
   featureFlagId: string,
 ): boolean | undefined;
 
+/**
+ * Getter method to determine if the Braze SDK has been initialized.
+ */
+export function isInitialized(): boolean;
+
 /**
  * Supported initialization options
  *
@@ -2513,7 +2518,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.3/service-worker.js');` or by including the content
+   *   `self.importScripts('https://js.appboycdn.com/web-sdk-develop/5.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;
@@ -2570,6 +2575,17 @@ export type InitializationOptions = {
    *   default with a value of your own.
    */
   deviceId?: string;
+  /**
+   * By default, Braze will register service worker with scope as the directory where the service worker script is located.
+   *
+   *   Provide a value for this option to override that with a different scope. If you are using Service-Worker-Allowed header to specify scope,
+   *   ensure that the value provided here either matches the value returned by the header or is a subdirectory of it.
+   *
+   *   For example, if the scope is '/path/to/subdirectory/' and the header is set to '/', the registration will succeed. However, if the scope is '/' and the
+   *   header is set to '/path/to/subdirectory/', the registration will fail because the provided scope ('/') is not under the maximum scope allowed
+   *   by Service-Worker-Allowed: '/path/to/subdirectory/'.
+   */
+  serviceWorkerScope?: string;
 };
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@braze/web-sdk",
-  "version": "5.3.2",
+  "version": "5.5.0",
   "description": "Braze SDK for web sites and other JS platforms.",
   "main": "src/index.js",
   "scripts": {

package/shared-lib/event-types.js

@@ -1,33 +1,33 @@
 const i = {
     CustomEvent: "ce",
     Pr: "p",
-    _u: "pc",
+    Ku: "pc",
     vc: "ca",
-    Ea: "i",
-    qs: "ie",
+    Ua: "i",
+    Ls: "ie",
     M: "cci",
     R: "ccic",
-    I: "ccc",
+    k: "ccc",
     F: "ccd",
     ql: "ss",
     xl: "se",
-    Gi: "si",
+    Xi: "si",
     $i: "sc",
-    Ei: "sbc",
+    Oi: "sbc",
     Cc: "sfe",
     mo: "iec",
-    Uu: "lr",
-    zu: "uae",
+    Ju: "lr",
+    Eu: "uae",
     O: "ci",
-    $: "cc",
-    Ju: "lcaa",
-    Eu: "lcar",
+    D: "cc",
+    Xu: "lcaa",
+    Gu: "lcar",
     On: "inc",
     Ln: "add",
     Rn: "rem",
     $n: "set",
     Bn: "ncam",
-    Ku: "sgu",
+    Hu: "sgu",
     Fr: "ffi",
   },
   or = { Ar: "feed_displayed", Ec: "content_cards_displayed" };

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

@@ -64,11 +64,11 @@ export default class A {
             "...",
         );
         const n = null === (e = t.target) || void 0 === e ? void 0 : e.result;
-        for (const t in i.database.ss) {
+        for (const t in i.database.hs) {
           const e = t;
-          i.database.ss.hasOwnProperty(t) &&
-            !n.objectStoreNames.contains(i.database.ss[e]) &&
-            n.createObjectStore(i.database.ss[e]);
+          i.database.hs.hasOwnProperty(t) &&
+            !n.objectStoreNames.contains(i.database.hs[e]) &&
+            n.createObjectStore(i.database.hs[e]);
         }
       }),
       (o.onsuccess = (n) => {
@@ -249,7 +249,7 @@ export default class A {
       };
     });
   }
-  Zt(t, e) {
+  ss(t, e) {
     if (!this.isSupported()) return !1;
     const n = this;
     return this.Bd((o) => {
@@ -304,11 +304,11 @@ export default class A {
   clearData() {
     if (!this.isSupported()) return !1;
     const t = [];
-    for (const e in this.database.ss) {
+    for (const e in this.database.hs) {
       const n = e;
-      this.database.ss.hasOwnProperty(e) &&
-        this.database.ss[n] !== this.database.ss.ae &&
-        t.push(this.database.ss[n]);
+      this.database.hs.hasOwnProperty(e) &&
+        this.database.hs[n] !== this.database.hs.ae &&
+        t.push(this.database.hs[n]);
     }
     const e = this;
     return this.Bd(function (n) {
@@ -333,16 +333,16 @@ export default class A {
     });
   }
 }
-A.Yt = {
-  Qt: {
+A.ts = {
+  Zt: {
     Sd: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
-    ss: {
-      $a: "data",
+    hs: {
+      Ka: "data",
       hr: "pushClicks",
       cu: "pushSubscribed",
       Cd: "fallbackDevice",
-      ts: "cardUpdates",
+      es: "cardUpdates",
       ae: "optOut",
       wr: "pendingData",
       jh: "sdkAuthenticationSignature",

package/shared-lib/logger.js

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

package/shared-lib/supported-options.js

@@ -2,17 +2,17 @@ export default {
   Eo: "allowCrawlerActivity",
   _o: "baseUrl",
   Io: "noCookies",
-  Ao: "devicePropertyAllowlist",
-  _a: "disablePushTokenMaintenance",
-  So: "enableLogging",
+  So: "devicePropertyAllowlist",
+  Aa: "disablePushTokenMaintenance",
+  Ao: "enableLogging",
   No: "enableSdkAuthentication",
-  Ma: "manageServiceWorkerExternally",
+  qa: "manageServiceWorkerExternally",
   Oo: "minimumIntervalBetweenTriggerActionsInSeconds",
-  Po: "sessionTimeoutInSeconds",
-  Ro: "appVersion",
+  Ro: "sessionTimeoutInSeconds",
+  Po: "appVersion",
   Lo: "appVersionNumber",
-  wa: "serviceWorkerLocation",
-  ya: "safariWebsitePushId",
+  Ma: "serviceWorkerLocation",
+  ka: "safariWebsitePushId",
   zn: "localization",
   bo: "contentSecurityNonce",
   Do: "allowUserSuppliedJavascript",
@@ -22,6 +22,7 @@ export default {
   Lh: "requireExplicitInAppMessageDismissal",
   Mo: "doNotLoadFontAwesome",
   Uo: "deviceId",
-  Bo: "sdkFlavor",
+  _a: "serviceWorkerScope",
+  Wo: "sdkFlavor",
   tn: "openCardsInNewTab",
 };

package/src/Card/card-manager.js

@@ -1,30 +1,30 @@
 import { ControlCard } from "./models/index.js";
-import s from "../common/event-logger.js";
-import t from "../models/request-result.js";
+import t from "../common/event-logger.js";
+import s from "../models/request-result.js";
 import { logger as r, EventTypes as i } from "../../shared-lib/index.js";
 import { STORAGE_KEYS as o } from "../managers/storage-manager.js";
 export default class a {
-  constructor(s) {
-    (this.u = s), (this.u = s);
+  constructor(t) {
+    (this.u = t), (this.u = t);
   }
   h(n, e) {
-    const l = new t();
+    const l = new s();
     if ((n.p(), null == n.url || "" === n.url))
       return (
         r.info(`Card ${n.id} has no url. Not logging click to Braze servers.`),
         l
       );
     if (e && n.id && this.u) {
-      const s = this.u.j(o.C.v) || {};
-      (s[n.id] = !0), this.u.k(o.C.v, s);
+      const t = this.u.j(o.C.v) || {};
+      (t[n.id] = !0), this.u.I(o.C.v, t);
     }
-    const u = this.D([n]);
-    if (null == u) return l;
-    const c = e ? i.I : i.$;
-    return s.q(c, u);
+    const a = this.$([n]);
+    if (null == a) return l;
+    const u = e ? i.k : i.D;
+    return t.q(u, a);
   }
   B(n) {
-    const e = new t();
+    const e = new s();
     if (!n.N())
       return (
         r.info(
@@ -33,44 +33,48 @@ export default class a {
         e
       );
     if (n.id && this.u) {
-      const s = this.u.j(o.C.A) || {};
-      (s[n.id] = !0), this.u.k(o.C.A, s);
+      const t = this.u.j(o.C.A) || {};
+      (t[n.id] = !0), this.u.I(o.C.A, t);
     }
-    const l = this.D([n]);
-    return null == l ? e : s.q(i.F, l);
+    const l = this.$([n]);
+    return null == l ? e : t.q(i.F, l);
   }
-  G(n, r) {
-    const e = new t(!0),
-      l = [],
+  G(n, e) {
+    const l = new s(!0),
+      a = [],
       u = [];
     let c = {};
-    this.u && (c = r ? this.u.j(o.C.H) || {} : this.u.j(o.C.J) || {});
-    for (const s of n)
-      s.K(),
-        s instanceof ControlCard ? u.push(s) : l.push(s),
-        s.id && (c[s.id] = !0);
-    const h = this.D(l),
-      a = this.D(u);
-    if (null == h && null == a) return (e.L = !1), e;
-    if ((this.u && (r ? this.u.k(o.C.H, c) : this.u.k(o.C.J, c)), null != h)) {
-      const t = r ? i.M : i.O,
-        n = s.q(t, h);
-      e.P(n);
+    this.u && (c = e ? this.u.j(o.C.H) || {} : this.u.j(o.C.J) || {});
+    for (const t of n) {
+      t.K()
+        ? (t instanceof ControlCard ? u.push(t) : a.push(t),
+          t.id && (c[t.id] = !0))
+        : r.info(
+            `Card ${t.id} logged an impression too recently. Ignoring analytics event.`,
+          );
     }
-    if (null != a && r) {
-      const t = s.q(i.R, a);
-      e.P(t);
+    const h = this.$(a),
+      m = this.$(u);
+    if (null == h && null == m) return (l.L = !1), l;
+    if ((this.u && (e ? this.u.I(o.C.H, c) : this.u.I(o.C.J, c)), null != h)) {
+      const s = e ? i.M : i.O,
+        n = t.q(s, h);
+      l.P(n);
     }
-    return e;
+    if (null != m && e) {
+      const s = t.q(i.R, m);
+      l.P(s);
+    }
+    return l;
   }
-  D(s) {
-    let t,
+  $(t) {
+    let s,
       n = null;
-    for (let r = 0; r < s.length; r++)
-      (t = s[r].id),
-        null != t &&
-          "" !== t &&
-          ((n = n || {}), (n.ids = n.ids || []), n.ids.push(t));
+    for (let r = 0; r < t.length; r++)
+      (s = t[r].id),
+        null != s &&
+          "" !== s &&
+          ((n = n || {}), (n.ids = n.ids || []), n.ids.push(s));
     return n;
   }
 }

package/src/Card/display/card-display.js

@@ -41,98 +41,99 @@ export function setCardHeight(t, o) {
       t && (a.style.height = `${t}px`);
     }
 }
-export function cardToHtml(t, logCardClick, o) {
-  const e = document.createElement("div");
-  (e.className = "ab-card ab-effect-card " + t._),
+export function cardToHtml(t, logCardClick, o, e = "ltr") {
+  const a = document.createElement("div");
+  (a.dir = e),
+    (a.className = "ab-card ab-effect-card " + t._),
     t.id &&
-      (e.setAttribute("data-ab-card-id", t.id), e.setAttribute("id", t.id)),
-    e.setAttribute("role", "article"),
-    e.setAttribute("tabindex", "0");
-  let a = "",
-    n = !1;
-  t.url && "" !== t.url && ((a = t.url), (n = !0));
-  const i = (i) => (markCardAsRead(e), n && (logCardClick(t), u(a, o, i)), !1);
+      (a.setAttribute("data-ab-card-id", t.id), a.setAttribute("id", t.id)),
+    a.setAttribute("role", "article"),
+    a.setAttribute("tabindex", "0");
+  let n = "",
+    i = !1;
+  t.url && "" !== t.url && ((n = t.url), (i = !0));
+  const r = (e) => (markCardAsRead(a), i && (logCardClick(t), u(n, o, e)), !1);
   if (t.pinned) {
     const t = document.createElement("div");
     t.className = "ab-pinned-indicator";
     const o = document.createElement("i");
-    (o.className = "fa fa-star"), t.appendChild(o), e.appendChild(t);
+    (o.className = "fa fa-star"), t.appendChild(o), a.appendChild(t);
   }
   if (t.imageUrl && "" !== t.imageUrl) {
     const o = document.createElement("div");
-    o.className = "ab-image-area";
-    const r = document.createElement("img");
+    (o.dir = e), (o.className = "ab-image-area");
+    const d = document.createElement("img");
     if (
-      (r.setAttribute("src", t.imageUrl),
-      (r.onload = () => {
-        e.style.height = "auto";
+      (d.setAttribute("src", t.imageUrl),
+      (d.onload = () => {
+        a.style.height = "auto";
       }),
-      _setImageAltText(t, r),
-      o.appendChild(r),
-      (e.className += " with-image"),
-      n && !t.S)
+      _setImageAltText(t, d),
+      o.appendChild(d),
+      (a.className += " with-image"),
+      i && !t.S)
     ) {
       const t = document.createElement("a");
-      t.setAttribute("href", a),
-        (t.onclick = i),
+      t.setAttribute("href", n),
+        (t.onclick = r),
         t.appendChild(o),
-        e.appendChild(t);
-    } else e.appendChild(o);
+        a.appendChild(t);
+    } else a.appendChild(o);
   }
-  const r = document.createElement("div");
-  if (((r.className = "ab-card-body"), t.dismissible)) {
+  const s = document.createElement("div");
+  if (((s.className = "ab-card-body"), (s.dir = e), t.dismissible)) {
     t.logCardDismissal = () => logCardDismissal(t);
-    const o = d("Dismiss Card", void 0, t.dismissCard.bind(t));
-    e.appendChild(o),
-      c(r, m.U, (t) => {
-        (e.className += " ab-swiped-left"), o.onclick(t);
+    const o = d("Dismiss Card", void 0, t.dismissCard.bind(t), e);
+    a.appendChild(o),
+      c(s, m.U, (t) => {
+        (a.className += " ab-swiped-left"), o.onclick(t);
       }),
-      c(r, m.V, (t) => {
-        (e.className += " ab-swiped-right"), o.onclick(t);
+      c(s, m.V, (t) => {
+        (a.className += " ab-swiped-right"), o.onclick(t);
       });
   }
-  let s = "",
-    l = !1;
-  if ((t.title && "" !== t.title && ((s = t.title), (l = !0)), l)) {
+  let l = "",
+    b = !1;
+  if ((t.title && "" !== t.title && ((l = t.title), (b = !0)), b)) {
     const t = document.createElement("h1");
     if (
       ((t.className = "ab-title"),
       (t.id = p.W()),
-      e.setAttribute("aria-labelledby", t.id),
-      n)
+      a.setAttribute("aria-labelledby", t.id),
+      i)
     ) {
       const o = document.createElement("a");
-      o.setAttribute("href", a),
-        (o.onclick = i),
-        o.appendChild(document.createTextNode(s)),
+      o.setAttribute("href", n),
+        (o.onclick = r),
+        o.appendChild(document.createTextNode(l)),
         t.appendChild(o);
-    } else t.appendChild(document.createTextNode(s));
-    r.appendChild(t);
+    } else t.appendChild(document.createTextNode(l));
+    s.appendChild(t);
   }
-  const b = document.createElement("div");
+  const f = document.createElement("div");
   if (
-    ((b.className = l ? "ab-description" : "ab-description ab-no-title"),
-    (b.id = p.W()),
-    e.setAttribute("aria-describedby", b.id),
-    t.description && b.appendChild(document.createTextNode(t.description)),
-    n)
+    ((f.className = b ? "ab-description" : "ab-description ab-no-title"),
+    (f.id = p.W()),
+    a.setAttribute("aria-describedby", f.id),
+    t.description && f.appendChild(document.createTextNode(t.description)),
+    i)
   ) {
     const o = document.createElement("div");
     o.className = "ab-url-area";
     const e = document.createElement("a");
-    e.setAttribute("href", a),
+    e.setAttribute("href", n),
       t.linkText && e.appendChild(document.createTextNode(t.linkText)),
-      (e.onclick = i),
+      (e.onclick = r),
       o.appendChild(e),
-      b.appendChild(o);
+      f.appendChild(o);
   }
-  r.appendChild(b), e.appendChild(r);
-  const f = document.createElement("div");
+  s.appendChild(f), a.appendChild(s);
+  const x = document.createElement("div");
   return (
-    (f.className = "ab-unread-indicator"),
-    t.viewed && (f.className += " read"),
-    e.appendChild(f),
-    (t.T = e),
-    e
+    (x.className = "ab-unread-indicator"),
+    t.viewed && (x.className += " read"),
+    a.appendChild(x),
+    (t.T = a),
+    a
   );
 }