@braze/web-sdk 6.6.0 → 6.7.1

package/index.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definitions for @braze/web-sdk v6.6.0
+* Type definitions for @braze/web-sdk v6.7.1
 * 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,6 +1585,255 @@ export type PropertiesJson = Partial<
   >
 >;
 
+export interface eCommerceProductProperties {
+  /**
+   * A unique identifier for the product, such as product ID or SKU. Cannot exceed 255 characters in length.
+   */
+  product_id: string;
+
+  /**
+   * The name of the product. Cannot exceed 255 characters in length.
+   */
+  product_name: string;
+
+  /**
+   * A unique identifier for the product variant (ex: shirt_medium_blue). Cannot exceed 255 characters in length.
+   */
+  variant_id: string;
+
+  /**
+   * The URL of the product image. Cannot exceed 255 characters in length.
+   */
+  image_url?: string;
+
+  /**
+   * The URL of the product page. Cannot exceed 255 characters in length.
+   */
+  product_url?: string;
+
+  /**
+   * The number of units of the product.
+   */
+  quantity: number;
+
+  /**
+   * The variant unit price of the product at the time of viewing (ex: 12.99).
+   */
+  price: number;
+
+  /**
+   * 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?: {
+    /**
+     * Shopify SKU, only applicable to Shopify integrations. Cannot exceed 255 characters in length.
+     */
+    sku?: string;
+    [key: string]: any;
+  };
+}
+
+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,
+   * BMD, BND, BOB, BRL, BSD, BTC, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE,
+   * CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD,
+   * HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW,
+   * KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MTL,
+   * MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR,
+   * RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT,
+   * TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XCD, XDR, XOF,
+   * XPD, XPF, XPT, YER, ZAR, ZMK, ZMW, and ZWL. Any other provided currency symbol will result in a logged
+   * warning and no other action taken by the SDK.
+   */
+  currency: string;
+
+  /**
+   * The source the event is derived from. Cannot exceed 255 characters in length.
+   */
+  source: string;
+}
+
+export interface CheckoutStartedEventProperties
+  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 
+   * (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 associated with the checkout.
+   */
+  products: eCommerceProductProperties[];
+
+  /**
+   * 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?: {
+    checkout_url?: string;
+    [key: string]: any;
+  };
+}
+
+export interface CartUpdatedEventProperties extends eCommerceEventProperties {
+  /**
+   * 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[];
+
+  /**
+   * 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 {
+  /**
+   * A unique identifier for the product that was viewed. Cannot exceed 255 characters in length.
+   */
+  product_id: string;
+
+  /**
+   * The name of the product that was viewed. Cannot exceed 255 characters in length.
+   */
+  product_name: string;
+
+  /**
+   * A unique identifier for the product variant that was viewed (ex: shirt_medium_blue). Cannot exceed 255 characters in length.
+   */
+  variant_id: string;
+
+  /**
+   * The URL of the product image that was viewed. Cannot exceed 255 characters in length.
+   */
+  image_url?: string;
+
+  /**
+   * The URL to the product page for more details. Cannot exceed 255 characters in length.
+   */
+  product_url?: string;
+
+  /**
+   * The variant unit price of the product at the time of viewing.
+   */
+  price: number;
+
+  /**
+   * 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?: {
+    /**
+     * Shopify SKU, only applicable to Shopify integrations. Cannot exceed 255 characters in length.
+     */
+    sku?: string;
+
+    /**
+     * A list of types for the product that was viewed. The `back_in_stock` and `price_drop` types can be used to trigger
+     * back-in-stock and price drop notifications. Each type cannot exceed 255 characters in length.
+     */
+    type?: string[];
+    [key: string]: any;
+  };
+}
+
+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 
+   * (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 order (ex: 12.99).
+   */
+  total_value: number;
+
+  /**
+   * The total amount of discounts applied to the order (ex: 12.99).
+   */
+  total_discounts?: number;
+
+  /**
+   * A detailed list of discounts applied to the order.
+   */
+  discounts?: any[];
+
+  /**
+   * The products in the order.
+   */
+  products: eCommerceProductProperties[];
+
+  /**
+   * 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?: {
+    /**
+     * The URL to view the status of the order. Cannot exceed 255 characters in length.
+     */
+    order_status_url?: string;
+
+    /**
+     * A unique order number for the order placed, only applicable to Shopify integrations. Cannot exceed 255 characters in length.
+     */
+    order_number?: string;
+
+    /**
+     * A list of tags associated with the order placed, only applicable to Shopify integrations. Each tag cannot exceed 255 characters in length.
+     */
+    tags?: string[];
+
+    /**
+     * The site the order originated from (ex: Meta), only applicable to Shopify integrations. Cannot exceed 255 characters in length.
+     */
+    referring_site?: string;
+
+    /**
+     * 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[];
+    [key: string]: any;
+  };
+}
+
 export class FeatureFlag {
   /** Indicates whether or not this feature flag is enabled. */
   enabled: boolean;
@@ -2023,7 +2272,7 @@ export function logBannerImpressions(
 ): boolean | undefined;
 
 /**
- * Logs when user clicks on a Banner.
+ * Logs when the user clicks on a Banner.
  *    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 banners in
  *    your own code.
@@ -2171,7 +2420,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.6/service-worker.js');
+ * self.importScripts('https://js.appboycdn.com/web-sdk/6.7/service-worker.js');
  * ```
  *
  * For more details, see [Our Product Documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/integration).
@@ -2432,7 +2681,6 @@ export function logFeatureFlagImpression(
 
 /**
  * Requests banners by a list of placement IDs from the Braze backend.
- * Note that this method can only be called once per session.
  *
  * @param placementIds - A list of placement IDs for banners.
  * @param successCallback - Callback that is invoked when the banners refresh request has been successfully completed.
@@ -2594,7 +2842,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.6/service-worker.js');` or by including the content
+   *   `self.importScripts('https://js.appboycdn.com/web-sdk/6.7/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.6.0",
+  "version": "6.7.1",
   "description": "Braze SDK for web sites and other JS platforms.",
   "main": "src/index.js",
   "scripts": {

package/shared-lib/event-types.js

@@ -1,34 +1,35 @@
-const f = {
+const p = {
     CustomEvent: "ce",
     Pr: "p",
-    Sd: "pc",
+    Uc: "pc",
     ev: "ca",
-    Kl: "i",
-    Cl: "ie",
-    Xt: "cci",
-    Zt: "ccic",
-    Lt: "ccc",
-    Qt: "ccd",
-    Sm: "ss",
+    gl: "i",
+    Ya: "ie",
+    ds: "cci",
+    js: "ccic",
+    os: "ccc",
+    cs: "ccd",
+    wm: "ss",
     hm: "se",
-    zn: "si",
-    Sn: "sc",
-    Bn: "sbc",
+    Fn: "si",
+    On: "sc",
+    Xn: "sbc",
     tv: "sfe",
     om: "iec",
-    jd: "lr",
-    yd: "uae",
-    $d: "lcaa",
-    Dd: "lcar",
+    Oc: "lr",
+    Nc: "uae",
+    Kc: "lcaa",
+    Jc: "lcar",
     Zu: "inc",
     Qu: "add",
     Xu: "rem",
     Yu: "set",
     Vu: "ncam",
-    qd: "sgu",
+    Wc: "sgu",
     xo: "ffi",
     ro: "bi",
-    ut: "bc",
+    Dt: "bc",
+    Ft: "bd",
   },
-  Ee = { nv: "content_cards_displayed" };
-export { f as EventTypes, Ee as InternalEventTypes };
+  Qe = { nv: "content_cards_displayed" };
+export { p as EventTypes, Qe as InternalEventTypes };

package/shared-lib/guid.js

@@ -1,5 +1,5 @@
-const P = {
-  se: function () {
+const V = {
+  de: function () {
     if ("undefined" != typeof window && window.crypto) {
       if ("function" == typeof window.crypto.randomUUID)
         return window.crypto.randomUUID();
@@ -26,4 +26,4 @@ const P = {
     return n() + n(!0) + n(!0) + n();
   },
 };
-export default P;
+export default V;