@braze/web-sdk 4.9.0 → 4.10.0

package/package.json

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

package/shared-lib/braze-shared-lib.js

@@ -4,5 +4,5 @@ import Ge from "./guid.js";
 import Oe from "./indexed-db-adapter.js";
 import Ue from "./logger.js";
 import ke from "./supported-options.js";
-const r = { On: ve, q: De, Cr: Be, Z: Ge, xt: Oe, zt: Oe.ep, j: Ue, Jo: ke };
+const r = { On: ve, q: De, Cr: Be, Z: Ge, xt: Oe, zt: Oe.ep, j: Ue, Yo: ke };
 export default r;

package/shared-lib/event-types.js

@@ -1,9 +1,9 @@
 const De = {
     CustomEvent: "ce",
     Pr: "p",
-    $u: "pc",
-    dc: "ca",
-    Va: "i",
+    Mu: "pc",
+    cc: "ca",
+    Ka: "i",
     qs: "ie",
     P: "cci",
     T: "ccic",
@@ -16,19 +16,19 @@ const De = {
     Qi: "sbc",
     Ki: "sfe",
     eo: "iec",
-    Su: "lr",
-    ju: "uae",
+    Lu: "lr",
+    Tu: "uae",
     R: "ci",
     B: "cc",
-    Au: "lcaa",
-    qu: "lcar",
+    Ru: "lcaa",
+    Pu: "lcar",
     Xn: "inc",
     Jn: "add",
     Qn: "rem",
     Hn: "set",
     Kn: "ncam",
-    Cu: "sgu",
+    Nu: "sgu",
     Fr: "ffi",
   },
-  Be = { Br: "feed_displayed", vc: "content_cards_displayed" };
+  Be = { Br: "feed_displayed", dc: "content_cards_displayed" };
 export { De as EventTypes, Be as InternalEventTypes };

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

@@ -338,7 +338,7 @@ Oe.ep = {
     od: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
     Jt: {
-      Ja: "data",
+      Na: "data",
       kr: "pushClicks",
       cu: "pushSubscribed",
       dd: "fallbackDevice",

package/shared-lib/logger.js

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

package/shared-lib/supported-options.js

@@ -10,17 +10,18 @@ export default {
   No: "minimumIntervalBetweenTriggerActionsInSeconds",
   wo: "sessionTimeoutInSeconds",
   Oo: "appVersion",
+  Po: "appVersionNumber",
   _a: "serviceWorkerLocation",
   ka: "safariWebsitePushId",
   Ba: "localization",
   po: "contentSecurityNonce",
-  Co: "enableHtmlInAppMessages",
-  Lo: "allowUserSuppliedJavascript",
+  Ro: "enableHtmlInAppMessages",
+  Co: "allowUserSuppliedJavascript",
   lo: "inAppMessageZIndex",
   fo: "openInAppMessagesInNewTab",
   en: "openNewsFeedCardsInNewTab",
   mh: "requireExplicitInAppMessageDismissal",
-  Po: "doNotLoadFontAwesome",
-  Ro: "sdkFlavor",
+  Lo: "doNotLoadFontAwesome",
+  Mo: "sdkFlavor",
   tn: "openCardsInNewTab",
 };

package/src/Core/get-device-id.js

@@ -1,11 +1,13 @@
 import e from "../managers/braze-instance.js";
 import r from "../../shared-lib/braze-shared-lib.js";
-export function getDeviceId(i) {
+export function getDeviceId(t) {
   if (!e.rr()) return;
-  null == i &&
-    r.j.error(
-      "getDeviceId must be supplied with a callback. e.g., braze.getDeviceId(function(deviceId) {console.log('the device id is ' + deviceId)})",
-    );
-  const t = e.te();
-  "function" == typeof i && t && i(t.ce().id);
+  const i = e.te();
+  if (!i) return;
+  const c = i.ce().id;
+  if ("function" != typeof t) return c;
+  r.j.warn(
+    "The callback for getDeviceId is deprecated. You can access its return value directly instead (e.g. `const id = braze.getDeviceId()`)",
+  ),
+    t(c);
 }

package/src/User/user.js

@@ -1,7 +1,7 @@
 import {
   isArray as p,
-  isDate as Nt,
-  isObject as yt,
+  isDate as yt,
+  isObject as Nt,
   validateValueIsFromEnum as H,
 } from "../util/code-utils.js";
 import r from "../../shared-lib/braze-shared-lib.js";
@@ -21,11 +21,12 @@ export default class User {
     (this.ft = t), (this.ki = e), (this.ft = t), (this.ki = e);
   }
   getUserId(t) {
-    null == t &&
-      r.j.error(
-        "getUserId must be supplied with a callback. e.g., braze.getUser().getUserId(function(userId) {console.log('the user id is ' + userId)})",
-      ),
-      "function" == typeof t && t(this.ft.getUserId());
+    const e = this.ft.getUserId();
+    if ("function" != typeof t) return e;
+    r.j.warn(
+      "The callback for getUserId is deprecated. You can access its return value directly instead (e.g. `const id = braze.getUser().getUserId()`)",
+    ),
+      t(e);
   }
   addAlias(t, e) {
     return !J(t, "add alias", "the alias", !1) || t.length <= 0
@@ -182,13 +183,13 @@ export default class User {
       if (!s && !n && 0 !== e.length) return !1;
       if (s || 0 === e.length) return this.ki.Gn(r.q.Hn, t, e).O;
       for (const t of e) if (!i(t)) return !1;
-    } else if (yt(e)) {
+    } else if (Nt(e)) {
       if (!i(e)) return !1;
       if (s) return this.ki.Gn(r.q.Kn, t, e).O;
     } else {
       if (!(void 0 !== e && Ut(e))) return !1;
       if (
-        (Nt(e) && (e = $t(e)),
+        (yt(e) && (e = $t(e)),
         "string" == typeof e &&
           !ot(
             e,

package/src/managers/braze-instance.js

@@ -7,11 +7,11 @@ import {
   isArray as p,
   keys as oo,
   validateValueIsFromEnum as H,
-  values as Lt,
+  values as Pt,
 } from "../util/code-utils.js";
 import { logDeprecationWarning as z } from "../util/deprecation-utils.js";
-import Pt from "./network-manager.js";
-import Rt from "../request-controller.js";
+import Rt from "./network-manager.js";
+import Lt from "../request-controller.js";
 import Mt from "./server-config-manager.js";
 import Dt from "./session-manager.js";
 import r from "../../shared-lib/braze-shared-lib.js";
@@ -36,26 +36,27 @@ const L = {
   No: "minimumIntervalBetweenTriggerActionsInSeconds",
   wo: "sessionTimeoutInSeconds",
   Oo: "appVersion",
+  Po: "appVersionNumber",
   _a: "serviceWorkerLocation",
   ka: "safariWebsitePushId",
   Ba: "localization",
   po: "contentSecurityNonce",
-  Co: "enableHtmlInAppMessages",
-  Lo: "allowUserSuppliedJavascript",
+  Ro: "enableHtmlInAppMessages",
+  Co: "allowUserSuppliedJavascript",
   lo: "inAppMessageZIndex",
   fo: "openInAppMessagesInNewTab",
   tn: "openCardsInNewTab",
   en: "openNewsFeedCardsInNewTab",
   mh: "requireExplicitInAppMessageDismissal",
-  Po: "doNotLoadFontAwesome",
-  Ro: "sdkFlavor",
+  Lo: "doNotLoadFontAwesome",
+  Mo: "sdkFlavor",
 };
 class Wt {
   constructor() {
     (this.cn = ""),
-      (this.Mo = ""),
-      (this.jo = void 0),
-      (this.Do = null),
+      (this.jo = ""),
+      (this.Do = void 0),
+      (this.Uo = null),
       (this.fn = null),
       (this.gt = null),
       (this.ki = null),
@@ -63,22 +64,22 @@ class Wt {
       (this._e = null),
       (this.u = null),
       (this.ft = null),
-      (this.Uo = ""),
-      (this.Bo = !1),
+      (this.Bo = ""),
       (this.Wo = !1),
-      (this.zo = new E()),
+      (this.zo = !1),
       (this.Vo = new E()),
+      (this.Go = new E()),
       (this.options = {}),
-      (this.Go = []),
       (this.Ko = []),
+      (this.Ho = []),
       (this.Ve = []),
-      (this.Mo = "4.9.0");
+      (this.jo = "4.10.0");
   }
-  Ho(t) {
-    this.zo.lt(t);
+  $o(t) {
+    this.Vo.lt(t);
   }
   Rh(t) {
-    this.Vo.lt(t);
+    this.Go.lt(t);
   }
   initialize(t, s) {
     if (this.fe())
@@ -107,34 +108,34 @@ class Wt {
       ((o = document.createElement("a")),
       (o.href = h),
       "/" === o.pathname && (o = `${o}api/v3`),
-      (this.Uo = o.toString()),
-      V.$o && !this.nn(L.ho))
+      (this.Bo = o.toString()),
+      V.qo && !this.nn(L.ho))
     )
       return (
         r.j.info("Ignoring activity from crawler bot " + navigator.userAgent),
-        (this.Wo = !0),
+        (this.zo = !0),
         !1
       );
     const a = this.nn(L._o) || !1;
     if (
-      ((this.u = Bt.qo(t, a)), a && this.u.xo(t), new O.ee(null, !0).jr(i.re))
+      ((this.u = Bt.xo(t, a)), a && this.u.Jo(t), new O.ee(null, !0).jr(i.re))
     )
       return (
         r.j.info("Ignoring all activity due to previous opt out"),
-        (this.Wo = !0),
+        (this.zo = !0),
         !1
       );
     for (const t of oo(this.options))
-      -1 === Lt(r.Jo).indexOf(t) &&
+      -1 === Pt(r.Yo).indexOf(t) &&
         r.j.warn(`Ignoring unknown initialization option '${t}'.`);
     const l = ["mparticle", "wordpress", "tealium"];
-    if (null != this.nn(L.Ro)) {
-      const t = this.nn(L.Ro);
+    if (null != this.nn(L.Mo)) {
+      const t = this.nn(L.Mo);
       -1 !== l.indexOf(t)
-        ? (this.jo = t)
+        ? (this.Do = t)
         : r.j.error("Invalid sdk flavor passed: " + t);
     }
-    let u = this.nn(r.Jo.Io);
+    let u = this.nn(r.Yo.Io);
     if (null != u)
       if (p(u)) {
         const t = [];
@@ -157,24 +158,25 @@ class Wt {
       (this._e = new Dt(this.u, this.ft, this.wt, this.nn(L.wo)));
     const f = new E();
     return (
-      (this.Do = new kt(this.u, this.nn(L.So), f)),
+      (this.Uo = new kt(this.u, this.nn(L.So), f)),
       this.jt(f),
-      (this.gt = new Pt(
+      (this.gt = new Rt(
         this.fn,
         this.u,
-        this.Do,
+        this.Uo,
         this.ft,
         this._e,
         this.wt,
         this.cn,
-        this.Uo,
-        this.Mo,
-        this.jo || "",
+        this.Bo,
+        this.jo,
+        this.Do || "",
         this.nn(L.Oo),
+        this.nn(L.Po),
       )),
-      (this.ki = new Rt(
+      (this.ki = new Lt(
         this.cn,
-        this.Uo,
+        this.Bo,
         this._e,
         this.fn,
         this.ft,
@@ -183,7 +185,7 @@ class Wt {
         (t) => {
           if (this.fe()) for (const i of this.gr()) i.Ts(t);
         },
-        this.Do,
+        this.Uo,
         this.gt,
       )),
       this.ki.initialize(),
@@ -192,7 +194,7 @@ class Wt {
           L.Eo,
         )}" with API key "${this.cn}".`,
       ),
-      null != this.nn(L.Co) &&
+      null != this.nn(L.Ro) &&
         z(
           "enableHtmlInAppMessages",
           "initialization option",
@@ -200,54 +202,54 @@ class Wt {
         ),
       et.o(),
       this.wt.Ci(() => {
-        this.Bo &&
+        this.Wo &&
           this.wt &&
           this.wt.vi() &&
           import("../FeatureFlags/refresh-feature-flags.js").then((t) => {
-            if (!this.Bo) return;
+            if (!this.Wo) return;
             (0, t.default)();
           });
       }),
       this.ki.pr(() => {
-        this.Bo &&
+        this.Wo &&
           this.wt &&
           this.wt.vi() &&
           import("../FeatureFlags/refresh-feature-flags.js").then((t) => {
-            if (!this.Bo) return;
+            if (!this.Wo) return;
             (0, t.default)(void 0, void 0, !0);
           });
       }),
-      this.zo.Et(this.options),
-      (this.Bo = !0),
+      this.Vo.Et(this.options),
+      (this.Wo = !0),
       !0
     );
   }
   destroy(t) {
     if ((r.j.destroy(), this.fe())) {
-      this.Vo.Et(), this.Vo.removeAllSubscriptions();
-      for (const t of this.Go) t.destroy();
-      this.Go = [];
-      for (const t of this.Ko) t.clearData(!1);
-      (this.Ko = []),
+      this.Go.Et(), this.Go.removeAllSubscriptions();
+      for (const t of this.Ko) t.destroy();
+      this.Ko = [];
+      for (const t of this.Ho) t.clearData(!1);
+      (this.Ho = []),
         this.removeAllSubscriptions(),
         (this.Ve = []),
         null != this.ki && this.ki.destroy(),
         (this.ki = null),
-        (this.Do = null),
+        (this.Uo = null),
         (this.fn = null),
         (this.gt = null),
         (this.wt = null),
         (this._e = null),
         (this.ft = null),
         (this.options = {}),
-        (this.jo = void 0),
-        (this.Bo = !1),
+        (this.Do = void 0),
         (this.Wo = !1),
+        (this.zo = !1),
         t && (this.u = null);
     }
   }
   rr() {
-    if (this.Yo()) return !1;
+    if (this.Xo()) return !1;
     if (!this.fe()) throw new Error(P);
     return !0;
   }
@@ -255,10 +257,10 @@ class Wt {
     return this.cn;
   }
   Sr() {
-    return this.Do;
+    return this.Uo;
   }
   Ys() {
-    return this.Uo;
+    return this.Bo;
   }
   te() {
     return this.fn;
@@ -270,7 +272,7 @@ class Wt {
     return this.options[t];
   }
   gr() {
-    return this.Ko;
+    return this.Ho;
   }
   cr() {
     return this.ki;
@@ -291,17 +293,17 @@ class Wt {
     return this.ft;
   }
   nr() {
-    return !0 === this.nn(L.Lo) || !0 === this.nn(L.Co);
+    return !0 === this.nn(L.Co) || !0 === this.nn(L.Ro);
   }
   g(t) {
     let i = !1;
-    for (const s of this.Go) s === t && (i = !0);
-    i || this.Go.push(t);
+    for (const s of this.Ko) s === t && (i = !0);
+    i || this.Ko.push(t);
   }
   dr(t) {
     let i = !1;
-    for (const s of this.Ko) s.constructor === t.constructor && (i = !0);
-    t instanceof y && !i && this.Ko.push(t);
+    for (const s of this.Ho) s.constructor === t.constructor && (i = !0);
+    t instanceof y && !i && this.Ho.push(t);
   }
   jt(t) {
     t instanceof E && this.Ve.push(t);
@@ -313,16 +315,16 @@ class Wt {
     if (this.rr()) for (const i of this.Ve) i.removeSubscription(t);
   }
   ne(t) {
-    this.Wo = t;
+    this.zo = t;
   }
   fe() {
-    return this.Bo;
-  }
-  Yo() {
     return this.Wo;
   }
+  Xo() {
+    return this.zo;
+  }
   ks() {
-    return this.Mo;
+    return this.jo;
   }
 }
 const e = new Wt();

package/src/managers/device-manager.js

@@ -4,19 +4,19 @@ import DeviceProperties from "../Core/device-properties.js";
 import _t from "../models/identifier.js";
 import r from "../../shared-lib/braze-shared-lib.js";
 import { STORAGE_KEYS as i } from "../managers/storage-manager.js";
-import { values as Lt } from "../util/code-utils.js";
+import { values as Pt } from "../util/code-utils.js";
 import { getErrorMessage as ei } from "../util/error-utils.js";
 export default class Ot {
   constructor(t, e) {
     (this.u = t),
       (this.Qo = e),
       (this.u = t),
-      null == e && (e = Lt(DeviceProperties)),
+      null == e && (e = Pt(DeviceProperties)),
       (this.Qo = e);
   }
   ce(t = !0) {
-    let e = this.u.tu(i.eu.Xo);
-    null == e && ((e = new _t(r.Z.Y())), t && this.u.uu(i.eu.Xo, e));
+    let e = this.u.tu(i.eu.Zo);
+    null == e && ((e = new _t(r.Z.Y())), t && this.u.uu(i.eu.Zo, e));
     const s = new xt(e.iu);
     for (let t = 0; t < this.Qo.length; t++) {
       switch (this.Qo[t]) {
@@ -24,19 +24,19 @@ export default class Ot {
           s.browser = V.browser;
           break;
         case DeviceProperties.BROWSER_VERSION:
-          s.Zo = V.version;
+          s.Ia = V.version;
           break;
         case DeviceProperties.OS:
-          s.os = this.Ia();
+          s.os = this.Ta();
           break;
         case DeviceProperties.RESOLUTION:
-          s.Ta = screen.width + "x" + screen.height;
+          s.Da = screen.width + "x" + screen.height;
           break;
         case DeviceProperties.LANGUAGE:
           s.language = V.language;
           break;
         case DeviceProperties.TIME_ZONE:
-          s.timeZone = this.Da(new Date());
+          s.timeZone = this.Oa(new Date());
           break;
         case DeviceProperties.USER_AGENT:
           s.userAgent = V.userAgent;
@@ -44,12 +44,12 @@ export default class Ot {
     }
     return s;
   }
-  Ia() {
-    if (V.Oa()) return V.Oa();
-    const t = this.u.v(i.k.Ca);
-    return t && t.os_version ? t.os_version : V.Ia();
+  Ta() {
+    if (V.Ca()) return V.Ca();
+    const t = this.u.v(i.k.Fa);
+    return t && t.os_version ? t.os_version : V.Ta();
   }
-  Da(t) {
+  Oa(t) {
     let e = !1;
     if ("undefined" != typeof Intl && "function" == typeof Intl.DateTimeFormat)
       try {
@@ -66,9 +66,9 @@ export default class Ot {
       }
     if (e) return "";
     const s = t.getTimezoneOffset();
-    return this.Fa(s);
+    return this.Ga(s);
   }
-  Fa(t) {
+  Ga(t) {
     const e = Math.trunc(t / 60),
       r = Math.trunc(t % 60);
     let s = "GMT";