@microsoft/omnichannel-chat-widget 1.0.3-main.527b216 → 1.0.3-main.c925679

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

@@ -1,6 +1,6 @@
 import { BroadcastEvent, LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
 import { ChatSDKError, LiveWorkItemState } from "../../../common/Constants";
-import { createTimer, getStateFromCache, isUndefinedOrEmpty } from "../../../common/utils";
+import { createTimer, getStateFromCache, getWidgetCacheIdfromProps, isNullOrEmptyString, isUndefinedOrEmpty } from "../../../common/utils";
 import { getAuthClientFunction, handleAuthentication } from "./authHelper";
 import { ActivityStreamHandler } from "./ActivityStreamHandler";
 import { BroadcastService } from "@microsoft/omnichannel-chat-components";
@@ -20,21 +20,26 @@ import { updateSessionDataForTelemetry } from "./updateSessionDataForTelemetry";
 let optionalParams = {};
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 let widgetInstanceId;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+let popoutWidgetInstanceId;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const prepareStartChat = async (props, chatSDK, state, dispatch, setAdapter) => {
-  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;
+  widgetInstanceId = getWidgetCacheIdfromProps(props);
 
   // reconnect > chat from cache
   await 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.Active || state.appStates.conversationState === ConversationState.ReconnectChat) {
     return;
   }
 
+  // Check if there is any active popout chats in cache
+  if (await canStartPopoutChat(props)) {
+    return;
+  }
+
   // Can connect to existing chat session
   if (await canConnectToExistingChat(props, chatSDK, state, dispatch, setAdapter)) {
     return;
@@ -45,19 +50,12 @@ const prepareStartChat = async (props, chatSDK, state, dispatch, setAdapter) =>
   const isPreChatEnabledInProactiveChat = state.appStates.proactiveChatStates.proactiveChatEnablePrechat;
 
   //Setting PreChat and intiate chat
-  setPreChatAndInitiateChat(chatSDK, dispatch, setAdapter, isProactiveChat, isPreChatEnabledInProactiveChat, undefined, props);
+  await setPreChatAndInitiateChat(chatSDK, dispatch, setAdapter, isProactiveChat, isPreChatEnabledInProactiveChat, undefined, props);
 };
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const setPreChatAndInitiateChat = async (chatSDK, dispatch, setAdapter, isProactiveChat, proactiveChatEnablePrechatState, state, props) => {
   //Handle reconnect scenario
-  if (state) {
-    await 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.Active || state.appStates.conversationState === ConversationState.ReconnectChat) {
-      return;
-    }
-  }
 
   // Getting prechat Survey Context
   const parseToJson = false;
@@ -88,11 +86,11 @@ const setPreChatAndInitiateChat = async (chatSDK, dispatch, setAdapter, isProact
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const initStartChat = async (chatSDK, dispatch, setAdapter, props, params, persistedState) => {
-  var _props$controlProps2;
+  var _props$controlProps;
   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;
+  const hideErrorUIPane = props === null || props === void 0 ? void 0 : (_props$controlProps = props.controlProps) === null || _props$controlProps === void 0 ? void 0 : _props$controlProps.hideErrorUIPane;
   try {
     var _newAdapter$activity$, _TelemetryTimers$Widg;
     //Start widget load timer
@@ -106,11 +104,8 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, props, params, persi
       // set auth token to chat sdk before start chat
       const authSuccess = await handleAuthentication(chatSDK, chatConfig, getAuthToken);
       if (!authSuccess) {
-        dispatch({
-          type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
-          payload: ConversationState.Closed
-        });
-        return;
+        // Replacing with error ui
+        throw new Error("Authentication was not successful");
       }
     }
 
@@ -128,7 +123,7 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, props, params, persi
     try {
       var _window$Microsoft, _window$Microsoft$Dyn, _window$Microsoft$Dyn2, _window$Microsoft$Dyn3;
       // Set custom context params
-      setCustomContextParams(chatSDK);
+      setCustomContextParams();
       const defaultOptionalParams = {
         sendDefaultInitContext: true,
         isProactiveChat: !!(params !== null && params !== void 0 && params.isProactiveChat),
@@ -157,21 +152,6 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, props, params, persi
       payload: chatToken
     });
     newAdapter === null || newAdapter === void 0 ? void 0 : (_newAdapter$activity$ = newAdapter.activity$) === null || _newAdapter$activity$ === void 0 ? void 0 : _newAdapter$activity$.subscribe(createOnNewAdapterActivityHandler(chatToken === null || chatToken === void 0 ? void 0 : chatToken.chatId, chatToken === null || chatToken === void 0 ? void 0 : chatToken.visitorId));
-    if (persistedState) {
-      dispatch({
-        type: LiveChatWidgetActionType.SET_WIDGET_STATE,
-        payload: persistedState
-      });
-      setPostChatContextAndLoadSurvey(chatSDK, dispatch, true);
-      return;
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const liveChatContext = await (chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.getCurrentLiveChatContext());
-    dispatch({
-      type: LiveChatWidgetActionType.SET_LIVE_CHAT_CONTEXT,
-      payload: liveChatContext
-    });
 
     // Set app state to Active
     if (isStartChatSuccessful) {
@@ -186,14 +166,30 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, props, params, persi
         payload: ConversationState.Active
       });
     }
+    if (persistedState) {
+      dispatch({
+        type: LiveChatWidgetActionType.SET_WIDGET_STATE,
+        payload: persistedState
+      });
+      await setPostChatContextAndLoadSurvey(chatSDK, dispatch, true);
+      return;
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const liveChatContext = await (chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.getCurrentLiveChatContext());
+    dispatch({
+      type: LiveChatWidgetActionType.SET_LIVE_CHAT_CONTEXT,
+      payload: liveChatContext
+    });
     TelemetryHelper.logLoadingEvent(LogLevel.INFO, {
       Event: TelemetryEvent.WidgetLoadComplete,
       Description: "Widget load complete",
       ElapsedTimeInMilliseconds: TelemetryTimers === null || TelemetryTimers === void 0 ? void 0 : (_TelemetryTimers$Widg = TelemetryTimers.WidgetLoadTimer) === null || _TelemetryTimers$Widg === void 0 ? void 0 : _TelemetryTimers$Widg.milliSecondsElapsed
     });
 
-    // Set post chat context in state, no survey load
-    setPostChatContextAndLoadSurvey(chatSDK, dispatch);
+    // Set post chat context in state
+    // Commenting this for now as post chat context is fetched during end chat
+    await setPostChatContextAndLoadSurvey(chatSDK, dispatch);
 
     // Updating chat session detail for telemetry
     await updateSessionDataForTelemetry(chatSDK, dispatch);
@@ -217,12 +213,12 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, props, params, persi
       });
       return;
     }
+    dispatch({
+      type: LiveChatWidgetActionType.SET_START_CHAT_FAILING,
+      payload: true
+    });
     if (!hideErrorUIPane) {
       // Set app state to failing start chat if hideErrorUI is not turned on
-      dispatch({
-        type: LiveChatWidgetActionType.SET_START_CHAT_FAILING,
-        payload: true
-      });
       TelemetryHelper.logLoadingEvent(LogLevel.INFO, {
         Event: TelemetryEvent.ErrorUIPaneLoaded,
         Description: "Error UI Pane Loaded"
@@ -258,15 +254,15 @@ const forceEndChat = async chatSDK => {
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const canConnectToExistingChat = async (props, chatSDK, state, dispatch, setAdapter) => {
-  var _chatSDK$omnichannelC, _chatSDK$omnichannelC2, _props$controlProps3, _persistedState$domai6;
+  var _state$appStates, _persistedState$domai6, _persistedState$appSt;
   // By pass this function in case of popout chat
-  if (state.appStates.hideStartChatButton === true) {
+  if ((state === null || state === void 0 ? void 0 : (_state$appStates = state.appStates) === null || _state$appStates === void 0 ? void 0 : _state$appStates.hideStartChatButton) === true) {
     return false;
   }
-  const persistedState = 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) ?? "");
+  const persistedState = getStateFromCache(getWidgetCacheIdfromProps(props));
 
   //Connect to only active chat session
-  if (persistedState && !isUndefinedOrEmpty(persistedState === null || persistedState === void 0 ? void 0 : (_persistedState$domai6 = persistedState.domainStates) === null || _persistedState$domai6 === void 0 ? void 0 : _persistedState$domai6.liveChatContext)) {
+  if (persistedState && !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.Active) {
     var _persistedState$domai7;
     dispatch({
       type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
@@ -277,16 +273,15 @@ const canConnectToExistingChat = async (props, chatSDK, state, dispatch, setAdap
     };
     await initStartChat(chatSDK, dispatch, setAdapter, props, optionalParams, persistedState);
     return true;
-  } else {
-    return false;
   }
+  return false;
 };
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-const setCustomContextParams = chatSDK => {
-  var _chatSDK$omnichannelC3, _chatSDK$omnichannelC4, _persistedState$domai8;
+const setCustomContextParams = () => {
+  var _persistedState$domai8;
   // Add custom context only for unauthenticated chat
-  const persistedState = getStateFromCache(chatSDK === null || chatSDK === void 0 ? void 0 : (_chatSDK$omnichannelC3 = chatSDK.omnichannelConfig) === null || _chatSDK$omnichannelC3 === void 0 ? void 0 : _chatSDK$omnichannelC3.orgId, chatSDK === null || chatSDK === void 0 ? void 0 : (_chatSDK$omnichannelC4 = chatSDK.omnichannelConfig) === null || _chatSDK$omnichannelC4 === void 0 ? void 0 : _chatSDK$omnichannelC4.widgetId, widgetInstanceId ?? "");
+  const persistedState = getStateFromCache(widgetInstanceId);
   if (!isUndefinedOrEmpty(persistedState === null || persistedState === void 0 ? void 0 : (_persistedState$domai8 = persistedState.domainStates) === null || _persistedState$domai8 === void 0 ? void 0 : _persistedState$domai8.customContext)) {
     var _persistedState$domai9, _persistedState$domai10;
     if (persistedState !== null && persistedState !== void 0 && (_persistedState$domai9 = persistedState.domainStates.liveChatConfig) !== null && _persistedState$domai9 !== void 0 && _persistedState$domai9.LiveChatConfigAuthSettings) {
@@ -304,25 +299,43 @@ const setCustomContextParams = chatSDK => {
     });
   }
 };
+const canStartPopoutChat = async props => {
+  if (props.allowSdkChatSupport === false) {
+    return false;
+  }
+  popoutWidgetInstanceId = getWidgetCacheIdfromProps(props, true);
+  if (!isNullOrEmptyString(popoutWidgetInstanceId)) {
+    var _persistedState$domai11, _persistedState$appSt2;
+    const persistedState = getStateFromCache(popoutWidgetInstanceId);
+    if (persistedState && !isUndefinedOrEmpty(persistedState === null || persistedState === void 0 ? void 0 : (_persistedState$domai11 = persistedState.domainStates) === null || _persistedState$domai11 === void 0 ? void 0 : _persistedState$domai11.liveChatContext) && (persistedState === null || persistedState === void 0 ? void 0 : (_persistedState$appSt2 = persistedState.appStates) === null || _persistedState$appSt2 === void 0 ? void 0 : _persistedState$appSt2.conversationState) === ConversationState.Active) {
+      // Initiate popout chat
+      BroadcastService.postMessage({
+        eventName: BroadcastEvent.InitiateStartChatInPopoutMode
+      });
+      return true;
+    }
+  }
+  return false;
+};
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const checkIfConversationStillValid = async (chatSDK, dispatch, state) => {
   var _state$domainStates, _state$domainStates$l;
-  const requestId = (_state$domainStates = state.domainStates) === null || _state$domainStates === void 0 ? void 0 : (_state$domainStates$l = _state$domainStates.liveChatContext) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.requestId;
+  const requestIdFromCache = (_state$domainStates = state.domainStates) === null || _state$domainStates === void 0 ? void 0 : (_state$domainStates$l = _state$domainStates.liveChatContext) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.requestId;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   let conversationDetails = undefined;
 
-  //Preserve old requestId
-  const oldRequestId = chatSDK.requestId ?? "";
+  //Preserve current requestId
+  const currentRequestId = chatSDK.requestId ?? "";
   dispatch({
     type: LiveChatWidgetActionType.SET_INITIAL_CHAT_SDK_REQUEST_ID,
-    payload: oldRequestId
+    payload: currentRequestId
   });
   try {
-    chatSDK.requestId = requestId;
+    chatSDK.requestId = requestIdFromCache;
     conversationDetails = await chatSDK.getConversationDetails();
     if (Object.keys(conversationDetails).length === 0) {
-      chatSDK.requestId = oldRequestId;
+      chatSDK.requestId = currentRequestId;
       return false;
     }
     if (conversationDetails.state === LiveWorkItemState.Closed || conversationDetails.state === LiveWorkItemState.WrapUp) {
@@ -330,7 +343,7 @@ const checkIfConversationStillValid = async (chatSDK, dispatch, state) => {
         type: LiveChatWidgetActionType.SET_LIVE_CHAT_CONTEXT,
         payload: undefined
       });
-      chatSDK.requestId = oldRequestId;
+      chatSDK.requestId = currentRequestId;
       return false;
     }
     return true;
@@ -341,7 +354,7 @@ const checkIfConversationStillValid = async (chatSDK, dispatch, state) => {
         exception: `Conversation is not valid: ${erorr}`
       }
     });
-    chatSDK.requestId = oldRequestId;
+    chatSDK.requestId = currentRequestId;
     return false;
   }
 };