@microsoft/omnichannel-chat-widget 1.8.2-main.fc93d3d → 1.8.3-main.1381896

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,9 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.polyfillMessagePayloadForEvent = exports.isHistoryMessage = exports.getScenarioType = exports.extractTimestampFromId = exports.createTrackingMessage = exports.buildMessagePayload = void 0;
+exports.polyfillMessagePayloadForEvent = exports.maskPayloadText = 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.
  * 
@@ -23,19 +25,21 @@ var _Constants2 = require("../common/Constants");
  *   - If the ID is valid and the timestamp is older than the start time, the message is historical.
  */
 const isHistoryMessage = (activity, startTime) => {
-  var _activity$channelData, _activity$channelData2;
+  var _activity$channelData;
   // Only process message activities
   if ((activity === null || activity === void 0 ? void 0 : activity.type) !== _Constants2.Constants.message) {
     return false;
   }
 
-  // Legacy check for history message tag
-  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)) {
+  // 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 isOlderThanStartTime = activityId < startTime;
+  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;
 };
@@ -64,7 +68,7 @@ const extractTimestampFromId = activity => {
 };
 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
@@ -72,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,
@@ -98,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;
   }
@@ -122,4 +126,14 @@ const createTrackingMessage = (payload, type) => {
     checkTime: new Date().getTime()
   };
 };
-exports.createTrackingMessage = createTrackingMessage;
+exports.createTrackingMessage = createTrackingMessage;
+const maskPayloadText = payload => {
+  if (!payload) {
+    return payload;
+  }
+  return {
+    ...payload,
+    text: "*contents hidden*"
+  };
+};
+exports.maskPayloadText = maskPayloadText;

package/lib/cjs/index.js

@@ -14,7 +14,8 @@ var _exportNames = {
   useChatSDKStore: true,
   useFacadeChatSDKStore: true,
   LiveChatWidget: true,
-  getMockChatSDKIfApplicable: true
+  getMockChatSDKIfApplicable: true,
+  LiveChatWidgetMockType: true
 };
 Object.defineProperty(exports, "BroadcastService", {
   enumerable: true,
@@ -34,6 +35,12 @@ Object.defineProperty(exports, "LiveChatWidget", {
     return _LiveChatWidget.default;
   }
 });
+Object.defineProperty(exports, "LiveChatWidgetMockType", {
+  enumerable: true,
+  get: function () {
+    return _IMockProps.LiveChatWidgetMockType;
+  }
+});
 Object.defineProperty(exports, "decodeComponentString", {
   enumerable: true,
   get: function () {
@@ -90,6 +97,7 @@ var _useChatSDKStore = _interopRequireDefault(require("./hooks/useChatSDKStore")
 var _useFacadeChatSDKStore = _interopRequireDefault(require("./hooks/useFacadeChatSDKStore"));
 var _LiveChatWidget = _interopRequireDefault(require("./components/livechatwidget/LiveChatWidget"));
 var _getMockChatSDKIfApplicable = require("./components/livechatwidget/common/getMockChatSDKIfApplicable");
+var _IMockProps = require("./components/livechatwidget/interfaces/IMockProps");
 var _renderingmiddlewares = require("./components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares");
 Object.keys(_renderingmiddlewares).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/lib/cjs/plugins/createChatTranscript.js

@@ -705,10 +705,23 @@ const createChatTranscript = async function (transcript, facadeChatSDK) {
       reader.readAsDataURL(blob);
     });
   };
+
+  // Configure DOMPurify to remove target attribute from br tags
+  const hook = function (node) {
+    // eslint-disable-line @typescript-eslint/no-explicit-any
+    // Remove target attribute from br tags as it causes them to display as literal text
+    if (node.tagName === "BR" && node.hasAttribute("target")) {
+      node.removeAttribute("target");
+    }
+  };
+  _dompurify.default.addHook("afterSanitizeAttributes", hook);
   let messages = transcriptMessages.filter(message => {
     message.content = _dompurify.default.sanitize(message.content);
     return message;
   });
+
+  // Clean up the hook after processing all messages
+  _dompurify.default.removeHook("afterSanitizeAttributes", hook);
   if (renderAttachments) {
     messages = await Promise.all(transcriptMessages.map(async message => {
       // eslint-disable-line @typescript-eslint/no-explicit-any

package/lib/cjs/plugins/newMessageEventHandler.js

@@ -71,7 +71,7 @@ const createOnNewAdapterActivityHandler = (chatId, userId, startTime) => {
       _TelemetryHelper.TelemetryHelper.logActionEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {
         Event: _TelemetryConstants.TelemetryEvent.RehydrateMessageReceived,
         Description: "History message received",
-        CustomProperties: payload
+        CustomProperties: (0, _util.maskPayloadText)(payload)
       });
     }
   };
@@ -108,7 +108,7 @@ const createOnNewAdapterActivityHandler = (chatId, userId, startTime) => {
     _TelemetryHelper.TelemetryHelper.logActionEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {
       Event: _TelemetryConstants.TelemetryEvent.MessageReceived,
       Description: "New message received",
-      CustomProperties: payload
+      CustomProperties: (0, _util.maskPayloadText)(payload)
     });
   };
   const raiseMessageEvent = activity => {

package/lib/esm/common/Constants.js

@@ -25,6 +25,7 @@ _defineProperty(Constants, "webchatChannelId", "webchat");
 _defineProperty(Constants, "markdown", "markdown");
 _defineProperty(Constants, "actionType", "actionType");
 _defineProperty(Constants, "markDownSystemMessageClass", "webchat__basic-transcript__activity-markdown-body");
+_defineProperty(Constants, "MARKDOWN_LIST_INDENTATION", "   ");
 _defineProperty(Constants, "String", "string");
 _defineProperty(Constants, "ChatMessagesJson", "chatMessagesJson");
 _defineProperty(Constants, "truePascal", "True");
@@ -108,8 +109,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?");
@@ -125,6 +125,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);
@@ -178,6 +184,8 @@ _defineProperty(HtmlAttributeNames, "adaptiveCardClassName", "ac-adaptiveCard");
 _defineProperty(HtmlAttributeNames, "adaptiveCardTextBlockClassName", "ac-textBlock");
 _defineProperty(HtmlAttributeNames, "adaptiveCardToggleInputClassName", "ac-toggleInput");
 _defineProperty(HtmlAttributeNames, "adaptiveCardActionSetClassName", "ac-actionSet");
+_defineProperty(HtmlAttributeNames, "ocwCitationPaneClassName", "ocw-citation-pane");
+_defineProperty(HtmlAttributeNames, "ocwCitationPaneTitle", "Citation");
 export let WebChatMiddlewareConstants = /*#__PURE__*/_createClass(function WebChatMiddlewareConstants() {
   _classCallCheck(this, WebChatMiddlewareConstants);
 });

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

@@ -148,6 +148,7 @@ export let TelemetryEvent;
   TelemetryEvent["EmailTranscriptLoaded"] = "EmailTranscriptLoaded";
   TelemetryEvent["OutOfOfficePaneLoaded"] = "OutOfOfficePaneLoaded";
   TelemetryEvent["ConfirmationPaneLoaded"] = "ConfirmationPaneLoaded";
+  TelemetryEvent["CitationPaneLoaded"] = "CitationPaneLoaded";
   TelemetryEvent["ProactiveChatPaneLoaded"] = "ProactiveChatPaneLoaded";
   TelemetryEvent["ReconnectChatPaneLoaded"] = "ReconnectChatPaneLoaded";
   TelemetryEvent["HeaderCloseButtonClicked"] = "HeaderCloseButtonClicked";
@@ -184,10 +185,12 @@ export let TelemetryEvent;
   TelemetryEvent["BotAuthActivityUndefinedSignInId"] = "BotAuthActivityUndefinedSignInId";
   TelemetryEvent["ThirdPartyCookiesBlocked"] = "ThirdPartyCookiesBlocked";
   TelemetryEvent["ParticipantsRemovedEvent"] = "ParticipantsRemovedEvent";
+  TelemetryEvent["QueueOverflowEvent"] = "QueueOverflowEvent";
   TelemetryEvent["ProcessingHTMLTextMiddlewareFailed"] = "ProcessingHTMLTextMiddlewareFailed";
   TelemetryEvent["ProcessingSanitizationMiddlewareFailed"] = "ProcessingSanitizationMiddlewareFailed";
   TelemetryEvent["FormatTagsMiddlewareJSONStringifyFailed"] = "FormatTagsMiddlewareJSONStringifyFailed";
   TelemetryEvent["AttachmentUploadValidatorMiddlewareFailed"] = "AttachmentUploadValidatorMiddlewareFailed";
+  TelemetryEvent["CitationMiddlewareFailed"] = "CitationMiddlewareFailed";
   TelemetryEvent["QueuePositionMessageRecieved"] = "QueuePositionMessageRecieved";
   TelemetryEvent["AverageWaitTimeMessageRecieved"] = "AverageWaitTimeMessageRecieved";
   TelemetryEvent["DataMaskingRuleApplied"] = "DataMaskingRuleApplied";
@@ -222,6 +225,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";
@@ -271,7 +275,9 @@ export let TelemetryEvent;
   TelemetryEvent["UXLCWChatButtonLoadingStart"] = "UXLCWChatButtonLoadingStart";
   TelemetryEvent["UXLCWChatButtonLoadingCompleted"] = "UXLCWChatButtonLoadingCompleted";
   TelemetryEvent["UXConfirmationPaneStart"] = "UXConfirmationPaneStart";
+  TelemetryEvent["UXCitationPaneStart"] = "UXCitationPaneStart";
   TelemetryEvent["UXConfirmationPaneCompleted"] = "UXConfirmationPaneCompleted";
+  TelemetryEvent["UXCitationPaneCompleted"] = "UXCitationPaneCompleted";
   TelemetryEvent["UXLiveChatWidgetStart"] = "UXLiveChatWidgetStart";
   TelemetryEvent["UXLiveChatWidgetCompleted"] = "UXLiveChatWidgetCompleted";
   TelemetryEvent["AppInsightsInitialized"] = "AppInsightsInitialized";

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

@@ -230,11 +230,13 @@ export let TelemetryHelper = /*#__PURE__*/function () {
   }, {
     key: "postTelemetryEvent",
     value: function postTelemetryEvent(eventName, logLevel, payload) {
+      var _TelemetryManager$Int16;
       const telemetryEvent = {
         eventName,
         logLevel,
         payload: {
-          ...payload
+          ...payload,
+          runtimeId: (_TelemetryManager$Int16 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int16 === void 0 ? void 0 : _TelemetryManager$Int16.lcwRuntimeId
         }
       };
       BroadcastService.postMessage(telemetryEvent);
@@ -260,11 +262,11 @@ _defineProperty(TelemetryHelper, "logActionEvent", (logLevel, payload) => {
   TelemetryHelper.postTelemetryEvent((payload === null || payload === void 0 ? void 0 : payload.Event) ?? "", logLevel, payload);
 });
 _defineProperty(TelemetryHelper, "logSDKEvent", (logLevel, payload) => {
-  var _TelemetryManager$Int16;
+  var _TelemetryManager$Int17;
   TelemetryHelper.postTelemetryEvent((payload === null || payload === void 0 ? void 0 : payload.Event) ?? "", logLevel, {
     ...payload,
     TransactionId: newGuid(),
-    RequestId: (_TelemetryManager$Int16 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int16 === void 0 ? void 0 : _TelemetryManager$Int16.currentRequestId
+    RequestId: (_TelemetryManager$Int17 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int17 === void 0 ? void 0 : _TelemetryManager$Int17.currentRequestId
   });
 });
 _defineProperty(TelemetryHelper, "logConfigDataEvent", (logLevel, payload) => {
@@ -299,12 +301,12 @@ _defineProperty(TelemetryHelper, "logFacadeChatSDKEventToAllTelemetry", (logLeve
   });
 });
 _defineProperty(TelemetryHelper, "logSDKEventToAllTelemetry", (logLevel, payload) => {
-  var _TelemetryManager$Int17;
+  var _TelemetryManager$Int18;
   TelemetryHelper.postTelemetryEvent((payload === null || payload === void 0 ? void 0 : payload.Event) ?? "", logLevel, {
     ...{
       ...payload,
       TransactionId: newGuid(),
-      RequestId: (_TelemetryManager$Int17 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int17 === void 0 ? void 0 : _TelemetryManager$Int17.currentRequestId
+      RequestId: (_TelemetryManager$Int18 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int18 === void 0 ? void 0 : _TelemetryManager$Int18.currentRequestId
     },
     LogToAll: true
   });

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);
 }