@braze/web-sdk 6.7.0 → 6.8.0

package/src/util/ecommerce-event-validation.js

@@ -0,0 +1,326 @@
+import { logger as E } from "../../shared-lib/index.js";
+import { isValidIso4217CurrencyCode as or } from "./iso-4217-currency-codes.js";
+import { CoreStrings as R } from "../common/constants.js";
+import { CartUpdatedActions as un } from "../types.js";
+import {
+  isArray as g,
+  isObject as Ct,
+  validateValueIsFromEnum as ta,
+} from "./code-utils.js";
+import {
+  validateCustomProperties as nt,
+  validateCustomString as mt,
+} from "./validation-utils.js";
+const ln = "log eCommerce event";
+function dn(n, t, e) {
+  if (null == n) {
+    if (!e) return;
+    return E.error(`Cannot ${ln} because ${t} must be a non-empty string.`), !1;
+  }
+  return "string" != typeof n || (e && n.length <= 0)
+    ? (E.error(
+        `Cannot ${ln} because ${t} must be a string${
+          e ? "" : " when provided"
+        }.`,
+      ),
+      !1)
+    : n.length > 255
+    ? (E.error(`Cannot ${ln} because ${t} must be at most 255 characters.`), !1)
+    : !!mt(n, ln, t) && n;
+}
+function mn(n, t) {
+  return "number" != typeof n || isNaN(n) || !isFinite(n)
+    ? (E.error(`Cannot ${ln} because ${t} must be a finite number.`), !1)
+    : n;
+}
+function pn(n, t) {
+  const e = mn(n, t);
+  return (
+    !1 !== e &&
+    (e < 0 ? (E.error(`Cannot ${ln} because ${t} must be at least 0.`), !1) : e)
+  );
+}
+const bn = /^[A-Za-z0-9\-_.,:;!?@#%&*()+={}[\]|\\/'`~^<>]+$/;
+function _n(n, t) {
+  return 0 === n.length || n.length > 255
+    ? (E.error(
+        `Cannot ${ln} because each ${t} key must be between 1 and 255 characters.`,
+      ),
+      !1)
+    : "$" === n.charAt(0)
+    ? (E.error(`Cannot ${ln} because ${t} keys cannot begin with "$".`), !1)
+    : !!bn.test(n) ||
+      (E.error(
+        `Cannot ${ln} because ${t} key "${n}" contains invalid characters.`,
+      ),
+      !1);
+}
+function $n(n, t, e) {
+  if (e > 50)
+    return E.error(`Cannot ${ln} because ${t} is nested too deeply.`), !1;
+  if (null == n || "object" != typeof n) return !0;
+  if (g(n)) {
+    const r = n;
+    for (let n = 0; n < r.length; n++) {
+      const u = r[n];
+      if ("string" == typeof u) {
+        if (u.length > 255)
+          return (
+            E.error(
+              `Cannot ${ln} because a ${t} string value exceeds 255 characters.`,
+            ),
+            !1
+          );
+      } else if (!$n(u, t, e + 1)) return !1;
+    }
+    return !0;
+  }
+  if (!Ct(n)) return !0;
+  const r = n;
+  for (const n in r) {
+    if (!Object.prototype.hasOwnProperty.call(r, n)) continue;
+    if (!_n(n, t)) return !1;
+    const u = r[n];
+    if ("string" == typeof u) {
+      if (u.length > 255)
+        return (
+          E.error(
+            `Cannot ${ln} because a ${t} string value exceeds 255 characters.`,
+          ),
+          !1
+        );
+    } else if (null != u && "object" == typeof u && !$n(u, t, e + 1)) return !1;
+  }
+  return !0;
+}
+function vn(n, t) {
+  if (!g(n))
+    return (
+      E.error(`Cannot ${ln} because ${t} must be an array of strings.`), !1
+    );
+  for (const e of n) if (!1 === dn(e, t, !0)) return !1;
+  return !0;
+}
+function yn(n, t) {
+  if (void 0 === n) return;
+  const [e, r] = nt(null != n ? n : {}, R.QE, "metadata", ln, t);
+  return !!e && !(null != r && !$n(r, t, 0)) && r;
+}
+function gn(n) {
+  if (null == n || "object" != typeof n || g(n))
+    return (
+      E.error(`Cannot ${ln} because each product must be an object.`), null
+    );
+  const t = n,
+    e = dn(t.product_id, "product_id", !0),
+    r = dn(t.product_name, "product_name", !0),
+    u = dn(t.variant_id, "variant_id", !0),
+    o = (function (n) {
+      if (!1 === mn(n, "product quantity")) return !1;
+      const t = parseInt(n.toString(), 10);
+      return t !== n
+        ? (E.error(`Cannot ${ln} because product quantity must be an integer.`),
+          !1)
+        : n < 0 || n > Number.MAX_SAFE_INTEGER
+        ? (E.error(
+            `Cannot ${ln} because product quantity must be between 0 and Number.MAX_SAFE_INTEGER.`,
+          ),
+          !1)
+        : t;
+    })(t.quantity),
+    c = pn(t.price, "product price");
+  if (!1 === e || !1 === r || !1 === u || !1 === o || !1 === c) return null;
+  const i = dn(t.image_url, "image_url", !1),
+    a = dn(t.product_url, "product_url", !1);
+  if (!1 === i || !1 === a) return null;
+  const s = yn(t.metadata, "eCommerce product metadata");
+  if (!1 === s) return null;
+  const l = {
+    product_id: e,
+    product_name: r,
+    variant_id: u,
+    quantity: o,
+    price: c,
+  };
+  return (
+    null != i && (l.image_url = i),
+    null != a && (l.product_url = a),
+    null != s && (l.metadata = s),
+    l
+  );
+}
+function Cn(n) {
+  if (null == n || !g(n))
+    return E.error(`Cannot ${ln} because products must be an array.`), null;
+  const t = [],
+    e = n;
+  for (const n of e) {
+    const e = gn(n);
+    if (null == e) return null;
+    t.push(e);
+  }
+  return t;
+}
+function jn(n) {
+  const t = (function (n) {
+      if (null == n || "string" != typeof n || n.length <= 0)
+        return (
+          E.error(`Cannot ${ln} because currency must be a non-empty string.`),
+          !1
+        );
+      const t = n.toUpperCase();
+      return or(t)
+        ? t
+        : (E.error(
+            `${R.QE} requires a valid ISO 4217 currency code, got "${n}". Ignoring event.`,
+          ),
+          !1);
+    })(n.currency),
+    e = dn(n.source, "source", !0);
+  return !1 === t || !1 === e ? null : { currency: t, source: e };
+}
+function hn(n, t) {
+  const e = yn(t, "eCommerce event metadata");
+  return !1 !== e && (null != e && (n.metadata = e), !0);
+}
+function wn(n, t) {
+  const e = dn(n.cart_id, "cart_id", !0),
+    r =
+      void 0 === n.action
+        ? un.REPLACE
+        : ((u = n.action),
+          !!ta(
+            un,
+            u,
+            `Cannot ${ln} because action is invalid.`,
+            "CartUpdatedActions",
+          ) && u);
+  var u;
+  const o = Cn(n.products);
+  if (!1 === e || !1 === r || null == o) return null;
+  const c = r === un.Ed || r === un.Ad,
+    i =
+      void 0 === n.total_value && c ? void 0 : pn(n.total_value, "total_value");
+  if (!1 === i) return null;
+  const a = {
+    cart_id: e,
+    action: r,
+    currency: t.currency,
+    products: o,
+    source: t.source,
+  };
+  return void 0 !== i && (a.total_value = i), hn(a, n.metadata) ? a : null;
+}
+export function sanitizeEcommerceEvent(n) {
+  const t = n.properties;
+  if (null == t || "object" != typeof t || g(t))
+    return E.error(`${R.QE} requires a properties object.`), null;
+  const e = t,
+    r = jn(e);
+  if (null == r) return null;
+  switch (n.name) {
+    case "ecommerce.product_viewed":
+      return (function (n, t) {
+        const e = n.metadata;
+        if (null != e && "object" == typeof e && !g(e)) {
+          const n = e;
+          if (void 0 !== n.type && !vn(n.type, "metadata.type")) return null;
+        }
+        const r = dn(n.product_id, "product_id", !0),
+          u = dn(n.product_name, "product_name", !0),
+          o = dn(n.variant_id, "variant_id", !0),
+          c = pn(n.price, "price"),
+          i = dn(n.image_url, "image_url", !1),
+          a = dn(n.product_url, "product_url", !1);
+        if (
+          !1 === r ||
+          !1 === u ||
+          !1 === o ||
+          !1 === c ||
+          !1 === i ||
+          !1 === a
+        )
+          return null;
+        const s = {
+          product_id: r,
+          product_name: u,
+          variant_id: o,
+          price: c,
+          currency: t.currency,
+          source: t.source,
+        };
+        return (
+          null != i && (s.image_url = i),
+          null != a && (s.product_url = a),
+          hn(s, e) ? s : null
+        );
+      })(e, r);
+    case "ecommerce.cart_updated":
+      return wn(e, r);
+    case "ecommerce.checkout_started":
+      return (function (n, t) {
+        const e = dn(n.checkout_id, "checkout_id", !0),
+          r = pn(n.total_value, "total_value"),
+          u = Cn(n.products),
+          o = dn(n.cart_id, "cart_id", !1);
+        if (!1 === e || !1 === r || null == u || !1 === o) return null;
+        const c = {
+          checkout_id: e,
+          total_value: r,
+          currency: t.currency,
+          products: u,
+          source: t.source,
+        };
+        return null != o && (c.cart_id = o), hn(c, n.metadata) ? c : null;
+      })(e, r);
+    case "ecommerce.order_placed":
+      return (function (n, t) {
+        const e = n.metadata;
+        if (null != e && "object" == typeof e && !g(e)) {
+          const n = e;
+          if (void 0 !== n.tags && !vn(n.tags, "metadata.tags")) return null;
+          if (
+            void 0 !== n.payment_gateway_names &&
+            !vn(n.payment_gateway_names, "metadata.payment_gateway_names")
+          )
+            return null;
+        }
+        const r = dn(n.order_id, "order_id", !0),
+          u = pn(n.total_value, "total_value"),
+          o = Cn(n.products),
+          c = dn(n.cart_id, "cart_id", !1);
+        if (!1 === r || !1 === u || null == o || !1 === c) return null;
+        const i = {
+          order_id: r,
+          total_value: u,
+          currency: t.currency,
+          products: o,
+          source: t.source,
+        };
+        if ((null != c && (i.cart_id = c), null != n.total_discounts)) {
+          const t = pn(n.total_discounts, "total_discounts");
+          if (!1 === t) return null;
+          i.total_discounts = t;
+        }
+        if (void 0 !== n.discounts) {
+          const [t, e] = nt(
+            { discounts: n.discounts },
+            R.QE,
+            "discounts",
+            ln,
+            "eCommerce order discounts",
+          );
+          if (!t || null == e) return null;
+          i.discounts = e.discounts;
+        }
+        return hn(i, n.metadata) ? i : null;
+      })(e, r);
+    default:
+      return (
+        E.error(
+          "logEcommerceEvent received an unknown event name. Ignoring event.",
+        ),
+        null
+      );
+  }
+}

package/src/util/iso-4217-currency-codes.js

@@ -0,0 +1,176 @@
+const DD = [
+  "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",
+  "ZWL",
+];
+export function isValidIso4217CurrencyCode(D) {
+  return -1 !== DD.indexOf(D);
+}

package/src/util/net.js

@@ -1,6 +1,6 @@
 import { logger as E } from "../../shared-lib/index.js";
 import Ne from "../models/backend-errors.js";
-import { getErrorMessage as ai } from "./error-utils.js";
+import { getErrorMessage as hi } from "./error-utils.js";
 const l = {
   ot: (t) => {
     let e, o;
@@ -27,7 +27,7 @@ const l = {
               o = JSON.parse(e.responseText);
             } catch (o) {
               const n = {
-                error: "" === e.responseText ? Ne.Wa : Ne.Qa,
+                error: "" === e.responseText ? Ne.Qa : Ne.Za,
                 response: e.responseText,
               };
               (0, t.lt)(n, r);
@@ -51,7 +51,7 @@ const l = {
       for (const t of i) e.setRequestHeader(t[0], t[1]);
       e.send(o);
     } catch (t) {
-      E.error(`Network request error: ${ai(t)}`);
+      E.error(`Network request error: ${hi(t)}`);
     }
   },
 };

package/src/util/request-header-utils.js

@@ -1,51 +1,51 @@
-import { REQUEST_ATTEMPT_DEFAULT as Ge } from "../common/constants.js";
+import { REQUEST_ATTEMPT_DEFAULT as Qe } from "../common/constants.js";
 import { STORAGE_KEYS as s } from "../managers/storage-manager.js";
 const h = {
   it: {
-    pn: "data",
+    wn: "data",
     Ji: "content_cards/sync",
     Co: "feature_flags/sync",
-    Yo: "template",
+    ta: "template",
     st: "banners/sync",
   },
-  Pl: (t) => (null == t ? void 0 : t.Rt(s.Tt.iS)),
-  Am: (t) => (null == t ? void 0 : t.Rt(s.Tt.ES)),
+  xl: (t) => (null == t ? void 0 : t.Rt(s.Tt.ES)),
+  Am: (t) => (null == t ? void 0 : t.Rt(s.Tt.SS)),
   Rm: (t, e) => {
-    null == t || t.It(s.Tt.iS, e);
+    null == t || t.It(s.Tt.ES, e);
   },
   qm: (t, e) => {
-    null == t || t.It(s.Tt.ES, e);
+    null == t || t.It(s.Tt.SS, e);
   },
-  ql: (t, e) => {
+  Dl: (t, e) => {
     if (!t || !e) return -1;
-    const s = h.Pl(t);
+    const s = h.xl(t);
     if (null == s) return -1;
     const n = s[e];
     return null == n || isNaN(n) ? -1 : n;
   },
-  Al: (t, e) => {
-    let s = Ge;
+  kl: (t, e) => {
+    let s = Qe;
     if (!t || !e) return s;
     const n = h.Am(t);
-    return null == n ? s : ((s = n[e]), null == s || isNaN(s) ? Ge : s);
+    return null == n ? s : ((s = n[e]), null == s || isNaN(s) ? Qe : s);
   },
   nt: (t, e, s) => {
     if (!t || !e) return;
-    let n = h.Pl(t);
+    let n = h.xl(t);
     null == n && (n = {}), (n[e] = s), h.Rm(t, n);
   },
-  Dl: (t, e, s) => {
+  yl: (t, e, s) => {
     if (!t || !e) return;
     let n = h.Am(t);
     null == n && (n = {}), (n[e] = s), h.qm(t, n);
   },
   Li: (t, e) => {
-    t && e && h.Dl(t, e, Ge);
+    t && e && h.yl(t, e, Qe);
   },
-  zl: (t, e) => {
+  Ml: (t, e) => {
     if (!t || !e) return;
-    const s = h.Al(t, e);
-    h.Dl(t, e, s + 1);
+    const s = h.kl(t, e);
+    h.yl(t, e, s + 1);
   },
 };
 export default h;

package/src/util/user-agent-parser.js

@@ -1,8 +1,8 @@
 import Ve from "./base-device-parser.js";
-import { Browsers as vi, OperatingSystems as so } from "./device-constants.js";
-export default class bi extends Ve {
+import { Browsers as yi, OperatingSystems as so } from "./device-constants.js";
+export default class vi extends Ve {
   constructor() {
-    super(), (this.Sd = bi.hf(navigator.userAgent || ""));
+    super(), (this.Sd = vi.hf(navigator.userAgent || ""));
   }
   ef() {
     return this.Sd[0] || "Unknown Browser";
@@ -13,7 +13,7 @@ export default class bi extends Ve {
   Fa(r) {
     for (let n = 0; n < r.length; n++) {
       const e = r[n].string;
-      let i = bi.nf(e, r[n]);
+      let i = vi.nf(e, r[n]);
       if (i)
         return (
           i === so.Pg && navigator.maxTouchPoints > 1 && (i = so.co),
@@ -40,40 +40,40 @@ export default class bi extends Ve {
     if (-1 !== r.indexOf("PhilipsTV")) return ["Philips Smart TV", null];
     if (r.match(/\b(Roku)\b/)) return ["Roku", null];
     if (r.match(/\bAFTM\b/)) return ["Amazon Fire Stick", null];
-    if (e[1] === vi.rO) {
-      if (r.includes(vi.Sg)) return [vi.Sg, e[2]];
+    if (e[1] === yi.rO) {
+      if (r.includes(yi.Sg)) return [yi.Sg, e[2]];
       if (
         ((n = r.match(/\b(OPR|Edge|EdgA|Edg|UCBrowser)\/(\.?\d+(\.\d+)*)/)),
         null != n)
       )
         return (
           (n = n.slice(1)),
-          (n[0] = n[0].replace("OPR", vi.oO)),
-          (n[0] = n[0].replace("EdgA", vi.eO)),
-          "Edg" === n[0] && (n[0] = vi.eO),
+          (n[0] = n[0].replace("OPR", yi.oO)),
+          (n[0] = n[0].replace("EdgA", yi.eO)),
+          "Edg" === n[0] && (n[0] = yi.eO),
           [n[0], n[1]]
         );
     }
     if (
-      e[1] === vi.Bg &&
+      e[1] === yi.Bg &&
       ((n = r.match(/\b(EdgiOS)\/(\.?\d+(\.\d+)*)/)), null != n)
     )
       return (
-        (n = n.slice(1)), (n[0] = n[0].replace("EdgiOS", vi.eO)), [n[0], n[1]]
+        (n = n.slice(1)), (n[0] = n[0].replace("EdgiOS", yi.eO)), [n[0], n[1]]
       );
     if (
       ((e = e[2] ? [e[1], e[2]] : [null, null]),
-      e[0] === vi.Bg &&
+      e[0] === yi.Bg &&
         null != (n = r.match(/version\/(\.?\d+(\.\d+)*)/i)) &&
         e.splice(1, 1, n[1]),
       null != (n = r.match(/\b(UCBrowser)\/(\.?\d+(\.\d+)*)/)) &&
         e.splice(1, 1, n[2]),
-      e[0] === vi.oO && null != (n = r.match(/mini\/(\.?\d+(\.\d+)*)/i)))
+      e[0] === yi.oO && null != (n = r.match(/mini\/(\.?\d+(\.\d+)*)/i)))
     )
       return ["Opera Mini", n[1] || ""];
     if (e[0]) {
       const r = e[0].toLowerCase();
-      "crios" === r && (e[0] = vi.rO),
+      "crios" === r && (e[0] = yi.rO),
         "tizen" === r && ((e[0] = "Samsung Smart TV"), (e[1] = null)),
         "samsungbrowser" === r && (e[0] = "Samsung Browser");
     }

package/src/util/validation-utils.js

@@ -4,7 +4,7 @@ import {
   isObject as Ct,
   keys as D,
 } from "./code-utils.js";
-import { getByteLength as ir } from "./string-utils.js";
+import { getByteLength as er } from "./string-utils.js";
 import { logger as E } from "../../shared-lib/index.js";
 import { toValidBackendTimeString as $t } from "./date-utils.js";
 import { BRAZE_ACTIONS as oo } from "./braze-actions.js";
@@ -102,7 +102,7 @@ export function validateCustomProperties(t, e, r, n, o) {
   let i, a;
   e === R.Ku ? ((i = 76800), (a = "75KB")) : ((i = 51200), (a = "50KB"));
   const s = JSON.stringify(t);
-  if (ir(s) > i)
+  if (er(s) > i)
     return (
       E.error(
         `Could not ${n} because ${r} was greater than the max size of ${a}.`,

package/src/util/window-utils.js

@@ -28,7 +28,7 @@ export function _getCurrentUrl() {
 }
 export const WindowUtils = {
   openUri: _openUri,
-  da: _isPhone,
-  ga: _getOrientation,
+  ja: _isPhone,
+  ba: _getOrientation,
   Qh: _getCurrentUrl,
 };