@braze/web-sdk 6.0.0 → 6.1.0

package/index.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definitions for @braze/web-sdk v6.0.0
+* Type definitions for @braze/web-sdk v6.1.0
 * Project: https://github.com/braze-inc/braze-web-sdk
 * (c) Braze, Inc. 2025 - http://braze.com
 * License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE
@@ -1542,64 +1542,66 @@ export class InAppMessageButton {
   subscribeToClickedEvent(subscriber: () => void): string | null;
 }
 
-export interface FeatureFlagStringProperty {
+export interface StringProperty {
   type: "string";
   value: string;
 }
 
-export interface FeatureFlagNumberProperty {
+export interface NumberProperty {
   type: "number";
   value: number;
 }
 
-export interface FeatureFlagBooleanProperty {
+export interface BooleanProperty {
   type: "boolean";
   value: boolean;
 }
 
-export interface FeatureFlagImageProperty {
+export interface ImageProperty {
   type: "image";
   value: string;
 }
 
-export interface FeatureFlagTimestampProperty {
+export interface TimestampProperty {
   type: "datetime";
   value: number;
 }
 
-export type FeatureFlagJsonPropertyValue = Partial<Record<string, any>>;
-export interface FeatureFlagJsonProperty {
+export type JsonPropertyValue = Partial<Record<string, any>>;
+export interface JsonProperty {
   type: "jsonobject";
-  value: FeatureFlagJsonPropertyValue;
+  value: JsonPropertyValue;
 }
 
+export type PropertiesJson = Partial<
+  Record<
+    string,
+    | StringProperty
+    | NumberProperty
+    | BooleanProperty
+    | ImageProperty
+    | JsonProperty
+    | TimestampProperty
+  >
+>;
+
 export class FeatureFlag {
   /** Indicates whether or not this feature flag is enabled. */
   enabled: boolean;
 
+  /** The ID for this feature flag. */
+  id: string;
+
   /**
-   * Properties of this feature flag.
+   * Properties of this object.
    *
    * 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<
-      string,
-      | FeatureFlagStringProperty
-      | FeatureFlagNumberProperty
-      | FeatureFlagBooleanProperty
-      | FeatureFlagImageProperty
-      | FeatureFlagJsonProperty
-      | FeatureFlagTimestampProperty
-    >
-  >;
-
-  /** The ID for this feature flag. */
-  id: string;
+  properties: PropertiesJson;
 
   /**
-   * Get value of a feature flag property of type string.
+   * Get value of a property of type string.
    *
    * @param key - The key of the property.
    *
@@ -1609,7 +1611,7 @@ export class FeatureFlag {
   getStringProperty(key: string): string | null;
 
   /**
-   * Get value of a feature flag property of type number.
+   * Get value of a property of type number.
    *
    * @param key - The key of the property.
    *
@@ -1619,7 +1621,7 @@ export class FeatureFlag {
   getNumberProperty(key: string): number | null;
 
   /**
-   * Get value of a feature flag property of type boolean.
+   * Get value of a property of type boolean.
    *
    * @param key - The key of the property.
    *
@@ -1629,7 +1631,7 @@ export class FeatureFlag {
   getBooleanProperty(key: string): boolean | null;
 
   /**
-   * Get value of a feature flag property of type image.
+   * Get value of a property of type image.
    *
    * @param key - The key of the property.
    *
@@ -1639,17 +1641,17 @@ export class FeatureFlag {
   getImageProperty(key: string): string | null;
 
   /**
-   * Get value of a feature flag property of type JSON.
+   * Get value of a 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;
+  getJsonProperty(key: string): JsonPropertyValue | null;
 
   /**
-   * Get value of a feature flag property of type datetime as a Unix timestamp (milliseconds).
+   * Get value of a property of type datetime as a Unix timestamp (milliseconds).
    *
    * @param key - The key of the property.
    *
@@ -1670,6 +1672,74 @@ export class Banner {
 
   /** Whether this banner is a control banner. */
   isControl: boolean;
+
+  /**
+   * Properties of this object.
+   *
+   * 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: PropertiesJson;
+
+  /**
+   * Get value of a property of type string.
+   *
+   * @param key - The key of the property.
+   *
+   * @returns The value of the property if the key is found and is of type string.
+   *    If the key is not found or if there is a type mismatch, this method will return a null.
+   */
+  getStringProperty(key: string): string | null;
+
+  /**
+   * Get value of a property of type number.
+   *
+   * @param key - The key of the property.
+   *
+   * @returns The value of the property if the key is found and is of type number.
+   *    If the key is not found or if there is a type mismatch, this method will return a null.
+   */
+  getNumberProperty(key: string): number | null;
+
+  /**
+   * Get value of a property of type boolean.
+   *
+   * @param key - The key of the property.
+   *
+   * @returns The value of the property if the key is found and is of type boolean.
+   *    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 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 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): JsonPropertyValue | null;
+
+  /**
+   * Get value of a 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;
 }
 
 /**
@@ -2068,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/6.0/service-worker.js');
+ * self.importScripts('https://js.appboycdn.com/web-sdk/6.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).
@@ -2491,7 +2561,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/6.0/service-worker.js');` or by including the content
+   *   `self.importScripts('https://js.appboycdn.com/web-sdk/6.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": "6.0.0",
+  "version": "6.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 ei = {
-  In: 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 d = {
+const m = {
     CustomEvent: "ce",
     Pr: "p",
-    mc: "pc",
+    uc: "pc",
     Cc: "ca",
-    Al: "i",
-    ul: "ie",
-    Zt: "cci",
-    ts: "ccic",
-    Mt: "ccc",
-    Vt: "ccd",
-    Iu: "ss",
-    Du: "se",
-    $i: "si",
-    Fi: "sc",
-    Oi: "sbc",
+    wu: "i",
+    pu: "ie",
+    Ut: "cci",
+    Wt: "ccic",
+    Ht: "ccc",
+    Mt: "ccd",
+    Al: "ss",
+    Dl: "se",
+    Gi: "si",
+    $i: "sc",
+    Fi: "sbc",
     yc: "sfe",
-    Go: "iec",
-    dc: "lr",
-    cc: "uae",
-    vc: "lcaa",
-    gc: "lcar",
+    zo: "iec",
+    lc: "lr",
+    nc: "uae",
+    mc: "lcaa",
+    dc: "lcar",
     Gn: "inc",
     Rn: "add",
     On: "rem",
     $n: "set",
     Bn: "ncam",
-    bc: "sgu",
-    yr: "ffi",
+    fc: "sgu",
+    Fr: "ffi",
     ro: "bi",
-    ct: "bc",
+    ot: "bc",
   },
   Ee = { Mc: "content_cards_displayed" };
-export { d as EventTypes, Ee as InternalEventTypes };
+export { m as EventTypes, Ee as InternalEventTypes };

package/shared-lib/guid.js

@@ -1,5 +1,5 @@
-const O = {
-  ce: function () {
+const P = {
+  oe: 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 O = {
     return t() + t(!0) + t(!0) + t();
   },
 };
-export default O;
+export default P;

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

@@ -64,11 +64,11 @@ export default class et {
             "...",
         );
         const n = null === (e = t.target) || void 0 === e ? void 0 : e.result;
-        for (const t in i.database.Ls) {
+        for (const t in i.database.Fs) {
           const e = t;
-          i.database.Ls.hasOwnProperty(t) &&
-            !n.objectStoreNames.contains(i.database.Ls[e]) &&
-            n.createObjectStore(i.database.Ls[e]);
+          i.database.Fs.hasOwnProperty(t) &&
+            !n.objectStoreNames.contains(i.database.Fs[e]) &&
+            n.createObjectStore(i.database.Fs[e]);
         }
       }),
       (o.onsuccess = (n) => {
@@ -216,7 +216,7 @@ export default class et {
         });
     }, n);
   }
-  ge(t, e) {
+  be(t, e) {
     if (!this.isSupported()) return !1;
     const n = this;
     return this.Bd((o) => {
@@ -249,7 +249,7 @@ export default class et {
       };
     });
   }
-  As(t, e) {
+  Ds(t, e) {
     if (!this.isSupported()) return !1;
     const n = this;
     return this.Bd((o) => {
@@ -304,11 +304,11 @@ export default class et {
   clearData() {
     if (!this.isSupported()) return !1;
     const t = [];
-    for (const e in this.database.Ls) {
+    for (const e in this.database.Fs) {
       const n = e;
-      this.database.Ls.hasOwnProperty(e) &&
-        this.database.Ls[n] !== this.database.Ls.pe &&
-        t.push(this.database.Ls[n]);
+      this.database.Fs.hasOwnProperty(e) &&
+        this.database.Fs[n] !== this.database.Fs.le &&
+        t.push(this.database.Fs[n]);
     }
     const e = this;
     return this.Bd(function (n) {
@@ -333,20 +333,20 @@ export default class et {
     });
   }
 }
-et.Ds = {
-  Us: {
+et.Us = {
+  Rs: {
     Sd: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
-    Ls: {
-      gl: "data",
+    Fs: {
+      Tu: "data",
       hr: "pushClicks",
       cu: "pushSubscribed",
       Cd: "fallbackDevice",
-      Fs: "cardUpdates",
-      pe: "optOut",
-      $r: "pendingData",
-      qh: "sdkAuthenticationSignature",
+      As: "cardUpdates",
+      le: "optOut",
+      wr: "pendingData",
+      xh: "sdkAuthenticationSignature",
     },
-    be: 1,
+    me: 1,
   },
 };

package/shared-lib/logger.js

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

package/shared-lib/supported-options.js

@@ -1,27 +1,27 @@
 export default {
   _o: "allowCrawlerActivity",
-  Yo: "baseUrl",
-  Xo: "noCookies",
-  Zo: "devicePropertyAllowlist",
+  Ro: "baseUrl",
+  Wo: "noCookies",
+  Vo: "devicePropertyAllowlist",
   Aa: "disablePushTokenMaintenance",
-  Wh: "enableLogging",
-  Vh: "enableSdkAuthentication",
+  Yo: "enableLogging",
+  Xo: "enableSdkAuthentication",
   qa: "manageServiceWorkerExternally",
-  Kh: "minimumIntervalBetweenTriggerActionsInSeconds",
-  $h: "sessionTimeoutInSeconds",
-  Yh: "appVersion",
-  Xh: "appVersionNumber",
+  Zo: "minimumIntervalBetweenTriggerActionsInSeconds",
+  Wh: "sessionTimeoutInSeconds",
+  Vh: "appVersion",
+  Kh: "appVersionNumber",
   Ma: "serviceWorkerLocation",
   ka: "safariWebsitePushId",
-  Zn: "localization",
+  Xn: "localization",
   er: "contentSecurityNonce",
   re: "allowUserSuppliedJavascript",
-  Ko: "inAppMessageZIndex",
-  Qo: "openInAppMessagesInNewTab",
+  Jo: "inAppMessageZIndex",
+  Do: "openInAppMessagesInNewTab",
   Lh: "requireExplicitInAppMessageDismissal",
-  Zh: "doNotLoadFontAwesome",
-  Qh: "deviceId",
+  $h: "doNotLoadFontAwesome",
+  Jh: "deviceId",
   _a: "serviceWorkerScope",
-  Ea: "sdkFlavor",
+  Yh: "sdkFlavor",
   tn: "openCardsInNewTab",
 };

package/src/Banner/banner-factory.js

@@ -1,6 +1,6 @@
 import Banner from "./banner.js";
 export function newBannerFromSerializedValue(n) {
-  return new Banner(n.id, n.o, n.html, n.t, n.i, n.u);
+  return new Banner(n.id, n.pid, n.html, n.its, n.ic, n.eat, n.pr);
 }
 export function newBannerFromJson(n) {
   return new Banner(
@@ -10,5 +10,6 @@ export function newBannerFromJson(n) {
     n.is_test_send,
     n.is_control,
     n.expires_at,
+    n.properties,
   );
 }

package/src/Banner/banner-provider-factory.js

@@ -1,19 +1,19 @@
 import r from "../managers/braze-instance.js";
 import e from "./banner-provider.js";
 const i = {
-  l: !1,
+  i: !1,
   provider: null,
-  m: () => (
-    i.p(),
+  o: () => (
+    i.t(),
     i.provider ||
-      ((i.provider = new e(r.v(), r.g(), r.j(), r.P())), r._(i.provider)),
+      ((i.provider = new e(r.l(), r.m(), r.p(), r.u())), r.v(i.provider)),
     i.provider
   ),
-  p: () => {
-    i.l || (r.h(i), (i.l = !0));
+  t: () => {
+    i.i || (r.g(i), (i.i = !0));
   },
   destroy: () => {
-    (i.provider = null), (i.l = !1);
+    (i.provider = null), (i.i = !1);
   },
 };
 export default i;