@braze/web-sdk 5.1.1 → 5.2.0

package/index.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definitions for @braze/web-sdk v5.1.1
+* Type definitions for @braze/web-sdk v5.2.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
@@ -1289,7 +1289,8 @@ export class User {
    * @param key - The identifier of the custom attribute. Limited to 255 characters in length, cannot begin with
    *    a $, and can only contain alphanumeric characters and punctuation.
    * @param value - Can be numeric, boolean, a Date object, a string, or an array of strings. Strings are limited to
-   *    255 characters in length, cannot begin with a $, and can only contain alphanumeric characters and punctuation.
+   *    255 characters in length, cannot begin with a $ and cannot contain new lines, tabs or double quotes.
+   *    It can only include alphanumeric characters and other punctuation.
    *    Passing a null value will remove this custom attribute from the user.
    * @param merge - Whether the value should be merged with the existing value on the backend. If `false` (default), any existing
    *    attribute will be overwritten. If `true`, existing objects and arrays of objects will be merged. To update an array of objects,
@@ -1767,9 +1768,9 @@ export function toggleFeed(
  * Additionally, if you identify a user which has never been identified on another device, the entire history of
  *    that user as an "anonymous" user on this device will be preserved and associated with the newly identified
  *    user. However, if you identify a user which *has* been identified in another app, any history which was
- *    already flushed to the server for the anonymous user on this device will become orphaned and will not be
- *    associated with any future users. These orphaned users are not considered in your user counts and will not
- *    be messaged.
+ *    already flushed to the server for the anonymous user on this device will be merged into the identified user.
+ *    Any fields that already exist on the identified user will not be overwritten, and the merge is limited
+ *    to the fields listed [here](https://www.braze.com/docs/api/endpoints/user_data/post_users_merge/).
  *
  * Note: Once you identify a user, you cannot revert to the "anonymous" user. The transition from anonymous to
  *    identified tracking is only allowed once because the initial anonymous user receives special treatment to
@@ -2088,7 +2089,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.1/service-worker.js');
+ * self.importScripts('https://js.appboycdn.com/web-sdk-develop/5.2/service-worker.js');
  * ```
  *
  * For more details, see [Our Product Documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
@@ -2394,7 +2395,7 @@ export type InitializationOptions = {
   /**
    * A numerical app version value which can be used for user segmentation. This value must be sent with four fields, such as
    * "1.2.3.4", otherwise it will be ignored.
-   * 
+   *
    * Note: `appVersion` must also be set, either with the same value or a unique name for this version.
    */
   appVersionNumber?: string;
@@ -2463,7 +2464,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.1/service-worker.js');` or by including the content
+   *   `self.importScripts('https://js.appboycdn.com/web-sdk-develop/5.2/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;
@@ -2515,6 +2516,11 @@ export type InitializationOptions = {
    *   default with a value of your own.
    */
   sessionTimeoutInSeconds?: number;
+  /**
+   * By default, Braze will assign a random guid as the device ID. Provide a value for this configuration option to override that
+   *   default with a value of your own.
+   */
+  deviceId?: string;
 };
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@braze/web-sdk",
-  "version": "5.1.1",
+  "version": "5.2.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 = {
-  qn: function (t) {
+  Tn: function (t) {
     const r = (t + "=".repeat((4 - (t.length % 4)) % 4))
         .replace(/\-/g, "+")
         .replace(/_/g, "/"),

package/shared-lib/event-types.js

@@ -1,9 +1,9 @@
 const i = {
     CustomEvent: "ce",
     Pr: "p",
-    Iu: "pc",
+    xu: "pc",
     vc: "ca",
-    Za: "i",
+    Ua: "i",
     Ms: "ie",
     M: "cci",
     R: "ccic",
@@ -11,24 +11,24 @@ const i = {
     F: "ccd",
     kl: "ss",
     xl: "se",
-    Ze: "si",
-    Xe: "sc",
-    Ye: "sbc",
-    We: "sfe",
-    fo: "iec",
-    xu: "lr",
-    Pu: "uae",
+    Xe: "si",
+    Ve: "sc",
+    We: "sbc",
+    Cc: "sfe",
+    po: "iec",
+    Pu: "lr",
+    Mu: "uae",
     O: "ci",
     $: "cc",
-    Uu: "lcaa",
-    Ou: "lcar",
-    Hn: "inc",
-    On: "add",
-    Gn: "rem",
-    Ln: "set",
-    Rn: "ncam",
-    _u: "sgu",
+    Ou: "lcaa",
+    Nu: "lcar",
+    On: "inc",
+    Ln: "add",
+    Rn: "rem",
+    $n: "set",
+    Bn: "ncam",
+    Uu: "sgu",
     Fr: "ffi",
   },
-  or = { Br: "feed_displayed", Cc: "content_cards_displayed" };
+  or = { Br: "feed_displayed", Ec: "content_cards_displayed" };
 export { i as EventTypes, or as InternalEventTypes };

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

@@ -6,16 +6,16 @@ export default class A {
       (this.database = t),
       (this.dd = e);
   }
-  fd() {
+  ud() {
     if ("indexedDB" in this.parent) return this.parent.indexedDB;
   }
   isSupported() {
     var t;
     try {
-      if (null == this.fd()) return !1;
+      if (null == this.ud()) return !1;
       {
         const e =
-          null === (t = this.fd()) || void 0 === t
+          null === (t = this.ud()) || void 0 === t
             ? void 0
             : t.open("Braze IndexedDB Support Test");
         if (
@@ -25,7 +25,7 @@ export default class A {
           "undefined" != typeof window)
         ) {
           const t = window,
-            e = t.chrome || t.browser || t.ad;
+            e = t.chrome || t.browser || t.fd;
           if (e && e.runtime && e.runtime.id)
             return (
               this.dd.info(
@@ -45,12 +45,12 @@ export default class A {
       );
     }
   }
-  vd(t, e) {
+  ad(t, e) {
     var n;
     const o =
-      null === (n = this.fd()) || void 0 === n
+      null === (n = this.ud()) || void 0 === n
         ? void 0
-        : n.open(this.database.Dd, this.database.VERSION);
+        : n.open(this.database.vd, this.database.VERSION);
     if (null == o) return "function" == typeof e && e(), !1;
     const i = this;
     return (
@@ -58,7 +58,7 @@ export default class A {
         var e;
         i.dd.info(
           "Upgrading indexedDB " +
-            i.database.Dd +
+            i.database.vd +
             " to v" +
             i.database.VERSION +
             "...",
@@ -89,7 +89,7 @@ export default class A {
         return (
           i.dd.info(
             "Could not open indexedDB " +
-              i.database.Dd +
+              i.database.vd +
               " v" +
               i.database.VERSION +
               ": " +
@@ -105,7 +105,7 @@ export default class A {
   setItem(t, e, n, o, i) {
     if (!this.isSupported()) return "function" == typeof i && i(), !1;
     const r = this;
-    return this.vd((d) => {
+    return this.ad((d) => {
       if (!d.objectStoreNames.contains(t))
         return (
           r.dd.error(
@@ -114,7 +114,7 @@ export default class A {
               " in " +
               t +
               " on indexedDB " +
-              r.database.Dd +
+              r.database.vd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -132,7 +132,7 @@ export default class A {
             " in " +
             t +
             " on indexedDB " +
-            r.database.Dd,
+            r.database.vd,
         ),
           "function" == typeof i && i();
       }),
@@ -144,7 +144,7 @@ export default class A {
   getItem(t, e, n) {
     if (!this.isSupported()) return !1;
     const o = this;
-    return this.vd((i) => {
+    return this.ad((i) => {
       if (!i.objectStoreNames.contains(t))
         return (
           o.dd.error(
@@ -153,7 +153,7 @@ export default class A {
               " in " +
               t +
               " on indexedDB " +
-              o.database.Dd +
+              o.database.vd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -170,7 +170,7 @@ export default class A {
             " in " +
             t +
             " on indexedDB " +
-            o.database.Dd,
+            o.database.vd,
         );
       }),
         (d.onsuccess = (t) => {
@@ -183,14 +183,14 @@ export default class A {
   jr(t, e, n) {
     if (!this.isSupported()) return "function" == typeof n && n(), !1;
     const o = this;
-    return this.vd((i) => {
+    return this.ad((i) => {
       if (!i.objectStoreNames.contains(t))
         return (
           o.dd.error(
             "Could not retrieve last record from " +
               t +
               " on indexedDB " +
-              o.database.Dd +
+              o.database.vd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -203,7 +203,7 @@ export default class A {
       const d = r.objectStore(t).openCursor(null, "prev");
       (d.onerror = () => {
         o.dd.error(
-          "Could not open cursor for " + t + " on indexedDB " + o.database.Dd,
+          "Could not open cursor for " + t + " on indexedDB " + o.database.vd,
         ),
           "function" == typeof n && n();
       }),
@@ -219,7 +219,7 @@ export default class A {
   re(t, e) {
     if (!this.isSupported()) return !1;
     const n = this;
-    return this.vd((o) => {
+    return this.ad((o) => {
       if (!o.objectStoreNames.contains(t))
         return (
           n.dd.error(
@@ -228,7 +228,7 @@ export default class A {
               " from " +
               t +
               " on indexedDB " +
-              n.database.Dd +
+              n.database.vd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -244,7 +244,7 @@ export default class A {
             " from " +
             t +
             " on indexedDB " +
-            n.database.Dd,
+            n.database.vd,
         );
       };
     });
@@ -252,14 +252,14 @@ export default class A {
   Zt(t, e) {
     if (!this.isSupported()) return !1;
     const n = this;
-    return this.vd((o) => {
+    return this.ad((o) => {
       if (!o.objectStoreNames.contains(t))
         return (
           n.dd.error(
             "Could not retrieve objects from " +
               t +
               " on indexedDB " +
-              n.database.Dd +
+              n.database.vd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -277,14 +277,14 @@ export default class A {
               "Cursor closed midway through for " +
                 t +
                 " on indexedDB " +
-                n.database.Dd,
+                n.database.vd,
             ),
             e(s))
           : n.dd.error(
               "Could not open cursor for " +
                 t +
                 " on indexedDB " +
-                n.database.Dd,
+                n.database.vd,
             );
       }),
         (d.onsuccess = (t) => {
@@ -311,7 +311,7 @@ export default class A {
         t.push(this.database.ss[n]);
     }
     const e = this;
-    return this.vd(function (n) {
+    return this.ad(function (n) {
       const o = n.transaction(t, "readwrite");
       o.oncomplete = () => n.close();
       for (let n = 0; n < t.length; n++) {
@@ -321,13 +321,13 @@ export default class A {
             "Could not clear " +
               this.source.name +
               " on indexedDB " +
-              e.database.Dd,
+              e.database.vd,
           );
         };
       }
       o.onerror = function () {
         e.dd.error(
-          "Could not clear object stores on indexedDB " + e.database.Dd,
+          "Could not clear object stores on indexedDB " + e.database.vd,
         );
       };
     });
@@ -335,17 +335,17 @@ export default class A {
 }
 A.Yt = {
   Qt: {
-    Dd: "AppboyServiceWorkerAsyncStorage",
+    vd: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
     ss: {
-      Qa: "data",
+      La: "data",
       hr: "pushClicks",
       cu: "pushSubscribed",
-      pd: "fallbackDevice",
+      Dd: "fallbackDevice",
       ts: "cardUpdates",
       ae: "optOut",
       wr: "pendingData",
-      xh: "sdkAuthenticationSignature",
+      jh: "sdkAuthenticationSignature",
     },
     ie: 1,
   },

package/shared-lib/logger.js

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

package/shared-lib/supported-options.js

@@ -1,26 +1,27 @@
 export default {
-  _o: "allowCrawlerActivity",
-  Io: "baseUrl",
-  Ao: "noCookies",
-  So: "devicePropertyAllowlist",
-  qa: "disablePushTokenMaintenance",
-  No: "enableLogging",
-  Oo: "enableSdkAuthentication",
-  ka: "manageServiceWorkerExternally",
-  Po: "minimumIntervalBetweenTriggerActionsInSeconds",
-  Ro: "sessionTimeoutInSeconds",
-  Lo: "appVersion",
-  Do: "appVersionNumber",
-  Ma: "serviceWorkerLocation",
-  _a: "safariWebsitePushId",
-  Xn: "localization",
-  wo: "contentSecurityNonce",
-  Mo: "allowUserSuppliedJavascript",
-  ho: "inAppMessageZIndex",
-  yo: "openInAppMessagesInNewTab",
+  Eo: "allowCrawlerActivity",
+  _o: "baseUrl",
+  Io: "noCookies",
+  Ao: "devicePropertyAllowlist",
+  Aa: "disablePushTokenMaintenance",
+  So: "enableLogging",
+  No: "enableSdkAuthentication",
+  qa: "manageServiceWorkerExternally",
+  Oo: "minimumIntervalBetweenTriggerActionsInSeconds",
+  Po: "sessionTimeoutInSeconds",
+  Ro: "appVersion",
+  Lo: "appVersionNumber",
+  _a: "serviceWorkerLocation",
+  ka: "safariWebsitePushId",
+  zn: "localization",
+  ho: "contentSecurityNonce",
+  Do: "allowUserSuppliedJavascript",
+  bo: "inAppMessageZIndex",
+  wo: "openInAppMessagesInNewTab",
   en: "openNewsFeedCardsInNewTab",
-  mh: "requireExplicitInAppMessageDismissal",
-  Uo: "doNotLoadFontAwesome",
+  Lh: "requireExplicitInAppMessageDismissal",
+  Mo: "doNotLoadFontAwesome",
+  Uo: "deviceId",
   Bo: "sdkFlavor",
   tn: "openCardsInNewTab",
 };

package/src/InAppMessage/display/html-message-to-html.js

@@ -9,7 +9,8 @@ import { WindowUtils as eo } from "../../util/window-utils.js";
 import e from "../../managers/braze-instance.js";
 import { logger as r } from "../../../shared-lib/index.js";
 import { BRAZE_MUST_BE_INITIALIZED_ERROR as _ } from "../../common/constants.js";
-export default function ct(t, o, n, s, i, u) {
+import { nodeScriptReplace as ct } from "../utils/in-app-message-utils.js";
+export default function at(t, o, n, s, i, u) {
   const c = document.createElement("iframe");
   c.setAttribute("title", "Modal Message"),
     i && (c.style.zIndex = (i + 1).toString());
@@ -67,22 +68,24 @@ export default function ct(t, o, n, s, i, u) {
         }
       }
       const i = c.contentWindow;
-      i.focus(), i.document.write(s ? s.innerHTML : t.message || "");
-      const l = i.document.getElementsByTagName("head")[0];
-      if (null != l) {
+      i.focus();
+      const l = i.document.querySelector("html");
+      l && ((l.innerHTML = s ? s.innerHTML : t.message || ""), ct(l));
+      const f = i.document.getElementsByTagName("head")[0];
+      if (null != f) {
         if (t.be()) {
           const e = document.createElement("style");
           (e.innerHTML = t.css || ""),
             (e.id = t.ye() || ""),
             null != u && e.setAttribute("nonce", u),
-            l.appendChild(e);
+            f.appendChild(e);
         }
         const e = i.document.createElement("base");
-        null != e && (e.setAttribute("target", "_parent"), l.appendChild(e));
+        null != e && (e.setAttribute("target", "_parent"), f.appendChild(e));
       }
-      const f = i.document.getElementsByTagName("title");
-      f && f.length > 0 && c.setAttribute("title", f[0].textContent || "");
-      const d = {
+      const d = i.document.getElementsByTagName("title");
+      d && d.length > 0 && c.setAttribute("title", d[0].textContent || "");
+      const p = {
           closeMessage: function () {
             t.he(c);
           },
@@ -102,7 +105,7 @@ export default function ct(t, o, n, s, i, u) {
             });
           };
         },
-        p = {
+        g = {
           requestImmediateDataFlush: function () {
             const t = arguments;
             import("../../Core/request-immediate-data-flush.js").then(
@@ -152,13 +155,13 @@ export default function ct(t, o, n, s, i, u) {
             );
           },
         },
-        g = function (t) {
+        h = function (t) {
           return function () {
-            p[t](...Array.prototype.slice.call(arguments));
+            g[t](...Array.prototype.slice.call(arguments));
           };
         };
-      for (const t of to(p)) d[t] = g(t);
-      const h = [
+      for (const t of to(g)) p[t] = h(t);
+      const b = [
           "setFirstName",
           "setLastName",
           "setEmail",
@@ -179,51 +182,51 @@ export default function ct(t, o, n, s, i, u) {
           "addToSubscriptionGroup",
           "removeFromSubscriptionGroup",
         ],
-        b = function (t) {
+        y = function (t) {
           return function () {
             const e = ro();
             e && e[t](...Array.prototype.slice.call(arguments));
           };
         },
-        y = {};
-      for (let t = 0; t < h.length; t++) y[h[t]] = b(h[t]);
-      d.getUser = function () {
-        return y;
+        A = {};
+      for (let t = 0; t < b.length; t++) A[b[t]] = y(b[t]);
+      p.getUser = function () {
+        return A;
       };
-      const A = { showFeed: o },
-        j = function (e) {
+      const j = { showFeed: o },
+        C = function (e) {
           return function () {
             const o = arguments;
             t.he(c, function () {
-              A[e](...Array.prototype.slice.call(o));
+              j[e](...Array.prototype.slice.call(o));
             });
           };
         },
-        C = d.display;
-      for (const t of to(A)) C[t] = j(t);
-      const v = { registerAppboyPushMessages: requestPushPermission() },
-        P = function (t) {
+        v = p.display;
+      for (const t of to(j)) v[t] = C(t);
+      const P = { registerAppboyPushMessages: requestPushPermission() },
+        w = function (t) {
           return function () {
-            v[t](...Array.prototype.slice.call(arguments));
+            P[t](...Array.prototype.slice.call(arguments));
           };
         },
-        w = d.web;
-      for (const t of to(v)) w[t] = P(t);
+        E = p.web;
+      for (const t of to(P)) E[t] = w(t);
       if (
-        ((i.appboyBridge = d), (i.brazeBridge = d), t.Ae !== InAppMessage.Ce.je)
+        ((i.appboyBridge = p), (i.brazeBridge = p), t.Ae !== InAppMessage.Ce.je)
       ) {
         const t = i.document.getElementsByTagName("a");
         for (let e = 0; e < t.length; e++) t[e].onclick = a(t[e]);
         const e = i.document.getElementsByTagName("button");
         for (let t = 0; t < e.length; t++) e[t].onclick = a(e[t]);
       }
-      const E = i.document.body;
-      if (null != E) {
-        t.ve() && (E.id = t.htmlId || "");
+      const $ = i.document.body;
+      if (null != $) {
+        t.ve() && ($.id = t.htmlId || "");
         const e = document.createElement("hidden");
-        (e.onclick = d.closeMessage),
+        (e.onclick = p.closeMessage),
           (e.className = "ab-programmatic-close-button"),
-          E.appendChild(e);
+          $.appendChild(e);
       }
       i.dispatchEvent(new CustomEvent("ab.BridgeReady")),
         -1 !== c.className.indexOf("ab-start-hidden") &&

package/src/InAppMessage/display/in-app-message-to-html.js

@@ -13,12 +13,12 @@ import ModalMessage from "../models/modal-message.js";
 import SlideUpMessage from "../models/slide-up-message.js";
 import { logInAppMessageClick } from "../log-in-app-message-click.js";
 import { _handleBrazeAction as u } from "../../Core/handle-braze-action.js";
-import ct from "./html-message-to-html.js";
+import at from "./html-message-to-html.js";
 import le from "./modal-utils.js";
 import { logger as r, Guid as p } from "../../../shared-lib/index.js";
 export default function ce(e, o, a, t, n, s, i, l = document.body) {
   if (((e.we = document.activeElement), e instanceof HtmlMessage))
-    return ct(e, o, a, n, s, i);
+    return at(e, o, a, n, s, i);
   const b = (function (e, o, a, t, n, s, i = document.body) {
     let m = null;
     const l = document.createElement("div");

package/src/InAppMessage/display/modal-utils.js

@@ -3,7 +3,7 @@ import { _handleBrazeAction as u } from "../../Core/handle-braze-action.js";
 import { logInAppMessageButtonClick } from "../log-in-app-message-button-click.js";
 import { toRgba as ie } from "../../util/color-utils.js";
 import { addPassiveEventListener as oe } from "../../util/dom-utils.js";
-import { KeyCodes as at } from "../../util/key-codes.js";
+import { KeyCodes as lt } from "../../util/key-codes.js";
 const le = {
   qe: (t) => {
     const o = t.querySelectorAll(
@@ -16,7 +16,7 @@ const le = {
         s = o[o.length - 1];
       t.addEventListener("keydown", (o) => {
         const a = document.activeElement;
-        o.keyCode === at.lo &&
+        o.keyCode === lt.lo &&
           (o.shiftKey || (a !== s && a !== t)
             ? !o.shiftKey ||
               (a !== e && a !== t) ||