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

package/lib/cjs/common/Constants.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.WebChatMiddlewareConstants = exports.TranscriptConstants = exports.StorageType = 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.ChatSDKError = exports.AriaTelemetryConstants = exports.AMSConstants = void 0;
+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;
 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); }
@@ -191,12 +191,6 @@ exports.ElementType = ElementType;
 (function (ElementType) {
   ElementType["CallingContainerSDK"] = "CallingContainerSDK";
 })(ElementType || (exports.ElementType = ElementType = {}));
-let ChatSDKError;
-exports.ChatSDKError = ChatSDKError;
-(function (ChatSDKError) {
-  ChatSDKError["WidgetUseOutsideOperatingHour"] = "WidgetUseOutsideOperatingHour";
-  ChatSDKError["AuthContactIdNotFoundFailure"] = "AuthContactIdNotFoundFailure";
-})(ChatSDKError || (exports.ChatSDKError = ChatSDKError = {}));
 let EnvironmentVersion;
 exports.EnvironmentVersion = EnvironmentVersion;
 (function (EnvironmentVersion) {
@@ -280,6 +274,15 @@ _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");
+class StartChatErrorPaneConstants {}
+exports.StartChatErrorPaneConstants = 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");
 class AriaTelemetryConstants {}
 exports.AriaTelemetryConstants = AriaTelemetryConstants;
 // Aria Endpoint for different environment types.
@@ -294,4 +297,12 @@ _defineProperty(AriaTelemetryConstants, "MOONCAKE_ENDPOINT", "");
 _defineProperty(AriaTelemetryConstants, "Public", "Public");
 _defineProperty(AriaTelemetryConstants, "EU", "Europe");
 // EUR: crm4; FRA: crm12; GER: crm16; CHE: crm17; NOR: crm19
-_defineProperty(AriaTelemetryConstants, "lcwEUDomainNames", ["crm4.omnichannelengagementhub.com", "crm12.omnichannelengagementhub.com", "crm16.omnichannelengagementhub.com", "crm17.omnichannelengagementhub.com", "crm19.omnichannelengagementhub.com"]);
+_defineProperty(AriaTelemetryConstants, "lcwEUDomainNames", ["crm4.omnichannelengagementhub.com", "crm12.omnichannelengagementhub.com", "crm16.omnichannelengagementhub.com", "crm17.omnichannelengagementhub.com", "crm19.omnichannelengagementhub.com"]);
+class WidgetLoadTelemetryMessage {}
+exports.WidgetLoadTelemetryMessage = WidgetLoadTelemetryMessage;
+_defineProperty(WidgetLoadTelemetryMessage, "OOOHMessage", "Widget is OOOH");
+_defineProperty(WidgetLoadTelemetryMessage, "PersistedStateRetrievedMessage", "Persisted state retrieved");
+class WidgetLoadCustomErrorString {}
+exports.WidgetLoadCustomErrorString = WidgetLoadCustomErrorString;
+_defineProperty(WidgetLoadCustomErrorString, "AuthenticationFailedErrorString", "Authentication was not successful");
+_defineProperty(WidgetLoadCustomErrorString, "NetworkErrorString", "Network Error");

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

@@ -133,10 +133,10 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["ErrorUIPaneLoaded"] = "ErrorUIPaneLoaded";
   TelemetryEvent["DownloadTranscriptFailed"] = "DownloadTranscriptFailed";
   TelemetryEvent["StartChatFailed"] = "StartChatFailed";
-  TelemetryEvent["IC3ThreadUpdateEventReceived"] = "IC3ThreadUpdateEventReceived";
   TelemetryEvent["ConfirmationCancelButtonClicked"] = "ConfirmationCancelButtonClicked";
   TelemetryEvent["ConfirmationConfirmButtonClicked"] = "ConfirmationConfirmButtonClicked";
   TelemetryEvent["LoadingPaneLoaded"] = "LoadingPaneLoaded";
+  TelemetryEvent["StartChatErrorPaneLoaded"] = "StartChatErrorPaneLoaded";
   TelemetryEvent["EmailTranscriptLoaded"] = "EmailTranscriptLoaded";
   TelemetryEvent["OutOfOfficePaneLoaded"] = "OutOfOfficePaneLoaded";
   TelemetryEvent["ConfirmationPaneLoaded"] = "ConfirmationPaneLoaded";
@@ -250,7 +250,6 @@ class TelemetryConstants {
       case TelemetryEvent.EmailTranscriptSent:
       case TelemetryEvent.EmailTranscriptFailed:
       case TelemetryEvent.DownloadTranscriptFailed:
-      case TelemetryEvent.IC3ThreadUpdateEventReceived:
       case TelemetryEvent.ConfirmationCancelButtonClicked:
       case TelemetryEvent.ConfirmationConfirmButtonClicked:
       case TelemetryEvent.PreChatSurveyStartChatMethodFailed:

package/lib/cjs/common/utils.js

@@ -11,6 +11,7 @@ var _DataStoreManager = require("./contextDataStore/DataStoreManager");
 var _KeyCodes = require("./KeyCodes");
 var _md5Typescript = require("md5-typescript");
 var _TelemetryHelper = require("./telemetry/TelemetryHelper");
+var _omnichannelChatSdk = require("@microsoft/omnichannel-chat-sdk");
 var _this = void 0;
 const getElementBySelector = selector => {
   let element;
@@ -406,7 +407,7 @@ const getConversationDetailsCall = async chatSDK => {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 exports.getConversationDetailsCall = getConversationDetailsCall;
 const checkContactIdError = e => {
-  if ((e === null || e === void 0 ? void 0 : e.message) === _Constants.ChatSDKError.AuthContactIdNotFoundFailure) {
+  if ((e === null || e === void 0 ? void 0 : e.message) === _omnichannelChatSdk.ChatSDKErrorName.AuthContactIdNotFoundFailure) {
     const contactIdNotFoundErrorEvent = {
       eventName: _TelemetryConstants.BroadcastEvent.ContactIdNotFound,
       payload: {

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

@@ -11,23 +11,38 @@ var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants"
 var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const handleChatDisconnect = (props, state, setWebChatStyles) => {
-  var _state$appStates;
-  if (state !== null && state !== void 0 && (_state$appStates = state.appStates) !== null && _state$appStates !== void 0 && _state$appStates.chatDisconnectEventReceived) {
-    var _state$domainStates, _state$domainStates$m, _props$webChatContain, _props$webChatContain2;
-    const chatDisconnectMessage = (state === null || state === void 0 ? void 0 : (_state$domainStates = state.domainStates) === null || _state$domainStates === void 0 ? void 0 : (_state$domainStates$m = _state$domainStates.middlewareLocalizedTexts) === null || _state$domainStates$m === void 0 ? void 0 : _state$domainStates$m.MIDDLEWARE_BANNER_CHAT_DISCONNECT) ?? _defaultMiddlewareLocalizedTexts.defaultMiddlewareLocalizedTexts.MIDDLEWARE_BANNER_CHAT_DISCONNECT;
-    if ((props === null || props === void 0 ? void 0 : (_props$webChatContain = props.webChatContainerProps) === null || _props$webChatContain === void 0 ? void 0 : (_props$webChatContain2 = _props$webChatContain.renderingMiddlewareProps) === null || _props$webChatContain2 === void 0 ? void 0 : _props$webChatContain2.hideSendboxOnConversationEnd) !== false) {
-      setWebChatStyles(styles => {
-        return {
-          ...styles,
-          hideSendBox: true
-        };
+  var _state$appStates, _state$domainStates, _state$domainStates$m, _props$webChatContain, _props$webChatContain2;
+  const chatDisconnectState = state === null || state === void 0 ? void 0 : (_state$appStates = state.appStates) === null || _state$appStates === void 0 ? void 0 : _state$appStates.chatDisconnectEventReceived;
+  const chatDisconnectMessage = (state === null || state === void 0 ? void 0 : (_state$domainStates = state.domainStates) === null || _state$domainStates === void 0 ? void 0 : (_state$domainStates$m = _state$domainStates.middlewareLocalizedTexts) === null || _state$domainStates$m === void 0 ? void 0 : _state$domainStates$m.MIDDLEWARE_BANNER_CHAT_DISCONNECT) ?? _defaultMiddlewareLocalizedTexts.defaultMiddlewareLocalizedTexts.MIDDLEWARE_BANNER_CHAT_DISCONNECT;
+  const hideSendBoxOnConversationEnd = props === null || props === void 0 ? void 0 : (_props$webChatContain = props.webChatContainerProps) === null || _props$webChatContain === void 0 ? void 0 : (_props$webChatContain2 = _props$webChatContain.renderingMiddlewareProps) === null || _props$webChatContain2 === void 0 ? void 0 : _props$webChatContain2.hideSendboxOnConversationEnd;
+  switch (chatDisconnectState) {
+    case true:
+      if (hideSendBoxOnConversationEnd !== false) {
+        setWebChatStyles(styles => {
+          return {
+            ...styles,
+            hideSendBox: true
+          };
+        });
+      }
+      _NotificationHandler.NotificationHandler.notifyWarning(_NotificationScenarios.NotificationScenarios.ChatDisconnect, chatDisconnectMessage);
+      _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
+        Event: _TelemetryConstants.TelemetryEvent.ChatDisconnectThreadEventReceived,
+        Description: "Chat disconnected due to timeout, left or removed."
       });
-    }
-    _NotificationHandler.NotificationHandler.notifyWarning(_NotificationScenarios.NotificationScenarios.ChatDisconnect, chatDisconnectMessage);
-    _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
-      Event: _TelemetryConstants.TelemetryEvent.ChatDisconnectThreadEventReceived,
-      Description: "Chat disconnected due to timeout, left or removed."
-    });
+      break;
+    case false:
+      if (hideSendBoxOnConversationEnd !== false) {
+        setWebChatStyles(styles => {
+          return {
+            ...styles,
+            hideSendBox: false
+          };
+        });
+      }
+      break;
+    default:
+      break;
   }
 };
 exports.handleChatDisconnect = handleChatDisconnect;

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

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.prepareEndChat = exports.endVoiceVideoCallIfOngoing = exports.endChatStateCleanUp = exports.endChat = exports.closeChatStateCleanUp = exports.callingStateCleanUp = void 0;
+exports.prepareEndChat = exports.endVoiceVideoCallIfOngoing = exports.endChatStateCleanUp = exports.endChat = exports.closeChatStateCleanUp = exports.chatSDKStateCleanUp = exports.callingStateCleanUp = void 0;
 var _Constants = require("../../../common/Constants");
 var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants");
 var _authHelper = require("./authHelper");
@@ -16,6 +16,7 @@ var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
 var _WebChatStoreLoader = require("../../webchatcontainerstateful/webchatcontroller/WebChatStoreLoader");
 var _defaultWebChatContainerStatefulProps = require("../../webchatcontainerstateful/common/defaultProps/defaultWebChatContainerStatefulProps");
 var _TelemetryManager = require("../../../common/telemetry/TelemetryManager");
+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 {
@@ -152,7 +153,7 @@ const endChat = async (props, chatSDK, state, dispatch, setAdapter, setWebChatSt
   }
 };
 exports.endChat = endChat;
-const callingStateCleanUp = async dispatch => {
+const callingStateCleanUp = dispatch => {
   dispatch({
     type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SHOW_CALLING_CONTAINER,
     payload: false
@@ -175,7 +176,7 @@ const callingStateCleanUp = async dispatch => {
   });
 };
 exports.callingStateCleanUp = callingStateCleanUp;
-const endChatStateCleanUp = async dispatch => {
+const endChatStateCleanUp = dispatch => {
   // Need to clear these states immediately when chat ended from OC.
   dispatch({
     type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_LIVE_CHAT_CONTEXT,
@@ -191,7 +192,7 @@ const endChatStateCleanUp = async dispatch => {
   });
 };
 exports.endChatStateCleanUp = endChatStateCleanUp;
-const closeChatStateCleanUp = async dispatch => {
+const closeChatStateCleanUp = dispatch => {
   dispatch({
     type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CHAT_TOKEN,
     payload: undefined
@@ -229,6 +230,17 @@ const closeChatStateCleanUp = async dispatch => {
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 exports.closeChatStateCleanUp = closeChatStateCleanUp;
+const chatSDKStateCleanUp = chatSDK => {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  chatSDK.requestId = (0, _omnichannelChatSdk.uuidv4)();
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  chatSDK.chatToken = {};
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  chatSDK.reconnectId = null;
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+exports.chatSDKStateCleanUp = chatSDKStateCleanUp;
 const endVoiceVideoCallIfOngoing = async (chatSDK, dispatch) => {
   let callId = "";
   try {

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

@@ -12,8 +12,6 @@ var _ActivityStreamHandler = require("./ActivityStreamHandler");
 var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components");
 var _ConversationState = require("../../../contexts/common/ConversationState");
 var _LiveChatWidgetActionType = require("../../../contexts/common/LiveChatWidgetActionType");
-var _NotificationHandler = require("../../webchatcontainerstateful/webchatcontroller/notification/NotificationHandler");
-var _NotificationScenarios = require("../../webchatcontainerstateful/webchatcontroller/enums/NotificationScenarios");
 var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
 var _TelemetryManager = require("../../../common/telemetry/TelemetryManager");
 var _createAdapter = require("./createAdapter");
@@ -21,6 +19,8 @@ var _newMessageEventHandler = require("../../../plugins/newMessageEventHandler")
 var _reconnectChatHelper = require("./reconnectChatHelper");
 var _setPostChatContextAndLoadSurvey = require("./setPostChatContextAndLoadSurvey");
 var _updateSessionDataForTelemetry = require("./updateSessionDataForTelemetry");
+var _startChatErrorHandler = require("./startChatErrorHandler");
+var _endChat = require("./endChat");
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 let optionalParams = {};
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -114,13 +114,21 @@ const setPreChatAndInitiateChat = async (chatSDK, dispatch, setAdapter, isProact
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 exports.setPreChatAndInitiateChat = setPreChatAndInitiateChat;
 const initStartChat = async (chatSDK, dispatch, setAdapter, state, props, params, persistedState) => {
-  var _props$controlProps2;
   let isStartChatSuccessful = false;
   const chatConfig = props === null || props === void 0 ? void 0 : props.chatConfig;
   const getAuthToken = props === null || props === void 0 ? void 0 : props.getAuthToken;
-  const hideErrorUIPane = props === null || props === void 0 ? void 0 : (_props$controlProps2 = props.controlProps) === null || _props$controlProps2 === void 0 ? void 0 : _props$controlProps2.hideErrorUIPane;
+  if ((state === null || state === void 0 ? void 0 : state.appStates.conversationState) === _ConversationState.ConversationState.Closed) {
+    // Preventive reset to avoid starting chat with previous requestId which could potentially cause problems
+    (0, _endChat.chatSDKStateCleanUp)(chatSDK);
+  }
   try {
-    var _newAdapter$activity$, _TelemetryTimers$Widg2;
+    var _state$appStates, _newAdapter$activity$;
+    // Clear disconnect state on start chat
+    (state === null || state === void 0 ? void 0 : (_state$appStates = state.appStates) === null || _state$appStates === void 0 ? void 0 : _state$appStates.chatDisconnectEventReceived) && dispatch({
+      type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CHAT_DISCONNECT_EVENT_RECEIVED,
+      payload: false
+    });
+
     //Start widget load timer
     _TelemetryManager.TelemetryTimers.WidgetLoadTimer = (0, _utils.createTimer)();
     _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.INFO, {
@@ -132,8 +140,7 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, state, props, params
       // set auth token to chat sdk before start chat
       const authSuccess = await (0, _authHelper.handleAuthentication)(chatSDK, chatConfig, getAuthToken);
       if (!authSuccess) {
-        // Replacing with error ui
-        throw new Error("Authentication was not successful");
+        throw new Error(_Constants.WidgetLoadCustomErrorString.AuthenticationFailedErrorString);
       }
     }
 
@@ -196,16 +203,11 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, state, props, params
       });
     }
     if (persistedState) {
-      var _TelemetryTimers$Widg;
       dispatch({
         type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_WIDGET_STATE,
         payload: persistedState
       });
-      _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.INFO, {
-        Event: _TelemetryConstants.TelemetryEvent.WidgetLoadComplete,
-        Description: "Widget load complete. Persisted state retrieved",
-        ElapsedTimeInMilliseconds: _TelemetryManager.TelemetryTimers === null || _TelemetryManager.TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg = _TelemetryManager.TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg === void 0 ? void 0 : _TelemetryTimers$Widg.milliSecondsElapsed
-      });
+      (0, _startChatErrorHandler.logWidgetLoadComplete)(_Constants.WidgetLoadTelemetryMessage.PersistedStateRetrievedMessage);
       await (0, _setPostChatContextAndLoadSurvey.setPostChatContextAndLoadSurvey)(chatSDK, dispatch, true);
       return;
     }
@@ -216,11 +218,7 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, state, props, params
       type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_LIVE_CHAT_CONTEXT,
       payload: liveChatContext
     });
-    _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.INFO, {
-      Event: _TelemetryConstants.TelemetryEvent.WidgetLoadComplete,
-      Description: "Widget load complete",
-      ElapsedTimeInMilliseconds: _TelemetryManager.TelemetryTimers === null || _TelemetryManager.TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg2 = _TelemetryManager.TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg2 === void 0 ? void 0 : _TelemetryTimers$Widg2.milliSecondsElapsed
-    });
+    (0, _startChatErrorHandler.logWidgetLoadComplete)();
 
     // Set post chat context in state
     // Commenting this for now as post chat context is fetched during end chat
@@ -229,55 +227,7 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, state, props, params
     // Updating chat session detail for telemetry
     await (0, _updateSessionDataForTelemetry.updateSessionDataForTelemetry)(chatSDK, dispatch);
   } catch (ex) {
-    var _TelemetryTimers$Widg4;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    if (ex.message === _Constants.ChatSDKError.WidgetUseOutsideOperatingHour) {
-      var _TelemetryTimers$Widg3;
-      dispatch({
-        type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_OUTSIDE_OPERATING_HOURS,
-        payload: true
-      });
-      dispatch({
-        type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
-        payload: _ConversationState.ConversationState.OutOfOffice
-      });
-      _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.INFO, {
-        Event: _TelemetryConstants.TelemetryEvent.WidgetLoadComplete,
-        Description: "Widget load complete. Widget is OOOH.",
-        ElapsedTimeInMilliseconds: _TelemetryManager.TelemetryTimers === null || _TelemetryManager.TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg3 = _TelemetryManager.TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg3 === void 0 ? void 0 : _TelemetryTimers$Widg3.milliSecondsElapsed
-      });
-      return;
-    }
-    _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.ERROR, {
-      Event: _TelemetryConstants.TelemetryEvent.WidgetLoadFailed,
-      ExceptionDetails: {
-        Exception: `Widget load Failed: ${ex}`
-      },
-      ElapsedTimeInMilliseconds: _TelemetryManager.TelemetryTimers === null || _TelemetryManager.TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg4 = _TelemetryManager.TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg4 === void 0 ? void 0 : _TelemetryTimers$Widg4.milliSecondsElapsed
-    });
-    _NotificationHandler.NotificationHandler.notifyError(_NotificationScenarios.NotificationScenarios.Connection, "Start Chat Failed: " + ex);
-    dispatch({
-      type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_START_CHAT_FAILING,
-      payload: true
-    });
-    if (!hideErrorUIPane) {
-      // Set app state to failing start chat if hideErrorUI is not turned on
-      _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.INFO, {
-        Event: _TelemetryConstants.TelemetryEvent.ErrorUIPaneLoaded,
-        Description: "Error UI Pane Loaded"
-      });
-    }
-    // Show the loading pane in other cases for failure, this will help for both hideStartChatButton case
-    dispatch({
-      type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
-      payload: _ConversationState.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 
-    if (isStartChatSuccessful === true) {
-      await forceEndChat(chatSDK);
-    }
+    (0, _startChatErrorHandler.handleStartChatError)(dispatch, chatSDK, props, ex, isStartChatSuccessful);
   } finally {
     optionalParams = {};
     widgetInstanceId = "";
@@ -286,21 +236,10 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, state, props, params
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 exports.initStartChat = initStartChat;
-const forceEndChat = async chatSDK => {
-  _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.ERROR, {
-    Event: _TelemetryConstants.TelemetryEvent.WidgetLoadFailed,
-    ExceptionDetails: {
-      Exception: "SessionInit was successful, but widget load failed."
-    }
-  });
-  chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.endChat();
-};
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const canConnectToExistingChat = async (props, chatSDK, state, dispatch, setAdapter) => {
-  var _state$appStates, _persistedState$domai6, _persistedState$appSt;
+  var _state$appStates2, _persistedState$domai6, _persistedState$appSt;
   // By pass this function in case of popout chat
-  if ((state === null || state === void 0 ? void 0 : (_state$appStates = state.appStates) === null || _state$appStates === void 0 ? void 0 : _state$appStates.hideStartChatButton) === true) {
+  if ((state === null || state === void 0 ? void 0 : (_state$appStates2 = state.appStates) === null || _state$appStates2 === void 0 ? void 0 : _state$appStates2.hideStartChatButton) === true) {
     return false;
   }
   const persistedState = (0, _utils.getStateFromCache)((0, _utils.getWidgetCacheIdfromProps)(props));

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

@@ -0,0 +1,219 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.logWidgetLoadComplete = exports.handleStartChatError = void 0;
+var _omnichannelChatSdk = require("@microsoft/omnichannel-chat-sdk");
+var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants");
+var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
+var _TelemetryManager = require("../../../common/telemetry/TelemetryManager");
+var _ConversationState = require("../../../contexts/common/ConversationState");
+var _LiveChatWidgetActionType = require("../../../contexts/common/LiveChatWidgetActionType");
+var _endChat = require("./endChat");
+var _DataStoreManager = require("../../../common/contextDataStore/DataStoreManager");
+var _utils = require("../../../common/utils");
+var _Constants = require("../../../common/Constants");
+var _StartChatFailureType = require("../../../contexts/common/StartChatFailureType");
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handleStartChatError = (dispatch, chatSDK, props, ex, isStartChatSuccessful) => {
+  var _props$controlProps;
+  if (!ex) {
+    logWidgetLoadFailed();
+    return;
+  }
+
+  // Handle internal or misc errors
+  if (ex.message === _Constants.WidgetLoadCustomErrorString.AuthenticationFailedErrorString) {
+    dispatch({
+      type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_START_CHAT_FAILURE_TYPE,
+      payload: _StartChatFailureType.StartChatFailureType.AuthSetupError
+    });
+    logWidgetLoadCompleteWithError(ex);
+  }
+  if (ex.message === _Constants.WidgetLoadCustomErrorString.NetworkErrorString) {
+    logWidgetLoadCompleteWithError(ex);
+  }
+
+  // Handle ChatSDK errors
+  if (ex instanceof _omnichannelChatSdk.ChatSDKError) {
+    switch (ex.message) {
+      case _omnichannelChatSdk.ChatSDKErrorName.WidgetUseOutsideOperatingHour:
+        handleWidgetUseOutsideOperatingHour(dispatch);
+        return;
+      case _omnichannelChatSdk.ChatSDKErrorName.PersistentChatConversationRetrievalFailure:
+        handlePersistentChatConversationRetrievalFailure(ex);
+        break;
+      case _omnichannelChatSdk.ChatSDKErrorName.ConversationInitializationFailure:
+        handleConversationInitializationFailure(ex);
+        break;
+      case _omnichannelChatSdk.ChatSDKErrorName.ChatTokenRetrievalFailure:
+        handleChatTokenRetrievalFailure(dispatch, ex);
+        break;
+      case _omnichannelChatSdk.ChatSDKErrorName.UninitializedChatSDK:
+        handleUninitializedChatSDK(ex);
+        break;
+      case _omnichannelChatSdk.ChatSDKErrorName.InvalidConversation:
+      case _omnichannelChatSdk.ChatSDKErrorName.ClosedConversation:
+        handleInvalidOrClosedConversation(dispatch, chatSDK, props, ex);
+        return;
+      default:
+        logWidgetLoadFailed(ex);
+    }
+  }
+
+  // Show the error UI pane
+  dispatch({
+    type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_START_CHAT_FAILING,
+    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.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.INFO, {
+      Event: _TelemetryConstants.TelemetryEvent.ErrorUIPaneLoaded,
+      Description: "Error UI Pane Loaded"
+    });
+    dispatch({
+      type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+      payload: _ConversationState.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.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+      payload: _ConversationState.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
+  if (isStartChatSuccessful === true) {
+    forceEndChat(chatSDK);
+  }
+};
+exports.handleStartChatError = handleStartChatError;
+const logWidgetLoadFailed = ex => {
+  var _TelemetryTimers$Widg;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const exDetails = {
+    Exception: `Widget load complete with error: ${ex}`
+  };
+  if (ex !== null && ex !== void 0 && ex.httpResponseStatusCode) {
+    exDetails.HttpResponseStatusCode = ex.httpResponseStatusCode;
+  }
+  _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.ERROR, {
+    Event: _TelemetryConstants.TelemetryEvent.WidgetLoadFailed,
+    ExceptionDetails: exDetails,
+    ElapsedTimeInMilliseconds: _TelemetryManager.TelemetryTimers === null || _TelemetryManager.TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg = _TelemetryManager.TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg === void 0 ? void 0 : _TelemetryTimers$Widg.milliSecondsElapsed
+  });
+};
+const logWidgetLoadComplete = additionalMessage => {
+  var _TelemetryTimers$Widg2;
+  let descriptionString = "Widget load complete";
+  if (additionalMessage) {
+    descriptionString += `. ${additionalMessage}`;
+  }
+  _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.INFO, {
+    Event: _TelemetryConstants.TelemetryEvent.WidgetLoadComplete,
+    Description: descriptionString,
+    ElapsedTimeInMilliseconds: _TelemetryManager.TelemetryTimers === null || _TelemetryManager.TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg2 = _TelemetryManager.TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg2 === void 0 ? void 0 : _TelemetryTimers$Widg2.milliSecondsElapsed
+  });
+};
+exports.logWidgetLoadComplete = logWidgetLoadComplete;
+const logWidgetLoadCompleteWithError = ex => {
+  var _TelemetryTimers$Widg3;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const exDetails = {
+    Exception: `Widget load complete with error: ${ex}`
+  };
+  if (ex !== null && ex !== void 0 && ex.httpResponseStatusCode) {
+    exDetails.HttpResponseStatusCode = ex.httpResponseStatusCode;
+  }
+  _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.WARN, {
+    Event: _TelemetryConstants.TelemetryEvent.WidgetLoadComplete,
+    Description: "Widget load complete with error",
+    ExceptionDetails: exDetails,
+    ElapsedTimeInMilliseconds: _TelemetryManager.TelemetryTimers === null || _TelemetryManager.TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg3 = _TelemetryManager.TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg3 === void 0 ? void 0 : _TelemetryTimers$Widg3.milliSecondsElapsed
+  });
+};
+
+// 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."
+    }
+  });
+  chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.endChat();
+};
+const handleWidgetUseOutsideOperatingHour = dispatch => {
+  dispatch({
+    type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_OUTSIDE_OPERATING_HOURS,
+    payload: true
+  });
+  dispatch({
+    type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+    payload: _ConversationState.ConversationState.OutOfOffice
+  });
+  logWidgetLoadComplete(_Constants.WidgetLoadTelemetryMessage.OOOHMessage);
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handlePersistentChatConversationRetrievalFailure = ex => {
+  if (ex.httpResponseStatusCode === 400) {
+    logWidgetLoadFailed(ex);
+  } else {
+    logWidgetLoadCompleteWithError(ex);
+  }
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handleConversationInitializationFailure = ex => {
+  if (ex.httpResponseStatusCode === 400) {
+    logWidgetLoadFailed(ex);
+  } else {
+    logWidgetLoadCompleteWithError(ex);
+  }
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handleChatTokenRetrievalFailure = (dispatch, ex) => {
+  if (ex.httpResponseStatusCode === 400) {
+    logWidgetLoadFailed(ex);
+  } else {
+    if (ex.httpResponseStatusCode === 401) {
+      dispatch({
+        type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_START_CHAT_FAILURE_TYPE,
+        payload: _StartChatFailureType.StartChatFailureType.Unauthorized
+      });
+    }
+    logWidgetLoadCompleteWithError(ex);
+  }
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handleUninitializedChatSDK = ex => {
+  logWidgetLoadCompleteWithError(ex);
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handleInvalidOrClosedConversation = (dispatch, chatSDK, props, ex) => {
+  var _DataStoreManager$cli;
+  logWidgetLoadCompleteWithError(ex);
+
+  // Reset all internal states
+  (0, _endChat.callingStateCleanUp)(dispatch);
+  (0, _endChat.endChatStateCleanUp)(dispatch);
+  (0, _endChat.closeChatStateCleanUp)(dispatch);
+  (0, _endChat.chatSDKStateCleanUp)(chatSDK);
+  (_DataStoreManager$cli = _DataStoreManager.DataStoreManager.clientDataStore) === null || _DataStoreManager$cli === void 0 ? void 0 : _DataStoreManager$cli.removeData((0, _utils.getWidgetCacheIdfromProps)(props));
+
+  // Starts new chat
+  dispatch({
+    type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+    payload: _ConversationState.ConversationState.Closed
+  });
+};