@braze/web-sdk 5.0.0 → 5.1.0

package/README.md

@@ -8,5 +8,5 @@ Note: The Braze Web SDK is meant to be used client-side in a web application and
 
 See the [Public Github Repo](https://github.com/braze-inc/braze-web-sdk#readme) for getting started instructions or [our documentation pages](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/initial_sdk_setup/) for use-case based documentation.
 
-(c) Braze, Inc. 2023 - http://braze.com  
+(c) Braze, Inc. 2024 - http://braze.com  
 License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE

package/index.d.ts

@@ -1,7 +1,7 @@
 /*
-* Type definitions for @braze/web-sdk v5.0.0
+* Type definitions for @braze/web-sdk v5.1.0
 * Project: https://github.com/braze-inc/braze-web-sdk
-* (c) Braze, Inc. 2023 - http://braze.com
+* (c) Braze, Inc. 2024 - http://braze.com
 * License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE
 */
 
@@ -1549,7 +1549,12 @@ export class FeatureFlag {
   /** Indicates whether or not this feature flag is enabled. */
   enabled: boolean;
 
-  /** Properties of this feature flag, listed as key-value pairs. */
+  /**
+   * Properties of this feature flag.
+   *
+   * Avoid accessing these properties directly. Instead, prefer using the `getStringProperty`, `getBooleanProperty`, `getNumberProperty` methods which ensure type safety,
+   * and to avoid breaking changes in the future.
+   */
   properties: Partial<
     Record<
       string,
@@ -2083,7 +2088,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.0/service-worker.js');
+ * self.importScripts('https://js.appboycdn.com/web-sdk-develop/5.1/service-worker.js');
  * ```
  *
  * For more details, see [Our Product Documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
@@ -2389,6 +2394,8 @@ 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;
   /**
@@ -2456,7 +2463,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.0/service-worker.js');` or by including the content
+   *   `self.importScripts('https://js.appboycdn.com/web-sdk-develop/5.1/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.0.0",
+  "version": "5.1.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 ve = {
-  Fn: function (t) {
+const ei = {
+  qn: function (t) {
     const r = (t + "=".repeat((4 - (t.length % 4)) % 4))
         .replace(/\-/g, "+")
         .replace(/_/g, "/"),
@@ -9,4 +9,4 @@ const ve = {
     return o;
   },
 };
-export default ve;
+export default ei;

package/shared-lib/event-types.js

@@ -1,34 +1,34 @@
-const De = {
+const i = {
     CustomEvent: "ce",
     Pr: "p",
-    Mu: "pc",
-    cc: "ca",
-    Ka: "i",
-    qs: "ie",
-    P: "cci",
-    T: "ccic",
-    $: "ccc",
-    H: "ccd",
-    Wl: "ss",
+    Iu: "pc",
+    vc: "ca",
+    Za: "i",
+    Ms: "ie",
+    M: "cci",
+    R: "ccic",
+    I: "ccc",
+    F: "ccd",
+    kl: "ss",
     xl: "se",
-    Vi: "si",
-    Li: "sc",
-    Qi: "sbc",
-    Ki: "sfe",
-    eo: "iec",
-    Lu: "lr",
-    Tu: "uae",
-    R: "ci",
-    B: "cc",
-    Ru: "lcaa",
-    Pu: "lcar",
-    Xn: "inc",
-    Jn: "add",
-    Qn: "rem",
-    Hn: "set",
-    Kn: "ncam",
-    Nu: "sgu",
+    Ze: "si",
+    Xe: "sc",
+    Ye: "sbc",
+    We: "sfe",
+    fo: "iec",
+    xu: "lr",
+    Pu: "uae",
+    O: "ci",
+    $: "cc",
+    Uu: "lcaa",
+    Ou: "lcar",
+    Hn: "inc",
+    On: "add",
+    Gn: "rem",
+    Ln: "set",
+    Rn: "ncam",
+    _u: "sgu",
     Fr: "ffi",
   },
-  Be = { Br: "feed_displayed", dc: "content_cards_displayed" };
-export { De as EventTypes, Be as InternalEventTypes };
+  or = { Br: "feed_displayed", Cc: "content_cards_displayed" };
+export { i as EventTypes, or as InternalEventTypes };

package/shared-lib/guid.js

@@ -1,5 +1,5 @@
-const Ge = {
-  Y: function () {
+const p = {
+  W: function () {
     const t = (t = !1) => {
       const n = (Math.random().toString(16) + "000000000").substr(2, 8);
       return t ? "-" + n.substr(0, 4) + "-" + n.substr(4, 4) : n;
@@ -7,4 +7,4 @@ const Ge = {
     return t() + t(!0) + t(!0) + t();
   },
 };
-export default Ge;
+export default p;

package/shared-lib/index.js

@@ -0,0 +1,6 @@
+export { default as logger } from "./logger.js";
+export { default as EncodingUtils } from "./encoding-utils.js";
+export { EventTypes, InternalEventTypes } from "./event-types.js";
+export { default as Guid } from "./guid.js";
+export { default as IndexedDBAdapter } from "./indexed-db-adapter.js";
+export { default as SupportedOptions } from "./supported-options.js";

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

@@ -1,21 +1,21 @@
-export default class Oe {
+export default class A {
   constructor(t, e) {
     (this.database = t),
-      (this.j = e),
+      (this.dd = e),
       (this.parent = "undefined" == typeof window ? self : window),
       (this.database = t),
-      (this.j = e);
+      (this.dd = e);
   }
-  td() {
+  fd() {
     if ("indexedDB" in this.parent) return this.parent.indexedDB;
   }
   isSupported() {
     var t;
     try {
-      if (null == this.td()) return !1;
+      if (null == this.fd()) return !1;
       {
         const e =
-          null === (t = this.td()) || void 0 === t
+          null === (t = this.fd()) || void 0 === t
             ? void 0
             : t.open("Braze IndexedDB Support Test");
         if (
@@ -25,10 +25,10 @@ export default class Oe {
           "undefined" != typeof window)
         ) {
           const t = window,
-            e = t.chrome || t.browser || t.ed;
+            e = t.chrome || t.browser || t.ad;
           if (e && e.runtime && e.runtime.id)
             return (
-              this.j.info(
+              this.dd.info(
                 "Not using IndexedDB for storage because we are running inside an extension",
               ),
               !1
@@ -38,37 +38,37 @@ export default class Oe {
       }
     } catch (t) {
       return (
-        this.j.info(
+        this.dd.info(
           "Not using IndexedDB for storage due to following error: " + t,
         ),
         !1
       );
     }
   }
-  nd(t, e) {
+  vd(t, e) {
     var n;
     const o =
-      null === (n = this.td()) || void 0 === n
+      null === (n = this.fd()) || void 0 === n
         ? void 0
-        : n.open(this.database.od, this.database.VERSION);
+        : n.open(this.database.Dd, this.database.VERSION);
     if (null == o) return "function" == typeof e && e(), !1;
     const i = this;
     return (
       (o.onupgradeneeded = (t) => {
         var e;
-        i.j.info(
+        i.dd.info(
           "Upgrading indexedDB " +
-            i.database.od +
+            i.database.Dd +
             " to v" +
             i.database.VERSION +
             "...",
         );
         const n = null === (e = t.target) || void 0 === e ? void 0 : e.result;
-        for (const t in i.database.rs) {
+        for (const t in i.database.ss) {
           const e = t;
-          i.database.rs.hasOwnProperty(t) &&
-            !n.objectStoreNames.contains(i.database.rs[e]) &&
-            n.createObjectStore(i.database.rs[e]);
+          i.database.ss.hasOwnProperty(t) &&
+            !n.objectStoreNames.contains(i.database.ss[e]) &&
+            n.createObjectStore(i.database.ss[e]);
         }
       }),
       (o.onsuccess = (n) => {
@@ -77,7 +77,7 @@ export default class Oe {
         (r.onversionchange = () => {
           r.close(),
             "function" == typeof e && e(),
-            i.j.error(
+            i.dd.error(
               "Needed to close the database unexpectedly because of an upgrade in another tab",
             );
         }),
@@ -87,9 +87,9 @@ export default class Oe {
         var n;
         const o = t;
         return (
-          i.j.info(
+          i.dd.info(
             "Could not open indexedDB " +
-              i.database.od +
+              i.database.Dd +
               " v" +
               i.database.VERSION +
               ": " +
@@ -105,16 +105,16 @@ export default class Oe {
   setItem(t, e, n, o, i) {
     if (!this.isSupported()) return "function" == typeof i && i(), !1;
     const r = this;
-    return this.nd((d) => {
+    return this.vd((d) => {
       if (!d.objectStoreNames.contains(t))
         return (
-          r.j.error(
+          r.dd.error(
             "Could not store object " +
               e +
               " in " +
               t +
               " on indexedDB " +
-              r.database.od +
+              r.database.Dd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -126,13 +126,13 @@ export default class Oe {
       s.oncomplete = () => d.close();
       const u = s.objectStore(t).put(n, e);
       (u.onerror = () => {
-        r.j.error(
+        r.dd.error(
           "Could not store object " +
             e +
             " in " +
             t +
             " on indexedDB " +
-            r.database.od,
+            r.database.Dd,
         ),
           "function" == typeof i && i();
       }),
@@ -144,16 +144,16 @@ export default class Oe {
   getItem(t, e, n) {
     if (!this.isSupported()) return !1;
     const o = this;
-    return this.nd((i) => {
+    return this.vd((i) => {
       if (!i.objectStoreNames.contains(t))
         return (
-          o.j.error(
+          o.dd.error(
             "Could not retrieve object " +
               e +
               " in " +
               t +
               " on indexedDB " +
-              o.database.od +
+              o.database.Dd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -164,13 +164,13 @@ export default class Oe {
       r.oncomplete = () => i.close();
       const d = r.objectStore(t).get(e);
       (d.onerror = () => {
-        o.j.error(
+        o.dd.error(
           "Could not retrieve object " +
             e +
             " in " +
             t +
             " on indexedDB " +
-            o.database.od,
+            o.database.Dd,
         );
       }),
         (d.onsuccess = (t) => {
@@ -180,17 +180,17 @@ export default class Oe {
         });
     });
   }
-  hr(t, e, n) {
+  jr(t, e, n) {
     if (!this.isSupported()) return "function" == typeof n && n(), !1;
     const o = this;
-    return this.nd((i) => {
+    return this.vd((i) => {
       if (!i.objectStoreNames.contains(t))
         return (
-          o.j.error(
+          o.dd.error(
             "Could not retrieve last record from " +
               t +
               " on indexedDB " +
-              o.database.od +
+              o.database.Dd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -202,8 +202,8 @@ export default class Oe {
       r.oncomplete = () => i.close();
       const d = r.objectStore(t).openCursor(null, "prev");
       (d.onerror = () => {
-        o.j.error(
-          "Could not open cursor for " + t + " on indexedDB " + o.database.od,
+        o.dd.error(
+          "Could not open cursor for " + t + " on indexedDB " + o.database.Dd,
         ),
           "function" == typeof n && n();
       }),
@@ -216,19 +216,19 @@ export default class Oe {
         });
     }, n);
   }
-  oe(t, e) {
+  re(t, e) {
     if (!this.isSupported()) return !1;
     const n = this;
-    return this.nd((o) => {
+    return this.vd((o) => {
       if (!o.objectStoreNames.contains(t))
         return (
-          n.j.error(
+          n.dd.error(
             "Could not delete record " +
               e +
               " from " +
               t +
               " on indexedDB " +
-              n.database.od +
+              n.database.Dd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -238,28 +238,28 @@ export default class Oe {
       const i = o.transaction([t], "readwrite");
       i.oncomplete = () => o.close();
       i.objectStore(t).delete(e).onerror = () => {
-        n.j.error(
+        n.dd.error(
           "Could not delete record " +
             e +
             " from " +
             t +
             " on indexedDB " +
-            n.database.od,
+            n.database.Dd,
         );
       };
     });
   }
-  ss(t, e) {
+  Zt(t, e) {
     if (!this.isSupported()) return !1;
     const n = this;
-    return this.nd((o) => {
+    return this.vd((o) => {
       if (!o.objectStoreNames.contains(t))
         return (
-          n.j.error(
+          n.dd.error(
             "Could not retrieve objects from " +
               t +
               " on indexedDB " +
-              n.database.od +
+              n.database.Dd +
               " - " +
               t +
               " is not a valid objectStore",
@@ -273,18 +273,18 @@ export default class Oe {
         s = [];
       (d.onerror = () => {
         s.length > 0
-          ? (n.j.info(
+          ? (n.dd.info(
               "Cursor closed midway through for " +
                 t +
                 " on indexedDB " +
-                n.database.od,
+                n.database.Dd,
             ),
             e(s))
-          : n.j.error(
+          : n.dd.error(
               "Could not open cursor for " +
                 t +
                 " on indexedDB " +
-                n.database.od,
+                n.database.Dd,
             );
       }),
         (d.onsuccess = (t) => {
@@ -304,48 +304,48 @@ export default class Oe {
   clearData() {
     if (!this.isSupported()) return !1;
     const t = [];
-    for (const e in this.database.rs) {
+    for (const e in this.database.ss) {
       const n = e;
-      this.database.rs.hasOwnProperty(e) &&
-        this.database.rs[n] !== this.database.rs.se &&
-        t.push(this.database.rs[n]);
+      this.database.ss.hasOwnProperty(e) &&
+        this.database.ss[n] !== this.database.ss.ae &&
+        t.push(this.database.ss[n]);
     }
     const e = this;
-    return this.nd(function (n) {
+    return this.vd(function (n) {
       const o = n.transaction(t, "readwrite");
       o.oncomplete = () => n.close();
       for (let n = 0; n < t.length; n++) {
         const i = t[n];
         o.objectStore(i).clear().onerror = function () {
-          e.j.error(
+          e.dd.error(
             "Could not clear " +
               this.source.name +
               " on indexedDB " +
-              e.database.od,
+              e.database.Dd,
           );
         };
       }
       o.onerror = function () {
-        e.j.error(
-          "Could not clear object stores on indexedDB " + e.database.od,
+        e.dd.error(
+          "Could not clear object stores on indexedDB " + e.database.Dd,
         );
       };
     });
   }
 }
-Oe.ep = {
-  Zt: {
-    od: "AppboyServiceWorkerAsyncStorage",
+A.Yt = {
+  Qt: {
+    Dd: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
-    rs: {
-      Na: "data",
-      kr: "pushClicks",
+    ss: {
+      Qa: "data",
+      hr: "pushClicks",
       cu: "pushSubscribed",
-      dd: "fallbackDevice",
-      hs: "cardUpdates",
-      se: "optOut",
+      pd: "fallbackDevice",
+      ts: "cardUpdates",
+      ae: "optOut",
       wr: "pendingData",
-      qh: "sdkAuthenticationSignature",
+      xh: "sdkAuthenticationSignature",
     },
     ie: 1,
   },

package/shared-lib/logger.js

@@ -1,38 +1,38 @@
-const Ue = {
+const r = {
   init: function (n) {
-    (void 0 === n && void 0 !== Ue.zg) || (Ue.zg = !!n), Ue.t || (Ue.t = !0);
+    (void 0 === n && void 0 !== r.zg) || (r.zg = !!n), r.t || (r.t = !0);
   },
   destroy: function () {
-    (Ue.t = !1), (Ue.zg = void 0), (Ue.j = void 0);
+    (r.t = !1), (r.zg = void 0), (r.dd = void 0);
   },
   setLogger: function (n) {
     "function" == typeof n
-      ? (Ue.init(), (Ue.j = n))
-      : Ue.info("Ignoring setLogger call since logger is not a function");
+      ? (r.init(), (r.dd = n))
+      : r.info("Ignoring setLogger call since logger is not a function");
   },
   toggleLogging: function () {
-    Ue.init(),
-      Ue.zg
-        ? (console.log("Disabling Braze logging"), (Ue.zg = !1))
-        : (console.log("Enabled Braze logging"), (Ue.zg = !0));
+    r.init(),
+      r.zg
+        ? (console.log("Disabling Braze logging"), (r.zg = !1))
+        : (console.log("Enabled Braze logging"), (r.zg = !0));
   },
   info: function (n) {
-    if (Ue.zg) {
+    if (r.zg) {
       const o = "Braze: " + n;
-      null != Ue.j ? Ue.j(o) : console.log(o);
+      null != r.dd ? r.dd(o) : console.log(o);
     }
   },
   warn: function (n) {
-    if (Ue.zg) {
-      const o = "Braze SDK Warning: " + n + " (v5.0.0)";
-      null != Ue.j ? Ue.j(o) : console.warn(o);
+    if (r.zg) {
+      const o = "Braze SDK Warning: " + n + " (v5.1.0)";
+      null != r.dd ? r.dd(o) : console.warn(o);
     }
   },
   error: function (n) {
-    if (Ue.zg) {
-      const o = "Braze SDK Error: " + n + " (v5.0.0)";
-      null != Ue.j ? Ue.j(o) : console.error(o);
+    if (r.zg) {
+      const o = "Braze SDK Error: " + n + " (v5.1.0)";
+      null != r.dd ? r.dd(o) : console.error(o);
     }
   },
 };
-export default Ue;
+export default r;

package/shared-lib/supported-options.js

@@ -1,26 +1,26 @@
 export default {
-  ho: "allowCrawlerActivity",
-  _o: "baseUrl",
-  Eo: "noCookies",
-  Io: "devicePropertyAllowlist",
-  Aa: "disablePushTokenMaintenance",
-  Ao: "enableLogging",
-  So: "enableSdkAuthentication",
-  qa: "manageServiceWorkerExternally",
-  No: "minimumIntervalBetweenTriggerActionsInSeconds",
-  Oo: "sessionTimeoutInSeconds",
-  wo: "appVersion",
-  Po: "appVersionNumber",
-  _a: "serviceWorkerLocation",
-  ka: "safariWebsitePushId",
-  Ba: "localization",
-  po: "contentSecurityNonce",
-  Ro: "allowUserSuppliedJavascript",
-  lo: "inAppMessageZIndex",
-  fo: "openInAppMessagesInNewTab",
+  _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",
   en: "openNewsFeedCardsInNewTab",
   mh: "requireExplicitInAppMessageDismissal",
-  Co: "doNotLoadFontAwesome",
-  Lo: "sdkFlavor",
+  Uo: "doNotLoadFontAwesome",
+  Bo: "sdkFlavor",
   tn: "openCardsInNewTab",
 };