@braze/web-sdk 4.4.0 → 4.5.0

package/index.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definitions for @braze/web-sdk v4.4.0
+* Type definitions for @braze/web-sdk v4.5.0
 * Project: https://github.com/braze-inc/braze-web-sdk
 * (c) Braze, Inc. 2022 - http://braze.com
 * License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE
@@ -122,6 +122,9 @@
     /** Whether to pin this card to the top of the view. */
     pinned: boolean;
 
+    /** Whether this card is a ControlCard. */
+    isControl: boolean;
+
 
   }
 
@@ -468,6 +471,12 @@
      *   Braze with in-app message analytics events.
      */
     triggerId?: string;
+
+    /** Object of string/string key/value pairs. */
+    extras: Record<string, any>;
+
+    /** Whether this message is a ControlMessage. */
+    isControl: boolean;
   }
 
   
@@ -588,6 +597,9 @@
      */
     css?: string;
 
+    /** Whether this message is a ControlMessage. */
+    isControl: boolean;
+
     /**
      * Call this method if you wish to programmatically remove the message from the DOM. This method will only
      *   work with the Braze UI.
@@ -1932,7 +1944,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.4/service-worker.js');
+   * self.importScripts('https://js.appboycdn.com/web-sdk-develop/4.5/service-worker.js');
    * ```
    *
    * For more details, see [Our Product Documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
@@ -2285,7 +2297,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.4/service-worker.js');` or by including the content
+     *   `self.importScripts('https://js.appboycdn.com/web-sdk-develop/4.5/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.4.0",
+  "version": "4.5.0",
   "description": "Braze SDK for web sites and other JS platforms.",
   "main": "src/index.js",
   "scripts": {

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

@@ -4,5 +4,5 @@ import Ae from "./guid.js";
 import Ge from "./indexed-db-adapter.js";
 import Oe from "./logger.js";
 import Ue from "./supported-options.js";
-const r = { vn: ve, A: De, qr: Be, it: Ae, qt: Ge, xt: Ge.ep, D: Oe, Fo: Ue };
+const r = { kn: ve, A: De, qr: Be, it: Ae, qt: Ge, xt: Ge.ep, D: Oe, Vo: Ue };
 export default r;

package/shared-lib/encoding-utils.js

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

package/shared-lib/event-types.js

@@ -1,9 +1,9 @@
 const De = {
     CustomEvent: "ce",
     Pr: "p",
-    Ul: "pc",
+    xl: "pc",
     cc: "ca",
-    Aa: "i",
+    za: "i",
     qs: "ie",
     T: "cci",
     W: "ccic",
@@ -16,17 +16,17 @@ const De = {
     mi: "sbc",
     ui: "sfe",
     ro: "iec",
-    Ol: "lr",
-    Nl: "uae",
+    Ul: "lr",
+    Ol: "uae",
     U: "ci",
     F: "cc",
-    Wl: "lcaa",
-    Kl: "lcar",
+    Bl: "lcaa",
+    Wl: "lcar",
     Fn: "inc",
     Un: "add",
     En: "rem",
     An: "set",
-    Bl: "sgu"
+    Gl: "sgu"
   },
   Be = { Fr: "feed_displayed", dc: "content_cards_displayed" };
 export { De as EventTypes, Be as InternalEventTypes };

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

@@ -301,7 +301,7 @@ Ge.ep = {
     dd: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
     $t: {
-      xl: "data",
+      Kl: "data",
       jr: "pushClicks",
       cu: "pushSubscribed",
       ud: "fallbackDevice",

package/shared-lib/logger.js

@@ -24,13 +24,13 @@ const Oe = {
   },
   warn: function(n) {
     if (Oe.zg) {
-      const o = "Braze SDK Warning: " + n + " (v4.4.0)";
+      const o = "Braze SDK Warning: " + n + " (v4.5.0)";
       null != Oe.nd ? Oe.nd(o) : console.warn(o);
     }
   },
   error: function(n) {
     if (Oe.zg) {
-      const o = "Braze SDK Error: " + n + " (v4.4.0)";
+      const o = "Braze SDK Error: " + n + " (v4.5.0)";
       null != Oe.nd ? Oe.nd(o) : console.error(o);
     }
   }

package/shared-lib/supported-options.js

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

package/src/Card/models/card.js

@@ -24,6 +24,7 @@ export default class Card {
       (this.dismissible = N || !1),
       (this.dismissed = !1),
       (this.clicked = S || !1),
+      (this.isControl = !1),
       (this.test = !1),
       (this.lt = null),
       (this.Et = null);

package/src/Card/models/control-card.js

@@ -1,6 +1,6 @@
 import Card from "./card.js";
 export default class ControlCard extends Card {
-  constructor(l, t, s, n, u, i) {
+  constructor(l, t, s, n, i, u) {
     super(
       l,
       t,
@@ -14,10 +14,11 @@ export default class ControlCard extends Card {
       null,
       null,
       null,
-      u,
       i,
+      u,
       null
     ),
+      (this.isControl = !0),
       (this.Y = "ab-control-card"),
       (this.Z = !1);
   }

package/src/InAppMessage/log-in-app-message-click.js

@@ -1,6 +1,7 @@
 import e from "../managers/braze-instance.js";
 import InAppMessage from "./models/in-app-message.js";
 import pe from "./in-app-message-manager-factory.js";
+import { logInAppMessageImpression } from "./log-in-app-message-impression.js";
 import { MUST_BE_IN_APP_MESSAGE_WARNING as or } from "../common/constants.js";
 import r from "../../shared-lib/braze-shared-lib.js";
 import V from "../triggers/models/trigger-events.js";
@@ -9,8 +10,10 @@ export function logInAppMessageClick(o) {
   if (!e.rr()) return !1;
   if (!(o instanceof InAppMessage)) return r.D.error(or), !1;
   const s = pe.m().G(o, r.A.pi);
-  if (s)
+  if (s) {
+    o.Cr() || logInAppMessageImpression(o);
     for (let r = 0; r < s.ve.length; r++)
       W.er().je(V.Ar, [o.triggerId], s.ve[r]);
+  }
   return s.S;
 }

package/src/InAppMessage/models/control-message.js

@@ -1,6 +1,6 @@
 export default class ControlMessage {
   constructor(t) {
-    this.triggerId = t;
+    (this.triggerId = t), (this.extras = {}), (this.isControl = !0);
   }
   static fromJson(t) {
     return new ControlMessage(t.trigger_id);

package/src/InAppMessage/models/in-app-message.js

@@ -35,8 +35,8 @@ export default class InAppMessage {
     R,
     b,
     P,
-    C,
-    U
+    p,
+    C
   ) {
     (this.message = t),
       (this.messageAlignment = s || InAppMessage.TextAlignment.CENTER),
@@ -67,8 +67,9 @@ export default class InAppMessage {
       (this.buttons = R || []),
       (this.cropType = b || InAppMessage.CropType.FIT_CENTER),
       (this.orientation = P),
-      (this.htmlId = C),
-      (this.css = U),
+      (this.htmlId = p),
+      (this.css = C),
+      (this.isControl = !1),
       (this.Ri = !1),
       (this.nl = !1),
       (this.Pi = !1),
@@ -108,6 +109,9 @@ export default class InAppMessage {
   R() {
     return !this.Ri && ((this.Ri = !0), !0);
   }
+  Cr() {
+    return this.Ri;
+  }
   k() {
     return !this.nl && ((this.nl = !0), this.lt.St(), !0);
   }

package/src/Push/push-manager.js

@@ -15,19 +15,19 @@ export default class aa {
       (this.Ir = n),
       (this.gt = o),
       (this.Vr = u || !1),
-      (this.Cr = a || !1),
+      (this.Er = a || !1),
       (this.h = h),
-      (this.Er = dt.Or()),
-      (this.Br = dt.Mr());
+      (this.Or = dt.Br()),
+      (this.Mr = dt.Yr());
   }
-  Yr() {
-    return this.Cr;
+  Gr() {
+    return this.Er;
   }
-  Gr(i, e, t, s, n) {
+  Hr(i, e, t, s, n) {
     i.unsubscribe()
       .then(i => {
         i
-          ? this.Hr(e, t, s, n)
+          ? this.Jr(e, t, s, n)
           : (r.D.error("Failed to unsubscribe device from push."),
             "function" == typeof n && n(!1));
       })
@@ -36,16 +36,16 @@ export default class aa {
           "function" == typeof n && n(!1);
       });
   }
-  Jr(i, e, t) {
+  Kr(i, e, t) {
     const s = (i => {
       if ("string" == typeof i) return i;
       if (0 !== i.endpoint.indexOf("https://android.googleapis.com/gcm/send"))
         return i.endpoint;
       let e = i.endpoint;
       return (
-        i.Kr &&
-          -1 === i.endpoint.indexOf(i.Kr) &&
-          (e = i.endpoint + "/" + i.Kr),
+        i.Lr &&
+          -1 === i.endpoint.indexOf(i.Lr) &&
+          (e = i.endpoint + "/" + i.Lr),
         e
       );
     })(i);
@@ -73,15 +73,15 @@ export default class aa {
             .replace(/\//g, "_")
         : null;
     })(i);
-    this.Sr.Lr(s, t, r, n, o), s && "function" == typeof e && e(s, r, n);
+    this.Sr.Qr(s, t, r, n, o), s && "function" == typeof e && e(s, r, n);
   }
-  Qr() {
-    this.Sr.Xr(!0);
+  Xr() {
+    this.Sr.Zr(!0);
   }
-  Zr(i, e) {
-    this.Sr.Xr(!1), r.D.info(i), "function" == typeof e && e(!1);
+  hn(i, e) {
+    this.Sr.Zr(!1), r.D.info(i), "function" == typeof e && e(!1);
   }
-  hn(i, e, t, s) {
+  fn(i, e, t, s) {
     if ("default" === e.permission)
       try {
         window.safari.pushNotification.requestPermission(
@@ -93,23 +93,23 @@ export default class aa {
               this.Sr.setPushNotificationSubscriptionType(
                 User.NotificationSubscriptionTypes.OPTED_IN
               ),
-              this.hn(i, e, t, s);
+              this.fn(i, e, t, s);
           }
         );
       } catch (i) {
-        this.Zr("Could not request permission for push: " + i, s);
+        this.hn("Could not request permission for push: " + i, s);
       }
     else
       "denied" === e.permission
-        ? this.Zr(
+        ? this.hn(
             "The user has blocked notifications from this site, or Safari push is not configured in the Braze dashboard.",
             s
           )
         : "granted" === e.permission &&
           (r.D.info("Device successfully subscribed to push."),
-          this.Jr(e.deviceToken, t, new Date()));
+          this.Kr(e.deviceToken, t, new Date()));
   }
-  fn(i, e, t) {
+  dn(i, e, t) {
     const s = s => {
       switch (s) {
         case "granted":
@@ -132,14 +132,14 @@ export default class aa {
         })
       : (n = !0);
   }
-  Hr(i, e, t, s) {
+  Jr(i, e, t, s) {
     const n = { userVisibleOnly: !0 };
     null != e && (n.applicationServerKey = e),
       i.pushManager
         .subscribe(n)
         .then(i => {
           r.D.info("Device successfully subscribed to push."),
-            this.Jr(i, t, new Date());
+            this.Kr(i, t, new Date());
         })
         .catch(i => {
           dt.isPushBlocked()
@@ -148,7 +148,7 @@ export default class aa {
             : r.D.error("Push subscription failed: " + i);
         });
   }
-  dn() {
+  pn() {
     return this.Vr
       ? navigator.serviceWorker.getRegistration()
       : navigator.serviceWorker.register(this.Nr).then(() =>
@@ -164,13 +164,13 @@ export default class aa {
           )
         );
   }
-  pn(i) {
+  bn(i) {
     this.Vr ||
       (i.unregister(), r.D.info("Service worker successfully unregistered."));
   }
   subscribe(i, e) {
     if (dt.isPushSupported()) {
-      if (this.Er) {
+      if (this.Or) {
         if (!this.Vr && null != window.location) {
           let i = this.Nr;
           -1 === i.indexOf(window.location.host) &&
@@ -178,7 +178,7 @@ export default class aa {
             -1 === i.indexOf(window.location.protocol) &&
               (i = window.location.protocol + "//" + i);
           const e = i.substr(0, i.lastIndexOf("/") + 1);
-          if (0 !== H.bn().indexOf(e))
+          if (0 !== H.gn().indexOf(e))
             return void r.D.error(
               "Cannot subscribe to push from a path higher than the service worker location (tried to subscribe from " +
                 window.location.pathname +
@@ -188,16 +188,16 @@ export default class aa {
             );
         }
         if (dt.isPushBlocked())
-          return void this.Zr(
+          return void this.hn(
             "Notifications from this site are blocked. This may be a temporary embargo or a permanent denial.",
             e
           );
-        if (this.gt && !this.gt.gn() && 0 === this.gt.Zs())
+        if (this.gt && !this.gt.wn() && 0 === this.gt.Zs())
           return (
             r.D.info(
               "Waiting for VAPID key from server config before subscribing to push."
             ),
-            void this.gt.wn(() => {
+            void this.gt.yn(() => {
               this.subscribe(i, e);
             })
           );
@@ -219,7 +219,7 @@ export default class aa {
               this.Sr.setPushNotificationSubscriptionType(
                 User.NotificationSubscriptionTypes.OPTED_IN
               ),
-              this.dn()
+              this.pn()
                 .then(t => {
                   if (null == t)
                     return (
@@ -234,17 +234,17 @@ export default class aa {
                       let n = null;
                       if (
                         (this.gt &&
-                          null != this.gt.gn() &&
-                          (n = r.vn.yn(this.gt.gn())),
+                          null != this.gt.wn() &&
+                          (n = r.kn.vn(this.gt.wn())),
                         s)
                       ) {
                         let u = null,
                           a = null;
-                        const h = this.h.I(o.q.kn);
+                        const h = this.h.I(o.q.Pn);
                         if (h && !p(h)) {
                           let i;
                           try {
-                            i = ei.Dn(h).Pn;
+                            i = ei.Sn(h).Dn;
                           } catch (e) {
                             i = null;
                           }
@@ -268,30 +268,30 @@ export default class aa {
                               : r.D.info(
                                   "Attempting to upgrade a gcm_sender_id-based push registration to VAPID - depending on the browser this may or may not result in the same gcm_sender_id-based subscription."
                                 ),
-                            this.Gr(s, t, n, i, e))
+                            this.Hr(s, t, n, i, e))
                           : s.expirationTime &&
                             new Date(s.expirationTime) <= new Date().valueOf()
                           ? (r.D.info(
                               "Push subscription is expired, creating new subscription."
                             ),
-                            this.Gr(s, t, n, i, e))
+                            this.Hr(s, t, n, i, e))
                           : h && p(h)
-                          ? this.Gr(s, t, n, i, e)
+                          ? this.Hr(s, t, n, i, e)
                           : null == a
                           ? (r.D.info(
                               "No push subscription creation date found, creating new subscription."
                             ),
-                            this.Gr(s, t, n, i, e))
+                            this.Hr(s, t, n, i, e))
                           : a <= new Date().valueOf()
                           ? (r.D.info(
                               "Push subscription older than 6 months, creating new subscription."
                             ),
-                            this.Gr(s, t, n, i, e))
+                            this.Hr(s, t, n, i, e))
                           : (r.D.info(
                               "Device already subscribed to push, sending existing subscription to backend."
                             ),
-                            this.Jr(s, i, u));
-                      } else this.Hr(t, n, i, e);
+                            this.Kr(s, i, u));
+                      } else this.Jr(t, n, i, e);
                     })
                     .catch(i => {
                       r.D.error(
@@ -303,27 +303,27 @@ export default class aa {
                   r.D.error("ServiceWorker registration failed: " + i);
                 });
           };
-        this.fn(u, s, t);
-      } else if (this.Br) {
+        this.dn(u, s, t);
+      } else if (this.Mr) {
         if (null == this.Ir || "" === this.Ir)
           return void r.D.error(
             "You must supply the safariWebsitePushId initialization option in order to use registerPush on Safari"
           );
         const t = window.safari.pushNotification.permission(this.Ir);
-        this.hn(this.Ir, t, i, e);
+        this.fn(this.Ir, t, i, e);
       }
-    } else r.D.info(this.Sn);
+    } else r.D.info(this._n);
   }
   unsubscribe(i, e) {
     dt.isPushSupported()
-      ? this.Er
+      ? this.Or
         ? navigator.serviceWorker.getRegistration().then(t => {
             t
               ? t.pushManager
                   .getSubscription()
                   .then(s => {
                     s &&
-                      (this.Qr(),
+                      (this.Xr(),
                       s
                         .unsubscribe()
                         .then(s => {
@@ -336,7 +336,7 @@ export default class aa {
                                 "Failed to unsubscribe device from push."
                               ),
                               "function" == typeof e && e()),
-                            this.pn(t);
+                            this.bn(t);
                         })
                         .catch(i => {
                           r.D.error("Push unsubscription error: " + i),
@@ -350,11 +350,11 @@ export default class aa {
               : (r.D.info("Device already unsubscribed from push."),
                 "function" == typeof i && i());
           })
-        : this.Br &&
-          (this.Qr(),
+        : this.Mr &&
+          (this.Xr(),
           r.D.info("Device unsubscribed from push."),
           "function" == typeof i && i())
-      : r.D.info(this.Sn);
+      : r.D.info(this._n);
   }
 }
-aa.Sn = "Push notifications are not supported in this browser.";
+aa._n = "Push notifications are not supported in this browser.";

package/src/Push/utils/push-utils.js

@@ -1,15 +1,15 @@
 const dt = {
-  Or: () =>
+  Br: () =>
     "serviceWorker" in navigator &&
     "undefined" != typeof ServiceWorkerRegistration &&
     "showNotification" in ServiceWorkerRegistration.prototype &&
     "PushManager" in window,
-  Mr: () =>
+  Yr: () =>
     "safari" in window &&
     "pushNotification" in window.safari &&
     "function" == typeof window.safari.pushNotification.permission &&
     "function" == typeof window.safari.pushNotification.requestPermission,
-  isPushSupported: () => dt.Or() || dt.Mr(),
+  isPushSupported: () => dt.Br() || dt.Yr(),
   isPushBlocked: () => {
     const i =
         dt.isPushSupported() &&

package/src/User/user-manager.js

@@ -44,7 +44,7 @@ export default class bt {
       u
     );
   }
-  Lr(t, s, e, i, u) {
+  Qr(t, s, e, i, u) {
     this.nu("push_token", t, !1, !0),
       this.nu("custom_push_public_key", e, !1, !0),
       this.nu("custom_push_user_auth", i, !1, !0),
@@ -52,9 +52,9 @@ export default class bt {
     const h = r.xt.Ft,
       n = new r.qt(h, r.D),
       l = new ei(t, s, e, i, u);
-    this.h.B(o.q.kn, l.ss()), n.setItem(h.$t.cu, h.se, !0);
+    this.h.B(o.q.Pn, l.ss()), n.setItem(h.$t.cu, h.se, !0);
   }
-  Xr(t) {
+  Zr(t) {
     if (
       (this.nu("push_token", null, !1, !0),
       this.nu("custom_push_public_key", null, !1, !0),
@@ -64,7 +64,7 @@ export default class bt {
     ) {
       const t = r.xt.Ft,
         s = new r.qt(t, r.D);
-      this.h.B(o.q.kn, !1), s.setItem(t.$t.cu, t.se, !1);
+      this.h.B(o.q.Pn, !1), s.setItem(t.$t.cu, t.se, !1);
     }
   }
 }

package/src/User/user.js

@@ -236,7 +236,7 @@ export default class User {
           "addToSubscriptionGroup requires a non-empty subscription group ID"
         ),
         !1)
-      : this.si.$n(t, User._n.SUBSCRIBED).S;
+      : this.si.$n(t, User.Bn.SUBSCRIBED).S;
   }
   removeFromSubscriptionGroup(t) {
     return !R(
@@ -249,13 +249,13 @@ export default class User {
           "removeFromSubscriptionGroup requires a non-empty subscription group ID"
         ),
         !1)
-      : this.si.$n(t, User._n.UNSUBSCRIBED).S;
+      : this.si.$n(t, User.Bn.UNSUBSCRIBED).S;
   }
-  Lr(t, e, s, r, i) {
-    this.v.Lr(t, e, s, r, i), this.si.Bn();
+  Qr(t, e, s, r, i) {
+    this.v.Qr(t, e, s, r, i), this.si.Ln();
   }
-  Xr(t) {
-    this.v.Xr(t);
+  Zr(t) {
+    this.v.Zr(t);
   }
 }
 (User.Cn = /^[0-9 .\\(\\)\\+\\-]+$/),
@@ -272,7 +272,7 @@ export default class User {
     SUBSCRIBED: "subscribed",
     UNSUBSCRIBED: "unsubscribed"
   }),
-  (User._n = { SUBSCRIBED: "subscribed", UNSUBSCRIBED: "unsubscribed" }),
-  (User.Ln = "user_id"),
+  (User.Bn = { SUBSCRIBED: "subscribed", UNSUBSCRIBED: "unsubscribed" }),
+  (User.Rn = "user_id"),
   (User.lu = "custom"),
   (User.ee = 997);