@braze/web-sdk 5.1.1 → 5.3.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.3.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,
@@ -1545,6 +1546,22 @@ export interface FeatureFlagBooleanProperty {
   value: boolean;
 }
 
+export interface FeatureFlagImageProperty {
+  type: "image";
+  value: string;
+}
+
+export interface FeatureFlagTimestampProperty {
+  type: "datetime";
+  value: number;
+}
+
+export type FeatureFlagJsonPropertyValue = Partial<Record<string, any>>;
+export interface FeatureFlagJsonProperty {
+  type: "jsonobject";
+  value: FeatureFlagJsonPropertyValue;
+}
+
 export class FeatureFlag {
   /** Indicates whether or not this feature flag is enabled. */
   enabled: boolean;
@@ -1552,8 +1569,8 @@ export class FeatureFlag {
   /**
    * 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.
+   * Avoid accessing these properties directly. Instead, prefer using the `getStringProperty`, `getBooleanProperty`, `getNumberProperty`,
+   * `getImageProperty` and `getJsonProperty` methods which ensure type safety and to avoid breaking changes in the future.
    */
   properties: Partial<
     Record<
@@ -1561,6 +1578,9 @@ export class FeatureFlag {
       | FeatureFlagStringProperty
       | FeatureFlagNumberProperty
       | FeatureFlagBooleanProperty
+      | FeatureFlagImageProperty
+      | FeatureFlagJsonProperty
+      | FeatureFlagTimestampProperty
     >
   >;
 
@@ -1596,6 +1616,36 @@ export class FeatureFlag {
    *    If the key is not found or if there is a type mismatch, this method will return a null.
    */
   getBooleanProperty(key: string): boolean | null;
+
+  /**
+   * Get value of a feature flag property of type image.
+   *
+   * @param key - The key of the property.
+   *
+   * @returns The string value of the image url if the key is found and is of type image.
+   *    If the key is not found or if there is a type mismatch, this method will return a null.
+   */
+  getImageProperty(key: string): string | null;
+
+  /**
+   * Get value of a feature flag property of type JSON.
+   *
+   * @param key - The key of the property.
+   *
+   * @returns The value of the property if the key is found and is of type JSON.
+   *    If the key is not found or if there is a type mismatch, this method will return a null.
+   */
+  getJsonProperty(key: string): FeatureFlagJsonPropertyValue | null;
+
+  /**
+   * Get value of a feature flag property of type datetime as a Unix timestamp (milliseconds).
+   *
+   * @param key - The key of the property.
+   *
+   * @returns The Unix timestamp (milliseconds) value of the property if the key is found and is of type datetime.
+   *    If the key is not found or if there is a type mismatch, this method will return a null.
+   */
+  getTimestampProperty(key: string): number | null;
 }
 
 /**
@@ -1767,9 +1817,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 +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.1/service-worker.js');
+ * self.importScripts('https://js.appboycdn.com/web-sdk-develop/5.3/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 +2444,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 +2513,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.3/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 +2565,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.3.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,34 +1,34 @@
 const i = {
     CustomEvent: "ce",
     Pr: "p",
-    Iu: "pc",
+    _u: "pc",
     vc: "ca",
-    Za: "i",
-    Ms: "ie",
+    Ea: "i",
+    qs: "ie",
     M: "cci",
     R: "ccic",
     I: "ccc",
     F: "ccd",
-    kl: "ss",
+    ql: "ss",
     xl: "se",
-    Ze: "si",
-    Xe: "sc",
-    Ye: "sbc",
-    We: "sfe",
-    fo: "iec",
-    xu: "lr",
-    Pu: "uae",
+    Oi: "si",
+    Ei: "sc",
+    Gi: "sbc",
+    Cc: "sfe",
+    mo: "iec",
+    Uu: "lr",
+    zu: "uae",
     O: "ci",
     $: "cc",
-    Uu: "lcaa",
-    Ou: "lcar",
-    Hn: "inc",
-    On: "add",
-    Gn: "rem",
-    Ln: "set",
-    Rn: "ncam",
-    _u: "sgu",
+    Ju: "lcaa",
+    Eu: "lcar",
+    On: "inc",
+    Ln: "add",
+    Rn: "rem",
+    $n: "set",
+    Bn: "ncam",
+    Ku: "sgu",
     Fr: "ffi",
   },
-  or = { Br: "feed_displayed", Cc: "content_cards_displayed" };
+  or = { Ar: "feed_displayed", Ec: "content_cards_displayed" };
 export { i as EventTypes, or as InternalEventTypes };

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

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

package/shared-lib/logger.js

@@ -3,11 +3,11 @@ const r = {
     (void 0 === n && void 0 !== r.zg) || (r.zg = !!n), r.t || (r.t = !0);
   },
   destroy: function () {
-    (r.t = !1), (r.zg = void 0), (r.dd = void 0);
+    (r.t = !1), (r.zg = void 0), (r.vd = void 0);
   },
   setLogger: function (n) {
     "function" == typeof n
-      ? (r.init(), (r.dd = n))
+      ? (r.init(), (r.vd = n))
       : r.info("Ignoring setLogger call since logger is not a function");
   },
   toggleLogging: function () {
@@ -19,19 +19,19 @@ const r = {
   info: function (n) {
     if (r.zg) {
       const o = "Braze: " + n;
-      null != r.dd ? r.dd(o) : console.log(o);
+      null != r.vd ? r.vd(o) : console.log(o);
     }
   },
   warn: function (n) {
     if (r.zg) {
-      const o = "Braze SDK Warning: " + n + " (v5.1.1)";
-      null != r.dd ? r.dd(o) : console.warn(o);
+      const o = "Braze SDK Warning: " + n + " (v5.3.0)";
+      null != r.vd ? r.vd(o) : console.warn(o);
     }
   },
   error: function (n) {
     if (r.zg) {
-      const o = "Braze SDK Error: " + n + " (v5.1.1)";
-      null != r.dd ? r.dd(o) : console.error(o);
+      const o = "Braze SDK Error: " + n + " (v5.3.0)";
+      null != r.vd ? r.vd(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",
+  _a: "disablePushTokenMaintenance",
+  So: "enableLogging",
+  No: "enableSdkAuthentication",
+  Ma: "manageServiceWorkerExternally",
+  Oo: "minimumIntervalBetweenTriggerActionsInSeconds",
+  Po: "sessionTimeoutInSeconds",
+  Ro: "appVersion",
+  Lo: "appVersionNumber",
+  wa: "serviceWorkerLocation",
+  ya: "safariWebsitePushId",
+  zn: "localization",
+  bo: "contentSecurityNonce",
+  Do: "allowUserSuppliedJavascript",
+  jo: "inAppMessageZIndex",
+  ho: "openInAppMessagesInNewTab",
   en: "openNewsFeedCardsInNewTab",
-  mh: "requireExplicitInAppMessageDismissal",
-  Uo: "doNotLoadFontAwesome",
+  Lh: "requireExplicitInAppMessageDismissal",
+  Mo: "doNotLoadFontAwesome",
+  Uo: "deviceId",
   Bo: "sdkFlavor",
   tn: "openCardsInNewTab",
 };