@braze/web-sdk 4.7.2 → 4.8.0

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.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
@@ -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;
@@ -473,7 +473,7 @@
     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;
@@ -562,7 +562,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
@@ -625,9 +625,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 +637,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 +698,7 @@
     constructor(
       message?: string,
       messageAlignment?: TextAlignment,
-      extras?: Record<string, any>,
+      extras?: Record<string, string>,
       triggerId?: string,
       clickAction?: ClickAction,
       uri?: string,
@@ -857,7 +857,7 @@
     constructor(
       message?: string,
       messageAlignment?: TextAlignment,
-      extras?: Record<string, any>,
+      extras?: Record<string, string>,
       triggerId?: string,
       clickAction?: ClickAction,
       uri?: string,
@@ -980,7 +980,7 @@
      */
     constructor(
       message: string,
-      extras?: Record<string, any>,
+      extras?: Record<string, string>,
       triggerId?: string,
       dismissType?: DismissType,
       duration?: number,
@@ -1047,7 +1047,7 @@
       message: string,
       messageAlignment?: TextAlignment,
       slideFrom?: SlideFrom,
-      extras?: Record<string, any>,
+      extras?: Record<string, string>,
       triggerId?: string,
       clickAction?: ClickAction,
       uri?: string,
@@ -1496,9 +1496,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 +1842,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 +2005,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 +2138,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 +2246,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 +2361,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.0",
   "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 = { _n: je, q: ve, Cr: De, Z: Ie, xt: Be, zt: Be.ep, j: Ae, Jo: Ge };
 export default r;

package/shared-lib/encoding-utils.js

@@ -1,5 +1,5 @@
 const je = {
-  wn: 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,33 +1,33 @@
 const ve = {
     CustomEvent: "ce",
     Pr: "p",
-    Ol: "pc",
+    Rl: "pc",
     cc: "ca",
-    Aa: "i",
-    qs: "ie",
-    T: "cci",
-    W: "ccic",
-    _: "ccc",
-    L: "ccd",
-    yh: "ss",
-    wh: "se",
-    Mi: "si",
+    ya: "i",
+    Is: "ie",
+    P: "cci",
+    T: "ccic",
+    $: "ccc",
+    H: "ccd",
+    Vh: "ss",
+    Fh: "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"
+    Pl: "lr",
+    Ll: "uae",
+    R: "ci",
+    B: "cc",
+    Nl: "lcaa",
+    Ml: "lcar",
+    Rn: "inc",
+    Bn: "add",
+    Ln: "rem",
+    Fn: "set",
+    $n: "ncam",
+    Ol: "sgu"
   },
-  De = { qr: "feed_displayed", dc: "content_cards_displayed" };
+  De = { Ar: "feed_displayed", dc: "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,4 +1,4 @@
-export default class Ae {
+export default class Be {
   constructor(t, e) {
     (this.td = "undefined" == typeof window ? self : window),
       (this.ed = t),
@@ -47,10 +47,10 @@ export default class Ae {
           "Upgrading indexedDB " + o.ed.dd + " to v" + o.ed.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.ed.Jt)
+          o.ed.Jt.hasOwnProperty(t) &&
+            !e.objectStoreNames.contains(o.ed.Jt[t]) &&
+            e.createObjectStore(o.ed.Jt[t]);
       }),
       (n.onsuccess = n => {
         const i = n.target.result;
@@ -223,7 +223,7 @@ export default class Ae {
       };
     });
   }
-  Jt(t, e) {
+  Mt(t, e) {
     if (!this.rd()) return !1;
     const n = this;
     return this.sd(o => {
@@ -274,10 +274,10 @@ export default class Ae {
   clearData() {
     if (!this.rd()) 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.ed.Jt)
+      this.ed.Jt.hasOwnProperty(e) &&
+        this.ed.Jt[e] !== this.ed.Jt.oe &&
+        t.push(this.ed.Jt[e]);
     const e = this;
     return this.sd(function(n) {
       const o = n.transaction(t, "readwrite");
@@ -296,19 +296,19 @@ export default class Ae {
     });
   }
 }
-Ae.ep = {
+Be.ep = {
   Ft: {
     dd: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
-    $t: {
-      Il: "data",
-      jr: "pushClicks",
+    Jt: {
+      Xa: "data",
+      kr: "pushClicks",
       cu: "pushSubscribed",
       ud: "fallbackDevice",
-      Mt: "cardUpdates",
+      qt: "cardUpdates",
       oe: "optOut",
-      $r: "pendingData",
-      Mn: "sdkAuthenticationSignature"
+      yr: "pendingData",
+      gu: "sdkAuthenticationSignature"
     },
     se: 1
   }

package/shared-lib/logger.js

@@ -1,38 +1,38 @@
-const Ge = {
+const Ae = {
   init: function(n) {
-    (void 0 === n && void 0 !== Ge.zg) || (Ge.zg = !!n), Ge.Eg || (Ge.Eg = !0);
+    (void 0 === n && void 0 !== Ae.zg) || (Ae.zg = !!n), Ae.Eg || (Ae.Eg = !0);
   },
   destroy: function() {
-    (Ge.Eg = !1), (Ge.zg = void 0), (Ge.nd = void 0);
+    (Ae.Eg = !1), (Ae.zg = void 0), (Ae.nd = void 0);
   },
   setLogger: function(n) {
     "function" == typeof n
-      ? (Ge.init(), (Ge.nd = n))
-      : Ge.info("Ignoring setLogger call since logger is not a function");
+      ? (Ae.init(), (Ae.nd = n))
+      : Ae.info("Ignoring setLogger call since logger is not a function");
   },
   toggleLogging: function() {
-    Ge.init(),
-      Ge.zg
-        ? (console.log("Disabling Braze logging"), (Ge.zg = !1))
-        : (console.log("Enabled Braze logging"), (Ge.zg = !0));
+    Ae.init(),
+      Ae.zg
+        ? (console.log("Disabling Braze logging"), (Ae.zg = !1))
+        : (console.log("Enabled Braze logging"), (Ae.zg = !0));
   },
   info: function(n) {
-    if (Ge.zg) {
+    if (Ae.zg) {
       const o = "Braze: " + n;
-      null != Ge.nd ? Ge.nd(o) : console.log(o);
+      null != Ae.nd ? Ae.nd(o) : console.log(o);
     }
   },
   warn: function(n) {
-    if (Ge.zg) {
-      const o = "Braze SDK Warning: " + n + " (v4.7.2)";
-      null != Ge.nd ? Ge.nd(o) : console.warn(o);
+    if (Ae.zg) {
+      const o = "Braze SDK Warning: " + n + " (v4.8.0)";
+      null != Ae.nd ? Ae.nd(o) : console.warn(o);
     }
   },
   error: function(n) {
-    if (Ge.zg) {
-      const o = "Braze SDK Error: " + n + " (v4.7.2)";
-      null != Ge.nd ? Ge.nd(o) : console.error(o);
+    if (Ae.zg) {
+      const o = "Braze SDK Error: " + n + " (v4.8.0)";
+      null != Ae.nd ? Ae.nd(o) : console.error(o);
     }
   }
 };
-export default Ge;
+export default Ae;

package/shared-lib/supported-options.js

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

package/src/Card/card-manager-factory.js

@@ -3,9 +3,9 @@ import e from "../managers/braze-instance.js";
 const n = {
   t: !1,
   i: null,
-  m: () => (n.o(), n.i || (n.i = new a(e.l(), e.g(), e.p())), n.i),
+  m: () => (n.o(), n.i || (n.i = new a(e.l())), n.i),
   o: () => {
-    n.t || (e.u(n), (n.t = !0));
+    n.t || (e.g(n), (n.t = !0));
   },
   destroy: () => {
     (n.i = null), (n.t = !1);

package/src/Card/card-manager.js

@@ -2,71 +2,77 @@ import { ControlCard } from "./models/index.js";
 import s from "../common/event-logger.js";
 import t from "../models/request-result.js";
 import r from "../../shared-lib/braze-shared-lib.js";
-import { STORAGE_KEYS as o } from "../managers/storage-manager.js";
+import { STORAGE_KEYS as i } from "../managers/storage-manager.js";
 export default class a {
-  constructor(s, t, r) {
-    (this.h = s), (this.j = t), (this.v = r);
+  constructor(s) {
+    (this.u = s), (this.u = s);
   }
-  C(n, i) {
+  h(n, o) {
     const e = new t();
-    if ((n.k(), null == n.url || "" === n.url))
+    if ((n.p(), null == n.url || "" === n.url))
       return (
-        r.D.info(
+        r.j.info(
           `Card ${n.id} has no url. Not logging click to Braze servers.`
         ),
         e
       );
-    if (i) {
-      const s = this.h.I(o.q.$) || {};
-      (s[n.id] = !0), this.h.B(o.q.$, s);
+    if (o && n.id && this.u) {
+      const s = this.u.v(i.k.C) || {};
+      (s[n.id] = !0), this.u.D(i.k.C, s);
     }
-    const l = this.N([n]);
+    const l = this.I([n]);
     if (null == l) return e;
-    const u = i ? r.A._ : r.A.F;
-    return s.G(u, l);
+    const u = o ? r.q.$ : r.q.B;
+    return s.N(u, l);
   }
-  H(n) {
-    const i = new t();
-    if (!n.J())
+  A(n) {
+    const o = new t();
+    if (!n.F())
       return (
-        r.D.info(
+        r.j.info(
           `Card ${n.id} refused this dismissal. Ignoring analytics event.`
         ),
-        i
+        o
       );
-    const e = this.h.I(o.q.K) || {};
-    (e[n.id] = !0), this.h.B(o.q.K, e);
-    const l = this.N([n]);
-    return null == l ? i : s.G(r.A.L, l);
+    if (n.id && this.u) {
+      const s = this.u.v(i.k.G) || {};
+      (s[n.id] = !0), this.u.D(i.k.G, s);
+    }
+    const e = this.I([n]);
+    return null == e ? o : s.N(r.q.H, e);
   }
-  M(n, i) {
+  J(n, o) {
     const e = new t(!0),
       l = [],
       u = [];
     let a;
-    a = i ? this.h.I(o.q.O) || {} : this.h.I(o.q.P) || {};
+    this.u && (a = o ? this.u.v(i.k.K) || {} : this.u.v(i.k.L) || {});
     for (const s of n)
-      s.R(), s instanceof ControlCard ? u.push(s) : l.push(s), (a[s.id] = !0);
-    const c = this.N(l),
-      h = this.N(u);
-    if (null == c && null == h) return (e.S = !1), e;
-    if ((i ? this.h.B(o.q.O, a) : this.h.B(o.q.P, a), null != c)) {
-      const t = i ? r.A.T : r.A.U,
-        n = s.G(t, c);
-      e.V(n);
+      s.M(),
+        s instanceof ControlCard ? u.push(s) : l.push(s),
+        s.id && (a[s.id] = !0);
+    const h = this.I(l),
+      c = this.I(u);
+    if (null == h && null == c) return (e.O = !1), e;
+    if ((this.u && (o ? this.u.D(i.k.K, a) : this.u.D(i.k.L, a)), null != h)) {
+      const t = o ? r.q.P : r.q.R,
+        n = s.N(t, h);
+      e.S(n);
     }
-    if (null != h && i) {
-      const t = s.G(r.A.W, h);
-      e.V(t);
+    if (null != c && o) {
+      const t = s.N(r.q.T, c);
+      e.S(t);
     }
     return e;
   }
-  N(s) {
-    let t = null;
-    for (let r = 0; r < s.length; r++)
-      null != s[r].id &&
-        "" !== s[r].id &&
-        ((t = t || {}), (t.ids = t.ids || []), t.ids.push(s[r].id));
-    return t;
+  I(s) {
+    let t,
+      r = null;
+    for (let n = 0; n < s.length; n++)
+      (t = s[n].id),
+        null != t &&
+          "" !== t &&
+          ((r = r || {}), (r.ids = r.ids || []), r.ids.push(t));
+    return r;
   }
 }