@microsoft/omnichannel-chat-widget 0.1.0-main.bf74329 → 0.1.0-main.c1bbb91

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

@@ -3,9 +3,13 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.setPreChatAndInitiateChat = exports.prepareStartChat = exports.initStartChat = void 0;
-var _Constants = require("../../../common/Constants");
+exports.setPreChatAndInitiateChat = exports.prepareStartChat = exports.initStartChat = exports.checkIfConversationStillValid = void 0;
 var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants");
+var _Constants = require("../../../common/Constants");
+var _utils = require("../../../common/utils");
+var _authHelper = require("./authHelper");
+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");
@@ -14,13 +18,9 @@ var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
 var _TelemetryManager = require("../../../common/telemetry/TelemetryManager");
 var _createAdapter = require("./createAdapter");
 var _newMessageEventHandler = require("../../../plugins/newMessageEventHandler");
-var _utils = require("../../../common/utils");
 var _reconnectChatHelper = require("./reconnectChatHelper");
 var _setPostChatContextAndLoadSurvey = require("./setPostChatContextAndLoadSurvey");
 var _updateSessionDataForTelemetry = require("./updateSessionDataForTelemetry");
-var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components");
-var _ActivityStreamHandler = require("./ActivityStreamHandler");
-var _authHelper = require("./authHelper");
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 let optionalParams = {};
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -28,7 +28,7 @@ let widgetInstanceId;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const prepareStartChat = async (props, chatSDK, state, dispatch, setAdapter) => {
-  var _props$controlProps, _props$reconnectChatP;
+  var _props$controlProps;
   optionalParams = {}; //Resetting to ensure no stale values
   widgetInstanceId = props === null || props === void 0 ? void 0 : (_props$controlProps = props.controlProps) === null || _props$controlProps === void 0 ? void 0 : _props$controlProps.widgetInstanceId;
 
@@ -36,25 +36,10 @@ const prepareStartChat = async (props, chatSDK, state, dispatch, setAdapter) =>
   if (await canConnectToExistingChat(props, chatSDK, state, dispatch, setAdapter)) {
     return;
   }
+  await (0, _reconnectChatHelper.handleChatReconnect)(chatSDK, props, dispatch, setAdapter, initStartChat, state);
 
-  // Redirecting if unauthenticated reconnect chat expired
-  if ((_props$reconnectChatP = props.reconnectChatPaneProps) !== null && _props$reconnectChatP !== void 0 && _props$reconnectChatP.reconnectId) {
-    var _props$reconnectChatP2, _props$reconnectChatP3, _props$reconnectChatP4;
-    await (0, _reconnectChatHelper.handleRedirectUnauthenticatedReconnectChat)(chatSDK, props.chatConfig, props.getAuthToken, dispatch, setAdapter, initStartChat, (_props$reconnectChatP2 = props.reconnectChatPaneProps) === null || _props$reconnectChatP2 === void 0 ? void 0 : _props$reconnectChatP2.isReconnectEnabled, (_props$reconnectChatP3 = props.reconnectChatPaneProps) === null || _props$reconnectChatP3 === void 0 ? void 0 : _props$reconnectChatP3.reconnectId, (_props$reconnectChatP4 = props.reconnectChatPaneProps) === null || _props$reconnectChatP4 === void 0 ? void 0 : _props$reconnectChatP4.redirectInSameWindow);
-    return;
-  }
-
-  // Getting reconnectId for authenticated chat
-  const reconnectId = await (0, _reconnectChatHelper.getReconnectIdForAuthenticatedChat)(props, chatSDK);
-  if (reconnectId) {
-    dispatch({
-      type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_RECONNECT_ID,
-      payload: reconnectId
-    });
-    dispatch({
-      type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
-      payload: _ConversationState.ConversationState.ReconnectChat
-    });
+  // If chat reconnect has kicked in chat state will become Active or Reconnect. So just exit, else go next
+  if (state.appStates.conversationState === _ConversationState.ConversationState.Active || state.appStates.conversationState === _ConversationState.ConversationState.ReconnectChat) {
     return;
   }
 
@@ -63,12 +48,21 @@ const prepareStartChat = async (props, chatSDK, state, dispatch, setAdapter) =>
   const isPreChatEnabledInProactiveChat = state.appStates.proactiveChatStates.proactiveChatEnablePrechat;
 
   //Setting PreChat and intiate chat
-  setPreChatAndInitiateChat(chatSDK, props.chatConfig, props.getAuthToken, dispatch, setAdapter, isProactiveChat, isPreChatEnabledInProactiveChat);
+  setPreChatAndInitiateChat(chatSDK, dispatch, setAdapter, isProactiveChat, isPreChatEnabledInProactiveChat, undefined, props);
 };
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 exports.prepareStartChat = prepareStartChat;
-const setPreChatAndInitiateChat = async (chatSDK, chatConfig, getAuthToken, dispatch, setAdapter, isProactiveChat, proactiveChatEnablePrechatState) => {
+const setPreChatAndInitiateChat = async (chatSDK, dispatch, setAdapter, isProactiveChat, proactiveChatEnablePrechatState, state, props) => {
+  //Handle reconnect scenario
+  if (state) {
+    await (0, _reconnectChatHelper.handleChatReconnect)(chatSDK, props, dispatch, setAdapter, initStartChat, state);
+    // If chat reconnect has kicked in chat state will become Active or Reconnect. So just exit, else go next
+    if (state.appStates.conversationState === _ConversationState.ConversationState.Active || state.appStates.conversationState === _ConversationState.ConversationState.ReconnectChat) {
+      return;
+    }
+  }
+
   // Getting prechat Survey Context
   const parseToJson = false;
   const preChatSurveyResponse = await chatSDK.getPreChatSurvey(parseToJson);
@@ -90,14 +84,28 @@ const setPreChatAndInitiateChat = async (chatSDK, chatConfig, getAuthToken, disp
     type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
     payload: _ConversationState.ConversationState.Loading
   });
-  await initStartChat(chatSDK, chatConfig, getAuthToken, dispatch, setAdapter);
+  const optionalParams = {
+    isProactiveChat
+  };
+  await initStartChat(chatSDK, dispatch, setAdapter, props, optionalParams);
 };
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 exports.setPreChatAndInitiateChat = setPreChatAndInitiateChat;
-const initStartChat = async (chatSDK, chatConfig, getAuthToken, dispatch, setAdapter, params, persistedState) => {
+const initStartChat = async (chatSDK, dispatch, setAdapter, 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;
   try {
     var _newAdapter$activity$, _TelemetryTimers$Widg;
+    //Start widget load timer
+    _TelemetryManager.TelemetryTimers.WidgetLoadTimer = (0, _utils.createTimer)();
+    _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.INFO, {
+      Event: _TelemetryConstants.TelemetryEvent.WidgetLoadStarted,
+      Description: "Widget loading started"
+    });
     const authClientFunction = (0, _authHelper.getAuthClientFunction)(chatConfig);
     if (getAuthToken && authClientFunction) {
       // set auth token to chat sdk before start chat
@@ -106,7 +114,6 @@ const initStartChat = async (chatSDK, chatConfig, getAuthToken, dispatch, setAda
         return;
       }
     }
-    let isStartChatSuccessful = false;
 
     //Check if chat retrieved from cache
     if (persistedState || params !== null && params !== void 0 && params.liveChatContext) {
@@ -120,16 +127,16 @@ const initStartChat = async (chatSDK, chatConfig, getAuthToken, dispatch, setAda
       });
     }
     try {
-      //Start widget load timer
-      _TelemetryManager.TelemetryTimers.WidgetLoadTimer = (0, _utils.createTimer)();
-      _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
-        Event: _TelemetryConstants.TelemetryEvent.StartChatSDKCall
-      });
-
+      var _window$Microsoft, _window$Microsoft$Dyn, _window$Microsoft$Dyn2, _window$Microsoft$Dyn3;
       // Set custom context params
       setCustomContextParams(chatSDK);
-      optionalParams = Object.assign({}, params, optionalParams);
-      await chatSDK.startChat(optionalParams);
+      const defaultOptionalParams = {
+        sendDefaultInitContext: true,
+        isProactiveChat: !!(params !== null && params !== void 0 && params.isProactiveChat),
+        portalContactId: (_window$Microsoft = window.Microsoft) === null || _window$Microsoft === void 0 ? void 0 : (_window$Microsoft$Dyn = _window$Microsoft.Dynamic365) === null || _window$Microsoft$Dyn === void 0 ? void 0 : (_window$Microsoft$Dyn2 = _window$Microsoft$Dyn.Portal) === null || _window$Microsoft$Dyn2 === void 0 ? void 0 : (_window$Microsoft$Dyn3 = _window$Microsoft$Dyn2.User) === null || _window$Microsoft$Dyn3 === void 0 ? void 0 : _window$Microsoft$Dyn3.contactId
+      };
+      const startChatOptionalParams = Object.assign({}, params, optionalParams, defaultOptionalParams);
+      await chatSDK.startChat(startChatOptionalParams);
       isStartChatSuccessful = true;
     } catch (error) {
       _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.ERROR, {
@@ -162,7 +169,7 @@ const initStartChat = async (chatSDK, chatConfig, getAuthToken, dispatch, setAda
         type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_WIDGET_STATE,
         payload: persistedState
       });
-      await (0, _setPostChatContextAndLoadSurvey.setPostChatContextAndLoadSurvey)(chatSDK, dispatch, true);
+      (0, _setPostChatContextAndLoadSurvey.setPostChatContextAndLoadSurvey)(chatSDK, dispatch, true);
       return;
     }
 
@@ -174,7 +181,7 @@ const initStartChat = async (chatSDK, chatConfig, getAuthToken, dispatch, setAda
     });
 
     // Set post chat context in state, no survey load
-    await (0, _setPostChatContextAndLoadSurvey.setPostChatContextAndLoadSurvey)(chatSDK, dispatch);
+    (0, _setPostChatContextAndLoadSurvey.setPostChatContextAndLoadSurvey)(chatSDK, dispatch);
 
     // Updating chat session detail for telemetry
     await (0, _updateSessionDataForTelemetry.updateSessionDataForTelemetry)(chatSDK, dispatch);
@@ -182,6 +189,11 @@ const initStartChat = async (chatSDK, chatConfig, getAuthToken, dispatch, setAda
     // Set app state to Active
     if (isStartChatSuccessful) {
       _ActivityStreamHandler.ActivityStreamHandler.uncork();
+      // Update start chat failure app state if chat loads successfully
+      dispatch({
+        type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_START_CHAT_FAILING,
+        payload: false
+      });
       dispatch({
         type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
         payload: _ConversationState.ConversationState.Active
@@ -210,6 +222,29 @@ const initStartChat = async (chatSDK, chatConfig, getAuthToken, dispatch, setAda
         type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
         payload: _ConversationState.ConversationState.OutOfOffice
       });
+      return;
+    }
+    if (!hideErrorUIPane) {
+      // Set app state to failing start chat if hideErrorUI is not turned on
+      dispatch({
+        type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_START_CHAT_FAILING,
+        payload: true
+      });
+      _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);
     }
   } finally {
     optionalParams = {};
@@ -219,13 +254,24 @@ const initStartChat = async (chatSDK, chatConfig, getAuthToken, dispatch, setAda
 
 // 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 _chatSDK$omnichannelC, _chatSDK$omnichannelC2, _props$controlProps2, _persistedState$domai6, _persistedState$appSt;
+  var _chatSDK$omnichannelC, _chatSDK$omnichannelC2, _props$controlProps3, _persistedState$domai6, _persistedState$appSt;
   // By pass this function in case of popout chat
-  if (state.appStates.skipChatButtonRendering === true) {
+  if (state.appStates.hideStartChatButton === true) {
     return false;
   }
-  const persistedState = (0, _utils.getStateFromCache)(chatSDK === null || chatSDK === void 0 ? void 0 : (_chatSDK$omnichannelC = chatSDK.omnichannelConfig) === null || _chatSDK$omnichannelC === void 0 ? void 0 : _chatSDK$omnichannelC.orgId, chatSDK === null || chatSDK === void 0 ? void 0 : (_chatSDK$omnichannelC2 = chatSDK.omnichannelConfig) === null || _chatSDK$omnichannelC2 === void 0 ? void 0 : _chatSDK$omnichannelC2.widgetId, (props === null || props === void 0 ? void 0 : (_props$controlProps2 = props.controlProps) === null || _props$controlProps2 === void 0 ? void 0 : _props$controlProps2.widgetInstanceId) ?? "");
+  const persistedState = (0, _utils.getStateFromCache)(chatSDK === null || chatSDK === void 0 ? void 0 : (_chatSDK$omnichannelC = chatSDK.omnichannelConfig) === null || _chatSDK$omnichannelC === void 0 ? void 0 : _chatSDK$omnichannelC.orgId, chatSDK === null || chatSDK === void 0 ? void 0 : (_chatSDK$omnichannelC2 = chatSDK.omnichannelConfig) === null || _chatSDK$omnichannelC2 === void 0 ? void 0 : _chatSDK$omnichannelC2.widgetId, (props === null || props === void 0 ? void 0 : (_props$controlProps3 = props.controlProps) === null || _props$controlProps3 === void 0 ? void 0 : _props$controlProps3.widgetInstanceId) ?? "");
 
   //Connect to only active chat session
   if (persistedState && !(0, _utils.isUndefinedOrEmpty)(persistedState === null || persistedState === void 0 ? void 0 : (_persistedState$domai6 = persistedState.domainStates) === null || _persistedState$domai6 === void 0 ? void 0 : _persistedState$domai6.liveChatContext) && (persistedState === null || persistedState === void 0 ? void 0 : (_persistedState$appSt = persistedState.appStates) === null || _persistedState$appSt === void 0 ? void 0 : _persistedState$appSt.conversationState) === _ConversationState.ConversationState.Active) {
@@ -237,7 +283,7 @@ const canConnectToExistingChat = async (props, chatSDK, state, dispatch, setAdap
     const optionalParams = {
       liveChatContext: persistedState === null || persistedState === void 0 ? void 0 : (_persistedState$domai7 = persistedState.domainStates) === null || _persistedState$domai7 === void 0 ? void 0 : _persistedState$domai7.liveChatContext
     };
-    await initStartChat(chatSDK, props.chatConfig, props.getAuthToken, dispatch, setAdapter, optionalParams, persistedState);
+    await initStartChat(chatSDK, dispatch, setAdapter, props, optionalParams, persistedState);
     return true;
   } else {
     return false;
@@ -265,4 +311,75 @@ const setCustomContextParams = chatSDK => {
       customContext: persistedState === null || persistedState === void 0 ? void 0 : (_persistedState$domai10 = persistedState.domainStates) === null || _persistedState$domai10 === void 0 ? void 0 : _persistedState$domai10.customContext
     });
   }
-};
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handleAuthenticationIfEnabled = async (chatSDK, props) => {
+  //For auth chat
+  if (props.getAuthToken) {
+    const authClientFunction = (0, _authHelper.getAuthClientFunction)(props.chatConfig);
+    if (authClientFunction) {
+      // set auth token to chat sdk before start chat
+      const authSuccess = await (0, _authHelper.handleAuthentication)(chatSDK, props.chatConfig, props.getAuthToken);
+      if (!authSuccess) {
+        return false;
+      }
+      return true;
+    }
+  }
+  return true;
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const checkIfConversationStillValid = async (chatSDK, props, requestId, dispatch) => {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  let conversationDetails = undefined;
+
+  // Show Loading screen during auth check and start chat calls 
+  dispatch({
+    type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+    payload: _ConversationState.ConversationState.Loading
+  });
+  const authSucceed = await handleAuthenticationIfEnabled(chatSDK, props);
+  if (!authSucceed) {
+    var _props$controlProps4;
+    if (!(props !== null && props !== void 0 && (_props$controlProps4 = props.controlProps) !== null && _props$controlProps4 !== void 0 && _props$controlProps4.hideErrorUIPane)) {
+      // Set app state to failing start chat if hideErrorUI is not turned on
+      dispatch({
+        type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_START_CHAT_FAILING,
+        payload: true
+      });
+      _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.INFO, {
+        Event: _TelemetryConstants.TelemetryEvent.ErrorUIPaneLoaded,
+        Description: "Error UI Pane Loaded"
+      });
+    }
+    return false;
+  }
+
+  //Preserve old requestId
+  const oldRequestId = chatSDK.requestId;
+  try {
+    chatSDK.requestId = requestId;
+    conversationDetails = await chatSDK.getConversationDetails();
+    if (Object.keys(conversationDetails).length === 0) {
+      chatSDK.requestId = oldRequestId;
+      return false;
+    }
+    if (conversationDetails.state === _Constants.LiveWorkItemState.Closed || conversationDetails.state === _Constants.LiveWorkItemState.WrapUp) {
+      chatSDK.requestId = oldRequestId;
+      return false;
+    }
+    return true;
+  } catch (erorr) {
+    _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.ERROR, {
+      Event: _TelemetryConstants.TelemetryEvent.GetConversationDetailsException,
+      ExceptionDetails: {
+        exception: `Conversation is not valid: ${erorr}`
+      }
+    });
+    chatSDK.requestId = oldRequestId;
+    return false;
+  }
+};
+exports.checkIfConversationStillValid = checkIfConversationStillValid;

package/lib/cjs/components/livechatwidget/interfaces/IScrollBarProps.js

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