@microsoft/omnichannel-chat-widget 1.6.2 → 1.6.3-main.0e66ed8

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;
         }
       }
@@ -131,9 +136,6 @@ export const LiveChatWidgetStateful = props => {
         type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
         payload: ConversationState.Loading
       });
-      if (localState) {
-        localState.appStates.conversationState = ConversationState.Loading;
-      }
 
       //Check if conversation state is not in wrapup or closed state
       isChatValid = await checkIfConversationStillValid(chatSDK, dispatch, state);
@@ -150,7 +152,11 @@ export const LiveChatWidgetStateful = props => {
         // adding the reconnect logic for the case when customer tries to reconnect from a new browser or InPrivate browser
         const reconnectTriggered = await isReconnectTriggered();
         if (!reconnectTriggered) {
-          await setPreChatAndInitiateChat(chatSDK, dispatch, setAdapter, undefined, undefined, localState, props);
+          const inMemoryState = executeReducer(state, {
+            type: LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
+            payload: null
+          });
+          await setPreChatAndInitiateChat(chatSDK, dispatch, setAdapter, undefined, undefined, inMemoryState, props);
         }
         return;
       } else {
@@ -330,76 +336,70 @@ export const LiveChatWidgetStateful = props => {
       }
     });
 
+    /**
+     * This will allow to sync multiple tabs to handle minimize and maximize state, 
+     * the event is expected to be emitted from scripting layer.
+     */
+    BroadcastService.getMessageByEventName(BroadcastEvent.SyncMinimize).subscribe(msg => {
+      var _msg$payload4;
+      dispatch({
+        type: LiveChatWidgetActionType.SET_MINIMIZED,
+        payload: msg === null || msg === void 0 ? void 0 : (_msg$payload4 = msg.payload) === null || _msg$payload4 === void 0 ? void 0 : _msg$payload4.minimized
+      });
+    });
+
     // Start chat from SDK Event
     BroadcastService.getMessageByEventName(BroadcastEvent.StartChat).subscribe(msg => {
-      var _msg$payload4, _msg$payload5, _msg$payload6;
+      var _msg$payload5, _msg$payload6, _msg$payload7, _msg$payload9, _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) {
+      if (!isNullOrUndefined(msg === null || msg === void 0 ? void 0 : (_msg$payload5 = msg.payload) === null || _msg$payload5 === void 0 ? void 0 : _msg$payload5.runtimeId) && (msg === null || msg === void 0 ? void 0 : (_msg$payload6 = msg.payload) === null || _msg$payload6 === void 0 ? void 0 : _msg$payload6.runtimeId) !== TelemetryManager.InternalTelemetryData.lcwRuntimeId) {
         return;
       }
-      let stateWithUpdatedContext = state;
-      if (msg !== null && msg !== void 0 && (_msg$payload6 = msg.payload) !== null && _msg$payload6 !== void 0 && _msg$payload6.customContext) {
-        var _msg$payload7, _msg$payload8;
+      if (msg !== null && msg !== void 0 && (_msg$payload7 = msg.payload) !== null && _msg$payload7 !== void 0 && _msg$payload7.customContext) {
+        var _msg$payload8;
         TelemetryHelper.logActionEvent(LogLevel.INFO, {
           Event: TelemetryEvent.CustomContextReceived,
           Description: "CustomContext received through startChat event."
         });
         dispatch({
           type: LiveChatWidgetActionType.SET_CUSTOM_CONTEXT,
-          payload: msg === null || msg === void 0 ? void 0 : (_msg$payload7 = msg.payload) === null || _msg$payload7 === void 0 ? void 0 : _msg$payload7.customContext
+          payload: msg === null || msg === void 0 ? void 0 : (_msg$payload8 = msg.payload) === null || _msg$payload8 === void 0 ? void 0 : _msg$payload8.customContext
         });
-        stateWithUpdatedContext = {
-          ...state,
-          domainStates: {
-            ...state.domainStates,
-            customContext: msg === null || msg === void 0 ? void 0 : (_msg$payload8 = msg.payload) === null || _msg$payload8 === void 0 ? void 0 : _msg$payload8.customContext
-          }
-        };
       }
       TelemetryHelper.logActionEvent(LogLevel.INFO, {
         Event: TelemetryEvent.StartChatEventRecevied,
         Description: "Start chat event received."
       });
+      const inMemoryState = executeReducer(state, {
+        type: LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
+        payload: null
+      });
+      inMemoryState.domainStates.customContext = msg === null || msg === void 0 ? void 0 : (_msg$payload9 = msg.payload) === null || _msg$payload9 === void 0 ? void 0 : _msg$payload9.customContext;
 
-      // 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
         });
-        prepareStartChat(props, chatSDK, stateWithUpdatedContext, dispatch, setAdapter);
+        prepareStartChat(props, chatSDK, inMemoryState, dispatch, setAdapter);
         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;
       }
     });
 
@@ -448,8 +448,8 @@ export const LiveChatWidgetStateful = props => {
     // Listen to end chat event from other tabs
     const endChatEventName = getWidgetEndChatEventName(chatSDK === null || chatSDK === void 0 ? void 0 : (_chatSDK$omnichannelC2 = chatSDK.omnichannelConfig) === null || _chatSDK$omnichannelC2 === void 0 ? void 0 : _chatSDK$omnichannelC2.orgId, chatSDK === null || chatSDK === void 0 ? void 0 : (_chatSDK$omnichannelC3 = chatSDK.omnichannelConfig) === null || _chatSDK$omnichannelC3 === void 0 ? void 0 : _chatSDK$omnichannelC3.widgetId, ((_props$controlProps11 = props.controlProps) === null || _props$controlProps11 === void 0 ? void 0 : _props$controlProps11.widgetInstanceId) ?? "");
     BroadcastService.getMessageByEventName(endChatEventName).subscribe(msg => {
-      var _msg$payload9;
-      if ((msg === null || msg === void 0 ? void 0 : (_msg$payload9 = msg.payload) === null || _msg$payload9 === void 0 ? void 0 : _msg$payload9.runtimeId) !== TelemetryManager.InternalTelemetryData.lcwRuntimeId) {
+      var _msg$payload10;
+      if ((msg === null || msg === void 0 ? void 0 : (_msg$payload10 = msg.payload) === null || _msg$payload10 === void 0 ? void 0 : _msg$payload10.runtimeId) !== TelemetryManager.InternalTelemetryData.lcwRuntimeId) {
         TelemetryHelper.logSDKEvent(LogLevel.INFO, {
           Event: TelemetryEvent.PrepareEndChat,
           Description: "Received EndChat BroadcastEvent from other tabs. Closing this chat."

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 = {}));

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

@@ -12,6 +12,16 @@ export const getLiveChatWidgetContextInitialState = props => {
   const initialState = defaultClientDataStoreProvider(cacheTtlInMins, storageType).getData(widgetCacheId);
   if (!isNullOrUndefined(initialState)) {
     const initialStateFromCache = JSON.parse(initialState);
+
+    /*
+    * this step is needed to avoid the pre-chat pane to be injected in the DOM when the widget is reloaded, because wont be visible
+    * and it will be blocking all elements behind it
+    * as part of the flow, the pre-chat will be detected and then it will be displayed properly 
+    * this case is only and only for pre-chat pane.
+    * **/
+    if (initialStateFromCache.appStates.conversationState === ConversationState.Prechat) {
+      initialStateFromCache.appStates.conversationState = ConversationState.Closed;
+    }
     return initialStateFromCache;
   }
   const LiveChatWidgetContextInitialState = {