@braze/web-sdk 6.12.0 → 6.13.0

package/shared-lib/logger.js

@@ -3,11 +3,11 @@ const b = {
     (void 0 === n && void 0 !== b.zg) || (b.zg = !!n), b.i || (b.i = !0);
   },
   destroy: function () {
-    (b.i = !1), (b.zg = void 0), (b.Bd = void 0);
+    (b.i = !1), (b.zg = void 0), (b.df = void 0);
   },
   setLogger: function (n) {
     "function" == typeof n
-      ? (b.init(), (b.Bd = n))
+      ? (b.init(), (b.df = n))
       : b.info("Ignoring setLogger call since logger is not a function");
   },
   toggleLogging: function () {
@@ -19,19 +19,19 @@ const b = {
   info: function (n) {
     if (b.zg) {
       const o = "Braze: " + n;
-      null != b.Bd ? b.Bd(o) : console.log(o);
+      null != b.df ? b.df(o) : console.log(o);
     }
   },
   warn: function (n) {
     if (b.zg) {
-      const o = "Braze SDK Warning: " + n + " (v6.12.0)";
-      null != b.Bd ? b.Bd(o) : console.warn(o);
+      const o = "Braze SDK Warning: " + n + " (v6.13.0)";
+      null != b.df ? b.df(o) : console.warn(o);
     }
   },
   error: function (n) {
     if (b.zg) {
-      const o = "Braze SDK Error: " + n + " (v6.12.0)";
-      null != b.Bd ? b.Bd(o) : console.error(o);
+      const o = "Braze SDK Error: " + n + " (v6.13.0)";
+      null != b.df ? b.df(o) : console.error(o);
     }
   },
 };

package/shared-lib/supported-options.js

@@ -1,29 +1,30 @@
 export default {
-  _h: "allowCrawlerActivity",
-  Nh: "baseUrl",
-  se: "cookieExpiryInDays",
-  Oh: "noCookies",
-  Th: "devicePropertyAllowlist",
-  xa: "disablePushTokenMaintenance",
-  Rh: "enableLogging",
-  Ph: "enableSdkAuthentication",
-  wa: "manageServiceWorkerExternally",
-  Dh: "minimumIntervalBetweenTriggerActionsInSeconds",
-  Lh: "sessionTimeoutInSeconds",
-  yh: "appVersion",
-  Mh: "appVersionNumber",
-  za: "serviceWorkerLocation",
-  ha: "safariWebsitePushId",
-  Ma: "localization",
+  hl: "allowCrawlerActivity",
+  cl: "baseUrl",
+  xe: "cookieExpiryInDays",
+  ml: "noCookies",
+  fl: "devicePropertyAllowlist",
+  Oa: "disablePushTokenMaintenance",
+  El: "enableLogging",
+  Il: "enableSdkAuthentication",
+  Na: "manageServiceWorkerExternally",
+  _l: "minimumIntervalBetweenTriggerActionsInSeconds",
+  gl: "sessionTimeoutInSeconds",
+  Sl: "appVersion",
+  Al: "appVersionNumber",
+  Ha: "serviceWorkerLocation",
+  La: "safariWebsitePushId",
+  al: "localization",
   sr: "contentSecurityNonce",
   nr: "allowUserSuppliedJavascript",
-  ca: "inAppMessageZIndex",
-  da: "openInAppMessagesInNewTab",
-  lh: "requireExplicitInAppMessageDismissal",
-  Uh: "doNotLoadFontAwesome",
-  Wh: "deviceId",
-  ba: "serviceWorkerScope",
-  Oi: "dustHost",
-  Bh: "sdkFlavor",
+  Ee: "inAppMessageZIndex",
+  Te: "conversationalChatZIndex",
+  Ja: "openInAppMessagesInNewTab",
+  Zh: "requireExplicitInAppMessageDismissal",
+  vl: "doNotLoadFontAwesome",
+  Nl: "deviceId",
+  Ka: "serviceWorkerScope",
+  _e: "dustHost",
+  Ol: "sdkFlavor",
   tn: "openCardsInNewTab",
 };

package/src/ConversationalChat/automatically-manage-chat.js

@@ -0,0 +1,5 @@
+import r from "../managers/braze-instance.js";
+import aa from "./conversational-chat-provider-factory.js";
+export function automaticallyManageChat() {
+  r.rr() && aa.o().automaticallyManageChat();
+}

package/src/ConversationalChat/chat-message-factory.js

@@ -0,0 +1,25 @@
+import ChatMessage from "./chat-message.js";
+export function newChatMessageFromJson(e) {
+  return new ChatMessage(
+    "assistant",
+    e.session_id,
+    e.message.id,
+    e.actions || [],
+    e.message,
+    e.event_type,
+  );
+}
+export function newUserChatMessage(e, n, t) {
+  return new ChatMessage("user", e, n, [], void 0, void 0, t);
+}
+export function newChatActionEvent(e) {
+  const n = e.type;
+  return "end_conversation" === n || "error" === n
+    ? { type: n, data: e.data }
+    : "user_action" === n && null != e.name
+    ? { type: n, name: e.name, data: e.data }
+    : null;
+}
+export function newChatMessageFromSerializedValue(e) {
+  return new ChatMessage(e.r, e.sid, e.id, e.a || [], e.m, e.et, e.um);
+}

package/src/ConversationalChat/chat-message.js

@@ -0,0 +1,33 @@
+export default class ChatMessage {
+  constructor(t, s, i, h = [], r, e, o) {
+    (this.role = t),
+      (this.sessionId = s),
+      (this.messageId = i),
+      (this.actions = h),
+      (this.message = r),
+      (this.eventType = e),
+      (this.userMessage = o),
+      (this.role = t),
+      (this.sessionId = s),
+      (this.messageId = i),
+      (this.actions = h),
+      (this.message = r),
+      (this.eventType = e),
+      (this.userMessage = o);
+  }
+  Gi(t) {
+    for (const s of this.actions) if (s && s.type === t) return !0;
+    return !1;
+  }
+  qt() {
+    return {
+      r: this.role,
+      sid: this.sessionId,
+      id: this.messageId,
+      m: this.message,
+      et: this.eventType,
+      um: this.userMessage,
+      a: this.actions,
+    };
+  }
+}

package/src/ConversationalChat/constants.js

@@ -0,0 +1 @@
+export const CHAT_BRAZE_ACTION_TYPE = "triggerChatAction";

package/src/ConversationalChat/conversational-chat-provider-factory.js

@@ -0,0 +1,26 @@
+import r from "../managers/braze-instance.js";
+import tr from "./conversational-chat-provider.js";
+import { registerChatActionHandler as er } from "./register-chat-action-handler.js";
+const aa = {
+    i: !1,
+    provider: null,
+    o: () => (
+      aa.t(),
+      aa.provider ||
+        ((aa.provider = new tr(r.m(), r.l(), r.p())), r.v(aa.provider)),
+      aa.provider
+    ),
+    t: () => {
+      aa.i || (r.g(aa), (aa.i = !0));
+    },
+    destroy: () => {
+      (aa.provider = null), (aa.i = !1);
+    },
+  },
+  nr = r.initialize.bind(r);
+(r.initialize = function (r, t) {
+  const e = nr(r, t);
+  return e && er(), e;
+}),
+  r.vr() && er();
+export default aa;

package/src/ConversationalChat/conversational-chat-provider.js

@@ -0,0 +1,372 @@
+import t from "../common/base-provider.js";
+import r from "../managers/braze-instance.js";
+import nt from "../DUST/dust-provider-factory.js";
+import f from "../managers/subscription-manager.js";
+import { STORAGE_KEYS as s } from "../managers/storage-manager.js";
+import l from "../util/net.js";
+import h from "../util/request-header-utils.js";
+import { logger as b, Guid as V } from "../../shared-lib/index.js";
+import {
+  newChatActionEvent as rt,
+  newChatMessageFromJson as ot,
+  newChatMessageFromSerializedValue as ht,
+  newUserChatMessage as at,
+} from "./chat-message-factory.js";
+import ut from "./display/chat-widget-manager.js";
+export default class tr extends t {
+  constructor(t, s, i) {
+    super(),
+      (this.B = t),
+      (this.h = s),
+      (this.j = i),
+      (this.B = t),
+      (this.h = s),
+      (this.j = i),
+      (this._i = !1),
+      (this.Oi = !1),
+      (this.Hi = new ut()),
+      (this.Wi = null),
+      (this.Ki = null),
+      (this.Qi = new f()),
+      (this.Vi = new f()),
+      (this.Yi = new f()),
+      r.S(this.Qi),
+      r.S(this.Vi),
+      r.S(this.Yi);
+  }
+  isEnabled() {
+    return (
+      !(!this.h || !this.h.Zi()) ||
+      (b.info("Conversational chat is not enabled for this user."), !1)
+    );
+  }
+  sn() {
+    return null != this.en();
+  }
+  en() {
+    const t = r.u();
+    return null != t ? t.$t() : null;
+  }
+  on() {
+    var t;
+    const i = this.en();
+    null != i && (null === (t = this.j) || void 0 === t || t.Pt(s.It.hn, i));
+  }
+  an() {
+    var t;
+    const i = this.en();
+    if (null == i) return !1;
+    return (
+      (null === (t = this.j) || void 0 === t ? void 0 : t.St(s.It.hn)) !== i
+    );
+  }
+  automaticallyManageChat() {
+    var t;
+    const s = this.h;
+    if (this.Oi || !s) return;
+    this.Oi = !0;
+    const i = () => {
+      this.sn() && this.un();
+    };
+    null === (t = r.nn()) ||
+      void 0 === t ||
+      t.rn(() => {
+        null != this.Wi && this.Wi !== this.en() && this.Hi.destroy(), i();
+      }),
+      s.ln(() => {
+        s.Zi() ? i() : this.Hi.destroy();
+      }),
+      i();
+  }
+  un() {
+    if (!this.h || !this.h.Zi()) return;
+    const t = this.h.dn();
+    t ? ((this.Wi = this.en()), this.Hi.mount(t)) : this.Hi.destroy();
+  }
+  cn() {
+    var t;
+    let i = this.vn();
+    return (
+      null == i &&
+        ((i = V.de()),
+        null === (t = this.j) || void 0 === t || t.Pt(s.It.fn, i),
+        this.on()),
+      i
+    );
+  }
+  vn() {
+    var t;
+    return (
+      (null === (t = this.j) || void 0 === t ? void 0 : t.St(s.It.fn)) || null
+    );
+  }
+  gn() {
+    return this.pn().map(ht);
+  }
+  pn() {
+    var t;
+    const i = this.vn();
+    if (null == i) return [];
+    const n = null === (t = this.j) || void 0 === t ? void 0 : t.St(s.It.mn);
+    return (null == n ? void 0 : n[i]) || [];
+  }
+  Cn() {
+    return this.pn().length > 0;
+  }
+  yn() {
+    var t;
+    return (
+      "in_progress" ===
+      (null === (t = this.j) || void 0 === t ? void 0 : t.St(s.It.wn))
+    );
+  }
+  Sn() {
+    var t;
+    return (
+      "ended" ===
+      (null === (t = this.j) || void 0 === t ? void 0 : t.St(s.It.wn))
+    );
+  }
+  isChatTurnErrored() {
+    var t;
+    return (
+      !0 === (null === (t = this.j) || void 0 === t ? void 0 : t.St(s.It.bn))
+    );
+  }
+  jn() {
+    var t;
+    this.Mn(),
+      null === (t = this.j) || void 0 === t || t.Pt(s.It.wn, "in_progress"),
+      this.Vi.A();
+  }
+  Tn() {
+    var t;
+    this.yn() && (null === (t = this.j) || void 0 === t || t.Vt(s.It.wn));
+  }
+  zn() {
+    var t;
+    null === (t = this.j) || void 0 === t || t.Pt(s.It.bn, !0), this.Vi.A();
+  }
+  Mn() {
+    var t;
+    null === (t = this.j) || void 0 === t || t.Vt(s.It.bn);
+  }
+  En(t, s) {
+    const i = this.B;
+    if (!this.isEnabled() || !i) return void ("function" == typeof s && s());
+    if ((this.Rn(), this.Sn()))
+      return void b.info(
+        "Conversational chat: conversation has ended; call resetChatConversation to start a new one.",
+      );
+    if (this.Cn())
+      return void b.info(
+        "Conversational chat: conversation already has history; skipping retrieveChatConfig.",
+      );
+    if (this.yn())
+      return void b.info(
+        "Conversational chat: a turn is already in progress; ignoring retrieveChatConfig.",
+      );
+    if (!this.sn())
+      return (
+        b.info(
+          "Conversational chat: no open session yet; skipping opening message request until a session opens.",
+        ),
+        void ("function" == typeof s && s())
+      );
+    const n = i.Z({}, !0);
+    (n.conversation_session_id = this.cn()), (n.dust_individual = nt.o().qn());
+    const e = h.it.Bn,
+      r = i.tt(n, e);
+    this.jn();
+    const o = () => {
+      this.Tn(), this.zn(), "function" == typeof s && s();
+    };
+    i.et(
+      n,
+      (s = -1) => {
+        -1 !== s && r.push(["X-Braze-Req-Tokens-Remaining", s.toString()]),
+          l.ot({
+            url: `${i.ht()}/${e}`,
+            data: n,
+            headers: r,
+            lt: (s) => {
+              i.ut(n, s, r) ? (i.ct(), "function" == typeof t && t()) : o();
+            },
+            error: (t) => {
+              i.dt(t, "requesting conversational chat opening message"), o();
+            },
+          });
+      },
+      e,
+      o,
+    );
+  }
+  In(t, s, i, n) {
+    const e = this.B;
+    if (!this.isEnabled() || !e) return "function" == typeof n && n(), !1;
+    if ((this.Rn(), this.Sn()))
+      return (
+        b.info(
+          "Conversational chat: conversation has ended; call resetChatConversation to start a new one.",
+        ),
+        !1
+      );
+    if (this.yn())
+      return (
+        b.info(
+          "Conversational chat: a turn is already in progress; ignoring sendChatMessage.",
+        ),
+        !1
+      );
+    if (!this.sn())
+      return (
+        b.info(
+          "Conversational chat: no open session yet; ignoring sendChatMessage until a session opens.",
+        ),
+        "function" == typeof n && n(),
+        !1
+      );
+    const r = this.cn(),
+      o = e.Z({}, !0);
+    (o.conversation_session_id = r),
+      (o.user_message = t),
+      (o.dust_individual = nt.o().qn()),
+      null != s &&
+        null != s.completedActions &&
+        (o.completed_actions = s.completedActions);
+    const a = h.it.$n,
+      u = e.tt(o, a);
+    this.jn();
+    let d = !1;
+    const c = () => {
+      (d = !0), this.Tn(), this.zn(), "function" == typeof n && n();
+    };
+    return (
+      e.et(
+        o,
+        (s = -1) => {
+          -1 !== s && u.push(["X-Braze-Req-Tokens-Remaining", s.toString()]),
+            l.ot({
+              url: `${e.ht()}/${a}`,
+              data: o,
+              headers: u,
+              lt: (s) => {
+                if (!e.ut(o, s, u)) return void c();
+                e.ct();
+                const n = s.message_id;
+                this.kn(at(r, n, t)),
+                  this.Vi.A(),
+                  "function" == typeof i && i();
+              },
+              error: (t) => {
+                e.dt(t, "sending conversational chat message"), c();
+              },
+            });
+        },
+        a,
+        c,
+      ),
+      !d
+    );
+  }
+  xn(t) {
+    return this.Rn(), this.Qi.Ut(t);
+  }
+  Dn(t) {
+    return this.Rn(), this.Vi.Ut(t);
+  }
+  subscribeToChatAction(t) {
+    return this.Rn(), this.Yi.Ut(t);
+  }
+  Un(t) {
+    this.Yi.A(t);
+  }
+  Rn() {
+    var t;
+    this._i ||
+      (r.ar("ctr", (t) => {
+        this._n(t);
+      }),
+      null === (t = r.nn()) ||
+        void 0 === t ||
+        t.rn(() => {
+          this.an() && this.An(), this.on();
+        }),
+      this.Gn(),
+      (this._i = !0));
+  }
+  Gn() {
+    "undefined" != typeof window &&
+      window.addEventListener &&
+      !this.Ki &&
+      ((this.Ki = (t) => this.Nn(t)),
+      window.addEventListener("storage", this.Ki),
+      r.On(() => {
+        this.Ki &&
+          (window.removeEventListener("storage", this.Ki), (this.Ki = null));
+      }));
+  }
+  Nn(t) {
+    const i = t.key;
+    (null == i ||
+      0 === i.indexOf(s.It.mn) ||
+      0 === i.indexOf(s.It.wn) ||
+      0 === i.indexOf(s.It.bn)) &&
+      this.Vi.A();
+  }
+  _n(t) {
+    var i;
+    if ("ctr" !== t.type || null == t.body) return;
+    const n = ot(t.body);
+    if (n.sessionId === this.vn() && !this.Xn(n.messageId)) {
+      this.Tn(),
+        n.Gi("end_conversation")
+          ? (this.kn(n),
+            this.Mn(),
+            null === (i = this.j) || void 0 === i || i.Pt(s.It.wn, "ended"),
+            this.Vi.A())
+          : n.Gi("error")
+          ? this.zn()
+          : (this.kn(n), this.Mn(), this.Vi.A()),
+        this.Qi.A(n);
+      for (const t of n.actions) {
+        const s = rt(t);
+        null != s
+          ? this.Un(s)
+          : b.info(`Ignoring unrecognized chat action: ${t.type}`);
+      }
+    }
+  }
+  Xn(t) {
+    if (null == t) return !1;
+    for (const s of this.pn()) if (s.id === t) return !0;
+    return !1;
+  }
+  kn(t) {
+    if (!this.j) return;
+    const i = t.sessionId,
+      n = this.j.St(s.It.mn) || {},
+      e = n[i] || [];
+    for (e.push(t.qt()); e.length > 1 && JSON.stringify(e).length > 5e4; )
+      e.shift();
+    (n[i] = e), this.j.Pt(s.It.mn, n);
+  }
+  changeUser() {
+    this.Hn();
+  }
+  clearData(t = !1) {
+    t && this.Hn(), this.Hi.destroy();
+  }
+  Hn() {
+    this.An();
+  }
+  An() {
+    if (!this.j) return;
+    const t = this.vn();
+    if ((this.j.Vt(s.It.fn), null != t)) {
+      const i = this.j.St(s.It.mn) || {};
+      delete i[t], this.j.Pt(s.It.mn, i);
+    }
+    this.j.Vt(s.It.wn), this.j.Vt(s.It.bn), this.j.Vt(s.It.hn), this.Vi.A();
+  }
+}

package/src/ConversationalChat/display/chat-widget-manager.js

@@ -0,0 +1,113 @@
+import r, { OPTIONS as U } from "../../managers/braze-instance.js";
+import { removeSubscription } from "../../Core/remove-subscription.js";
+import b from "../../../shared-lib/logger.js";
+import l from "../../util/net.js";
+import { setupChatWidgetUI as lt } from "../../ui/js/chat-widget-css.js";
+import {
+  CHAT_WIDGET_IFRAME_ID as dt,
+  chatWidgetToHtml as ct,
+} from "./chat-widget-to-html.js";
+export default class ut {
+  constructor() {
+    (this.se = 0),
+      (this.he = 0),
+      (this.ue = null),
+      (this.le = []),
+      (this.ce = null),
+      (this.me = null),
+      (this.fe = 0),
+      (this.pe = null);
+  }
+  mount(t) {
+    if ("undefined" == typeof document) return;
+    if (this.pe === t) return;
+    if ((null != this.pe && this.destroy(), document.getElementById(dt)))
+      return;
+    if (!r.er(U.nr))
+      return void b.error(
+        "Conversational chat is disabled. Use the 'allowUserSuppliedJavascript' option for braze.initialize to enable this feature.",
+      );
+    lt(), (this.pe = t);
+    const i = ++this.fe;
+    l.get({
+      url: t,
+      lt: (t) => {
+        if (i !== this.fe) return;
+        const s = r.er(U.sr);
+        this.we(t, s, i);
+      },
+      error: (t) => {
+        i === this.fe &&
+          (b.error(`Conversational chat: failed to fetch widget (${t})`),
+          (this.pe = null));
+      },
+    });
+  }
+  destroy() {
+    if ((this.fe++, this.ve(), this.be(), "undefined" != typeof document)) {
+      this.ce &&
+        (document.removeEventListener("DOMContentLoaded", this.ce),
+        (this.ce = null));
+      const t = document.getElementById(dt) || this.me;
+      t && ((t.onload = null), t.parentNode && t.parentNode.removeChild(t)),
+        (this.me = null);
+    }
+    this.pe = null;
+  }
+  ge(t, i) {
+    this.ve();
+    const s = ct(
+      t,
+      i,
+      (t) => this.je(t),
+      (t, i, s) => this.ye(t, i, s),
+    );
+    return (
+      (this.me = s),
+      (this.ue = () => this.Ce(s)),
+      window.addEventListener("resize", this.ue),
+      s
+    );
+  }
+  ve() {
+    this.ue &&
+      (window.removeEventListener("resize", this.ue), (this.ue = null)),
+      (this.se = 0),
+      (this.he = 0);
+  }
+  we(t, i, s) {
+    const e = () => {
+      if (
+        (this.ce === e && (this.ce = null),
+        s === this.fe && null != this.pe && !document.getElementById(dt))
+      )
+        return document.body
+          ? void document.body.appendChild(this.ge(t, i))
+          : (b.error(
+              "Conversational chat: document body is unavailable; not mounting the widget.",
+            ),
+            void (this.pe = null));
+    };
+    document.body
+      ? e()
+      : ((this.ce = e), document.addEventListener("DOMContentLoaded", e));
+  }
+  je(t) {
+    return t && this.le.push(t), t;
+  }
+  be() {
+    for (const t of this.le) removeSubscription(t);
+    this.le = [];
+  }
+  Ce(t) {
+    const i = window.innerWidth || this.se,
+      s = window.innerHeight || this.he;
+    (t.style.width = `${Math.min(this.se, i)}px`),
+      (t.style.height = `${Math.min(this.he, s)}px`);
+  }
+  ye(t, i, s) {
+    isNaN(i) || isNaN(s) || !isFinite(i) || !isFinite(s) || i < 0 || s < 0
+      ? b.warn(`Conversational chat: invalid widget bounds ${i}x${s}`)
+      : ((this.se = i), (this.he = s), this.Ce(t));
+  }
+}