@braze/web-sdk 4.7.2 → 4.8.1

package/index.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definitions for @braze/web-sdk v4.7.2
+* Type definitions for @braze/web-sdk v4.8.1
 * 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
@@ -88,9 +88,9 @@
      *    no arguments when this card records a click.
      *
      * @returns The identifier of the subscription created. This can be passed to `Card.removeSubscription`
-     *    to cancel the subscription.
+     *    to cancel the subscription. Returns null if the subscriber passed is not a function.
      */
-    subscribeToClickedEvent(subscriber: () => void): string;
+    subscribeToClickedEvent(subscriber: () => void): string | null;
 
     /**
      * Subscribe to receive dismissed events. The subscriber callback will be called whenever this card is dismissed by the
@@ -100,9 +100,9 @@
      *    no arguments when this card records a dismissal.
      *
      * @returns The identifier of the subscription created. This can be passed to `Card.removeSubscription`
-     *    to cancel the subscription.
+     *    to cancel the subscription. Returns null if the subscriber passed is not a function.
      */
-    subscribeToDismissedEvent(subscriber: () => void): string;
+    subscribeToDismissedEvent(subscriber: () => void): string | null;
 
     /** The id of the card. This will be reported back to Braze with events for analytics purposes. */
     id?: string;
@@ -390,6 +390,9 @@
       extras?: Record<string, string>,
       pinned?: boolean
     );
+
+    /** Whether this card is a ControlCard. */
+    isControl: true;
   }
 
   export class ContentCards {
@@ -473,10 +476,10 @@
     triggerId?: string;
 
     /** Object of string/string key/value pairs. */
-    extras: Record<string, any>;
+    extras: Record<string, string>;
 
     /** Whether this message is a ControlMessage. */
-    isControl: boolean;
+    isControl: true;
   }
 
   
@@ -562,7 +565,7 @@
     message?: string;
 
     /** Object of string/string key/value pairs. */
-    extras: Record<string, any>;
+    extras: Record<string, string>;
 
     /**
      * The id of the trigger that created this message. The SDK will report back this to
@@ -598,7 +601,7 @@
     css?: string;
 
     /** Whether this message is a ControlMessage. */
-    isControl: boolean;
+    isControl: false;
 
     /**
      * Call this method if you wish to programmatically remove the message from the DOM. This method will only
@@ -625,9 +628,9 @@
      *    no arguments when this message records a click.
      *
      * @returns The identifier of the subscription created. This can be passed to `removeSubscription`
-     *    to cancel the subscription.
+     *    to cancel the subscription. Returns null if the subscriber passed is not a function.
      */
-    subscribeToClickedEvent(subscriber: () => void): string;
+    subscribeToClickedEvent(subscriber: () => void): string | null;
 
     /**
      * Subscribe to receive dismissed events. The subscriber callback will be called whenever this message is closed
@@ -637,9 +640,9 @@
      *    no arguments when this message records a dismissal.
      *
      * @returns The identifier of the subscription created. This can be passed to `removeSubscription`
-     *    to cancel the subscription.
+     *    to cancel the subscription. Returns null if the subscriber passed is not a function.
      */
-    subscribeToDismissedEvent(subscriber: () => void): string;
+    subscribeToDismissedEvent(subscriber: () => void): string | null;
 
 
   }
@@ -698,7 +701,7 @@
     constructor(
       message?: string,
       messageAlignment?: TextAlignment,
-      extras?: Record<string, any>,
+      extras?: Record<string, string>,
       triggerId?: string,
       clickAction?: ClickAction,
       uri?: string,
@@ -857,7 +860,7 @@
     constructor(
       message?: string,
       messageAlignment?: TextAlignment,
-      extras?: Record<string, any>,
+      extras?: Record<string, string>,
       triggerId?: string,
       clickAction?: ClickAction,
       uri?: string,
@@ -980,7 +983,7 @@
      */
     constructor(
       message: string,
-      extras?: Record<string, any>,
+      extras?: Record<string, string>,
       triggerId?: string,
       dismissType?: DismissType,
       duration?: number,
@@ -1047,7 +1050,7 @@
       message: string,
       messageAlignment?: TextAlignment,
       slideFrom?: SlideFrom,
-      extras?: Record<string, any>,
+      extras?: Record<string, string>,
       triggerId?: string,
       clickAction?: ClickAction,
       uri?: string,
@@ -1496,9 +1499,9 @@
      *    no arguments when this button records a click.
      *
      * @returns The identifier of the subscription created. This can be passed to `removeSubscription`
-     *    to cancel the subscription.
+     *    to cancel the subscription. Returns null if the subscriber passed is not a function.
      */
-    subscribeToClickedEvent(subscriber: () => void): string;
+    subscribeToClickedEvent(subscriber: () => void): string | null;
   }
 
   export interface FeatureFlagStringProperty {
@@ -1842,7 +1845,7 @@
   ): boolean;
 
   /**
-   * A convenience method to log that the user saw the given Content Cards. This method is equivalent to
+   * A convenient method to log that the user saw the given Content Cards. This method is equivalent to
    *    calling [`logCardImpressions` method with `forContentCards` param set to true.
    *    This is done automatically when you use Braze's display module and should only be called
    *    if you're bypassing that and manually building the DOM for displaying content cards in
@@ -2005,7 +2008,7 @@
    * - 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.7/service-worker.js');
+   * self.importScripts('https://js.appboycdn.com/web-sdk-develop/4.8/service-worker.js');
    * ```
    *
    * For more details, see [Our Product Documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
@@ -2138,10 +2141,11 @@
    *   regardless of whether new cards are available, you should use the `successCallback` of `requestContentCardsRefresh`.
    *
    * @returns The identifier of the subscription created. This can be passed to `removeSubscription` to cancel the subscription.
+   *   Returns undefined if the SDK has not been initialized.
    */
   export function subscribeToContentCardsUpdates(
     subscriber: (cards: ContentCards) => void
-  ): string;
+  ): string | undefined;
 
   /**
    * Subscribe to news feed updates. The subscriber callback will be called whenever the news feed is updated.
@@ -2245,15 +2249,17 @@
    * Subscribe to feature flag updates. The subscriber callback will be called whenever feature flags are updated. This method
    *   should be called before calling `openSession`.
    *
-   * @param subscriber - The callback function to handle new feature flags. This function will be called with a list of `FeatureFlag`
-   *   objects, including all feature flags currently available. If you want to be notified when a refresh has completed
+   * @param subscriber - The callback function to handle new feature flags. This function is always called first with the
+   *   available cached list of `FeatureFlag` objects, and will also be called when feature flag updates are available.
+   *   If you want to be notified when a refresh has completed
    *   regardless of whether new feature flags are available, you should use the `successCallback` of `refreshFeatureFlags`.
    *
    * @returns The identifier of the subscription created. This can be passed to `removeSubscription` to cancel the subscription.
+   *    Returns undefined if the SDK has not been initialized.
    */
    export function subscribeToFeatureFlagsUpdates(
     subscriber: (featureFlags: FeatureFlag[]) => void
-  ): string;
+  ): string | undefined;
 
   /**
    * Gets all available feature flags.
@@ -2358,7 +2364,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.7/service-worker.js');` or by including the content
+     *   `self.importScripts('https://js.appboycdn.com/web-sdk-develop/4.8/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.7.2",
+  "version": "4.8.1",
   "description": "Braze SDK for web sites and other JS platforms.",
   "main": "src/index.js",
   "scripts": {

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

@@ -1,8 +1,8 @@
 import je from "./encoding-utils.js";
 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 Ue from "./supported-options.js";
-const r = { yn: je, A: ve, Ar: De, it: Be, qt: Ae, xt: Ae.ep, D: Ge, Fo: Ue };
+import Ie from "./guid.js";
+import Be from "./indexed-db-adapter.js";
+import Ae from "./logger.js";
+import Ge from "./supported-options.js";
+const r = { xn: je, q: ve, Cr: De, Z: Ie, xt: Be, zt: Be.ep, j: Ae, xo: Ge };
 export default r;

package/shared-lib/encoding-utils.js

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

package/shared-lib/event-types.js

@@ -1,33 +1,33 @@
 const ve = {
     CustomEvent: "ce",
     Pr: "p",
-    Ol: "pc",
-    cc: "ca",
-    Aa: "i",
-    qs: "ie",
-    T: "cci",
-    W: "ccic",
-    _: "ccc",
-    L: "ccd",
-    yh: "ss",
-    wh: "se",
-    Mi: "si",
+    du: "pc",
+    dc: "ca",
+    ka: "i",
+    Is: "ie",
+    P: "cci",
+    T: "ccic",
+    $: "ccc",
+    H: "ccd",
+    Wl: "ss",
+    xl: "se",
+    _i: "si",
     Ii: "sc",
-    Ai: "sbc",
+    Mi: "sbc",
     Ze: "sfe",
     ro: "iec",
-    Nl: "lr",
-    Ml: "uae",
-    U: "ci",
-    F: "cc",
-    xl: "lcaa",
-    Ul: "lcar",
-    Fn: "inc",
-    Un: "add",
-    En: "rem",
-    Sn: "set",
-    An: "ncam",
-    Jl: "sgu"
+    au: "lr",
+    Zh: "uae",
+    R: "ci",
+    B: "cc",
+    gu: "lcaa",
+    fu: "lcar",
+    Rn: "inc",
+    Bn: "add",
+    Ln: "rem",
+    Fn: "set",
+    $n: "ncam",
+    pu: "sgu"
   },
-  De = { qr: "feed_displayed", dc: "content_cards_displayed" };
+  De = { Ar: "feed_displayed", Cc: "content_cards_displayed" };
 export { ve as EventTypes, De as InternalEventTypes };

package/shared-lib/guid.js

@@ -1,5 +1,5 @@
-const Be = {
-  nt: () => {
+const Ie = {
+  Y: () => {
     const t = t => {
       const e = (Math.random().toString(16) + "000000000").substr(2, 8);
       return t ? "-" + e.substr(0, 4) + "-" + e.substr(4, 4) : e;
@@ -7,4 +7,4 @@ const Be = {
     return t() + t(!0) + t(!0) + t();
   }
 };
-export default Be;
+export default Ie;

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

@@ -1,17 +1,17 @@
-export default class Ae {
+export default class Be {
   constructor(t, e) {
-    (this.td = "undefined" == typeof window ? self : window),
-      (this.ed = t),
-      (this.nd = e);
+    (this.nd = "undefined" == typeof window ? self : window),
+      (this.od = t),
+      (this.sd = e);
   }
-  od() {
-    if ("indexedDB" in this.td) return this.td.indexedDB;
+  dd() {
+    if ("indexedDB" in this.nd) return this.nd.indexedDB;
   }
-  rd() {
+  ud() {
     try {
-      if (null == this.od()) return !1;
+      if (null == this.dd()) return !1;
       {
-        const t = this.od().open("Braze IndexedDB Support Test");
+        const t = this.dd().open("Braze IndexedDB Support Test");
         if (
           ((t.onupgradeneeded = () => t.result.close()),
           (t.onsuccess = () => t.result.close()),
@@ -20,7 +20,7 @@ export default class Ae {
           const t = window.chrome || window.browser || window.msBrowser;
           if (t && t.runtime && t.runtime.id)
             return (
-              this.nd.info(
+              this.sd.info(
                 "Not using IndexedDB for storage because we are running inside an extension"
               ),
               !1
@@ -30,45 +30,45 @@ export default class Ae {
       }
     } catch (t) {
       return (
-        this.nd.info(
+        this.sd.info(
           "Not using IndexedDB for storage due to following error: " + t
         ),
         !1
       );
     }
   }
-  sd(t, e) {
-    const n = this.od().open(this.ed.dd, this.ed.VERSION);
+  fd(t, e) {
+    const n = this.dd().open(this.od.ad, this.od.VERSION);
     if (null == n) return "function" == typeof e && e(), !1;
     const o = this;
     return (
       (n.onupgradeneeded = t => {
-        o.nd.info(
-          "Upgrading indexedDB " + o.ed.dd + " to v" + o.ed.VERSION + "..."
+        o.sd.info(
+          "Upgrading indexedDB " + o.od.ad + " to v" + o.od.VERSION + "..."
         );
         const e = t.target.result;
-        for (const t in o.ed.$t)
-          o.ed.$t.hasOwnProperty(t) &&
-            !e.objectStoreNames.contains(o.ed.$t[t]) &&
-            e.createObjectStore(o.ed.$t[t]);
+        for (const t in o.od.Jt)
+          o.od.Jt.hasOwnProperty(t) &&
+            !e.objectStoreNames.contains(o.od.Jt[t]) &&
+            e.createObjectStore(o.od.Jt[t]);
       }),
       (n.onsuccess = n => {
         const i = n.target.result;
         (i.onversionchange = () => {
           i.close(),
             "function" == typeof e && e(),
-            o.nd.error(
+            o.sd.error(
               "Needed to close the database unexpectedly because of an upgrade in another tab"
             );
         }),
           t(i);
       }),
       (n.onerror = t => (
-        o.nd.info(
+        o.sd.info(
           "Could not open indexedDB " +
-            o.ed.dd +
+            o.od.ad +
             " v" +
-            o.ed.VERSION +
+            o.od.VERSION +
             ": " +
             t.target.errorCode
         ),
@@ -79,18 +79,18 @@ export default class Ae {
     );
   }
   setItem(t, e, n, o, i) {
-    if (!this.rd()) return "function" == typeof i && i(), !1;
+    if (!this.ud()) return "function" == typeof i && i(), !1;
     const r = this;
-    return this.sd(s => {
+    return this.fd(s => {
       if (!s.objectStoreNames.contains(t))
         return (
-          r.nd.error(
+          r.sd.error(
             "Could not store object " +
               e +
               " in " +
               t +
               " on indexedDB " +
-              r.ed.dd +
+              r.od.ad +
               " - " +
               t +
               " is not a valid objectStore"
@@ -102,13 +102,13 @@ export default class Ae {
       d.oncomplete = () => s.close();
       const u = d.objectStore(t).put(n, e);
       (u.onerror = () => {
-        r.nd.error(
+        r.sd.error(
           "Could not store object " +
             e +
             " in " +
             t +
             " on indexedDB " +
-            r.ed.dd
+            r.od.ad
         ),
           "function" == typeof i && i();
       }),
@@ -118,18 +118,18 @@ export default class Ae {
     }, i);
   }
   getItem(t, e, n) {
-    if (!this.rd()) return !1;
+    if (!this.ud()) return !1;
     const o = this;
-    return this.sd(i => {
+    return this.fd(i => {
       if (!i.objectStoreNames.contains(t))
         return (
-          o.nd.error(
+          o.sd.error(
             "Could not retrieve object " +
               e +
               " in " +
               t +
               " on indexedDB " +
-              o.ed.dd +
+              o.od.ad +
               " - " +
               t +
               " is not a valid objectStore"
@@ -140,13 +140,13 @@ export default class Ae {
       r.oncomplete = () => i.close();
       const s = r.objectStore(t).get(e);
       (s.onerror = () => {
-        o.nd.error(
+        o.sd.error(
           "Could not retrieve object " +
             e +
             " in " +
             t +
             " on indexedDB " +
-            o.ed.dd
+            o.od.ad
         );
       }),
         (s.onsuccess = t => {
@@ -156,16 +156,16 @@ export default class Ae {
     });
   }
   hr(t, e, n) {
-    if (!this.rd()) return "function" == typeof n && n(), !1;
+    if (!this.ud()) return "function" == typeof n && n(), !1;
     const o = this;
-    return this.sd(i => {
+    return this.fd(i => {
       if (!i.objectStoreNames.contains(t))
         return (
-          o.nd.error(
+          o.sd.error(
             "Could not retrieve last record from " +
               t +
               " on indexedDB " +
-              o.ed.dd +
+              o.od.ad +
               " - " +
               t +
               " is not a valid objectStore"
@@ -177,8 +177,8 @@ export default class Ae {
       r.oncomplete = () => i.close();
       const s = r.objectStore(t).openCursor(null, "prev");
       (s.onerror = () => {
-        o.nd.error(
-          "Could not open cursor for " + t + " on indexedDB " + o.ed.dd
+        o.sd.error(
+          "Could not open cursor for " + t + " on indexedDB " + o.od.ad
         ),
           "function" == typeof n && n();
       }),
@@ -191,18 +191,18 @@ export default class Ae {
     }, n);
   }
   br(t, e) {
-    if (!this.rd()) return !1;
+    if (!this.ud()) return !1;
     const n = this;
-    return this.sd(o => {
+    return this.fd(o => {
       if (!o.objectStoreNames.contains(t))
         return (
-          n.nd.error(
+          n.sd.error(
             "Could not delete record " +
               e +
               " from " +
               t +
               " on indexedDB " +
-              n.ed.dd +
+              n.od.ad +
               " - " +
               t +
               " is not a valid objectStore"
@@ -212,28 +212,28 @@ export default class Ae {
       const i = o.transaction([t], "readwrite");
       i.oncomplete = () => o.close();
       i.objectStore(t).delete(e).onerror = () => {
-        n.nd.error(
+        n.sd.error(
           "Could not delete record " +
             e +
             " from " +
             t +
             " on indexedDB " +
-            n.ed.dd
+            n.od.ad
         );
       };
     });
   }
-  Jt(t, e) {
-    if (!this.rd()) return !1;
+  Mt(t, e) {
+    if (!this.ud()) return !1;
     const n = this;
-    return this.sd(o => {
+    return this.fd(o => {
       if (!o.objectStoreNames.contains(t))
         return (
-          n.nd.error(
+          n.sd.error(
             "Could not retrieve objects from " +
               t +
               " on indexedDB " +
-              n.ed.dd +
+              n.od.ad +
               " - " +
               t +
               " is not a valid objectStore"
@@ -247,15 +247,15 @@ export default class Ae {
         d = [];
       (s.onerror = () => {
         d.length > 0
-          ? (n.nd.info(
+          ? (n.sd.info(
               "Cursor closed midway through for " +
                 t +
                 " on indexedDB " +
-                n.ed.dd
+                n.od.ad
             ),
             e(d))
-          : n.nd.error(
-              "Could not open cursor for " + t + " on indexedDB " + n.ed.dd
+          : n.sd.error(
+              "Could not open cursor for " + t + " on indexedDB " + n.od.ad
             );
       }),
         (s.onsuccess = t => {
@@ -272,43 +272,43 @@ export default class Ae {
     });
   }
   clearData() {
-    if (!this.rd()) return !1;
+    if (!this.ud()) return !1;
     const t = [];
-    for (const e in this.ed.$t)
-      this.ed.$t.hasOwnProperty(e) &&
-        this.ed.$t[e] !== this.ed.$t.oe &&
-        t.push(this.ed.$t[e]);
+    for (const e in this.od.Jt)
+      this.od.Jt.hasOwnProperty(e) &&
+        this.od.Jt[e] !== this.od.Jt.oe &&
+        t.push(this.od.Jt[e]);
     const e = this;
-    return this.sd(function(n) {
+    return this.fd(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.nd.error(
-            "Could not clear " + this.source.name + " on indexedDB " + e.ed.dd
+          e.sd.error(
+            "Could not clear " + this.source.name + " on indexedDB " + e.od.ad
           );
         };
       }
       o.onerror = function() {
-        e.nd.error("Could not clear object stores on indexedDB " + e.ed.dd);
+        e.sd.error("Could not clear object stores on indexedDB " + e.od.ad);
       };
     });
   }
 }
-Ae.ep = {
+Be.ep = {
   Ft: {
-    dd: "AppboyServiceWorkerAsyncStorage",
+    ad: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
-    $t: {
-      Il: "data",
-      jr: "pushClicks",
+    Jt: {
+      Sa: "data",
+      kr: "pushClicks",
       cu: "pushSubscribed",
-      ud: "fallbackDevice",
-      Mt: "cardUpdates",
+      hd: "fallbackDevice",
+      qt: "cardUpdates",
       oe: "optOut",
-      $r: "pendingData",
-      Mn: "sdkAuthenticationSignature"
+      yr: "pendingData",
+      kh: "sdkAuthenticationSignature"
     },
     se: 1
   }