@microsoft/omnichannel-chat-widget 0.1.0-main.86df755 → 0.1.0-main.886e5cf

package/lib/esm/components/chatbuttonstateful/ChatButtonStateful.js

@@ -1,6 +1,6 @@
-import { LogLevel, TelemetryEvent } from "../../common/telemetry/TelemetryConstants";
-import React, { useEffect, useState } from "react";
-import { ChatButton } from "@microsoft/omnichannel-chat-components";
+import { BroadcastEvent, LogLevel, TelemetryEvent } from "../../common/telemetry/TelemetryConstants";
+import React, { useEffect, useRef, useState } from "react";
+import { BroadcastService, ChatButton } from "@microsoft/omnichannel-chat-components";
 import { Constants } from "../../common/Constants";
 import { setFocusOnElement } from "../../common/utils";
 import { ConversationState } from "../../contexts/common/ConversationState";
@@ -10,7 +10,7 @@ import { TelemetryTimers } from "../../common/telemetry/TelemetryManager";
 import { defaultOutOfOfficeChatButtonStyleProps } from "./common/styleProps/defaultOutOfOfficeChatButtonStyleProps";
 import useChatContextStore from "../../hooks/useChatContextStore";
 export const ChatButtonStateful = props => {
-  var _state$domainStates$l, _state$domainStates$l2, _buttonProps$controlP;
+  var _state$domainStates$l, _state$domainStates$l2, _buttonProps$controlP, _props$buttonProps, _props$buttonProps$co, _props$buttonProps2, _props$buttonProps2$c, _props$buttonProps3, _props$buttonProps3$c;
 
   const [state, dispatch] = useChatContextStore();
   const {
@@ -20,20 +20,26 @@ export const ChatButtonStateful = props => {
   } = props; //Setting OutOfOperatingHours Flag
 
   const [outOfOperatingHours, setOutOfOperatingHours] = useState(((_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.OutOfOperatingHours) === "True");
+  const proactiveChatInNewWindow = useRef(state.appStates.proactiveChatStates.proactiveChatInNewWindow);
   const outOfOfficeStyleProps = Object.assign({}, defaultOutOfOfficeChatButtonStyleProps, outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.styleProps);
   const controlProps = {
     id: "oc-lcw-chat-button",
     dir: state.domainStates.globalDir,
     titleText: "Let's Chat!",
     subtitleText: "We're online.",
-    hideNotificationBubble: !(state.appStates.isMinimized === true && state.appStates.unreadMessageCount > 0) || (buttonProps === null || buttonProps === void 0 ? void 0 : (_buttonProps$controlP = buttonProps.controlProps) === null || _buttonProps$controlP === void 0 ? void 0 : _buttonProps$controlP.hideNotificationBubble) === true,
-    unreadMessageCount: state.appStates.unreadMessageCount ? state.appStates.unreadMessageCount > Constants.maximumUnreadMessageCount ? Constants.maximumUnreadMessageCount.toString() + "+" : state.appStates.unreadMessageCount.toString() : "0",
+    hideNotificationBubble: (buttonProps === null || buttonProps === void 0 ? void 0 : (_buttonProps$controlP = buttonProps.controlProps) === null || _buttonProps$controlP === void 0 ? void 0 : _buttonProps$controlP.hideNotificationBubble) === true || state.appStates.isMinimized === false,
+    unreadMessageCount: state.appStates.unreadMessageCount ? state.appStates.unreadMessageCount > Constants.maximumUnreadMessageCount ? (_props$buttonProps = props.buttonProps) === null || _props$buttonProps === void 0 ? void 0 : (_props$buttonProps$co = _props$buttonProps.controlProps) === null || _props$buttonProps$co === void 0 ? void 0 : _props$buttonProps$co.largeUnreadMessageString : state.appStates.unreadMessageCount.toString() : "0",
     onClick: async () => {
       TelemetryHelper.logActionEvent(LogLevel.INFO, {
         Event: TelemetryEvent.LCWChatButtonClicked
       });
 
-      if (state.appStates.isMinimized) {
+      if (proactiveChatInNewWindow.current) {
+        const proactiveChatIsInPopoutModeEvent = {
+          eventName: BroadcastEvent.ProactiveChatIsInPopoutMode
+        };
+        BroadcastService.postMessage(proactiveChatIsInPopoutModeEvent);
+      } else if (state.appStates.isMinimized) {
         dispatch({
           type: LiveChatWidgetActionType.SET_MINIMIZED,
           payload: false
@@ -42,6 +48,7 @@ export const ChatButtonStateful = props => {
         await startChat();
       }
     },
+    unreadMessageString: (_props$buttonProps2 = props.buttonProps) === null || _props$buttonProps2 === void 0 ? void 0 : (_props$buttonProps2$c = _props$buttonProps2.controlProps) === null || _props$buttonProps2$c === void 0 ? void 0 : _props$buttonProps2$c.unreadMessageString,
     ...(buttonProps === null || buttonProps === void 0 ? void 0 : buttonProps.controlProps)
   };
   const outOfOfficeControlProps = {
@@ -50,6 +57,10 @@ export const ChatButtonStateful = props => {
     titleText: "We're Offline",
     subtitleText: "No agents available",
     onClick: async () => {
+      TelemetryHelper.logActionEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.LCWChatButtonClicked
+      });
+
       if (state.appStates.isMinimized) {
         dispatch({
           type: LiveChatWidgetActionType.SET_MINIMIZED,
@@ -62,6 +73,7 @@ export const ChatButtonStateful = props => {
         });
       }
     },
+    unreadMessageString: (_props$buttonProps3 = props.buttonProps) === null || _props$buttonProps3 === void 0 ? void 0 : (_props$buttonProps3$c = _props$buttonProps3.controlProps) === null || _props$buttonProps3$c === void 0 ? void 0 : _props$buttonProps3$c.unreadMessageString,
     ...(outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.controlProps)
   };
   useEffect(() => {
@@ -73,8 +85,19 @@ export const ChatButtonStateful = props => {
       Event: TelemetryEvent.LCWChatButtonShow,
       ElapsedTimeInMilliseconds: TelemetryTimers.LcwLoadToChatButtonTimer.milliSecondsElapsed
     });
-    setFocusOnElement(document.getElementById((controlProps === null || controlProps === void 0 ? void 0 : controlProps.id) ?? "oc-lcw-chat-button"));
+
+    if (state.uiStates.focusChatButton) {
+      setFocusOnElement(document.getElementById((controlProps === null || controlProps === void 0 ? void 0 : controlProps.id) ?? "oc-lcw-chat-button"));
+    } else {
+      dispatch({
+        type: LiveChatWidgetActionType.SET_FOCUS_CHAT_BUTTON,
+        payload: true
+      });
+    }
   }, []);
+  useEffect(() => {
+    proactiveChatInNewWindow.current = state.appStates.proactiveChatStates.proactiveChatInNewWindow;
+  }, [state.appStates.proactiveChatStates.proactiveChatInNewWindow]);
   return /*#__PURE__*/React.createElement(ChatButton, {
     componentOverrides: buttonProps === null || buttonProps === void 0 ? void 0 : buttonProps.componentOverrides,
     controlProps: outOfOperatingHours ? outOfOfficeControlProps : controlProps,

package/lib/esm/components/confirmationpanestateful/ConfirmationPaneStateful.js

@@ -1,40 +1,29 @@
 import { LogLevel, TelemetryEvent } from "../../common/telemetry/TelemetryConstants";
+import { ConfirmationPane } from "@microsoft/omnichannel-chat-components";
 import React, { useEffect } from "react";
 import { findAllFocusableElement, findParentFocusableElementsWithoutChildContainer, preventFocusToMoveOutOfElement, setFocusOnElement, setFocusOnSendBox, setTabIndices } from "../../common/utils";
-import { ConfirmationPane } from "@microsoft/omnichannel-chat-components";
-import { Constants } from "../../common/Constants";
-import { ConversationState } from "../../contexts/common/ConversationState";
 import { DimLayer } from "../dimlayer/DimLayer";
 import { LiveChatWidgetActionType } from "../../contexts/common/LiveChatWidgetActionType";
 import { NotificationHandler } from "../webchatcontainerstateful/webchatcontroller/notification/NotificationHandler";
 import { NotificationScenarios } from "../webchatcontainerstateful/webchatcontroller/enums/NotificationScenarios";
-import { PostChatSurveyMode } from "../postchatsurveypanestateful/enums/PostChatSurveyMode";
 import { TelemetryHelper } from "../../common/telemetry/TelemetryHelper";
 import useChatAdapterStore from "../../hooks/useChatAdapterStore";
-import useChatContextStore from "../../hooks/useChatContextStore";
-import useChatSDKStore from "../../hooks/useChatSDKStore"; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+import useChatContextStore from "../../hooks/useChatContextStore"; // eslint-disable-next-line @typescript-eslint/no-explicit-any
 
 export const ConfirmationPaneStateful = props => {
-  var _state$domainStates$l, _state$domainStates$l2, _state$domainStates$l3, _state$domainStates$l4;
-
   const initialTabIndexMap = new Map();
   let elements = [];
   const [state, dispatch] = useChatContextStore();
   const {
-    setPostChatContext,
-    endChat
+    prepareEndChat
   } = props; // eslint-disable-next-line @typescript-eslint/no-explicit-any
 
-  const chatSDK = useChatSDKStore(); // eslint-disable-next-line @typescript-eslint/no-explicit-any
-
   const [adapter] = useChatAdapterStore();
-  const isPostChatEnabled = (_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;
-  const postChatSurveyMode = (_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_postconversationsurveymode;
   const controlProps = {
     id: "oc-lcw-confirmation-pane",
     dir: state.domainStates.globalDir,
     onConfirm: async () => {
-      TelemetryHelper.logConfigDataEvent(LogLevel.INFO, {
+      TelemetryHelper.logActionEvent(LogLevel.INFO, {
         Event: TelemetryEvent.ConfirmationConfirmButtonClicked,
         Description: "Confirmation pane Confirm button clicked"
       });
@@ -44,40 +33,8 @@ export const ConfirmationPaneStateful = props => {
       });
 
       try {
-        //ToDo: End Chat before PostChat Context and conversation Details is set once the getPostChatContext request ID fetch issue is fixed
-        const conversationDetails = await chatSDK.getConversationDetails(); // ToDo: Replace with CanRenderPostChat once available in conversationDetails API response 
-
-        if (isPostChatEnabled === "true" && postChatSurveyMode === PostChatSurveyMode.Embed && conversationDetails.canRenderPostChat === Constants.truePascal) {
-          dispatch({
-            type: LiveChatWidgetActionType.SET_SHOULD_SHOW_POST_CHAT,
-            payload: true
-          });
-          dispatch({
-            type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
-            payload: ConversationState.Loading
-          });
-          await setPostChatContext();
-
-          if (state.domainStates.postChatContext) {
-            dispatch({
-              type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
-              payload: ConversationState.Postchat
-            });
-          }
-        } else {
-          setTabIndices(elements, initialTabIndexMap, true);
-
-          try {
-            await endChat(adapter);
-          } catch (error) {
-            TelemetryHelper.logSDKEvent(LogLevel.ERROR, {
-              Event: TelemetryEvent.CloseChatMethodException,
-              ExceptionDetails: {
-                exception: `Failed to endChat: ${error}`
-              }
-            });
-          }
-        }
+        setTabIndices(elements, initialTabIndexMap, true);
+        await prepareEndChat(adapter, state);
       } catch (ex) {
         TelemetryHelper.logSDKEvent(LogLevel.ERROR, {
           Event: TelemetryEvent.GetConversationDetailsCallFailed,
@@ -89,7 +46,7 @@ export const ConfirmationPaneStateful = props => {
       }
     },
     onCancel: () => {
-      TelemetryHelper.logConfigDataEvent(LogLevel.INFO, {
+      TelemetryHelper.logActionEvent(LogLevel.INFO, {
         Event: TelemetryEvent.ConfirmationCancelButtonClicked,
         Description: "Confirmation pane Cancel button clicked."
       });

package/lib/esm/components/emailtranscriptpanestateful/EmailTranscriptPaneStateful.js

@@ -68,8 +68,8 @@ export const EmailTranscriptPaneStateful = props => {
     },
     onCancel: () => {
       TelemetryHelper.logActionEvent(LogLevel.INFO, {
-        Event: TelemetryEvent.EmailTranscriptButtonClicked,
-        Description: "Email Transcript button clicked."
+        Event: TelemetryEvent.EmailTranscriptCancelButtonClicked,
+        Description: "Email Transcript cancel button clicked."
       });
       closeEmailTranscriptPane();
     },

package/lib/esm/components/footerstateful/FooterStateful.js

@@ -4,13 +4,13 @@ import AudioNotificationStateful from "./audionotificationstateful/AudioNotifica
 import { Constants } from "../../common/Constants";
 import { Footer } from "@microsoft/omnichannel-chat-components";
 import { LiveChatWidgetActionType } from "../../contexts/common/LiveChatWidgetActionType";
+import { NewMessageNotificationSoundBase64 } from "../../assets/Audios";
 import { NotificationHandler } from "../webchatcontainerstateful/webchatcontroller/notification/NotificationHandler";
 import { NotificationScenarios } from "../webchatcontainerstateful/webchatcontroller/enums/NotificationScenarios";
 import { TelemetryHelper } from "../../common/telemetry/TelemetryHelper";
 import { downloadTranscript } from "./downloadtranscriptstateful/DownloadTranscriptStateful";
 import useChatContextStore from "../../hooks/useChatContextStore";
-import useChatSDKStore from "../../hooks/useChatSDKStore";
-import newMessageNotification from "../../assets/audios/newMessageNotification.mp3"; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+import useChatSDKStore from "../../hooks/useChatSDKStore"; // eslint-disable-next-line @typescript-eslint/no-explicit-any
 
 export const FooterStateful = props => {
   var _footerProps$controlP3, _footerProps$controlP4;
@@ -96,9 +96,8 @@ export const FooterStateful = props => {
     controlProps: controlProps,
     styleProps: footerProps === null || footerProps === void 0 ? void 0 : footerProps.styleProps
   }), /*#__PURE__*/React.createElement(AudioNotificationStateful, {
-    audioSrc: (audioNotificationProps === null || audioNotificationProps === void 0 ? void 0 : audioNotificationProps.audioSrc) ?? newMessageNotification,
-    hideAudioNotificationButton: (footerProps === null || footerProps === void 0 ? void 0 : (_footerProps$controlP4 = footerProps.controlProps) === null || _footerProps$controlP4 === void 0 ? void 0 : _footerProps$controlP4.hideAudioNotificationButton) ?? false,
-    isAudioMuted: state.appStates.isAudioMuted ?? false
+    audioSrc: (audioNotificationProps === null || audioNotificationProps === void 0 ? void 0 : audioNotificationProps.audioSrc) ?? NewMessageNotificationSoundBase64,
+    isAudioMuted: state.appStates.isAudioMuted === null ? (footerProps === null || footerProps === void 0 ? void 0 : (_footerProps$controlP4 = footerProps.controlProps) === null || _footerProps$controlP4 === void 0 ? void 0 : _footerProps$controlP4.hideAudioNotificationButton) ?? false : state.appStates.isAudioMuted ?? false
   }));
 };
 export default FooterStateful;

package/lib/esm/components/footerstateful/downloadtranscriptstateful/DownloadTranscriptStateful.js

@@ -105,8 +105,14 @@ const beautifyChatTranscripts = (chatTranscripts, renderMarkDown, attachmentMess
     let fileAttachmentName = TranscriptConstants.DefaultFileAttachmentName;
     let dialogColor = TranscriptConstants.CustomerDialogColor;
     let fontColor = TranscriptConstants.CustomerFontColor;
-
-    if (value.tags && value.tags.toLowerCase().indexOf(Constants.systemMessageTag) !== -1 || value.isControlMessage && value.isControlMessage === true || value.contentType && value.contentType.toLowerCase() === TranscriptConstants.AdaptiveCardType || value.deliveryMode && value.deliveryMode.toLowerCase() === TranscriptConstants.InternalMode) {
+    const isSystemMessage = value.tags && value.tags.toLowerCase().indexOf(Constants.systemMessageTag) !== -1;
+    const isControlMessage = value.isControlMessage && value.isControlMessage === true;
+    const isAdaptiveCard = value.contentType && value.contentType.toLowerCase() === TranscriptConstants.AdaptiveCardType;
+    const isInternalMessage = value.deliveryMode && value.deliveryMode.toLowerCase() === TranscriptConstants.InternalMode;
+    const isHiddenMessage = value.tags && value.tags.toLowerCase().indexOf(Constants.hiddenTag.toLowerCase()) !== -1;
+    const shouldIgnoreMessage = isSystemMessage || isControlMessage || isAdaptiveCard || isInternalMessage || isHiddenMessage;
+
+    if (shouldIgnoreMessage) {
       return;
     } else if (value.from) {
       if (value.from.application) {
@@ -127,7 +133,7 @@ const beautifyChatTranscripts = (chatTranscripts, renderMarkDown, attachmentMess
 
       if (value.attachments && value.attachments.length > 0 && value.attachments[0].name) {
         fileAttachmentName = value.attachments[0].name;
-        value.content = attachmentMessage ?? "The following attachment was uploaded during the conversation:" + fileAttachmentName;
+        value.content = attachmentMessage ? attachmentMessage + " " + fileAttachmentName : "The following attachment was uploaded during the conversation: " + fileAttachmentName;
       }
     }
 

package/lib/esm/components/headerstateful/HeaderStateful.js

@@ -1,5 +1,5 @@
 import { LogLevel, TelemetryEvent } from "../../common/telemetry/TelemetryConstants";
-import React, { useEffect, useState } from "react";
+import React, { useEffect, useRef, useState } from "react";
 import { ConversationState } from "../../contexts/common/ConversationState";
 import { Header } from "@microsoft/omnichannel-chat-components";
 import { LiveChatWidgetActionType } from "../../contexts/common/LiveChatWidgetActionType";
@@ -21,6 +21,7 @@ export const HeaderStateful = props => {
 
   const [outOfOperatingHours, setOutOfOperatingHours] = useState(((_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.OutOfOperatingHours) === "True");
   const outOfOfficeStyleProps = Object.assign({}, defaultOutOfOfficeHeaderStyleProps, outOfOfficeHeaderProps === null || outOfOfficeHeaderProps === void 0 ? void 0 : outOfOfficeHeaderProps.styleProps);
+  const conversationState = useRef(state.appStates.conversationState);
   const controlProps = {
     id: "oc-lcw-header",
     dir: state.domainStates.globalDir,
@@ -40,17 +41,15 @@ export const HeaderStateful = props => {
         Description: "Header Close button clicked."
       });
 
-      if (state.appStates.conversationState === ConversationState.Active) {
+      if (conversationState.current === ConversationState.Active) {
         dispatch({
           type: LiveChatWidgetActionType.SET_SHOW_CONFIRMATION,
           payload: true
         });
-      } else if (state.appStates.conversationState === ConversationState.Postchat) {
-        dispatch({
-          type: LiveChatWidgetActionType.SET_SHOULD_SHOW_POST_CHAT,
-          payload: false
-        });
-        await endChat(adapter);
+      } else {
+        const skipEndChatSDK = true;
+        const skipCloseChat = false;
+        await endChat(adapter, skipEndChatSDK, skipCloseChat);
       }
 
       dispatch({
@@ -59,8 +58,8 @@ export const HeaderStateful = props => {
       });
     },
     ...(headerProps === null || headerProps === void 0 ? void 0 : headerProps.controlProps),
-    hideTitle: state.appStates.conversationState === ConversationState.Loading || (headerProps === null || headerProps === void 0 ? void 0 : (_headerProps$controlP = headerProps.controlProps) === null || _headerProps$controlP === void 0 ? void 0 : _headerProps$controlP.hideTitle),
-    hideIcon: state.appStates.conversationState === ConversationState.Loading || (headerProps === null || headerProps === void 0 ? void 0 : (_headerProps$controlP2 = headerProps.controlProps) === null || _headerProps$controlP2 === void 0 ? void 0 : _headerProps$controlP2.hideIcon),
+    hideTitle: state.appStates.conversationState === ConversationState.Loading || state.appStates.conversationState === ConversationState.PostchatLoading || (headerProps === null || headerProps === void 0 ? void 0 : (_headerProps$controlP = headerProps.controlProps) === null || _headerProps$controlP === void 0 ? void 0 : _headerProps$controlP.hideTitle),
+    hideIcon: state.appStates.conversationState === ConversationState.Loading || state.appStates.conversationState === ConversationState.PostchatLoading || (headerProps === null || headerProps === void 0 ? void 0 : (_headerProps$controlP2 = headerProps.controlProps) === null || _headerProps$controlP2 === void 0 ? void 0 : _headerProps$controlP2.hideIcon),
     hideCloseButton: state.appStates.conversationState === ConversationState.Loading || state.appStates.conversationState === ConversationState.Prechat || state.appStates.conversationState === ConversationState.ReconnectChat || (headerProps === null || headerProps === void 0 ? void 0 : (_headerProps$controlP3 = headerProps.controlProps) === null || _headerProps$controlP3 === void 0 ? void 0 : _headerProps$controlP3.hideCloseButton)
   };
   const outOfOfficeControlProps = {
@@ -82,7 +81,11 @@ export const HeaderStateful = props => {
     if (state.appStates.outsideOperatingHours) {
       setOutOfOperatingHours(true);
     }
-  }, []);
+
+    if (state.appStates.conversationState) {
+      conversationState.current = state.appStates.conversationState;
+    }
+  }, [state.appStates]);
   return /*#__PURE__*/React.createElement(Header, {
     componentOverrides: headerProps === null || headerProps === void 0 ? void 0 : headerProps.componentOverrides,
     controlProps: outOfOperatingHours || state.appStates.conversationState === ConversationState.OutOfOffice ? outOfOfficeControlProps : controlProps,

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

@@ -1,5 +1,4 @@
 import MarkdownIt from "markdown-it";
-import MarkdownSlack from "slack-markdown-it";
 import MarkdownItForInline from "markdown-it-for-inline";
 import { defaultMarkdownLocalizedTexts } from "../../webchatcontainerstateful/common/defaultProps/defaultMarkdownLocalizedTexts";
 import { Constants } from "../../../common/Constants"; // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -12,8 +11,9 @@ export const createMarkdown = (disableMarkdownMessageFormatting, disableNewLineM
       html: true,
       linkify: true,
       breaks: !disableNewLineMarkdownSupport
-    });
-    markdown.use(MarkdownSlack); // Markdown override for open link in new tab
+    }); // ToDo: Commenting below usage of plugin until deferred bug is resolved: https://github.com/mayashavin/markdown-it-slack/issues/1
+    // markdown.use(MarkdownSlack);
+    // Markdown override for open link in new tab
     // eslint-disable-next-line @typescript-eslint/no-explicit-any, quotes
 
     markdown.use(MarkdownItForInline, "url_new_win", "link_open", function (tokens, idx, env) {