@microsoft/omnichannel-chat-widget 0.1.0-main.02fa07b

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

@@ -0,0 +1,244 @@
+import { ChatSDKError } 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";
+import { NotificationScenarios } from "../../webchatcontainerstateful/webchatcontroller/enums/NotificationScenarios";
+import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
+import { TelemetryTimers } from "../../../common/telemetry/TelemetryManager";
+import { createAdapter } from "./createAdapter";
+import { createOnNewAdapterActivityHandler } from "../../../plugins/newMessageEventHandler";
+import { createTimer, getStateFromCache, isUndefinedOrEmpty } from "../../../common/utils";
+import { getReconnectIdForAuthenticatedChat, handleRedirectUnauthenticatedReconnectChat } from "./reconnectChatHelper";
+import { setPostChatContextAndLoadSurvey } from "./setPostChatContextAndLoadSurvey";
+import { updateSessionDataForTelemetry } from "./updateSessionDataForTelemetry";
+import { BroadcastService } from "@microsoft/omnichannel-chat-components"; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+let optionalParams = {}; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+const prepareStartChat = async (props, chatSDK, state, dispatch, setAdapter) => {
+  var _props$reconnectChatP;
+
+  optionalParams = {}; //Resetting to ensure no stale values
+  // Can connect to existing chat session
+
+  if (await canConnectToExistingChat(props, chatSDK, state, dispatch, setAdapter)) {
+    return;
+  } // Redirecting if unauthenticated reconnect chat expired
+
+
+  if ((_props$reconnectChatP = props.reconnectChatPaneProps) !== null && _props$reconnectChatP !== void 0 && _props$reconnectChatP.reconnectId) {
+    var _props$reconnectChatP2, _props$reconnectChatP3;
+
+    await handleRedirectUnauthenticatedReconnectChat(chatSDK, dispatch, setAdapter, initStartChat, (_props$reconnectChatP2 = props.reconnectChatPaneProps) === null || _props$reconnectChatP2 === void 0 ? void 0 : _props$reconnectChatP2.reconnectId, (_props$reconnectChatP3 = props.reconnectChatPaneProps) === null || _props$reconnectChatP3 === void 0 ? void 0 : _props$reconnectChatP3.redirectInSameWindow);
+    return;
+  } // Getting reconnectId for authenticated chat
+
+
+  const reconnectId = await getReconnectIdForAuthenticatedChat(props, chatSDK);
+
+  if (reconnectId) {
+    dispatch({
+      type: LiveChatWidgetActionType.SET_RECONNECT_ID,
+      payload: reconnectId
+    });
+    dispatch({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+      payload: ConversationState.ReconnectChat
+    });
+    return;
+  } // Set custom context params
+
+
+  setCustomContextParams(props, chatSDK); // 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);
+}; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+
+const setPreChatAndInitiateChat = async (chatSDK, dispatch, setAdapter, isProactiveChat, proactiveChatEnablePrechatState) => {
+  // 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
+    });
+    dispatch({
+      type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+      payload: ConversationState.Prechat
+    });
+    return;
+  } //Initiate start chat
+
+
+  dispatch({
+    type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+    payload: ConversationState.Loading
+  });
+  await initStartChat(chatSDK, dispatch, setAdapter);
+}; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+
+const initStartChat = async (chatSDK, dispatch, setAdapter, params, persistedState) => {
+  try {
+    var _newAdapter$activity$, _TelemetryTimers$Widg;
+
+    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 {
+      //Start widget load timer
+      TelemetryTimers.WidgetLoadTimer = createTimer();
+      TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.StartChatSDKCall
+      }); // Set optional params
+
+      optionalParams = Object.assign({}, params, optionalParams);
+      await chatSDK.startChat(optionalParams);
+      isStartChatSuccessful = true;
+    } catch (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);
+    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_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
+    }); // Set post chat context in state, no survey load
+
+    await setPostChatContextAndLoadSurvey(chatSDK, dispatch); // Updating chat session detail for telemetry
+
+    await updateSessionDataForTelemetry(chatSDK, dispatch); // Set app state to Active
+
+    if (isStartChatSuccessful) {
+      dispatch({
+        type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+        payload: ConversationState.Active
+      });
+    }
+
+    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
+    });
+  } catch (ex) {
+    TelemetryHelper.logLoadingEvent(LogLevel.ERROR, {
+      Event: TelemetryEvent.WidgetLoadFailed,
+      ExceptionDetails: {
+        Exception: `Widget load Failed: ${ex}`
+      }
+    });
+    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,
+        payload: true
+      });
+      dispatch({
+        type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+        payload: ConversationState.OutOfOffice
+      });
+    }
+  } finally {
+    optionalParams = {};
+  }
+}; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+
+const canConnectToExistingChat = async (props, chatSDK, state, dispatch, setAdapter) => {
+  var _chatSDK$omnichannelC, _chatSDK$omnichannelC2, _persistedState$domai6, _persistedState$appSt;
+
+  // By pass this function in case of popout chat
+  if (state.appStates.skipChatButtonRendering === 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); //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, dispatch, setAdapter, optionalParams, persistedState);
+    return true;
+  } else {
+    return false;
+  }
+}; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+
+const setCustomContextParams = (props, chatSDK) => {
+  var _chatSDK$omnichannelC3, _chatSDK$omnichannelC4, _props$chatConfig, _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);
+
+  if (!((_props$chatConfig = props.chatConfig) !== null && _props$chatConfig !== void 0 && _props$chatConfig.LiveChatConfigAuthSettings) && !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;
+
+    optionalParams = Object.assign({}, optionalParams, {
+      customContext: persistedState === null || persistedState === void 0 ? void 0 : (_persistedState$domai9 = persistedState.domainStates) === null || _persistedState$domai9 === void 0 ? void 0 : _persistedState$domai9.customContext
+    });
+  }
+};
+
+export { prepareStartChat, initStartChat, setPreChatAndInitiateChat };

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

@@ -0,0 +1,25 @@
+import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
+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, notificationConfig, enablePreChat, inNewWindow) => {
+  dispatch({
+    type: LiveChatWidgetActionType.SET_PROACTIVE_CHAT_PARAMS,
+    payload: {
+      proactiveChatBodyTitle: notificationConfig && notificationConfig.message ? notificationConfig.message : "",
+      proactiveChatEnablePrechat: enablePreChat ?? false,
+      proactiveChatInNewWindow: inNewWindow ?? false
+    }
+  });
+  dispatch({
+    type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+    payload: ConversationState.ProactiveChat
+  });
+  TelemetryHelper.logLoadingEvent(LogLevel.INFO, {
+    Event: TelemetryEvent.IncomingProactiveChatScreenLoaded,
+    ElapsedTimeInMilliseconds: TelemetryTimers.LcwLoadToChatButtonTimer.milliSecondsElapsed,
+    Description: "Incoming proactive chat loaded."
+  });
+};

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

@@ -0,0 +1,28 @@
+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
+
+export const updateSessionDataForTelemetry = async (chatSDK, dispatch) => {
+  if (chatSDK) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const chatSession = await chatSDK.getCurrentLiveChatContext();
+    const telemetryData = TelemetryHelper.addSessionDataToTelemetry(chatSession, TelemetryManager.InternalTelemetryData);
+    dispatch({
+      type: LiveChatWidgetActionType.SET_TELEMETRY_DATA,
+      payload: telemetryData
+    });
+    await updateConversationDataForTelemetry(chatSDK, dispatch);
+  }
+}; // 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
+    const liveWorkItem = await chatSDK.getConversationDetails();
+    const telemetryData = TelemetryHelper.addConversationDataToTelemetry(liveWorkItem, TelemetryManager.InternalTelemetryData);
+    dispatch({
+      type: LiveChatWidgetActionType.SET_TELEMETRY_DATA,
+      payload: telemetryData
+    });
+  }
+};

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

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

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

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

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

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

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

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