@braze/web-sdk 4.6.3 → 4.7.0

package/index.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definitions for @braze/web-sdk v4.6.3
+* Type definitions for @braze/web-sdk v4.7.0
 * Project: https://github.com/braze-inc/braze-web-sdk
 * (c) Braze, Inc. 2023 - http://braze.com
 * License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE
@@ -1270,12 +1270,17 @@
      * @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.
      *    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,
+     *    follow the guidelines in our
+     *    [public docs](https://www.braze.com/docs/user_guide/data_and_analytics/custom_data/custom_attributes/array_of_objects/#usage-examples).
      *
      * @returns {boolean} Whether the update was successfully enqueued.
      */
     setCustomUserAttribute(
       key: string,
-      value: number | boolean | Date | string | string[] | null
+      value: number | boolean | Date | string | string[] | object | object[] | null,
+      merge?: boolean
     ): boolean;
 
     /**
@@ -2000,16 +2005,16 @@
    * - 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/4.6/service-worker.js');
+   * self.importScripts('https://js.appboycdn.com/web-sdk-develop/4.7/service-worker.js');
    * ```
    *
    * For more details, see [Our Product Documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
    *
    * @param successCallback - When the user subscribes to push successfully this callback will be
    *    invoked with the user's endpoint, public key, and user auth key (endpoint, publicKey, userAuth).
-   * @param deniedCallback - If push permission is denied, this callback will be invoked. If the denial
-   *    is temporary, it will be invoked with a parameter of `true` - otherwise it will be invoked with a parameter
-   *    of `false`.
+   * @param deniedCallback - If push permission is denied or an error is encountered while registering, this callback will
+   *    be invoked. If the denial is temporary, it will be invoked with a parameter of `true` - otherwise it will be invoked
+   *    with a parameter of `false`.
    */
   export function requestPushPermission(
     successCallback?: (
@@ -2189,7 +2194,7 @@
    */
   export function subscribeToSdkAuthenticationFailures(subscriber: (
     error: {
-      errorCode: string,
+      errorCode: number,
       reason?: string,
       userId?: string,
       signature?: string
@@ -2353,7 +2358,7 @@
      *   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/4.6/service-worker.js');` or by including the content
+     *   `self.importScripts('https://js.appboycdn.com/web-sdk-develop/4.7/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": "4.6.3",
+  "version": "4.7.0",
   "description": "Braze SDK for web sites and other JS platforms.",
   "main": "src/index.js",
   "scripts": {

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

@@ -3,6 +3,6 @@ import { EventTypes as ve, InternalEventTypes as De } from "./event-types.js";
 import Be from "./guid.js";
 import Ae from "./indexed-db-adapter.js";
 import Ge from "./logger.js";
-import Oe from "./supported-options.js";
-const r = { Dn: je, A: ve, Ar: De, it: Be, qt: Ae, xt: Ae.ep, D: Ge, Go: Oe };
+import Ue from "./supported-options.js";
+const r = { yn: je, A: ve, Ar: De, it: Be, qt: Ae, xt: Ae.ep, D: Ge, Wo: Ue };
 export default r;

package/shared-lib/encoding-utils.js

@@ -1,5 +1,5 @@
 const je = {
-  Pn: function(t) {
+  wn: function(t) {
     const r = (t + "=".repeat((4 - (t.length % 4)) % 4))
         .replace(/\-/g, "+")
         .replace(/_/g, "/"),

package/shared-lib/event-types.js

@@ -1,32 +1,33 @@
 const ve = {
     CustomEvent: "ce",
     Pr: "p",
-    xl: "pc",
+    Nl: "pc",
     cc: "ca",
-    Ba: "i",
+    qa: "i",
     qs: "ie",
     T: "cci",
     W: "ccic",
     _: "ccc",
     L: "ccd",
-    _h: "ss",
-    gh: "se",
-    bi: "si",
-    yi: "sc",
-    ji: "sbc",
-    vi: "sfe",
+    yh: "ss",
+    wh: "se",
+    Mi: "si",
+    Ii: "sc",
+    Ai: "sbc",
+    Ze: "sfe",
     ro: "iec",
-    Ul: "lr",
-    Ol: "uae",
+    Ml: "lr",
+    Rl: "uae",
     U: "ci",
     F: "cc",
-    Bl: "lcaa",
-    Wl: "lcar",
-    Tn: "inc",
-    En: "add",
-    Fn: "rem",
-    Un: "set",
-    Gl: "sgu"
+    Ul: "lcaa",
+    Il: "lcar",
+    Fn: "inc",
+    Un: "add",
+    En: "rem",
+    Sn: "set",
+    An: "ncam",
+    xl: "sgu"
   },
   De = { qr: "feed_displayed", dc: "content_cards_displayed" };
 export { ve as EventTypes, De as InternalEventTypes };

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

@@ -301,14 +301,14 @@ Ae.ep = {
     dd: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
     $t: {
-      Kl: "data",
+      Ol: "data",
       jr: "pushClicks",
       cu: "pushSubscribed",
       ud: "fallbackDevice",
       Mt: "cardUpdates",
       oe: "optOut",
       $r: "pendingData",
-      Vn: "sdkAuthenticationSignature"
+      Mn: "sdkAuthenticationSignature"
     },
     se: 1
   }

package/shared-lib/logger.js

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

package/shared-lib/supported-options.js

@@ -1,26 +1,26 @@
 export default {
-  ho: "allowCrawlerActivity",
-  po: "baseUrl",
-  Eo: "noCookies",
-  _o: "devicePropertyAllowlist",
+  Yn: "allowCrawlerActivity",
+  Xn: "baseUrl",
+  Zn: "noCookies",
+  ho: "devicePropertyAllowlist",
   ta: "disablePushTokenMaintenance",
-  Io: "enableLogging",
-  Ao: "enableSdkAuthentication",
+  po: "enableLogging",
+  Eo: "enableSdkAuthentication",
   ia: "manageServiceWorkerExternally",
-  So: "minimumIntervalBetweenTriggerActionsInSeconds",
-  No: "sessionTimeoutInSeconds",
-  wo: "appVersion",
+  _o: "minimumIntervalBetweenTriggerActionsInSeconds",
+  Io: "sessionTimeoutInSeconds",
+  Ao: "appVersion",
   na: "serviceWorkerLocation",
   ra: "safariWebsitePushId",
-  zn: "localization",
+  jn: "localization",
   ao: "contentSecurityNonce",
-  To: "enableHtmlInAppMessages",
-  Oo: "allowUserSuppliedJavascript",
+  So: "enableHtmlInAppMessages",
+  No: "allowUserSuppliedJavascript",
   no: "inAppMessageZIndex",
   lo: "openInAppMessagesInNewTab",
   en: "openNewsFeedCardsInNewTab",
-  eh: "requireExplicitInAppMessageDismissal",
-  vo: "doNotLoadFontAwesome",
-  Co: "sdkFlavor",
+  Ih: "requireExplicitInAppMessageDismissal",
+  wo: "doNotLoadFontAwesome",
+  To: "sdkFlavor",
   tn: "openCardsInNewTab"
 };

package/src/Core/handle-braze-action.js

@@ -1,22 +1,22 @@
 import r from "../../shared-lib/braze-shared-lib.js";
 import e from "../managers/braze-instance.js";
 import {
-  BRAZE_ACTIONS as _,
-  getDecodedBrazeAction as J
+  BRAZE_ACTIONS as P,
+  getDecodedBrazeAction as _
 } from "../util/braze-actions.js";
 import {
-  BRAZE_ACTION_URI_REGEX as O,
-  isValidBrazeActionJson as P
+  BRAZE_ACTION_URI_REGEX as J,
+  isValidBrazeActionJson as O
 } from "../util/validation-utils.js";
 import { WindowUtils as H } from "../util/window-utils.js";
 import { getUser as Q } from "./get-user.js";
-export function _handleBrazeAction(a, s, i) {
+export function _handleBrazeAction(s, o, i) {
   if (e.rr())
-    if (O.test(a)) {
-      const e = J(a);
+    if (J.test(s)) {
+      const e = _(s);
       if (!e) return;
-      const s = async e => {
-        if (!P(e))
+      const o = e => {
+        if (!O(e))
           return void r.D.error(
             `Decoded Braze Action json is invalid: ${JSON.stringify(
               e,
@@ -24,40 +24,46 @@ export function _handleBrazeAction(a, s, i) {
               2
             )}`
           );
-        const a = e[_.properties.type];
-        if (a === _.types.ue) for (const r of e[_.properties.me]) s(r);
+        const s = e[P.properties.type];
+        if (s === P.types.ue) for (const r of e[P.properties.me]) o(r);
         else {
-          const s = e[_.properties.fe];
-          let i, o;
-          switch (a) {
-            case _.types.logCustomEvent:
-              (i = await import("./log-custom-event.js")),
-                i.logCustomEvent.apply(null, Array.prototype.slice.call(s));
+          const o = e[P.properties.fe];
+          let i;
+          switch (s) {
+            case P.types.logCustomEvent:
+              import("./log-custom-event.js").then(
+                ({ logCustomEvent: logCustomEvent }) => {
+                  logCustomEvent.apply(null, Array.prototype.slice.call(o));
+                }
+              );
               break;
-            case _.types.requestPushPermission:
-              (i = await import("../Push/request-push-permission.js")),
-                i.requestPushPermission();
+            case P.types.requestPushPermission:
+              import("../Push/request-push-permission.js").then(
+                ({ requestPushPermission: requestPushPermission }) => {
+                  requestPushPermission();
+                }
+              );
               break;
-            case _.types.setEmailNotificationSubscriptionType:
-            case _.types.setPushNotificationSubscriptionType:
-            case _.types.setCustomUserAttribute:
-            case _.types.addToSubscriptionGroup:
-            case _.types.removeFromSubscriptionGroup:
-            case _.types.addToCustomAttributeArray:
-            case _.types.removeFromCustomAttributeArray:
-              (o = Q()), o[a].apply(o, Array.prototype.slice.call(s));
+            case P.types.setEmailNotificationSubscriptionType:
+            case P.types.setPushNotificationSubscriptionType:
+            case P.types.setCustomUserAttribute:
+            case P.types.addToSubscriptionGroup:
+            case P.types.removeFromSubscriptionGroup:
+            case P.types.addToCustomAttributeArray:
+            case P.types.removeFromCustomAttributeArray:
+              (i = Q()), i[s].apply(i, Array.prototype.slice.call(o));
               break;
-            case _.types.de:
-            case _.types.pe:
-              H.openUri.apply(null, Array.prototype.slice.call(s));
+            case P.types.de:
+            case P.types.pe:
+              H.openUri.apply(null, Array.prototype.slice.call(o));
               break;
             default:
-              r.D.info(`Ignoring unknown Braze Action: ${a}`);
+              r.D.info(`Ignoring unknown Braze Action: ${s}`);
           }
         }
       };
-      s(e);
-    } else H.openUri(a, i, s);
+      o(e);
+    } else H.openUri(s, i, o);
 }
 export function handleBrazeAction(e, r) {
   _handleBrazeAction(e, r);

package/src/Core/log-custom-event.js

@@ -7,6 +7,7 @@ import {
   validateCustomProperties as X,
   validateCustomString as Y
 } from "../util/validation-utils.js";
+import { LOG_CUSTOM_EVENT_STRING as Z } from "../common/constants.js";
 export function logCustomEvent(t, o) {
   if (!e.rr()) return !1;
   if (null == t || t.length <= 0)
@@ -17,13 +18,7 @@ export function logCustomEvent(t, o) {
       !1
     );
   if (!Y(t, "log custom event", "the event name")) return !1;
-  const [n, i] = X(
-    o,
-    "logCustomEvent",
-    "eventProperties",
-    `log custom event "${t}"`,
-    "event"
-  );
+  const [n, i] = X(o, Z, "eventProperties", `log custom event "${t}"`, "event");
   if (!n) return !1;
   if (e.ir().ge(t))
     return r.D.info(`Custom Event "${t}" is blocklisted, ignoring.`), !1;

package/src/Core/log-purchase.js

@@ -1,5 +1,5 @@
 import e from "../managers/braze-instance.js";
-import { MAX_PURCHASE_QUANTITY as Z } from "../common/constants.js";
+import { MAX_PURCHASE_QUANTITY as rr } from "../common/constants.js";
 import r from "../../shared-lib/braze-shared-lib.js";
 import V from "../triggers/models/trigger-events.js";
 import { TriggersProviderFactory as W } from "../triggers/triggers-provider-factory.js";
@@ -34,10 +34,10 @@ export function logPurchase(o, i, t, n, D) {
       ),
       !1
     );
-  if (g < 1 || g > Z)
+  if (g < 1 || g > rr)
     return (
       r.D.error(
-        `logPurchase requires a quantity >1 and <${Z}, got ${g}, ignoring.`
+        `logPurchase requires a quantity >1 and <${rr}, got ${g}, ignoring.`
       ),
       !1
     );

package/src/Core/wipe-data.js

@@ -1,11 +1,11 @@
 import e from "../managers/braze-instance.js";
-import { keys as rr } from "../util/code-utils.js";
+import { keys as or } from "../util/code-utils.js";
 import r from "../../shared-lib/braze-shared-lib.js";
 export function wipeData() {
   if (null == e.l())
     throw new Error("Braze must be initialized before calling methods.");
   e.l().clearData();
-  const o = rr(r.xt);
+  const o = or(r.xt);
   for (let e = 0; e < o.length; e++) {
     const i = o[e],
       t = r.xt[i];

package/src/FeatureFlags/feature-flag.js

@@ -1,22 +1,36 @@
 import r from "../../shared-lib/braze-shared-lib.js";
 export default class FeatureFlag {
   constructor(t, r = !1, e = {}) {
-    (this.id = t), (this.enabled = r), (this.properties = e);
+    (this.id = t),
+      (this.enabled = r),
+      (this.properties = e),
+      (this.id = t),
+      (this.enabled = r),
+      (this.properties = e);
   }
   getStringProperty(t) {
-    if (!this.yr(t)) return null;
     const r = this.properties[t];
-    return this.Er(r, "string") ? r.value : null;
+    return null == r
+      ? (this.yr(t), null)
+      : this.Er(r)
+      ? r.value
+      : (this.Br("string"), null);
   }
   getNumberProperty(t) {
-    if (!this.yr(t)) return null;
     const r = this.properties[t];
-    return this.Er(r, "number") ? r.value : null;
+    return null == r
+      ? (this.yr(t), null)
+      : this.Ir(r)
+      ? r.value
+      : (this.Br("number"), null);
   }
   getBooleanProperty(t) {
-    if (!this.yr(t)) return null;
     const r = this.properties[t];
-    return this.Er(r, "boolean") ? r.value : null;
+    return null == r
+      ? (this.yr(t), null)
+      : this.Nr(r)
+      ? r.value
+      : (this.Br("boolean"), null);
   }
   ss() {
     const t = {};
@@ -27,17 +41,20 @@ export default class FeatureFlag {
       t
     );
   }
+  Br(t) {
+    r.D.info(`Property is not of type ${t}.`);
+  }
   yr(t) {
-    return (
-      !(!this.properties || !this.properties[t]) ||
-      (r.D.info(`${t} not found in feature flag properties.`), !1)
-    );
+    r.D.info(`${t} not found in feature flag properties.`);
   }
-  Er(t, e) {
-    return (
-      (t.type === e && typeof t.value === e) ||
-      (r.D.info(`Property is not of type ${e}.`), !1)
-    );
+  Er(t) {
+    return "string" === t.type && "string" == typeof t.value;
+  }
+  Ir(t) {
+    return "number" === t.type && "number" == typeof t.value;
+  }
+  Nr(t) {
+    return "boolean" === t.type && "boolean" == typeof t.value;
   }
 }
 (FeatureFlag.hs = { ns: "id", Fe: "e", we: "pr" }),