@microsoft/omnichannel-chat-widget 0.1.0-main.fdf1fdf → 1.0.0

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

@@ -1,10 +1,18 @@
-import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
+import { BroadcastEvent, LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
 import { BroadcastService } from "@microsoft/omnichannel-chat-components";
 import { ConversationState } from "../../../contexts/common/ConversationState";
 import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidgetActionType";
-import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper"; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
+import { Constants } from "../../../common/Constants";
+import { endChat } from "./endChat";
+import { PostChatSurveyMode } from "../../postchatsurveypanestateful/enums/PostChatSurveyMode";
+import { addDelayInMs } from "../../../common/utils";
+import { NotificationHandler } from "../../webchatcontainerstateful/webchatcontroller/notification/NotificationHandler";
+import { NotificationScenarios } from "../../webchatcontainerstateful/webchatcontroller/enums/NotificationScenarios";
+import { ConversationEndEntity } from "../../../contexts/common/ConversationEndEntity";
 
-export const setPostChatContextAndLoadSurvey = async (chatSDK, dispatch, persistedChat) => {
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const setPostChatContextAndLoadSurvey = async (chatSDK, dispatch, persistedChat) => {
   try {
     if (!persistedChat) {
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -25,13 +33,258 @@ export const setPostChatContextAndLoadSurvey = async (chatSDK, dispatch, persist
         exception: ex
       }
     });
-  } // eslint-disable-next-line @typescript-eslint/no-unused-vars
-
+  }
 
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   BroadcastService.getMessageByEventName("LoadPostChatSurvey").subscribe(msg => {
     dispatch({
       type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
       payload: ConversationState.Postchat
     });
   });
-};
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const checkPostChatEnabled = (props, state) => {
+  var _props$chatConfig, _props$chatConfig$Liv, _state$domainStates$l, _state$domainStates$l2;
+  const isPostChatEnabled = ((_props$chatConfig = props.chatConfig) === null || _props$chatConfig === void 0 ? void 0 : (_props$chatConfig$Liv = _props$chatConfig.LiveWSAndLiveChatEngJoin) === null || _props$chatConfig$Liv === void 0 ? void 0 : _props$chatConfig$Liv.msdyn_postconversationsurveyenable) ?? ((_state$domainStates$l = state.domainStates.liveChatConfig) === null || _state$domainStates$l === void 0 ? void 0 : (_state$domainStates$l2 = _state$domainStates$l.LiveWSAndLiveChatEngJoin) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.msdyn_postconversationsurveyenable);
+  return isPostChatEnabled === Constants.true;
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const initiatePostChat = async (props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, state) => {
+  // Check if Postchat already in progress and handle case where chat is ended by customer
+  if (state.appStates.postChatWorkflowInProgress && state.appStates.conversationEndedBy === ConversationEndEntity.Customer) {
+    await endChat(props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, false, false, true);
+    return;
+  }
+
+  // Conversation Details call required by customer as well as agent 
+  const conversationDetails = await getConversationDetailsCall(chatSDK);
+  // Start Postchat workflow
+  dispatch({
+    type: LiveChatWidgetActionType.SET_POST_CHAT_WORKFLOW_IN_PROGRESS,
+    payload: true
+  });
+
+  // Below logic checks if agent or bot or noone joins conversation and handles them separately
+  if ((conversationDetails === null || conversationDetails === void 0 ? void 0 : conversationDetails.participantType) === Constants.userParticipantTypeTag) {
+    if (state.appStates.conversationEndedBy === ConversationEndEntity.Customer) {
+      // Set use bot settings to false
+      await postChatInitiatedByCustomer(props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, state, conversationDetails, false);
+    } else if (state.appStates.conversationEndedBy === ConversationEndEntity.Agent) {
+      await postChatInitiatedByAgent(props, setWebChatStyles, dispatch, state);
+    } else {
+      const error = `Conversation was Ended after agent joined but App State was not set correctly: conversationEndedBy = ${state.appStates.conversationEndedBy}`;
+      TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+        Event: TelemetryEvent.AppStatesException,
+        ExceptionDetails: {
+          exception: error
+        }
+      });
+      throw new Error(error);
+    }
+  } else if ((conversationDetails === null || conversationDetails === void 0 ? void 0 : conversationDetails.participantType) === Constants.botParticipantTypeTag) {
+    // Set Use bot survey to true
+    dispatch({
+      type: LiveChatWidgetActionType.SET_SHOULD_USE_BOT_SURVEY,
+      payload: true
+    });
+    if (state.appStates.conversationEndedBy === ConversationEndEntity.Customer) {
+      // Set use bot settings to true
+      await postChatInitiatedByCustomer(props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, state, conversationDetails, true);
+    } else if (state.appStates.conversationEndedBy === ConversationEndEntity.Agent) {
+      await postChatInitiatedByBot(props, setWebChatStyles, dispatch, state);
+    } else {
+      const error = `Conversation was Ended after bot joined but App State was not set correctly: conversationEndedBy = ${state.appStates.conversationEndedBy}`;
+      TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+        Event: TelemetryEvent.AppStatesException,
+        ExceptionDetails: {
+          exception: error
+        }
+      });
+      throw new Error(error);
+    }
+  } else {
+    if (state.appStates.conversationEndedBy === ConversationEndEntity.Customer) {
+      // No one has joined chat will be handled by postChat customer
+      await postChatInitiatedByCustomer(props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, state, conversationDetails, false);
+    } else {
+      const error = `ConversationDetails and App state was not set correctly: conversationDetails = ${JSON.stringify(conversationDetails)} , conversationEndedBy = ${state.appStates.conversationEndedBy}`;
+      TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+        Event: TelemetryEvent.AppStatesException,
+        ExceptionDetails: {
+          exception: error
+        }
+      });
+      throw new Error(error);
+    }
+  }
+};
+
+// Function for link mode postchat workflow which is essentially same for both customer and agent
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const linkModePostChatWorkflow = (props, dispatch, setWebChatStyles) => {
+  var _props$webChatContain, _props$webChatContain2;
+  TelemetryHelper.logActionEvent(LogLevel.INFO, {
+    Event: TelemetryEvent.LinkModePostChatWorkflowStarted
+  });
+  dispatch({
+    type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+    payload: ConversationState.InActive
+  });
+
+  // Disable SendBox
+  if ((props === null || props === void 0 ? void 0 : (_props$webChatContain = props.webChatContainerProps) === null || _props$webChatContain === void 0 ? void 0 : (_props$webChatContain2 = _props$webChatContain.renderingMiddlewareProps) === null || _props$webChatContain2 === void 0 ? void 0 : _props$webChatContain2.hideSendboxOnConversationEnd) !== false) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    setWebChatStyles(styles => {
+      return {
+        ...styles,
+        hideSendBox: true
+      };
+    });
+  }
+};
+
+// Function for embed mode postchat workflow which is essentially same for both customer and agent
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const embedModePostChatWorkflow = async (dispatch, state) => {
+  TelemetryHelper.logActionEvent(LogLevel.INFO, {
+    Event: TelemetryEvent.EmbedModePostChatWorkflowStarted
+  });
+  if (state.domainStates.postChatContext) {
+    dispatch({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+      payload: ConversationState.PostchatLoading
+    });
+    await addDelayInMs(Constants.PostChatLoadingDurationInMs);
+    const loadPostChatEvent = {
+      eventName: BroadcastEvent.LoadPostChatSurvey
+    };
+    BroadcastService.postMessage(loadPostChatEvent);
+  } else {
+    const error = `Conversation was Ended but App State was not set correctly: postChatContext = ${state.domainStates.postChatContext}`;
+    TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+      Event: TelemetryEvent.AppStatesException,
+      ExceptionDetails: {
+        exception: error
+      }
+    });
+    throw new Error(error);
+  }
+};
+
+// Function will handle only postchat cases initiated by customer
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const postChatInitiatedByCustomer = async (props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, state, conversationDetails, shouldUseBotSetting) => {
+  let postChatSurveyMode = "";
+  if (shouldUseBotSetting) {
+    var _props$chatConfig2, _props$chatConfig2$Li, _state$domainStates$l3, _state$domainStates$l4;
+    postChatSurveyMode = ((_props$chatConfig2 = props.chatConfig) === null || _props$chatConfig2 === void 0 ? void 0 : (_props$chatConfig2$Li = _props$chatConfig2.LiveWSAndLiveChatEngJoin) === null || _props$chatConfig2$Li === void 0 ? void 0 : _props$chatConfig2$Li.msdyn_postconversationsurveybotsurveymode) ?? ((_state$domainStates$l3 = state.domainStates.liveChatConfig) === null || _state$domainStates$l3 === void 0 ? void 0 : (_state$domainStates$l4 = _state$domainStates$l3.LiveWSAndLiveChatEngJoin) === null || _state$domainStates$l4 === void 0 ? void 0 : _state$domainStates$l4.msdyn_postconversationsurveybotsurveymode);
+  } else {
+    var _props$chatConfig3, _props$chatConfig3$Li, _state$domainStates$l5, _state$domainStates$l6;
+    postChatSurveyMode = ((_props$chatConfig3 = props.chatConfig) === null || _props$chatConfig3 === void 0 ? void 0 : (_props$chatConfig3$Li = _props$chatConfig3.LiveWSAndLiveChatEngJoin) === null || _props$chatConfig3$Li === void 0 ? void 0 : _props$chatConfig3$Li.msdyn_postconversationsurveymode) ?? ((_state$domainStates$l5 = state.domainStates.liveChatConfig) === null || _state$domainStates$l5 === void 0 ? void 0 : (_state$domainStates$l6 = _state$domainStates$l5.LiveWSAndLiveChatEngJoin) === null || _state$domainStates$l6 === void 0 ? void 0 : _state$domainStates$l6.msdyn_postconversationsurveymode);
+  }
+  // Check if agent or bot has joined conversation
+  if ((conversationDetails === null || conversationDetails === void 0 ? void 0 : conversationDetails.canRenderPostChat) === Constants.truePascal) {
+    TelemetryHelper.logActionEvent(LogLevel.INFO, {
+      Event: TelemetryEvent.PostChatWorkflowFromCustomer,
+      Description: shouldUseBotSetting ? "PostChat Workflow was started by customer using bot settings" : "PostChat Workflow was started by customer using agent settings"
+    });
+    const chatSession = await (chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.getCurrentLiveChatContext());
+    // End chat call to end chatsdk but not close chat, only if chat ended by customer
+    await endChat(props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, false, true, false);
+    // Saving request Id below for chat transcript calls
+    if (chatSession) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      chatSDK.chatToken = chatSession.chatToken ?? {};
+      chatSDK.requestId = chatSession.requestId;
+    }
+    if (postChatSurveyMode === PostChatSurveyMode.Embed) {
+      await embedModePostChatWorkflow(dispatch, state);
+    } else if (postChatSurveyMode === PostChatSurveyMode.Link) {
+      linkModePostChatWorkflow(props, dispatch, setWebChatStyles);
+    } else {
+      const error = `Conversation was Ended but App State was not set correctly: msdyn_postconversationsurveymode = ${postChatSurveyMode}`;
+      TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+        Event: TelemetryEvent.AppStatesException,
+        ExceptionDetails: {
+          exception: error
+        }
+      });
+      throw new Error(error);
+    }
+  } else {
+    // Agent did not join chat so end chat normally
+    await endChat(props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, false, false, true);
+  }
+};
+
+// Function will handle only postchat cases initiated by agent
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const postChatInitiatedByAgent = async (props, setWebChatStyles, dispatch, state) => {
+  var _props$chatConfig4, _props$chatConfig4$Li, _state$domainStates$l7, _state$domainStates$l8;
+  const postChatSurveyMode = ((_props$chatConfig4 = props.chatConfig) === null || _props$chatConfig4 === void 0 ? void 0 : (_props$chatConfig4$Li = _props$chatConfig4.LiveWSAndLiveChatEngJoin) === null || _props$chatConfig4$Li === void 0 ? void 0 : _props$chatConfig4$Li.msdyn_postconversationsurveymode) ?? ((_state$domainStates$l7 = state.domainStates.liveChatConfig) === null || _state$domainStates$l7 === void 0 ? void 0 : (_state$domainStates$l8 = _state$domainStates$l7.LiveWSAndLiveChatEngJoin) === null || _state$domainStates$l8 === void 0 ? void 0 : _state$domainStates$l8.msdyn_postconversationsurveymode);
+  TelemetryHelper.logActionEvent(LogLevel.INFO, {
+    Event: TelemetryEvent.PostChatWorkflowFromAgent,
+    Description: "PostChat Workflow was started by agent"
+  });
+  if (postChatSurveyMode === PostChatSurveyMode.Embed) {
+    await embedModePostChatWorkflow(dispatch, state);
+  } else if (postChatSurveyMode === PostChatSurveyMode.Link) {
+    linkModePostChatWorkflow(props, dispatch, setWebChatStyles);
+  } else {
+    const error = `Conversation was Ended but App State was not set correctly: msdyn_postconversationsurveymode = ${postChatSurveyMode}`;
+    TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+      Event: TelemetryEvent.AppStatesException,
+      ExceptionDetails: {
+        exception: error
+      }
+    });
+    throw new Error(error);
+  }
+};
+
+// Function will handle only postchat cases initiated by bot
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const postChatInitiatedByBot = async (props, setWebChatStyles, dispatch, state) => {
+  var _props$chatConfig5, _props$chatConfig5$Li, _state$domainStates$l9, _state$domainStates$l10;
+  const postChatSurveyMode = ((_props$chatConfig5 = props.chatConfig) === null || _props$chatConfig5 === void 0 ? void 0 : (_props$chatConfig5$Li = _props$chatConfig5.LiveWSAndLiveChatEngJoin) === null || _props$chatConfig5$Li === void 0 ? void 0 : _props$chatConfig5$Li.msdyn_postconversationsurveybotsurveymode) ?? ((_state$domainStates$l9 = state.domainStates.liveChatConfig) === null || _state$domainStates$l9 === void 0 ? void 0 : (_state$domainStates$l10 = _state$domainStates$l9.LiveWSAndLiveChatEngJoin) === null || _state$domainStates$l10 === void 0 ? void 0 : _state$domainStates$l10.msdyn_postconversationsurveybotsurveymode);
+  TelemetryHelper.logActionEvent(LogLevel.INFO, {
+    Event: TelemetryEvent.PostChatWorkflowFromBot,
+    Description: "PostChat Workflow was started by bot"
+  });
+  if (postChatSurveyMode === PostChatSurveyMode.Embed) {
+    await embedModePostChatWorkflow(dispatch, state);
+  } else if (postChatSurveyMode === PostChatSurveyMode.Link) {
+    linkModePostChatWorkflow(props, dispatch, setWebChatStyles);
+  } else {
+    const error = `Conversation was Ended but App State was not set correctly: msdyn_postconversationsurveybotsurveymode = ${postChatSurveyMode}`;
+    TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+      Event: TelemetryEvent.AppStatesException,
+      ExceptionDetails: {
+        exception: error
+      }
+    });
+    throw new Error(error);
+  }
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const getConversationDetailsCall = async chatSDK => {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  let conversationDetails = undefined;
+  try {
+    conversationDetails = await chatSDK.getConversationDetails();
+  } catch (error) {
+    TelemetryHelper.logSDKEvent(LogLevel.ERROR, {
+      Event: TelemetryEvent.GetConversationDetailsCallFailed,
+      ExceptionDetails: {
+        exception: `Get Conversation Details Call Failed : ${error}`
+      }
+    });
+    NotificationHandler.notifyError(NotificationScenarios.Connection, "Get Conversation Details Call Failed: " + error);
+  }
+  return conversationDetails;
+};
+export { setPostChatContextAndLoadSurvey, checkPostChatEnabled, initiatePostChat };

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

@@ -1,34 +1,31 @@
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function shareObservable(observable) {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  let observers = []; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  let observers = [];
 
-  let subscription; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  let subscription;
 
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   return new window.Observable(observer => {
     if (!subscription) {
       subscription = observable.subscribe({
         complete() {
           observers.forEach(observer => observer.complete());
         },
-
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         error(err) {
           observers.forEach(observer => observer.error(err));
         },
-
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         next(value) {
           observers.forEach(observer => observer.next(value));
         }
-
       });
     }
-
     observers.push(observer);
     return () => {
       observers = observers.filter(o => o !== observer);
-
       if (!observers.length) {
         subscription.unsubscribe();
         subscription = null;