@braze/web-sdk 6.7.1 → 6.8.0

package/index.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definitions for @braze/web-sdk v6.7.1
+* Type definitions for @braze/web-sdk v6.8.0
 * Project: https://github.com/braze-inc/braze-web-sdk
 * (c) Braze, Inc. 2026 - http://braze.com
 * License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE
@@ -1585,7 +1585,7 @@ export type PropertiesJson = Partial<
   >
 >;
 
-export interface eCommerceProductProperties {
+export interface EcommerceProductProperties {
   /**
    * A unique identifier for the product, such as product ID or SKU. Cannot exceed 255 characters in length.
    */
@@ -1622,7 +1622,7 @@ export interface eCommerceProductProperties {
   price: number;
 
   /**
-   * Additional metadata about the product. Keys are limited to 255 characters in length, cannot begin with a $ character, 
+   * Additional metadata about the product. Keys are limited to 255 characters in length, cannot begin with a $ character,
    * and can only contain alphanumeric characters and punctuation. Total size of metadata cannot exceed 50KB.
    */
   metadata?: {
@@ -1634,7 +1634,7 @@ export interface eCommerceProductProperties {
   };
 }
 
-export interface eCommerceEventProperties {
+export interface EcommerceEventProperties {
   /**
    * Default USD. Currencies should be represented as an ISO 4217 currency code. Supported
    * currency symbols include: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF,
@@ -1657,14 +1657,14 @@ export interface eCommerceEventProperties {
 }
 
 export interface CheckoutStartedEventProperties
-  extends eCommerceEventProperties {
+  extends EcommerceEventProperties {
   /**
    * A unique identifier for the checkout. Cannot exceed 255 characters in length.
    */
   checkout_id: string;
 
   /**
-   * A unique identifier for the cart. If no value is passed, a default value is assumed 
+   * A unique identifier for the cart. If no value is passed, a default value is assumed
    * (shared across cart/checkout/order events) for user cart mapping.
    * Cannot exceed 255 characters in length.
    */
@@ -1678,10 +1678,10 @@ export interface CheckoutStartedEventProperties
   /**
    * The products associated with the checkout.
    */
-  products: eCommerceProductProperties[];
+  products: EcommerceProductProperties[];
 
   /**
-   * Additional metadata about the checkout. Keys are limited to 255 characters in length, cannot begin with a $ character, 
+   * Additional metadata about the checkout. Keys are limited to 255 characters in length, cannot begin with a $ character,
    * and can only contain alphanumeric characters and punctuation. Total size of metadata cannot exceed 50KB.
    */
   metadata?: {
@@ -1690,34 +1690,60 @@ export interface CheckoutStartedEventProperties
   };
 }
 
-export interface CartUpdatedEventProperties extends eCommerceEventProperties {
+type CartUpdatedBaseProperties = EcommerceEventProperties & {
   /**
-   * A unique identifier for the cart. If no value is passed, a default value is assumed 
+   * A unique identifier for the cart. If no value is passed, a default value is assumed
    * (shared across cart/checkout/order events) for user cart mapping.
    * Cannot exceed 255 characters in length.
    */
   cart_id: string;
 
-  /**
-   * The total monetary value of the cart (ex: 12.99).
-   */
-  total_value: number;
-
   /**
    * The products in the updated cart.
    */
-  products: eCommerceProductProperties[];
+  products: EcommerceProductProperties[];
 
   /**
-   * Additional metadata about the cart update. Keys are limited to 255 characters in length, cannot begin with a $ character, 
+   * Additional metadata about the cart update. Keys are limited to 255 characters in length, cannot begin with a $ character,
    * and can only contain alphanumeric characters and punctuation. Total size of metadata cannot exceed 50KB.
    */
   metadata?: {
     [key: string]: any;
   };
-}
+};
 
-export interface ProductViewedEventProperties extends eCommerceEventProperties {
+/**
+ * Properties for the `ecommerce.cart_updated` event.
+ *
+ * `total_value` is required when `action` is `"replace"` or omitted (defaults to `"replace"`).
+ * `total_value` is optional when `action` is `"add"` or `"remove"`.
+ */
+export type CartUpdatedEventProperties =
+  | (CartUpdatedBaseProperties & {
+      /**
+       * The action that triggered the cart update. Defaults to "replace" if not provided.
+       * - "replace": the cart contents were fully replaced (default)
+       */
+      action?: "replace";
+      /**
+       * The total monetary value of the cart (ex: 12.99). Required when action is "replace" or omitted.
+       */
+      total_value: number;
+    })
+  | (CartUpdatedBaseProperties & {
+      /**
+       * The action that triggered the cart update.
+       * - "add": one or more products were added to the cart
+       * - "remove": one or more products were removed from the cart
+       */
+      action: "add" | "remove";
+      /**
+       * The total monetary value of the cart (ex: 12.99). Optional when action is "add" or "remove".
+       */
+      total_value?: number;
+    });
+
+export interface ProductViewedEventProperties extends EcommerceEventProperties {
   /**
    * A unique identifier for the product that was viewed. Cannot exceed 255 characters in length.
    */
@@ -1749,7 +1775,7 @@ export interface ProductViewedEventProperties extends eCommerceEventProperties {
   price: number;
 
   /**
-   * Additional metadata about the product viewed. Keys are limited to 255 characters in length, cannot begin with a $ character, 
+   * Additional metadata about the product viewed. Keys are limited to 255 characters in length, cannot begin with a $ character,
    * and can only contain alphanumeric characters and punctuation. Total size of metadata cannot exceed 50KB.
    */
   metadata?: {
@@ -1767,14 +1793,14 @@ export interface ProductViewedEventProperties extends eCommerceEventProperties {
   };
 }
 
-export interface OrderPlacedEventProperties extends eCommerceEventProperties {
+export interface OrderPlacedEventProperties extends EcommerceEventProperties {
   /**
    * A unique identifier for the order that was placed. Cannot exceed 255 characters in length.
    */
   order_id: string;
 
   /**
-   * A unique identifier for the cart. If no value is passed, a default value is assumed 
+   * A unique identifier for the cart. If no value is passed, a default value is assumed
    * (shared across cart/checkout/order events) for user cart mapping.
    * Cannot exceed 255 characters in length.
    */
@@ -1798,10 +1824,10 @@ export interface OrderPlacedEventProperties extends eCommerceEventProperties {
   /**
    * The products in the order.
    */
-  products: eCommerceProductProperties[];
+  products: EcommerceProductProperties[];
 
   /**
-   * Additional metadata about the product viewed. Keys are limited to 255 characters in length, cannot begin with a $ character, 
+   * Additional metadata about the product viewed. Keys are limited to 255 characters in length, cannot begin with a $ character,
    * and can only contain alphanumeric characters and punctuation. Total size of metadata cannot exceed 50KB.
    */
   metadata?: {
@@ -1826,7 +1852,7 @@ export interface OrderPlacedEventProperties extends eCommerceEventProperties {
     referring_site?: string;
 
     /**
-     * A list of payment system sources (ex: POS, mobile, etc.), only applicable to Shopify integrations. 
+     * A list of payment system sources (ex: POS, mobile, etc.), only applicable to Shopify integrations.
      * Each payment gateway name cannot exceed 255 characters in length.
      */
     payment_gateway_names?: string[];
@@ -1834,6 +1860,16 @@ export interface OrderPlacedEventProperties extends eCommerceEventProperties {
   };
 }
 
+/**
+ * The `name` field selects which eCommerce event is logged,
+ * `properties` must match the corresponding properties interface.
+ */
+export type EcommerceEvent =
+  | { name: "ecommerce.product_viewed"; properties: ProductViewedEventProperties }
+  | { name: "ecommerce.cart_updated"; properties: CartUpdatedEventProperties }
+  | { name: "ecommerce.checkout_started"; properties: CheckoutStartedEventProperties }
+  | { name: "ecommerce.order_placed"; properties: OrderPlacedEventProperties };
+
 export class FeatureFlag {
   /** Indicates whether or not this feature flag is enabled. */
   enabled: boolean;
@@ -2305,6 +2341,17 @@ export function logCustomEvent(
   eventProperties?: object,
 ): boolean;
 
+/**
+ * Logs a typed eCommerce event through the custom event pipeline (`EventTypes.CustomEvent`): `n` is the event
+ * name (e.g. `ecommerce.product_viewed`) and `p` is the validated properties payload. On success, fires the same
+ * custom event trigger as `logCustomEvent` for backwards compatibility.
+ *
+ * @param event - Which eCommerce event to log and its validated properties object.
+ *
+ * @returns Whether the event was successfully queued for later flush.
+ */
+export function logEcommerceEvent(event: EcommerceEvent): boolean;
+
 /**
  * Logs that the user clicked the given in-app message button. This is done automatically when the user clicks on
  *    a button in a message generated by `showInAppMessage`,
@@ -2420,7 +2467,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/6.7/service-worker.js');
+ * self.importScripts('https://js.appboycdn.com/web-sdk/6.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).
@@ -2842,7 +2889,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/6.7/service-worker.js');` or by including the content
+   *   `self.importScripts('https://js.appboycdn.com/web-sdk/6.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": "6.7.1",
+  "version": "6.8.0",
   "description": "Braze SDK for web sites and other JS platforms.",
   "main": "src/index.js",
   "scripts": {

package/shared-lib/encoding-utils.js

@@ -1,4 +1,4 @@
-const ui = {
+const ai = {
   Nu: function (t) {
     const r = (t + "=".repeat((4 - (t.length % 4)) % 4))
         .replace(/\-/g, "+")
@@ -9,4 +9,4 @@ const ui = {
     return o;
   },
 };
-export default ui;
+export default ai;

package/shared-lib/event-types.js

@@ -1,35 +1,35 @@
 const p = {
     CustomEvent: "ce",
     Pr: "p",
-    Uc: "pc",
+    Jc: "pc",
     ev: "ca",
-    gl: "i",
-    Ya: "ie",
+    ql: "i",
+    Va: "ie",
     ds: "cci",
     js: "ccic",
     os: "ccc",
     cs: "ccd",
     wm: "ss",
     hm: "se",
-    Fn: "si",
-    On: "sc",
-    Xn: "sbc",
+    Xn: "si",
+    Hn: "sc",
+    Jn: "sbc",
     tv: "sfe",
     om: "iec",
-    Oc: "lr",
-    Nc: "uae",
-    Kc: "lcaa",
-    Jc: "lcar",
+    Bc: "lr",
+    Uc: "uae",
+    Gc: "lcaa",
+    Wc: "lcar",
     Zu: "inc",
     Qu: "add",
     Xu: "rem",
     Yu: "set",
     Vu: "ncam",
-    Wc: "sgu",
+    Xc: "sgu",
     xo: "ffi",
     ro: "bi",
     Dt: "bc",
     Ft: "bd",
   },
-  Qe = { nv: "content_cards_displayed" };
-export { p as EventTypes, Qe as InternalEventTypes };
+  We = { nv: "content_cards_displayed" };
+export { p as EventTypes, We as InternalEventTypes };

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

@@ -338,13 +338,13 @@ et.Ps = {
     xd: "AppboyServiceWorkerAsyncStorage",
     VERSION: 6,
     Os: {
-      pn: "data",
-      $r: "pushClicks",
+      wn: "data",
+      yr: "pushClicks",
       Fu: "pushSubscribed",
       yd: "fallbackDevice",
       _s: "cardUpdates",
       pe: "optOut",
-      qr: "pendingData",
+      Br: "pendingData",
       wh: "sdkAuthenticationSignature",
     },
     be: 1,

package/shared-lib/logger.js

@@ -24,13 +24,13 @@ const E = {
   },
   warn: function (n) {
     if (E.zg) {
-      const o = "Braze SDK Warning: " + n + " (v6.7.1)";
+      const o = "Braze SDK Warning: " + n + " (v6.8.0)";
       null != E.vd ? E.vd(o) : console.warn(o);
     }
   },
   error: function (n) {
     if (E.zg) {
-      const o = "Braze SDK Error: " + n + " (v6.7.1)";
+      const o = "Braze SDK Error: " + n + " (v6.8.0)";
       null != E.vd ? E.vd(o) : console.error(o);
     }
   },

package/shared-lib/supported-options.js

@@ -4,26 +4,26 @@ export default {
   se: "cookieExpiryInDays",
   Oh: "noCookies",
   Th: "devicePropertyAllowlist",
-  ka: "disablePushTokenMaintenance",
+  qa: "disablePushTokenMaintenance",
   Rh: "enableLogging",
   Ph: "enableSdkAuthentication",
-  _a: "manageServiceWorkerExternally",
+  ka: "manageServiceWorkerExternally",
   Dh: "minimumIntervalBetweenTriggerActionsInSeconds",
   Lh: "sessionTimeoutInSeconds",
   yh: "appVersion",
   Mh: "appVersionNumber",
   xa: "serviceWorkerLocation",
-  Ma: "safariWebsitePushId",
-  qa: "localization",
+  _a: "safariWebsitePushId",
+  Ba: "localization",
   sr: "contentSecurityNonce",
   nr: "allowUserSuppliedJavascript",
-  ja: "inAppMessageZIndex",
-  ba: "openInAppMessagesInNewTab",
+  wa: "inAppMessageZIndex",
+  va: "openInAppMessagesInNewTab",
   oh: "requireExplicitInAppMessageDismissal",
   Uh: "doNotLoadFontAwesome",
   Wh: "deviceId",
-  ya: "serviceWorkerScope",
-  Qe: "dustHost",
+  Ma: "serviceWorkerScope",
+  Xe: "dustHost",
   Bh: "sdkFlavor",
   tn: "openCardsInNewTab",
 };

package/src/Banner/log-banner-impressions.js

@@ -10,22 +10,31 @@ export function logBannerImpressions(o) {
     s = n.k();
   if (0 === D(s).length)
     return E.info("Not logging banners impression. No banners exist."), !1;
-  const e = n.Ut(),
-    t = [];
-  for (const r of o) {
-    const o = s[r];
+  let e = n.Ut(),
+    t = !1;
+  if (Object.keys(e).some((o) => void 0 !== s[o])) {
+    const o = {};
+    for (const n of Object.keys(e)) {
+      const r = s[n];
+      r && e[n] && (o[r.id] = !0);
+    }
+    (e = o), (t = !0);
+  }
+  const a = [];
+  for (const n of o) {
+    const o = s[n];
     o
-      ? e[o.placementId]
+      ? e[o.id]
         ? E.info(
-            `Not logging banners impression for ID ${r}. This ID was already logged this session.`,
+            `Not logging banners impression for ID ${n}. This ID was already logged this session.`,
           )
-        : ((e[o.placementId] = !0), t.push(o.id))
+        : ((e[o.id] = !0), a.push(o.id))
       : E.info(
-          `Not logging banners impression for ID ${r}. The placement ID did not correspond to any banner.`,
+          `Not logging banners impression for ID ${n}. The placement ID did not correspond to any banner.`,
         );
   }
-  if (0 === t.length) return !1;
+  if (0 === a.length) return t && n.At(e), !1;
   n.At(e);
-  const a = { ids: t };
-  return v.wt(p.ro, a).lt;
+  const f = { ids: a };
+  return v.wt(p.ro, f).lt;
 }

package/src/ContentCards/content-cards-provider-factory.js

@@ -1,24 +1,26 @@
 import r from "../managers/braze-instance.js";
 import rr from "./content-cards-provider.js";
-const er = {
+const ir = {
   i: !1,
   provider: null,
   o: () => (
-    er.t(),
-    er.provider ||
-      ((er.provider = new rr(r.ir(), r.p(), r.l(), r.ar(), r.m())),
-      r.v(er.provider),
-      r.dr("ccr", () => {
+    ir.t(),
+    ir.provider ||
+      ((ir.provider = new rr(r.ir(), r.p(), r.l(), r.dr(), r.m())),
+      r.v(ir.provider),
+      r.ar("ccr", () => {
         var r;
-        null === (r = er.provider) || void 0 === r || r.lr();
+        null === (r = ir.provider) ||
+          void 0 === r ||
+          r.lr(void 0, void 0, "dust");
       })),
-    er.provider
+    ir.provider
   ),
   t: () => {
-    er.i || (r.g(er), (er.i = !0));
+    ir.i || (r.g(ir), (ir.i = !0));
   },
   destroy: () => {
-    (er.provider = null), (er.i = !1);
+    (ir.provider = null), (ir.i = !1);
   },
 };
-export default er;
+export default ir;

package/src/ContentCards/content-cards-provider.js

@@ -207,17 +207,17 @@ export default class rr extends t {
   Fi() {
     this.Ws && (clearTimeout(this.Ws), (this.Ws = null));
   }
-  lr(t, i, e = !1) {
+  lr(t, i, e = "sdk") {
     var n;
     const o = this.B,
       u = this.C;
     if (!o || !u) return void ("function" == typeof i && i());
-    if ((e && (h.Li(u, h.it.Ji), this.Fi()), !this.Ui()))
+    if (("client" === e && (h.Li(u, h.it.Ji), this.Fi()), !this.Ui()))
       return void (
         null === (n = this.h) ||
         void 0 === n ||
         n.Mi(() => {
-          this.lr(t, i, !0);
+          this.lr(t, i, "client");
         })
       );
     const f = o.Z({}, !0);
@@ -267,7 +267,7 @@ export default class rr extends t {
               o.yt(
                 e,
                 () => {
-                  this.lr(t, i, !1);
+                  this.lr(t, i);
                 },
                 h.it.Ji,
                 (t) => this.xi(t),

package/src/ContentCards/get-cached-content-cards.js

@@ -1,5 +1,5 @@
-import er from "./content-cards-provider-factory.js";
+import ir from "./content-cards-provider-factory.js";
 import r from "../managers/braze-instance.js";
 export function getCachedContentCards() {
-  if (r.rr()) return er.o().qi(!1);
+  if (r.rr()) return ir.o().qi(!1);
 }

package/src/ContentCards/request-content-cards-refresh.js

@@ -1,5 +1,5 @@
 import r from "../managers/braze-instance.js";
-import er from "./content-cards-provider-factory.js";
+import ir from "./content-cards-provider-factory.js";
 export function requestContentCardsRefresh(e, t) {
-  if (r.rr()) return er.o().lr(e, t, !0);
+  if (r.rr()) return ir.o().lr(e, t, "client");
 }

package/src/ContentCards/subscribe-to-content-cards-updates.js

@@ -1,16 +1,16 @@
 import r from "../managers/braze-instance.js";
-import er from "./content-cards-provider-factory.js";
-export function subscribeToContentCardsUpdates(o) {
+import ir from "./content-cards-provider-factory.js";
+export function subscribeToContentCardsUpdates(t) {
   if (!r.rr()) return;
-  const t = er.o(),
-    n = t.zt(o);
-  if (!t.Lt()) {
-    const o = r.nn();
-    if (o) {
-      const r = o.rn(() => {
-        t.lr(void 0, void 0, !0);
+  const o = ir.o(),
+    n = o.zt(t);
+  if (!o.Lt()) {
+    const t = r.nn();
+    if (t) {
+      const r = t.rn(() => {
+        o.lr(void 0, void 0, "client");
       });
-      r && t.$t(r);
+      r && o.$t(r);
     }
   }
   return n;

package/src/ContentCards/ui/show-content-cards.js

@@ -1,6 +1,6 @@
 import r, { OPTIONS as U } from "../../managers/braze-instance.js";
 import { ContentCards, subscribeToContentCardsUpdates } from "../index.js";
-import er from "../content-cards-provider-factory.js";
+import ir from "../content-cards-provider-factory.js";
 import { setCardHeight as tn } from "../../Card/display/card-display.js";
 import { logger as E } from "../../../shared-lib/index.js";
 import {
@@ -19,10 +19,10 @@ export function showContentCards(n, t) {
   let e = !1;
   null == n && ((n = document.body), (e = !0));
   const o = r.er(U.tn) || !1,
-    s = er.o().qi(!1);
+    s = ir.o().qi(!1);
   "function" == typeof t && cn(s, t(s.cards.slice()), s.lastUpdated, null, o);
   const a = on(s, o, e),
-    i = er.o(),
+    i = ir.o(),
     c = i.fi();
   (null == s.lastUpdated ||
     new Date().valueOf() - s.lastUpdated.valueOf() > ContentCards.mr) &&

package/src/Core/change-user.js

@@ -1,5 +1,5 @@
 import r from "../managers/braze-instance.js";
-import { getByteLength as ir } from "../util/string-utils.js";
+import { getByteLength as er } from "../util/string-utils.js";
 import { logger as E } from "../../shared-lib/index.js";
 import { User } from "../User/index.js";
 import { validateStandardString as tr } from "../util/validation-utils.js";
@@ -7,7 +7,7 @@ export function changeUser(e, i) {
   if (!r.rr()) return;
   if (null == e || 0 === e.length || e != e)
     return void E.error("changeUser requires a non-empty userId.");
-  if (ir(e) > User.br)
+  if (er(e) > User.br)
     return void E.error(
       `Rejected user id "${e}" because it is longer than ${User.br} bytes.`,
     );

package/src/Core/index.js

@@ -11,6 +11,7 @@ export { initialize } from "./initialize.js";
 export { isDisabled } from "./is-disabled.js";
 export { isInitialized } from "./is-initialized.js";
 export { logCustomEvent } from "./log-custom-event.js";
+export { logEcommerceEvent } from "./log-ecommerce-event.js";
 export { logPurchase } from "./log-purchase.js";
 export { openSession } from "./open-session.js";
 export { removeAllSubscriptions } from "./remove-all-subscriptions.js";

package/src/Core/log-ecommerce-event.js

@@ -0,0 +1,29 @@
+import { EventTypes as p, logger as E } from "../../shared-lib/index.js";
+import v from "../common/event-logger.js";
+import r from "../managers/braze-instance.js";
+import ot from "../triggers/models/trigger-events.js";
+import { TriggersProviderFactory as rt } from "../triggers/triggers-provider-factory.js";
+import { sanitizeEcommerceEvent as re } from "../util/ecommerce-event-validation.js";
+export function logEcommerceEvent(e) {
+  if (!r.rr()) return !1;
+  if (null == e || "object" != typeof e || null == e.name)
+    return (
+      E.error(
+        'logEcommerceEvent requires an event object with a "name" field.',
+      ),
+      !1
+    );
+  const o = re(e);
+  if (null == o) return !1;
+  const t = r.l();
+  if (t && t.$e(e.name))
+    return (
+      E.info(`The eCommerce event "${e.name}" is blocklisted, ignoring.`), !1
+    );
+  const n = v.wt(p.CustomEvent, { n: e.name, p: o });
+  if (n.lt) {
+    E.info(`Logged eCommerce event "${e.name}".`);
+    for (const r of n.Ce) rt.o().Ee(ot.he, [e.name, e.properties], r);
+  }
+  return n.lt;
+}