@microsoft/omnichannel-chat-widget 1.5.1-main.e2be12d → 1.6.0

package/lib/cjs/components/startchaterrorpanestateful/interfaces/IStartChatErrorPaneProps.js

@@ -0,0 +1 @@
+"use strict";

package/lib/cjs/components/startchaterrorpanestateful/interfaces/IStartChatErrorPaneStyleProps.js

@@ -0,0 +1 @@
+"use strict";

package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityMiddleware.js

@@ -54,7 +54,7 @@ const handleSystemMessage = (next, args, card, systemMessageStyleProps) => {
   return () => /*#__PURE__*/_react.default.createElement("div", {
     key: card.activity.id,
     style: systemMessageStyles,
-    "aria-hidden": "true",
+    "aria-hidden": "false",
     dangerouslySetInnerHTML: {
       __html: (0, _utils.escapeHtml)(card.activity.text)
     }
@@ -100,8 +100,7 @@ const createActivityMiddleware = (systemMessageStyleProps, userMessageStyleProps
       return function () {
         return /*#__PURE__*/_react.default.createElement("div", {
           className: card.activity.from.role === _DirectLineSenderRole.DirectLineSenderRole.User ? _Constants.Constants.sentMessageClassName : _Constants.Constants.receivedMessageClassName,
-          style: userMessageStyles,
-          "aria-hidden": "true"
+          style: userMessageStyles
         }, next(...args)(...arguments));
       };
     }

package/lib/cjs/contexts/common/ConversationState.js

@@ -17,4 +17,5 @@ exports.ConversationState = ConversationState;
   ConversationState[ConversationState["PostchatLoading"] = 7] = "PostchatLoading";
   ConversationState[ConversationState["Postchat"] = 8] = "Postchat";
   ConversationState[ConversationState["Closed"] = 9] = "Closed";
+  ConversationState[ConversationState["Error"] = 10] = "Error";
 })(ConversationState || (exports.ConversationState = ConversationState = {}));

package/lib/cjs/contexts/common/LiveChatWidgetActionType.js

@@ -15,40 +15,41 @@ exports.LiveChatWidgetActionType = LiveChatWidgetActionType;
   LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATION_STATE"] = 5] = "SET_CONVERSATION_STATE";
   LiveChatWidgetActionType[LiveChatWidgetActionType["SET_PREVIOUS_FOCUSED_ELEMENT_ID"] = 6] = "SET_PREVIOUS_FOCUSED_ELEMENT_ID";
   LiveChatWidgetActionType[LiveChatWidgetActionType["SET_START_CHAT_FAILING"] = 7] = "SET_START_CHAT_FAILING";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_OUTSIDE_OPERATING_HOURS"] = 8] = "SET_OUTSIDE_OPERATING_HOURS";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_PRE_CHAT_SURVEY_RESPONSE"] = 9] = "SET_PRE_CHAT_SURVEY_RESPONSE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CUSTOM_CONTEXT"] = 10] = "SET_CUSTOM_CONTEXT";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SHOW_CONFIRMATION"] = 11] = "SET_SHOW_CONFIRMATION";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SHOW_EMAIL_TRANSCRIPT_PANE"] = 12] = "SET_SHOW_EMAIL_TRANSCRIPT_PANE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_PRECHAT_RESPONSE_EMAIL"] = 13] = "SET_PRECHAT_RESPONSE_EMAIL";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_AUDIO_NOTIFICATION"] = 14] = "SET_AUDIO_NOTIFICATION";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_E2VV_ENABLED"] = 15] = "SET_E2VV_ENABLED";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_POST_CHAT_CONTEXT"] = 16] = "SET_POST_CHAT_CONTEXT";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SHOW_CALLING_CONTAINER"] = 17] = "SHOW_CALLING_CONTAINER";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_INCOMING_CALL"] = 18] = "SET_INCOMING_CALL";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["DISABLE_VIDEO_CALL"] = 19] = "DISABLE_VIDEO_CALL";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["DISABLE_LOCAL_VIDEO"] = 20] = "DISABLE_LOCAL_VIDEO";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["DISABLE_REMOTE_VIDEO"] = 21] = "DISABLE_REMOTE_VIDEO";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CHAT_TOKEN"] = 22] = "SET_CHAT_TOKEN";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_START_CHAT_BUTTON_DISPLAY"] = 23] = "SET_START_CHAT_BUTTON_DISPLAY";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_PROACTIVE_CHAT_PARAMS"] = 24] = "SET_PROACTIVE_CHAT_PARAMS";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_TELEMETRY_DATA"] = 25] = "SET_TELEMETRY_DATA";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_RECONNECT_ID"] = 26] = "SET_RECONNECT_ID";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_UNREAD_MESSAGE_COUNT"] = 27] = "SET_UNREAD_MESSAGE_COUNT";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_FOCUS_CHAT_BUTTON"] = 28] = "SET_FOCUS_CHAT_BUTTON";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATION_ENDED_BY_AGENT_EVENT_RECEIVED"] = 29] = "SET_CONVERSATION_ENDED_BY_AGENT_EVENT_RECEIVED";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATION_ENDED_BY"] = 30] = "SET_CONVERSATION_ENDED_BY";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_WIDGET_STATE"] = 31] = "SET_WIDGET_STATE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_LIVE_CHAT_CONTEXT"] = 32] = "SET_LIVE_CHAT_CONTEXT";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_BOT_OAUTH_SIGNIN_ID"] = 33] = "SET_BOT_OAUTH_SIGNIN_ID";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_WIDGET_SIZE"] = 34] = "SET_WIDGET_SIZE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_WIDGET_INSTANCE_ID"] = 35] = "SET_WIDGET_INSTANCE_ID";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_LIVE_CHAT_CONFIG"] = 36] = "SET_LIVE_CHAT_CONFIG";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_POST_CHAT_WORKFLOW_IN_PROGRESS"] = 37] = "SET_POST_CHAT_WORKFLOW_IN_PROGRESS";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_INITIAL_CHAT_SDK_REQUEST_ID"] = 38] = "SET_INITIAL_CHAT_SDK_REQUEST_ID";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SHOULD_USE_BOT_SURVEY"] = 39] = "SET_SHOULD_USE_BOT_SURVEY";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CHAT_DISCONNECT_EVENT_RECEIVED"] = 40] = "SET_CHAT_DISCONNECT_EVENT_RECEIVED";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SURVEY_MODE"] = 41] = "SET_SURVEY_MODE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONFIRMATION_STATE"] = 42] = "SET_CONFIRMATION_STATE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_POST_CHAT_PARTICIPANT_TYPE"] = 43] = "SET_POST_CHAT_PARTICIPANT_TYPE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_START_CHAT_FAILURE_TYPE"] = 8] = "SET_START_CHAT_FAILURE_TYPE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_OUTSIDE_OPERATING_HOURS"] = 9] = "SET_OUTSIDE_OPERATING_HOURS";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_PRE_CHAT_SURVEY_RESPONSE"] = 10] = "SET_PRE_CHAT_SURVEY_RESPONSE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CUSTOM_CONTEXT"] = 11] = "SET_CUSTOM_CONTEXT";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SHOW_CONFIRMATION"] = 12] = "SET_SHOW_CONFIRMATION";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SHOW_EMAIL_TRANSCRIPT_PANE"] = 13] = "SET_SHOW_EMAIL_TRANSCRIPT_PANE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_PRECHAT_RESPONSE_EMAIL"] = 14] = "SET_PRECHAT_RESPONSE_EMAIL";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_AUDIO_NOTIFICATION"] = 15] = "SET_AUDIO_NOTIFICATION";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_E2VV_ENABLED"] = 16] = "SET_E2VV_ENABLED";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_POST_CHAT_CONTEXT"] = 17] = "SET_POST_CHAT_CONTEXT";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SHOW_CALLING_CONTAINER"] = 18] = "SHOW_CALLING_CONTAINER";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_INCOMING_CALL"] = 19] = "SET_INCOMING_CALL";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["DISABLE_VIDEO_CALL"] = 20] = "DISABLE_VIDEO_CALL";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["DISABLE_LOCAL_VIDEO"] = 21] = "DISABLE_LOCAL_VIDEO";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["DISABLE_REMOTE_VIDEO"] = 22] = "DISABLE_REMOTE_VIDEO";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CHAT_TOKEN"] = 23] = "SET_CHAT_TOKEN";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_START_CHAT_BUTTON_DISPLAY"] = 24] = "SET_START_CHAT_BUTTON_DISPLAY";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_PROACTIVE_CHAT_PARAMS"] = 25] = "SET_PROACTIVE_CHAT_PARAMS";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_TELEMETRY_DATA"] = 26] = "SET_TELEMETRY_DATA";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_RECONNECT_ID"] = 27] = "SET_RECONNECT_ID";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_UNREAD_MESSAGE_COUNT"] = 28] = "SET_UNREAD_MESSAGE_COUNT";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_FOCUS_CHAT_BUTTON"] = 29] = "SET_FOCUS_CHAT_BUTTON";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATION_ENDED_BY_AGENT_EVENT_RECEIVED"] = 30] = "SET_CONVERSATION_ENDED_BY_AGENT_EVENT_RECEIVED";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATION_ENDED_BY"] = 31] = "SET_CONVERSATION_ENDED_BY";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_WIDGET_STATE"] = 32] = "SET_WIDGET_STATE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_LIVE_CHAT_CONTEXT"] = 33] = "SET_LIVE_CHAT_CONTEXT";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_BOT_OAUTH_SIGNIN_ID"] = 34] = "SET_BOT_OAUTH_SIGNIN_ID";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_WIDGET_SIZE"] = 35] = "SET_WIDGET_SIZE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_WIDGET_INSTANCE_ID"] = 36] = "SET_WIDGET_INSTANCE_ID";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_LIVE_CHAT_CONFIG"] = 37] = "SET_LIVE_CHAT_CONFIG";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_POST_CHAT_WORKFLOW_IN_PROGRESS"] = 38] = "SET_POST_CHAT_WORKFLOW_IN_PROGRESS";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_INITIAL_CHAT_SDK_REQUEST_ID"] = 39] = "SET_INITIAL_CHAT_SDK_REQUEST_ID";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SHOULD_USE_BOT_SURVEY"] = 40] = "SET_SHOULD_USE_BOT_SURVEY";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CHAT_DISCONNECT_EVENT_RECEIVED"] = 41] = "SET_CHAT_DISCONNECT_EVENT_RECEIVED";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SURVEY_MODE"] = 42] = "SET_SURVEY_MODE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONFIRMATION_STATE"] = 43] = "SET_CONFIRMATION_STATE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_POST_CHAT_PARTICIPANT_TYPE"] = 44] = "SET_POST_CHAT_PARTICIPANT_TYPE";
 })(LiveChatWidgetActionType || (exports.LiveChatWidgetActionType = LiveChatWidgetActionType = {}));

package/lib/cjs/contexts/common/LiveChatWidgetContextInitialState.js

@@ -9,6 +9,7 @@ var _defaultMiddlewareLocalizedTexts = require("../../components/webchatcontaine
 var _utils = require("../../common/utils");
 var _defaultClientDataStoreProvider = require("../../common/storage/default/defaultClientDataStoreProvider");
 var _Constants = require("../../common/Constants");
+var _StartChatFailureType = require("./StartChatFailureType");
 const getLiveChatWidgetContextInitialState = props => {
   var _props$controlProps, _props$webChatContain;
   const widgetCacheId = (0, _utils.getWidgetCacheIdfromProps)(props);
@@ -37,7 +38,8 @@ const getLiveChatWidgetContextInitialState = props => {
       initialChatSdkRequestId: "",
       transcriptRequestId: "",
       confirmationPaneConfirmedOptionClicked: false,
-      confirmationState: _Constants.ConfirmationState.NotSet
+      confirmationState: _Constants.ConfirmationState.NotSet,
+      startChatFailureType: _StartChatFailureType.StartChatFailureType.Generic
     },
     appStates: {
       conversationState: _ConversationState.ConversationState.Closed,
@@ -64,6 +66,7 @@ const getLiveChatWidgetContextInitialState = props => {
     },
     uiStates: {
       showConfirmationPane: false,
+      showStartChatErrorPane: false,
       showEmailTranscriptPane: false,
       showCallingPopup: false,
       isIncomingCall: true,

package/lib/cjs/contexts/common/StartChatFailureType.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.StartChatFailureType = void 0;
+let StartChatFailureType;
+exports.StartChatFailureType = StartChatFailureType;
+(function (StartChatFailureType) {
+  StartChatFailureType["Unauthorized"] = "unauthorized";
+  StartChatFailureType["AuthSetupError"] = "authSetupError";
+  StartChatFailureType["Generic"] = "generic";
+})(StartChatFailureType || (exports.StartChatFailureType = StartChatFailureType = {}));

package/lib/cjs/contexts/createReducer.js

@@ -67,6 +67,14 @@ const createReducer = () => {
             startChatFailed: action.payload
           }
         };
+      case _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_START_CHAT_FAILURE_TYPE:
+        return {
+          ...state,
+          domainStates: {
+            ...state.domainStates,
+            startChatFailureType: action.payload
+          }
+        };
       case _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_OUTSIDE_OPERATING_HOURS:
         return {
           ...state,

package/lib/cjs/controller/componentController.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.shouldShowWebChatContainer = exports.shouldShowReconnectChatPane = exports.shouldShowProactiveChatPane = exports.shouldShowPreChatSurveyPane = exports.shouldShowPostChatSurveyPane = exports.shouldShowPostChatLoadingPane = exports.shouldShowOutOfOfficeHoursPane = exports.shouldShowLoadingPane = exports.shouldShowHeader = exports.shouldShowFooter = exports.shouldShowEmailTranscriptPane = exports.shouldShowConfirmationPane = exports.shouldShowChatButton = exports.shouldShowCallingContainer = void 0;
+exports.shouldShowWebChatContainer = exports.shouldShowStartChatErrorPane = exports.shouldShowReconnectChatPane = exports.shouldShowProactiveChatPane = exports.shouldShowPreChatSurveyPane = exports.shouldShowPostChatSurveyPane = exports.shouldShowPostChatLoadingPane = exports.shouldShowOutOfOfficeHoursPane = exports.shouldShowLoadingPane = exports.shouldShowHeader = exports.shouldShowFooter = exports.shouldShowEmailTranscriptPane = exports.shouldShowConfirmationPane = exports.shouldShowChatButton = exports.shouldShowCallingContainer = void 0;
 var _ConversationState = require("../contexts/common/ConversationState");
 const shouldShowChatButton = state => {
   var _state$appStates;
@@ -34,6 +34,10 @@ const shouldShowLoadingPane = state => {
   return !state.appStates.isMinimized && state.appStates.conversationState === _ConversationState.ConversationState.Loading;
 };
 exports.shouldShowLoadingPane = shouldShowLoadingPane;
+const shouldShowStartChatErrorPane = state => {
+  return !state.appStates.isMinimized && state.appStates.conversationState === _ConversationState.ConversationState.Error;
+};
+exports.shouldShowStartChatErrorPane = shouldShowStartChatErrorPane;
 const shouldShowReconnectChatPane = state => {
   return !state.appStates.isMinimized && state.appStates.conversationState === _ConversationState.ConversationState.ReconnectChat;
 };

package/lib/esm/common/Constants.js

@@ -247,6 +247,14 @@ _defineProperty(NotificationPaneConstants, "IconText", "Notification Icon");
 _defineProperty(NotificationPaneConstants, "ChatDisconnectTitleText", "Chat disconnected");
 _defineProperty(NotificationPaneConstants, "ChatDisconnectSubtitleText", "For additional assistance, please close the chat and try again.");
 _defineProperty(NotificationPaneConstants, "ChromeCloseIconName", "ChromeClose");
+export class StartChatErrorPaneConstants {}
+_defineProperty(StartChatErrorPaneConstants, "DefaultStartChatErrorPaneId", "oc-lcw-start-chat-error-pane");
+_defineProperty(StartChatErrorPaneConstants, "DefaultStartChatErrorTitleText", "We are unable to load chat at this time.");
+_defineProperty(StartChatErrorPaneConstants, "DefaultStartChatErrorSubtitleText", "Please try again later.");
+_defineProperty(StartChatErrorPaneConstants, "DefaultStartChatErrorUnauthorizedTitleText", "Chat authentication has failed.");
+_defineProperty(StartChatErrorPaneConstants, "DefaultStartChatErrorAuthSetupErrorTitleText", "Chat authentication has failed.");
+_defineProperty(StartChatErrorPaneConstants, "DefaultStartChatErrorUnauthorizedSubtitleText", "UNAUTHORIZED");
+_defineProperty(StartChatErrorPaneConstants, "DefaultStartChatErrorAuthSetupErrorSubtitleText", "AUTH SETUP ERROR");
 export class AriaTelemetryConstants {}
 // Aria Endpoint for different environment types.
 _defineProperty(AriaTelemetryConstants, "GERMANY_ENDPOINT", "https://de.pipe.aria.microsoft.com/Collector/3.0/");
@@ -266,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";
@@ -130,6 +131,7 @@ export let TelemetryEvent;
   TelemetryEvent["ConfirmationCancelButtonClicked"] = "ConfirmationCancelButtonClicked";
   TelemetryEvent["ConfirmationConfirmButtonClicked"] = "ConfirmationConfirmButtonClicked";
   TelemetryEvent["LoadingPaneLoaded"] = "LoadingPaneLoaded";
+  TelemetryEvent["StartChatErrorPaneLoaded"] = "StartChatErrorPaneLoaded";
   TelemetryEvent["EmailTranscriptLoaded"] = "EmailTranscriptLoaded";
   TelemetryEvent["OutOfOfficePaneLoaded"] = "OutOfOfficePaneLoaded";
   TelemetryEvent["ConfirmationPaneLoaded"] = "ConfirmationPaneLoaded";
@@ -283,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,8 @@ 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
 export const handleStartChatError = (dispatch, chatSDK, props, ex, isStartChatSuccessful) => {
@@ -18,7 +19,14 @@ export const handleStartChatError = (dispatch, chatSDK, props, ex, isStartChatSu
   }
 
   // Handle internal or misc errors
-  if (ex.message === WidgetLoadCustomErrorString.AuthenticationFailedErrorString || ex.message === WidgetLoadCustomErrorString.NetworkErrorString) {
+  if (ex.message === WidgetLoadCustomErrorString.AuthenticationFailedErrorString) {
+    dispatch({
+      type: LiveChatWidgetActionType.SET_START_CHAT_FAILURE_TYPE,
+      payload: StartChatFailureType.AuthSetupError
+    });
+    logWidgetLoadCompleteWithError(ex);
+  }
+  if (ex.message === WidgetLoadCustomErrorString.NetworkErrorString) {
     logWidgetLoadCompleteWithError(ex);
   }
 
@@ -35,7 +43,7 @@ export const handleStartChatError = (dispatch, chatSDK, props, ex, isStartChatSu
         handleConversationInitializationFailure(ex);
         break;
       case ChatSDKErrorName.ChatTokenRetrievalFailure:
-        handleChatTokenRetrievalFailure(ex);
+        handleChatTokenRetrievalFailure(dispatch, ex);
         break;
       case ChatSDKErrorName.UninitializedChatSDK:
         handleUninitializedChatSDK(ex);
@@ -55,17 +63,24 @@ export const handleStartChatError = (dispatch, chatSDK, props, ex, isStartChatSu
     payload: true
   });
   if (!(props !== null && props !== void 0 && (_props$controlProps = props.controlProps) !== null && _props$controlProps !== void 0 && _props$controlProps.hideErrorUIPane)) {
+    // New flow of leveraging ConversationState.Error
     // Set app state to failing start chat if hideErrorUI is not turned on
     TelemetryHelper.logLoadingEvent(LogLevel.INFO, {
       Event: TelemetryEvent.ErrorUIPaneLoaded,
       Description: "Error UI Pane Loaded"
     });
+    dispatch({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+      payload: ConversationState.Error
+    });
+  } else {
+    // Old flow of leveraging ConversationState.Loading
+    // Show the loading pane in other cases for failure, this will help for both hideStartChatButton case
+    dispatch({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+      payload: ConversationState.Loading
+    });
   }
-  // Show the loading pane in other cases for failure, this will help for both hideStartChatButton case
-  dispatch({
-    type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
-    payload: ConversationState.Loading
-  });
 
   // If sessionInit was successful but LCW startchat failed due to some reason e.g adapter didn't load
   // we need to directly endChat to avoid leaving ghost chats in OC, not disturbing any other UI state
@@ -119,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();
 };
@@ -158,10 +174,16 @@ const handleConversationInitializationFailure = ex => {
 };
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-const handleChatTokenRetrievalFailure = ex => {
+const handleChatTokenRetrievalFailure = (dispatch, ex) => {
   if (ex.httpResponseStatusCode === 400) {
     logWidgetLoadFailed(ex);
   } else {
+    if (ex.httpResponseStatusCode === 401) {
+      dispatch({
+        type: LiveChatWidgetActionType.SET_START_CHAT_FAILURE_TYPE,
+        payload: StartChatFailureType.Unauthorized
+      });
+    }
     logWidgetLoadCompleteWithError(ex);
   }
 };