@microsoft/omnichannel-chat-widget 1.8.3-main.ec1328d → 1.8.4-main.1bfa518

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

@@ -1,10 +1,13 @@
 import { BroadcastEvent, LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
-import { ConfirmationState, Constants, ConversationEndEntity, ParticipantType, PrepareEndChatDescriptionConstants } from "../../../common/Constants";
+import { ConfirmationState, Constants, ConversationEndEntity, LiveWorkItemState, ParticipantType, PrepareEndChatDescriptionConstants } from "../../../common/Constants";
 import { getConversationDetailsCall, getWidgetEndChatEventName } from "../../../common/utils";
 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 { NotificationHandler } from "../../webchatcontainerstateful/webchatcontroller/notification/NotificationHandler";
+import { NotificationScenarios } from "../../webchatcontainerstateful/webchatcontroller/enums/NotificationScenarios";
 import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
 import { TelemetryManager } from "../../../common/telemetry/TelemetryManager";
 import { WebChatStoreLoader } from "../../webchatcontainerstateful/webchatcontroller/WebChatStoreLoader";
@@ -39,7 +42,7 @@ const prepareEndChat = async (props, facadeChatSDK, state, dispatch, setAdapter,
       }
 
       // Use Case: If ended by Agent, stay chat in InActive state
-      let isConversationalSurveyEnabled = state.appStates.isConversationalSurveyEnabled;
+      const isConversationalSurveyEnabled = state.appStates.isConversationalSurveyEnabled;
       if (isConversationalSurveyEnabled && ((state === null || state === void 0 ? void 0 : (_state$appStates2 = state.appStates) === null || _state$appStates2 === void 0 ? void 0 : _state$appStates2.conversationEndedBy) === ConversationEndEntity.Agent || (state === null || state === void 0 ? void 0 : (_state$appStates3 = state.appStates) === null || _state$appStates3 === void 0 ? void 0 : _state$appStates3.conversationEndedBy) === ConversationEndEntity.Bot)) {
         dispatch({
           type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
@@ -147,8 +150,23 @@ const endChat = async (props, facadeChatSDK, state, dispatch, setAdapter, setWeb
       type: LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
       payload: null
     });
+    let isSessionEnded = inMemoryState === null || inMemoryState === void 0 ? void 0 : (_inMemoryState$appSta = inMemoryState.appStates) === null || _inMemoryState$appSta === void 0 ? void 0 : _inMemoryState$appSta.chatDisconnectEventReceived;
+    if (!isSessionEnded) {
+      // double check by fetching the latest conversation details
+      const conversationDetails = await getConversationDetailsCall(facadeChatSDK);
+      if ((conversationDetails === null || conversationDetails === void 0 ? void 0 : conversationDetails.state) === LiveWorkItemState.WrapUp || (conversationDetails === null || conversationDetails === void 0 ? void 0 : conversationDetails.state) === LiveWorkItemState.Closed) {
+        TelemetryHelper.logActionEvent(LogLevel.INFO, {
+          Event: TelemetryEvent.ChatDisconnectThreadEventReceived,
+          Description: "Checking conversation details upon endChat. Chat disconnected.",
+          CustomProperties: {
+            conversationDetails
+          }
+        });
+        isSessionEnded = true;
+      }
+    }
     const endChatOptionalParameters = {
-      isSessionEnded: inMemoryState === null || inMemoryState === void 0 ? void 0 : (_inMemoryState$appSta = inMemoryState.appStates) === null || _inMemoryState$appSta === void 0 ? void 0 : _inMemoryState$appSta.chatDisconnectEventReceived
+      isSessionEnded
     };
     try {
       TelemetryHelper.logSDKEvent(LogLevel.INFO, {
@@ -179,6 +197,18 @@ const endChat = async (props, facadeChatSDK, state, dispatch, setAdapter, setWeb
       facadeChatSDK.destroy();
     }
   }
+
+  //moving logic below to before processing skipCloseChat logic to avoid race conditions of postMessage for endChatEvent for other tabs vs postMessage for CloseChat
+  //TODO: clarify if this postMessageToOtherTab actually works in production.
+  if (postMessageToOtherTab) {
+    const endChatEventName = await getEndChatEventName(facadeChatSDK, props);
+    BroadcastService.postMessage({
+      eventName: endChatEventName,
+      payload: {
+        runtimeId: TelemetryManager.InternalTelemetryData.lcwRuntimeId
+      }
+    });
+  }
   if (!skipCloseChat) {
     try {
       var _props$webChatContain;
@@ -210,20 +240,25 @@ 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();
+
+      //always post the close chat event after chat closed and cleanup completed
+      BroadcastService.postMessage({
+        eventName: BroadcastEvent.CloseChat
+      });
+      TelemetryHelper.logActionEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.CloseChatCall,
+        Description: "Broadcasted close chat event"
+      });
     }
   }
-  if (postMessageToOtherTab) {
-    const endChatEventName = await getEndChatEventName(facadeChatSDK, props);
-    BroadcastService.postMessage({
-      eventName: endChatEventName,
-      payload: {
-        runtimeId: TelemetryManager.InternalTelemetryData.lcwRuntimeId
-      }
-    });
-  }
 };
 export const callingStateCleanUp = dispatch => {
   dispatch({
@@ -296,6 +331,13 @@ export const closeChatStateCleanUp = dispatch => {
       proactiveChatInNewWindow: false
     }
   });
+  dispatch({
+    type: LiveChatWidgetActionType.SET_CITATIONS,
+    payload: {}
+  });
+
+  // Dismiss the chat disconnect notification banner if it was shown
+  NotificationHandler.dismissNotification(NotificationScenarios.ChatDisconnect);
 
   // Clear live chat context only if chat widget is fully closed to support transcript calls after sessionclose is called
   dispatch({

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

@@ -3,14 +3,15 @@ import { DesignerChatSDK } from "../../webchatcontainerstateful/common/DesignerC
 import { MockChatSDK } from "../../webchatcontainerstateful/common/mockchatsdk";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const getMockChatSDKIfApplicable = (chatSDK, type) => {
-  if (type) {
-    switch (type.toLowerCase()) {
+export const getMockChatSDKIfApplicable = (chatSDK, mockProps) => {
+  if (mockProps !== null && mockProps !== void 0 && mockProps.type) {
+    switch (mockProps.type.toLowerCase()) {
       case "demo":
         chatSDK = new DemoChatSDK();
         break;
       case "designer":
         chatSDK = new DesignerChatSDK();
+        chatSDK.mockMessages = mockProps === null || mockProps === void 0 ? void 0 : mockProps.mockMessages;
         break;
       default:
         chatSDK = new MockChatSDK();

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, {
@@ -118,7 +120,14 @@ export const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endCh
     };
     webChatStore = createStore({},
     //initial state
-    preProcessingMiddleware, attachmentProcessingMiddleware, createAttachmentUploadValidatorMiddleware((_state$domainStates$l = state.domainStates.liveChatConfig) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.allowedFileExtensions, (_state$domainStates$l2 = state.domainStates.liveChatConfig) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.maxUploadFileSize, localizedTexts), createCustomEventMiddleware(BroadcastService), createQueueOverflowMiddleware(state, dispatch), channelDataMiddleware(addConversationalSurveyTagsCallback), createConversationEndMiddleware(conversationEndCallback, startConversationalSurveyCallback, endConversationalSurveyCallback), createDataMaskingMiddleware((_state$domainStates$l3 = state.domainStates.liveChatConfig) === null || _state$domainStates$l3 === void 0 ? void 0 : _state$domainStates$l3.DataMaskingInfo), createMessageTimeStampMiddleware, createMessageSequenceIdOverrideMiddleware, createCitationsMiddleware, gifUploadMiddleware, htmlPlayerMiddleware, htmlTextMiddleware(honorsTargetInHTMLLinks), createMaxMessageSizeValidator(localizedTexts), sanitizationMiddleware, createCallActionMiddleware(), localizedStringsBotInitialsMiddleware(),
+    preProcessingMiddleware, attachmentProcessingMiddleware, createAttachmentUploadValidatorMiddleware((_state$domainStates$l = state.domainStates.liveChatConfig) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.allowedFileExtensions, (_state$domainStates$l2 = state.domainStates.liveChatConfig) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.maxUploadFileSize, localizedTexts), createCustomEventMiddleware(BroadcastService), createQueueOverflowMiddleware(state, dispatch), channelDataMiddleware(addConversationalSurveyTagsCallback), createConversationEndMiddleware(conversationEndCallback, startConversationalSurveyCallback, endConversationalSurveyCallback), createDataMaskingMiddleware((_state$domainStates$l3 = state.domainStates.liveChatConfig) === null || _state$domainStates$l3 === void 0 ? void 0 : _state$domainStates$l3.DataMaskingInfo), createMessageTimeStampMiddleware, createMessageSequenceIdOverrideMiddleware, createCitationsMiddleware(state, dispatch), gifUploadMiddleware, htmlPlayerMiddleware, htmlTextMiddleware(honorsTargetInHTMLLinks), createMaxMessageSizeValidator(localizedTexts), sanitizationMiddleware, createCallActionMiddleware(),
+    // Pass a callback so middleware can push initials into React context for reactivity
+    localizedStringsBotInitialsMiddleware(initials => {
+      dispatch({
+        type: LiveChatWidgetActionType.SET_BOT_AVATAR_INITIALS,
+        payload: initials
+      });
+    }),
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     ...(((_props$webChatContain7 = props.webChatContainerProps) === null || _props$webChatContain7 === void 0 ? void 0 : _props$webChatContain7.storeMiddlewares) ?? []));
     WebChatStoreLoader.store = webChatStore;
@@ -161,14 +170,14 @@ export const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endCh
     dir: state.domainStates.globalDir,
     locale: changeLanguageCodeFormatForWebChat(getLocaleStringFromId((_state$domainStates$l4 = state.domainStates.liveChatConfig) === null || _state$domainStates$l4 === void 0 ? void 0 : (_state$domainStates$l5 = _state$domainStates$l4.ChatWidgetLanguage) === null || _state$domainStates$l5 === void 0 ? void 0 : _state$domainStates$l5.msdyn_localeid)),
     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),
+    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, localizedTexts),
     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/liveChatConfigUtils.js

@@ -1,11 +1,13 @@
+import { isNullOrUndefined, parseBooleanFromConfig } from "../../../common/utils";
 import { ConversationMode } from "../../../common/Constants";
-import { isNullOrUndefined } from "../../../common/utils";
 export const isPostChatSurveyEnabled = async facadeChatSDK => {
   var _chatConfig$LiveWSAnd;
   const chatConfig = await facadeChatSDK.getLiveChatConfig();
   const postChatEnabled = (_chatConfig$LiveWSAnd = chatConfig.LiveWSAndLiveChatEngJoin) === null || _chatConfig$LiveWSAnd === void 0 ? void 0 : _chatConfig$LiveWSAnd.msdyn_postconversationsurveyenable.toString().toLowerCase();
   return postChatEnabled === "true";
 };
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const getPostChatSurveyConfig = async facadeChatSDK => {
   var _chatConfig$LiveWSAnd2, _chatConfig$LiveWSAnd3, _chatConfig$LiveWSAnd4, _chatConfig$LiveWSAnd5, _chatConfig$LiveWSAnd6, _chatConfig$LiveWSAnd7, _chatConfig$LiveWSAnd8, _chatConfig$LiveWSAnd9, _chatConfig$LiveWSAnd10;
   const chatConfig = await facadeChatSDK.getLiveChatConfig();
@@ -26,5 +28,34 @@ export const isPersistentChatEnabled = conversationMode => {
   if (isNullOrUndefined(conversationMode)) {
     return false;
   }
-  return (conversationMode === null || conversationMode === void 0 ? void 0 : conversationMode.toString().toLowerCase()) === ConversationMode.Persistent;
+  return (conversationMode === null || conversationMode === void 0 ? void 0 : conversationMode.toString()) === ConversationMode.Persistent;
+};
+
+/**
+ * Determines if persistent chat history should be loaded based on all required conditions.
+ * 
+ * @param extendedChatConfig - The extended chat configuration object
+ * @returns true if ALL conditions are met:
+ *   1. Conversation mode must be Persistent ("192350001")
+ *   2. History is enabled in admin config (msdyn_enablepersistentchatpreviousconversations)
+ *   3. History is enabled via feature flag (lcwPersistentChatHistoryEnabled)
+ */
+export const shouldLoadPersistentChatHistory = extendedChatConfig => {
+  var _extendedChatConfig$L, _extendedChatConfig$L2, _extendedChatConfig$L3;
+  // CRITICAL: First check if conversation mode is persistent
+  // Only persistent mode ("192350001") should allow history loading
+  const isPersistentChatEnabledForWidget = isPersistentChatEnabled(extendedChatConfig === null || extendedChatConfig === void 0 ? void 0 : (_extendedChatConfig$L = extendedChatConfig.LiveWSAndLiveChatEngJoin) === null || _extendedChatConfig$L === void 0 ? void 0 : _extendedChatConfig$L.msdyn_conversationmode);
+  if (!isPersistentChatEnabledForWidget) {
+    return false;
+  }
+
+  // Check if history is enabled in admin config (handles both boolean and string "true"/"false")
+  const isHistoryEnabledInConfig = parseBooleanFromConfig(extendedChatConfig === null || extendedChatConfig === void 0 ? void 0 : (_extendedChatConfig$L2 = extendedChatConfig.LiveWSAndLiveChatEngJoin) === null || _extendedChatConfig$L2 === void 0 ? void 0 : _extendedChatConfig$L2.msdyn_enablepersistentchatpreviousconversations);
+  if (!isHistoryEnabledInConfig) {
+    return false;
+  }
+
+  // Check if history is enabled via feature flag (handles both boolean and string "true"/"false")
+  const isHistoryEnabledViaFCB = parseBooleanFromConfig(extendedChatConfig === null || extendedChatConfig === void 0 ? void 0 : (_extendedChatConfig$L3 = extendedChatConfig.LcwFcbConfiguration) === null || _extendedChatConfig$L3 === void 0 ? void 0 : _extendedChatConfig$L3.lcwPersistentChatHistoryEnabled);
+  return isHistoryEnabledViaFCB;
 };

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

@@ -1,6 +1,7 @@
 const overridePropsOnMockIfApplicable = props => {
   var _props$mock, _props$mock2;
   if (props !== null && props !== void 0 && (_props$mock = props.mock) !== null && _props$mock !== void 0 && _props$mock.type && (props === null || props === void 0 ? void 0 : (_props$mock2 = props.mock) === null || _props$mock2 === void 0 ? void 0 : _props$mock2.type.toLowerCase()) === "designer") {
+    var _props$mock3, _props$mock3$mockMess;
     if (!props.webChatContainerProps) {
       props.webChatContainerProps = {};
     }
@@ -16,7 +17,7 @@ const overridePropsOnMockIfApplicable = props => {
     props.webChatContainerProps = {
       ...props.webChatContainerProps,
       webChatProps: {
-        disabled: true,
+        disabled: !(props !== null && props !== void 0 && (_props$mock3 = props.mock) !== null && _props$mock3 !== void 0 && (_props$mock3$mockMess = _props$mock3.mockMessages) !== null && _props$mock3$mockMess !== void 0 && _props$mock3$mockMess.length),
         ...props.webChatContainerProps.webChatProps,
         overrideLocalizedStrings: {
           TEXT_INPUT_PLACEHOLDER: "Send a message . . .",

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

@@ -24,7 +24,10 @@ export const registerTelemetryLoggers = (props, dispatch) => {
       appInsightsConfig: Object.assign({}, defaultAppInsightsConfig, props.appInsightsConfig)
     };
     if (props.chatConfig) {
+      var _props$chatConfig$Liv;
       telemetryData = TelemetryHelper.addChatConfigDataToTelemetry(props === null || props === void 0 ? void 0 : props.chatConfig, telemetryData);
+      //store AppInsights instrumentation key from chatConfig if present
+      telemetryData.chatConfigAppInsightsKey = (_props$chatConfig$Liv = props.chatConfig.LiveWSAndLiveChatEngJoin) === null || _props$chatConfig$Liv === void 0 ? void 0 : _props$chatConfig$Liv.AppInsightsInstrumentationKey;
     }
     if (!((_props$chatSDK = props.chatSDK) !== null && _props$chatSDK !== void 0 && (_props$chatSDK$omnich = _props$chatSDK.omnichannelConfig) !== null && _props$chatSDK$omnich !== void 0 && _props$chatSDK$omnich.orgId) || ((_props$chatSDK2 = props.chatSDK) === null || _props$chatSDK2 === void 0 ? void 0 : (_props$chatSDK2$omnic = _props$chatSDK2.omnichannelConfig) === null || _props$chatSDK2$omnic === void 0 ? void 0 : _props$chatSDK2$omnic.orgId.trim().length) === 0) {
       throw new Error("orgId is undefined in ChatSDK");

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";
@@ -99,7 +99,7 @@ const setPreChatAndInitiateChat = async (facadeChatSDK, dispatch, setAdapter, is
 
       // If minimized, maximize the chat, if the state is missing, consider it as minimized
       if ((state === null || state === void 0 ? void 0 : state.appStates.isMinimized) === undefined || (state === null || state === void 0 ? void 0 : (_state$appStates = state.appStates) === null || _state$appStates === void 0 ? void 0 : _state$appStates.isMinimized) === true) {
-        var _state$domainStates3, _state$domainStates3$, _state$domainStates4, _state$domainStates4$;
+        var _state$domainStates3, _state$domainStates3$, _state$domainStates4, _state$domainStates4$, _TelemetryManager$Int;
         dispatch({
           type: LiveChatWidgetActionType.SET_MINIMIZED,
           payload: false
@@ -110,7 +110,8 @@ const setPreChatAndInitiateChat = async (facadeChatSDK, dispatch, setAdapter, is
           eventName: BroadcastEvent.MaximizeChat,
           payload: {
             height: state === null || state === void 0 ? void 0 : (_state$domainStates3 = state.domainStates) === null || _state$domainStates3 === void 0 ? void 0 : (_state$domainStates3$ = _state$domainStates3.widgetSize) === null || _state$domainStates3$ === void 0 ? void 0 : _state$domainStates3$.height,
-            width: state === null || state === void 0 ? void 0 : (_state$domainStates4 = state.domainStates) === null || _state$domainStates4 === void 0 ? void 0 : (_state$domainStates4$ = _state$domainStates4.widgetSize) === null || _state$domainStates4$ === void 0 ? void 0 : _state$domainStates4$.width
+            width: state === null || state === void 0 ? void 0 : (_state$domainStates4 = state.domainStates) === null || _state$domainStates4 === void 0 ? void 0 : (_state$domainStates4$ = _state$domainStates4.widgetSize) === null || _state$domainStates4$ === void 0 ? void 0 : _state$domainStates4$.width,
+            runtimeId: TelemetryManager === null || TelemetryManager === void 0 ? void 0 : (_TelemetryManager$Int = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int === void 0 ? void 0 : _TelemetryManager$Int.lcwRuntimeId
           }
         });
       }
@@ -131,7 +132,7 @@ const setPreChatAndInitiateChat = async (facadeChatSDK, dispatch, setAdapter, is
    * This is because a new change to control OOH as closed event when a widget is coming from chat.
    */
   if ((state === null || state === void 0 ? void 0 : state.appStates.isMinimized) === undefined || (state === null || state === void 0 ? void 0 : (_state$appStates2 = state.appStates) === null || _state$appStates2 === void 0 ? void 0 : _state$appStates2.isMinimized) === true) {
-    var _state$domainStates5, _state$domainStates5$, _state$domainStates6, _state$domainStates6$, _TelemetryManager$Int;
+    var _state$domainStates5, _state$domainStates5$, _state$domainStates6, _state$domainStates6$, _TelemetryManager$Int2;
     dispatch({
       type: LiveChatWidgetActionType.SET_MINIMIZED,
       payload: false
@@ -142,7 +143,7 @@ const setPreChatAndInitiateChat = async (facadeChatSDK, dispatch, setAdapter, is
       payload: {
         height: state === null || state === void 0 ? void 0 : (_state$domainStates5 = state.domainStates) === null || _state$domainStates5 === void 0 ? void 0 : (_state$domainStates5$ = _state$domainStates5.widgetSize) === null || _state$domainStates5$ === void 0 ? void 0 : _state$domainStates5$.height,
         width: state === null || state === void 0 ? void 0 : (_state$domainStates6 = state.domainStates) === null || _state$domainStates6 === void 0 ? void 0 : (_state$domainStates6$ = _state$domainStates6.widgetSize) === null || _state$domainStates6$ === void 0 ? void 0 : _state$domainStates6$.width,
-        runtimeId: TelemetryManager === null || TelemetryManager === void 0 ? void 0 : (_TelemetryManager$Int = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int === void 0 ? void 0 : _TelemetryManager$Int.lcwRuntimeId
+        runtimeId: TelemetryManager === null || TelemetryManager === void 0 ? void 0 : (_TelemetryManager$Int2 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int2 === void 0 ? void 0 : _TelemetryManager$Int2.lcwRuntimeId
       }
     });
   }
@@ -173,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
@@ -201,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/IMockProps.js

@@ -1,6 +1,6 @@
-var LiveChatWidgetMockType;
+export let LiveChatWidgetMockType;
 (function (LiveChatWidgetMockType) {
   LiveChatWidgetMockType["Test"] = "Test";
   LiveChatWidgetMockType["Demo"] = "Demo";
-})(LiveChatWidgetMockType || (LiveChatWidgetMockType = {}));
-export {};
+  LiveChatWidgetMockType["Designer"] = "Designer";
+})(LiveChatWidgetMockType || (LiveChatWidgetMockType = {}));

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

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