@microsoft/omnichannel-chat-widget 1.6.2 → 1.6.3-main.25307f2

package/lib/esm/common/utils.js

@@ -413,4 +413,7 @@ export const formatTemplateString = (templateMessage, values) => {
   return templateMessage.replace(/{(\d+)}/g, (match, index) => {
     return typeof values[index] !== "undefined" ? values[index] : match;
   });
+};
+export const parseLowerCaseString = property => {
+  return String(property).toLowerCase();
 };

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

@@ -1,6 +1,7 @@
 import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
 import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
 import { isNullOrEmptyString } from "../../../common/utils";
+import { WidgetLoadCustomErrorString } from "../../../common/Constants";
 const getAuthClientFunction = chatConfig => {
   let authClientFunction = undefined;
   if (chatConfig !== null && chatConfig !== void 0 && chatConfig.LiveChatConfigAuthSettings) {
@@ -25,10 +26,12 @@ const handleAuthentication = async (chatSDK, chatConfig, getAuthToken) => {
       });
       return true;
     } else {
+      // instead of returning false, it's more appropiate to thrown an error to force error handling on the caller side
+      // this will help to avoid the error to be ignored and the chat to be started
       TelemetryHelper.logActionEvent(LogLevel.ERROR, {
         Event: TelemetryEvent.ReceivedNullOrEmptyToken
       });
-      return false;
+      throw new Error(WidgetLoadCustomErrorString.AuthenticationFailedErrorString);
     }
   }
   return false;

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

@@ -1,6 +1,6 @@
 import { ConfirmationState, Constants, ConversationEndEntity, ParticipantType, PrepareEndChatDescriptionConstants } from "../../../common/Constants";
 import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
-import { getAuthClientFunction, handleAuthentication } from "./authHelper";
+import { handleAuthentication } from "./authHelper";
 import { getConversationDetailsCall, getWidgetEndChatEventName } from "../../../common/utils";
 import { getPostChatContext, initiatePostChat } from "./renderSurveyHelpers";
 import { BroadcastService } from "@microsoft/omnichannel-chat-components";
@@ -113,7 +113,7 @@ const endChat = async (props, chatSDK, state, dispatch, setAdapter, setWebChatSt
         Event: TelemetryEvent.EndChatSDKCall
       });
       //Get auth token again if chat continued for longer time, otherwise gets 401 error
-      await handleAuthenticationIfEnabled(props, chatSDK);
+      await handleAuthentication(chatSDK, props.chatConfig, props.getAuthToken);
       await (chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.endChat());
     } catch (ex) {
       TelemetryHelper.logSDKEvent(LogLevel.ERROR, {
@@ -296,27 +296,6 @@ const closeChatWidget = (dispatch, props, state) => {
   });
 };
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-const handleAuthenticationIfEnabled = async (props, chatSDK) => {
-  //Unable to end chat if token has expired
-  if (props.getAuthToken) {
-    const authClientFunction = getAuthClientFunction(props.chatConfig);
-    if (props.getAuthToken && authClientFunction) {
-      // set auth token to chat sdk before end chat
-      const authSuccess = await handleAuthentication(chatSDK, props.chatConfig, props.getAuthToken);
-      if (!authSuccess) {
-        TelemetryHelper.logActionEvent(LogLevel.ERROR, {
-          Event: TelemetryEvent.GetAuthTokenFailed,
-          ExceptionDetails: {
-            exception: "Unable to get auth token during end chat"
-          }
-        });
-        throw new Error("handleAuthenticationIfEnabled:Failed to get authentication token");
-      }
-    }
-  }
-};
-
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const chatTokenCleanUp = async dispatch => {
   //Just do cleanup here

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

@@ -3,10 +3,12 @@ import { BroadcastEvent, LogLevel, TelemetryEvent } from "../../../common/teleme
 import { checkContactIdError, isNullOrEmptyString, isNullOrUndefined } from "../../../common/utils";
 import { handleAuthentication, removeAuthTokenProvider } from "./authHelper";
 import { BroadcastService } from "@microsoft/omnichannel-chat-components";
-import { ConversationMode } from "../../../common/Constants";
+import { ConversationMode, WidgetLoadCustomErrorString } from "../../../common/Constants";
 import { ConversationState } from "../../../contexts/common/ConversationState";
 import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidgetActionType";
 import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
+import { handleStartChatError } from "./startChatErrorHandler";
+
 // Return value: should start normal chat flow when reconnect is enabled
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const handleChatReconnect = async (chatSDK, props, dispatch, setAdapter, initStartChat, state) => {
@@ -15,7 +17,7 @@ const handleChatReconnect = async (chatSDK, props, dispatch, setAdapter, initSta
   const isAuthenticatedChat = (_props$chatConfig = props.chatConfig) !== null && _props$chatConfig !== void 0 && (_props$chatConfig$Liv = _props$chatConfig.LiveChatConfigAuthSettings) !== null && _props$chatConfig$Liv !== void 0 && _props$chatConfig$Liv.msdyn_javascriptclientfunction ? true : false;
 
   // Get chat reconnect context
-  const reconnectChatContext = await getChatReconnectContext(chatSDK, props.chatConfig, props, isAuthenticatedChat);
+  const reconnectChatContext = await getChatReconnectContext(chatSDK, props.chatConfig, props, isAuthenticatedChat, dispatch);
 
   // Redirect if enabled
   if (reconnectChatContext !== null && reconnectChatContext !== void 0 && reconnectChatContext.redirectURL) {
@@ -50,7 +52,7 @@ const handleChatReconnect = async (chatSDK, props, dispatch, setAdapter, initSta
 };
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-const getChatReconnectContext = async (chatSDK, chatConfig, props, isAuthenticatedChat) => {
+const getChatReconnectContext = async (chatSDK, chatConfig, props, isAuthenticatedChat, dispatch) => {
   try {
     var _props$reconnectChatP4;
     TelemetryHelper.logSDKEvent(LogLevel.INFO, {
@@ -62,6 +64,7 @@ const getChatReconnectContext = async (chatSDK, chatConfig, props, isAuthenticat
     };
     // Get auth token for getting chat reconnect context
     if (isAuthenticatedChat) {
+      // handle authentication will throw error if auth token is not available, so no need to check for response
       await handleAuthentication(chatSDK, chatConfig, props.getAuthToken);
     }
     const reconnectChatContext = await (chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.getChatReconnectContext(chatReconnectOptionalParams));
@@ -71,7 +74,9 @@ const getChatReconnectContext = async (chatSDK, chatConfig, props, isAuthenticat
       removeAuthTokenProvider(chatSDK);
     }
     return reconnectChatContext;
-  } catch (error) {
+  }
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  catch (error) {
     checkContactIdError(error);
     TelemetryHelper.logSDKEvent(LogLevel.ERROR, {
       Event: TelemetryEvent.GetChatReconnectContextSDKCallFailed,
@@ -79,6 +84,12 @@ const getChatReconnectContext = async (chatSDK, chatConfig, props, isAuthenticat
         exception: error
       }
     });
+
+    // when auth token is not available, propagate the error to stop the execution and ensure error pane is loaded
+    if ((error === null || error === void 0 ? void 0 : error.message) == WidgetLoadCustomErrorString.AuthenticationFailedErrorString) {
+      handleStartChatError(dispatch, chatSDK, props, new Error(WidgetLoadCustomErrorString.AuthenticationFailedErrorString), false);
+      throw error;
+    }
   }
 };
 

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

@@ -24,6 +24,11 @@ export const handleStartChatError = (dispatch, chatSDK, props, ex, isStartChatSu
       type: LiveChatWidgetActionType.SET_START_CHAT_FAILURE_TYPE,
       payload: StartChatFailureType.AuthSetupError
     });
+    // set conversation to error to enforce error UI pane
+    dispatch({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+      payload: ConversationState.Error
+    });
     logWidgetLoadCompleteWithError(ex);
   }
   if (ex.message === WidgetLoadCustomErrorString.NetworkErrorString) {

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

@@ -53,6 +53,7 @@ import useChatSDKStore from "../../../hooks/useChatSDKStore";
 import { defaultAdaptiveCardStyles } from "../../webchatcontainerstateful/common/defaultStyles/defaultAdaptiveCardStyles";
 import StartChatErrorPaneStateful from "../../startchaterrorpanestateful/StartChatErrorPaneStateful";
 import { StartChatFailureType } from "../../../contexts/common/StartChatFailureType";
+import { executeReducer } from "../../../contexts/createReducer";
 export const LiveChatWidgetStateful = props => {
   var _props$webChatContain, _props$styleProps, _props$controlProps, _props$controlProps3, _state$appStates7, _props$webChatContain5, _state$appStates14, _props$webChatContain6, _props$controlProps12, _props$draggableChatW, _props$draggableChatW2, _props$draggableChatW3, _props$draggableChatW4, _props$draggableChatW5, _props$webChatContain7, _props$webChatContain8, _props$webChatContain9, _props$webChatContain10, _livechatProps$webCha, _livechatProps$styleP, _livechatProps$contro, _livechatProps$contro2, _livechatProps$compon, _livechatProps$contro3, _livechatProps$compon2, _livechatProps$contro4, _livechatProps$compon3, _livechatProps$contro5, _livechatProps$compon4, _livechatProps$contro6, _livechatProps$compon5, _livechatProps$contro7, _livechatProps$compon6, _livechatProps$contro8, _livechatProps$compon7, _livechatProps$contro9, _livechatProps$compon8, _livechatProps$contro10, _livechatProps$contro11, _livechatProps$compon9, _livechatProps$contro12, _livechatProps$compon10, _livechatProps$contro13, _livechatProps$compon11, _livechatProps$compon12, _livechatProps$compon13;
   const [state, dispatch] = useChatContextStore();
@@ -117,8 +118,12 @@ export const LiveChatWidgetStateful = props => {
     const isReconnectTriggered = async () => {
       if (isReconnectEnabled(props.chatConfig) === true && !isPersistentEnabled(props.chatConfig)) {
         const noValidReconnectId = await handleChatReconnect(chatSDK, props, dispatch, setAdapter, initStartChat, state);
+        const inMemoryState = executeReducer(state, {
+          type: LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
+          payload: null
+        });
         // If chat reconnect has kicked in chat state will become Active or Reconnect. So just exit, else go next
-        if (!noValidReconnectId && (state.appStates.conversationState === ConversationState.Active || state.appStates.conversationState === ConversationState.ReconnectChat)) {
+        if (!noValidReconnectId && (inMemoryState.appStates.conversationState === ConversationState.Active || inMemoryState.appStates.conversationState === ConversationState.ReconnectChat)) {
           return true;
         }
       }
@@ -332,7 +337,7 @@ export const LiveChatWidgetStateful = props => {
 
     // Start chat from SDK Event
     BroadcastService.getMessageByEventName(BroadcastEvent.StartChat).subscribe(msg => {
-      var _msg$payload4, _msg$payload5, _msg$payload6;
+      var _msg$payload4, _msg$payload5, _msg$payload6, _inMemoryState$appSta, _inMemoryState$appSta2, _inMemoryState$appSta3, _inMemoryState$appSta4;
       // If the startChat event is not initiated by the same tab. Ignore the call
       if (!isNullOrUndefined(msg === null || msg === void 0 ? void 0 : (_msg$payload4 = msg.payload) === null || _msg$payload4 === void 0 ? void 0 : _msg$payload4.runtimeId) && (msg === null || msg === void 0 ? void 0 : (_msg$payload5 = msg.payload) === null || _msg$payload5 === void 0 ? void 0 : _msg$payload5.runtimeId) !== TelemetryManager.InternalTelemetryData.lcwRuntimeId) {
         return;
@@ -360,12 +365,13 @@ export const LiveChatWidgetStateful = props => {
         Event: TelemetryEvent.StartChatEventRecevied,
         Description: "Start chat event received."
       });
+      const inMemoryState = executeReducer(state, {
+        type: LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
+        payload: null
+      });
 
-      // DataStoreManager.clientDataStore?.swtichToSessionStorage(true);
-      const persistedState = getStateFromCache(getWidgetCacheIdfromProps(props));
-
-      // Chat not found in cache - scenario: explicitly clearing cache and calling startChat SDK method
-      if (persistedState === undefined) {
+      // Only initiate new chat if widget runtime state is one of the followings
+      if (((_inMemoryState$appSta = inMemoryState.appStates) === null || _inMemoryState$appSta === void 0 ? void 0 : _inMemoryState$appSta.conversationState) === ConversationState.Closed || ((_inMemoryState$appSta2 = inMemoryState.appStates) === null || _inMemoryState$appSta2 === void 0 ? void 0 : _inMemoryState$appSta2.conversationState) === ConversationState.InActive || ((_inMemoryState$appSta3 = inMemoryState.appStates) === null || _inMemoryState$appSta3 === void 0 ? void 0 : _inMemoryState$appSta3.conversationState) === ConversationState.Postchat) {
         BroadcastService.postMessage({
           eventName: BroadcastEvent.ChatInitiated
         });
@@ -373,33 +379,21 @@ export const LiveChatWidgetStateful = props => {
         return;
       }
 
-      // Chat exist in cache
-      if (persistedState) {
-        var _persistedState$appSt, _persistedState$appSt2, _persistedState$appSt3, _persistedState$appSt4;
-        // Only initiate new chat if widget state in cache in one of the followings
-        if (((_persistedState$appSt = persistedState.appStates) === null || _persistedState$appSt === void 0 ? void 0 : _persistedState$appSt.conversationState) === ConversationState.Closed || ((_persistedState$appSt2 = persistedState.appStates) === null || _persistedState$appSt2 === void 0 ? void 0 : _persistedState$appSt2.conversationState) === ConversationState.InActive || ((_persistedState$appSt3 = persistedState.appStates) === null || _persistedState$appSt3 === void 0 ? void 0 : _persistedState$appSt3.conversationState) === ConversationState.Postchat) {
-          BroadcastService.postMessage({
-            eventName: BroadcastEvent.ChatInitiated
-          });
-          prepareStartChat(props, chatSDK, stateWithUpdatedContext, dispatch, setAdapter);
-          return;
-        }
-
-        // If minimized, maximize the chat
-        if ((persistedState === null || persistedState === void 0 ? void 0 : (_persistedState$appSt4 = persistedState.appStates) === null || _persistedState$appSt4 === void 0 ? void 0 : _persistedState$appSt4.isMinimized) === true) {
-          var _persistedState$domai, _persistedState$domai2, _persistedState$domai3, _persistedState$domai4;
-          dispatch({
-            type: LiveChatWidgetActionType.SET_MINIMIZED,
-            payload: false
-          });
-          BroadcastService.postMessage({
-            eventName: BroadcastEvent.MaximizeChat,
-            payload: {
-              height: persistedState === null || persistedState === void 0 ? void 0 : (_persistedState$domai = persistedState.domainStates) === null || _persistedState$domai === void 0 ? void 0 : (_persistedState$domai2 = _persistedState$domai.widgetSize) === null || _persistedState$domai2 === void 0 ? void 0 : _persistedState$domai2.height,
-              width: persistedState === null || persistedState === void 0 ? void 0 : (_persistedState$domai3 = persistedState.domainStates) === null || _persistedState$domai3 === void 0 ? void 0 : (_persistedState$domai4 = _persistedState$domai3.widgetSize) === null || _persistedState$domai4 === void 0 ? void 0 : _persistedState$domai4.width
-            }
-          });
-        }
+      // If minimized, maximize the chat
+      if ((inMemoryState === null || inMemoryState === void 0 ? void 0 : (_inMemoryState$appSta4 = inMemoryState.appStates) === null || _inMemoryState$appSta4 === void 0 ? void 0 : _inMemoryState$appSta4.isMinimized) === true) {
+        var _inMemoryState$domain, _inMemoryState$domain2, _inMemoryState$domain3, _inMemoryState$domain4;
+        dispatch({
+          type: LiveChatWidgetActionType.SET_MINIMIZED,
+          payload: false
+        });
+        BroadcastService.postMessage({
+          eventName: BroadcastEvent.MaximizeChat,
+          payload: {
+            height: inMemoryState === null || inMemoryState === void 0 ? void 0 : (_inMemoryState$domain = inMemoryState.domainStates) === null || _inMemoryState$domain === void 0 ? void 0 : (_inMemoryState$domain2 = _inMemoryState$domain.widgetSize) === null || _inMemoryState$domain2 === void 0 ? void 0 : _inMemoryState$domain2.height,
+            width: inMemoryState === null || inMemoryState === void 0 ? void 0 : (_inMemoryState$domain3 = inMemoryState.domainStates) === null || _inMemoryState$domain3 === void 0 ? void 0 : (_inMemoryState$domain4 = _inMemoryState$domain3.widgetSize) === null || _inMemoryState$domain4 === void 0 ? void 0 : _inMemoryState$domain4.width
+          }
+        });
+        return;
       }
     });
 

package/lib/esm/components/webchatcontainerstateful/common/utils/isMaskingFromCustomer.js

@@ -1,3 +1,4 @@
+import { isNullOrUndefined, parseLowerCaseString } from "../../../../common/utils";
 export const isMaskingforCustomer = maskingInfo => {
   var _maskingInfo$setting;
   // If the masking info (containing masking setting and masking rules) is missing or empty, return false.
@@ -8,8 +9,9 @@ export const isMaskingforCustomer = maskingInfo => {
 
   // If the masking rules are provided and;
   // If the masking setting is NOT null and masking for customer is NOT null, return the configuration
-  if ((_maskingInfo$setting = maskingInfo.setting) !== null && _maskingInfo$setting !== void 0 && _maskingInfo$setting.msdyn_maskforcustomer) {
-    return maskingInfo.setting.msdyn_maskforcustomer;
+  if (!isNullOrUndefined((_maskingInfo$setting = maskingInfo.setting) === null || _maskingInfo$setting === void 0 ? void 0 : _maskingInfo$setting.msdyn_maskforcustomer)) {
+    var _maskingInfo$setting2;
+    return parseLowerCaseString(maskingInfo === null || maskingInfo === void 0 ? void 0 : (_maskingInfo$setting2 = maskingInfo.setting) === null || _maskingInfo$setting2 === void 0 ? void 0 : _maskingInfo$setting2.msdyn_maskforcustomer) === "true";
   }
 
   // In all other cases, even if masking setting is missing, return true to apply the masking for backward compatibility (i.e. in old versions, OC does not have masking info settings)

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

@@ -45,4 +45,5 @@ export let LiveChatWidgetActionType;
   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[LiveChatWidgetActionType["GET_IN_MEMORY_STATE"] = 45] = "GET_IN_MEMORY_STATE";
 })(LiveChatWidgetActionType || (LiveChatWidgetActionType = {}));