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

package/lib/cjs/common/utils.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.setTabIndices = exports.setFocusOnSendBox = exports.setFocusOnElement = exports.preventFocusToMoveOutOfElement = exports.parseAdaptiveCardPayload = exports.newGuid = exports.isUndefinedOrEmpty = exports.isNullOrUndefined = exports.isNullOrEmptyString = exports.getWidgetEndChatEventName = exports.getWidgetCacheIdfromProps = exports.getWidgetCacheId = exports.getTimestampHourMinute = exports.getStateFromCache = exports.getLocaleDirection = exports.getIconText = exports.getDomain = exports.getConversationDetailsCall = exports.getBroadcastChannelName = exports.formatTemplateString = exports.findParentFocusableElementsWithoutChildContainer = exports.findAllFocusableElement = exports.extractPreChatSurveyResponseValues = exports.escapeHtml = exports.debounceLeading = exports.createTimer = exports.createFileAndDownload = exports.checkContactIdError = exports.changeLanguageCodeFormatForWebChat = exports.addDelayInMs = void 0;
+exports.setTabIndices = exports.setFocusOnSendBox = exports.setFocusOnElement = exports.preventFocusToMoveOutOfElement = exports.parseLowerCaseString = exports.parseAdaptiveCardPayload = exports.newGuid = exports.isUndefinedOrEmpty = exports.isNullOrUndefined = exports.isNullOrEmptyString = exports.getWidgetEndChatEventName = exports.getWidgetCacheIdfromProps = exports.getWidgetCacheId = exports.getTimestampHourMinute = exports.getStateFromCache = exports.getLocaleDirection = exports.getIconText = exports.getDomain = exports.getConversationDetailsCall = exports.getBroadcastChannelName = exports.formatTemplateString = exports.findParentFocusableElementsWithoutChildContainer = exports.findAllFocusableElement = exports.extractPreChatSurveyResponseValues = exports.escapeHtml = exports.debounceLeading = exports.createTimer = exports.createFileAndDownload = exports.checkContactIdError = exports.changeLanguageCodeFormatForWebChat = exports.addDelayInMs = void 0;
 var _Constants = require("./Constants");
 var _TelemetryConstants = require("./telemetry/TelemetryConstants");
 var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components");
@@ -449,4 +449,8 @@ const formatTemplateString = (templateMessage, values) => {
     return typeof values[index] !== "undefined" ? values[index] : match;
   });
 };
-exports.formatTemplateString = formatTemplateString;
+exports.formatTemplateString = formatTemplateString;
+const parseLowerCaseString = property => {
+  return String(property).toLowerCase();
+};
+exports.parseLowerCaseString = parseLowerCaseString;

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

@@ -7,6 +7,7 @@ exports.removeAuthTokenProvider = exports.handleAuthentication = exports.getAuth
 var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants");
 var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
 var _utils = require("../../../common/utils");
+var _Constants = require("../../../common/Constants");
 const getAuthClientFunction = chatConfig => {
   let authClientFunction = undefined;
   if (chatConfig !== null && chatConfig !== void 0 && chatConfig.LiveChatConfigAuthSettings) {
@@ -32,10 +33,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.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.ERROR, {
         Event: _TelemetryConstants.TelemetryEvent.ReceivedNullOrEmptyToken
       });
-      return false;
+      throw new Error(_Constants.WidgetLoadCustomErrorString.AuthenticationFailedErrorString);
     }
   }
   return false;

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

@@ -119,7 +119,7 @@ const endChat = async (props, chatSDK, state, dispatch, setAdapter, setWebChatSt
         Event: _TelemetryConstants.TelemetryEvent.EndChatSDKCall
       });
       //Get auth token again if chat continued for longer time, otherwise gets 401 error
-      await handleAuthenticationIfEnabled(props, chatSDK);
+      await (0, _authHelper.handleAuthentication)(chatSDK, props.chatConfig, props.getAuthToken);
       await (chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.endChat());
     } catch (ex) {
       _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.ERROR, {
@@ -308,27 +308,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 = (0, _authHelper.getAuthClientFunction)(props.chatConfig);
-    if (props.getAuthToken && authClientFunction) {
-      // set auth token to chat sdk before end chat
-      const authSuccess = await (0, _authHelper.handleAuthentication)(chatSDK, props.chatConfig, props.getAuthToken);
-      if (!authSuccess) {
-        _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.ERROR, {
-          Event: _TelemetryConstants.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/cjs/components/livechatwidget/common/reconnectChatHelper.js

@@ -13,6 +13,7 @@ var _Constants = require("../../../common/Constants");
 var _ConversationState = require("../../../contexts/common/ConversationState");
 var _LiveChatWidgetActionType = require("../../../contexts/common/LiveChatWidgetActionType");
 var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
+var _startChatErrorHandler = require("./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) => {
@@ -21,7 +22,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) {
@@ -57,7 +58,7 @@ const handleChatReconnect = async (chatSDK, props, dispatch, setAdapter, initSta
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 exports.handleChatReconnect = handleChatReconnect;
-const getChatReconnectContext = async (chatSDK, chatConfig, props, isAuthenticatedChat) => {
+const getChatReconnectContext = async (chatSDK, chatConfig, props, isAuthenticatedChat, dispatch) => {
   try {
     var _props$reconnectChatP4;
     _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
@@ -69,6 +70,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 (0, _authHelper.handleAuthentication)(chatSDK, chatConfig, props.getAuthToken);
     }
     const reconnectChatContext = await (chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.getChatReconnectContext(chatReconnectOptionalParams));
@@ -78,7 +80,9 @@ const getChatReconnectContext = async (chatSDK, chatConfig, props, isAuthenticat
       (0, _authHelper.removeAuthTokenProvider)(chatSDK);
     }
     return reconnectChatContext;
-  } catch (error) {
+  }
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  catch (error) {
     (0, _utils.checkContactIdError)(error);
     _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.ERROR, {
       Event: _TelemetryConstants.TelemetryEvent.GetChatReconnectContextSDKCallFailed,
@@ -86,6 +90,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) == _Constants.WidgetLoadCustomErrorString.AuthenticationFailedErrorString) {
+      (0, _startChatErrorHandler.handleStartChatError)(dispatch, chatSDK, props, new Error(_Constants.WidgetLoadCustomErrorString.AuthenticationFailedErrorString), false);
+      throw error;
+    }
   }
 };
 

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

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

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

@@ -57,6 +57,7 @@ var _useChatSDKStore = _interopRequireDefault(require("../../../hooks/useChatSDK
 var _defaultAdaptiveCardStyles = require("../../webchatcontainerstateful/common/defaultStyles/defaultAdaptiveCardStyles");
 var _StartChatErrorPaneStateful = _interopRequireDefault(require("../../startchaterrorpanestateful/StartChatErrorPaneStateful"));
 var _StartChatFailureType = require("../../../contexts/common/StartChatFailureType");
+var _createReducer = require("../../../contexts/createReducer");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -125,8 +126,12 @@ const LiveChatWidgetStateful = props => {
     const isReconnectTriggered = async () => {
       if ((0, _reconnectChatHelper.isReconnectEnabled)(props.chatConfig) === true && !(0, _reconnectChatHelper.isPersistentEnabled)(props.chatConfig)) {
         const noValidReconnectId = await (0, _reconnectChatHelper.handleChatReconnect)(chatSDK, props, dispatch, setAdapter, _startChat.initStartChat, state);
+        const inMemoryState = (0, _createReducer.executeReducer)(state, {
+          type: _LiveChatWidgetActionType.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.ConversationState.Active || state.appStates.conversationState === _ConversationState.ConversationState.ReconnectChat)) {
+        if (!noValidReconnectId && (inMemoryState.appStates.conversationState === _ConversationState.ConversationState.Active || inMemoryState.appStates.conversationState === _ConversationState.ConversationState.ReconnectChat)) {
           return true;
         }
       }
@@ -340,7 +345,7 @@ const LiveChatWidgetStateful = props => {
 
     // Start chat from SDK Event
     _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.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 (!(0, _utils.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.TelemetryManager.InternalTelemetryData.lcwRuntimeId) {
         return;
@@ -368,12 +373,13 @@ const LiveChatWidgetStateful = props => {
         Event: _TelemetryConstants.TelemetryEvent.StartChatEventRecevied,
         Description: "Start chat event received."
       });
+      const inMemoryState = (0, _createReducer.executeReducer)(state, {
+        type: _LiveChatWidgetActionType.LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
+        payload: null
+      });
 
-      // DataStoreManager.clientDataStore?.swtichToSessionStorage(true);
-      const persistedState = (0, _utils.getStateFromCache)((0, _utils.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.ConversationState.Closed || ((_inMemoryState$appSta2 = inMemoryState.appStates) === null || _inMemoryState$appSta2 === void 0 ? void 0 : _inMemoryState$appSta2.conversationState) === _ConversationState.ConversationState.InActive || ((_inMemoryState$appSta3 = inMemoryState.appStates) === null || _inMemoryState$appSta3 === void 0 ? void 0 : _inMemoryState$appSta3.conversationState) === _ConversationState.ConversationState.Postchat) {
         _omnichannelChatComponents.BroadcastService.postMessage({
           eventName: _TelemetryConstants.BroadcastEvent.ChatInitiated
         });
@@ -381,33 +387,21 @@ 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.ConversationState.Closed || ((_persistedState$appSt2 = persistedState.appStates) === null || _persistedState$appSt2 === void 0 ? void 0 : _persistedState$appSt2.conversationState) === _ConversationState.ConversationState.InActive || ((_persistedState$appSt3 = persistedState.appStates) === null || _persistedState$appSt3 === void 0 ? void 0 : _persistedState$appSt3.conversationState) === _ConversationState.ConversationState.Postchat) {
-          _omnichannelChatComponents.BroadcastService.postMessage({
-            eventName: _TelemetryConstants.BroadcastEvent.ChatInitiated
-          });
-          (0, _startChat.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.LiveChatWidgetActionType.SET_MINIMIZED,
-            payload: false
-          });
-          _omnichannelChatComponents.BroadcastService.postMessage({
-            eventName: _TelemetryConstants.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.LiveChatWidgetActionType.SET_MINIMIZED,
+          payload: false
+        });
+        _omnichannelChatComponents.BroadcastService.postMessage({
+          eventName: _TelemetryConstants.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/cjs/components/webchatcontainerstateful/common/utils/isMaskingFromCustomer.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.isMaskingforCustomer = void 0;
+var _utils = require("../../../../common/utils");
 const isMaskingforCustomer = maskingInfo => {
   var _maskingInfo$setting;
   // If the masking info (containing masking setting and masking rules) is missing or empty, return false.
@@ -14,8 +15,9 @@ 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 (!(0, _utils.isNullOrUndefined)((_maskingInfo$setting = maskingInfo.setting) === null || _maskingInfo$setting === void 0 ? void 0 : _maskingInfo$setting.msdyn_maskforcustomer)) {
+    var _maskingInfo$setting2;
+    return (0, _utils.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/cjs/contexts/common/LiveChatWidgetActionType.js

@@ -52,4 +52,5 @@ exports.LiveChatWidgetActionType = 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 || (exports.LiveChatWidgetActionType = LiveChatWidgetActionType = {}));