@microsoft/omnichannel-chat-widget 0.1.0-main.745305b → 0.1.0-main.78a2099

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

@@ -7,8 +7,8 @@ import { WebChatStoreLoader } from "../../webchatcontainerstateful/webchatcontro
 import { defaultWebChatContainerStatefulProps } from "../../webchatcontainerstateful/common/defaultProps/defaultWebChatContainerStatefulProps";
 import { PostChatSurveyMode } from "../../postchatsurveypanestateful/enums/PostChatSurveyMode";
 import { Constants } from "../../../common/Constants";
+import { getWidgetEndChatEventName } from "../../../common/utils"; // eslint-disable-next-line @typescript-eslint/no-explicit-any
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const prepareEndChat = async (props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, state) => {
   var _state$domainStates$l, _state$domainStates$l2, _state$domainStates$l3, _state$domainStates$l4;
 
@@ -19,7 +19,7 @@ const prepareEndChat = async (props, chatSDK, setAdapter, setWebChatStyles, disp
   if (isPostChatEnabled === "true" && (conversationDetails === null || conversationDetails === void 0 ? void 0 : conversationDetails.canRenderPostChat) === Constants.truePascal) {
     const skipEndChatSDK = false;
     const skipCloseChat = true;
-    await endChat(props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, skipEndChatSDK, skipCloseChat);
+    await endChat(props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, skipEndChatSDK, skipCloseChat, true);
 
     if (postChatSurveyMode === PostChatSurveyMode.Embed) {
       const loadPostChatEvent = {
@@ -33,12 +33,12 @@ const prepareEndChat = async (props, chatSDK, setAdapter, setWebChatStyles, disp
       });
     }
   } else {
-    await endChat(props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter);
+    await endChat(props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, false, false, true);
   }
 }; // eslint-disable-next-line @typescript-eslint/no-explicit-any
 
 
-const endChat = async (props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, skipEndChatSDK, skipCloseChat) => {
+const endChat = async (props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, skipEndChatSDK, skipCloseChat, postMessageToOtherTab) => {
   if (!skipEndChatSDK) {
     try {
       TelemetryHelper.logSDKEvent(LogLevel.INFO, {
@@ -61,6 +61,7 @@ const endChat = async (props, chatSDK, setAdapter, setWebChatStyles, dispatch, a
           exception: ex
         }
       });
+      postMessageToOtherTab = false;
     }
   }
 
@@ -91,8 +92,17 @@ const endChat = async (props, chatSDK, setAdapter, setWebChatStyles, dispatch, a
         payload: null
       });
       BroadcastService.postMessage({
-        eventName: BroadcastEvent.EndChat
+        eventName: BroadcastEvent.ChatEnded
       });
+
+      if (postMessageToOtherTab) {
+        var _chatSDK$omnichannelC, _chatSDK$omnichannelC2;
+
+        const endChatEventName = getWidgetEndChatEventName(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);
+        BroadcastService.postMessage({
+          eventName: endChatEventName
+        });
+      }
     } catch (error) {
       TelemetryHelper.logActionEvent(LogLevel.ERROR, {
         Event: TelemetryEvent.CloseChatMethodException,

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

@@ -26,10 +26,11 @@ import gifUploadMiddleware from "../../webchatcontainerstateful/webchatcontrolle
 import htmlPlayerMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/htmlPlayerMiddleware";
 import htmlTextMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/htmlTextMiddleware";
 import preProcessingMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/preProcessingMiddleware";
-import sanitizationMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/sanitizationMiddleware"; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+import sanitizationMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/sanitizationMiddleware";
+import { createCardActionMiddleware } from "../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/cardActionMiddleware"; // eslint-disable-next-line @typescript-eslint/no-explicit-any
 
 export const initWebChatComposer = (props, chatSDK, state, dispatch, setWebChatStyles) => {
-  var _props$webChatContain, _props$webChatContain2, _props$webChatContain3, _state$domainStates$l, _state$domainStates$l2, _state$domainStates$l3, _state$domainStates$l4, _state$domainStates$l8, _state$domainStates$l9, _props$webChatContain7, _props$webChatContain8, _state$domainStates$r, _state$domainStates$r2, _props$webChatContain9, _props$webChatContain10, _state$domainStates$r3, _state$domainStates$r4, _props$webChatContain11, _props$webChatContain12, _defaultWebChatContai, _props$webChatContain13, _props$webChatContain14, _props$webChatContain15, _props$webChatContain16, _state$domainStates$r5, _state$domainStates$r6, _props$webChatContain17, _props$webChatContain18, _defaultWebChatContai2, _props$webChatContain19, _props$webChatContain20, _defaultWebChatContai3, _props$webChatContain21;
+  var _props$webChatContain, _props$webChatContain2, _props$webChatContain3, _state$domainStates$l, _state$domainStates$l2, _state$domainStates$l3, _state$domainStates$l4, _state$domainStates$l8, _state$domainStates$l9, _props$webChatContain7, _props$webChatContain8, _state$domainStates$r, _state$domainStates$r2, _props$webChatContain9, _props$webChatContain10, _state$domainStates$r3, _state$domainStates$r4, _props$webChatContain11, _props$webChatContain12, _defaultWebChatContai, _props$webChatContain13, _props$webChatContain14, _props$webChatContain15, _props$webChatContain16, _state$domainStates$r5, _state$domainStates$r6, _props$webChatContain17, _props$webChatContain18, _defaultWebChatContai2, _props$webChatContain19, _props$webChatContain20, _defaultWebChatContai3, _props$webChatContain21, _props$webChatContain22;
 
   const localizedTexts = { ...defaultMiddlewareLocalizedTexts,
     ...((_props$webChatContain = props.webChatContainerProps) === null || _props$webChatContain === void 0 ? void 0 : _props$webChatContain.localizedTexts)
@@ -109,7 +110,8 @@ export const initWebChatComposer = (props, chatSDK, state, dispatch, setWebChatS
     groupActivitiesMiddleware: (_props$webChatContain17 = props.webChatContainerProps) !== null && _props$webChatContain17 !== void 0 && (_props$webChatContain18 = _props$webChatContain17.renderingMiddlewareProps) !== null && _props$webChatContain18 !== void 0 && _props$webChatContain18.disableGroupActivitiesMiddleware ? undefined : (_defaultWebChatContai2 = defaultWebChatContainerStatefulProps.webChatProps) === null || _defaultWebChatContai2 === void 0 ? void 0 : _defaultWebChatContai2.groupActivitiesMiddleware,
     typingIndicatorMiddleware: (_props$webChatContain19 = props.webChatContainerProps) !== null && _props$webChatContain19 !== void 0 && (_props$webChatContain20 = _props$webChatContain19.renderingMiddlewareProps) !== null && _props$webChatContain20 !== void 0 && _props$webChatContain20.disableTypingIndicatorMiddleware ? undefined : (_defaultWebChatContai3 = defaultWebChatContainerStatefulProps.webChatProps) === null || _defaultWebChatContai3 === void 0 ? void 0 : _defaultWebChatContai3.typingIndicatorMiddleware,
     onTelemetry: createWebChatTelemetry(),
-    ...((_props$webChatContain21 = props.webChatContainerProps) === null || _props$webChatContain21 === void 0 ? void 0 : _props$webChatContain21.webChatProps)
+    cardActionMiddleware: createCardActionMiddleware(((_props$webChatContain21 = props.webChatContainerProps) === null || _props$webChatContain21 === void 0 ? void 0 : _props$webChatContain21.botMagicCode) || undefined),
+    ...((_props$webChatContain22 = props.webChatContainerProps) === null || _props$webChatContain22 === void 0 ? void 0 : _props$webChatContain22.webChatProps)
   };
   return webChatProps;
 };

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

@@ -1,5 +1,5 @@
-import { ChatSDKError, Constants } from "../../../common/Constants";
-import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
+import { ChatSDKError } from "../../../common/Constants";
+import { BroadcastEvent, LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
 import { ConversationState } from "../../../contexts/common/ConversationState";
 import { DataStoreManager } from "../../../common/contextDataStore/DataStoreManager";
 import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidgetActionType";
@@ -9,10 +9,13 @@ import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
 import { TelemetryTimers } from "../../../common/telemetry/TelemetryManager";
 import { createAdapter } from "./createAdapter";
 import { createOnNewAdapterActivityHandler } from "../../../plugins/newMessageEventHandler";
-import { createTimer } from "../../../common/utils";
+import { createTimer, getWidgetCacheId } from "../../../common/utils";
 import { getReconnectIdForAuthenticatedChat, handleRedirectUnauthenticatedReconnectChat } from "./reconnectChatHelper";
 import { setPostChatContextAndLoadSurvey } from "./setPostChatContextAndLoadSurvey";
-import { updateSessionDataForTelemetry } from "./updateSessionDataForTelemetry"; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+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;
@@ -52,11 +55,13 @@ const prepareStartChat = async (props, chatSDK, state, dispatch, setAdapter) =>
         type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
         payload: ConversationState.Prechat
       });
+      setCustomContextParams(props, state);
     } else {
       dispatch({
         type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
         payload: ConversationState.Loading
       });
+      setCustomContextParams(props, state);
       await initStartChat(chatSDK, dispatch, setAdapter);
     }
   }
@@ -67,12 +72,29 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, params, persistedSta
   try {
     var _newAdapter$activity$, _TelemetryTimers$Widg;
 
+    let isStartChatSuccessful = false;
+
+    if (persistedState || params !== null && params !== void 0 && params.liveChatContext) {
+      var _persistedState$domai, _persistedState$domai2, _persistedState$domai3, _persistedState$domai4, _persistedState$domai5;
+
+      // Broadcasting limited cached chat details
+      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 {
       TelemetryTimers.WidgetLoadTimer = createTimer();
       TelemetryHelper.logSDKEvent(LogLevel.INFO, {
         Event: TelemetryEvent.StartChatSDKCall
       });
-      await chatSDK.startChat(params);
+      optionalParams = Object.assign({}, params, optionalParams);
+      await chatSDK.startChat(optionalParams);
+      isStartChatSuccessful = true;
     } catch (error) {
       TelemetryHelper.logSDKEvent(LogLevel.ERROR, {
         Event: TelemetryEvent.StartChatMethodException,
@@ -80,6 +102,7 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, params, persistedSta
           exception: `Failed to setup startChat: ${error}`
         }
       });
+      isStartChatSuccessful = false;
     }
 
     const newAdapter = await createAdapter(chatSDK);
@@ -107,10 +130,12 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, params, persistedSta
       await setPostChatContextAndLoadSurvey(chatSDK, dispatch);
       await updateSessionDataForTelemetry(chatSDK, dispatch); // Set app state to Active
 
-      dispatch({
-        type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
-        payload: ConversationState.Active
-      });
+      if (isStartChatSuccessful) {
+        dispatch({
+          type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+          payload: ConversationState.Active
+        });
+      }
     } else {
       dispatch({
         type: LiveChatWidgetActionType.SET_WIDGET_STATE,
@@ -148,20 +173,21 @@ const initStartChat = async (chatSDK, dispatch, setAdapter, params, persistedSta
 
 
 const canConnectToExistingChat = async (props, chatSDK, state, dispatch, setAdapter) => {
-  var _DataStoreManager$cli, _persistedState$domai;
+  var _chatSDK$omnichannelC, _chatSDK$omnichannelC2, _DataStoreManager$cli, _persistedState$domai6;
 
-  const widgetStateFromCache = (_DataStoreManager$cli = DataStoreManager.clientDataStore) === null || _DataStoreManager$cli === void 0 ? void 0 : _DataStoreManager$cli.getData(Constants.widgetStateDataKey, "localStorage");
+  const widgetStateEventName = getWidgetCacheId((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) ?? "");
+  const widgetStateFromCache = (_DataStoreManager$cli = DataStoreManager.clientDataStore) === null || _DataStoreManager$cli === void 0 ? void 0 : _DataStoreManager$cli.getData(widgetStateEventName, "localStorage");
   const persistedState = widgetStateFromCache ? JSON.parse(widgetStateFromCache) : undefined;
 
-  if (persistedState !== null && persistedState !== void 0 && (_persistedState$domai = persistedState.domainStates) !== null && _persistedState$domai !== void 0 && _persistedState$domai.liveChatContext) {
-    var _persistedState$domai2;
+  if (persistedState !== null && persistedState !== void 0 && (_persistedState$domai6 = persistedState.domainStates) !== null && _persistedState$domai6 !== void 0 && _persistedState$domai6.liveChatContext) {
+    var _persistedState$domai7;
 
     dispatch({
       type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
       payload: ConversationState.Loading
     });
     const optionalParams = {
-      liveChatContext: persistedState === null || persistedState === void 0 ? void 0 : (_persistedState$domai2 = persistedState.domainStates) === null || _persistedState$domai2 === void 0 ? void 0 : _persistedState$domai2.liveChatContext
+      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;
@@ -170,4 +196,15 @@ const canConnectToExistingChat = async (props, chatSDK, state, dispatch, setAdap
   }
 };
 
+const setCustomContextParams = (props, state) => {
+  var _props$chatConfig, _state$domainStates;
+
+  // Add custom context if any only for unauthenticated chat
+  if (!((_props$chatConfig = props.chatConfig) !== null && _props$chatConfig !== void 0 && _props$chatConfig.LiveChatConfigAuthSettings) && (_state$domainStates = state.domainStates) !== null && _state$domainStates !== void 0 && _state$domainStates.customContext) {
+    optionalParams = Object.assign({}, optionalParams, {
+      customContext: state.domainStates.customContext
+    });
+  }
+};
+
 export { prepareStartChat, initStartChat };

package/lib/esm/components/livechatwidget/livechatwidgetstateful/LiveChatWidgetStateful.js

@@ -4,7 +4,7 @@ import { BroadcastEvent, LogLevel, TelemetryEvent } from "../../../common/teleme
 import { BroadcastService, decodeComponentString } from "@microsoft/omnichannel-chat-components";
 import { Stack } from "@fluentui/react";
 import React, { useEffect, useRef, useState } from "react";
-import { createTimer, getLocaleDirection } from "../../../common/utils";
+import { createTimer, getLocaleDirection, getWidgetCacheId, getWidgetEndChatEventName } from "../../../common/utils";
 import { getReconnectIdForAuthenticatedChat, handleUnauthenticatedReconnectChat, startUnauthenticatedReconnectChat } from "../common/reconnectChatHelper";
 import { initStartChat, prepareStartChat } from "../common/startChat";
 import { shouldShowCallingContainer, shouldShowChatButton, shouldShowConfirmationPane, shouldShowEmailTranscriptPane, shouldShowHeader, shouldShowLoadingPane, shouldShowOutOfOfficeHoursPane, shouldShowPostChatLoadingPane, shouldShowPostChatSurveyPane, shouldShowPreChatSurveyPane, shouldShowProactiveChatPane, shouldShowReconnectChatPane, shouldShowWebChatContainer } from "../../../controller/componentController";
@@ -150,6 +150,8 @@ export const LiveChatWidgetStateful = props => {
     }
   }, [state.appStates.skipChatButtonRendering]);
   useEffect(() => {
+    var _chatSDK$omnichannelC, _chatSDK$omnichannelC2;
+
     // Add the custom context on receiving the SetCustomContext event
     BroadcastService.getMessageByEventName(BroadcastEvent.SetCustomContext).subscribe(msg => {
       TelemetryHelper.logActionEvent(LogLevel.INFO, {
@@ -161,7 +163,7 @@ export const LiveChatWidgetStateful = props => {
         payload: msg === null || msg === void 0 ? void 0 : msg.payload
       });
     });
-    BroadcastService.getMessageByEventName("StartProactiveChat").subscribe(msg => {
+    BroadcastService.getMessageByEventName(BroadcastEvent.StartProactiveChat).subscribe(msg => {
       TelemetryHelper.logActionEvent(LogLevel.INFO, {
         Event: TelemetryEvent.StartProactiveChatEventReceived,
         Description: "Start proactive chat event received."
@@ -179,7 +181,7 @@ export const LiveChatWidgetStateful = props => {
       }
     }); // start chat from SDK Event
 
-    BroadcastService.getMessageByEventName("StartChat").subscribe(() => {
+    BroadcastService.getMessageByEventName(BroadcastEvent.StartChat).subscribe(() => {
       TelemetryHelper.logActionEvent(LogLevel.INFO, {
         Event: TelemetryEvent.StartChatEventRecevied,
         Description: "Start chat event received."
@@ -195,7 +197,7 @@ export const LiveChatWidgetStateful = props => {
       }
     }); // end chat from SDK Event
 
-    BroadcastService.getMessageByEventName("EndChat").subscribe(async () => {
+    BroadcastService.getMessageByEventName(BroadcastEvent.EndChat).subscribe(async () => {
       TelemetryHelper.logActionEvent(LogLevel.INFO, {
         Event: TelemetryEvent.EndChatEventReceived,
         Description: "End chat event received."
@@ -208,6 +210,26 @@ export const LiveChatWidgetStateful = props => {
         const skipCloseChat = false;
         endChat(props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, skipEndChatSDK, skipCloseChat);
       }
+    }); // Listen to end chat event from other tabs
+
+    const endChatEventName = getWidgetEndChatEventName(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);
+    BroadcastService.getMessageByEventName(endChatEventName).subscribe(async () => {
+      endChat(props, chatSDK, setAdapter, setWebChatStyles, dispatch, adapter, false, false, false);
+    }); // Close popout window
+
+    BroadcastService.getMessageByEventName(BroadcastEvent.ClosePopoutWindow).subscribe(() => {
+      TelemetryHelper.logActionEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.ClosePopoutWindowEventRecevied,
+        Description: "Close popout window event received."
+      });
+      dispatch({
+        type: LiveChatWidgetActionType.SET_PROACTIVE_CHAT_PARAMS,
+        payload: {
+          proactiveChatBodyTitle: "",
+          proactiveChatEnablePrechat: false,
+          proactiveChatInNewWindow: false
+        }
+      });
     });
     window.addEventListener("beforeunload", () => {
       disposeTelemetryLoggers();
@@ -290,8 +312,11 @@ export const LiveChatWidgetStateful = props => {
   const confirmationPaneProps = initConfirmationPropsComposer(props); // publish chat widget state
 
   useEffect(() => {
+    var _props$chatSDK, _props$chatSDK$omnich, _props$chatSDK2, _props$chatSDK2$omnic;
+
+    const widgetStateEventName = getWidgetCacheId(props === null || props === void 0 ? void 0 : (_props$chatSDK = props.chatSDK) === null || _props$chatSDK === void 0 ? void 0 : (_props$chatSDK$omnich = _props$chatSDK.omnichannelConfig) === null || _props$chatSDK$omnich === void 0 ? void 0 : _props$chatSDK$omnich.orgId, props === null || props === void 0 ? void 0 : (_props$chatSDK2 = props.chatSDK) === null || _props$chatSDK2 === void 0 ? void 0 : (_props$chatSDK2$omnic = _props$chatSDK2.omnichannelConfig) === null || _props$chatSDK2$omnic === void 0 ? void 0 : _props$chatSDK2$omnic.widgetId);
     const chatWidgetStateChangeEvent = {
-      eventName: BroadcastEvent.ChatWidgetStateChanged,
+      eventName: widgetStateEventName,
       payload: { ...state
       }
     };

package/lib/esm/components/prechatsurveypanestateful/PreChatSurveyPaneStateful.js

@@ -1,7 +1,7 @@
-import { Constants, HtmlAttributeNames, Regex } from "../../common/Constants";
+import { HtmlAttributeNames, Regex } from "../../common/Constants";
 import { LogLevel, TelemetryEvent } from "../../common/telemetry/TelemetryConstants";
 import React, { useEffect } from "react";
-import { extractPreChatSurveyResponseValues, findAllFocusableElement, parseAdaptiveCardPayload } from "../../common/utils";
+import { extractPreChatSurveyResponseValues, findAllFocusableElement, getWidgetCacheId, parseAdaptiveCardPayload } from "../../common/utils";
 import { ConversationState } from "../../contexts/common/ConversationState";
 import { DataStoreManager } from "../../common/contextDataStore/DataStoreManager";
 import { LiveChatWidgetActionType } from "../../contexts/common/LiveChatWidgetActionType";
@@ -67,9 +67,10 @@ export const PreChatSurveyPaneStateful = props => {
       });
 
       try {
-        var _DataStoreManager$cli, _persistedState$domai;
+        var _state$domainStates, _state$domainStates$t, _state$domainStates$t2, _DataStoreManager$cli, _persistedState$domai;
 
-        const widgetStateFromCache = (_DataStoreManager$cli = DataStoreManager.clientDataStore) === null || _DataStoreManager$cli === void 0 ? void 0 : _DataStoreManager$cli.getData(Constants.widgetStateDataKey, "localStorage");
+        const widgetStateCacheId = getWidgetCacheId(((_state$domainStates = state.domainStates) === null || _state$domainStates === void 0 ? void 0 : (_state$domainStates$t = _state$domainStates.telemetryInternalData) === null || _state$domainStates$t === void 0 ? void 0 : _state$domainStates$t.orgId) ?? "", ((_state$domainStates$t2 = state.domainStates.telemetryInternalData) === null || _state$domainStates$t2 === void 0 ? void 0 : _state$domainStates$t2.widgetId) ?? "");
+        const widgetStateFromCache = (_DataStoreManager$cli = DataStoreManager.clientDataStore) === null || _DataStoreManager$cli === void 0 ? void 0 : _DataStoreManager$cli.getData(widgetStateCacheId, "localStorage");
         const persistedState = widgetStateFromCache ? JSON.parse(widgetStateFromCache) : undefined;
         let optionalParams = {};
 
@@ -83,9 +84,7 @@ export const PreChatSurveyPaneStateful = props => {
         } else {
           const prechatResponseValues = extractPreChatSurveyResponseValues(state.domainStates.preChatSurveyResponse, values);
           optionalParams = {
-            initContext: {
-              preChatResponse: prechatResponseValues
-            }
+            preChatResponse: prechatResponseValues
           };
           setPreChatResponseEmail(values);
           await initStartChat(optionalParams);

package/lib/esm/components/proactivechatpanestateful/ProactiveChatPaneStateful.js

@@ -24,6 +24,14 @@ export const ProactiveChatPaneStateful = props => {
   const handleProactiveChatInviteTimeout = () => {
     if (!timeoutRemoved) {
       setTimeoutRemoved(true);
+      dispatch({
+        type: LiveChatWidgetActionType.SET_PROACTIVE_CHAT_PARAMS,
+        payload: {
+          proactiveChatBodyTitle: "",
+          proactiveChatEnablePrechat: false,
+          proactiveChatInNewWindow: false
+        }
+      });
       dispatch({
         type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
         payload: ConversationState.Closed
@@ -81,6 +89,14 @@ export const ProactiveChatPaneStateful = props => {
         Event: TelemetryEvent.ProactiveChatClosed,
         Description: "Proactive chat closed."
       });
+      dispatch({
+        type: LiveChatWidgetActionType.SET_PROACTIVE_CHAT_PARAMS,
+        payload: {
+          proactiveChatBodyTitle: "",
+          proactiveChatEnablePrechat: false,
+          proactiveChatInNewWindow: false
+        }
+      });
       dispatch({
         type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
         payload: ConversationState.Closed

package/lib/esm/components/webchatcontainerstateful/WebChatContainerStateful.js

@@ -8,11 +8,45 @@ import { defaultMiddlewareLocalizedTexts } from "./common/defaultProps/defaultMi
 import { defaultWebChatContainerStatefulProps } from "./common/defaultProps/defaultWebChatContainerStatefulProps";
 import { setFocusOnSendBox } from "../../common/utils";
 import { useChatContextStore } from "../..";
+import { WebChatActionType } from "./webchatcontroller/enums/WebChatActionType";
+import { WebChatStoreLoader } from "./webchatcontroller/WebChatStoreLoader";
+import { Constants } from "../../common/Constants";
+import { BotMagicCodeStore } from "./webchatcontroller/BotMagicCodeStore";
+const broadcastChannelMessageEvent = "message";
+
+const postActivity = activity => {
+  // eslint-disable-line @typescript-eslint/no-explicit-any
+  return {
+    type: WebChatActionType.DIRECT_LINE_POST_ACTIVITY,
+    meta: {
+      method: "keyboard"
+    },
+    payload: {
+      activity: {
+        channelData: undefined,
+        text: "",
+        textFormat: "plain",
+        type: Constants.message,
+        ...activity
+      }
+    }
+  };
+};
+
+const createMagicCodeSuccessResponse = signin => {
+  return {
+    signin,
+    result: "Success"
+  };
+};
+
 export const WebChatContainerStateful = props => {
   const {
     BasicWebChat
   } = Components;
   const [state, dispatch] = useChatContextStore();
+  const magicCodeBroadcastChannel = new BroadcastChannel(Constants.magicCodeBroadcastChannel);
+  const magicCodeResponseBroadcastChannel = new BroadcastChannel(Constants.magicCodeResponseBroadcastChannel);
   const containerStyles = {
     root: Object.assign({}, defaultWebChatContainerStatefulProps.containerStyles, props === null || props === void 0 ? void 0 : props.containerStyles, {
       display: state.appStates.isMinimized ? "none" : ""
@@ -36,6 +70,44 @@ export const WebChatContainerStateful = props => {
       Event: TelemetryEvent.WebChatLoaded
     });
   }, []);
+  useEffect(() => {
+    const eventListener = event => {
+      // eslint-disable-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-empty-function
+      const {
+        data
+      } = event;
+
+      if (BotMagicCodeStore.botOAuthSignInId === data.signin) {
+        const {
+          signin,
+          code
+        } = data;
+        const text = `${code}`;
+        const action = postActivity({
+          text,
+          channelData: {
+            tags: [Constants.hiddenTag]
+          }
+        });
+        WebChatStoreLoader.store.dispatch(action);
+        const response = createMagicCodeSuccessResponse(signin);
+        magicCodeResponseBroadcastChannel.postMessage(response);
+        TelemetryHelper.logActionEvent(LogLevel.INFO, {
+          Event: TelemetryEvent.SuppressBotMagicCodeSucceeded
+        });
+        BotMagicCodeStore.botOAuthSignInId = "";
+        magicCodeBroadcastChannel.close();
+        magicCodeResponseBroadcastChannel.close();
+      } else {
+        TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+          Event: TelemetryEvent.SuppressBotMagicCodeFailed,
+          Description: "Signin does not match"
+        });
+      }
+    };
+
+    magicCodeBroadcastChannel.addEventListener(broadcastChannelMessageEvent, eventListener);
+  }, []);
   return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement("style", null, `
         .ms_lcw_webchat_received_message img.webchat__markdown__external-link-icon { 
             background-image : url(data:image/svg+xml;base64,PHN2ZyB2aWV3Qm94PSIzIDMgMTggMTgiICB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPjxwYXRoIGQ9Ik03LjI1MDEgNC41MDAxN0gxMC43NDk1QzExLjE2MzcgNC41MDAxNyAxMS40OTk1IDQuODM1OTYgMTEuNDk5NSA1LjI1MDE3QzExLjQ5OTUgNS42Mjk4NiAxMS4yMTczIDUuOTQzNjYgMTAuODUxMyA1Ljk5MzMyTDEwLjc0OTUgNi4wMDAxN0g3LjI0OTc0QzYuMDcwNzkgNS45OTk2MSA1LjEwMzQ5IDYuOTA2NTYgNS4wMDc4NiA4LjA2MTEyTDUuMDAwMjggOC4yMjAwM0w1LjAwMzEyIDE2Ljc1MDdDNS4wMDM0MyAxNy45NDE1IDUuOTI4ODUgMTguOTE2MSA3LjA5OTY2IDE4Ljk5NDlMNy4yNTM3MSAxOS4wMDAxTDE1Ljc1MTggMTguOTg4NEMxNi45NDE1IDE4Ljk4NjggMTcuOTE0NSAxOC4wNjIgMTcuOTkzNSAxNi44OTIzTDE3Ljk5ODcgMTYuNzM4NFYxMy4yMzIxQzE3Ljk5ODcgMTIuODE3OSAxOC4zMzQ1IDEyLjQ4MjEgMTguNzQ4NyAxMi40ODIxQzE5LjEyODQgMTIuNDgyMSAxOS40NDIyIDEyLjc2NDMgMTkuNDkxOCAxMy4xMzAzTDE5LjQ5ODcgMTMuMjMyMVYxNi43Mzg0QzE5LjQ5ODcgMTguNzQwNyAxNy45MjkzIDIwLjM3NjkgMTUuOTUyOCAyMC40ODI5TDE1Ljc1MzggMjAuNDg4NEw3LjI1ODI3IDIwLjUwMDFMNy4wNTQ5NSAyMC40OTQ5QzUuMTQyMzkgMjAuMzk1NCAzLjYwODk1IDE4Ljg2MjcgMy41MDgzNyAxNi45NTAyTDMuNTAzMTIgMTYuNzUxMUwzLjUwMDg5IDguMjUyN0wzLjUwNTI5IDguMDUwMkMzLjYwNTM5IDYuMTM3NDkgNS4xMzg2NyA0LjYwNDQ5IDcuMDUwOTYgNC41MDUyN0w3LjI1MDEgNC41MDAxN0gxMC43NDk1SDcuMjUwMVpNMTMuNzQ4MSAzLjAwMTQ2TDIwLjMwMTggMy4wMDE5N0wyMC40MDE0IDMuMDE1NzVMMjAuNTAyMiAzLjA0MzkzTDIwLjU1OSAzLjA2ODAzQzIwLjYxMjIgMy4wOTEyMiAyMC42NjM0IDMuMTIxNjMgMjAuNzExMSAzLjE1ODg1TDIwLjc4MDQgMy4yMjE1NkwyMC44NjQxIDMuMzIwMTRMMjAuOTE4MyAzLjQxMDI1TDIwLjk1NyAzLjUwMDU3TDIwLjk3NjIgMy41NjQ3NkwyMC45ODk4IDMuNjI4NjJMMjAuOTk5MiAzLjcyMjgyTDIwLjk5OTcgMTAuMjU1NEMyMC45OTk3IDEwLjY2OTYgMjAuNjYzOSAxMS4wMDU0IDIwLjI0OTcgMTEuMDA1NEMxOS44NyAxMS4wMDU0IDE5LjU1NjIgMTAuNzIzMiAxOS41MDY1IDEwLjM1NzFMMTkuNDk5NyAxMC4yNTU0TDE5LjQ5ODkgNS41NjE0N0wxMi4yNzk3IDEyLjc4NDdDMTIuMDEzNCAxMy4wNTEgMTEuNTk2OCAxMy4wNzUzIDExLjMwMzEgMTIuODU3NUwxMS4yMTkgMTIuNzg0OUMxMC45NTI3IDEyLjUxODcgMTAuOTI4NCAxMi4xMDIxIDExLjE0NjIgMTEuODA4NEwxMS4yMTg4IDExLjcyNDNMMTguNDM2OSA0LjUwMTQ2SDEzLjc0ODFDMTMuMzY4NCA0LjUwMTQ2IDEzLjA1NDYgNC4yMTkzMSAxMy4wMDUgMy44NTMyNEwxMi45OTgxIDMuNzUxNDZDMTIuOTk4MSAzLjM3MTc3IDEzLjI4MDMgMy4wNTc5NyAxMy42NDY0IDMuMDA4MzFMMTMuNzQ4MSAzLjAwMTQ2WiIgZmlsbD0iI0ZGRkZGRiIgLz48L3N2Zz4) !important;

package/lib/esm/components/webchatcontainerstateful/interfaces/IBotMagicCodeConfig.js

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

package/lib/esm/components/webchatcontainerstateful/webchatcontroller/BotMagicCodeStore.js

@@ -0,0 +1,5 @@
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+export class BotMagicCodeStore {}
+
+_defineProperty(BotMagicCodeStore, "botOAuthSignInId", "");

package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityMiddleware.js

@@ -62,7 +62,7 @@ export const createActivityMiddleware = (systemMessageStyleProps, userMessageSty
   const [card] = args;
 
   if (card.activity) {
-    var _card$activity$from, _card$activity$channe4, _card$activity$channe5;
+    var _card$activity$from;
 
     if (((_card$activity$from = card.activity.from) === null || _card$activity$from === void 0 ? void 0 : _card$activity$from.role) === DirectLineSenderRole.Channel) {
       var _card$activity$channe3;
@@ -77,8 +77,14 @@ export const createActivityMiddleware = (systemMessageStyleProps, userMessageSty
       return () => false;
     }
 
-    if ((_card$activity$channe4 = card.activity.channelData) !== null && _card$activity$channe4 !== void 0 && (_card$activity$channe5 = _card$activity$channe4.tags) !== null && _card$activity$channe5 !== void 0 && _card$activity$channe5.includes(Constants.systemMessageTag)) {
-      return handleSystemMessage(next, args, card, systemMessageStyleProps);
+    if (card.activity.channelData.tags) {
+      if (card.activity.channelData.tags.includes(Constants.hiddenTag)) {
+        return () => false;
+      }
+
+      if (card.activity.channelData.tags.includes(Constants.systemMessageTag)) {
+        return handleSystemMessage(next, args, card, systemMessageStyleProps);
+      }
     } else if (card.activity.text && card.activity.type === DirectLineActivityType.Message) {
       if (!card.activity.channelData.isHtmlEncoded && card.activity.channelId === Constants.webchatChannelId) {
         card.activity.text = escapeHtml(card.activity.text);

package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/cardActionMiddleware.js

@@ -0,0 +1,41 @@
+import { BotMagicCodeStore } from "../../BotMagicCodeStore";
+var CardActionType;
+
+(function (CardActionType) {
+  CardActionType["OpenUrl"] = "openUrl";
+  CardActionType["SignIn"] = "signin";
+})(CardActionType || (CardActionType = {}));
+
+const validCardActionTypes = [CardActionType.OpenUrl, CardActionType.SignIn];
+const botOauthUrlRegex = /[\S]+.botframework.com\/api\/oauth\/signin\?signin=([\S]+)/;
+export const createCardActionMiddleware = botMagicCodeConfig => {
+  const cardActionMiddleware = () => next => function () {
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
+    // eslint-disable-line @typescript-eslint/no-explicit-any
+    const [card] = args;
+
+    if (card.cardAction && validCardActionTypes.indexOf(card.cardAction.type) >= 0 && card.cardAction.value) {
+      // Override signin url only if fwdUrl is valid & feature is enabled
+      if ((botMagicCodeConfig === null || botMagicCodeConfig === void 0 ? void 0 : botMagicCodeConfig.disabled) === true && botMagicCodeConfig !== null && botMagicCodeConfig !== void 0 && botMagicCodeConfig.fwdUrl) {
+        const baseUrl = window.location.origin;
+        const result = botOauthUrlRegex.exec(card.cardAction.value);
+
+        if (result) {
+          BotMagicCodeStore.botOAuthSignInId = `${result[1]}`;
+        } // fwdUrl must be on the same domain as the chat widget
+
+
+        if (botMagicCodeConfig !== null && botMagicCodeConfig !== void 0 && botMagicCodeConfig.fwdUrl.startsWith(baseUrl)) {
+          card.cardAction.value += `&fwdUrl=${botMagicCodeConfig.fwdUrl}`;
+        }
+      }
+    }
+
+    return next(...args);
+  };
+
+  return cardActionMiddleware;
+};

package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/cardActionMiddleware.spec.js

@@ -0,0 +1,94 @@
+import "@testing-library/jest-dom/extend-expect";
+import { createCardActionMiddleware } from "./cardActionMiddleware";
+describe("cardActionMiddleware test", () => {
+  it("createCardActionMiddleware() with undefined botMagicCodeConfig should not change the sign in card url", () => {
+    const next = args => args; // eslint-disable-line @typescript-eslint/no-explicit-any
+
+
+    const signInUrl = "https://token.botframework.com/api/oauth/signin?signin=[signin]";
+    const args = {
+      cardAction: {
+        type: "signin",
+        value: signInUrl
+      }
+    };
+    const results = createCardActionMiddleware(undefined)()(next)(args);
+    expect(signInUrl).toEqual(results.cardAction.value);
+  });
+  it("createCardActionMiddleware() with botMagicCode enabled should not change the sign in card url", () => {
+    const botMagicCodeConfig = {
+      disabled: false
+    };
+
+    const next = args => args; // eslint-disable-line @typescript-eslint/no-explicit-any
+
+
+    const signInUrl = "https://token.botframework.com/api/oauth/signin?signin=[signin]";
+    const args = {
+      cardAction: {
+        type: "signin",
+        value: signInUrl
+      }
+    };
+    const results = createCardActionMiddleware(botMagicCodeConfig)()(next)(args);
+    expect(args.cardAction.value).toEqual(results.cardAction.value);
+  });
+  it("createCardActionMiddleware() with botMagicCode disabled & no fwdUrl should not change the sign in card url", () => {
+    const botMagicCodeConfig = {
+      disabled: true
+    };
+
+    const next = args => args; // eslint-disable-line @typescript-eslint/no-explicit-any
+
+
+    const signInUrl = "https://token.botframework.com/api/oauth/signin?signin=[signin]";
+    const args = {
+      cardAction: {
+        type: "signin",
+        value: signInUrl
+      }
+    };
+    const results = createCardActionMiddleware(botMagicCodeConfig)()(next)(args);
+    expect(args.cardAction.value).toEqual(results.cardAction.value);
+  });
+  it("createCardActionMiddleware() with botMagicCode disabled & fwdUrl should append the fwdUrl in the sign in card url", () => {
+    const botMagicCodeConfig = {
+      disabled: true,
+      fwdUrl: "http://localhost/forwarder.html"
+    };
+
+    const next = args => args; // eslint-disable-line @typescript-eslint/no-explicit-any
+
+
+    const signInUrl = "https://token.botframework.com/api/oauth/signin?signin=[signin]";
+    const args = {
+      cardAction: {
+        type: "signin",
+        value: signInUrl
+      }
+    };
+    const results = createCardActionMiddleware(botMagicCodeConfig)()(next)(args);
+    expect(signInUrl === results.cardAction.value).toBe(false);
+    expect(results.cardAction.value === `${signInUrl}&fwdUrl=${botMagicCodeConfig.fwdUrl}`).toBe(true);
+  });
+  it("createCardActionMiddleware() should not append fwdUrl if fwdUrl & sign in card url are not in the same domain", () => {
+    const botMagicCodeConfig = {
+      disabled: true,
+      fwdUrl: "https://localhost/forwarder.html"
+    };
+
+    const next = args => args; // eslint-disable-line @typescript-eslint/no-explicit-any
+
+
+    const signInUrl = "https://token.botframework.com/api/oauth/signin?signin=[signin]";
+    const args = {
+      cardAction: {
+        type: "signin",
+        value: signInUrl
+      }
+    };
+    const results = createCardActionMiddleware(botMagicCodeConfig)()(next)(args);
+    expect(signInUrl === results.cardAction.value).toBe(true);
+    expect(results.cardAction.value === `${signInUrl}&fwdUrl=${botMagicCodeConfig.fwdUrl}`).toBe(false);
+  });
+});