@braze/web-sdk 5.4.0 → 5.5.0

package/index.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definitions for @braze/web-sdk v5.4.0
+* 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.4/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).
@@ -2518,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.4/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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@braze/web-sdk",
-  "version": "5.4.0",
+  "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",
-    Eu: "pc",
+    Ku: "pc",
     vc: "ca",
-    Ka: "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",
-    Bu: "lr",
-    _u: "uae",
+    Ju: "lr",
+    Eu: "uae",
     O: "ci",
-    $: "cc",
-    Wu: "lcaa",
-    Ku: "lcar",
+    D: "cc",
+    Xu: "lcaa",
+    Gu: "lcar",
     On: "inc",
     Ln: "add",
     Rn: "rem",
     $n: "set",
     Bn: "ncam",
-    Gu: "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: {
-      La: "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.4.0)";
+      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.4.0)";
+      const o = "Braze SDK Error: " + n + " (v5.5.0)";
       null != r.vd ? r.vd(o) : console.error(o);
     }
   },

package/shared-lib/supported-options.js

@@ -3,16 +3,16 @@ export default {
   _o: "baseUrl",
   Io: "noCookies",
   So: "devicePropertyAllowlist",
-  ka: "disablePushTokenMaintenance",
+  Aa: "disablePushTokenMaintenance",
   Ao: "enableLogging",
   No: "enableSdkAuthentication",
-  _a: "manageServiceWorkerExternally",
+  qa: "manageServiceWorkerExternally",
   Oo: "minimumIntervalBetweenTriggerActionsInSeconds",
   Ro: "sessionTimeoutInSeconds",
   Po: "appVersion",
   Lo: "appVersionNumber",
-  wa: "serviceWorkerLocation",
-  Ma: "safariWebsitePushId",
+  Ma: "serviceWorkerLocation",
+  ka: "safariWebsitePushId",
   zn: "localization",
   bo: "contentSecurityNonce",
   Do: "allowUserSuppliedJavascript",
@@ -22,7 +22,7 @@ export default {
   Lh: "requireExplicitInAppMessageDismissal",
   Mo: "doNotLoadFontAwesome",
   Uo: "deviceId",
-  ya: "serviceWorkerScope",
+  _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/models/card.js

@@ -6,13 +6,13 @@ import { FEED_ANIMATION_DURATION as E } from "../../common/constants.js";
 import T from "../../managers/subscription-manager.js";
 import r from "../../../shared-lib/logger.js";
 export default class Card {
-  constructor(t, i, s, h, l, n, e, r, u, E, o, T, I, a, N, c) {
+  constructor(t, i, s, h, n, l, e, r, u, E, o, T, I, a, c, N) {
     (this.id = t),
       (this.viewed = i),
       (this.title = s),
       (this.imageUrl = h),
-      (this.description = l),
-      (this.created = n),
+      (this.description = n),
+      (this.created = l),
       (this.updated = e),
       (this.categories = r),
       (this.expiresAt = u),
@@ -21,14 +21,14 @@ export default class Card {
       (this.aspectRatio = T),
       (this.extras = I),
       (this.pinned = a),
-      (this.dismissible = N),
-      (this.clicked = c),
+      (this.dismissible = c),
+      (this.clicked = N),
       (this.id = t),
       (this.viewed = i || !1),
       (this.title = s || ""),
       (this.imageUrl = h),
-      (this.description = l || ""),
-      (this.created = n || null),
+      (this.description = n || ""),
+      (this.created = l || null),
       (this.updated = e || null),
       (this.categories = r || []),
       (this.expiresAt = u || null),
@@ -40,25 +40,26 @@ export default class Card {
           (this.aspectRatio = isNaN(T) ? null : T)),
       (this.extras = I || {}),
       (this.pinned = a || !1),
-      (this.dismissible = N || !1),
+      (this.dismissible = c || !1),
       (this.dismissed = !1),
-      (this.clicked = c || !1),
+      (this.clicked = N || !1),
       (this.isControl = !1),
       (this.test = !1),
       (this.Et = null),
-      (this.Tt = null);
+      (this.Tt = null),
+      (this.It = null);
   }
   subscribeToClickedEvent(t) {
-    return this.Nt().It(t);
+    return this.St().Nt(t);
   }
   subscribeToDismissedEvent(t) {
-    return this.St().It(t);
+    return this.At().Nt(t);
   }
   removeSubscription(t) {
-    this.Nt().removeSubscription(t), this.St().removeSubscription(t);
+    this.St().removeSubscription(t), this.At().removeSubscription(t);
   }
   removeAllSubscriptions() {
-    this.Nt().removeAllSubscriptions(), this.St().removeAllSubscriptions();
+    this.St().removeAllSubscriptions(), this.At().removeAllSubscriptions();
   }
   dismissCard() {
     if (!this.dismissible || this.dismissed) return;
@@ -75,65 +76,69 @@ export default class Card {
             (t.style.margin = "0"),
             setTimeout(function () {
               t && t.parentNode && t.parentNode.removeChild(t);
-            }, Card.At));
+            }, Card.Dt));
         }, E));
   }
-  Nt() {
+  St() {
     return null == this.Et && (this.Et = new T()), this.Et;
   }
-  St() {
+  At() {
     return null == this.Tt && (this.Tt = new T()), this.Tt;
   }
   K() {
-    this.viewed = !0;
+    const t = new Date().valueOf();
+    return (
+      !(null != this.It && t - this.It < Card.Ct) &&
+      ((this.It = t), (this.viewed = !0), !0)
+    );
   }
   p() {
-    (this.viewed = !0), (this.clicked = !0), this.Nt().Dt();
+    (this.viewed = !0), (this.clicked = !0), this.St().Rt();
   }
   N() {
     return (
       !(!this.dismissible || this.dismissed) &&
-      ((this.dismissed = !0), this.St().Dt(), !0)
+      ((this.dismissed = !0), this.At().Rt(), !0)
     );
   }
-  Ct(t) {
-    if (null == t || t[Card.Rt.ht] !== this.id) return !0;
-    if (t[Card.Rt.Lt]) return !1;
+  Lt(t) {
+    if (null == t || t[Card._t.ht] !== this.id) return !0;
+    if (t[Card._t.Ot]) return !1;
     if (
-      null != t[Card.Rt.nt] &&
+      null != t[Card._t.nt] &&
       null != this.updated &&
-      parseInt(t[Card.Rt.nt]) < h(this.updated.valueOf())
+      parseInt(t[Card._t.nt]) < h(this.updated.valueOf())
     )
       return !0;
     if (
-      (t[Card.Rt.et] && !this.viewed && (this.viewed = !0),
-      t[Card.Rt.zt] && !this.clicked && (this.clicked = t[Card.Rt.zt]),
-      null != t[Card.Rt.rt] && (this.title = t[Card.Rt.rt]),
-      null != t[Card.Rt.ot] && (this.imageUrl = t[Card.Rt.ot]),
-      null != t[Card.Rt.ct] && (this.description = t[Card.Rt.ct]),
-      null != t[Card.Rt.nt])
+      (t[Card._t.et] && !this.viewed && (this.viewed = !0),
+      t[Card._t.zt] && !this.clicked && (this.clicked = t[Card._t.zt]),
+      null != t[Card._t.rt] && (this.title = t[Card._t.rt]),
+      null != t[Card._t.ot] && (this.imageUrl = t[Card._t.ot]),
+      null != t[Card._t.ct] && (this.description = t[Card._t.ct]),
+      null != t[Card._t.nt])
     ) {
-      const i = l(t[Card.Rt.nt]);
+      const i = l(t[Card._t.nt]);
       null != i && (this.updated = i);
     }
-    if (null != t[Card.Rt.lt]) {
+    if (null != t[Card._t.lt]) {
       let i;
-      (i = t[Card.Rt.lt] === Card._t ? null : l(t[Card.Rt.lt])),
+      (i = t[Card._t.lt] === Card.Mt ? null : l(t[Card._t.lt])),
         (this.expiresAt = i);
     }
     if (
-      (null != t[Card.Rt.URL] && (this.url = t[Card.Rt.URL]),
-      null != t[Card.Rt.ft] && (this.linkText = t[Card.Rt.ft]),
-      null != t[Card.Rt.xt])
+      (null != t[Card._t.URL] && (this.url = t[Card._t.URL]),
+      null != t[Card._t.ft] && (this.linkText = t[Card._t.ft]),
+      null != t[Card._t.xt])
     ) {
-      const i = parseFloat(t[Card.Rt.xt].toString());
+      const i = parseFloat(t[Card._t.xt].toString());
       this.aspectRatio = isNaN(i) ? null : i;
     }
     return (
-      null != t[Card.Rt.bt] && (this.extras = t[Card.Rt.bt]),
-      null != t[Card.Rt.gt] && (this.pinned = t[Card.Rt.gt]),
-      null != t[Card.Rt.jt] && (this.dismissible = t[Card.Rt.jt]),
-      null != t[Card.Rt.kt] && (this.test = t[Card.Rt.kt]),
+      null != t[Card._t.bt] && (this.extras = t[Card._t.bt]),
+      null != t[Card._t.gt] && (this.pinned = t[Card._t.gt]),
+      null != t[Card._t.jt] && (this.dismissible = t[Card._t.jt]),
+      null != t[Card._t.kt] && (this.test = t[Card._t.kt]),
       !0
     );
   }
@@ -141,12 +146,12 @@ export default class Card {
     r.error("Must be implemented in a subclass");
   }
 }
-(Card._t = -1),
-  (Card.Rt = {
+(Card.Mt = -1),
+  (Card._t = {
     ht: "id",
     et: "v",
     jt: "db",
-    Lt: "r",
+    Ot: "r",
     nt: "ca",
     gt: "p",
     lt: "ea",
@@ -163,10 +168,10 @@ export default class Card {
   }),
   (Card.it = {
     st: "captioned_image",
-    Ot: "text_announcement",
-    Mt: "short_news",
-    Pt: "banner_image",
-    Ut: "control",
+    Pt: "text_announcement",
+    Ut: "short_news",
+    Gt: "banner_image",
+    Xt: "control",
   }),
   (Card.tt = {
     ht: "id",
@@ -188,10 +193,11 @@ export default class Card {
     zt: "cl",
     kt: "s",
   }),
-  (Card.Gt = {
-    Xt: "ADVERTISING",
-    vt: "ANNOUNCEMENTS",
-    Vt: "NEWS",
-    Wt: "SOCIAL",
+  (Card.vt = {
+    Vt: "ADVERTISING",
+    Wt: "ANNOUNCEMENTS",
+    wt: "NEWS",
+    Ft: "SOCIAL",
   }),
-  (Card.At = 400);
+  (Card.Dt = 400),
+  (Card.Ct = 1e4);

package/src/Card/models/classic-card.js

@@ -8,7 +8,7 @@ export default class ClassicCard extends Card {
   Y() {
     const s = {};
     return (
-      (s[Card.tt.Z] = Card.it.Mt),
+      (s[Card.tt.Z] = Card.it.Ut),
       (s[Card.tt.ht] = this.id),
       (s[Card.tt.et] = this.viewed),
       (s[Card.tt.rt] = this.title),

package/src/Card/models/control-card.js

@@ -9,7 +9,7 @@ export default class ControlCard extends Card {
   Y() {
     const l = {};
     return (
-      (l[Card.tt.Z] = Card.it.Ut),
+      (l[Card.tt.Z] = Card.it.Xt),
       (l[Card.tt.ht] = this.id),
       (l[Card.tt.et] = this.viewed),
       (l[Card.tt.nt] = this.updated),

package/src/Card/models/image-only.js

@@ -9,7 +9,7 @@ export default class ImageOnly extends Card {
   Y() {
     const s = {};
     return (
-      (s[Card.tt.Z] = Card.it.Pt),
+      (s[Card.tt.Z] = Card.it.Gt),
       (s[Card.tt.ht] = this.id),
       (s[Card.tt.et] = this.viewed),
       (s[Card.tt.ot] = this.imageUrl),

package/src/Card/util/card-factory.js

@@ -12,31 +12,31 @@ import {
 import { logger as r } from "../../../shared-lib/index.js";
 export function newCard(n, e, t, o, i, l, u, d, a, w, f, s, m, C, p, c, x, F) {
   let j;
-  if (e === Card.it.Ot || e === Card.it.Mt)
+  if (e === Card.it.Pt || e === Card.it.Ut)
     j = new ClassicCard(n, t, o, i, l, u, d, a, w, f, s, m, C, p, c, x);
   else if (e === Card.it.st)
     j = new CaptionedImage(n, t, o, i, l, u, d, a, w, f, s, m, C, p, c, x);
-  else if (e === Card.it.Pt)
+  else if (e === Card.it.Gt)
     j = new ImageOnly(n, t, i, u, d, a, w, f, s, m, C, p, c, x);
   else {
-    if (e !== Card.it.Ut)
+    if (e !== Card.it.Xt)
       return r.error("Ignoring card with unknown type " + e), null;
     j = new ControlCard(n, t, d, w, C, p);
   }
   return F && (j.test = F), j;
 }
 export function newCardFromContentCardsJson(n) {
-  if (n[Card.Rt.Lt]) return null;
-  const e = n[Card.Rt.ht],
-    r = n[Card.Rt.Z],
-    t = n[Card.Rt.et],
-    o = n[Card.Rt.rt],
-    i = n[Card.Rt.ot],
-    u = n[Card.Rt.ct],
-    d = l(n[Card.Rt.nt]),
+  if (n[Card._t.Ot]) return null;
+  const e = n[Card._t.ht],
+    r = n[Card._t.Z],
+    t = n[Card._t.et],
+    o = n[Card._t.rt],
+    i = n[Card._t.ot],
+    u = n[Card._t.ct],
+    d = l(n[Card._t.nt]),
     a = d;
   let w;
-  w = n[Card.Rt.lt] === Card._t ? null : l(n[Card.Rt.lt]);
+  w = n[Card._t.lt] === Card.Mt ? null : l(n[Card._t.lt]);
   return newCard(
     e,
     r,
@@ -48,14 +48,14 @@ export function newCardFromContentCardsJson(n) {
     d,
     null,
     w,
-    n[Card.Rt.URL],
-    n[Card.Rt.ft],
-    n[Card.Rt.xt],
-    n[Card.Rt.bt],
-    n[Card.Rt.gt],
-    n[Card.Rt.jt],
-    n[Card.Rt.zt],
-    n[Card.Rt.kt] || !1,
+    n[Card._t.URL],
+    n[Card._t.ft],
+    n[Card._t.xt],
+    n[Card._t.bt],
+    n[Card._t.gt],
+    n[Card._t.jt],
+    n[Card._t.zt],
+    n[Card._t.kt] || !1,
   );
 }
 export function newCardFromFeedJson(n) {