@microsoft/omnichannel-chat-widget 1.8.2-main.e3c1d40 → 1.8.2-main.f638bed

package/lib/cjs/firstresponselatency/FirstMessageTrackerFromBot.js

@@ -12,54 +12,96 @@ var _util = require("./util");
 //  with different timeline, therefore this is a functional approach to track the events, instead of a class based approach
 const createTrackingForFirstMessage = () => {
   // Reset the tracking variables
-  let startTracking = false;
-  let stopTracking = false;
+  let isTracking = false;
   let startTime = 0;
   let stopTime = 0;
-  let stopTrackingMessage;
+  let stopTrackingMessage = null;
   let flag = false;
+  let trackingTimeoutId;
+
+  /**
+   * Checks if the message payload is from a valid sender (not an agent).
+   * Returns false if the message is from an agent (tag 'public'), true otherwise.
+   */
   const isMessageFromValidSender = payload => {
     var _payload$tags;
-    // agent scenario
     if (payload !== null && payload !== void 0 && (_payload$tags = payload.tags) !== null && _payload$tags !== void 0 && _payload$tags.includes("public")) {
       return false;
     }
     return true;
   };
+
+  /**
+   * Listener for widget load completion event.
+   * Starts tracking the time for the first bot message after widget loads.
+   * Sets a 5-second timeout to auto-reset if no bot message is received.
+   */
   const widgetLoadListener = _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.TelemetryEvent.WidgetLoadComplete).subscribe(() => {
-    if (startTracking) return;
-    startTracking = true;
+    if (isTracking) return;
+    isTracking = true;
     startTime = new Date().getTime();
+    // Start a 5-second timeout to auto-stop tracking if not stopped
+    if (trackingTimeoutId) {
+      clearTimeout(trackingTimeoutId);
+    }
+    trackingTimeoutId = setTimeout(() => {
+      if (isTracking) {
+        // Reset state and disengage, no telemetry or FMLTrackingCompleted
+        isTracking = false;
+        startTime = 0;
+        stopTime = 0;
+        stopTrackingMessage = null;
+        trackingTimeoutId = undefined;
+        disconnectListener();
+      }
+    }, 10000); //adding more time since it meassures from widget load complete till message received
   });
+
+  /**
+   * Listener for new bot message event.
+   * If a valid bot message is received, stops tracking and logs telemetry.
+   * If the message is invalid, resets and disengages listeners.
+   */
   const newMessageListener = _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.BroadcastEvent.NewMessageReceived).subscribe(message => {
     const payload = message.payload;
-
-    // we only care for bot, so we need to check if the message is from the bot
-    // pending to add typing message indicator signal detection
-
-    if (isMessageFromValidSender(payload)) {
-      if (startTracking && !stopTracking) {
-        stopTime = new Date().getTime();
-        const elapsedTime = stopTime - startTime;
-        stopTracking = true;
-        stopTrackingMessage = (0, _util.createTrackingMessage)(payload, "botMessage");
-        notifyFMLTrackingCompleted();
-        _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
-          Event: _TelemetryConstants.TelemetryEvent.BotFirstMessageLapTrack,
-          Description: "First Message from Bot latency tracking",
-          CustomProperties: {
-            elapsedTime,
-            widgetLoadedAt: startTime,
-            botMessage: stopTrackingMessage
-          }
-        });
+    if (!isMessageFromValidSender(payload)) {
+      // If not valid, stop everything and clean up
+      isTracking = false;
+      if (trackingTimeoutId) {
+        clearTimeout(trackingTimeoutId);
+        trackingTimeoutId = undefined;
       }
+      disconnectListener();
+      return;
+    }
+    if (isTracking) {
+      isTracking = false;
+      // Clear the timeout if it exists
+      if (trackingTimeoutId) {
+        clearTimeout(trackingTimeoutId);
+        trackingTimeoutId = undefined;
+      }
+      stopTime = new Date().getTime();
+      const elapsedTime = stopTime - startTime;
+      stopTrackingMessage = (0, _util.createTrackingMessage)(payload, "botMessage");
+      notifyFMLTrackingCompleted();
+      _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
+        Event: _TelemetryConstants.TelemetryEvent.BotFirstMessageLapTrack,
+        Description: "First Message from Bot latency tracking",
+        CustomProperties: {
+          elapsedTime,
+          widgetLoadedAt: startTime,
+          botMessage: stopTrackingMessage
+        }
+      });
+      disconnectListener();
     }
-
-    // this track only first message, if coming from the bot or not
-    // the only difference is that it logs only those from bot
-    disconnectListener();
   });
+
+  /**
+   * Notifies that FML (First Message Latency) tracking is completed.
+   * Retries sending the completion event until acknowledged.
+   */
   const notifyFMLTrackingCompleted = () => {
     ackListener();
     // Retry sending until flag is true, but do not block the main thread
@@ -74,6 +116,11 @@ const createTrackingForFirstMessage = () => {
       }
     }, 100);
   };
+
+  /**
+   * Listener for FMLTrackingCompletedAck event.
+   * Sets the flag to true when acknowledgment is received.
+   */
   const ackListener = () => {
     const listen = _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.BroadcastEvent.FMLTrackingCompletedAck).subscribe(() => {
       flag = true;
@@ -83,22 +130,32 @@ const createTrackingForFirstMessage = () => {
 
   // Rehydrate message is received when the widget is reloaded, this is to ensure that we are not tracking messages that are not part of the current conversation
   // No need to keep listerning for tracking, enforcing disconnection for the listners
+  /**
+   * Listener for widget rehydration event.
+   * Resets tracking and disconnects listeners when widget is reloaded.
+   */
   const rehydrateListener = _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.TelemetryEvent.RehydrateMessageReceived).subscribe(() => {
-    startTracking = false;
-    stopTracking = false;
+    isTracking = false;
     disconnectListener();
   });
 
   // Rehydrate message is received when the widget is reloaded, this is to ensure that we are not tracking messages that are not part of the current conversation
   // No need to keep listerning for tracking, enforcing disconnection for the listners
+  /**
+   * Listener for history message event.
+   * Resets tracking and disconnects listeners when history is loaded.
+   */
   const historyListener = _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.BroadcastEvent.HistoryMessageReceived).subscribe(() => {
-    startTracking = false;
-    stopTracking = false;
+    isTracking = false;
     disconnectListener();
   });
+
+  /**
+   * Listener for network disconnection event.
+   * Resets tracking, disconnects listeners, and logs a telemetry error.
+   */
   const offlineNetworkListener = _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.TelemetryEvent.NetworkDisconnected).subscribe(() => {
-    startTracking = false;
-    stopTracking = false;
+    isTracking = false;
     disconnectListener();
     _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
       Event: _TelemetryConstants.TelemetryEvent.BotFirstMessageLapTrackError,
@@ -107,7 +164,15 @@ const createTrackingForFirstMessage = () => {
   });
 
   // this is to ensure that we are not tracking messages that are not part of the current conversation
+  /**
+   * Disconnects all listeners and clears the tracking timeout.
+   * Used for cleanup when tracking is stopped or reset.
+   */
   const disconnectListener = () => {
+    if (trackingTimeoutId) {
+      clearTimeout(trackingTimeoutId);
+      trackingTimeoutId = undefined;
+    }
     historyListener.unsubscribe();
     rehydrateListener.unsubscribe();
     newMessageListener.unsubscribe();

package/lib/cjs/firstresponselatency/FirstResponseLatencyTracker.js

@@ -17,14 +17,13 @@ let FirstResponseLatencyTracker = /*#__PURE__*/function () {
   function FirstResponseLatencyTracker() {
     _classCallCheck(this, FirstResponseLatencyTracker);
     _defineProperty(this, "isABotConversation", false);
-    _defineProperty(this, "isStarted", false);
-    _defineProperty(this, "isEnded", false);
+    _defineProperty(this, "isTracking", false);
     _defineProperty(this, "startTrackingMessage", void 0);
     _defineProperty(this, "stopTrackingMessage", void 0);
     _defineProperty(this, "isReady", false);
+    _defineProperty(this, "trackingTimeoutId", void 0);
     _defineProperty(this, "offlineNetworkListener", _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.TelemetryEvent.NetworkDisconnected).subscribe(() => {
-      this.isStarted = false;
-      this.isEnded = false;
+      this.isTracking = false;
       _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
         Event: _TelemetryConstants.TelemetryEvent.MessageStopLapTrackError,
         Description: "Tracker Stopped due to network disconnection"
@@ -72,7 +71,7 @@ let FirstResponseLatencyTracker = /*#__PURE__*/function () {
     value: function startTracking(payload) {
       if (!this.isReady) return;
       //  this prevents to initiate tracking for multiple incoming messages
-      if (this.isStarted) {
+      if (this.isTracking) {
         return;
       }
       // this is to ensure we track only messages where bot is engaged
@@ -80,10 +79,24 @@ let FirstResponseLatencyTracker = /*#__PURE__*/function () {
         return;
       }
       // control of states to prevent clashing of messages
-      this.isStarted = true;
-      this.isEnded = false;
+      this.isTracking = true;
       // The idea  of using types is to enrich telemetry data 
       this.startTrackingMessage = this.createTrackingMessage(payload, "userMessage");
+
+      // Start a 5-second timeout to auto-stop tracking if not stopped
+      if (this.trackingTimeoutId) {
+        clearTimeout(this.trackingTimeoutId);
+      }
+      this.trackingTimeoutId = setTimeout(() => {
+        // this means the start process is in progress, but the end wasn't called within the time limit
+        if (this.isTracking) {
+          // Reset state variables and skip stopTracking
+          this.isTracking = false;
+          this.startTrackingMessage = undefined;
+          this.stopTrackingMessage = undefined;
+          this.trackingTimeoutId = undefined;
+        }
+      }, 5000);
     }
   }, {
     key: "handleAgentMessage",
@@ -99,13 +112,16 @@ let FirstResponseLatencyTracker = /*#__PURE__*/function () {
     value: function stopTracking(payload) {
       var _this$stopTrackingMes, _this$startTrackingMe;
       // this prevents execution for multiple incoming messages from the bot.
-      if (this.isEnded && !this.isStarted) {
+      if (!this.isTracking) {
         return;
       }
-
+      // Clear the timeout if it exists
+      if (this.trackingTimeoutId) {
+        clearTimeout(this.trackingTimeoutId);
+        this.trackingTimeoutId = undefined;
+      }
       // control of states to prevent clashing of messages
-      this.isEnded = true;
-      this.isStarted = false;
+      this.isTracking = false;
 
       // The idea  of using types is to enrich telemetry data 
       this.stopTrackingMessage = this.createTrackingMessage(payload, "botMessage");
@@ -160,12 +176,16 @@ let FirstResponseLatencyTracker = /*#__PURE__*/function () {
         if (!payload || !payload.Id) {
           throw new Error("Invalid payload");
         }
-        if (!this.isMessageFromValidSender(payload)) return;
-        if (this.isABotConversation && this.isStarted) {
+
+        // Only allow stopTracking if sender is valid and tracking is active
+        if (!this.isMessageFromValidSender(payload)) {
+          // Do not change isTracking or stopTrackingMessage
+          return;
+        }
+        if (this.isABotConversation && this.isTracking) {
           this.stopTracking(payload);
         }
       } catch (e) {
-        console.error("FRL : error while trying to stop the tracker", e);
         _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.ERROR, {
           Event: _TelemetryConstants.TelemetryEvent.MessageStopLapTrackError,
           Description: "Error while stopping the clock",
@@ -174,11 +194,6 @@ let FirstResponseLatencyTracker = /*#__PURE__*/function () {
             payload: payload
           }
         });
-        //reset state
-        this.startTrackingMessage = undefined;
-        this.stopTrackingMessage = undefined;
-        this.isStarted = false;
-        this.isEnded = false;
       }
     }
   }, {
@@ -186,10 +201,13 @@ let FirstResponseLatencyTracker = /*#__PURE__*/function () {
     value: function deregister() {
       // Reset State
       this.isABotConversation = false;
-      this.isStarted = false;
-      this.isEnded = false;
+      this.isTracking = false;
       this.startTrackingMessage = undefined;
       this.stopTrackingMessage = undefined;
+      if (this.trackingTimeoutId) {
+        clearTimeout(this.trackingTimeoutId);
+        this.trackingTimeoutId = undefined;
+      }
       this.offlineNetworkListener.unsubscribe();
       this.fmltrackingListener.unsubscribe();
       this.rehydrateListener.unsubscribe();

package/lib/cjs/firstresponselatency/util.js

@@ -3,43 +3,72 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.polyfillMessagePayloadForEvent = exports.isHistoryMessage = exports.getScenarioType = exports.createTrackingMessage = exports.buildMessagePayload = void 0;
+exports.polyfillMessagePayloadForEvent = exports.isHistoryMessage = exports.getScenarioType = exports.extractTimestampFromId = exports.createTrackingMessage = exports.buildMessagePayload = void 0;
 var _Constants = require("./Constants");
 var _Constants2 = require("../common/Constants");
+const DELTA_WITHIN_LIMITS_IN_MS = 250;
+
+/**
+ * Determines whether a given activity is a historical message.
+ * 
+ * This function checks if the activity is a message type and uses a combination
+ * of legacy tags and timestamp-based logic to determine if the message is historical.
+ * 
+ * @param {IActivity} activity - The activity object to evaluate.
+ * @param {number} startTime - The start time (in milliseconds since epoch) to compare against.
+ * @returns {boolean} - Returns true if the activity is a historical message, false otherwise.
+ * 
+ * Logic:
+ * - If the activity type is not a message, it is not historical.
+ * - If the activity contains a legacy history message tag, it is considered historical.
+ * - Otherwise, the function extracts a timestamp from the activity ID using `extractTimestampFromId`.
+ *   - If the ID is valid and the timestamp is older than the start time, the message is historical.
+ */
 const isHistoryMessage = (activity, startTime) => {
-  try {
-    if ((activity === null || activity === void 0 ? void 0 : activity.type) === _Constants2.Constants.message) {
-      var _activity$channelData, _activity$channelData2;
-      // this is an old piece of code, probably no longer relevant
-      if (activity !== null && activity !== void 0 && (_activity$channelData = activity.channelData) !== null && _activity$channelData !== void 0 && (_activity$channelData2 = _activity$channelData.tags) !== null && _activity$channelData2 !== void 0 && _activity$channelData2.includes(_Constants2.Constants.historyMessageTag)) return true;
+  var _activity$channelData;
+  // Only process message activities
+  if ((activity === null || activity === void 0 ? void 0 : activity.type) !== _Constants2.Constants.message) {
+    return false;
+  }
 
-      // Id is an epoch time in milliseconds , in utc format, for some reason is in a string format
-      if (activity !== null && activity !== void 0 && activity.id) {
-        /// activity.id is an string that contains epoch time in milliseconds
-        const activityId = parseInt(activity === null || activity === void 0 ? void 0 : activity.id);
+  // Prioritize legacy history tag
+  if (activity !== null && activity !== void 0 && (_activity$channelData = activity.channelData) !== null && _activity$channelData !== void 0 && _activity$channelData.tags && activity.channelData.tags.includes(_Constants2.Constants.historyMessageTag)) {
+    return true;
+  }
+  const activityId = extractTimestampFromId(activity);
+  const isValidId = !isNaN(activityId) && activityId > 0;
+  const difference = startTime - activityId;
+  // Only consider historical if activityId < startTime and difference >= DELTA_WITHIN_LIMITS_IN_MS
+  const isOlderThanStartTime = activityId < startTime && difference >= DELTA_WITHIN_LIMITS_IN_MS;
+  const isHistoryById = isValidId && isOlderThanStartTime;
+  return isHistoryById;
+};
+exports.isHistoryMessage = isHistoryMessage;
+const extractTimestampFromId = activity => {
+  const id = (activity === null || activity === void 0 ? void 0 : activity.id) ?? "";
 
-        // if the activity id is not a number, we default to new message
-        if (isNaN(activityId)) {
-          return false;
-        }
+  // Helper function to get timestamp fallback
+  const getTimestampFallback = () => {
+    const timestamp = new Date((activity === null || activity === void 0 ? void 0 : activity.timestamp) ?? "").getTime();
+    return isNaN(timestamp) ? 0 : timestamp;
+  };
 
-        // if the activity id is less than the start time, it means that the message is a history message
-        if (activityId < startTime) {
-          return true;
-        }
-      }
-      // anything else will be considered a new message
-      return false;
-    }
-  } catch (e) {
-    // if there is an error in parsing the activity id, we will consider it a new message
-    console.error("Error in parsing activity id: ", e);
+  // Check if ID looks like a UUID (contains dashes or is very long)
+  const UUID_LENGTH_THRESHOLD = 13; // Threshold to distinguish UUIDs from epoch timestamps
+  if (id.includes("-") || id.length > UUID_LENGTH_THRESHOLD) {
+    // Likely UUID, use timestamp instead
+    return getTimestampFallback();
   }
-  return false;
+  const activityId = parseInt(id);
+  // if activity id is not a number, then we use timestamp field
+  if (isNaN(activityId)) {
+    return getTimestampFallback();
+  }
+  return activityId;
 };
-exports.isHistoryMessage = isHistoryMessage;
+exports.extractTimestampFromId = extractTimestampFromId;
 const buildMessagePayload = (activity, userId) => {
-  var _text, _text2, _activity$channelData3, _activity$from;
+  var _text, _text2, _activity$channelData2, _activity$from;
   return {
     // To identify hidden contents vs empty content
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -47,7 +76,7 @@ const buildMessagePayload = (activity, userId) => {
     type: activity === null || activity === void 0 ? void 0 : activity.type,
     timestamp: activity === null || activity === void 0 ? void 0 : activity.timestamp,
     userId: userId,
-    tags: activity === null || activity === void 0 ? void 0 : (_activity$channelData3 = activity.channelData) === null || _activity$channelData3 === void 0 ? void 0 : _activity$channelData3.tags,
+    tags: (activity === null || activity === void 0 ? void 0 : (_activity$channelData2 = activity.channelData) === null || _activity$channelData2 === void 0 ? void 0 : _activity$channelData2.tags) || [],
     messageType: "",
     Id: activity === null || activity === void 0 ? void 0 : activity.id,
     role: activity === null || activity === void 0 ? void 0 : (_activity$from = activity.from) === null || _activity$from === void 0 ? void 0 : _activity$from.role,
@@ -73,9 +102,9 @@ const polyfillMessagePayloadForEvent = (activity, payload, conversationId) => {
 };
 exports.polyfillMessagePayloadForEvent = polyfillMessagePayloadForEvent;
 const getScenarioType = activity => {
-  var _activity$from3, _activity$channelData4;
+  var _activity$from3, _activity$channelData3;
   const role = activity === null || activity === void 0 ? void 0 : (_activity$from3 = activity.from) === null || _activity$from3 === void 0 ? void 0 : _activity$from3.role;
-  const tags = activity === null || activity === void 0 ? void 0 : (_activity$channelData4 = activity.channelData) === null || _activity$channelData4 === void 0 ? void 0 : _activity$channelData4.tags;
+  const tags = activity === null || activity === void 0 ? void 0 : (_activity$channelData3 = activity.channelData) === null || _activity$channelData3 === void 0 ? void 0 : _activity$channelData3.tags;
   if (role === _Constants2.Constants.userMessageTag) {
     return _Constants.ScenarioType.UserSendMessageStrategy;
   }

package/lib/cjs/plugins/newMessageEventHandler.js

@@ -12,13 +12,13 @@ var _Constants2 = require("../common/Constants");
 var _FirstResponseLatencyTracker = require("../firstresponselatency/FirstResponseLatencyTracker");
 var _TelemetryHelper = require("../common/telemetry/TelemetryHelper");
 var _TelemetryManager = require("../common/telemetry/TelemetryManager");
-const createOnNewAdapterActivityHandler = (chatId, userId) => {
+const createOnNewAdapterActivityHandler = (chatId, userId, startTime) => {
   // Hooking the message tracker in the listener, a bit invasive but easier to control.
   const firstResponseLatencyTracker = new _FirstResponseLatencyTracker.FirstResponseLatencyTracker();
   // epoch time in utc for when start to listen.
   // We dont longer have a mechanism to know if a message is history or new, so any message older than the time we start listening will be considered a history message.
   // this is a workaround for the fact that we dont have a way to identify if a message is history or new, and it will provide consistency across different scenarios
-  const startTime = new Date().getTime();
+
   let isHistoryMessageReceivedEventRaised = false;
   const onNewAdapterActivityHandler = activity => {
     raiseMessageEvent(activity);
@@ -41,6 +41,7 @@ const createOnNewAdapterActivityHandler = (chatId, userId) => {
     });
   };
   const systemMessageStrategy = activity => {
+    var _TelemetryManager$Int3;
     const payload = (0, _util.buildMessagePayload)(activity, userId);
     payload.messageType = _Constants2.Constants.systemMessageTag;
     if ((0, _util.isHistoryMessage)(activity, startTime)) {
@@ -48,6 +49,11 @@ const createOnNewAdapterActivityHandler = (chatId, userId) => {
       historyMessageStrategy((0, _util.polyfillMessagePayloadForEvent)(activity, payload, (_TelemetryManager$Int2 = _TelemetryManager.TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int2 === void 0 ? void 0 : _TelemetryManager$Int2.conversationId));
       return;
     }
+    const newMessageReceivedEvent = {
+      eventName: _TelemetryConstants.BroadcastEvent.NewMessageReceived,
+      payload: (0, _util.polyfillMessagePayloadForEvent)(activity, payload, (_TelemetryManager$Int3 = _TelemetryManager.TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int3 === void 0 ? void 0 : _TelemetryManager$Int3.conversationId)
+    };
+    _omnichannelChatComponents.BroadcastService.postMessage(newMessageReceivedEvent);
     _TelemetryHelper.TelemetryHelper.logActionEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {
       Event: _TelemetryConstants.TelemetryEvent.SystemMessageReceived,
       Description: "System message received"
@@ -83,20 +89,20 @@ const createOnNewAdapterActivityHandler = (chatId, userId) => {
     return true;
   };
   const receivedMessageStrategy = activity => {
-    var _TelemetryManager$Int4;
+    var _TelemetryManager$Int5;
     if (!isValidMessage(activity)) return;
     const isHistoryMessageReceived = (0, _util.isHistoryMessage)(activity, startTime);
     const payload = (0, _util.buildMessagePayload)(activity, userId);
     payload.messageType = _Constants2.Constants.userMessageTag;
     if (isHistoryMessageReceived) {
-      var _TelemetryManager$Int3;
-      historyMessageStrategy((0, _util.polyfillMessagePayloadForEvent)(activity, payload, (_TelemetryManager$Int3 = _TelemetryManager.TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int3 === void 0 ? void 0 : _TelemetryManager$Int3.conversationId));
+      var _TelemetryManager$Int4;
+      historyMessageStrategy((0, _util.polyfillMessagePayloadForEvent)(activity, payload, (_TelemetryManager$Int4 = _TelemetryManager.TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int4 === void 0 ? void 0 : _TelemetryManager$Int4.conversationId));
       return;
     }
     firstResponseLatencyTracker.stopClock(payload);
     const newMessageReceivedEvent = {
       eventName: _TelemetryConstants.BroadcastEvent.NewMessageReceived,
-      payload: (0, _util.polyfillMessagePayloadForEvent)(activity, payload, (_TelemetryManager$Int4 = _TelemetryManager.TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int4 === void 0 ? void 0 : _TelemetryManager$Int4.conversationId)
+      payload: (0, _util.polyfillMessagePayloadForEvent)(activity, payload, (_TelemetryManager$Int5 = _TelemetryManager.TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int5 === void 0 ? void 0 : _TelemetryManager$Int5.conversationId)
     };
     _omnichannelChatComponents.BroadcastService.postMessage(newMessageReceivedEvent);
     _TelemetryHelper.TelemetryHelper.logActionEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {

package/lib/esm/common/Constants.js

@@ -16,6 +16,9 @@ _defineProperty(Constants, "channelMessageTag", "channel");
 _defineProperty(Constants, "historyMessageTag", "history");
 _defineProperty(Constants, "agentEndConversationMessageTag", "agentendconversation");
 _defineProperty(Constants, "supervisorForceCloseMessageTag", "supervisorforceclosedconversation");
+_defineProperty(Constants, "endConversationalSurveyMessageTag", "endconversationalsurvey");
+_defineProperty(Constants, "startConversationalSurveyMessageTag", "startconversationalsurvey");
+_defineProperty(Constants, "c2ConversationalSurveyMessageTag", "c2conversationalsurvey");
 _defineProperty(Constants, "receivedMessageClassName", "ms_lcw_webchat_received_message");
 _defineProperty(Constants, "sentMessageClassName", "ms_lcw_webchat_sent_message");
 _defineProperty(Constants, "webchatChannelId", "webchat");
@@ -105,8 +108,7 @@ _defineProperty(Constants, "TargetRelationshipAttributes", "noopener noreferrer"
 // Markdown icons
 _defineProperty(Constants, "OpenLinkIconCssClass", "webchat__render-markdown__external-link-icon");
 // internet connection test
-_defineProperty(Constants, "internetConnectionTestUrl", "https://ocsdk-prod.azureedge.net/public/connecttest.txt");
-_defineProperty(Constants, "internetConnectionTestUrlText", "Omnichannel Connect Test");
+_defineProperty(Constants, "internetConnectionTestPath", "/livechatwidget/version.txt");
 _defineProperty(Constants, "ChatWidgetStateChangedPrefix", "ChatWidgetStateChanged");
 _defineProperty(Constants, "PostChatLoadingDurationInMs", 2000);
 _defineProperty(Constants, "BrowserUnloadConfirmationMessage", "Do you want to leave chat?");
@@ -122,6 +124,12 @@ _defineProperty(Constants, "InitContextParamsResponse", "initContextParamsRespon
 _defineProperty(Constants, "OCOriginalMessageId", "OriginalMessageId");
 _defineProperty(Constants, "WebchatSequenceIdAttribute", "webchat:sequence-id");
 _defineProperty(Constants, "MessageSequenceIdOverride", "MessageSequenceIdOverride");
+_defineProperty(Constants, "sendCustomEvent", "sendCustomEvent");
+_defineProperty(Constants, "onCustomEvent", "onCustomEvent");
+_defineProperty(Constants, "customEventName", "customEventName");
+_defineProperty(Constants, "customEventValue", "customEventValue");
+_defineProperty(Constants, "Hidden", "Hidden");
+_defineProperty(Constants, "EndConversationDueToOverflow", "endconversationduetooverflow");
 export const Regex = (_class = /*#__PURE__*/_createClass(function Regex() {
   _classCallCheck(this, Regex);
 }), _defineProperty(_class, "EmailRegex", "^(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*\")@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?)*|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\])$"), _class);
@@ -220,6 +228,10 @@ export let ConversationMode;
   ConversationMode["Regular"] = "192350000";
   ConversationMode["Persistent"] = "192350001";
 })(ConversationMode || (ConversationMode = {}));
+export let SurveyProvider;
+(function (SurveyProvider) {
+  SurveyProvider["MicrosoftCopilotStudio"] = "600990001";
+})(SurveyProvider || (SurveyProvider = {}));
 export let LiveWorkItemState;
 (function (LiveWorkItemState) {
   LiveWorkItemState["Active"] = "Active";

package/lib/esm/common/telemetry/TelemetryConstants.js

@@ -184,6 +184,7 @@ export let TelemetryEvent;
   TelemetryEvent["BotAuthActivityUndefinedSignInId"] = "BotAuthActivityUndefinedSignInId";
   TelemetryEvent["ThirdPartyCookiesBlocked"] = "ThirdPartyCookiesBlocked";
   TelemetryEvent["ParticipantsRemovedEvent"] = "ParticipantsRemovedEvent";
+  TelemetryEvent["QueueOverflowEvent"] = "QueueOverflowEvent";
   TelemetryEvent["ProcessingHTMLTextMiddlewareFailed"] = "ProcessingHTMLTextMiddlewareFailed";
   TelemetryEvent["ProcessingSanitizationMiddlewareFailed"] = "ProcessingSanitizationMiddlewareFailed";
   TelemetryEvent["FormatTagsMiddlewareJSONStringifyFailed"] = "FormatTagsMiddlewareJSONStringifyFailed";
@@ -222,6 +223,7 @@ export let TelemetryEvent;
   TelemetryEvent["SystemMessageReceived"] = "SystemMessageReceived";
   TelemetryEvent["RehydrateMessageReceived"] = "RehydrateMessageReceived";
   TelemetryEvent["CustomContextReceived"] = "CustomContextReceived";
+  TelemetryEvent["CustomEventAction"] = "CustomEventAction";
   TelemetryEvent["NetworkDisconnected"] = "NetworkDisconnected";
   TelemetryEvent["NetworkReconnected"] = "NetworkReconnected";
   TelemetryEvent["LinkModePostChatWorkflowStarted"] = "LinkModePostChatWorkflowStarted";

package/lib/esm/common/utils.js

@@ -453,4 +453,25 @@ export function getDeviceType() {
   } else {
     return "standard";
   }
+}
+
+//Bots expect a payload containing:
+//1. customEventName: this should be string describe the event name
+//2. customEventValue: given the value is from customer with unknown type, it is required to stringify the payload later
+export const isValidCustomEvent = payload => {
+  if (Constants.customEventName in payload && payload.customEventName && typeof payload.customEventName === Constants.String && Constants.customEventValue in payload && payload.customEventValue) return true;
+  return false;
+};
+export const getCustomEventValue = customEventPayload => {
+  let returnVal = "";
+  try {
+    returnVal = typeof customEventPayload.customEventValue === Constants.String ? customEventPayload.customEventValue : JSON.stringify(customEventPayload.customEventValue);
+  } catch (error) {
+    console.error(error);
+  }
+  return returnVal;
+};
+export function isEndConversationDueToOverflowActivity(activity) {
+  var _activity$channelData, _activity$channelData2;
+  return (activity === null || activity === void 0 ? void 0 : (_activity$channelData = activity.channelData) === null || _activity$channelData === void 0 ? void 0 : _activity$channelData.tags) && Array.isArray(activity === null || activity === void 0 ? void 0 : (_activity$channelData2 = activity.channelData) === null || _activity$channelData2 === void 0 ? void 0 : _activity$channelData2.tags) && activity.channelData.tags.includes(Constants.EndConversationDueToOverflow);
 }

package/lib/esm/components/chatbuttonstateful/ChatButtonStateful.js

@@ -65,7 +65,6 @@ export const ChatButtonStateful = props => {
   };
   const outOfOfficeStyleProps = Object.assign({}, defaultOutOfOfficeChatButtonStyleProps, outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.styleProps);
   const controlProps = {
-    ...(buttonProps === null || buttonProps === void 0 ? void 0 : buttonProps.controlProps),
     id: "oc-lcw-chat-button",
     dir: state.domainStates.globalDir,
     titleText: "Let's Chat!",
@@ -74,7 +73,8 @@ export const ChatButtonStateful = props => {
     unreadMessageCount: state.appStates.unreadMessageCount ? state.appStates.unreadMessageCount > Constants.maximumUnreadMessageCount ? (_props$buttonProps = props.buttonProps) === null || _props$buttonProps === void 0 ? void 0 : (_props$buttonProps$co = _props$buttonProps.controlProps) === null || _props$buttonProps$co === void 0 ? void 0 : _props$buttonProps$co.largeUnreadMessageString : state.appStates.unreadMessageCount.toString() : "0",
     unreadMessageString: (_props$buttonProps2 = props.buttonProps) === null || _props$buttonProps2 === void 0 ? void 0 : (_props$buttonProps2$c = _props$buttonProps2.controlProps) === null || _props$buttonProps2$c === void 0 ? void 0 : _props$buttonProps2$c.unreadMessageString,
     // Regular chat button onClick - this will always take precedence
-    onClick: () => ref.current()
+    onClick: () => ref.current(),
+    ...(buttonProps === null || buttonProps === void 0 ? void 0 : buttonProps.controlProps)
   };
   const outOfOfficeControlProps = {
     // Only take specific properties from outOfOfficeButtonProps, never onClick
@@ -83,7 +83,6 @@ export const ChatButtonStateful = props => {
     titleText: (outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : (_outOfOfficeButtonPro = outOfOfficeButtonProps.controlProps) === null || _outOfOfficeButtonPro === void 0 ? void 0 : _outOfOfficeButtonPro.titleText) || "We're Offline",
     subtitleText: (outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : (_outOfOfficeButtonPro2 = outOfOfficeButtonProps.controlProps) === null || _outOfOfficeButtonPro2 === void 0 ? void 0 : _outOfOfficeButtonPro2.subtitleText) || "No agents available",
     unreadMessageString: (_props$buttonProps3 = props.buttonProps) === null || _props$buttonProps3 === void 0 ? void 0 : (_props$buttonProps3$c = _props$buttonProps3.controlProps) === null || _props$buttonProps3$c === void 0 ? void 0 : _props$buttonProps3$c.unreadMessageString,
-    ...(outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.controlProps),
     // Out-of-office specific onClick - this will ALWAYS take precedence
     onClick: () => {
       if (state.appStates.isMinimized) {
@@ -96,7 +95,8 @@ export const ChatButtonStateful = props => {
         type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
         payload: ConversationState.OutOfOffice
       });
-    }
+    },
+    ...(outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.controlProps)
   };
   useEffect(() => {
     TelemetryHelper.logLoadingEvent(LogLevel.INFO, {