@braze/web-sdk 6.7.1 → 6.9.0

package/src/util/braze-actions.js

@@ -1,5 +1,5 @@
-import { logger as E } from "../../shared-lib/index.js";
-import { getErrorMessage as ai } from "./error-utils.js";
+import { logger as b } from "../../shared-lib/index.js";
+import { getErrorMessage as hi } from "./error-utils.js";
 import { decodeBrazeActions as uo } from "./string-utils.js";
 import {
   BRAZE_ACTION_URI_REGEX as to,
@@ -26,7 +26,7 @@ export const BRAZE_ACTIONS = {
 };
 export const INELIGIBLE_BRAZE_ACTION_URL_ERROR_TYPES = {
   Un: "unknownBrazeAction",
-  Zc: "noPushPrompt",
+  Nc: "noPushPrompt",
 };
 export const ineligibleBrazeActionURLErrorMessage = (t, o) =>
   t === INELIGIBLE_BRAZE_ACTION_URL_ERROR_TYPES.Un
@@ -38,15 +38,15 @@ export function getDecodedBrazeAction(t) {
       r = o ? o[0].length : null,
       n = r ? t.substring(r) : null;
     if (null == r || r > t.length - 1 || !n)
-      return void E.error(
+      return void b.error(
         `Did not find base64 encoded brazeAction in url to process : ${t}`,
       );
     const e = uo(n);
     return e
       ? JSON.parse(e)
-      : void E.error(`Failed to decode base64 encoded brazeAction: ${n}`);
+      : void b.error(`Failed to decode base64 encoded brazeAction: ${n}`);
   } catch (o) {
-    return void E.error(`Failed to process brazeAction URL ${t} : ${ai(o)}`);
+    return void b.error(`Failed to process brazeAction URL ${t} : ${hi(o)}`);
   }
 }
 function po(t, o) {

package/src/util/browser-detector.js

@@ -1,13 +1,13 @@
 import Si from "./client-hints-parser.js";
-import bi from "./user-agent-parser.js";
-import { Browsers as vi, OperatingSystems as so } from "./device-constants.js";
-class yi {
+import vi from "./user-agent-parser.js";
+import { Browsers as yi, OperatingSystems as so } from "./device-constants.js";
+class xi {
   constructor() {
     let t;
     (t =
-      navigator.userAgent.toLowerCase().includes(vi.Sg.toLowerCase()) ||
+      navigator.userAgent.toLowerCase().includes(yi.Sg.toLowerCase()) ||
       !navigator.userAgentData
-        ? bi
+        ? vi
         : Si),
       (this.vg = new t()),
       (this.userAgent = navigator.userAgent),
@@ -23,10 +23,10 @@ class yi {
       i.systemLanguage ||
       ""
     ).toLowerCase()),
-      (this.il = yi.xg(this.userAgent));
+      (this.il = xi.xg(this.userAgent));
   }
-  IS() {
-    return this.browser === vi.Bg;
+  bS() {
+    return this.browser === yi.Bg;
   }
   Aa() {
     return this.OS || null;
@@ -34,14 +34,14 @@ class yi {
   Fa() {
     return this.OS
       ? Promise.resolve(this.OS)
-      : this.vg.Fa(yi.Og).then((t) => ((this.OS = t), t));
+      : this.vg.Fa(xi.Og).then((t) => ((this.OS = t), t));
   }
   static xg(t) {
     t = t.toLowerCase();
     const i = [
       "bot",
+      "spider",
       "slurp",
-      "baiduspider",
       "yandex",
       "facebookexternalhit",
       "sogou",
@@ -63,7 +63,7 @@ class yi {
     return !1;
   }
 }
-yi.Og = [
+xi.Og = [
   { string: navigator.platform, cf: "Win", identity: so.kg },
   { string: navigator.platform, cf: "Mac", identity: so.Pg },
   { string: navigator.platform, cf: "BlackBerry", identity: "BlackBerry" },
@@ -91,5 +91,5 @@ yi.Og = [
   { string: navigator.userAgent, cf: ["Android"], identity: so.Dg },
   { string: navigator.platform, cf: "Linux", identity: "Linux" },
 ];
-const ro = new yi();
-export { ro as default, yi as BrowserDetector };
+const ro = new xi();
+export { ro as default, xi as BrowserDetector };

package/src/util/client-hints-parser.js

@@ -1,5 +1,5 @@
 import Ve from "./base-device-parser.js";
-import { Browsers as vi } from "./device-constants.js";
+import { Browsers as yi } from "./device-constants.js";
 export default class Si extends Ve {
   constructor() {
     if (
@@ -9,7 +9,7 @@ export default class Si extends Ve {
       (this.version = null),
       this.userAgentData)
     ) {
-      const t = this.hf();
+      const t = this.Bc();
       (this.browser = t.browser || "Unknown Browser"),
         (this.version = t.version || "Unknown Version");
     }
@@ -36,12 +36,12 @@ export default class Si extends Ve {
           .then((t) => (t.platform ? s(t.platform) : navigator.platform))
           .catch(() => navigator.platform);
   }
-  hf() {
+  Bc() {
     const t = {},
       s = this.userAgentData.brands;
     if (s && s.length)
       for (const r of s) {
-        const s = this.uf(vi),
+        const s = this.Vc(yi),
           i = r.brand.match(s);
         if (i && i.length > 0) {
           (t.browser = i[0]), (t.version = r.version);
@@ -50,7 +50,7 @@ export default class Si extends Ve {
       }
     return t;
   }
-  uf(t) {
+  Vc(t) {
     const s = [];
     for (const r in t) {
       const i = r;

package/src/util/code-utils.js

@@ -1,4 +1,4 @@
-import { logger as E } from "../../shared-lib/index.js";
+import { logger as b } from "../../shared-lib/index.js";
 export function values(t) {
   const e = [];
   let r;
@@ -13,7 +13,7 @@ export function validateValueIsFromEnum(t, e, r, n) {
   const o = values(t);
   return (
     -1 !== o.indexOf(e) ||
-    (E.error(`${r} Valid values from ${n} are "${o.join('"/"')}".`), !1)
+    (b.error(`${r} Valid values from ${n} are "${o.join('"/"')}".`), !1)
   );
 }
 export function isArray(t) {

package/src/util/deprecation-utils.js

@@ -1,5 +1,5 @@
-import { logger as E } from "../../shared-lib/index.js";
+import { logger as b } from "../../shared-lib/index.js";
 export function logDeprecationWarning(e, i, n) {
   let r = `The '${e}' ${i} is deprecated.`;
-  n && (r += ` Please use '${n}' instead.`), E.warn(r);
+  n && (r += ` Please use '${n}' instead.`), b.warn(r);
 }

package/src/util/dom-utils.js

@@ -1,5 +1,5 @@
-import { logger as E } from "../../shared-lib/index.js";
-import { getErrorMessage as ai } from "./error-utils.js";
+import { logger as b } from "../../shared-lib/index.js";
+import { getErrorMessage as hi } from "./error-utils.js";
 export function _isInView(t, n = !1, e = !1, s = !1) {
   if (null == t) return !1;
   (n = n || !1), (e = e || !1);
@@ -18,24 +18,24 @@ export function _isInView(t, n = !1, e = !1, s = !1) {
       !s)
   );
 }
-export const DOMUtils = { lp: null, td: _isInView };
+export const DOMUtils = { Ic: null, td: _isInView };
 export const DIRECTIONS = { Uo: "up", Vo: "down", ie: "left", ne: "right" };
 export function supportsPassive() {
-  if (null == DOMUtils.lp) {
-    DOMUtils.lp = !1;
+  if (null == DOMUtils.Ic) {
+    DOMUtils.Ic = !1;
     try {
       const t = Object.defineProperty({}, "passive", {
         get: () => {
-          DOMUtils.lp = !0;
+          DOMUtils.Ic = !0;
         },
       });
       window.addEventListener("testPassive", () => {}, t),
         window.removeEventListener("testPassive", () => {}, t);
     } catch (t) {
-      E.error(ai(t));
+      b.error(hi(t));
     }
   }
-  return DOMUtils.lp;
+  return DOMUtils.Ic;
 }
 export function addPassiveEventListener(t, n, e = () => {}) {
   t.addEventListener(n, e, !!supportsPassive() && { passive: !0 });

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

@@ -0,0 +1,343 @@
+import { logger as b } 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 b.error(`Cannot ${ln} because ${t} must be a non-empty string.`), !1;
+  }
+  return "string" != typeof n || (e && n.length <= 0)
+    ? (b.error(
+        `Cannot ${ln} because ${t} must be a string${
+          e ? "" : " when provided"
+        }.`,
+      ),
+      !1)
+    : n.length > 255
+    ? (b.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)
+    ? (b.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 ? (b.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
+    ? (b.error(
+        `Cannot ${ln} because each ${t} key must be between 1 and 255 characters.`,
+      ),
+      !1)
+    : "$" === n.charAt(0)
+    ? (b.error(`Cannot ${ln} because ${t} keys cannot begin with "$".`), !1)
+    : !!bn.test(n) ||
+      (b.error(
+        `Cannot ${ln} because ${t} key "${n}" contains invalid characters.`,
+      ),
+      !1);
+}
+function $n(n, t, e) {
+  if (e > 50)
+    return b.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 (
+            b.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 (
+          b.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 (
+      b.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 (
+      b.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
+        ? (b.error(`Cannot ${ln} because product quantity must be an integer.`),
+          !1)
+        : n < 0 || n > Number.MAX_SAFE_INTEGER
+        ? (b.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 b.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 hn(n) {
+  const t = (function (n) {
+      if (null == n || "string" != typeof n || n.length <= 0)
+        return (
+          b.error(`Cannot ${ln} because currency must be a non-empty string.`),
+          !1
+        );
+      const t = n.toUpperCase();
+      return or(t)
+        ? t
+        : (b.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 jn(n, t) {
+  const e = ["subtotal_value", "tax", "shipping"];
+  for (const r of e)
+    if (null != t[r]) {
+      const e = pn(t[r], r);
+      if (!1 === e) return !1;
+      n[r] = e;
+    }
+  return !0;
+}
+function wn(n, t) {
+  const e = yn(t, "eCommerce event metadata");
+  return !1 !== e && (null != e && (n.metadata = e), !0);
+}
+function kn(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.Ld || r === un.Md,
+    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),
+    jn(a, n) && wn(a, n.metadata) ? a : null
+  );
+}
+export function sanitizeEcommerceEvent(n) {
+  const t = n.properties;
+  if (null == t || "object" != typeof t || g(t))
+    return b.error(`${R.QE} requires a properties object.`), null;
+  const e = t,
+    r = hn(e);
+  if (null == r) return null;
+  switch (n.name) {
+    case "ecommerce.product_viewed":
+      return (function (n, t) {
+        const e = n.metadata;
+        if (void 0 !== n.type && !vn(n.type, "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),
+          void 0 !== n.type && (s.type = n.type),
+          wn(s, e) ? s : null
+        );
+      })(e, r);
+    case "ecommerce.cart_updated":
+      return kn(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), jn(c, n) && wn(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) {
+          if (!g(n.discounts))
+            return (
+              b.error(`Cannot ${ln} because discounts must be an array.`), null
+            );
+          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 jn(i, n) && wn(i, n.metadata) ? i : null;
+      })(e, r);
+    default:
+      return (
+        b.error(
+          "logEcommerceEvent received an unknown event name. Ignoring event.",
+        ),
+        null
+      );
+  }
+}

package/src/util/html-display-utils.js

@@ -1,8 +1,8 @@
-import { logger as E } from "../../shared-lib/index.js";
+import { logger as b } from "../../shared-lib/index.js";
 import { getUser as ao } from "../Core/get-user.js";
 import { CoreStrings as R } from "../common/constants.js";
 import r from "../managers/braze-instance.js";
-import { keys as D } from "../util/code-utils.js";
+import { keys as C } from "../util/code-utils.js";
 import User from "../User/user.js";
 export const buildBrazeBridge = (t, e) => {
   const o = { display: {}, web: {} },
@@ -12,7 +12,7 @@ export const buildBrazeBridge = (t, e) => {
         import("../Push/request-push-permission.js").then((e) => {
           r.ao()
             ? e.requestPushPermission(...Array.prototype.slice.call(t))
-            : E.error(R.ee);
+            : b.error(R.ee);
         });
       };
     },
@@ -23,7 +23,7 @@ export const buildBrazeBridge = (t, e) => {
           ({ requestImmediateDataFlush: requestImmediateDataFlush }) => {
             r.ao()
               ? requestImmediateDataFlush(...Array.prototype.slice.call(t))
-              : E.error(R.ee);
+              : b.error(R.ee);
           },
         );
       },
@@ -31,7 +31,7 @@ export const buildBrazeBridge = (t, e) => {
         const t = arguments;
         import("../Core/log-custom-event.js").then(
           ({ logCustomEvent: logCustomEvent }) => {
-            if (!r.ao()) return void E.error(R.ee);
+            if (!r.ao()) return void b.error(R.ee);
             logCustomEvent(...Array.prototype.slice.call(t));
           },
         );
@@ -40,7 +40,7 @@ export const buildBrazeBridge = (t, e) => {
         const t = arguments;
         import("../Core/log-purchase.js").then(
           ({ logPurchase: logPurchase }) => {
-            if (!r.ao()) return void E.error(R.ee);
+            if (!r.ao()) return void b.error(R.ee);
             logPurchase(...Array.prototype.slice.call(t));
           },
         );
@@ -51,7 +51,7 @@ export const buildBrazeBridge = (t, e) => {
           ({ unregisterPush: unregisterPush }) => {
             r.ao()
               ? unregisterPush(...Array.prototype.slice.call(t))
-              : E.error(R.ee);
+              : b.error(R.ee);
           },
         );
       },
@@ -59,7 +59,7 @@ export const buildBrazeBridge = (t, e) => {
       changeUser: function () {
         const t = arguments;
         import("../Core/change-user.js").then(({ changeUser: changeUser }) => {
-          if (!r.ao()) return void E.error(R.ee);
+          if (!r.ao()) return void b.error(R.ee);
           changeUser(...Array.prototype.slice.call(t));
         });
       },
@@ -69,7 +69,7 @@ export const buildBrazeBridge = (t, e) => {
         n[t](...Array.prototype.slice.call(arguments));
       };
     };
-  for (const t of D(n)) o[t] = s(t);
+  for (const t of C(n)) o[t] = s(t);
   const i = [
       "setFirstName",
       "setLastName",
@@ -115,7 +115,7 @@ export const buildBrazeBridge = (t, e) => {
       };
     },
     f = o.display;
-  for (const t of D(a)) f[t] = m(t);
+  for (const t of C(a)) f[t] = m(t);
   const l = { registerAppboyPushMessages: requestPushPermission() },
     p = function (t) {
       return function () {
@@ -123,7 +123,7 @@ export const buildBrazeBridge = (t, e) => {
       };
     },
     y = o.web;
-  for (const t of D(l)) y[t] = p(t);
+  for (const t of C(l)) y[t] = p(t);
   return (
     (o.NotificationSubscriptionTypes = User.NotificationSubscriptionTypes), o
   );