@microsoft/omnichannel-chat-widget 1.8.4-main.4478bbf → 1.8.4-main.6672d3a

package/README.md

@@ -268,6 +268,33 @@ const customizedFooterProp: IFooterProps = {
         setOnCustomEvent((event) => console.log(event));
         ```
 
+#### Trigger initiateEndChat event
+Customer can trigger the initiateEndChat event via BroadcastService to end a chat session.
+When needed, the payload below could be triggered:
+```js
+const endChatEvent = {
+    eventName: "InitiateEndChat",
+    payload: {
+        skipSessionCloseForPersistentChat: true
+    } //optional payload
+};
+BroadcastService.postMessage(endChatEvent);
+```
+
+The payload of the event is optional, only needed when force closing of a persistent chat session is not required.
+When chat widget receives the event without any payload, it will:
+1. set the widget to closed state, the widget panel will be minimized. Post chat survey will not be displayed.
+2. trigger a sessionclose service network request to OmniChannel services.
+
+If skipSessionCloseForPersistentChat is set to true. The session close network request will not be triggered, instead, if postChat survey is available, post chat survey will be displayed.
+
+After successfully processed initiateEndChat event. The CloseChat event is broadcasted.
+```js
+BroadcastService.getMessageByEventName("CloseChat").subscribe(async (msg) => {
+    console.log("close chat received: ", msg);
+    //more actions to unmount component and resources
+})
+```
 ## See Also
 
 [Customizations Dev Guide](https://github.com/microsoft/omnichannel-chat-widget/blob/main/docs/customizations/getstarted.md)\

package/lib/cjs/common/Constants.js

@@ -143,6 +143,7 @@ _defineProperty(Constants, "customEventName", "customEventName");
 _defineProperty(Constants, "customEventValue", "customEventValue");
 _defineProperty(Constants, "Hidden", "Hidden");
 _defineProperty(Constants, "EndConversationDueToOverflow", "endconversationduetooverflow");
+_defineProperty(Constants, "SkipSessionCloseForPersistentChatFlag", "skipSessionCloseForPersistentChat");
 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);
@@ -378,6 +379,7 @@ _defineProperty(PrepareEndChatDescriptionConstants, "ConversationEndedBy", "Conv
 _defineProperty(PrepareEndChatDescriptionConstants, "PrepareEndChatError", "There's an error while preparing to end chat. Closing chat widget.");
 _defineProperty(PrepareEndChatDescriptionConstants, "WidgetLoadFailedAfterSessionInit", "SessionInit was successful, but widget load failed. Ending chat to avoid ghost chats in OC.");
 _defineProperty(PrepareEndChatDescriptionConstants, "InitiateEndChatReceived", "Received InitiateEndChat BroadcastEvent while conversation state is not Active. Ending chat.");
+_defineProperty(PrepareEndChatDescriptionConstants, "InitiateEndChatReceivedActiveChat", "Received InitiateEndChat BroadcastEvent while conversation state is Active. Updating conversation states.");
 _defineProperty(PrepareEndChatDescriptionConstants, "EndChatReceivedFromOtherTabs", "Received EndChat BroadcastEvent from other tabs. Closing this chat.");
 _defineProperty(PrepareEndChatDescriptionConstants, "CustomerCloseChatOnFailureOrPostChat", "Customer is trying to close chat widget on start chat failure or post chat pane.");
 _defineProperty(PrepareEndChatDescriptionConstants, "CustomerCloseInactiveChat", "Chat was Inactive and customer is trying to close chat widget or refreshing the page.");

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

@@ -6,8 +6,11 @@ Object.defineProperty(exports, "__esModule", {
 exports.AppInsightsEventMapping = void 0;
 const AppInsightsEventMapping = {
   "LCWChatButtonClicked": "LCWChatButtonActionStarted",
-  "PrechatSubmitted": "PrechatSubmitCompleted",
-  "StartChatEventRecevied": "StartChatEventReceivedCompleted",
+  "UXLCWChatButtonLoadingStart": "LiveChatWidgetChatButtonLoadingStarted",
+  "UXLCWChatButtonLoadingCompleted": "LiveChatWidgetChatButtonLoadingCompleted",
+  "UXPrechatPaneStart": "PrechatSurveyStarted",
+  "UXPrechatPaneCompleted": "PrechatSurveyCompleted",
+  "PrechatSubmitted": "PrechatSurveySubmitCompleted",
   "EndChatEventReceived": "EndChatEventReceivedCompleted",
   "EmailTranscriptSent": "EmailTranscriptActionCompleted",
   "EmailTranscriptFailed": "EmailTranscriptActionFailed",
@@ -15,8 +18,6 @@ const AppInsightsEventMapping = {
   "HeaderMinimizeButtonClicked": "MinimizeChatActionStarted",
   "DownloadTranscriptButtonClicked": "DownloadTranscriptActionStarted",
   "EmailTranscriptButtonClicked": "EmailTranscriptButtonActionStarted",
-  "CustomerVoiceFormResponseSubmitted": "CustomerVoiceFormResponseSubmitCompleted",
-  "StartProactiveChatEventReceived": "StartProactiveChatEventReceivedCompleted",
   "ProactiveChatRejected": "ProactiveChatTimeOutCompleted",
   "MessageSent": "MessageSentCompleted",
   "MessageReceived": "MessageReceivedCompleted",
@@ -25,6 +26,11 @@ const AppInsightsEventMapping = {
   "CustomContextReceived": "CustomContextReceivedCompleted",
   "NewTokenValidationStarted": "AuthTokenValidationStarted",
   "NewTokenValidationCompleted": "AuthTokenValidationCompleted",
-  "NewTokenValidationFailed": "AuthTokenValidationFailed"
+  "NewTokenValidationFailed": "AuthTokenValidationFailed",
+  "UXPostChatPaneStarted": "PostChatSurveyStarted",
+  "UXPostChatPaneCompleted": "PostChatSurveyCompleted",
+  "WidgetLoadStarted": "ChatSessionInitializationStarted",
+  "WidgetLoadComplete": "ChatSessionInitializationCompleted",
+  "WidgetLoadFailed": "ChatSessionInitializationFailed"
 };
 exports.AppInsightsEventMapping = AppInsightsEventMapping;

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

@@ -124,6 +124,7 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["EndChatFailed"] = "EndChatFailed";
   TelemetryEvent["SettingCustomContext"] = "SettingCustomContext";
   TelemetryEvent["WebChatLoaded"] = "WebChatLoaded";
+  TelemetryEvent["PersistentChatHistoryEnabled"] = "PersistentChatHistoryEnabled";
   TelemetryEvent["LCWChatButtonActionCompleted"] = "LCWChatButtonActionCompleted";
   TelemetryEvent["LCWChatButtonClicked"] = "LCWChatButtonClicked";
   TelemetryEvent["LCWChatButtonShow"] = "LCWChatButtonShow";
@@ -305,6 +306,7 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["LCWPersistentConversationHandlerInitialized"] = "LCWPersistentConversationHandlerInitialized";
   TelemetryEvent["LCWPersistentHistoryPullBlocked"] = "LCWPersistentHistoryPullBlocked";
   TelemetryEvent["LCWPersistentHistoryPullCompleted"] = "LCWPersistentHistoryPullCompleted";
+  TelemetryEvent["LCWPersistentHistoryReturnedNull"] = "LCWPersistentHistoryReturnedNull";
   TelemetryEvent["LCWLazyLoadInitializationStarted"] = "LCWLazyLoadInitializationStarted";
   TelemetryEvent["LCWLazyLoadContainerNotFound"] = "LCWLazyLoadContainerNotFound";
   TelemetryEvent["LCWLazyLoadInitializationCompleted"] = "LCWLazyLoadInitializationCompleted";
@@ -314,6 +316,7 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["LCWLazyLoadActivityMounted"] = "LCWLazyLoadActivityMounted";
   TelemetryEvent["LCWLazyLoadReset"] = "LCWLazyLoadReset";
   TelemetryEvent["LCWLazyLoadNoMoreHistory"] = "LCWLazyLoadNoMoreHistory";
+  TelemetryEvent["LCWLazyLoadHistoryError"] = "LCWLazyLoadHistoryError";
   TelemetryEvent["LCWLazyLoadDestroyed"] = "LCWLazyLoadDestroyed";
   TelemetryEvent["SecureEventBusUnauthorizedDispatch"] = "SecureEventBusUnauthorizedDispatch";
   TelemetryEvent["SecureEventBusListenerError"] = "SecureEventBusListenerError";

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

@@ -50,7 +50,7 @@ const RegisterLoggers = () => {
       loggers.push((0, _consoleLogger.consoleLogger)());
     }
     if (((_TelemetryManager$Int9 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int9 === void 0 ? void 0 : (_TelemetryManager$Int10 = _TelemetryManager$Int9.telemetryConfig) === null || _TelemetryManager$Int10 === void 0 ? void 0 : _TelemetryManager$Int10.telemetryDisabled) === false) {
-      var _TelemetryManager$Int11, _TelemetryManager$Int20, _TelemetryManager$Int21, _TelemetryManager$Int22, _TelemetryManager$Int23;
+      var _TelemetryManager$Int11, _TelemetryManager$Int20, _TelemetryManager$Int21, _TelemetryManager$Int22, _TelemetryManager$Int23, _TelemetryManager$Int24, _TelemetryManager$Int25, _TelemetryManager$Int26;
       if ((_TelemetryManager$Int11 = TelemetryManager.InternalTelemetryData) !== null && _TelemetryManager$Int11 !== void 0 && _TelemetryManager$Int11.ariaConfig) {
         var _TelemetryManager$Int12, _TelemetryManager$Int13, _TelemetryManager$Int14, _TelemetryManager$Int15, _TelemetryManager$Int16, _TelemetryManager$Int17, _TelemetryManager$Int18, _TelemetryManager$Int19;
         loggers.push((0, _ariaTelemetryLogger.ariaTelemetryLogger)(((_TelemetryManager$Int12 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int12 === void 0 ? void 0 : (_TelemetryManager$Int13 = _TelemetryManager$Int12.ariaConfig) === null || _TelemetryManager$Int13 === void 0 ? void 0 : _TelemetryManager$Int13.ariaTelemetryKey) ?? _defaultAriaConfig.defaultAriaConfig.ariaTelemetryKey, ((_TelemetryManager$Int14 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int14 === void 0 ? void 0 : (_TelemetryManager$Int15 = _TelemetryManager$Int14.ariaConfig) === null || _TelemetryManager$Int15 === void 0 ? void 0 : _TelemetryManager$Int15.disableCookieUsage) ?? _defaultAriaConfig.defaultAriaConfig.disableCookieUsage, ((_TelemetryManager$Int16 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int16 === void 0 ? void 0 : (_TelemetryManager$Int17 = _TelemetryManager$Int16.ariaConfig) === null || _TelemetryManager$Int17 === void 0 ? void 0 : _TelemetryManager$Int17.collectorUriForTelemetry) ?? _defaultAriaConfig.defaultAriaConfig.collectorUriForTelemetry, ((_TelemetryManager$Int18 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int18 === void 0 ? void 0 : (_TelemetryManager$Int19 = _TelemetryManager$Int18.ariaConfig) === null || _TelemetryManager$Int19 === void 0 ? void 0 : _TelemetryManager$Int19.ariaTelemetryApplicationName) ?? _defaultAriaConfig.defaultAriaConfig.ariaTelemetryApplicationName));
@@ -61,12 +61,15 @@ const RegisterLoggers = () => {
           loggers.push(logger);
         });
       }
-      if (((_TelemetryManager$Int22 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int22 === void 0 ? void 0 : (_TelemetryManager$Int23 = _TelemetryManager$Int22.appInsightsConfig) === null || _TelemetryManager$Int23 === void 0 ? void 0 : _TelemetryManager$Int23.appInsightsDisabled) === false) {
-        var _TelemetryManager$Int24;
-        if ((_TelemetryManager$Int24 = TelemetryManager.InternalTelemetryData) !== null && _TelemetryManager$Int24 !== void 0 && _TelemetryManager$Int24.appInsightsConfig.appInsightsKey) {
-          var _TelemetryManager$Int25;
-          loggers.push((0, _appInsightsLogger.appInsightsLogger)((_TelemetryManager$Int25 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int25 === void 0 ? void 0 : _TelemetryManager$Int25.appInsightsConfig.appInsightsKey));
-        }
+      const chatConfigAppInsightsKey = (_TelemetryManager$Int22 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int22 === void 0 ? void 0 : _TelemetryManager$Int22.chatConfigAppInsightsKey;
+      const appInsightsKeyFromUser = (_TelemetryManager$Int23 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int23 === void 0 ? void 0 : (_TelemetryManager$Int24 = _TelemetryManager$Int23.appInsightsConfig) === null || _TelemetryManager$Int24 === void 0 ? void 0 : _TelemetryManager$Int24.appInsightsKey;
+      // when chatConfig has AppInsightsInstrumentationKey
+      if (chatConfigAppInsightsKey) {
+        loggers.push((0, _appInsightsLogger.appInsightsLogger)(chatConfigAppInsightsKey));
+      }
+      // when key set through appInsightsConfig
+      else if (appInsightsKeyFromUser && ((_TelemetryManager$Int25 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int25 === void 0 ? void 0 : (_TelemetryManager$Int26 = _TelemetryManager$Int25.appInsightsConfig) === null || _TelemetryManager$Int26 === void 0 ? void 0 : _TelemetryManager$Int26.appInsightsDisabled) === false) {
+        loggers.push((0, _appInsightsLogger.appInsightsLogger)(appInsightsKeyFromUser));
       }
     }
   };

package/lib/cjs/components/citationpanestateful/CitationPaneStateful.js

@@ -42,7 +42,7 @@ const CitationPaneStateful = props => {
   const [paneStyle, setPaneStyle] = (0, _react.useState)(null);
   const [isReady, setIsReady] = (0, _react.useState)(false);
 
-  // Move focus to the container
+  // Initial focus pattern (mirrors ConfirmationPaneStateful): focus first focusable element (will re-attempt after visibility becomes true)
   (0, _react.useEffect)(() => {
     (0, _utils.preventFocusToMoveOutOfElement)(controlId);
     const focusableElements = (0, _utils.findAllFocusableElement)(`#${controlId}`);
@@ -64,6 +64,25 @@ const CitationPaneStateful = props => {
     });
   }, []);
 
+  // Retry focus once pane is actually visible (isReady) in case initial attempt occurred while wrapper was visibility:hidden
+  (0, _react.useEffect)(() => {
+    if (!isReady) return;
+    const focusableElements = (0, _utils.findAllFocusableElement)(`#${controlId}`);
+    if (focusableElements && focusableElements.length > 0) {
+      const first = focusableElements[0];
+      // If focused element is not already inside the pane, move focus
+      if (!first.contains(document.activeElement) && !(document.activeElement && document.activeElement.id.startsWith(controlId))) {
+        requestAnimationFrame(() => {
+          if (first.isConnected) {
+            first.focus({
+              preventScroll: true
+            });
+          }
+        });
+      }
+    }
+  }, [isReady, controlId]);
+
   // Compute the widget bounds and set pane style accordingly (95% of widget size
   // and centered inside the widget). If the widget container can't be found,
   // fall back to the default pane styles from defaultCitationPaneProps.

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

@@ -9,7 +9,7 @@ var ChatWidgetEvents;
   ChatWidgetEvents["ADD_ACTIVITY"] = "CHAT_WIDGET/ADD_ACTIVITY";
   ChatWidgetEvents["FETCH_PERSISTENT_CHAT_HISTORY"] = "CHAT_WIDGET/FETCH_PERSISTENT_CHAT_HISTORY";
   ChatWidgetEvents["NO_MORE_HISTORY_AVAILABLE"] = "CHAT_WIDGET/NO_MORE_HISTORY_AVAILABLE";
-  ChatWidgetEvents["HIDE_LOADING_BANNER"] = "CHAT_WIDGET/HIDE_LOADING_BANNER";
+  ChatWidgetEvents["HISTORY_LOAD_ERROR"] = "CHAT_WIDGET/HISTORY_LOAD_ERROR";
 })(ChatWidgetEvents || (ChatWidgetEvents = {}));
 var _default = ChatWidgetEvents;
 exports.default = _default;

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

@@ -36,7 +36,7 @@ let PersistentConversationHandler = /*#__PURE__*/function () {
     _defineProperty(this, "facadeChatSDK", void 0);
     _defineProperty(this, "lastMessage", null);
     _defineProperty(this, "count", 0);
-    _defineProperty(this, "pageSize", 4);
+    _defineProperty(this, "pageSize", _defaultPersistentChatHistoryProps.defaultPersistentChatHistoryProps.pageSize);
     _defineProperty(this, "isCurrentlyPulling", false);
     _defineProperty(this, "pageTokenInTransitSet", new Set());
     _defineProperty(this, "resetEventListener", _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.BroadcastEvent.PersistentConversationReset).subscribe(() => {
@@ -48,18 +48,21 @@ let PersistentConversationHandler = /*#__PURE__*/function () {
       Event: _TelemetryConstants.TelemetryEvent.LCWPersistentConversationHandlerInitialized,
       Description: "PersistentConversationHandler initialized",
       CustomProperties: {
-        pageSize: this.pageSize
+        pageSize: _defaultPersistentChatHistoryProps.defaultPersistentChatHistoryProps.pageSize
       }
     });
   }
   _createClass(PersistentConversationHandler, [{
     key: "appliedPropsHandler",
     value: function appliedPropsHandler(props) {
+      var _this$appliedProps;
       this.appliedProps = {
         ..._defaultPersistentChatHistoryProps.defaultPersistentChatHistoryProps,
         ...props
       };
-      this.pageSize = this.appliedProps.pageSize || 4;
+
+      // if the props is not existent or is not a number then default to defaultPersistentChatHistoryProps.pageSize
+      this.pageSize = ((_this$appliedProps = this.appliedProps) === null || _this$appliedProps === void 0 ? void 0 : _this$appliedProps.pageSize) !== undefined && !isNaN(this.appliedProps.pageSize) ? this.appliedProps.pageSize : _defaultPersistentChatHistoryProps.defaultPersistentChatHistoryProps.pageSize;
     }
   }, {
     key: "reset",
@@ -104,12 +107,23 @@ let PersistentConversationHandler = /*#__PURE__*/function () {
       try {
         var _ref;
         const messages = await this.fetchHistoryMessages();
-        if (messages === null || (messages === null || messages === void 0 ? void 0 : messages.length) === 0) {
+
+        // Handle error case - null indicates an error occurred
+        // Don't mark as last pull to allow retry on next attempt
+        if (messages == null) {
+          _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.WARN, {
+            Event: _TelemetryConstants.TelemetryEvent.LCWPersistentHistoryReturnedNull,
+            Description: "History pull returned null - Possible error occurred, will retry on next scroll",
+            ElapsedTimeInMilliseconds: pullTimer.milliSecondsElapsed
+          });
+          return;
+        }
+
+        // Handle legitimate end of history - empty array
+        if (messages.length === 0) {
           this.isLastPull = true;
           // Dispatch event to notify UI that no more history is available
           (0, _dispatchCustomEvent.default)(_ChatWidgetEvents.default.NO_MORE_HISTORY_AVAILABLE);
-          // Also hide the loading banner
-          (0, _dispatchCustomEvent.default)(_ChatWidgetEvents.default.HIDE_LOADING_BANNER);
           _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
             Event: _TelemetryConstants.TelemetryEvent.LCWPersistentHistoryPullCompleted,
             Description: "History pull completed - no more messages",
@@ -119,9 +133,6 @@ let PersistentConversationHandler = /*#__PURE__*/function () {
         }
         const messagesDescOrder = (_ref = [...messages]) === null || _ref === void 0 ? void 0 : _ref.reverse();
         this.processHistoryMessages(messagesDescOrder);
-
-        // Dispatch event to hide the loading banner after messages are processed
-        (0, _dispatchCustomEvent.default)(_ChatWidgetEvents.default.HIDE_LOADING_BANNER);
         _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
           Event: _TelemetryConstants.TelemetryEvent.LCWPersistentHistoryPullCompleted,
           Description: "History pull completed successfully",
@@ -177,7 +188,6 @@ let PersistentConversationHandler = /*#__PURE__*/function () {
       if (!this.shouldPull()) {
         // Dispatch event to ensure banner is hidden when no more pulls are needed
         (0, _dispatchCustomEvent.default)(_ChatWidgetEvents.default.NO_MORE_HISTORY_AVAILABLE);
-        (0, _dispatchCustomEvent.default)(_ChatWidgetEvents.default.HIDE_LOADING_BANNER);
         return [];
       }
       const options = {
@@ -203,24 +213,20 @@ let PersistentConversationHandler = /*#__PURE__*/function () {
           this.isLastPull = true;
           // Dispatch event when we reach the end of available history
           (0, _dispatchCustomEvent.default)(_ChatWidgetEvents.default.NO_MORE_HISTORY_AVAILABLE);
-          // Also hide the loading banner
-          (0, _dispatchCustomEvent.default)(_ChatWidgetEvents.default.HIDE_LOADING_BANNER);
           return [];
         }
-        (0, _dispatchCustomEvent.default)(_ChatWidgetEvents.default.HIDE_LOADING_BANNER);
         return messages;
       } catch (error) {
         _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.ERROR, {
           Event: _TelemetryConstants.TelemetryEvent.FetchPersistentChatHistoryFailed,
           ExceptionDetails: error
         });
-        this.isLastPull = true;
-        this.pageToken = null;
-        // Dispatch event when there's an error to stop loading banner
-        (0, _dispatchCustomEvent.default)(_ChatWidgetEvents.default.NO_MORE_HISTORY_AVAILABLE);
-        // Also hide the loading banner
-        (0, _dispatchCustomEvent.default)(_ChatWidgetEvents.default.HIDE_LOADING_BANNER);
-        return [];
+
+        // On error, dispatch HISTORY_LOAD_ERROR to hide loading banner without marking conversation as ended
+        // This allows recovery on the next attempt (e.g., transient network errors)
+        // Return null to distinguish error from legitimate empty history
+        (0, _dispatchCustomEvent.default)(_ChatWidgetEvents.default.HISTORY_LOAD_ERROR);
+        return null;
       }
     }
   }, {

package/lib/cjs/components/livechatwidget/common/defaultProps/defaultPersistentChatHistoryProps.js

@@ -5,8 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.defaultPersistentChatHistoryProps = void 0;
 const defaultPersistentChatHistoryProps = {
-  persistentChatHistoryEnabled: true,
-  pageSize: 4,
+  pageSize: 10,
   dividerActivityStyle: {
     border: "1px solid rgb(96, 94, 92, 0.5)",
     margin: "10px 20%"

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

@@ -201,6 +201,18 @@ const endChat = async (props, facadeChatSDK, state, dispatch, setAdapter, setWeb
       facadeChatSDK.destroy();
     }
   }
+
+  //moving logic below to before processing skipCloseChat logic to avoid race conditions of postMessage for endChatEvent for other tabs vs postMessage for CloseChat
+  //TODO: clarify if this postMessageToOtherTab actually works in production.
+  if (postMessageToOtherTab) {
+    const endChatEventName = await getEndChatEventName(facadeChatSDK, props);
+    _omnichannelChatComponents.BroadcastService.postMessage({
+      eventName: endChatEventName,
+      payload: {
+        runtimeId: _TelemetryManager.TelemetryManager.InternalTelemetryData.lcwRuntimeId
+      }
+    });
+  }
   if (!skipCloseChat) {
     try {
       var _props$webChatContain;
@@ -240,17 +252,17 @@ const endChat = async (props, facadeChatSDK, state, dispatch, setAdapter, setWeb
       });
       closeChatWidget(dispatch, setWebChatStyles, props);
       facadeChatSDK.destroy();
+
+      //always post the close chat event after chat closed and cleanup completed
+      _omnichannelChatComponents.BroadcastService.postMessage({
+        eventName: _TelemetryConstants.BroadcastEvent.CloseChat
+      });
+      _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
+        Event: _TelemetryConstants.TelemetryEvent.CloseChatCall,
+        Description: "Broadcasted close chat event"
+      });
     }
   }
-  if (postMessageToOtherTab) {
-    const endChatEventName = await getEndChatEventName(facadeChatSDK, props);
-    _omnichannelChatComponents.BroadcastService.postMessage({
-      eventName: endChatEventName,
-      payload: {
-        runtimeId: _TelemetryManager.TelemetryManager.InternalTelemetryData.lcwRuntimeId
-      }
-    });
-  }
 };
 exports.endChat = endChat;
 const callingStateCleanUp = dispatch => {

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

@@ -125,7 +125,14 @@ const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endChat) =>
     };
     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), (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, (0, _citationsMiddleware.createCitationsMiddleware)(state, dispatch), _gifUploadMiddleware.default, _htmlPlayerMiddleware.default, (0, _htmlTextMiddleware.default)(honorsTargetInHTMLLinks), (0, _maxMessageSizeValidator.default)(localizedTexts), _sanitizationMiddleware.default, (0, _callActionMiddleware.default)(), (0, _localizedStringsBotInitialsMiddleware.localizedStringsBotInitialsMiddleware)(),
+    _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, (0, _citationsMiddleware.createCitationsMiddleware)(state, dispatch), _gifUploadMiddleware.default, _htmlPlayerMiddleware.default, (0, _htmlTextMiddleware.default)(honorsTargetInHTMLLinks), (0, _maxMessageSizeValidator.default)(localizedTexts), _sanitizationMiddleware.default, (0, _callActionMiddleware.default)(),
+    // Pass a callback so middleware can push initials into React context for reactivity
+    (0, _localizedStringsBotInitialsMiddleware.localizedStringsBotInitialsMiddleware)(initials => {
+      dispatch({
+        type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_BOT_AVATAR_INITIALS,
+        payload: initials
+      });
+    }),
     // 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;
@@ -168,7 +175,7 @@ const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endChat) =>
     dir: state.domainStates.globalDir,
     locale: (0, _utils.changeLanguageCodeFormatForWebChat)((0, _omnichannelChatSdk.getLocaleStringFromId)((_state$domainStates$l4 = state.domainStates.liveChatConfig) === null || _state$domainStates$l4 === void 0 ? void 0 : (_state$domainStates$l5 = _state$domainStates$l4.ChatWidgetLanguage) === null || _state$domainStates$l5 === void 0 ? void 0 : _state$domainStates$l5.msdyn_localeid)),
     store: webChatStore,
-    activityMiddleware: (_props$webChatContain11 = props.webChatContainerProps) !== null && _props$webChatContain11 !== void 0 && (_props$webChatContain12 = _props$webChatContain11.renderingMiddlewareProps) !== null && _props$webChatContain12 !== void 0 && _props$webChatContain12.disableActivityMiddleware ? undefined : (0, _activityMiddleware.createActivityMiddleware)(renderMarkdown, (_state$domainStates$r = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r === void 0 ? void 0 : _state$domainStates$r.systemMessageStyleProps, (_state$domainStates$r2 = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r2 === void 0 ? void 0 : _state$domainStates$r2.userMessageStyleProps),
+    activityMiddleware: (_props$webChatContain11 = props.webChatContainerProps) !== null && _props$webChatContain11 !== void 0 && (_props$webChatContain12 = _props$webChatContain11.renderingMiddlewareProps) !== null && _props$webChatContain12 !== void 0 && _props$webChatContain12.disableActivityMiddleware ? undefined : (0, _activityMiddleware.createActivityMiddleware)(renderMarkdown, (_state$domainStates$r = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r === void 0 ? void 0 : _state$domainStates$r.systemMessageStyleProps, (_state$domainStates$r2 = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r2 === void 0 ? void 0 : _state$domainStates$r2.userMessageStyleProps, localizedTexts),
     attachmentMiddleware: (_props$webChatContain13 = props.webChatContainerProps) !== null && _props$webChatContain13 !== void 0 && (_props$webChatContain14 = _props$webChatContain13.renderingMiddlewareProps) !== null && _props$webChatContain14 !== void 0 && _props$webChatContain14.disableAttachmentMiddleware ? undefined : (0, _attachmentMiddleware.createAttachmentMiddleware)(((_state$domainStates$r3 = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r3 === void 0 ? void 0 : (_state$domainStates$r4 = _state$domainStates$r3.attachmentProps) === null || _state$domainStates$r4 === void 0 ? void 0 : _state$domainStates$r4.enableInlinePlaying) ?? _defaultAttachmentProps.defaultAttachmentProps.enableInlinePlaying),
     activityStatusMiddleware: (_props$webChatContain15 = props.webChatContainerProps) !== null && _props$webChatContain15 !== void 0 && (_props$webChatContain16 = _props$webChatContain15.renderingMiddlewareProps) !== null && _props$webChatContain16 !== void 0 && _props$webChatContain16.disableActivityStatusMiddleware ? undefined : (0, _activityStatusMiddleware.createActivityStatusMiddleware)((0, _omnichannelChatSdk.getLocaleStringFromId)((_state$domainStates$l6 = state.domainStates.liveChatConfig) === null || _state$domainStates$l6 === void 0 ? void 0 : (_state$domainStates$l7 = _state$domainStates$l6.ChatWidgetLanguage) === null || _state$domainStates$l7 === void 0 ? void 0 : _state$domainStates$l7.msdyn_localeid)),
     toastMiddleware: (_props$webChatContain17 = props.webChatContainerProps) !== null && _props$webChatContain17 !== void 0 && (_props$webChatContain18 = _props$webChatContain17.renderingMiddlewareProps) !== null && _props$webChatContain18 !== void 0 && _props$webChatContain18.disableToastMiddleware ? undefined : (0, _toastMiddleware.createToastMiddleware)(props.notificationPaneProps, endChat),

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

@@ -30,7 +30,10 @@ const registerTelemetryLoggers = (props, dispatch) => {
       appInsightsConfig: Object.assign({}, _defaultAppInsightsConfig.defaultAppInsightsConfig, props.appInsightsConfig)
     };
     if (props.chatConfig) {
+      var _props$chatConfig$Liv;
       telemetryData = _TelemetryHelper.TelemetryHelper.addChatConfigDataToTelemetry(props === null || props === void 0 ? void 0 : props.chatConfig, telemetryData);
+      //store AppInsights instrumentation key from chatConfig if present
+      telemetryData.chatConfigAppInsightsKey = (_props$chatConfig$Liv = props.chatConfig.LiveWSAndLiveChatEngJoin) === null || _props$chatConfig$Liv === void 0 ? void 0 : _props$chatConfig$Liv.AppInsightsInstrumentationKey;
     }
     if (!((_props$chatSDK = props.chatSDK) !== null && _props$chatSDK !== void 0 && (_props$chatSDK$omnich = _props$chatSDK.omnichannelConfig) !== null && _props$chatSDK$omnich !== void 0 && _props$chatSDK$omnich.orgId) || ((_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.orgId.trim().length) === 0) {
       throw new Error("orgId is undefined in ChatSDK");