@xapp/chat-widget 1.110.0 → 1.111.1

package/dist/index.js

@@ -3616,6 +3616,115 @@ function stripQueryString(url) {
         return undefined;
     }
 }
+
+/**
+ * Google Analytics 4 ids for chat leads.
+ *
+ * A form lead's `generate_lead` can go out from the browser, but a chat lead is only
+ * ever sent by the backend's Measurement Protocol integration. Without the visitor's
+ * GA client and session ids that event matches no browser session, and GA4 credits
+ * it to Direct / Unassigned. These are sent as chat attributes so the backend can
+ * credit the lead to the traffic source that brought the visitor.
+ *
+ * Only the ids GA itself set are read; nothing here is PII.
+ */
+var SESSION_COOKIE_PREFIX = "_ga_";
+/**
+ * Extracts the GA4 client id from a `_ga` cookie value: `GA1.1.<rand>.<ts>` ->
+ * `<rand>.<ts>`.
+ */
+function parseGaClientId(cookie) {
+    var parts = (cookie === null || cookie === void 0 ? void 0 : cookie.split(".")) || [];
+    if (parts.length < 4) {
+        return undefined;
+    }
+    var clientId = parts.slice(-2).join(".");
+    return /^\d+\.\d+$/.test(clientId) ? clientId : undefined;
+}
+/**
+ * Extracts the session id from a `_ga_<stream>` cookie value. Handles both the legacy
+ * `GS1.1.<sid>.<n>...` format and the 2025 `GS2.1.s<sid>$o3$...` format.
+ */
+function parseGaSessionId(cookie) {
+    var parts = (cookie === null || cookie === void 0 ? void 0 : cookie.split(".")) || [];
+    if (parts.length < 3) {
+        return undefined;
+    }
+    var sessionId;
+    if (parts[0] === "GS2") {
+        var token = parts[2].split("$").find(function (t) { return t.startsWith("s"); });
+        sessionId = token === null || token === void 0 ? void 0 : token.slice(1);
+    }
+    else {
+        sessionId = parts[2];
+    }
+    return sessionId && /^\d+$/.test(sessionId) ? sessionId : undefined;
+}
+function hasGlobalPrivacyControlOptOut() {
+    if (typeof navigator === "undefined") {
+        return false;
+    }
+    return (navigator.globalPrivacyControl === true);
+}
+function readCookies() {
+    var cookies = {};
+    if (typeof document === "undefined" || !document.cookie) {
+        return cookies;
+    }
+    for (var _i = 0, _a = document.cookie.split(";"); _i < _a.length; _i++) {
+        var pair = _a[_i];
+        var index = pair.indexOf("=");
+        if (index < 0) {
+            continue;
+        }
+        var name_1 = pair.slice(0, index).trim();
+        var raw = pair.slice(index + 1).trim();
+        try {
+            cookies[name_1] = decodeURIComponent(raw);
+        }
+        catch (_b) {
+            // A stray "%" from another script must not break the chat.
+            cookies[name_1] = raw;
+        }
+    }
+    return cookies;
+}
+/**
+ * The GA4 attributes to send with a chat message. Under Global Privacy Control only
+ * the opt-out flag is sent. Never throws.
+ */
+function getGa4Attributes() {
+    try {
+        if (hasGlobalPrivacyControlOptOut()) {
+            return { ga4OptOut: true };
+        }
+        var cookies = readCookies();
+        var attributes = {};
+        var gaClientId = parseGaClientId(cookies["_ga"]);
+        if (gaClientId) {
+            attributes.gaClientId = gaClientId;
+        }
+        var gaSessionIds = {};
+        for (var _i = 0, _a = Object.entries(cookies); _i < _a.length; _i++) {
+            var _b = _a[_i], name_2 = _b[0], value = _b[1];
+            if (!name_2.startsWith(SESSION_COOKIE_PREFIX)) {
+                continue;
+            }
+            var stream = name_2.slice(SESSION_COOKIE_PREFIX.length);
+            var sessionId = parseGaSessionId(value);
+            if (/^[A-Z0-9]+$/i.test(stream) && sessionId) {
+                gaSessionIds[stream] = sessionId;
+            }
+        }
+        if (Object.keys(gaSessionIds).length > 0) {
+            attributes.gaSessionIds = gaSessionIds;
+        }
+        return attributes;
+    }
+    catch (_c) {
+        return {};
+    }
+}
 /**
  * A minimal client for the tenant's homeowner MCP endpoint: one `tools/call` per request, no
  * session. The endpoint is public and the server keeps no state we need, so the MCP
@@ -4001,6 +4110,7 @@ var SuggestionsList_1 = SuggestionsList;
 var addTestLeadAttribute_1 = addTestLeadAttribute;
 var findItemByIndex_1 = findItemByIndex;
 var getAttribution_1 = getAttribution;
+var getGa4Attributes_1 = getGa4Attributes;
 var getItemsLength_1 = getItemsLength;
 var parseSuggestionsResponse_1 = parseSuggestionsResponse;
 var stripQueryString_1 = stripQueryString;
@@ -6579,16 +6689,25 @@ var StentorDirectChat = /** @class */ (function () {
     StentorDirectChat.prototype.wakeup = function () { };
     StentorDirectChat.prototype.postMessage = function (message) {
         return __awaiter$1(this, void 0, void 0, function () {
-            var request, userId, sessionId, accessToken, attributes, rwgToken, merchantId, environment, enablePreferredTime, service, origin, now, permissionRequest, expired, text, granted, userProfile, isEmail, configurableMessages, botResponse, successResult, success, fail, i, timeout, responseMessage;
+            var request, userId, sessionId, accessToken, attributes, _i, _a, _b, key, value, rwgToken, merchantId, environment, enablePreferredTime, service, origin, now, permissionRequest, expired, text, granted, userProfile, isEmail, configurableMessages, botResponse, successResult, success, fail, i, timeout, responseMessage;
             var _this = this;
-            var _a, _b, _c, _d, _e;
-            return __generator$1(this, function (_f) {
-                switch (_f.label) {
+            var _c, _d, _e, _f, _g, _h;
+            return __generator$1(this, function (_j) {
+                switch (_j.label) {
                     case 0:
                         userId = this._userId;
                         sessionId = this._sessionId;
                         accessToken = this._accessToken;
                         attributes = mergeAttribution(this._attributes, getAttribution_1());
+                        // The visitor's GA client and session ids, so the backend can credit a chat lead
+                        // to the traffic source that brought them rather than Direct / Unassigned. Like the
+                        // rest of the attribution, a value the host page set itself wins.
+                        for (_i = 0, _a = Object.entries(getGa4Attributes_1()); _i < _a.length; _i++) {
+                            _b = _a[_i], key = _b[0], value = _b[1];
+                            if (((_c = this._attributes) === null || _c === void 0 ? void 0 : _c[key]) === undefined) {
+                                attributes[key] = value;
+                            }
+                        }
                         rwgToken = localStorage.getItem("xa_rwg_token");
                         if (rwgToken) {
                             attributes["rwg_token"] = rwgToken;
@@ -6618,10 +6737,10 @@ var StentorDirectChat = /** @class */ (function () {
                         // Add current time for accurate date/time responses
                         attributes["currentTime"] = new Date().toISOString();
                         now = new Date().getTime();
-                        if (this.isNewSession && !((_a = message === null || message === void 0 ? void 0 : message.msg) === null || _a === void 0 ? void 0 : _a.text)) {
+                        if (this.isNewSession && !((_d = message === null || message === void 0 ? void 0 : message.msg) === null || _d === void 0 ? void 0 : _d.text)) {
                             request = {
                                 type: "LAUNCH_REQUEST",
-                                rawQuery: (_b = message === null || message === void 0 ? void 0 : message.msg) === null || _b === void 0 ? void 0 : _b.text,
+                                rawQuery: (_e = message === null || message === void 0 ? void 0 : message.msg) === null || _e === void 0 ? void 0 : _e.text,
                                 sessionId: sessionId,
                                 userId: userId,
                                 isNewSession: true,
@@ -6633,11 +6752,11 @@ var StentorDirectChat = /** @class */ (function () {
                             };
                         }
                         else {
-                            permissionRequest = (_c = message.msg) === null || _c === void 0 ? void 0 : _c.permissionRequest;
+                            permissionRequest = (_f = message.msg) === null || _f === void 0 ? void 0 : _f.permissionRequest;
                             if (permissionRequest) {
                                 message = __assign$1(__assign$1({}, message), { msg: __assign$1(__assign$1({}, message.msg), { permissionRequest: undefined }) });
                                 expired = now - permissionRequest.time > PERMISSION_QUESTION_EXPIRATION_MS$1;
-                                text = (_d = message.msg.text) === null || _d === void 0 ? void 0 : _d.toLowerCase();
+                                text = (_g = message.msg.text) === null || _g === void 0 ? void 0 : _g.toLowerCase();
                                 granted = !expired;
                                 userProfile = { id: this._userId };
                                 if (!expired) {
@@ -6735,7 +6854,7 @@ var StentorDirectChat = /** @class */ (function () {
                             });
                         }); };
                         i = 1;
-                        _f.label = 1;
+                        _j.label = 1;
                     case 1:
                         if (!(i < configurableMessages.length)) return [3 /*break*/, 4];
                         timeout = this.config.timeout || 22000;
@@ -6751,12 +6870,12 @@ var StentorDirectChat = /** @class */ (function () {
                                 .catch(fail.bind(this, i))];
                     case 2:
                         // We don't start typing IF we have a failure message displayed and we are waiting on the timeout
-                        _f.sent();
+                        _j.sent();
                         // If we have what we want, break the for loop
                         if (successResult) {
                             return [3 /*break*/, 4];
                         }
-                        _f.label = 3;
+                        _j.label = 3;
                     case 3:
                         i++;
                         return [3 /*break*/, 1];
@@ -6782,7 +6901,7 @@ var StentorDirectChat = /** @class */ (function () {
                                     : "The assistant is not responding right now.  Please close the widget and open it again.",
                             };
                         }
-                        if (typeof ((_e = this.hooks) === null || _e === void 0 ? void 0 : _e.onResponse) === "function") {
+                        if (typeof ((_h = this.hooks) === null || _h === void 0 ? void 0 : _h.onResponse) === "function") {
                             this.hooks.onResponse(botResponse);
                         }
                         this.stopTyping();
@@ -7019,10 +7138,28 @@ function requestToMessage(botRequest, now) {
 }
 
 var ROUTER_USER = "router";
+/**
+ * Shown when the server reports an error outside the router protocol and no failure
+ * messages are configured.
+ */
+var DEFAULT_GATEWAY_ERROR_TEXT = "Sorry, we cannot communicate with the assistant right now. Please check your connection or try again later.";
+function isGatewayErrorFrame(frame) {
+    if (!frame || typeof frame !== "object") {
+        return false;
+    }
+    var f = frame;
+    return f.event === undefined && typeof f.message === "string";
+}
 var serverInfo = {
     deviceId: "Router",
     userId: ROUTER_USER,
-    displayName: "XAPP Server"};
+    isAdmin: false,
+    displayName: "XAPP Server",
+    urlAttributes: {
+        path: [],
+        query: {}
+    }
+};
 var StentorRouterChat = /** @class */ (function () {
     function StentorRouterChat(config, options) {
         var _a, _b, _c, _d, _e;
@@ -7035,6 +7172,8 @@ var StentorRouterChat = /** @class */ (function () {
         this.isAdmin = false;
         this.urlAttributes = {};
         this.handlers = {};
+        // Senders whose typing indicator is currently on, so it can be cleared when a request fails
+        this.typingSenders = new Map();
         // Sleep delay management
         // Use number | NodeJS.Timeout for cross-environment compatibility (browser vs Node.js)
         this.sleepTimeoutId = null;
@@ -7218,6 +7357,7 @@ var StentorRouterChat = /** @class */ (function () {
             });
         };
         this.handlers["typing"] = function (_data, sender, ts, _attributes) {
+            _this.typingSenders.set(senderToNick(sender), sender);
             _this.dispatch({
                 type: "chat",
                 detail: {
@@ -7231,6 +7371,7 @@ var StentorRouterChat = /** @class */ (function () {
             });
         };
         this.handlers["stop typing"] = function (_data, sender, ts, _attributes) {
+            _this.typingSenders.delete(senderToNick(sender));
             _this.dispatch({
                 type: "chat",
                 detail: {
@@ -7471,7 +7612,18 @@ var StentorRouterChat = /** @class */ (function () {
         };
         this.ws.onmessage = function (me) {
             log("ROUTER says: ".concat(me.data));
-            var message = JSON.parse(me.data);
+            var message;
+            try {
+                message = JSON.parse(me.data);
+            }
+            catch (e) {
+                err("Unparseable router message: ".concat(me.data));
+                return;
+            }
+            if (isGatewayErrorFrame(message)) {
+                _this.handleGatewayError(message);
+                return;
+            }
             var handler = _this.handlers[message.event];
             if (handler) {
                 _this.handlers[message.event](message.data, message.sender, message.timeMs, message.attributes, message.messageId);
@@ -7580,6 +7732,32 @@ var StentorRouterChat = /** @class */ (function () {
             }
         });
     };
+    /**
+     * The gateway answered instead of the router (typically a Lambda timeout). The request is
+     * lost and nothing else will arrive for it, so stop any typing indicator and tell the visitor.
+     */
+    StentorRouterChat.prototype.handleGatewayError = function (frame) {
+        var _this = this;
+        err("SERVER: gateway error: \"".concat(frame.message, "\" (requestId: ").concat(frame.requestId || "?", ")"));
+        this.typingSenders.forEach(function (sender) {
+            _this.dispatch({
+                type: "chat",
+                detail: {
+                    type: "chat.typing",
+                    user: {
+                        nick: senderToNick(sender),
+                    },
+                    typing: false,
+                    timestamp: +new Date(),
+                },
+            });
+        });
+        this.typingSenders.clear();
+        // The last configured message is the final, no-retry one
+        var last = this.configurableMessages[this.configurableMessages.length - 1];
+        var configured = last && last.text ? last : undefined;
+        this.sendFailureMessage(configured ? configured.retry : 1, 0, configured ? configured.text : DEFAULT_GATEWAY_ERROR_TEXT, serverInfo);
+    };
     StentorRouterChat.prototype.sendDisconnectMessage = function () {
         this.dispatch({
             type: "chat",
@@ -16089,7 +16267,7 @@ const createQueueWithTimer = (timeout) => {
 		setTimeout(notify, timeout);
 	};
 };
-const createRafWithFallbackTimer = (raf, timeout) => {
+const createRafWithFallbackTimer = (raf, caf, timeout) => {
 	return (notify) => {
 		let called = false;
 		let rafId;
@@ -16097,7 +16275,7 @@ const createRafWithFallbackTimer = (raf, timeout) => {
 		const callback = () => {
 			if (called) return;
 			called = true;
-			cancelAnimationFrame(rafId);
+			caf?.(rafId);
 			clearTimeout(timerId);
 			notify();
 		};
@@ -16111,7 +16289,7 @@ const autoBatchEnhancer = (options = { type: "raf" }) => (next) => (...args) =>
 	let shouldNotifyAtEndOfTick = false;
 	let notificationQueued = false;
 	const listeners = /* @__PURE__ */ new Set();
-	const queueCallback = options.type === "tick" ? queueMicrotask : options.type === "raf" ? typeof window !== "undefined" && window.requestAnimationFrame ? createRafWithFallbackTimer(window.requestAnimationFrame, 100) : createQueueWithTimer(10) : options.type === "callback" ? options.queueNotification : createQueueWithTimer(options.timeout);
+	const queueCallback = options.type === "tick" ? queueMicrotask : options.type === "raf" ? typeof window !== "undefined" && window.requestAnimationFrame ? createRafWithFallbackTimer(window.requestAnimationFrame, window.cancelAnimationFrame, 100) : createQueueWithTimer(10) : options.type === "callback" ? options.queueNotification : createQueueWithTimer(options.timeout);
 	const notifyListeners = () => {
 		notificationQueued = false;
 		if (shouldNotifyAtEndOfTick) {