@microsoft/omnichannel-chat-widget 1.7.8-main.7a07fc5 → 1.7.8-main.ab4d3b4

package/lib/esm/firstresponselatency/FirstResponseLatencyTracker.js

@@ -0,0 +1,172 @@
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+import { BroadcastEvent, LogLevel, TelemetryEvent } from "../common/telemetry/TelemetryConstants";
+import { BroadcastService } from "@microsoft/omnichannel-chat-components";
+import { TelemetryHelper } from "../common/telemetry/TelemetryHelper";
+export class FirstResponseLatencyTracker {
+  constructor() {
+    _defineProperty(this, "isABotConversation", false);
+    _defineProperty(this, "isStarted", false);
+    _defineProperty(this, "isEnded", false);
+    _defineProperty(this, "startTrackingMessage", void 0);
+    _defineProperty(this, "stopTrackingMessage", void 0);
+    _defineProperty(this, "isReady", false);
+    _defineProperty(this, "offlineNetworkListener", BroadcastService.getMessageByEventName(TelemetryEvent.NetworkDisconnected).subscribe(() => {
+      this.isStarted = false;
+      this.isEnded = false;
+      TelemetryHelper.logActionEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.MessageStopLapTrackError,
+        Description: "Tracker Stopped due to network disconnection"
+      });
+    }));
+    _defineProperty(this, "fmltrackingListener", BroadcastService.getMessageByEventName(BroadcastEvent.FMLTrackingCompleted).subscribe(() => {
+      this.isReady = true;
+      BroadcastService.postMessage({
+        eventName: BroadcastEvent.FMLTrackingCompletedAck,
+        payload: null
+      });
+    }));
+    // 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
+    _defineProperty(this, "rehydrateListener", BroadcastService.getMessageByEventName(TelemetryEvent.RehydrateMessageReceived).subscribe(() => {
+      this.isReady = true;
+    }));
+    // 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
+    _defineProperty(this, "historyListener", BroadcastService.getMessageByEventName(BroadcastEvent.HistoryMessageReceived).subscribe(() => {
+      this.isReady = true;
+    }));
+    // this is a workaround to ensure in reload we track effectively the messages
+    // we do have a mechanism in place to prevent log agent messages.
+    this.isABotConversation = true;
+  }
+  createTrackingMessage(payload, type) {
+    return {
+      Id: payload.Id,
+      role: payload.role,
+      timestamp: payload === null || payload === void 0 ? void 0 : payload.timestamp,
+      tags: payload.tags,
+      messageType: payload.messageType,
+      text: payload.text,
+      type: type,
+      checkTime: new Date().getTime()
+    };
+  }
+
+  // Tracking Functions
+  startTracking(payload) {
+    if (!this.isReady) return;
+    //  this prevents to initiate tracking for multiple incoming messages
+    if (this.isStarted) {
+      return;
+    }
+    // this is to ensure we track only messages where bot is engaged
+    if (!this.isABotConversation) {
+      return;
+    }
+    // control of states to prevent clashing of messages
+    this.isStarted = true;
+    this.isEnded = false;
+    // The idea  of using types is to enrich telemetry data 
+    this.startTrackingMessage = this.createTrackingMessage(payload, "userMessage");
+  }
+  handleAgentMessage(payload) {
+    var _payload$tags;
+    // this tag so far is only present in agent messages
+    if (payload !== null && payload !== void 0 && (_payload$tags = payload.tags) !== null && _payload$tags !== void 0 && _payload$tags.includes("public")) {
+      this.deregister();
+    }
+  }
+  stopTracking(payload) {
+    var _this$stopTrackingMes, _this$startTrackingMe;
+    // this prevents execution for multiple incoming messages from the bot.
+    if (this.isEnded && !this.isStarted) {
+      return;
+    }
+
+    // control of states to prevent clashing of messages
+    this.isEnded = true;
+    this.isStarted = false;
+
+    // The idea  of using types is to enrich telemetry data 
+    this.stopTrackingMessage = this.createTrackingMessage(payload, "botMessage");
+    // calculating elapsed time
+    const elapsedTime = (((_this$stopTrackingMes = this.stopTrackingMessage) === null || _this$stopTrackingMes === void 0 ? void 0 : _this$stopTrackingMes.checkTime) ?? 0) - (((_this$startTrackingMe = this.startTrackingMessage) === null || _this$startTrackingMe === void 0 ? void 0 : _this$startTrackingMe.checkTime) ?? 0);
+    TelemetryHelper.logActionEvent(LogLevel.INFO, {
+      Event: TelemetryEvent.MessageLapTrack,
+      Description: "First response latency tracking",
+      CustomProperties: {
+        elapsedTime,
+        userMessage: this.startTrackingMessage,
+        botMessage: this.stopTrackingMessage
+      }
+    });
+  }
+
+  // mechanism to ensure we track only allowed conversations
+  isMessageFromValidSender(payload) {
+    var _payload$tags2;
+    // agent scenario
+    if (payload !== null && payload !== void 0 && (_payload$tags2 = payload.tags) !== null && _payload$tags2 !== void 0 && _payload$tags2.includes("public")) {
+      this.handleAgentMessage(payload);
+      return false;
+    }
+    return true;
+  }
+  startClock(payload) {
+    try {
+      if (!payload || !payload.Id) {
+        throw new Error("Invalid payload");
+      }
+      this.startTracking(payload);
+    } catch (e) {
+      TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+        Event: TelemetryEvent.MessageStartLapTrackError,
+        Description: "Error while starting the clock",
+        ExceptionDetails: e,
+        CustomProperties: {
+          payload: payload
+        }
+      });
+    }
+  }
+  stopClock(payload) {
+    try {
+      if (!payload || !payload.Id) {
+        throw new Error("Invalid payload");
+      }
+      if (!this.isMessageFromValidSender(payload)) return;
+      if (this.isABotConversation && this.isStarted) {
+        this.stopTracking(payload);
+      }
+    } catch (e) {
+      console.error("FRL : error while trying to stop the tracker", e);
+      TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+        Event: TelemetryEvent.MessageStopLapTrackError,
+        Description: "Error while stopping the clock",
+        ExceptionDetails: e,
+        CustomProperties: {
+          payload: payload
+        }
+      });
+      //reset state
+      this.startTrackingMessage = undefined;
+      this.stopTrackingMessage = undefined;
+      this.isStarted = false;
+      this.isEnded = false;
+    }
+  }
+  deregister() {
+    // Reset State
+    this.isABotConversation = false;
+    this.isStarted = false;
+    this.isEnded = false;
+    this.startTrackingMessage = undefined;
+    this.stopTrackingMessage = undefined;
+    this.offlineNetworkListener.unsubscribe();
+    this.fmltrackingListener.unsubscribe();
+    this.rehydrateListener.unsubscribe();
+    this.historyListener.unsubscribe();
+  }
+}

package/lib/esm/firstresponselatency/util.js

@@ -0,0 +1,87 @@
+import { ScenarioType } from "./Constants";
+import { Constants } from "../common/Constants";
+export const isHistoryMessage = (activity, startTime) => {
+  try {
+    if ((activity === null || activity === void 0 ? void 0 : activity.type) === 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(Constants.historyMessageTag)) return true;
+
+      // 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);
+
+        // if the activity id is not a number, we default to new message
+        if (isNaN(activityId)) {
+          return false;
+        }
+
+        // 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);
+  }
+  return false;
+};
+export const buildMessagePayload = (activity, userId) => {
+  var _text, _text2, _activity$channelData3, _activity$from;
+  return {
+    // To identify hidden contents vs empty content
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    text: (activity === null || activity === void 0 ? void 0 : (_text = activity.text) === null || _text === void 0 ? void 0 : _text.length) >= 1 ? `*contents hidden (${activity === null || activity === void 0 ? void 0 : (_text2 = activity.text) === null || _text2 === void 0 ? void 0 : _text2.length} chars)*` : "",
+    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,
+    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,
+    isChatComplete: false
+  };
+};
+export const polyfillMessagePayloadForEvent = (activity, payload, conversationId) => {
+  var _activity$conversatio, _attachments, _activity$from2;
+  return {
+    ...payload,
+    channelData: activity === null || activity === void 0 ? void 0 : activity.channelData,
+    chatId: activity === null || activity === void 0 ? void 0 : (_activity$conversatio = activity.conversation) === null || _activity$conversatio === void 0 ? void 0 : _activity$conversatio.id,
+    conversationId: conversationId,
+    Id: activity === null || activity === void 0 ? void 0 : activity.id,
+    isChatComplete: false,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    text: activity === null || activity === void 0 ? void 0 : activity.text,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    attachment: (activity === null || activity === void 0 ? void 0 : (_attachments = activity.attachments) === null || _attachments === void 0 ? void 0 : _attachments.length) >= 1 ? activity === null || activity === void 0 ? void 0 : activity.attachments : [],
+    role: activity === null || activity === void 0 ? void 0 : (_activity$from2 = activity.from) === null || _activity$from2 === void 0 ? void 0 : _activity$from2.role
+  };
+};
+export const getScenarioType = activity => {
+  var _activity$from3, _activity$channelData4, _activity$channelData5;
+  if ((activity === null || activity === void 0 ? void 0 : (_activity$from3 = activity.from) === null || _activity$from3 === void 0 ? void 0 : _activity$from3.role) === Constants.userMessageTag) {
+    return ScenarioType.UserSendMessageStrategy;
+  }
+  if (activity !== null && activity !== void 0 && (_activity$channelData4 = activity.channelData) !== null && _activity$channelData4 !== void 0 && (_activity$channelData5 = _activity$channelData4.tags) !== null && _activity$channelData5 !== void 0 && _activity$channelData5.includes(Constants.systemMessageTag)) {
+    return ScenarioType.SystemMessageStrategy;
+  }
+  return ScenarioType.ReceivedMessageStrategy;
+};
+export const createTrackingMessage = (payload, type) => {
+  return {
+    Id: payload.Id,
+    role: payload.role,
+    timestamp: payload === null || payload === void 0 ? void 0 : payload.timestamp,
+    tags: payload.tags,
+    messageType: payload.messageType,
+    text: payload.text,
+    type: type,
+    checkTime: new Date().getTime()
+  };
+};

package/lib/esm/plugins/createChatTranscript.js

@@ -168,7 +168,7 @@ class TranscriptHTMLBuilder {
                 <script>
                     class Translator {
                         static convertTranscriptMessageToActivity(message) {
-                            const {created, OriginalMessageId, id, isControlMessage, content, tags, from, attachments, amsMetadata, amsReferences} = message;
+                            const {created, OriginalMessageId, id, isControlMessage, content, tags, from, attachments, amsMetadata, amsReferences, amsreferences} = message;
                             
                             //it's required to convert the id to a number, otherwise the webchat will not render the messages in the correct order
                             // if the OrginalMessageId is not present, we can use the id as the sequence id, which is always present.
@@ -215,7 +215,7 @@ class TranscriptHTMLBuilder {
                             }
 
                             // Attachments
-                            if (amsReferences && amsMetadata) {
+                            if ((amsReferences || amsreferences) && amsMetadata) {
                                 const metadata = JSON.parse(amsMetadata);
                                 const { fileName } = metadata[0];
                                 const text = \`${this.attachmentMessage}\${fileName}\`;
@@ -239,7 +239,7 @@ class TranscriptHTMLBuilder {
                             // Message
                             if (content) {
                                 // Adaptive card formatting
-                                if (content.includes('"text"') && content.includes('"attachments"') && content.includes('"suggestedActions"')) {
+                                if (content.includes('"attachments"') || content.includes('"suggestedActions"')) {
                                     try {
                                         const partialActivity = JSON.parse(content);
                                         return {
@@ -678,7 +678,7 @@ const createChatTranscript = async function (transcript, facadeChatSDK) {
     messages = await Promise.all(transcriptMessages.map(async message => {
       // eslint-disable-line @typescript-eslint/no-explicit-any
       const {
-        amsReferences,
+        amsReferences = message.amsreferences,
         amsMetadata
       } = message;
       if (amsReferences && amsMetadata) {

package/lib/esm/plugins/newMessageEventHandler.js

@@ -1,100 +1,114 @@
 import { BroadcastEvent, LogLevel, TelemetryEvent } from "../common/telemetry/TelemetryConstants";
+import { ScenarioType } from "../firstresponselatency/Constants";
+import { buildMessagePayload, getScenarioType, isHistoryMessage, polyfillMessagePayloadForEvent } from "../firstresponselatency/util";
 import { BroadcastService } from "@microsoft/omnichannel-chat-components";
 import { Constants } from "../common/Constants";
+import { FirstResponseLatencyTracker } from "../firstresponselatency/FirstResponseLatencyTracker";
 import { TelemetryHelper } from "../common/telemetry/TelemetryHelper";
 import { TelemetryManager } from "../common/telemetry/TelemetryManager";
 export const createOnNewAdapterActivityHandler = (chatId, userId) => {
+  // Hooking the message tracker in the listener, a bit invasive but easier to control.
+  const firstResponseLatencyTracker = new 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 => {
-    var _activity$channelData, _activity$channelData2, _activity$channelData3;
-    const isActivityMessage = (activity === null || activity === void 0 ? void 0 : activity.type) === Constants.message;
-    const isHistoryMessage = isActivityMessage && ((activity === null || activity === void 0 ? void 0 : (_activity$channelData = activity.channelData) === null || _activity$channelData === void 0 ? void 0 : (_activity$channelData2 = _activity$channelData.tags) === null || _activity$channelData2 === void 0 ? void 0 : _activity$channelData2.includes(Constants.historyMessageTag)) || (activity === null || activity === void 0 ? void 0 : (_activity$channelData3 = activity.channelData) === null || _activity$channelData3 === void 0 ? void 0 : _activity$channelData3.fromList));
-    raiseMessageEvent(activity, isHistoryMessage);
+    raiseMessageEvent(activity);
   };
-  let isHistoryMessageReceivedEventRasied = false;
-  const raiseMessageEvent = (activity, isHistoryMessage) => {
+  const userSendMessageStrategy = activity => {
+    var _TelemetryManager$Int;
+    const payload = buildMessagePayload(activity, userId);
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const polyfillMessagePayloadForEvent = payload => {
-      var _activity$conversatio, _TelemetryManager$Int, _attachments;
-      return {
-        ...payload,
-        channelData: activity === null || activity === void 0 ? void 0 : activity.channelData,
-        chatId: activity === null || activity === void 0 ? void 0 : (_activity$conversatio = activity.conversation) === null || _activity$conversatio === void 0 ? void 0 : _activity$conversatio.id,
-        conversationId: (_TelemetryManager$Int = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int === void 0 ? void 0 : _TelemetryManager$Int.conversationId,
-        id: activity === null || activity === void 0 ? void 0 : activity.id,
-        isChatComplete: false,
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        text: activity === null || activity === void 0 ? void 0 : activity.text,
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        attachment: (activity === null || activity === void 0 ? void 0 : (_attachments = activity.attachments) === null || _attachments === void 0 ? void 0 : _attachments.length) >= 1 ? activity === null || activity === void 0 ? void 0 : activity.attachments : []
-      };
+    payload.messageType = Constants.userMessageTag;
+    const newMessageSentEvent = {
+      eventName: BroadcastEvent.NewMessageSent,
+      payload: polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int === void 0 ? void 0 : _TelemetryManager$Int.conversationId)
     };
+    BroadcastService.postMessage(newMessageSentEvent);
+    if (!isHistoryMessage(activity, startTime)) {
+      firstResponseLatencyTracker.startClock(payload);
+    }
+    TelemetryHelper.logActionEvent(LogLevel.INFO, {
+      Event: TelemetryEvent.MessageSent,
+      Description: "New message sent"
+    });
+  };
+  const systemMessageStrategy = activity => {
+    const payload = buildMessagePayload(activity, userId);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    payload.messageType = Constants.systemMessageTag;
+    TelemetryHelper.logActionEvent(LogLevel.INFO, {
+      Event: TelemetryEvent.SystemMessageReceived,
+      Description: "System message received"
+    });
+  };
+  const historyMessageStrategy = payload => {
+    const newMessageReceivedEvent = {
+      eventName: BroadcastEvent.HistoryMessageReceived,
+      payload: payload
+    };
+    BroadcastService.postMessage(newMessageReceivedEvent);
+    if (!isHistoryMessageReceivedEventRaised) {
+      // this is needed for reload scenarios, it helps to identify the last message received before the reload
+      isHistoryMessageReceivedEventRaised = true;
+      TelemetryHelper.logActionEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.RehydrateMessageReceived,
+        Description: "History message received",
+        CustomProperties: payload
+      });
+    }
+  };
+  const isValidMessage = activity => {
+    var _activity$channelData, _activity$channelData2, _activity$channelData3;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const messageHasNoText = !(activity !== null && activity !== void 0 && activity.text);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const messageHasNoTags = !(activity !== null && activity !== void 0 && activity.channelData) || !(activity !== null && activity !== void 0 && (_activity$channelData = activity.channelData) !== null && _activity$channelData !== void 0 && _activity$channelData.tags) || (activity === null || activity === void 0 ? void 0 : (_activity$channelData2 = activity.channelData) === null || _activity$channelData2 === void 0 ? void 0 : (_activity$channelData3 = _activity$channelData2.tags) === null || _activity$channelData3 === void 0 ? void 0 : _activity$channelData3.length) === 0;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const messageHasNoAttachments = !(activity !== null && activity !== void 0 && activity.attachments) || (activity === null || activity === void 0 ? void 0 : activity.attachments.length) === 0;
+    if (messageHasNoTags && messageHasNoText && messageHasNoAttachments) {
+      return false;
+    }
+    return true;
+  };
+  const receivedMessageStrategy = activity => {
+    var _TelemetryManager$Int3;
+    if (!isValidMessage(activity)) return;
+    const isHistoryMessageReceived = isHistoryMessage(activity, startTime);
+    const payload = buildMessagePayload(activity, userId);
+    payload.messageType = Constants.userMessageTag;
+    if (isHistoryMessageReceived) {
+      var _TelemetryManager$Int2;
+      historyMessageStrategy(polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int2 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int2 === void 0 ? void 0 : _TelemetryManager$Int2.conversationId));
+      return;
+    }
+    firstResponseLatencyTracker.stopClock(payload);
+    const newMessageReceivedEvent = {
+      eventName: BroadcastEvent.NewMessageReceived,
+      payload: polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int3 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int3 === void 0 ? void 0 : _TelemetryManager$Int3.conversationId)
+    };
+    BroadcastService.postMessage(newMessageReceivedEvent);
+    TelemetryHelper.logActionEvent(LogLevel.INFO, {
+      Event: TelemetryEvent.MessageReceived,
+      Description: "New message received",
+      CustomProperties: payload
+    });
+  };
+  const raiseMessageEvent = activity => {
     if ((activity === null || activity === void 0 ? void 0 : activity.type) === Constants.message) {
-      var _text, _text2, _activity$channelData4, _activity$from;
-      const payload = {
-        // To identify hidden contents vs empty content
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        text: (activity === null || activity === void 0 ? void 0 : (_text = activity.text) === null || _text === void 0 ? void 0 : _text.length) >= 1 ? `*contents hidden (${activity === null || activity === void 0 ? void 0 : (_text2 = activity.text) === null || _text2 === void 0 ? void 0 : _text2.length} chars)*` : "",
-        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$channelData4 = activity.channelData) === null || _activity$channelData4 === void 0 ? void 0 : _activity$channelData4.tags,
-        messageType: ""
-      };
-      if ((activity === null || activity === void 0 ? void 0 : (_activity$from = activity.from) === null || _activity$from === void 0 ? void 0 : _activity$from.role) === Constants.userMessageTag) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        payload.messageType = Constants.userMessageTag;
-        const newMessageSentEvent = {
-          eventName: BroadcastEvent.NewMessageSent,
-          payload: polyfillMessagePayloadForEvent(payload)
-        };
-        BroadcastService.postMessage(newMessageSentEvent);
-        TelemetryHelper.logActionEvent(LogLevel.INFO, {
-          Event: TelemetryEvent.MessageSent,
-          Description: "New message sent"
-        });
-      } else {
-        var _activity$channelData5, _activity$channelData6;
-        if (activity !== null && activity !== void 0 && (_activity$channelData5 = activity.channelData) !== null && _activity$channelData5 !== void 0 && (_activity$channelData6 = _activity$channelData5.tags) !== null && _activity$channelData6 !== void 0 && _activity$channelData6.includes(Constants.systemMessageTag)) {
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          payload.messageType = Constants.systemMessageTag;
-          TelemetryHelper.logActionEvent(LogLevel.INFO, {
-            Event: TelemetryEvent.SystemMessageReceived,
-            Description: "System message received"
-          });
-        } else {
-          var _activity$channelData7, _activity$channelData8, _activity$channelData9;
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          const messageHasNoText = !(activity !== null && activity !== void 0 && activity.text);
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          const messageHasNoTags = !(activity !== null && activity !== void 0 && activity.channelData) || !(activity !== null && activity !== void 0 && (_activity$channelData7 = activity.channelData) !== null && _activity$channelData7 !== void 0 && _activity$channelData7.tags) || (activity === null || activity === void 0 ? void 0 : (_activity$channelData8 = activity.channelData) === null || _activity$channelData8 === void 0 ? void 0 : (_activity$channelData9 = _activity$channelData8.tags) === null || _activity$channelData9 === void 0 ? void 0 : _activity$channelData9.length) === 0;
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          const messageHasNoAttachments = !(activity !== null && activity !== void 0 && activity.attachments) || (activity === null || activity === void 0 ? void 0 : activity.attachments.length) === 0;
-          if (messageHasNoTags && messageHasNoText && messageHasNoAttachments) {
-            return;
-          }
-          payload.messageType = Constants.userMessageTag;
-        }
-        const newMessageReceivedEvent = {
-          eventName: isHistoryMessage ? BroadcastEvent.HistoryMessageReceived : BroadcastEvent.NewMessageReceived,
-          payload: polyfillMessagePayloadForEvent(payload)
-        };
-        BroadcastService.postMessage(newMessageReceivedEvent);
-        if (!isHistoryMessage) {
-          TelemetryHelper.logActionEvent(LogLevel.INFO, {
-            Event: TelemetryEvent.MessageReceived,
-            Description: "New message received",
-            CustomProperties: payload
-          });
-        } else {
-          if (!isHistoryMessageReceivedEventRasied) {
-            isHistoryMessageReceivedEventRasied = true;
-            TelemetryHelper.logActionEvent(LogLevel.INFO, {
-              Event: TelemetryEvent.RehydrateMessageReceived,
-              Description: "History message received",
-              CustomProperties: payload
-            });
-          }
-        }
+      const scenarioType = getScenarioType(activity);
+      switch (scenarioType) {
+        case ScenarioType.UserSendMessageStrategy:
+          userSendMessageStrategy(activity);
+          break;
+        case ScenarioType.SystemMessageStrategy:
+          systemMessageStrategy(activity);
+          break;
+        case ScenarioType.ReceivedMessageStrategy:
+          receivedMessageStrategy(activity);
+          break;
       }
     }
   };

package/lib/types/common/telemetry/TelemetryConstants.d.ts

@@ -54,7 +54,9 @@ export declare enum BroadcastEvent {
     UpdateConversationDataForTelemetry = "UpdateConversationDataForTelemetry",
     ContactIdNotFound = "ContactIdNotFound",
     SyncMinimize = "SyncMinimize",
-    OnWidgetError = "OnWidgetError"
+    OnWidgetError = "OnWidgetError",
+    FMLTrackingCompletedAck = "FMLTrackingCompletedAck",
+    FMLTrackingCompleted = "FMLTrackingCompleted"
 }
 export declare enum TelemetryEvent {
     CallAdded = "CallAdded",
@@ -192,6 +194,11 @@ export declare enum TelemetryEvent {
     ReconnectChatMinimize = "ReconnectChatMinimize",
     MessageSent = "MessageSent",
     MessageReceived = "MessageReceived",
+    MessageLapTrack = "MessageLapTrack",
+    BotFirstMessageLapTrack = "BotFirstMessageLapTrackError",
+    BotFirstMessageLapTrackError = "BotFirstMessageLapTrack",
+    MessageStartLapTrackError = "MessageStartLapTrackError",
+    MessageStopLapTrackError = "MessageStopLapTrackError",
     SystemMessageReceived = "SystemMessageReceived",
     RehydrateMessageReceived = "RehydrateMessageReceived",
     CustomContextReceived = "CustomContextReceived",
@@ -206,6 +213,8 @@ export declare enum TelemetryEvent {
     PostChatContextCallFailed = "PostChatContextCallFailed",
     PostChatSurveyLoadingPaneLoaded = "PostChatSurveyLoadingPaneLoaded",
     PostChatSurveyLoaded = "PostChatSurveyLoaded",
+    PostChatSurveyUrlValidationCompleted = "PostChatSurveyUrlValidationCompleted",
+    PostChatSurveyUrlValidationFailed = "PostChatSurveyUrlValidationFailed",
     ChatDisconnectThreadEventReceived = "ChatDisconnectThreadEventReceived",
     HiddenAdaptiveCardMessageReceived = "HiddenAdaptiveCardMessageReceived",
     EndingAdapterAfterDisconnectionError = "EndingAdapterAfterDisconnectionError",

package/lib/types/components/postchatsurveypanestateful/common/isValidSurveyUrl.d.ts

@@ -0,0 +1,2 @@
+declare const isValidSurveyUrl: (url: string) => boolean;
+export default isValidSurveyUrl;

package/lib/types/contexts/common/ILiveChatWidgetContext.d.ts

@@ -1,9 +1,9 @@
+import { ConfirmationState, ConversationEndEntity, ParticipantType } from "../../common/Constants";
 import ChatConfig from "@microsoft/omnichannel-chat-sdk/lib/core/ChatConfig";
 import { ConversationState } from "./ConversationState";
 import { IInternalTelemetryData } from "../../common/telemetry/interfaces/IInternalTelemetryData";
 import { ILiveChatWidgetLocalizedTexts } from "./ILiveChatWidgetLocalizedTexts";
 import { IRenderingMiddlewareProps } from "../../components/webchatcontainerstateful/interfaces/IRenderingMiddlewareProps";
-import { ConfirmationState, ConversationEndEntity, ParticipantType } from "../../common/Constants";
 import { StartChatFailureType } from "./StartChatFailureType";
 export interface ILiveChatWidgetContext {
     domainStates: {

package/lib/types/firstresponselatency/Constants.d.ts

@@ -0,0 +1,30 @@
+export declare enum ScenarioType {
+    UserSendMessageStrategy = "UserSendMessageStrategy",
+    SystemMessageStrategy = "SystemMessageStrategy",
+    ReceivedMessageStrategy = "ReceivedMessageStrategy"
+}
+export type MessagePayload = {
+    text: string;
+    type: string;
+    timestamp?: string | undefined;
+    userId: string;
+    tags: string[];
+    messageType: string;
+    Id: string | undefined;
+    role: string | undefined;
+    channelData?: any;
+    chatId?: string;
+    conversationId?: string;
+    isChatComplete: boolean;
+    attachment?: any[];
+};
+export type TrackingMessage = {
+    Id: string | undefined;
+    role: string | undefined;
+    timestamp: string | undefined;
+    tags: string[];
+    messageType: string;
+    text: string;
+    checkTime?: number;
+    type: string;
+};

package/lib/types/firstresponselatency/FirstMessageTrackerFromBot.d.ts

@@ -0,0 +1 @@
+export declare const createTrackingForFirstMessage: () => void;

package/lib/types/firstresponselatency/FirstResponseLatencyTracker.d.ts

@@ -0,0 +1,22 @@
+import { MessagePayload } from "./Constants";
+export declare class FirstResponseLatencyTracker {
+    private isABotConversation;
+    private isStarted;
+    private isEnded;
+    private startTrackingMessage?;
+    private stopTrackingMessage?;
+    private isReady;
+    constructor();
+    private createTrackingMessage;
+    private startTracking;
+    private handleAgentMessage;
+    private stopTracking;
+    private isMessageFromValidSender;
+    startClock(payload: MessagePayload): void;
+    stopClock(payload: MessagePayload): void;
+    private offlineNetworkListener;
+    private fmltrackingListener;
+    private rehydrateListener;
+    private historyListener;
+    private deregister;
+}

package/lib/types/firstresponselatency/util.d.ts

@@ -0,0 +1,7 @@
+import { MessagePayload, ScenarioType, TrackingMessage } from "./Constants";
+import { IActivity } from "botframework-directlinejs";
+export declare const isHistoryMessage: (activity: IActivity, startTime: number) => boolean;
+export declare const buildMessagePayload: (activity: IActivity, userId: string) => MessagePayload;
+export declare const polyfillMessagePayloadForEvent: (activity: IActivity, payload: MessagePayload, conversationId?: string) => MessagePayload;
+export declare const getScenarioType: (activity: IActivity) => ScenarioType;
+export declare const createTrackingMessage: (payload: MessagePayload, type: string) => TrackingMessage;