@microsoft/omnichannel-chat-widget 0.1.0-main.7a3ed6a → 0.1.0-main.834a4cd

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

@@ -1,5 +1,5 @@
-import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
-import { ChatSDKError } from "../../../common/Constants";
+import { ChatSDKError, LiveWorkItemState } from "../../../common/Constants";
+import { BroadcastEvent, LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
 import { ConversationState } from "../../../contexts/common/ConversationState";
 import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidgetActionType";
 import { NotificationHandler } from "../../webchatcontainerstateful/webchatcontroller/notification/NotificationHandler";
@@ -7,29 +7,61 @@ import { NotificationScenarios } from "../../webchatcontainerstateful/webchatcon
 import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
 import { TelemetryTimers } from "../../../common/telemetry/TelemetryManager";
 import { createAdapter } from "./createAdapter";
-import { createTimer } from "../../../common/utils";
-import { getReconnectIdForAuthenticatedChat } from "./reconnectChatHelper";
+import { createOnNewAdapterActivityHandler } from "../../../plugins/newMessageEventHandler";
+import { createTimer, getStateFromCache, isUndefinedOrEmpty } from "../../../common/utils";
+import { setPostChatContextAndLoadSurvey } from "./setPostChatContextAndLoadSurvey";
 import { updateSessionDataForTelemetry } from "./updateSessionDataForTelemetry";
-import { setPostChatContextAndLoadSurvey } from "./setPostChatContextAndLoadSurvey"; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+import { BroadcastService } from "@microsoft/omnichannel-chat-components";
+import { ActivityStreamHandler } from "./ActivityStreamHandler";
+import { getAuthClientFunction, handleAuthentication } from "./authHelper";
+import { handleChatReconnect } from "./reconnectChatHelper";
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+let optionalParams = {};
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+let widgetInstanceId;
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const prepareStartChat = async (props, chatSDK, state, dispatch, setAdapter) => {
-  // Getting PreChat Survey Context
-  const parseToJson = false;
-  const preChatSurveyResponse = await chatSDK.getPreChatSurvey(parseToJson);
-  const showPrechat = state.appStates.conversationState === ConversationState.ProactiveChat ? preChatSurveyResponse && state.appStates.proactiveChatStates.proactiveChatEnablePrechat : preChatSurveyResponse; // Getting reconnectId for authenticated chat
+  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;
 
-  const reconnectId = await getReconnectIdForAuthenticatedChat(props, chatSDK);
+  // Can connect to existing chat session
+  if (await canConnectToExistingChat(props, chatSDK, state, dispatch, setAdapter)) {
+    return;
+  }
+  await handleChatReconnect(chatSDK, props, dispatch, setAdapter, initStartChat, state);
 
-  if (reconnectId) {
-    dispatch({
-      type: LiveChatWidgetActionType.SET_RECONNECT_ID,
-      payload: reconnectId
-    });
-    dispatch({
-      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
-      payload: ConversationState.ReconnectChat
-    });
-  } else if (showPrechat) {
+  // 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;
+  }
+
+  // Setting Proactive chat settings
+  const isProactiveChat = state.appStates.conversationState === ConversationState.ProactiveChat;
+  const isPreChatEnabledInProactiveChat = state.appStates.proactiveChatStates.proactiveChatEnablePrechat;
+
+  //Setting PreChat and intiate chat
+  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;
+  const preChatSurveyResponse = await chatSDK.getPreChatSurvey(parseToJson);
+  const showPrechat = isProactiveChat ? preChatSurveyResponse && proactiveChatEnablePrechatState : preChatSurveyResponse;
+  if (showPrechat) {
     dispatch({
       type: LiveChatWidgetActionType.SET_PRE_CHAT_SURVEY_RESPONSE,
       payload: preChatSurveyResponse
@@ -38,54 +70,114 @@ const prepareStartChat = async (props, chatSDK, state, dispatch, setAdapter) =>
       type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
       payload: ConversationState.Prechat
     });
-  } else {
-    dispatch({
-      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
-      payload: ConversationState.Loading
-    });
-    await initStartChat(chatSDK, dispatch, setAdapter);
+    return;
   }
-}; // eslint-disable-next-line @typescript-eslint/no-explicit-any
 
+  //Initiate start chat
+  dispatch({
+    type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+    payload: ConversationState.Loading
+  });
+  await initStartChat(chatSDK, props === null || props === void 0 ? void 0 : props.chatConfig, props === null || props === void 0 ? void 0 : props.getAuthToken, dispatch, setAdapter);
+};
 
-const initStartChat = async (chatSDK, dispatch, setAdapter, params) => {
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const initStartChat = async (chatSDK, chatConfig, getAuthToken, dispatch, setAdapter, params, persistedState) => {
   try {
-    var _TelemetryTimers$Widg;
+    var _newAdapter$activity$, _TelemetryTimers$Widg;
+    //Start widget load timer
+    TelemetryTimers.WidgetLoadTimer = createTimer();
+    TelemetryHelper.logLoadingEvent(LogLevel.INFO, {
+      Event: TelemetryEvent.WidgetLoadStarted,
+      Description: "Widget loading started"
+    });
+    const authClientFunction = getAuthClientFunction(chatConfig);
+    if (getAuthToken && authClientFunction) {
+      // set auth token to chat sdk before start chat
+      const authSuccess = await handleAuthentication(chatSDK, chatConfig, getAuthToken);
+      if (!authSuccess) {
+        return;
+      }
+    }
+    let isStartChatSuccessful = false;
 
+    //Check if chat retrieved from cache
+    if (persistedState || params !== null && params !== void 0 && params.liveChatContext) {
+      var _persistedState$domai, _persistedState$domai2, _persistedState$domai3, _persistedState$domai4, _persistedState$domai5;
+      BroadcastService.postMessage({
+        eventName: BroadcastEvent.ChatRetrievedFromCache,
+        payload: {
+          chatId: persistedState === null || persistedState === void 0 ? void 0 : (_persistedState$domai = persistedState.domainStates) === null || _persistedState$domai === void 0 ? void 0 : (_persistedState$domai2 = _persistedState$domai.liveChatContext) === null || _persistedState$domai2 === void 0 ? void 0 : (_persistedState$domai3 = _persistedState$domai2.chatToken) === null || _persistedState$domai3 === void 0 ? void 0 : _persistedState$domai3.chatId,
+          requestId: persistedState === null || persistedState === void 0 ? void 0 : (_persistedState$domai4 = persistedState.domainStates) === null || _persistedState$domai4 === void 0 ? void 0 : (_persistedState$domai5 = _persistedState$domai4.liveChatContext) === null || _persistedState$domai5 === void 0 ? void 0 : _persistedState$domai5.requestId
+        }
+      });
+    }
     try {
-      TelemetryHelper.logConfigDataEvent(LogLevel.INFO, {
+      TelemetryHelper.logSDKEvent(LogLevel.INFO, {
         Event: TelemetryEvent.StartChatSDKCall
       });
-      await chatSDK.startChat(params);
-      TelemetryTimers.WidgetLoadTimer = createTimer();
+
+      // Set custom context params
+      setCustomContextParams(chatSDK);
+      optionalParams = Object.assign({}, params, optionalParams);
+      await chatSDK.startChat(optionalParams);
+      isStartChatSuccessful = true;
     } catch (error) {
-      TelemetryHelper.logLoadingEvent(LogLevel.ERROR, {
+      TelemetryHelper.logSDKEvent(LogLevel.ERROR, {
         Event: TelemetryEvent.StartChatMethodException,
         ExceptionDetails: {
           exception: `Failed to setup startChat: ${error}`
         }
       });
+      isStartChatSuccessful = false;
+      // Resetting the widget state to Closed, for recent introduction of OC rate limiting(429 Error) 
+      // TODO : How to diplay a proper UI message to customer to try after sometime at this point - cool down scenario
+      dispatch({
+        type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+        payload: ConversationState.Closed
+      });
+      return;
     }
 
+    // New adapter creation
     const newAdapter = await createAdapter(chatSDK);
-    setAdapter(newAdapter); // eslint-disable-next-line @typescript-eslint/no-explicit-any
-
-    if (chatSDK !== null && chatSDK !== void 0 && chatSDK.getVoiceVideoCalling) {
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      const chatToken = await (chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.getChatToken());
+    setAdapter(newAdapter);
+    const chatToken = await chatSDK.getChatToken();
+    dispatch({
+      type: LiveChatWidgetActionType.SET_CHAT_TOKEN,
+      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_CHAT_TOKEN,
-        payload: chatToken
+        type: LiveChatWidgetActionType.SET_WIDGET_STATE,
+        payload: persistedState
       });
+      setPostChatContextAndLoadSurvey(chatSDK, dispatch, true);
+      return;
     }
 
-    await setPostChatContextAndLoadSurvey(chatSDK, dispatch, false);
-    await updateSessionDataForTelemetry(chatSDK, dispatch); // Set app state to Active
-
+    // 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_CONVERSATION_STATE,
-      payload: ConversationState.Active
+      type: LiveChatWidgetActionType.SET_LIVE_CHAT_CONTEXT,
+      payload: liveChatContext
     });
+
+    // Set post chat context in state, no survey load
+    setPostChatContextAndLoadSurvey(chatSDK, dispatch);
+
+    // Updating chat session detail for telemetry
+    await updateSessionDataForTelemetry(chatSDK, dispatch);
+
+    // Set app state to Active
+    if (isStartChatSuccessful) {
+      ActivityStreamHandler.uncork();
+      dispatch({
+        type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+        payload: ConversationState.Active
+      });
+    }
     TelemetryHelper.logLoadingEvent(LogLevel.INFO, {
       Event: TelemetryEvent.WidgetLoadComplete,
       Description: "Widget load complete",
@@ -93,13 +185,13 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, params) => {
     });
   } catch (ex) {
     TelemetryHelper.logLoadingEvent(LogLevel.ERROR, {
-      Event: TelemetryEvent.StartChatFailed,
+      Event: TelemetryEvent.WidgetLoadFailed,
       ExceptionDetails: {
-        Exception: `Start Chat Failed: ${ex}`
+        Exception: `Widget load Failed: ${ex}`
       }
     });
-    NotificationHandler.notifyError(NotificationScenarios.Connection, "Start Chat Failed: " + ex); // eslint-disable-next-line @typescript-eslint/no-explicit-any
-
+    NotificationHandler.notifyError(NotificationScenarios.Connection, "Start Chat Failed: " + ex);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     if (ex.message === ChatSDKError.WidgetUseOutsideOperatingHour) {
       dispatch({
         type: LiveChatWidgetActionType.SET_OUTSIDE_OPERATING_HOURS,
@@ -109,8 +201,117 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, params) => {
         type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
         payload: ConversationState.OutOfOffice
       });
+      return;
     }
+    // Show the loading pane in other cases for failure, this will help for both hideStartChatButton case
+    dispatch({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+      payload: ConversationState.Loading
+    });
+  } finally {
+    optionalParams = {};
+    widgetInstanceId = "";
+  }
+};
+
+// 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;
+  // By pass this function in case of popout chat
+  if (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$controlProps2 = props.controlProps) === null || _props$controlProps2 === void 0 ? void 0 : _props$controlProps2.widgetInstanceId) ?? "");
+
+  //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) && (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,
+      payload: ConversationState.Loading
+    });
+    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);
+    return true;
+  } else {
+    return false;
   }
 };
 
-export { prepareStartChat, initStartChat };
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const setCustomContextParams = chatSDK => {
+  var _chatSDK$omnichannelC3, _chatSDK$omnichannelC4, _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 ?? "");
+  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) {
+      const errorMessage = "Use of custom context with authenticated chat is deprecated. The chat would not go through.";
+      TelemetryHelper.logSDKEvent(LogLevel.WARN, {
+        Event: TelemetryEvent.StartChatMethodException,
+        ExceptionDetails: {
+          exception: errorMessage
+        }
+      });
+      throw new Error(errorMessage);
+    }
+    optionalParams = Object.assign({}, optionalParams, {
+      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 = getAuthClientFunction(props.chatConfig);
+    if (authClientFunction) {
+      // set auth token to chat sdk before start chat
+      const authSuccess = await 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) => {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  let conversationDetails = undefined;
+  const authSucceed = await handleAuthenticationIfEnabled(chatSDK, props);
+  if (!authSucceed) {
+    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 === LiveWorkItemState.Closed || conversationDetails.state === LiveWorkItemState.WrapUp) {
+      chatSDK.requestId = oldRequestId;
+      return false;
+    }
+    return true;
+  } catch (erorr) {
+    TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+      Event: TelemetryEvent.GetConversationDetailsException,
+      ExceptionDetails: {
+        exception: `Conversation is not valid: ${erorr}`
+      }
+    });
+    chatSDK.requestId = oldRequestId;
+    return false;
+  }
+};
+export { prepareStartChat, initStartChat, setPreChatAndInitiateChat, checkIfConversationStillValid };

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

@@ -2,14 +2,14 @@ import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryCon
 import { ConversationState } from "../../../contexts/common/ConversationState";
 import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidgetActionType";
 import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
-import { TelemetryTimers } from "../../../common/telemetry/TelemetryManager"; // Defines startProactiveChat callback
-
-export const startProactiveChat = (dispatch, bodyTitle, showPrechat, inNewWindow) => {
+import { TelemetryTimers } from "../../../common/telemetry/TelemetryManager";
+// Defines startProactiveChat callback
+export const startProactiveChat = (dispatch, notificationConfig, enablePreChat, inNewWindow) => {
   dispatch({
     type: LiveChatWidgetActionType.SET_PROACTIVE_CHAT_PARAMS,
     payload: {
-      proactiveChatBodyTitle: bodyTitle ?? "",
-      proactiveChatEnablePrechat: showPrechat ?? false,
+      proactiveChatBodyTitle: notificationConfig && notificationConfig.message ? notificationConfig.message : "",
+      proactiveChatEnablePrechat: enablePreChat ?? false,
       proactiveChatInNewWindow: inNewWindow ?? false
     }
   });

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

@@ -1,7 +1,8 @@
 import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidgetActionType";
 import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
-import { TelemetryManager } from "../../../common/telemetry/TelemetryManager"; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+import { TelemetryManager } from "../../../common/telemetry/TelemetryManager";
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const updateSessionDataForTelemetry = async (chatSDK, dispatch) => {
   if (chatSDK) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -13,8 +14,9 @@ export const updateSessionDataForTelemetry = async (chatSDK, dispatch) => {
     });
     await updateConversationDataForTelemetry(chatSDK, dispatch);
   }
-}; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+};
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const updateConversationDataForTelemetry = async (chatSDK, dispatch) => {
   if (chatSDK) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

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

@@ -0,0 +1 @@
+export {};