@microsoft/omnichannel-chat-widget 1.8.3 → 1.8.4-main.4478bbf

package/lib/esm/components/livechatwidget/common/PersistentConversationHandler.js

@@ -0,0 +1,277 @@
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+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 ChatWidgetEvents from "./ChatWidgetEvents";
+import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
+import conversationDividerActivity from "../../webchatcontainerstateful/common/activities/conversationDividerActivity";
+import convertPersistentChatHistoryMessageToActivity from "../../webchatcontainerstateful/common/activityConverters/convertPersistentChatHistoryMessageToActivity";
+import { createTimer } from "../../../common/utils";
+import { defaultPersistentChatHistoryProps } from "./defaultProps/defaultPersistentChatHistoryProps";
+import dispatchCustomEvent from "../../../common/utils/dispatchCustomEvent";
+
+/**
+ * Class responsible for handling persistent conversation history
+ */
+let PersistentConversationHandler = /*#__PURE__*/function () {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+  function PersistentConversationHandler(facadeChatSDK, props) {
+    _classCallCheck(this, PersistentConversationHandler);
+    _defineProperty(this, "appliedProps", {
+      ...defaultPersistentChatHistoryProps
+    });
+    _defineProperty(this, "isLastPull", false);
+    _defineProperty(this, "pageToken", null);
+    _defineProperty(this, "facadeChatSDK", void 0);
+    _defineProperty(this, "lastMessage", null);
+    _defineProperty(this, "count", 0);
+    _defineProperty(this, "pageSize", 4);
+    _defineProperty(this, "isCurrentlyPulling", false);
+    _defineProperty(this, "pageTokenInTransitSet", new Set());
+    _defineProperty(this, "resetEventListener", BroadcastService.getMessageByEventName(BroadcastEvent.PersistentConversationReset).subscribe(() => {
+      this.reset();
+    }));
+    this.facadeChatSDK = facadeChatSDK;
+    this.appliedPropsHandler(props);
+    TelemetryHelper.logActionEventToAllTelemetry(LogLevel.INFO, {
+      Event: TelemetryEvent.LCWPersistentConversationHandlerInitialized,
+      Description: "PersistentConversationHandler initialized",
+      CustomProperties: {
+        pageSize: this.pageSize
+      }
+    });
+  }
+  _createClass(PersistentConversationHandler, [{
+    key: "appliedPropsHandler",
+    value: function appliedPropsHandler(props) {
+      this.appliedProps = {
+        ...defaultPersistentChatHistoryProps,
+        ...props
+      };
+      this.pageSize = this.appliedProps.pageSize || 4;
+    }
+  }, {
+    key: "reset",
+    value: function reset() {
+      this.isLastPull = false;
+      this.pageToken = null;
+      this.lastMessage = null;
+      this.count = 0;
+      this.isCurrentlyPulling = false;
+      this.pageTokenInTransitSet.clear();
+    }
+  }, {
+    key: "destroy",
+    value: function destroy() {
+      // Only unsubscribe when the handler is being destroyed completely
+      this.resetEventListener.unsubscribe();
+    }
+  }, {
+    key: "pullHistory",
+    value: async function pullHistory() {
+      const pullTimer = createTimer();
+
+      // Prevent concurrent pulls regardless of pageToken
+      if (this.isCurrentlyPulling) {
+        TelemetryHelper.logActionEvent(LogLevel.WARN, {
+          Event: TelemetryEvent.LCWPersistentHistoryPullBlocked,
+          Description: "History pull blocked - already in progress"
+        });
+        return;
+      }
+
+      // Additional check for specific pageToken duplicates
+      if (this.pageToken && this.pageTokenInTransitSet.has(this.pageToken)) {
+        return;
+      }
+
+      // Mark as currently pulling
+      this.isCurrentlyPulling = true;
+      if (this.pageToken) {
+        this.pageTokenInTransitSet.add(this.pageToken);
+      }
+      try {
+        var _ref;
+        const messages = await this.fetchHistoryMessages();
+        if (messages === null || (messages === null || messages === void 0 ? void 0 : messages.length) === 0) {
+          this.isLastPull = true;
+          // Dispatch event to notify UI that no more history is available
+          dispatchCustomEvent(ChatWidgetEvents.NO_MORE_HISTORY_AVAILABLE);
+          // Also hide the loading banner
+          dispatchCustomEvent(ChatWidgetEvents.HIDE_LOADING_BANNER);
+          TelemetryHelper.logActionEvent(LogLevel.INFO, {
+            Event: TelemetryEvent.LCWPersistentHistoryPullCompleted,
+            Description: "History pull completed - no more messages",
+            ElapsedTimeInMilliseconds: pullTimer.milliSecondsElapsed
+          });
+          return;
+        }
+        const messagesDescOrder = (_ref = [...messages]) === null || _ref === void 0 ? void 0 : _ref.reverse();
+        this.processHistoryMessages(messagesDescOrder);
+
+        // Dispatch event to hide the loading banner after messages are processed
+        dispatchCustomEvent(ChatWidgetEvents.HIDE_LOADING_BANNER);
+        TelemetryHelper.logActionEvent(LogLevel.INFO, {
+          Event: TelemetryEvent.LCWPersistentHistoryPullCompleted,
+          Description: "History pull completed successfully",
+          ElapsedTimeInMilliseconds: pullTimer.milliSecondsElapsed,
+          CustomProperties: {
+            messageCount: messages.length,
+            totalProcessed: this.count
+          }
+        });
+      } finally {
+        // Always clear the pulling flag when done
+        this.isCurrentlyPulling = false;
+
+        // Remove pageToken from transit set if it was added
+        if (this.pageToken) {
+          this.pageTokenInTransitSet.delete(this.pageToken);
+        }
+      }
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  }, {
+    key: "processHistoryMessages",
+    value: function processHistoryMessages(messagesDescOrder) {
+      for (const message of messagesDescOrder) {
+        try {
+          const activity = this.processMessageToActivity(message);
+          if (activity) {
+            dispatchCustomEvent(ChatWidgetEvents.ADD_ACTIVITY, {
+              activity
+            });
+            const dividerActivity = this.createDividerActivity(activity);
+            if (dividerActivity) {
+              dispatchCustomEvent(ChatWidgetEvents.ADD_ACTIVITY, {
+                activity: dividerActivity
+              });
+            }
+            this.lastMessage = activity;
+          }
+        } catch (error) {
+          TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+            Event: TelemetryEvent.ConvertPersistentChatHistoryMessageToActivityFailed,
+            ExceptionDetails: error
+          });
+        }
+      }
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  }, {
+    key: "fetchHistoryMessages",
+    value: async function fetchHistoryMessages() {
+      if (!this.shouldPull()) {
+        // Dispatch event to ensure banner is hidden when no more pulls are needed
+        dispatchCustomEvent(ChatWidgetEvents.NO_MORE_HISTORY_AVAILABLE);
+        dispatchCustomEvent(ChatWidgetEvents.HIDE_LOADING_BANNER);
+        return [];
+      }
+      const options = {
+        pageSize: this.pageSize,
+        pageToken: this.pageToken || undefined
+      };
+      try {
+        var _this$facadeChatSDK;
+        const response = await ((_this$facadeChatSDK = this.facadeChatSDK) === null || _this$facadeChatSDK === void 0 ? void 0 : _this$facadeChatSDK.fetchPersistentConversationHistory(options));
+        const {
+          chatMessages: messages,
+          nextPageToken: pageToken
+        } = response;
+        this.pageToken = pageToken || null;
+        if (pageToken === null) {
+          this.isLastPull = true;
+          // Dispatch event when we reach the end of available history
+          dispatchCustomEvent(ChatWidgetEvents.NO_MORE_HISTORY_AVAILABLE);
+        }
+
+        // if chatMessages is null, return empty array
+        if (!messages) {
+          this.isLastPull = true;
+          // Dispatch event when we reach the end of available history
+          dispatchCustomEvent(ChatWidgetEvents.NO_MORE_HISTORY_AVAILABLE);
+          // Also hide the loading banner
+          dispatchCustomEvent(ChatWidgetEvents.HIDE_LOADING_BANNER);
+          return [];
+        }
+        dispatchCustomEvent(ChatWidgetEvents.HIDE_LOADING_BANNER);
+        return messages;
+      } catch (error) {
+        TelemetryHelper.logSDKEvent(LogLevel.ERROR, {
+          Event: TelemetryEvent.FetchPersistentChatHistoryFailed,
+          ExceptionDetails: error
+        });
+        this.isLastPull = true;
+        this.pageToken = null;
+        // Dispatch event when there's an error to stop loading banner
+        dispatchCustomEvent(ChatWidgetEvents.NO_MORE_HISTORY_AVAILABLE);
+        // Also hide the loading banner
+        dispatchCustomEvent(ChatWidgetEvents.HIDE_LOADING_BANNER);
+        return [];
+      }
+    }
+  }, {
+    key: "shouldPull",
+    value: function shouldPull() {
+      return !this.isLastPull;
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  }, {
+    key: "processMessageToActivity",
+    value: function processMessageToActivity(message) {
+      try {
+        const activity = convertPersistentChatHistoryMessageToActivity(message);
+        activity.id = activity.id || `activity-${this.count}`;
+        activity.channelData = {
+          ...activity.channelData,
+          metadata: {
+            count: this.count
+          }
+        };
+
+        // Increment the count after assigning it to the activity
+        this.count += 1;
+        return activity;
+      } catch (error) {
+        TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+          Event: TelemetryEvent.ConvertPersistentChatHistoryMessageToActivityFailed,
+          ExceptionDetails: error
+        });
+        throw error;
+      }
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  }, {
+    key: "createDividerActivity",
+    value: function createDividerActivity(activity) {
+      var _this$lastMessage, _this$lastMessage$cha;
+      if (((_this$lastMessage = this.lastMessage) === null || _this$lastMessage === void 0 ? void 0 : (_this$lastMessage$cha = _this$lastMessage.channelData) === null || _this$lastMessage$cha === void 0 ? void 0 : _this$lastMessage$cha.conversationId) !== activity.channelData.conversationId) {
+        const rawSequenceId = activity.channelData["webchat:sequence-id"];
+        const sequenceId = typeof rawSequenceId === "number" && !isNaN(rawSequenceId) ? rawSequenceId + 1 : 1;
+        const timestamp = new Date(activity.timestamp).getTime() + 1;
+        return {
+          ...conversationDividerActivity,
+          channelData: {
+            ...conversationDividerActivity.channelData,
+            conversationId: activity.channelData.conversationId,
+            "webchat:sequence-id": sequenceId
+          },
+          timestamp: new Date(timestamp).toISOString(),
+          identifier: `divider-${activity.channelData.conversationId}`
+        };
+      }
+      return null;
+    }
+  }]);
+  return PersistentConversationHandler;
+}();
+export default PersistentConversationHandler;

package/lib/esm/components/livechatwidget/common/createAdapter.js

@@ -1,3 +1,4 @@
+import { AddActivitySubscriber } from "./ActivitySubscriber/AddActivitySubscriber";
 import { BotAuthActivitySubscriber } from "./ActivitySubscriber/BotAuthActivitySubscriber";
 import { ChatAdapterShim } from "./ChatAdapterShim";
 import { HiddenAdaptiveCardActivitySubscriber } from "./ActivitySubscriber/HiddenAdaptiveCardActivitySubscriber";
@@ -44,6 +45,7 @@ export const createAdapter = async (facadeChatSDK, props) => {
       fetchBotAuthConfigRetryInterval: (props === null || props === void 0 ? void 0 : (_props$webChatContain3 = props.webChatContainerProps) === null || _props$webChatContain3 === void 0 ? void 0 : (_props$webChatContain4 = _props$webChatContain3.botAuthConfig) === null || _props$webChatContain4 === void 0 ? void 0 : _props$webChatContain4.fetchBotAuthConfigRetryInterval) || defaultBotAuthConfig.fetchBotAuthConfigRetryInterval
     };
     adapter = new ChatAdapterShim(adapter);
+    adapter.addSubscriber(new AddActivitySubscriber());
     adapter.addSubscriber(new PauseActivitySubscriber());
     adapter.addSubscriber(new BotAuthActivitySubscriber(botAuthActivitySubscriberOptionalParams));
     // Remove this code after ICM ID:544623085 is fixed

package/lib/esm/components/livechatwidget/common/defaultProps/defaultPersistentChatHistoryProps.js

@@ -0,0 +1,11 @@
+export const defaultPersistentChatHistoryProps = {
+  persistentChatHistoryEnabled: true,
+  pageSize: 4,
+  dividerActivityStyle: {
+    border: "1px solid rgb(96, 94, 92, 0.5)",
+    margin: "10px 20%"
+  },
+  bannerStyle: {
+    margin: "10px auto"
+  }
+};

package/lib/esm/components/livechatwidget/common/endChat.js

@@ -4,6 +4,7 @@ import { getConversationDetailsCall, getWidgetEndChatEventName } from "../../../
 import { getPostChatContext, initiatePostChat } from "./renderSurveyHelpers";
 import { BroadcastService } from "@microsoft/omnichannel-chat-components";
 import { ConversationState } from "../../../contexts/common/ConversationState";
+import { LazyLoadHandler } from "../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activities/LazyLoadActivity";
 import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidgetActionType";
 import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
 import { TelemetryManager } from "../../../common/telemetry/TelemetryManager";
@@ -225,7 +226,12 @@ const endChat = async (props, facadeChatSDK, state, dispatch, setAdapter, setWeb
         type: LiveChatWidgetActionType.SET_POST_CHAT_CONTEXT,
         payload: undefined
       });
-      // Always allow to close the chat for embedded mode irrespective of end chat errors
+
+      // Call direct reset to ensure LazyLoadHandler gets reset regardless of broadcast timing
+      LazyLoadHandler.directReset();
+      BroadcastService.postMessage({
+        eventName: BroadcastEvent.PersistentConversationReset
+      });
       closeChatWidget(dispatch, setWebChatStyles, props);
       facadeChatSDK.destroy();
     }

package/lib/esm/components/livechatwidget/common/initWebChatComposer.js

@@ -1,6 +1,7 @@
 import { ConversationEndEntity, ParticipantType } from "../../../common/Constants";
 import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
 import { changeLanguageCodeFormatForWebChat, getConversationDetailsCall } from "../../../common/utils";
+import { getOverriddenLocalizedStrings, localizedStringsBotInitialsMiddleware } from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/localizedStringsBotInitialsMiddleware";
 import { BroadcastService } from "@microsoft/omnichannel-chat-components";
 import { Constants } from "../../../common/Constants";
 import { ConversationState } from "../../../contexts/common/ConversationState";
@@ -12,6 +13,7 @@ import { WebChatStoreLoader } from "../../webchatcontainerstateful/webchatcontro
 import attachmentProcessingMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentProcessingMiddleware";
 import channelDataMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/channelDataMiddleware";
 import { createActivityMiddleware } from "../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityMiddleware";
+import { createActivityStatusMiddleware } from "../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityStatusMiddleware";
 import { createAttachmentMiddleware } from "../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachmentMiddleware";
 import createAttachmentUploadValidatorMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentUploadValidatorMiddleware";
 import { createAvatarMiddleware } from "../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/avatarMiddleware";
@@ -39,11 +41,10 @@ import htmlPlayerMiddleware from "../../webchatcontainerstateful/webchatcontroll
 import htmlTextMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/htmlTextMiddleware";
 import preProcessingMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/preProcessingMiddleware";
 import sanitizationMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/sanitizationMiddleware";
-import { localizedStringsBotInitialsMiddleware, getOverriddenLocalizedStrings } from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/localizedStringsBotInitialsMiddleware";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endChat) => {
-  var _props$webChatContain, _props$webChatContain2, _props$webChatContain3, _props$webChatContain4, _props$webChatContain5, _props$webChatContain6, _state$domainStates$l4, _state$domainStates$l5, _props$webChatContain11, _props$webChatContain12, _state$domainStates$r, _state$domainStates$r2, _props$webChatContain13, _props$webChatContain14, _state$domainStates$r3, _state$domainStates$r4, _props$webChatContain15, _props$webChatContain16, _defaultWebChatContai, _props$webChatContain17, _props$webChatContain18, _props$webChatContain19, _props$webChatContain20, _state$domainStates$r5, _state$domainStates$r6, _props$webChatContain21, _props$webChatContain22, _defaultWebChatContai2, _props$webChatContain23, _props$webChatContain24, _defaultWebChatContai3, _props$webChatContain25, _props$webChatContain26, _props$webChatContain27, _props$webChatContain28;
+  var _props$webChatContain, _props$webChatContain2, _props$webChatContain3, _props$webChatContain4, _props$webChatContain5, _props$webChatContain6, _state$domainStates$l4, _state$domainStates$l5, _props$webChatContain11, _props$webChatContain12, _state$domainStates$r, _state$domainStates$r2, _props$webChatContain13, _props$webChatContain14, _state$domainStates$r3, _state$domainStates$r4, _props$webChatContain15, _props$webChatContain16, _state$domainStates$l6, _state$domainStates$l7, _props$webChatContain17, _props$webChatContain18, _props$webChatContain19, _props$webChatContain20, _state$domainStates$r5, _state$domainStates$r6, _props$webChatContain21, _props$webChatContain22, _defaultWebChatContai, _props$webChatContain23, _props$webChatContain24, _defaultWebChatContai2, _props$webChatContain25, _props$webChatContain26, _props$webChatContain27, _props$webChatContain28;
   // Add a hook to make all links open a new window
   postDomPurifyActivities();
   const localizedTexts = {
@@ -61,6 +62,7 @@ export const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endCh
   let webChatStore = WebChatStoreLoader.store;
   if (!webChatStore) {
     var _state$domainStates$l, _state$domainStates$l2, _state$domainStates$l3, _props$webChatContain7;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const addConversationalSurveyTagsCallback = action => {
       var _inMemoryState$appSta;
       const inMemoryState = executeReducer(state, {
@@ -163,12 +165,12 @@ export const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endCh
     store: webChatStore,
     activityMiddleware: (_props$webChatContain11 = props.webChatContainerProps) !== null && _props$webChatContain11 !== void 0 && (_props$webChatContain12 = _props$webChatContain11.renderingMiddlewareProps) !== null && _props$webChatContain12 !== void 0 && _props$webChatContain12.disableActivityMiddleware ? undefined : createActivityMiddleware(renderMarkdown, (_state$domainStates$r = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r === void 0 ? void 0 : _state$domainStates$r.systemMessageStyleProps, (_state$domainStates$r2 = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r2 === void 0 ? void 0 : _state$domainStates$r2.userMessageStyleProps),
     attachmentMiddleware: (_props$webChatContain13 = props.webChatContainerProps) !== null && _props$webChatContain13 !== void 0 && (_props$webChatContain14 = _props$webChatContain13.renderingMiddlewareProps) !== null && _props$webChatContain14 !== void 0 && _props$webChatContain14.disableAttachmentMiddleware ? undefined : createAttachmentMiddleware(((_state$domainStates$r3 = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r3 === void 0 ? void 0 : (_state$domainStates$r4 = _state$domainStates$r3.attachmentProps) === null || _state$domainStates$r4 === void 0 ? void 0 : _state$domainStates$r4.enableInlinePlaying) ?? defaultAttachmentProps.enableInlinePlaying),
-    activityStatusMiddleware: (_props$webChatContain15 = props.webChatContainerProps) !== null && _props$webChatContain15 !== void 0 && (_props$webChatContain16 = _props$webChatContain15.renderingMiddlewareProps) !== null && _props$webChatContain16 !== void 0 && _props$webChatContain16.disableActivityStatusMiddleware ? undefined : (_defaultWebChatContai = defaultWebChatContainerStatefulProps.webChatProps) === null || _defaultWebChatContai === void 0 ? void 0 : _defaultWebChatContai.activityStatusMiddleware,
+    activityStatusMiddleware: (_props$webChatContain15 = props.webChatContainerProps) !== null && _props$webChatContain15 !== void 0 && (_props$webChatContain16 = _props$webChatContain15.renderingMiddlewareProps) !== null && _props$webChatContain16 !== void 0 && _props$webChatContain16.disableActivityStatusMiddleware ? undefined : createActivityStatusMiddleware(getLocaleStringFromId((_state$domainStates$l6 = state.domainStates.liveChatConfig) === null || _state$domainStates$l6 === void 0 ? void 0 : (_state$domainStates$l7 = _state$domainStates$l6.ChatWidgetLanguage) === null || _state$domainStates$l7 === void 0 ? void 0 : _state$domainStates$l7.msdyn_localeid)),
     toastMiddleware: (_props$webChatContain17 = props.webChatContainerProps) !== null && _props$webChatContain17 !== void 0 && (_props$webChatContain18 = _props$webChatContain17.renderingMiddlewareProps) !== null && _props$webChatContain18 !== void 0 && _props$webChatContain18.disableToastMiddleware ? undefined : createToastMiddleware(props.notificationPaneProps, endChat),
     renderMarkdown,
     avatarMiddleware: (_props$webChatContain19 = props.webChatContainerProps) !== null && _props$webChatContain19 !== void 0 && (_props$webChatContain20 = _props$webChatContain19.renderingMiddlewareProps) !== null && _props$webChatContain20 !== void 0 && _props$webChatContain20.disableAvatarMiddleware ? undefined : createAvatarMiddleware((_state$domainStates$r5 = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r5 === void 0 ? void 0 : _state$domainStates$r5.avatarStyleProps, (_state$domainStates$r6 = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r6 === void 0 ? void 0 : _state$domainStates$r6.avatarTextStyleProps),
-    groupActivitiesMiddleware: (_props$webChatContain21 = props.webChatContainerProps) !== null && _props$webChatContain21 !== void 0 && (_props$webChatContain22 = _props$webChatContain21.renderingMiddlewareProps) !== null && _props$webChatContain22 !== void 0 && _props$webChatContain22.disableGroupActivitiesMiddleware ? undefined : (_defaultWebChatContai2 = defaultWebChatContainerStatefulProps.webChatProps) === null || _defaultWebChatContai2 === void 0 ? void 0 : _defaultWebChatContai2.groupActivitiesMiddleware,
-    typingIndicatorMiddleware: (_props$webChatContain23 = props.webChatContainerProps) !== null && _props$webChatContain23 !== void 0 && (_props$webChatContain24 = _props$webChatContain23.renderingMiddlewareProps) !== null && _props$webChatContain24 !== void 0 && _props$webChatContain24.disableTypingIndicatorMiddleware ? undefined : (_defaultWebChatContai3 = defaultWebChatContainerStatefulProps.webChatProps) === null || _defaultWebChatContai3 === void 0 ? void 0 : _defaultWebChatContai3.typingIndicatorMiddleware,
+    groupActivitiesMiddleware: (_props$webChatContain21 = props.webChatContainerProps) !== null && _props$webChatContain21 !== void 0 && (_props$webChatContain22 = _props$webChatContain21.renderingMiddlewareProps) !== null && _props$webChatContain22 !== void 0 && _props$webChatContain22.disableGroupActivitiesMiddleware ? undefined : (_defaultWebChatContai = defaultWebChatContainerStatefulProps.webChatProps) === null || _defaultWebChatContai === void 0 ? void 0 : _defaultWebChatContai.groupActivitiesMiddleware,
+    typingIndicatorMiddleware: (_props$webChatContain23 = props.webChatContainerProps) !== null && _props$webChatContain23 !== void 0 && (_props$webChatContain24 = _props$webChatContain23.renderingMiddlewareProps) !== null && _props$webChatContain24 !== void 0 && _props$webChatContain24.disableTypingIndicatorMiddleware ? undefined : (_defaultWebChatContai2 = defaultWebChatContainerStatefulProps.webChatProps) === null || _defaultWebChatContai2 === void 0 ? void 0 : _defaultWebChatContai2.typingIndicatorMiddleware,
     onTelemetry: createWebChatTelemetry(),
     cardActionMiddleware: createCardActionMiddleware(((_props$webChatContain25 = props.webChatContainerProps) === null || _props$webChatContain25 === void 0 ? void 0 : _props$webChatContain25.botMagicCode) || undefined),
     sendTypingIndicator: true,

package/lib/esm/components/livechatwidget/common/renderSurveyHelpers.js

@@ -149,7 +149,7 @@ const getPostChatContext = async (facadeChatSDK, state, dispatch) => {
       if ((state === null || state === void 0 ? void 0 : (_state$domainStates2 = state.domainStates) === null || _state$domainStates2 === void 0 ? void 0 : _state$domainStates2.postChatContext) === undefined) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const context = await facadeChatSDK.getPostChatSurveyContext();
-        TelemetryHelper.logSDKEventToAllTelemetry(LogLevel.INFO, {
+        TelemetryHelper.logSDKEvent(LogLevel.INFO, {
           Event: TelemetryEvent.PostChatContextCallSucceed,
           Description: PostChatSurveyTelemetryMessage.PostChatContextCallSucceed
         });
@@ -167,7 +167,7 @@ const getPostChatContext = async (facadeChatSDK, state, dispatch) => {
       }
     }
   } catch (error) {
-    TelemetryHelper.logSDKEventToAllTelemetry(LogLevel.ERROR, {
+    TelemetryHelper.logSDKEvent(LogLevel.ERROR, {
       Event: TelemetryEvent.PostChatContextCallFailed,
       Description: PostChatSurveyTelemetryMessage.PostChatContextCallFailed,
       ExceptionDetails: {

package/lib/esm/components/livechatwidget/common/setPostChatContextAndLoadSurvey.js

@@ -19,13 +19,13 @@ export const setPostChatContextAndLoadSurvey = async (facadeChatSDK, dispatch, p
     const postChatEnabled = postChatConfig.postChatEnabled;
     if (postChatEnabled) {
       if (!persistedChat) {
-        TelemetryHelper.logSDKEventToAllTelemetry(LogLevel.INFO, {
+        TelemetryHelper.logSDKEvent(LogLevel.INFO, {
           Event: TelemetryEvent.PostChatContextCallStarted,
           Description: PostChatSurveyTelemetryMessage.PostChatContextCallStarted
         });
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const context = await facadeChatSDK.getPostChatSurveyContext();
-        TelemetryHelper.logSDKEventToAllTelemetry(LogLevel.INFO, {
+        TelemetryHelper.logSDKEvent(LogLevel.INFO, {
           Event: TelemetryEvent.PostChatContextCallSucceed,
           Description: PostChatSurveyTelemetryMessage.PostChatContextCallSucceed
         });
@@ -42,7 +42,7 @@ export const setPostChatContextAndLoadSurvey = async (facadeChatSDK, dispatch, p
       }
     }
   } catch (ex) {
-    TelemetryHelper.logSDKEventToAllTelemetry(LogLevel.ERROR, {
+    TelemetryHelper.logSDKEvent(LogLevel.ERROR, {
       Event: TelemetryEvent.PostChatContextCallFailed,
       Description: PostChatSurveyTelemetryMessage.PostChatContextCallFailed,
       ExceptionDetails: {

package/lib/esm/components/livechatwidget/common/startChat.js

@@ -1,9 +1,9 @@
-import { BroadcastEvent, LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
+import { BroadcastEvent, ConversationStage, LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
 import { Constants, LiveWorkItemState, WidgetLoadTelemetryMessage } from "../../../common/Constants";
 import { TelemetryManager, TelemetryTimers } from "../../../common/telemetry/TelemetryManager";
 import { checkContactIdError, createTimer, getConversationDetailsCall, getStateFromCache, getWidgetCacheIdfromProps, isNullOrEmptyString, isNullOrUndefined, isUndefinedOrEmpty } from "../../../common/utils";
 import { handleChatReconnect, isPersistentEnabled, isReconnectEnabled } from "./reconnectChatHelper";
-import { handleStartChatError, logWidgetLoadComplete } from "./startChatErrorHandler";
+import { handleStartChatError, logStartChatComplete, logWidgetLoadComplete } from "./startChatErrorHandler";
 import { ActivityStreamHandler } from "./ActivityStreamHandler";
 import { BroadcastService } from "@microsoft/omnichannel-chat-components";
 import { ConversationState } from "../../../contexts/common/ConversationState";
@@ -174,7 +174,10 @@ const initStartChat = async (facadeChatSDK, dispatch, setAdapter, state, props,
     TelemetryTimers.WidgetLoadTimer = createTimer();
     TelemetryHelper.logLoadingEventToAllTelemetry(LogLevel.INFO, {
       Event: TelemetryEvent.WidgetLoadStarted,
-      Description: "Widget start chat started."
+      Description: "Widget start chat started.",
+      CustomProperties: {
+        ConversationStage: ConversationStage.Initialization
+      }
     });
 
     //Check if chat retrieved from cache
@@ -202,6 +205,7 @@ const initStartChat = async (facadeChatSDK, dispatch, setAdapter, state, props,
       const startTime = new Date().getTime();
       createTrackingForFirstMessage();
       await facadeChatSDK.startChat(startChatOptionalParams);
+      logStartChatComplete();
       isStartChatSuccessful = true;
       await createAdapterAndSubscribe(facadeChatSDK, dispatch, setAdapter, startTime, props);
     } catch (error) {

package/lib/esm/components/livechatwidget/common/startChatErrorHandler.js

@@ -1,5 +1,5 @@
 import { ChatSDKError, ChatSDKErrorName } from "@microsoft/omnichannel-chat-sdk";
-import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
+import { ConversationStage, LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
 import { PrepareEndChatDescriptionConstants, WidgetLoadCustomErrorString, WidgetLoadTelemetryMessage } from "../../../common/Constants";
 import { callingStateCleanUp, chatSDKStateCleanUp, closeChatStateCleanUp, endChatStateCleanUp } from "./endChat";
 import { ConversationState } from "../../../contexts/common/ConversationState";
@@ -118,7 +118,10 @@ const logWidgetLoadFailed = ex => {
     Event: TelemetryEvent.WidgetLoadFailed,
     Description: "Widget load complete with error",
     ExceptionDetails: exDetails,
-    ElapsedTimeInMilliseconds: TelemetryTimers === null || TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg = TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg === void 0 ? void 0 : _TelemetryTimers$Widg.milliSecondsElapsed
+    ElapsedTimeInMilliseconds: TelemetryTimers === null || TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg = TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg === void 0 ? void 0 : _TelemetryTimers$Widg.milliSecondsElapsed,
+    CustomProperties: {
+      ConversationStage: ConversationStage.Initialization
+    }
   });
 };
 export const logWidgetLoadComplete = additionalMessage => {
@@ -133,6 +136,16 @@ export const logWidgetLoadComplete = additionalMessage => {
     ElapsedTimeInMilliseconds: TelemetryTimers === null || TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg2 = TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg2 === void 0 ? void 0 : _TelemetryTimers$Widg2.milliSecondsElapsed
   });
 };
+export const logStartChatComplete = additionalMessage => {
+  let descriptionString = "Start chat complete";
+  if (additionalMessage) {
+    descriptionString += `. ${additionalMessage}`;
+  }
+  TelemetryHelper.logLoadingEvent(LogLevel.INFO, {
+    Event: TelemetryEvent.StartChatComplete,
+    Description: descriptionString
+  });
+};
 const logWidgetLoadCompleteWithError = ex => {
   var _TelemetryTimers$Widg3;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -149,7 +162,10 @@ const logWidgetLoadCompleteWithError = ex => {
     Event: TelemetryEvent.WidgetLoadFailed,
     Description: "Widget load complete with error",
     ExceptionDetails: exDetails,
-    ElapsedTimeInMilliseconds: TelemetryTimers === null || TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg3 = TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg3 === void 0 ? void 0 : _TelemetryTimers$Widg3.milliSecondsElapsed
+    ElapsedTimeInMilliseconds: TelemetryTimers === null || TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg3 = TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg3 === void 0 ? void 0 : _TelemetryTimers$Widg3.milliSecondsElapsed,
+    CustomProperties: {
+      ConversationStage: ConversationStage.Initialization
+    }
   });
 };
 export const logWidgetLoadWithUnexpectedError = ex => {
@@ -177,7 +193,10 @@ export const logWidgetLoadWithUnexpectedError = ex => {
     Event: TelemetryEvent.WidgetLoadFailed,
     Description: "Widget load with unexpected error",
     ExceptionDetails: exDetails,
-    ElapsedTimeInMilliseconds: TelemetryTimers === null || TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg4 = TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg4 === void 0 ? void 0 : _TelemetryTimers$Widg4.milliSecondsElapsed
+    ElapsedTimeInMilliseconds: TelemetryTimers === null || TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg4 = TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg4 === void 0 ? void 0 : _TelemetryTimers$Widg4.milliSecondsElapsed,
+    CustomProperties: {
+      ConversationStage: ConversationStage.Initialization
+    }
   });
 };
 

package/lib/esm/components/livechatwidget/interfaces/IPersistentChatHistoryProps.js

@@ -0,0 +1 @@
+export {};

package/lib/esm/components/livechatwidget/livechatwidgetstateful/LiveChatWidgetStateful.js

@@ -1,5 +1,5 @@
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
-import { BroadcastEvent, LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
+import { BroadcastEvent, ConversationStage, LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
 import { BroadcastService, BroadcastServiceInitialize, decodeComponentString } from "@microsoft/omnichannel-chat-components";
 import { Components } from "botframework-webchat";
 import { ConfirmationState, Constants, ConversationEndEntity, E2VVOptions, LiveWorkItemState, PrepareEndChatDescriptionConstants, StorageType, WidgetLoadCustomErrorString } from "../../../common/Constants";
@@ -61,7 +61,10 @@ export const LiveChatWidgetStateful = props => {
     uiTimer = createTimer();
     TelemetryHelper.logLoadingEventToAllTelemetry(LogLevel.INFO, {
       Event: TelemetryEvent.UXLiveChatWidgetStart,
-      Description: "Live chat widget loading started."
+      Description: "Live chat widget loading started.",
+      CustomProperties: {
+        ConversationStage: ConversationStage.Initialization
+      }
     });
   }, []);
   const [state, dispatch] = useChatContextStore();
@@ -492,7 +495,10 @@ export const LiveChatWidgetStateful = props => {
     BroadcastService.getMessageByEventName(BroadcastEvent.InitiateEndChat).subscribe(async () => {
       TelemetryHelper.logSDKEventToAllTelemetry(LogLevel.INFO, {
         Event: TelemetryEvent.EndChatEventReceived,
-        Description: "Received InitiateEndChat BroadcastEvent."
+        Description: "Received InitiateEndChat BroadcastEvent.",
+        CustomProperties: {
+          ConversationStage: ConversationStage.ConversationEnd
+        }
       });
 
       // This is to ensure to get latest state from cache in multitab
@@ -797,7 +803,10 @@ export const LiveChatWidgetStateful = props => {
     TelemetryHelper.logLoadingEventToAllTelemetry(LogLevel.INFO, {
       Event: TelemetryEvent.UXLiveChatWidgetCompleted,
       Description: "Live chat widget loading completed.",
-      ElapsedTimeInMilliseconds: uiTimer.milliSecondsElapsed
+      ElapsedTimeInMilliseconds: uiTimer.milliSecondsElapsed,
+      CustomProperties: {
+        ConversationStage: ConversationStage.Initialization
+      }
     });
   }, []);
   const initiateEndChatOnBrowserUnload = () => {