@braze/web-sdk 5.3.1 → 5.4.0

package/index.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definitions for @braze/web-sdk v5.3.1
+* Type definitions for @braze/web-sdk v5.4.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.4/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.4/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.1",
+  "version": "5.4.0",
   "description": "Braze SDK for web sites and other JS platforms.",
   "main": "src/index.js",
   "scripts": {

package/shared-lib/event-types.js

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

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

@@ -338,7 +338,7 @@ A.Yt = {
     Sd: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
     ss: {
-      $a: "data",
+      La: "data",
       hr: "pushClicks",
       cu: "pushSubscribed",
       Cd: "fallbackDevice",

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.1)";
+      const o = "Braze SDK Warning: " + n + " (v5.4.0)";
       null != r.vd ? r.vd(o) : console.warn(o);
     }
   },
   error: function (n) {
     if (r.zg) {
-      const o = "Braze SDK Error: " + n + " (v5.3.1)";
+      const o = "Braze SDK Error: " + n + " (v5.4.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",
+  ka: "disablePushTokenMaintenance",
+  Ao: "enableLogging",
   No: "enableSdkAuthentication",
-  Ma: "manageServiceWorkerExternally",
+  _a: "manageServiceWorkerExternally",
   Oo: "minimumIntervalBetweenTriggerActionsInSeconds",
-  Po: "sessionTimeoutInSeconds",
-  Ro: "appVersion",
+  Ro: "sessionTimeoutInSeconds",
+  Po: "appVersion",
   Lo: "appVersionNumber",
   wa: "serviceWorkerLocation",
-  ya: "safariWebsitePushId",
+  Ma: "safariWebsitePushId",
   zn: "localization",
   bo: "contentSecurityNonce",
   Do: "allowUserSuppliedJavascript",
@@ -22,6 +22,7 @@ export default {
   Lh: "requireExplicitInAppMessageDismissal",
   Mo: "doNotLoadFontAwesome",
   Uo: "deviceId",
-  Bo: "sdkFlavor",
+  ya: "serviceWorkerScope",
+  Wo: "sdkFlavor",
   tn: "openCardsInNewTab",
 };

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
   );
 }

package/src/Core/index.js

@@ -9,6 +9,7 @@ export { getDeviceId } from "./get-device-id.js";
 export { getUser } from "./get-user.js";
 export { initialize } from "./initialize.js";
 export { isDisabled } from "./is-disabled.js";
+export { isInitialized } from "./is-initialized.js";
 export { logCustomEvent } from "./log-custom-event.js";
 export { logPurchase } from "./log-purchase.js";
 export { openSession } from "./open-session.js";

package/src/Core/is-initialized.js

@@ -0,0 +1,4 @@
+import e from "../managers/braze-instance.js";
+export function isInitialized() {
+  return e.so();
+}

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

@@ -0,0 +1,172 @@
+import { getUser as ro } from "../../Core/get-user.js";
+import { keys as to } from "../../util/code-utils.js";
+import { parseQueryStringKeyValues as ut } from "../../util/url-utils.js";
+import { WindowUtils as eo } from "../../util/window-utils.js";
+import { logInAppMessageHtmlClick } from "../log-in-app-message-html-click.js";
+import InAppMessage from "../models/in-app-message.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 const buildHtmlClickHandler = (t, r, e, o) => {
+  const s = e.getAttribute("href"),
+    n = e.onclick;
+  return (i) => {
+    if (null != n && "function" == typeof n && !1 === n.bind(e)(i)) return;
+    let u = ut(s).abButtonId;
+    if (
+      ((null != u && "" !== u) || (u = e.getAttribute("id") || void 0),
+      null != s && "" !== s && 0 !== s.indexOf("#"))
+    ) {
+      const n =
+          "blank" ===
+          (e.getAttribute("target") || "").toLowerCase().replace("_", ""),
+        c = o || t.openTarget === InAppMessage.OpenTarget.BLANK || n,
+        a = () => {
+          logInAppMessageHtmlClick(t, u, s), eo.openUri(s, c, i);
+        };
+      c ? a() : t.Cr(r, a);
+    } else logInAppMessageHtmlClick(t, u, s || void 0);
+    return i.stopPropagation(), !1;
+  };
+};
+export const applyNonceToDynamicallyCreatedTags = (t, r, e) => {
+  const o = `([\\w]+)\\s*=\\s*document.createElement\\(['"]${e}['"]\\)`,
+    s = t.match(new RegExp(o));
+  if (s) {
+    const e = `${s[1]}.setAttribute("nonce", "${r}")`;
+    return `${t.slice(0, s.index + s[0].length)};${e};${t.slice(
+      s.index + s[0].length,
+    )}`;
+  }
+  return null;
+};
+export const buildBrazeBridge = (t, o, s) => {
+  const n = {
+      closeMessage: function () {
+        t.Cr(o);
+      },
+      logClick: function () {
+        logInAppMessageHtmlClick(t, ...arguments);
+      },
+      display: {},
+      web: {},
+    },
+    requestPushPermission = function () {
+      return function () {
+        const t = arguments;
+        import("../../Push/request-push-permission.js").then((o) => {
+          e.so()
+            ? o.requestPushPermission(...Array.prototype.slice.call(t))
+            : r.error(_);
+        });
+      };
+    },
+    i = {
+      requestImmediateDataFlush: function () {
+        const t = arguments;
+        import("../../Core/request-immediate-data-flush.js").then(
+          ({ requestImmediateDataFlush: requestImmediateDataFlush }) => {
+            e.so()
+              ? requestImmediateDataFlush(...Array.prototype.slice.call(t))
+              : r.error(_);
+          },
+        );
+      },
+      logCustomEvent: function () {
+        const t = arguments;
+        import("../../Core/log-custom-event.js").then(
+          ({ logCustomEvent: logCustomEvent }) => {
+            if (!e.so()) return void r.error(_);
+            logCustomEvent(...Array.prototype.slice.call(t));
+          },
+        );
+      },
+      logPurchase: function () {
+        const t = arguments;
+        import("../../Core/log-purchase.js").then(
+          ({ logPurchase: logPurchase }) => {
+            if (!e.so()) return void r.error(_);
+            logPurchase(...Array.prototype.slice.call(t));
+          },
+        );
+      },
+      unregisterPush: function () {
+        const t = arguments;
+        import("../../Push/unregister-push.js").then(
+          ({ unregisterPush: unregisterPush }) => {
+            e.so()
+              ? unregisterPush(...Array.prototype.slice.call(t))
+              : r.error(_);
+          },
+        );
+      },
+      requestPushPermission: requestPushPermission(),
+      changeUser: function () {
+        const t = arguments;
+        import("../../Core/change-user.js").then(
+          ({ changeUser: changeUser }) => {
+            if (!e.so()) return void r.error(_);
+            changeUser(...Array.prototype.slice.call(t));
+          },
+        );
+      },
+    },
+    u = function (t) {
+      return function () {
+        i[t](...Array.prototype.slice.call(arguments));
+      };
+    };
+  for (const t of to(i)) n[t] = u(t);
+  const c = [
+      "setFirstName",
+      "setLastName",
+      "setEmail",
+      "setGender",
+      "setDateOfBirth",
+      "setCountry",
+      "setHomeCity",
+      "setEmailNotificationSubscriptionType",
+      "setLanguage",
+      "addAlias",
+      "setPushNotificationSubscriptionType",
+      "setPhoneNumber",
+      "setCustomUserAttribute",
+      "addToCustomAttributeArray",
+      "removeFromCustomAttributeArray",
+      "incrementCustomUserAttribute",
+      "setCustomLocationAttribute",
+      "addToSubscriptionGroup",
+      "removeFromSubscriptionGroup",
+    ],
+    a = function (t) {
+      return function () {
+        const r = ro();
+        r && r[t](...Array.prototype.slice.call(arguments));
+      };
+    },
+    m = {};
+  for (let t = 0; t < c.length; t++) m[c[t]] = a(c[t]);
+  n.getUser = function () {
+    return m;
+  };
+  const l = { showFeed: s },
+    f = function (r) {
+      return function () {
+        const e = arguments;
+        t.Cr(o, function () {
+          l[r](...Array.prototype.slice.call(e));
+        });
+      };
+    },
+    p = n.display;
+  for (const t of to(l)) p[t] = f(t);
+  const d = { registerAppboyPushMessages: requestPushPermission() },
+    g = function (t) {
+      return function () {
+        d[t](...Array.prototype.slice.call(arguments));
+      };
+    },
+    h = n.web;
+  for (const t of to(d)) h[t] = g(t);
+  return n;
+};