@microsoft/omnichannel-chat-widget 1.5.1-main.6b98130 → 1.5.1-main.7897747

package/lib/cjs/common/Constants.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.WidgetLoadTelemetryMessage = exports.WidgetLoadCustomErrorString = exports.WebChatMiddlewareConstants = exports.TranscriptConstants = exports.StorageType = exports.StartChatErrorPaneConstants = exports.Regex = exports.ParticipantType = exports.NotificationPaneConstants = exports.MimeTypes = exports.LocaleConstants = exports.LiveWorkItemState = exports.HtmlIdNames = exports.HtmlElementSelectors = exports.HtmlClassNames = exports.HtmlAttributeNames = exports.EnvironmentVersion = exports.ElementType = exports.E2VVOptions = exports.ConversationMode = exports.ConversationEndEntity = exports.Constants = exports.ConfirmationState = exports.AriaTelemetryConstants = exports.AMSConstants = void 0;
+exports.WidgetLoadTelemetryMessage = exports.WidgetLoadCustomErrorString = exports.WebChatMiddlewareConstants = exports.TranscriptConstants = exports.StorageType = exports.StartChatErrorPaneConstants = exports.Regex = exports.PrepareEndChatDescriptionConstants = exports.ParticipantType = exports.NotificationPaneConstants = exports.MimeTypes = exports.LocaleConstants = exports.LiveWorkItemState = exports.HtmlIdNames = exports.HtmlElementSelectors = exports.HtmlClassNames = exports.HtmlAttributeNames = exports.EnvironmentVersion = exports.ElementType = exports.E2VVOptions = exports.ConversationMode = exports.ConversationEndEntity = exports.Constants = exports.ConfirmationState = exports.AriaTelemetryConstants = exports.AMSConstants = void 0;
 var _class;
 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); }
@@ -305,4 +305,16 @@ _defineProperty(WidgetLoadTelemetryMessage, "PersistedStateRetrievedMessage", "P
 class WidgetLoadCustomErrorString {}
 exports.WidgetLoadCustomErrorString = WidgetLoadCustomErrorString;
 _defineProperty(WidgetLoadCustomErrorString, "AuthenticationFailedErrorString", "Authentication was not successful");
-_defineProperty(WidgetLoadCustomErrorString, "NetworkErrorString", "Network Error");
+_defineProperty(WidgetLoadCustomErrorString, "NetworkErrorString", "Network Error");
+class PrepareEndChatDescriptionConstants {}
+exports.PrepareEndChatDescriptionConstants = PrepareEndChatDescriptionConstants;
+_defineProperty(PrepareEndChatDescriptionConstants, "ConversationEndedByCustomerWithoutPostChat", "Conversation ended by customer. Post chat not configured or should not show.");
+_defineProperty(PrepareEndChatDescriptionConstants, "ConversationEndedByCustomerWithInvalidPostChat", "Conversation ended by customer. Post chat context is invalid.");
+_defineProperty(PrepareEndChatDescriptionConstants, "ConversationEndedBy", "Conversation ended by");
+_defineProperty(PrepareEndChatDescriptionConstants, "PrepareEndChatError", "There's an error while preparing to end chat. Closing chat widget.");
+_defineProperty(PrepareEndChatDescriptionConstants, "WidgetLoadFailedAfterSessionInit", "SessionInit was successful, but widget load failed. Ending chat to avoid ghost chats in OC.");
+_defineProperty(PrepareEndChatDescriptionConstants, "InitiateEndChatReceived", "Received InitiateEndChat BroadcastEvent while conversation state is not Active. Ending chat.");
+_defineProperty(PrepareEndChatDescriptionConstants, "EndChatReceivedFromOtherTabs", "Received EndChat BroadcastEvent from other tabs. Closing this chat.");
+_defineProperty(PrepareEndChatDescriptionConstants, "CustomerCloseChatOnFailureOrPostChat", "Customer is trying to close chat widget on start chat failure or post chat pane.");
+_defineProperty(PrepareEndChatDescriptionConstants, "CustomerCloseInactiveChat", "Chat was Inactive and customer is trying to close chat widget or refreshing the page.");
+_defineProperty(PrepareEndChatDescriptionConstants, "BrowserUnload", "Browser unload event received. Ending chat.");

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

@@ -123,6 +123,7 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["StartChatSDKCall"] = "StartChatCall";
   TelemetryEvent["StartChatEventRecevied"] = "StartChatEventReceived";
   TelemetryEvent["EndChatSDKCall"] = "EndChatSDKCall";
+  TelemetryEvent["PrepareEndChat"] = "PrepareEndChat";
   TelemetryEvent["EndChatEventReceived"] = "EndChatEventReceived";
   TelemetryEvent["WindowClosed"] = "WindowClosed";
   TelemetryEvent["OnNewMessageFailed"] = "OnNewMessageFailed";
@@ -290,6 +291,7 @@ class TelemetryConstants {
       case TelemetryEvent.PostChatContextCallFailed:
       case TelemetryEvent.PostChatContextCallSucceed:
       case TelemetryEvent.GetConversationDetailsException:
+      case TelemetryEvent.PrepareEndChat:
         return ScenarioType.SDK;
       case TelemetryEvent.VideoCallAcceptButtonClick:
       case TelemetryEvent.CallAdded:

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

@@ -20,7 +20,7 @@ var _omnichannelChatSdk = require("@microsoft/omnichannel-chat-sdk");
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const prepareEndChat = async (props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter) => {
   try {
-    var _conversationDetails$, _state$domainStates;
+    var _conversationDetails$, _state$domainStates, _state$appStates3;
     // Use Case: If call is ongoing, end the call by simulating end call button click
     endVoiceVideoCallIfOngoing(chatSDK, dispatch);
     const conversationDetails = await (0, _utils.getConversationDetailsCall)(chatSDK);
@@ -30,8 +30,13 @@ const prepareEndChat = async (props, chatSDK, state, dispatch, setAdapter, setWe
       var _state$appStates;
       // If ended by customer, just close chat
       if ((state === null || state === void 0 ? void 0 : (_state$appStates = state.appStates) === null || _state$appStates === void 0 ? void 0 : _state$appStates.conversationEndedBy) === _Constants.ConversationEndEntity.Customer) {
+        _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+          Event: _TelemetryConstants.TelemetryEvent.PrepareEndChat,
+          Description: _Constants.PrepareEndChatDescriptionConstants.ConversationEndedByCustomerWithoutPostChat
+        });
         await endChat(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, false, false, true);
       }
+
       // Use Case: If ended by Agent, stay chat in InActive state
       return;
     }
@@ -51,6 +56,10 @@ const prepareEndChat = async (props, chatSDK, state, dispatch, setAdapter, setWe
       var _state$appStates2;
       // For Customer intiated conversations, just close chat widget
       if ((state === null || state === void 0 ? void 0 : (_state$appStates2 = state.appStates) === null || _state$appStates2 === void 0 ? void 0 : _state$appStates2.conversationEndedBy) === _Constants.ConversationEndEntity.Customer) {
+        _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+          Event: _TelemetryConstants.TelemetryEvent.PrepareEndChat,
+          Description: _Constants.PrepareEndChatDescriptionConstants.ConversationEndedByCustomerWithInvalidPostChat
+        });
         await endChat(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, false, false, true);
         return;
       }
@@ -62,6 +71,15 @@ const prepareEndChat = async (props, chatSDK, state, dispatch, setAdapter, setWe
       });
       return;
     }
+
+    // Log PrepareEndChat if conversation ended by customer (bot and agent cases are handled in LiveChatWidgetStateful.tsx)
+    if (state !== null && state !== void 0 && (_state$appStates3 = state.appStates) !== null && _state$appStates3 !== void 0 && _state$appStates3.conversationEndedBy) {
+      var _state$appStates4;
+      _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+        Event: _TelemetryConstants.TelemetryEvent.PrepareEndChat,
+        Description: `${_Constants.PrepareEndChatDescriptionConstants.ConversationEndedByCustomerWithInvalidPostChat} ${state === null || state === void 0 ? void 0 : (_state$appStates4 = state.appStates) === null || _state$appStates4 === void 0 ? void 0 : _state$appStates4.conversationEndedBy}.`
+      });
+    }
     endChat(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, false, true, true);
 
     // Initiate post chat render
@@ -80,6 +98,10 @@ const prepareEndChat = async (props, chatSDK, state, dispatch, setAdapter, setWe
 
     //Close chat widget for any failure in embedded to allow to show start chat button
     if (((_props$controlProps = props.controlProps) === null || _props$controlProps === void 0 ? void 0 : _props$controlProps.hideStartChatButton) === false) {
+      _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+        Event: _TelemetryConstants.TelemetryEvent.PrepareEndChat,
+        Description: _Constants.PrepareEndChatDescriptionConstants.PrepareEndChatError
+      });
       await endChat(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, false, false, true);
     }
   } finally {
@@ -265,8 +287,8 @@ const endVoiceVideoCallIfOngoing = async (chatSDK, dispatch) => {
 };
 exports.endVoiceVideoCallIfOngoing = endVoiceVideoCallIfOngoing;
 const closeChatWidget = (dispatch, props, state) => {
-  var _state$appStates3;
-  if (state !== null && state !== void 0 && (_state$appStates3 = state.appStates) !== null && _state$appStates3 !== void 0 && _state$appStates3.hideStartChatButton) {
+  var _state$appStates5;
+  if (state !== null && state !== void 0 && (_state$appStates5 = state.appStates) !== null && _state$appStates5 !== void 0 && _state$appStates5.hideStartChatButton) {
     var _props$controlProps2, _props$controlProps3;
     // Only close chat if header is enabled for popout
     // TODO : This condition needs to be removed eventually when the filler UX is ready for popout, removing this condition would show a blank screen for OOB Widget

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

@@ -59,11 +59,19 @@ const initWebChatComposer = (props, state, dispatch, chatSDK, endChat) => {
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       const conversationDetails = await (0, _utils.getConversationDetailsCall)(chatSDK);
       if ((conversationDetails === null || conversationDetails === void 0 ? void 0 : conversationDetails.participantType) === _Constants.ParticipantType.Bot) {
+        _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
+          Event: _TelemetryConstants.TelemetryEvent.ConversationEndedThreadEventReceived,
+          Description: "Conversation end by bot or timeout event received."
+        });
         dispatch({
           type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_ENDED_BY,
           payload: _Constants.ConversationEndEntity.Bot
         });
       } else {
+        _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
+          Event: _TelemetryConstants.TelemetryEvent.ConversationEndedThreadEventReceived,
+          Description: "Conversation end by agent or timeout event received."
+        });
         dispatch({
           type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_ENDED_BY,
           payload: _Constants.ConversationEndEntity.Agent
@@ -75,10 +83,6 @@ const initWebChatComposer = (props, state, dispatch, chatSDK, endChat) => {
           payload: conversationDetails === null || conversationDetails === void 0 ? void 0 : conversationDetails.participantType
         });
       }
-      _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
-        Event: _TelemetryConstants.TelemetryEvent.ConversationEndedThreadEventReceived,
-        Description: "Conversation end by agent side or by timeout event received."
-      });
     };
     webChatStore = (0, _botframeworkWebchat.createStore)({},
     //initial state

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

@@ -141,11 +141,12 @@ const logWidgetLoadCompleteWithError = ex => {
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const forceEndChat = chatSDK => {
-  _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.ERROR, {
-    Event: _TelemetryConstants.TelemetryEvent.WidgetLoadFailed,
-    ExceptionDetails: {
-      Exception: "SessionInit was successful, but widget load failed."
-    }
+  _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+    Event: _TelemetryConstants.TelemetryEvent.PrepareEndChat,
+    Description: _Constants.PrepareEndChatDescriptionConstants.WidgetLoadFailedAfterSessionInit
+  });
+  _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+    Event: _TelemetryConstants.TelemetryEvent.EndChatSDKCall
   });
   chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.endChat();
 };

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

@@ -413,9 +413,23 @@ const LiveChatWidgetStateful = props => {
 
     // End chat
     _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.BroadcastEvent.InitiateEndChat).subscribe(async () => {
+      _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+        Event: _TelemetryConstants.TelemetryEvent.EndChatEventReceived,
+        Description: "Received InitiateEndChat BroadcastEvent."
+      });
+
       // This is to ensure to get latest state from cache in multitab
       const persistedState = (0, _utils.getStateFromCache)((0, _utils.getWidgetCacheIdfromProps)(props));
       if (persistedState && persistedState.appStates.conversationState === _ConversationState.ConversationState.Active) {
+        // We need to simulate states for closing chat, in order to messup with close confirmation pane.
+        dispatch({
+          type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONFIRMATION_STATE,
+          payload: _Constants.ConfirmationState.Ok
+        });
+        dispatch({
+          type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_SHOW_CONFIRMATION,
+          payload: false
+        });
         dispatch({
           type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_ENDED_BY,
           payload: _Constants.ConversationEndEntity.Customer
@@ -423,6 +437,10 @@ const LiveChatWidgetStateful = props => {
       } else {
         const skipEndChatSDK = true;
         const skipCloseChat = false;
+        _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+          Event: _TelemetryConstants.TelemetryEvent.PrepareEndChat,
+          Description: _Constants.PrepareEndChatDescriptionConstants.InitiateEndChatReceived
+        });
         (0, _endChat.endChat)(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, skipEndChatSDK, skipCloseChat);
       }
       _omnichannelChatComponents.BroadcastService.postMessage({
@@ -440,6 +458,10 @@ const LiveChatWidgetStateful = props => {
     _omnichannelChatComponents.BroadcastService.getMessageByEventName(endChatEventName).subscribe(msg => {
       var _msg$payload9;
       if ((msg === null || msg === void 0 ? void 0 : (_msg$payload9 = msg.payload) === null || _msg$payload9 === void 0 ? void 0 : _msg$payload9.runtimeId) !== _TelemetryManager.TelemetryManager.InternalTelemetryData.lcwRuntimeId) {
+        _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+          Event: _TelemetryConstants.TelemetryEvent.PrepareEndChat,
+          Description: "Received EndChat BroadcastEvent from other tabs. Closing this chat."
+        });
         (0, _endChat.endChat)(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, true, false, false);
         (0, _endChat.endChatStateCleanUp)(dispatch);
         (0, _endChat.chatSDKStateCleanUp)(chatSDK);
@@ -570,12 +592,20 @@ const LiveChatWidgetStateful = props => {
 
     // If start chat failed, and C2 is trying to close chat widget
     if (state !== null && state !== void 0 && (_state$appStates9 = state.appStates) !== null && _state$appStates9 !== void 0 && _state$appStates9.startChatFailed || (state === null || state === void 0 ? void 0 : (_state$appStates10 = state.appStates) === null || _state$appStates10 === void 0 ? void 0 : _state$appStates10.conversationState) === _ConversationState.ConversationState.Postchat) {
+      _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+        Event: _TelemetryConstants.TelemetryEvent.PrepareEndChat,
+        Description: _Constants.PrepareEndChatDescriptionConstants.CustomerCloseChatOnFailureOrPostChat
+      });
       (0, _endChat.endChat)(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, true, false, true);
       return;
     }
 
     // Scenario -> Chat was InActive and closing the chat (Refresh scenario on post chat)
     if ((state === null || state === void 0 ? void 0 : (_state$appStates11 = state.appStates) === null || _state$appStates11 === void 0 ? void 0 : _state$appStates11.conversationState) === _ConversationState.ConversationState.InActive) {
+      _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+        Event: _TelemetryConstants.TelemetryEvent.PrepareEndChat,
+        Description: _Constants.PrepareEndChatDescriptionConstants.CustomerCloseInactiveChat
+      });
       (0, _endChat.endChat)(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, false, false, true);
       return;
     }
@@ -628,6 +658,10 @@ const LiveChatWidgetStateful = props => {
       Event: _TelemetryConstants.TelemetryEvent.BrowserUnloadEventStarted,
       Description: "Browser unload event received."
     });
+    _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+      Event: _TelemetryConstants.TelemetryEvent.PrepareEndChat,
+      Description: _Constants.PrepareEndChatDescriptionConstants.BrowserUnload
+    });
     (0, _endChat.endChat)(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, false, false, false);
     // Clean local storage
     (_DataStoreManager$cli = _DataStoreManager.DataStoreManager.clientDataStore) === null || _DataStoreManager$cli === void 0 ? void 0 : _DataStoreManager$cli.removeData(widgetStateEventId);

package/lib/esm/common/Constants.js

@@ -274,4 +274,15 @@ _defineProperty(WidgetLoadTelemetryMessage, "OOOHMessage", "Widget is OOOH");
 _defineProperty(WidgetLoadTelemetryMessage, "PersistedStateRetrievedMessage", "Persisted state retrieved");
 export class WidgetLoadCustomErrorString {}
 _defineProperty(WidgetLoadCustomErrorString, "AuthenticationFailedErrorString", "Authentication was not successful");
-_defineProperty(WidgetLoadCustomErrorString, "NetworkErrorString", "Network Error");
+_defineProperty(WidgetLoadCustomErrorString, "NetworkErrorString", "Network Error");
+export class PrepareEndChatDescriptionConstants {}
+_defineProperty(PrepareEndChatDescriptionConstants, "ConversationEndedByCustomerWithoutPostChat", "Conversation ended by customer. Post chat not configured or should not show.");
+_defineProperty(PrepareEndChatDescriptionConstants, "ConversationEndedByCustomerWithInvalidPostChat", "Conversation ended by customer. Post chat context is invalid.");
+_defineProperty(PrepareEndChatDescriptionConstants, "ConversationEndedBy", "Conversation ended by");
+_defineProperty(PrepareEndChatDescriptionConstants, "PrepareEndChatError", "There's an error while preparing to end chat. Closing chat widget.");
+_defineProperty(PrepareEndChatDescriptionConstants, "WidgetLoadFailedAfterSessionInit", "SessionInit was successful, but widget load failed. Ending chat to avoid ghost chats in OC.");
+_defineProperty(PrepareEndChatDescriptionConstants, "InitiateEndChatReceived", "Received InitiateEndChat BroadcastEvent while conversation state is not Active. Ending chat.");
+_defineProperty(PrepareEndChatDescriptionConstants, "EndChatReceivedFromOtherTabs", "Received EndChat BroadcastEvent from other tabs. Closing this chat.");
+_defineProperty(PrepareEndChatDescriptionConstants, "CustomerCloseChatOnFailureOrPostChat", "Customer is trying to close chat widget on start chat failure or post chat pane.");
+_defineProperty(PrepareEndChatDescriptionConstants, "CustomerCloseInactiveChat", "Chat was Inactive and customer is trying to close chat widget or refreshing the page.");
+_defineProperty(PrepareEndChatDescriptionConstants, "BrowserUnload", "Browser unload event received. Ending chat.");

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

@@ -117,6 +117,7 @@ export let TelemetryEvent;
   TelemetryEvent["StartChatSDKCall"] = "StartChatCall";
   TelemetryEvent["StartChatEventRecevied"] = "StartChatEventReceived";
   TelemetryEvent["EndChatSDKCall"] = "EndChatSDKCall";
+  TelemetryEvent["PrepareEndChat"] = "PrepareEndChat";
   TelemetryEvent["EndChatEventReceived"] = "EndChatEventReceived";
   TelemetryEvent["WindowClosed"] = "WindowClosed";
   TelemetryEvent["OnNewMessageFailed"] = "OnNewMessageFailed";
@@ -284,6 +285,7 @@ export class TelemetryConstants {
       case TelemetryEvent.PostChatContextCallFailed:
       case TelemetryEvent.PostChatContextCallSucceed:
       case TelemetryEvent.GetConversationDetailsException:
+      case TelemetryEvent.PrepareEndChat:
         return ScenarioType.SDK;
       case TelemetryEvent.VideoCallAcceptButtonClick:
       case TelemetryEvent.CallAdded:

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

@@ -1,4 +1,4 @@
-import { ConfirmationState, Constants, ConversationEndEntity, ParticipantType } from "../../../common/Constants";
+import { ConfirmationState, Constants, ConversationEndEntity, ParticipantType, PrepareEndChatDescriptionConstants } from "../../../common/Constants";
 import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
 import { getAuthClientFunction, handleAuthentication } from "./authHelper";
 import { getConversationDetailsCall, getWidgetEndChatEventName } from "../../../common/utils";
@@ -15,7 +15,7 @@ import { uuidv4 } from "@microsoft/omnichannel-chat-sdk";
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const prepareEndChat = async (props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter) => {
   try {
-    var _conversationDetails$, _state$domainStates;
+    var _conversationDetails$, _state$domainStates, _state$appStates3;
     // Use Case: If call is ongoing, end the call by simulating end call button click
     endVoiceVideoCallIfOngoing(chatSDK, dispatch);
     const conversationDetails = await getConversationDetailsCall(chatSDK);
@@ -25,8 +25,13 @@ const prepareEndChat = async (props, chatSDK, state, dispatch, setAdapter, setWe
       var _state$appStates;
       // If ended by customer, just close chat
       if ((state === null || state === void 0 ? void 0 : (_state$appStates = state.appStates) === null || _state$appStates === void 0 ? void 0 : _state$appStates.conversationEndedBy) === ConversationEndEntity.Customer) {
+        TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+          Event: TelemetryEvent.PrepareEndChat,
+          Description: PrepareEndChatDescriptionConstants.ConversationEndedByCustomerWithoutPostChat
+        });
         await endChat(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, false, false, true);
       }
+
       // Use Case: If ended by Agent, stay chat in InActive state
       return;
     }
@@ -46,6 +51,10 @@ const prepareEndChat = async (props, chatSDK, state, dispatch, setAdapter, setWe
       var _state$appStates2;
       // For Customer intiated conversations, just close chat widget
       if ((state === null || state === void 0 ? void 0 : (_state$appStates2 = state.appStates) === null || _state$appStates2 === void 0 ? void 0 : _state$appStates2.conversationEndedBy) === ConversationEndEntity.Customer) {
+        TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+          Event: TelemetryEvent.PrepareEndChat,
+          Description: PrepareEndChatDescriptionConstants.ConversationEndedByCustomerWithInvalidPostChat
+        });
         await endChat(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, false, false, true);
         return;
       }
@@ -57,6 +66,15 @@ const prepareEndChat = async (props, chatSDK, state, dispatch, setAdapter, setWe
       });
       return;
     }
+
+    // Log PrepareEndChat if conversation ended by customer (bot and agent cases are handled in LiveChatWidgetStateful.tsx)
+    if (state !== null && state !== void 0 && (_state$appStates3 = state.appStates) !== null && _state$appStates3 !== void 0 && _state$appStates3.conversationEndedBy) {
+      var _state$appStates4;
+      TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.PrepareEndChat,
+        Description: `${PrepareEndChatDescriptionConstants.ConversationEndedByCustomerWithInvalidPostChat} ${state === null || state === void 0 ? void 0 : (_state$appStates4 = state.appStates) === null || _state$appStates4 === void 0 ? void 0 : _state$appStates4.conversationEndedBy}.`
+      });
+    }
     endChat(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, false, true, true);
 
     // Initiate post chat render
@@ -75,6 +93,10 @@ const prepareEndChat = async (props, chatSDK, state, dispatch, setAdapter, setWe
 
     //Close chat widget for any failure in embedded to allow to show start chat button
     if (((_props$controlProps = props.controlProps) === null || _props$controlProps === void 0 ? void 0 : _props$controlProps.hideStartChatButton) === false) {
+      TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.PrepareEndChat,
+        Description: PrepareEndChatDescriptionConstants.PrepareEndChatError
+      });
       await endChat(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, false, false, true);
     }
   } finally {
@@ -253,8 +275,8 @@ export const endVoiceVideoCallIfOngoing = async (chatSDK, dispatch) => {
   }
 };
 const closeChatWidget = (dispatch, props, state) => {
-  var _state$appStates3;
-  if (state !== null && state !== void 0 && (_state$appStates3 = state.appStates) !== null && _state$appStates3 !== void 0 && _state$appStates3.hideStartChatButton) {
+  var _state$appStates5;
+  if (state !== null && state !== void 0 && (_state$appStates5 = state.appStates) !== null && _state$appStates5 !== void 0 && _state$appStates5.hideStartChatButton) {
     var _props$controlProps2, _props$controlProps3;
     // Only close chat if header is enabled for popout
     // TODO : This condition needs to be removed eventually when the filler UX is ready for popout, removing this condition would show a blank screen for OOB Widget

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

@@ -53,11 +53,19 @@ export const initWebChatComposer = (props, state, dispatch, chatSDK, endChat) =>
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       const conversationDetails = await getConversationDetailsCall(chatSDK);
       if ((conversationDetails === null || conversationDetails === void 0 ? void 0 : conversationDetails.participantType) === ParticipantType.Bot) {
+        TelemetryHelper.logActionEvent(LogLevel.INFO, {
+          Event: TelemetryEvent.ConversationEndedThreadEventReceived,
+          Description: "Conversation end by bot or timeout event received."
+        });
         dispatch({
           type: LiveChatWidgetActionType.SET_CONVERSATION_ENDED_BY,
           payload: ConversationEndEntity.Bot
         });
       } else {
+        TelemetryHelper.logActionEvent(LogLevel.INFO, {
+          Event: TelemetryEvent.ConversationEndedThreadEventReceived,
+          Description: "Conversation end by agent or timeout event received."
+        });
         dispatch({
           type: LiveChatWidgetActionType.SET_CONVERSATION_ENDED_BY,
           payload: ConversationEndEntity.Agent
@@ -69,10 +77,6 @@ export const initWebChatComposer = (props, state, dispatch, chatSDK, endChat) =>
           payload: conversationDetails === null || conversationDetails === void 0 ? void 0 : conversationDetails.participantType
         });
       }
-      TelemetryHelper.logActionEvent(LogLevel.INFO, {
-        Event: TelemetryEvent.ConversationEndedThreadEventReceived,
-        Description: "Conversation end by agent side or by timeout event received."
-      });
     };
     webChatStore = createStore({},
     //initial state

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

@@ -7,7 +7,7 @@ import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidge
 import { callingStateCleanUp, endChatStateCleanUp, closeChatStateCleanUp, chatSDKStateCleanUp } from "./endChat";
 import { DataStoreManager } from "../../../common/contextDataStore/DataStoreManager";
 import { getWidgetCacheIdfromProps } from "../../../common/utils";
-import { WidgetLoadCustomErrorString, WidgetLoadTelemetryMessage } from "../../../common/Constants";
+import { PrepareEndChatDescriptionConstants, WidgetLoadCustomErrorString, WidgetLoadTelemetryMessage } from "../../../common/Constants";
 import { StartChatFailureType } from "../../../contexts/common/StartChatFailureType";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -134,11 +134,12 @@ const logWidgetLoadCompleteWithError = ex => {
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const forceEndChat = chatSDK => {
-  TelemetryHelper.logLoadingEvent(LogLevel.ERROR, {
-    Event: TelemetryEvent.WidgetLoadFailed,
-    ExceptionDetails: {
-      Exception: "SessionInit was successful, but widget load failed."
-    }
+  TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+    Event: TelemetryEvent.PrepareEndChat,
+    Description: PrepareEndChatDescriptionConstants.WidgetLoadFailedAfterSessionInit
+  });
+  TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+    Event: TelemetryEvent.EndChatSDKCall
   });
   chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.endChat();
 };

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

@@ -2,7 +2,7 @@ function _extends() { _extends = Object.assign ? Object.assign.bind() : function
 import { BroadcastEvent, 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, StorageType } from "../../../common/Constants";
+import { ConfirmationState, Constants, ConversationEndEntity, E2VVOptions, LiveWorkItemState, PrepareEndChatDescriptionConstants, StorageType } from "../../../common/Constants";
 import { Stack } from "@fluentui/react";
 import React, { useEffect, useRef, useState } from "react";
 import { checkIfConversationStillValid, initStartChat, prepareStartChat, setPreChatAndInitiateChat } from "../common/startChat";
@@ -405,9 +405,23 @@ export const LiveChatWidgetStateful = props => {
 
     // End chat
     BroadcastService.getMessageByEventName(BroadcastEvent.InitiateEndChat).subscribe(async () => {
+      TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.EndChatEventReceived,
+        Description: "Received InitiateEndChat BroadcastEvent."
+      });
+
       // This is to ensure to get latest state from cache in multitab
       const persistedState = getStateFromCache(getWidgetCacheIdfromProps(props));
       if (persistedState && persistedState.appStates.conversationState === ConversationState.Active) {
+        // We need to simulate states for closing chat, in order to messup with close confirmation pane.
+        dispatch({
+          type: LiveChatWidgetActionType.SET_CONFIRMATION_STATE,
+          payload: ConfirmationState.Ok
+        });
+        dispatch({
+          type: LiveChatWidgetActionType.SET_SHOW_CONFIRMATION,
+          payload: false
+        });
         dispatch({
           type: LiveChatWidgetActionType.SET_CONVERSATION_ENDED_BY,
           payload: ConversationEndEntity.Customer
@@ -415,6 +429,10 @@ export const LiveChatWidgetStateful = props => {
       } else {
         const skipEndChatSDK = true;
         const skipCloseChat = false;
+        TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+          Event: TelemetryEvent.PrepareEndChat,
+          Description: PrepareEndChatDescriptionConstants.InitiateEndChatReceived
+        });
         endChat(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, skipEndChatSDK, skipCloseChat);
       }
       BroadcastService.postMessage({
@@ -432,6 +450,10 @@ export const LiveChatWidgetStateful = props => {
     BroadcastService.getMessageByEventName(endChatEventName).subscribe(msg => {
       var _msg$payload9;
       if ((msg === null || msg === void 0 ? void 0 : (_msg$payload9 = msg.payload) === null || _msg$payload9 === void 0 ? void 0 : _msg$payload9.runtimeId) !== TelemetryManager.InternalTelemetryData.lcwRuntimeId) {
+        TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+          Event: TelemetryEvent.PrepareEndChat,
+          Description: "Received EndChat BroadcastEvent from other tabs. Closing this chat."
+        });
         endChat(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, true, false, false);
         endChatStateCleanUp(dispatch);
         chatSDKStateCleanUp(chatSDK);
@@ -562,12 +584,20 @@ export const LiveChatWidgetStateful = props => {
 
     // If start chat failed, and C2 is trying to close chat widget
     if (state !== null && state !== void 0 && (_state$appStates9 = state.appStates) !== null && _state$appStates9 !== void 0 && _state$appStates9.startChatFailed || (state === null || state === void 0 ? void 0 : (_state$appStates10 = state.appStates) === null || _state$appStates10 === void 0 ? void 0 : _state$appStates10.conversationState) === ConversationState.Postchat) {
+      TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.PrepareEndChat,
+        Description: PrepareEndChatDescriptionConstants.CustomerCloseChatOnFailureOrPostChat
+      });
       endChat(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, true, false, true);
       return;
     }
 
     // Scenario -> Chat was InActive and closing the chat (Refresh scenario on post chat)
     if ((state === null || state === void 0 ? void 0 : (_state$appStates11 = state.appStates) === null || _state$appStates11 === void 0 ? void 0 : _state$appStates11.conversationState) === ConversationState.InActive) {
+      TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.PrepareEndChat,
+        Description: PrepareEndChatDescriptionConstants.CustomerCloseInactiveChat
+      });
       endChat(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, false, false, true);
       return;
     }
@@ -620,6 +650,10 @@ export const LiveChatWidgetStateful = props => {
       Event: TelemetryEvent.BrowserUnloadEventStarted,
       Description: "Browser unload event received."
     });
+    TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+      Event: TelemetryEvent.PrepareEndChat,
+      Description: PrepareEndChatDescriptionConstants.BrowserUnload
+    });
     endChat(props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, false, false, false);
     // Clean local storage
     (_DataStoreManager$cli = DataStoreManager.clientDataStore) === null || _DataStoreManager$cli === void 0 ? void 0 : _DataStoreManager$cli.removeData(widgetStateEventId);

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

@@ -254,3 +254,15 @@ export declare class WidgetLoadCustomErrorString {
     static readonly AuthenticationFailedErrorString = "Authentication was not successful";
     static readonly NetworkErrorString = "Network Error";
 }
+export declare class PrepareEndChatDescriptionConstants {
+    static readonly ConversationEndedByCustomerWithoutPostChat = "Conversation ended by customer. Post chat not configured or should not show.";
+    static readonly ConversationEndedByCustomerWithInvalidPostChat = "Conversation ended by customer. Post chat context is invalid.";
+    static readonly ConversationEndedBy = "Conversation ended by";
+    static readonly PrepareEndChatError = "There's an error while preparing to end chat. Closing chat widget.";
+    static readonly WidgetLoadFailedAfterSessionInit = "SessionInit was successful, but widget load failed. Ending chat to avoid ghost chats in OC.";
+    static readonly InitiateEndChatReceived = "Received InitiateEndChat BroadcastEvent while conversation state is not Active. Ending chat.";
+    static readonly EndChatReceivedFromOtherTabs = "Received EndChat BroadcastEvent from other tabs. Closing this chat.";
+    static readonly CustomerCloseChatOnFailureOrPostChat = "Customer is trying to close chat widget on start chat failure or post chat pane.";
+    static readonly CustomerCloseInactiveChat = "Chat was Inactive and customer is trying to close chat widget or refreshing the page.";
+    static readonly BrowserUnload = "Browser unload event received. Ending chat.";
+}

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

@@ -110,6 +110,7 @@ export declare enum TelemetryEvent {
     StartChatSDKCall = "StartChatCall",
     StartChatEventRecevied = "StartChatEventReceived",
     EndChatSDKCall = "EndChatSDKCall",
+    PrepareEndChat = "PrepareEndChat",
     EndChatEventReceived = "EndChatEventReceived",
     WindowClosed = "WindowClosed",
     OnNewMessageFailed = "OnNewMessageFailed",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/omnichannel-chat-widget",
-  "version": "1.5.1-main.6b98130",
+  "version": "1.5.1-main.7897747",
   "description": "Microsoft Omnichannel Chat Widget",
   "main": "lib/cjs/index.js",
   "types": "lib/types/index.d.ts",
@@ -97,8 +97,8 @@
     "test:e2e:build": "yarn build-sample && cd automation_tests && yarn test",
     "test:visual": "jest -c jest.config.visual.cjs",
     "test:all": "yarn test:unit && yarn test:visual",
-    "build:esm": "babel ./src --config-file ./babel.esm.config.json --out-dir lib/esm --extensions .ts,.js,.tsx --ignore **/*.test.ts,**/*.stories.tsx,**/*.test.tsx",
-    "build:cjs": "babel ./src --config-file ./babel.config.json --out-dir lib/cjs --extensions .ts,.js,.tsx --ignore **/*.test.ts,**/*.stories.tsx,**/*.test.tsx",
+    "build:esm": "babel ./src --config-file ./babel.esm.config.json --out-dir lib/esm --extensions .ts,.js,.tsx --ignore **/*.test.ts,**/*.stories.tsx,**/*.test.tsx,**/*.spec.ts,**/*.spec.tsx",
+    "build:cjs": "babel ./src --config-file ./babel.config.json --out-dir lib/cjs --extensions .ts,.js,.tsx --ignore **/*.test.ts,**/*.stories.tsx,**/*.test.tsx,**/*.spec.ts,**/*.spec.tsx",
     "verify": "yarn install && yarn build-storybook && yarn test:all && yarn build && yarn storybook",
     "testpack": "yarn build && yarn pack",
     "build-sample": "yarn build && webpack --config ./webpack.config.cjs",

package/lib/cjs/components/emailtranscriptpanestateful/EmailTranscriptPaneStateful.spec.js

@@ -1,71 +0,0 @@
-"use strict";
-
-var _omnichannelChatSdk = require("@microsoft/omnichannel-chat-sdk");
-var _react = require("@testing-library/react");
-jest.mock("@microsoft/omnichannel-chat-sdk");
-describe("EmailTranscriptPaneStateful unit test", () => {
-  afterEach(() => {
-    _react.cleanup;
-    jest.resetAllMocks();
-  });
-  it("Method emailLiveChatTranscript is called", async () => {
-    const omnichannelConfig = {
-      orgUrl: "",
-      orgId: "",
-      widgetId: ""
-    };
-    const chatSDK = new _omnichannelChatSdk.OmnichannelChatSDK(omnichannelConfig);
-    jest.spyOn(chatSDK, "emailLiveChatTranscript").mockResolvedValue(Promise.resolve());
-    const chatTranscriptBody = {
-      emailAddress: "sample@microsoft.com",
-      attachmentMessage: "sample",
-      locale: "sample"
-    };
-    try {
-      await chatSDK.emailLiveChatTranscript(chatTranscriptBody);
-      expect(chatSDK.emailLiveChatTranscript).toHaveBeenCalledTimes(1);
-      // eslint-disable-next-line no-empty
-    } catch (ex) {}
-  });
-  it("Method emailLiveChatTranscript throws exception", async () => {
-    const errorMessage = "Error";
-    const omnichannelConfig = {
-      orgUrl: "",
-      orgId: "",
-      widgetId: ""
-    };
-    const chatSDK = new _omnichannelChatSdk.OmnichannelChatSDK(omnichannelConfig);
-    jest.spyOn(chatSDK, "emailLiveChatTranscript").mockRejectedValue(new Error(errorMessage));
-    const chatTranscriptBody = {
-      emailAddress: "sample@microsoft.com",
-      attachmentMessage: "sample",
-      locale: "sample"
-    };
-    try {
-      await chatSDK.emailLiveChatTranscript(chatTranscriptBody);
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    } catch (ex) {
-      expect(ex.message).toEqual(errorMessage);
-    }
-  });
-  it("Method emailLiveChatTranscript undefined throws exception", async () => {
-    const errorMessage = "Error";
-    const omnichannelConfig = {
-      orgUrl: "",
-      orgId: "",
-      widgetId: ""
-    };
-    const chatSDK = new _omnichannelChatSdk.OmnichannelChatSDK(omnichannelConfig);
-    const chatTranscriptBody = {
-      emailAddress: "sample@microsoft.com",
-      attachmentMessage: "sample",
-      locale: "sample"
-    };
-    try {
-      await chatSDK.emailLiveChatTranscript(chatTranscriptBody);
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    } catch (ex) {
-      expect(ex.message).toEqual(errorMessage);
-    }
-  });
-});