@microsoft/omnichannel-chat-widget 1.8.2-main.e3c1d40 → 1.8.2-main.f638bed

package/README.md

@@ -101,6 +101,8 @@ A javascript sample widget can be found in this repo [here](https://github.com/m
 
 A typescript sample widget can be found [here](https://github.com/microsoft/omnichannel-chat-widget/tree/main/chat-widget/samples/typescript-sample). To build it, do ```yarn install``` then ```yarn build``` then ```yarn start``` from typescript sample project root. See [Create LiveChatWidget with Webpack5 and TypeScript](https://github.com/microsoft/omnichannel-chat-widget/blob/main/docs/BuildingUsingWebpack5.md) for additional typescript sample project resources.
 
+```react-scripts``` has deprecated to build the sample project, please refer to vite building instructions: [BuildingUsingVite.md](https://github.com/microsoft/omnichannel-chat-widget/blob/main/docs/BuildingUsingVite.md)
+
 ## Components
 
 For a detailed guide on how to customize each component with sample usages, please see our new [Developer Guide](https://github.com/microsoft/omnichannel-chat-widget/blob/main/docs/customizations/getstarted.md).
@@ -221,6 +223,51 @@ const customizedFooterProp: IFooterProps = {
 
 > :pushpin: Note that [WebChat hooks](https://github.com/microsoft/BotFramework-WebChat/blob/main/docs/HOOKS.md) can also be used in any custom components.
 
+#### Bidirectional Custom Events
+- Sending events from a hosting web page to bots/agents
+    - Register a function to post event
+        ```js
+        //define sendCustomEvent function
+        const sendCustomEvent = (payload) => {
+            const customEvent = {
+                eventName: "sendCustomEvent",
+                payload
+            };
+            BroadcastService.postMessage(customEvent);
+        };
+
+        //attach the sendCustomEvent function to window object
+        window["sendCustomEvent"] = sendCustomEvent;
+
+        //invoke the sendCustomEvent function with some customized payload
+        window.sendCustomEvent({
+            customEventName: "TestEvent",
+            customEventValue: {
+                boolVar: true,
+                displayableVar: {
+                    isDisplayable: true,
+                    value: "From C2: "+ new Date().toISOString()
+                },
+                numberVar: -10.5,
+                stringVar: "Hello from C2 str: " + new Date().toISOString()
+            }
+        })
+        ```
+    - Receiving events from bots/agents
+        ```js
+        //define setOnCustomEvent function
+        const setOnCustomEvent = (callback) => {
+            BroadcastService.getMessageByEventName("onCustomEvent").subscribe((event) => {
+                if (event && typeof callback === "function") {
+                    callback(event);
+                }
+            });
+        };
+
+        //set callback function
+        setOnCustomEvent((event) => console.log(event));
+        ```
+
 ## See Also
 
 [Customizations Dev Guide](https://github.com/microsoft/omnichannel-chat-widget/blob/main/docs/customizations/getstarted.md)\
@@ -230,4 +277,4 @@ const customizedFooterProp: IFooterProps = {
 [How to Add Visual Regression Tests](https://github.com/microsoft/omnichannel-chat-widget/blob/main/docs/VisualRegressionTestingGuide.md)\
 [Security](https://github.com/microsoft/omnichannel-chat-widget/blob/main/SECURITY.md)\
 [Third Party Cookie Support](https://github.com/microsoft/omnichannel-chat-widget/blob/main/docs/Tpc.md)\
-[Storybook](https://microsoft.github.io/omnichannel-chat-widget/docs/storybook/)
+[Storybook](https://microsoft.github.io/omnichannel-chat-widget/docs/storybook/)

package/lib/cjs/common/Constants.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.WidgetLoadTelemetryMessage = exports.WidgetLoadCustomErrorString = exports.WebChatMiddlewareConstants = exports.TranscriptConstants = exports.StorageType = exports.StartChatErrorPaneConstants = exports.Regex = exports.PrepareEndChatDescriptionConstants = exports.PostChatSurveyTelemetryMessage = exports.ParticipantType = exports.NotificationPaneConstants = exports.MimeTypes = exports.LocaleConstants = exports.LiveWorkItemState = exports.HtmlIdNames = exports.HtmlElementSelectors = exports.HtmlClassNames = exports.HtmlAttributeNames = exports.EnvironmentVersion = exports.ElementType = exports.E2VVOptions = exports.ConversationMode = exports.ConversationEndEntity = exports.Constants = exports.ConfirmationState = exports.AriaTelemetryConstants = exports.AppInsightsTelemetryMessage = exports.AMSConstants = void 0;
+exports.WidgetLoadTelemetryMessage = exports.WidgetLoadCustomErrorString = exports.WebChatMiddlewareConstants = exports.TranscriptConstants = exports.SurveyProvider = exports.StorageType = exports.StartChatErrorPaneConstants = exports.Regex = exports.PrepareEndChatDescriptionConstants = exports.PostChatSurveyTelemetryMessage = exports.ParticipantType = exports.NotificationPaneConstants = exports.MimeTypes = exports.LocaleConstants = exports.LiveWorkItemState = exports.HtmlIdNames = exports.HtmlElementSelectors = exports.HtmlClassNames = exports.HtmlAttributeNames = exports.EnvironmentVersion = exports.ElementType = exports.E2VVOptions = exports.ConversationMode = exports.ConversationEndEntity = exports.Constants = exports.ConfirmationState = exports.AriaTelemetryConstants = exports.AppInsightsTelemetryMessage = exports.AMSConstants = void 0;
 var _class;
 function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
 function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
@@ -23,6 +23,9 @@ _defineProperty(Constants, "channelMessageTag", "channel");
 _defineProperty(Constants, "historyMessageTag", "history");
 _defineProperty(Constants, "agentEndConversationMessageTag", "agentendconversation");
 _defineProperty(Constants, "supervisorForceCloseMessageTag", "supervisorforceclosedconversation");
+_defineProperty(Constants, "endConversationalSurveyMessageTag", "endconversationalsurvey");
+_defineProperty(Constants, "startConversationalSurveyMessageTag", "startconversationalsurvey");
+_defineProperty(Constants, "c2ConversationalSurveyMessageTag", "c2conversationalsurvey");
 _defineProperty(Constants, "receivedMessageClassName", "ms_lcw_webchat_received_message");
 _defineProperty(Constants, "sentMessageClassName", "ms_lcw_webchat_sent_message");
 _defineProperty(Constants, "webchatChannelId", "webchat");
@@ -112,8 +115,7 @@ _defineProperty(Constants, "TargetRelationshipAttributes", "noopener noreferrer"
 // Markdown icons
 _defineProperty(Constants, "OpenLinkIconCssClass", "webchat__render-markdown__external-link-icon");
 // internet connection test
-_defineProperty(Constants, "internetConnectionTestUrl", "https://ocsdk-prod.azureedge.net/public/connecttest.txt");
-_defineProperty(Constants, "internetConnectionTestUrlText", "Omnichannel Connect Test");
+_defineProperty(Constants, "internetConnectionTestPath", "/livechatwidget/version.txt");
 _defineProperty(Constants, "ChatWidgetStateChangedPrefix", "ChatWidgetStateChanged");
 _defineProperty(Constants, "PostChatLoadingDurationInMs", 2000);
 _defineProperty(Constants, "BrowserUnloadConfirmationMessage", "Do you want to leave chat?");
@@ -129,6 +131,12 @@ _defineProperty(Constants, "InitContextParamsResponse", "initContextParamsRespon
 _defineProperty(Constants, "OCOriginalMessageId", "OriginalMessageId");
 _defineProperty(Constants, "WebchatSequenceIdAttribute", "webchat:sequence-id");
 _defineProperty(Constants, "MessageSequenceIdOverride", "MessageSequenceIdOverride");
+_defineProperty(Constants, "sendCustomEvent", "sendCustomEvent");
+_defineProperty(Constants, "onCustomEvent", "onCustomEvent");
+_defineProperty(Constants, "customEventName", "customEventName");
+_defineProperty(Constants, "customEventValue", "customEventValue");
+_defineProperty(Constants, "Hidden", "Hidden");
+_defineProperty(Constants, "EndConversationDueToOverflow", "endconversationduetooverflow");
 const Regex = (_class = /*#__PURE__*/_createClass(function Regex() {
   _classCallCheck(this, Regex);
 }), _defineProperty(_class, "EmailRegex", "^(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"[^\"\\\\]*(?:\\\\.[^\"\\\\]*)*\")@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?)*|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\])$"), _class);
@@ -240,6 +248,11 @@ exports.ConversationMode = ConversationMode;
   ConversationMode["Regular"] = "192350000";
   ConversationMode["Persistent"] = "192350001";
 })(ConversationMode || (exports.ConversationMode = ConversationMode = {}));
+let SurveyProvider;
+exports.SurveyProvider = SurveyProvider;
+(function (SurveyProvider) {
+  SurveyProvider["MicrosoftCopilotStudio"] = "600990001";
+})(SurveyProvider || (exports.SurveyProvider = SurveyProvider = {}));
 let LiveWorkItemState;
 exports.LiveWorkItemState = LiveWorkItemState;
 (function (LiveWorkItemState) {

package/lib/cjs/common/telemetry/TelemetryConstants.js

@@ -190,6 +190,7 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["BotAuthActivityUndefinedSignInId"] = "BotAuthActivityUndefinedSignInId";
   TelemetryEvent["ThirdPartyCookiesBlocked"] = "ThirdPartyCookiesBlocked";
   TelemetryEvent["ParticipantsRemovedEvent"] = "ParticipantsRemovedEvent";
+  TelemetryEvent["QueueOverflowEvent"] = "QueueOverflowEvent";
   TelemetryEvent["ProcessingHTMLTextMiddlewareFailed"] = "ProcessingHTMLTextMiddlewareFailed";
   TelemetryEvent["ProcessingSanitizationMiddlewareFailed"] = "ProcessingSanitizationMiddlewareFailed";
   TelemetryEvent["FormatTagsMiddlewareJSONStringifyFailed"] = "FormatTagsMiddlewareJSONStringifyFailed";
@@ -228,6 +229,7 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["SystemMessageReceived"] = "SystemMessageReceived";
   TelemetryEvent["RehydrateMessageReceived"] = "RehydrateMessageReceived";
   TelemetryEvent["CustomContextReceived"] = "CustomContextReceived";
+  TelemetryEvent["CustomEventAction"] = "CustomEventAction";
   TelemetryEvent["NetworkDisconnected"] = "NetworkDisconnected";
   TelemetryEvent["NetworkReconnected"] = "NetworkReconnected";
   TelemetryEvent["LinkModePostChatWorkflowStarted"] = "LinkModePostChatWorkflowStarted";

package/lib/cjs/common/utils.js

@@ -3,9 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getConversationDetailsCall = exports.getBroadcastChannelName = exports.formatTemplateString = exports.findParentFocusableElementsWithoutChildContainer = exports.findAllFocusableElement = exports.extractPreChatSurveyResponseValues = exports.escapeHtml = exports.debounceLeading = exports.createTimer = exports.createFileAndDownload = exports.checkContactIdError = exports.changeLanguageCodeFormatForWebChat = exports.addDelayInMs = void 0;
+exports.getCustomEventValue = exports.getConversationDetailsCall = exports.getBroadcastChannelName = exports.formatTemplateString = exports.findParentFocusableElementsWithoutChildContainer = exports.findAllFocusableElement = exports.extractPreChatSurveyResponseValues = exports.escapeHtml = exports.debounceLeading = exports.createTimer = exports.createFileAndDownload = exports.checkContactIdError = exports.changeLanguageCodeFormatForWebChat = exports.addDelayInMs = void 0;
 exports.getDeviceType = getDeviceType;
-exports.setTabIndices = exports.setOcUserAgent = exports.setFocusOnSendBox = exports.setFocusOnElement = exports.preventFocusToMoveOutOfElement = exports.parseLowerCaseString = exports.parseAdaptiveCardPayload = exports.newGuid = exports.isUndefinedOrEmpty = exports.isThisSessionPopout = exports.isNullOrUndefined = exports.isNullOrEmptyString = exports.getWidgetEndChatEventName = exports.getWidgetCacheIdfromProps = exports.getWidgetCacheId = exports.getTimestampHourMinute = exports.getStateFromCache = exports.getLocaleDirection = exports.getIconText = exports.getDomain = void 0;
+exports.getWidgetEndChatEventName = exports.getWidgetCacheIdfromProps = exports.getWidgetCacheId = exports.getTimestampHourMinute = exports.getStateFromCache = exports.getLocaleDirection = exports.getIconText = exports.getDomain = void 0;
+exports.isEndConversationDueToOverflowActivity = isEndConversationDueToOverflowActivity;
+exports.setTabIndices = exports.setOcUserAgent = exports.setFocusOnSendBox = exports.setFocusOnElement = exports.preventFocusToMoveOutOfElement = exports.parseLowerCaseString = exports.parseAdaptiveCardPayload = exports.newGuid = exports.isValidCustomEvent = exports.isUndefinedOrEmpty = exports.isThisSessionPopout = exports.isNullOrUndefined = exports.isNullOrEmptyString = void 0;
 var _Constants = require("./Constants");
 var _TelemetryConstants = require("./telemetry/TelemetryConstants");
 var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components");
@@ -494,4 +496,27 @@ function getDeviceType() {
   } else {
     return "standard";
   }
+}
+
+//Bots expect a payload containing:
+//1. customEventName: this should be string describe the event name
+//2. customEventValue: given the value is from customer with unknown type, it is required to stringify the payload later
+const isValidCustomEvent = payload => {
+  if (_Constants.Constants.customEventName in payload && payload.customEventName && typeof payload.customEventName === _Constants.Constants.String && _Constants.Constants.customEventValue in payload && payload.customEventValue) return true;
+  return false;
+};
+exports.isValidCustomEvent = isValidCustomEvent;
+const getCustomEventValue = customEventPayload => {
+  let returnVal = "";
+  try {
+    returnVal = typeof customEventPayload.customEventValue === _Constants.Constants.String ? customEventPayload.customEventValue : JSON.stringify(customEventPayload.customEventValue);
+  } catch (error) {
+    console.error(error);
+  }
+  return returnVal;
+};
+exports.getCustomEventValue = getCustomEventValue;
+function isEndConversationDueToOverflowActivity(activity) {
+  var _activity$channelData, _activity$channelData2;
+  return (activity === null || activity === void 0 ? void 0 : (_activity$channelData = activity.channelData) === null || _activity$channelData === void 0 ? void 0 : _activity$channelData.tags) && Array.isArray(activity === null || activity === void 0 ? void 0 : (_activity$channelData2 = activity.channelData) === null || _activity$channelData2 === void 0 ? void 0 : _activity$channelData2.tags) && activity.channelData.tags.includes(_Constants.Constants.EndConversationDueToOverflow);
 }

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

@@ -74,7 +74,6 @@ const ChatButtonStateful = props => {
   };
   const outOfOfficeStyleProps = Object.assign({}, _defaultOutOfOfficeChatButtonStyleProps.defaultOutOfOfficeChatButtonStyleProps, outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.styleProps);
   const controlProps = {
-    ...(buttonProps === null || buttonProps === void 0 ? void 0 : buttonProps.controlProps),
     id: "oc-lcw-chat-button",
     dir: state.domainStates.globalDir,
     titleText: "Let's Chat!",
@@ -83,7 +82,8 @@ const ChatButtonStateful = props => {
     unreadMessageCount: state.appStates.unreadMessageCount ? state.appStates.unreadMessageCount > _Constants.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",
     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,
     // Regular chat button onClick - this will always take precedence
-    onClick: () => ref.current()
+    onClick: () => ref.current(),
+    ...(buttonProps === null || buttonProps === void 0 ? void 0 : buttonProps.controlProps)
   };
   const outOfOfficeControlProps = {
     // Only take specific properties from outOfOfficeButtonProps, never onClick
@@ -92,7 +92,6 @@ const ChatButtonStateful = props => {
     titleText: (outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : (_outOfOfficeButtonPro = outOfOfficeButtonProps.controlProps) === null || _outOfOfficeButtonPro === void 0 ? void 0 : _outOfOfficeButtonPro.titleText) || "We're Offline",
     subtitleText: (outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : (_outOfOfficeButtonPro2 = outOfOfficeButtonProps.controlProps) === null || _outOfOfficeButtonPro2 === void 0 ? void 0 : _outOfOfficeButtonPro2.subtitleText) || "No agents available",
     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),
     // Out-of-office specific onClick - this will ALWAYS take precedence
     onClick: () => {
       if (state.appStates.isMinimized) {
@@ -105,7 +104,8 @@ const ChatButtonStateful = props => {
         type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
         payload: _ConversationState.ConversationState.OutOfOffice
       });
-    }
+    },
+    ...(outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.controlProps)
   };
   (0, _react.useEffect)(() => {
     _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.INFO, {

package/lib/cjs/components/draggable/DraggableChatWidget.js

@@ -34,8 +34,11 @@ const DraggableChatWidget = props => {
   };
   const calculateOffsetsWithinViewport = (0, _react.useCallback)((id, offset, delta) => {
     const draggableElement = document.getElementById(id);
+    if ((0, _utils.isNullOrUndefined)(draggableElement)) {
+      return;
+    }
     const positionRelativeToViewport = draggableElement.getBoundingClientRect();
-    if ((0, _utils.isNullOrUndefined)(draggableElement) || (0, _utils.isNullOrUndefined)(positionRelativeToViewport) || (0, _utils.isNullOrUndefined)(offset.offsetLeft) || (0, _utils.isNullOrUndefined)(offset.offsetTop)) {
+    if ((0, _utils.isNullOrUndefined)(positionRelativeToViewport) || (0, _utils.isNullOrUndefined)(offset.offsetLeft) || (0, _utils.isNullOrUndefined)(offset.offsetTop)) {
       return;
     }
     let offsetLeft = offset.offsetLeft;
@@ -77,6 +80,9 @@ const DraggableChatWidget = props => {
     }
     const cacheInitialPosition = () => {
       const draggableElement = document.getElementById(props.elementId);
+      if ((0, _utils.isNullOrUndefined)(draggableElement)) {
+        return;
+      }
       const offsetLeft = draggableElement.offsetLeft;
       const offsetTop = draggableElement.offsetTop;
       setInitialPosition({
@@ -86,6 +92,9 @@ const DraggableChatWidget = props => {
     };
     const calculateOffsets = () => {
       const draggableElement = document.getElementById(props.elementId);
+      if ((0, _utils.isNullOrUndefined)(draggableElement)) {
+        return;
+      }
       const offsetLeft = draggableElement.offsetLeft;
       const offsetTop = draggableElement.offsetTop;
 
@@ -120,6 +129,9 @@ const DraggableChatWidget = props => {
       resetPosition(initialPosition);
     } else if (state.appStates.isMinimized) {
       const draggableElement = document.getElementById(props.elementId);
+      if ((0, _utils.isNullOrUndefined)(draggableElement)) {
+        return;
+      }
       const offsetLeft = draggableElement.offsetLeft;
       const offsetTop = draggableElement.offsetTop;
       if (!cachedPosition) {
@@ -144,6 +156,9 @@ const DraggableChatWidget = props => {
 
         // Update position via DOM manipulation to prevent <Stack/> continuously rendering on style change causing high CPU spike
         const draggableElement = document.getElementById(props.elementId);
+        if ((0, _utils.isNullOrUndefined)(draggableElement)) {
+          return;
+        }
         repositionElement(draggableElement, offsetLeft, offsetTop);
         setPosition({
           offsetLeft,

package/lib/cjs/components/livechatwidget/common/createInternetConnectionChangeHandler.js

@@ -13,34 +13,47 @@ var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
 var _defaultMiddlewareLocalizedTexts = require("../../webchatcontainerstateful/common/defaultProps/defaultMiddlewareLocalizedTexts");
 var _createReducer = require("../../../contexts/createReducer");
 var _LiveChatWidgetActionType = require("../../../contexts/common/LiveChatWidgetActionType");
-const isInternetConnected = async () => {
+const getRegionBasedInternetTestUrl = widgetSnippet => {
+  var _widgetSnippet$match;
+  if (!widgetSnippet) {
+    return null;
+  }
+  const widgetSnippetSourceRegex = new RegExp("src=\"(https:\\/\\/[\\w-.]+)[\\w-.\\/]+\"");
+  const baseCdnUrl = (_widgetSnippet$match = widgetSnippet.match(widgetSnippetSourceRegex)) === null || _widgetSnippet$match === void 0 ? void 0 : _widgetSnippet$match[1];
+  return baseCdnUrl ? `${baseCdnUrl}${_Constants.Constants.internetConnectionTestPath}` : null;
+};
+const isInternetConnected = async testUrl => {
   try {
-    const response = await fetch(_Constants.Constants.internetConnectionTestUrl);
-    const text = await response.text();
-    return text === _Constants.Constants.internetConnectionTestUrlText;
+    const response = await fetch(testUrl, {
+      method: "GET",
+      cache: "no-cache"
+    });
+    return response.ok;
   } catch {
     return false;
   }
 };
 const createInternetConnectionChangeHandler = async state => {
   const handler = async () => {
-    const connected = await isInternetConnected();
+    var _inMemoryState$domain, _inMemoryState$domain2;
     const inMemoryState = (0, _createReducer.executeReducer)(state, {
       type: _LiveChatWidgetActionType.LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
       payload: null
     });
+    const testUrl = getRegionBasedInternetTestUrl((_inMemoryState$domain = inMemoryState.domainStates.liveChatConfig) === null || _inMemoryState$domain === void 0 ? void 0 : (_inMemoryState$domain2 = _inMemoryState$domain.LiveWSAndLiveChatEngJoin) === null || _inMemoryState$domain2 === void 0 ? void 0 : _inMemoryState$domain2.msdyn_widgetsnippet);
+    const connected = testUrl ? await isInternetConnected(testUrl) : false;
     if (!connected) {
-      var _inMemoryState$domain, _inMemoryState$domain2;
+      var _inMemoryState$domain3, _inMemoryState$domain4;
       _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.WARN, {
         Event: _TelemetryConstants.TelemetryEvent.NetworkDisconnected
       });
-      _NotificationHandler.NotificationHandler.notifyError(_NotificationScenarios.NotificationScenarios.InternetConnection, (inMemoryState === null || inMemoryState === void 0 ? void 0 : (_inMemoryState$domain = inMemoryState.domainStates) === null || _inMemoryState$domain === void 0 ? void 0 : (_inMemoryState$domain2 = _inMemoryState$domain.middlewareLocalizedTexts) === null || _inMemoryState$domain2 === void 0 ? void 0 : _inMemoryState$domain2.MIDDLEWARE_BANNER_NO_INTERNET_CONNECTION) ?? _defaultMiddlewareLocalizedTexts.defaultMiddlewareLocalizedTexts.MIDDLEWARE_BANNER_NO_INTERNET_CONNECTION);
+      _NotificationHandler.NotificationHandler.notifyError(_NotificationScenarios.NotificationScenarios.InternetConnection, (inMemoryState === null || inMemoryState === void 0 ? void 0 : (_inMemoryState$domain3 = inMemoryState.domainStates) === null || _inMemoryState$domain3 === void 0 ? void 0 : (_inMemoryState$domain4 = _inMemoryState$domain3.middlewareLocalizedTexts) === null || _inMemoryState$domain4 === void 0 ? void 0 : _inMemoryState$domain4.MIDDLEWARE_BANNER_NO_INTERNET_CONNECTION) ?? _defaultMiddlewareLocalizedTexts.defaultMiddlewareLocalizedTexts.MIDDLEWARE_BANNER_NO_INTERNET_CONNECTION);
     } else {
-      var _inMemoryState$domain3, _inMemoryState$domain4;
+      var _inMemoryState$domain5, _inMemoryState$domain6;
       _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.WARN, {
         Event: _TelemetryConstants.TelemetryEvent.NetworkReconnected
       });
-      _NotificationHandler.NotificationHandler.notifySuccess(_NotificationScenarios.NotificationScenarios.InternetConnection, (inMemoryState === null || inMemoryState === void 0 ? void 0 : (_inMemoryState$domain3 = inMemoryState.domainStates) === null || _inMemoryState$domain3 === void 0 ? void 0 : (_inMemoryState$domain4 = _inMemoryState$domain3.middlewareLocalizedTexts) === null || _inMemoryState$domain4 === void 0 ? void 0 : _inMemoryState$domain4.MIDDLEWARE_BANNER_INTERNET_BACK_ONLINE) ?? _defaultMiddlewareLocalizedTexts.defaultMiddlewareLocalizedTexts.MIDDLEWARE_BANNER_INTERNET_BACK_ONLINE);
+      _NotificationHandler.NotificationHandler.notifySuccess(_NotificationScenarios.NotificationScenarios.InternetConnection, (inMemoryState === null || inMemoryState === void 0 ? void 0 : (_inMemoryState$domain5 = inMemoryState.domainStates) === null || _inMemoryState$domain5 === void 0 ? void 0 : (_inMemoryState$domain6 = _inMemoryState$domain5.middlewareLocalizedTexts) === null || _inMemoryState$domain6 === void 0 ? void 0 : _inMemoryState$domain6.MIDDLEWARE_BANNER_INTERNET_BACK_ONLINE) ?? _defaultMiddlewareLocalizedTexts.defaultMiddlewareLocalizedTexts.MIDDLEWARE_BANNER_INTERNET_BACK_ONLINE);
       _omnichannelChatComponents.BroadcastService.postMessage({
         eventName: _TelemetryConstants.BroadcastEvent.NetworkReconnected
       });

package/lib/cjs/components/livechatwidget/common/customEventHandler.js

@@ -0,0 +1,53 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.subscribeToSendCustomEvent = exports.customEventCallback = void 0;
+var _Constants = require("../../../common/Constants");
+var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
+var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants");
+var _utils = require("../../../common/utils");
+const customEventCallback = facadeChatSDK => event => {
+  if (!(_Constants.Constants.payload in event)) return;
+  if ((0, _utils.isValidCustomEvent)(event.payload)) {
+    const customEventPayload = event.payload;
+    try {
+      const customEventValueStr = (0, _utils.getCustomEventValue)(customEventPayload);
+      const customEventName = customEventPayload.customEventName;
+      const messageMeta = {
+        customEvent: _Constants.Constants.true,
+        customEventName: customEventName,
+        customEventValue: customEventValueStr
+      };
+      const messagePayload = {
+        content: "",
+        tags: [_Constants.Constants.Hidden],
+        metadata: messageMeta,
+        timestamp: new Date()
+      };
+      facadeChatSDK.sendMessage(messagePayload);
+      _TelemetryHelper.TelemetryHelper.logActionEventToAllTelemetry(_TelemetryConstants.LogLevel.DEBUG, {
+        Event: _TelemetryConstants.TelemetryEvent.CustomEventAction,
+        Description: "Sent customEvent.",
+        CustomProperties: {
+          customEventName,
+          lengthCustomEventValue: customEventValueStr.length
+        }
+      });
+    } catch (error) {
+      _TelemetryHelper.TelemetryHelper.logActionEventToAllTelemetry(_TelemetryConstants.LogLevel.ERROR, {
+        Event: _TelemetryConstants.TelemetryEvent.CustomEventAction,
+        Description: "Failed to process CustomEvent.",
+        ExceptionDetails: {
+          error
+        }
+      });
+    }
+  }
+};
+exports.customEventCallback = customEventCallback;
+const subscribeToSendCustomEvent = (broadcastService, facadeChatSDK, customEventCallback) => {
+  broadcastService.getMessageByEventName(_Constants.Constants.sendCustomEvent).subscribe(customEventCallback(facadeChatSDK));
+};
+exports.subscribeToSendCustomEvent = subscribeToSendCustomEvent;

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

@@ -21,7 +21,7 @@ var _omnichannelChatSdk = require("@microsoft/omnichannel-chat-sdk");
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const prepareEndChat = async (props, facadeChatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter) => {
   try {
-    var _conversationDetails$, _state$domainStates, _state$appStates3;
+    var _conversationDetails$, _state$domainStates, _state$appStates5;
     const {
       chatConfig
     } = props;
@@ -32,7 +32,7 @@ const prepareEndChat = async (props, facadeChatSDK, state, dispatch, setAdapter,
 
     // Use Case: When post chat is not configured
     if ((conversationDetails === null || conversationDetails === void 0 ? void 0 : (_conversationDetails$ = conversationDetails.canRenderPostChat) === null || _conversationDetails$ === void 0 ? void 0 : _conversationDetails$.toLowerCase()) === _Constants.Constants.false) {
-      var _state$appStates;
+      var _state$appStates, _state$appStates2, _state$appStates3;
       // If ended by customer, just close chat
       if ((state === null || state === void 0 ? void 0 : (_state$appStates = state.appStates) === null || _state$appStates === void 0 ? void 0 : _state$appStates.conversationEndedBy) === _Constants.ConversationEndEntity.Customer) {
         _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
@@ -43,6 +43,13 @@ const prepareEndChat = async (props, facadeChatSDK, state, dispatch, setAdapter,
       }
 
       // Use Case: If ended by Agent, stay chat in InActive state
+      let isConversationalSurveyEnabled = state.appStates.isConversationalSurveyEnabled;
+      if (isConversationalSurveyEnabled && ((state === null || state === void 0 ? void 0 : (_state$appStates2 = state.appStates) === null || _state$appStates2 === void 0 ? void 0 : _state$appStates2.conversationEndedBy) === _Constants.ConversationEndEntity.Agent || (state === null || state === void 0 ? void 0 : (_state$appStates3 = state.appStates) === null || _state$appStates3 === void 0 ? void 0 : _state$appStates3.conversationEndedBy) === _Constants.ConversationEndEntity.Bot)) {
+        dispatch({
+          type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+          payload: _ConversationState.ConversationState.InActive
+        });
+      }
       return;
     }
 
@@ -58,7 +65,7 @@ const prepareEndChat = async (props, facadeChatSDK, state, dispatch, setAdapter,
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const postchatContext = (await (0, _renderSurveyHelpers.getPostChatContext)(facadeChatSDK, state, dispatch)) ?? (state === null || state === void 0 ? void 0 : (_state$domainStates = state.domainStates) === null || _state$domainStates === void 0 ? void 0 : _state$domainStates.postChatContext);
     if (postchatContext === undefined) {
-      var _state$appStates2;
+      var _state$appStates4;
       _omnichannelChatComponents.BroadcastService.postMessage({
         eventName: _TelemetryConstants.BroadcastEvent.OnWidgetError,
         payload: {
@@ -67,7 +74,7 @@ const prepareEndChat = async (props, facadeChatSDK, state, dispatch, setAdapter,
       });
 
       // For Customer intiated conversations, just close chat widget
-      if ((state === null || state === void 0 ? void 0 : (_state$appStates2 = state.appStates) === null || _state$appStates2 === void 0 ? void 0 : _state$appStates2.conversationEndedBy) === _Constants.ConversationEndEntity.Customer) {
+      if ((state === null || state === void 0 ? void 0 : (_state$appStates4 = state.appStates) === null || _state$appStates4 === void 0 ? void 0 : _state$appStates4.conversationEndedBy) === _Constants.ConversationEndEntity.Customer) {
         _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
           Event: _TelemetryConstants.TelemetryEvent.PrepareEndChat,
           Description: _Constants.PrepareEndChatDescriptionConstants.ConversationEndedByCustomerWithInvalidPostChat
@@ -85,11 +92,11 @@ const prepareEndChat = async (props, facadeChatSDK, state, dispatch, setAdapter,
     }
 
     // Log PrepareEndChat if conversation ended by customer (bot and agent cases are handled in LiveChatWidgetStateful.tsx)
-    if (state !== null && state !== void 0 && (_state$appStates3 = state.appStates) !== null && _state$appStates3 !== void 0 && _state$appStates3.conversationEndedBy) {
-      var _state$appStates4;
+    if (state !== null && state !== void 0 && (_state$appStates5 = state.appStates) !== null && _state$appStates5 !== void 0 && _state$appStates5.conversationEndedBy) {
+      var _state$appStates6;
       _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
         Event: _TelemetryConstants.TelemetryEvent.PrepareEndChat,
-        Description: `${_Constants.PrepareEndChatDescriptionConstants.ConversationEndedByCustomerWithInvalidPostChat} ${state === null || state === void 0 ? void 0 : (_state$appStates4 = state.appStates) === null || _state$appStates4 === void 0 ? void 0 : _state$appStates4.conversationEndedBy}.`
+        Description: `${_Constants.PrepareEndChatDescriptionConstants.ConversationEndedByCustomerWithInvalidPostChat} ${state === null || state === void 0 ? void 0 : (_state$appStates6 = state.appStates) === null || _state$appStates6 === void 0 ? void 0 : _state$appStates6.conversationEndedBy}.`
       });
     }
     const persistentEnabled = (0, _reconnectChatHelper.isPersistentEnabled)(chatConfig);
@@ -265,6 +272,10 @@ const closeChatStateCleanUp = dispatch => {
     payload: undefined
   });
   // dispatch({ type: LiveChatWidgetActionType.SET_CONVERSATION_STATE, payload: ConversationState.Closed });
+  dispatch({
+    type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATIONAL_SURVEY_DISPLAY,
+    payload: false
+  });
   dispatch({
     type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_RECONNECT_ID,
     payload: undefined

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

@@ -37,6 +37,11 @@ var _htmlPlayerMiddleware = _interopRequireDefault(require("../../webchatcontain
 var _htmlTextMiddleware = _interopRequireDefault(require("../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/htmlTextMiddleware"));
 var _preProcessingMiddleware = _interopRequireDefault(require("../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/preProcessingMiddleware"));
 var _sanitizationMiddleware = _interopRequireDefault(require("../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/sanitizationMiddleware"));
+var _customEventMiddleware = _interopRequireDefault(require("../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/customEventMiddleware"));
+var _ConversationState = require("../../../contexts/common/ConversationState");
+var _createReducer = require("../../../contexts/createReducer");
+var _queueOverflowHandlerMiddleware = require("../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/queueOverflowHandlerMiddleware");
+var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endChat) => {
@@ -58,6 +63,20 @@ const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endChat) =>
   let webChatStore = _WebChatStoreLoader.WebChatStoreLoader.store;
   if (!webChatStore) {
     var _state$domainStates$l, _state$domainStates$l2, _state$domainStates$l3, _props$webChatContain7;
+    const addConversationalSurveyTagsCallback = action => {
+      var _inMemoryState$appSta;
+      const inMemoryState = (0, _createReducer.executeReducer)(state, {
+        type: _LiveChatWidgetActionType.LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
+        payload: null
+      });
+      const isConversationalSurvey = (_inMemoryState$appSta = inMemoryState.appStates) === null || _inMemoryState$appSta === void 0 ? void 0 : _inMemoryState$appSta.isConversationalSurvey;
+      if (isConversationalSurvey) {
+        if (!action.payload.activity.channelData.tags.includes(_Constants.Constants.c2ConversationalSurveyMessageTag)) {
+          action.payload.activity.channelData.tags.push(_Constants.Constants.c2ConversationalSurveyMessageTag);
+        }
+      }
+      return action;
+    };
     const conversationEndCallback = async () => {
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       const conversationDetails = await (0, _utils.getConversationDetailsCall)(facadeChatSDK);
@@ -87,9 +106,21 @@ const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endChat) =>
         });
       }
     };
+    const startConversationalSurveyCallback = async () => {
+      dispatch({
+        type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATIONAL_SURVEY_DISPLAY,
+        payload: true
+      });
+    };
+    const endConversationalSurveyCallback = async () => {
+      dispatch({
+        type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+        payload: _ConversationState.ConversationState.InActive
+      });
+    };
     webChatStore = (0, _botframeworkWebchat.createStore)({},
     //initial state
-    _preProcessingMiddleware.default, _attachmentProcessingMiddleware.default, (0, _attachmentUploadValidatorMiddleware.default)((_state$domainStates$l = state.domainStates.liveChatConfig) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.allowedFileExtensions, (_state$domainStates$l2 = state.domainStates.liveChatConfig) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.maxUploadFileSize, localizedTexts), _channelDataMiddleware.default, (0, _conversationEndMiddleware.default)(conversationEndCallback), (0, _dataMaskingMiddleware.default)((_state$domainStates$l3 = state.domainStates.liveChatConfig) === null || _state$domainStates$l3 === void 0 ? void 0 : _state$domainStates$l3.DataMaskingInfo), _messageTimestampMiddleware.createMessageTimeStampMiddleware, _messageSequenceIdOverrideMiddleware.createMessageSequenceIdOverrideMiddleware, _gifUploadMiddleware.default, _htmlPlayerMiddleware.default, (0, _htmlTextMiddleware.default)(honorsTargetInHTMLLinks), (0, _maxMessageSizeValidator.default)(localizedTexts), _sanitizationMiddleware.default,
+    _preProcessingMiddleware.default, _attachmentProcessingMiddleware.default, (0, _attachmentUploadValidatorMiddleware.default)((_state$domainStates$l = state.domainStates.liveChatConfig) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.allowedFileExtensions, (_state$domainStates$l2 = state.domainStates.liveChatConfig) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.maxUploadFileSize, localizedTexts), (0, _customEventMiddleware.default)(_omnichannelChatComponents.BroadcastService), (0, _queueOverflowHandlerMiddleware.createQueueOverflowMiddleware)(state, dispatch), (0, _channelDataMiddleware.default)(addConversationalSurveyTagsCallback), (0, _conversationEndMiddleware.default)(conversationEndCallback, startConversationalSurveyCallback, endConversationalSurveyCallback), (0, _dataMaskingMiddleware.default)((_state$domainStates$l3 = state.domainStates.liveChatConfig) === null || _state$domainStates$l3 === void 0 ? void 0 : _state$domainStates$l3.DataMaskingInfo), _messageTimestampMiddleware.createMessageTimeStampMiddleware, _messageSequenceIdOverrideMiddleware.createMessageSequenceIdOverrideMiddleware, _gifUploadMiddleware.default, _htmlPlayerMiddleware.default, (0, _htmlTextMiddleware.default)(honorsTargetInHTMLLinks), (0, _maxMessageSizeValidator.default)(localizedTexts), _sanitizationMiddleware.default,
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     ...(((_props$webChatContain7 = props.webChatContainerProps) === null || _props$webChatContain7 === void 0 ? void 0 : _props$webChatContain7.storeMiddlewares) ?? []));
     _WebChatStoreLoader.WebChatStoreLoader.store = webChatStore;

package/lib/cjs/components/livechatwidget/common/liveChatConfigUtils.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isPostChatSurveyEnabled = exports.isPersistentChatEnabled = void 0;
+exports.isPostChatSurveyEnabled = exports.isPersistentChatEnabled = exports.getPostChatSurveyConfig = void 0;
 var _Constants = require("../../../common/Constants");
 var _utils = require("../../../common/utils");
 const isPostChatSurveyEnabled = async facadeChatSDK => {
@@ -13,6 +13,23 @@ const isPostChatSurveyEnabled = async facadeChatSDK => {
   return postChatEnabled === "true";
 };
 exports.isPostChatSurveyEnabled = isPostChatSurveyEnabled;
+const getPostChatSurveyConfig = async facadeChatSDK => {
+  var _chatConfig$LiveWSAnd2, _chatConfig$LiveWSAnd3, _chatConfig$LiveWSAnd4, _chatConfig$LiveWSAnd5, _chatConfig$LiveWSAnd6, _chatConfig$LiveWSAnd7, _chatConfig$LiveWSAnd8, _chatConfig$LiveWSAnd9, _chatConfig$LiveWSAnd10;
+  const chatConfig = await facadeChatSDK.getLiveChatConfig();
+  const postChatEnabled = (_chatConfig$LiveWSAnd2 = chatConfig.LiveWSAndLiveChatEngJoin) === null || _chatConfig$LiveWSAnd2 === void 0 ? void 0 : _chatConfig$LiveWSAnd2.msdyn_postconversationsurveyenable.toString().toLowerCase();
+  const agentSurveyMode = (_chatConfig$LiveWSAnd3 = chatConfig.LiveWSAndLiveChatEngJoin) === null || _chatConfig$LiveWSAnd3 === void 0 ? void 0 : (_chatConfig$LiveWSAnd4 = _chatConfig$LiveWSAnd3.msdyn_postconversationsurveymode) === null || _chatConfig$LiveWSAnd4 === void 0 ? void 0 : _chatConfig$LiveWSAnd4.toString();
+  const botSurveyMode = (_chatConfig$LiveWSAnd5 = chatConfig.LiveWSAndLiveChatEngJoin) === null || _chatConfig$LiveWSAnd5 === void 0 ? void 0 : (_chatConfig$LiveWSAnd6 = _chatConfig$LiveWSAnd5.msdyn_postconversationsurveybotsurveymode) === null || _chatConfig$LiveWSAnd6 === void 0 ? void 0 : _chatConfig$LiveWSAnd6.toString();
+  const surveyProvider = (_chatConfig$LiveWSAnd7 = chatConfig.LiveWSAndLiveChatEngJoin) === null || _chatConfig$LiveWSAnd7 === void 0 ? void 0 : (_chatConfig$LiveWSAnd8 = _chatConfig$LiveWSAnd7.msdyn_surveyprovider) === null || _chatConfig$LiveWSAnd8 === void 0 ? void 0 : _chatConfig$LiveWSAnd8.toString();
+  const isConversationalSurveyEnabled = (_chatConfig$LiveWSAnd9 = chatConfig.LiveWSAndLiveChatEngJoin) === null || _chatConfig$LiveWSAnd9 === void 0 ? void 0 : (_chatConfig$LiveWSAnd10 = _chatConfig$LiveWSAnd9.msdyn_isConversationalPostChatSurveyEnabled) === null || _chatConfig$LiveWSAnd10 === void 0 ? void 0 : _chatConfig$LiveWSAnd10.toString().toLowerCase();
+  return {
+    postChatEnabled: postChatEnabled === "true",
+    agentSurveyMode: agentSurveyMode,
+    botSurveyMode: botSurveyMode,
+    surveyProvider: surveyProvider,
+    isConversationalSurveyEnabled: isConversationalSurveyEnabled === "true"
+  };
+};
+exports.getPostChatSurveyConfig = getPostChatSurveyConfig;
 const isPersistentChatEnabled = conversationMode => {
   if ((0, _utils.isNullOrUndefined)(conversationMode)) {
     return false;