@microsoft/omnichannel-chat-widget 1.8.3-main.ec1328d → 1.8.4-main.4478bbf

package/lib/cjs/contexts/common/LiveChatWidgetContextInitialState.js

@@ -45,6 +45,8 @@ const getLiveChatWidgetContextInitialState = props => {
     domainStates: {
       liveChatConfig: props.chatConfig,
       widgetElementId: "",
+      // Map of citation id => content injected by citations middleware
+      citations: {},
       renderingMiddlewareProps: (_props$webChatContain = props.webChatContainerProps) === null || _props$webChatContain === void 0 ? void 0 : _props$webChatContain.renderingMiddlewareProps,
       middlewareLocalizedTexts: _defaultMiddlewareLocalizedTexts.defaultMiddlewareLocalizedTexts,
       preChatSurveyResponse: "{}",

package/lib/cjs/contexts/createReducer.js

@@ -70,6 +70,21 @@ const reducer = (state, action) => {
           middlewareLocalizedTexts: action.payload
         }
       };
+    case _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CITATIONS:
+      inMemory = {
+        ...inMemory,
+        domainStates: {
+          ...inMemory.domainStates,
+          citations: action.payload
+        }
+      };
+      return {
+        ...state,
+        domainStates: {
+          ...state.domainStates,
+          citations: action.payload
+        }
+      };
     case _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_GLOBAL_DIR:
       inMemory = {
         ...inMemory,

package/lib/cjs/firstresponselatency/FirstMessageTrackerFromBot.js

@@ -36,7 +36,7 @@ const createTrackingForFirstMessage = () => {
    * Starts tracking the time for the first bot message after widget loads.
    * Sets a 5-second timeout to auto-reset if no bot message is received.
    */
-  const widgetLoadListener = _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.TelemetryEvent.WidgetLoadComplete).subscribe(() => {
+  const widgetLoadListener = _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.TelemetryEvent.StartChatComplete).subscribe(() => {
     if (isTracking) return;
     isTracking = true;
     startTime = new Date().getTime();
@@ -91,7 +91,8 @@ const createTrackingForFirstMessage = () => {
         CustomProperties: {
           elapsedTime,
           widgetLoadedAt: startTime,
-          botMessage: stopTrackingMessage
+          botMessage: stopTrackingMessage,
+          type: payload === null || payload === void 0 ? void 0 : payload.type
         }
       });
       disconnectListener();

package/lib/cjs/firstresponselatency/FirstResponseLatencyTracker.js

@@ -7,6 +7,7 @@ exports.FirstResponseLatencyTracker = void 0;
 var _TelemetryConstants = require("../common/telemetry/TelemetryConstants");
 var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components");
 var _TelemetryHelper = require("../common/telemetry/TelemetryHelper");
+var _Constants = require("../common/Constants");
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 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; }
@@ -133,7 +134,8 @@ let FirstResponseLatencyTracker = /*#__PURE__*/function () {
         CustomProperties: {
           elapsedTime,
           userMessage: this.startTrackingMessage,
-          botMessage: this.stopTrackingMessage
+          botMessage: this.stopTrackingMessage,
+          type: payload === null || payload === void 0 ? void 0 : payload.type
         }
       });
     }
@@ -174,7 +176,9 @@ let FirstResponseLatencyTracker = /*#__PURE__*/function () {
     value: function stopClock(payload) {
       try {
         if (!payload || !payload.Id) {
-          throw new Error("Invalid payload");
+          if ((payload === null || payload === void 0 ? void 0 : payload.type) !== _Constants.Constants.typing) {
+            throw new Error("Invalid payload");
+          }
         }
 
         // Only allow stopTracking if sender is valid and tracking is active

package/lib/cjs/index.js

@@ -14,7 +14,8 @@ var _exportNames = {
   useChatSDKStore: true,
   useFacadeChatSDKStore: true,
   LiveChatWidget: true,
-  getMockChatSDKIfApplicable: true
+  getMockChatSDKIfApplicable: true,
+  LiveChatWidgetMockType: true
 };
 Object.defineProperty(exports, "BroadcastService", {
   enumerable: true,
@@ -34,6 +35,12 @@ Object.defineProperty(exports, "LiveChatWidget", {
     return _LiveChatWidget.default;
   }
 });
+Object.defineProperty(exports, "LiveChatWidgetMockType", {
+  enumerable: true,
+  get: function () {
+    return _IMockProps.LiveChatWidgetMockType;
+  }
+});
 Object.defineProperty(exports, "decodeComponentString", {
   enumerable: true,
   get: function () {
@@ -90,6 +97,7 @@ var _useChatSDKStore = _interopRequireDefault(require("./hooks/useChatSDKStore")
 var _useFacadeChatSDKStore = _interopRequireDefault(require("./hooks/useFacadeChatSDKStore"));
 var _LiveChatWidget = _interopRequireDefault(require("./components/livechatwidget/LiveChatWidget"));
 var _getMockChatSDKIfApplicable = require("./components/livechatwidget/common/getMockChatSDKIfApplicable");
+var _IMockProps = require("./components/livechatwidget/interfaces/IMockProps");
 var _renderingmiddlewares = require("./components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares");
 Object.keys(_renderingmiddlewares).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/lib/cjs/plugins/newMessageEventHandler.js

@@ -84,6 +84,9 @@ const createOnNewAdapterActivityHandler = (chatId, userId, startTime) => {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const messageHasNoAttachments = !(activity !== null && activity !== void 0 && activity.attachments) || (activity === null || activity === void 0 ? void 0 : activity.attachments.length) === 0;
     if (messageHasNoTags && messageHasNoText && messageHasNoAttachments) {
+      if ((activity === null || activity === void 0 ? void 0 : activity.type) === _Constants2.Constants.typing) {
+        return true;
+      }
       return false;
     }
     return true;
@@ -112,7 +115,7 @@ const createOnNewAdapterActivityHandler = (chatId, userId, startTime) => {
     });
   };
   const raiseMessageEvent = activity => {
-    if ((activity === null || activity === void 0 ? void 0 : activity.type) === _Constants2.Constants.message) {
+    if ((activity === null || activity === void 0 ? void 0 : activity.type) === _Constants2.Constants.message || (activity === null || activity === void 0 ? void 0 : activity.type) === _Constants2.Constants.typing) {
       const scenarioType = (0, _util.getScenarioType)(activity);
       switch (scenarioType) {
         case _Constants.ScenarioType.UserSendMessageStrategy:

package/lib/esm/common/Constants.js

@@ -38,6 +38,10 @@ _defineProperty(Constants, "botParticipantTypeTag", "Bot");
 _defineProperty(Constants, "channelIdKey", "ChannelId-");
 _defineProperty(Constants, "ChannelId", "lcw");
 _defineProperty(Constants, "CustomerTag", "FromCustomer");
+// LCW only tags (Only applicable on client-side for additional processing, not recognized by service)
+_defineProperty(Constants, "persistentChatHistoryMessageTag", "PersistentChatHistory");
+_defineProperty(Constants, "persistentChatHistoryMessagePullTriggerTag", "PersistentChatHistoryMessagePullTrigger");
+_defineProperty(Constants, "conversationDividerTag", "ConversationDivider");
 // gifUploadMiddleware
 _defineProperty(Constants, "GifContentType", "image/gif");
 // htmlPlayerMiddleware
@@ -57,6 +61,7 @@ _defineProperty(Constants, "queuePositionMessageTag", "queueposition");
 _defineProperty(Constants, "averageWaitTimeMessageTag", "averagewaittime");
 _defineProperty(Constants, "message", "message");
 _defineProperty(Constants, "hiddenTag", "Hidden");
+_defineProperty(Constants, "typing", "typing");
 // messageTimestampMiddleware
 _defineProperty(Constants, "prefixTimestampTag", "ServerMessageTimestamp_");
 _defineProperty(Constants, "acsChannel", "ACS_CHANNEL");
@@ -184,6 +189,8 @@ _defineProperty(HtmlAttributeNames, "adaptiveCardClassName", "ac-adaptiveCard");
 _defineProperty(HtmlAttributeNames, "adaptiveCardTextBlockClassName", "ac-textBlock");
 _defineProperty(HtmlAttributeNames, "adaptiveCardToggleInputClassName", "ac-toggleInput");
 _defineProperty(HtmlAttributeNames, "adaptiveCardActionSetClassName", "ac-actionSet");
+_defineProperty(HtmlAttributeNames, "ocwCitationPaneClassName", "ocw-citation-pane");
+_defineProperty(HtmlAttributeNames, "ocwCitationPaneTitle", "Citation");
 export let WebChatMiddlewareConstants = /*#__PURE__*/_createClass(function WebChatMiddlewareConstants() {
   _classCallCheck(this, WebChatMiddlewareConstants);
 });

package/lib/esm/common/facades/FacadeChatSDK.js

@@ -481,6 +481,12 @@ export let FacadeChatSDK = /*#__PURE__*/function () {
       reconnectableChatsParams.authenticatedUserToken = this.token;
       return this.validateAndExecuteCall("getReconnectableChats", () => this.chatSDK.OCClient.getReconnectableChats(reconnectableChatsParams));
     }
+  }, {
+    key: "fetchPersistentConversationHistory",
+    value: async function fetchPersistentConversationHistory() {
+      let getPersistentChatHistoryOptionalParams = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      return this.validateAndExecuteCall("getPersistentChatHistory", () => this.chatSDK.getPersistentChatHistory(getPersistentChatHistoryOptionalParams));
+    }
   }]);
   return FacadeChatSDK;
 }();

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

@@ -1,8 +1,5 @@
 export const AppInsightsEventMapping = {
   "LCWChatButtonClicked": "LCWChatButtonActionStarted",
-  "WidgetLoadStarted": "WidgetStartChatStarted",
-  "WidgetLoadComplete": "WidgetStartChatCompleted",
-  "WidgetLoadFailed": "WidgetStartChatFailed",
   "PrechatSubmitted": "PrechatSubmitCompleted",
   "StartChatEventRecevied": "StartChatEventReceivedCompleted",
   "EndChatEventReceived": "EndChatEventReceivedCompleted",
@@ -18,7 +15,9 @@ export const AppInsightsEventMapping = {
   "MessageSent": "MessageSentCompleted",
   "MessageReceived": "MessageReceivedCompleted",
   "SystemMessageReceived": "SystemMessageReceivedCompleted",
-  "RehydrateMessageReceived": "RehydrateMessageReceivedCompleted",
+  "RehydrateMessageReceived": "ChatHistoryMessageReceivedCompleted",
   "CustomContextReceived": "CustomContextReceivedCompleted",
-  "PostChatContextCallSucceed": "PostChatContextCallCompleted"
+  "NewTokenValidationStarted": "AuthTokenValidationStarted",
+  "NewTokenValidationCompleted": "AuthTokenValidationCompleted",
+  "NewTokenValidationFailed": "AuthTokenValidationFailed"
 };

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

@@ -68,9 +68,11 @@ export let BroadcastEvent;
   BroadcastEvent["OnWidgetError"] = "OnWidgetError";
   BroadcastEvent["FMLTrackingCompletedAck"] = "FMLTrackingCompletedAck";
   BroadcastEvent["FMLTrackingCompleted"] = "FMLTrackingCompleted";
+  BroadcastEvent["PersistentConversationReset"] = "PersistentConversationReset";
 })(BroadcastEvent || (BroadcastEvent = {}));
 export let TelemetryEvent;
 (function (TelemetryEvent) {
+  TelemetryEvent["FetchPersistentChatHistoryFailed"] = "FetchPersistentChatHistoryFailed";
   TelemetryEvent["CallAdded"] = "CallAdded";
   TelemetryEvent["LocalVideoStreamAdded"] = "LocalVideoStreamAdded";
   TelemetryEvent["LocalVideoStreamRemoved"] = "LocalVideoStreamRemoved";
@@ -148,6 +150,7 @@ export let TelemetryEvent;
   TelemetryEvent["EmailTranscriptLoaded"] = "EmailTranscriptLoaded";
   TelemetryEvent["OutOfOfficePaneLoaded"] = "OutOfOfficePaneLoaded";
   TelemetryEvent["ConfirmationPaneLoaded"] = "ConfirmationPaneLoaded";
+  TelemetryEvent["CitationPaneLoaded"] = "CitationPaneLoaded";
   TelemetryEvent["ProactiveChatPaneLoaded"] = "ProactiveChatPaneLoaded";
   TelemetryEvent["ReconnectChatPaneLoaded"] = "ReconnectChatPaneLoaded";
   TelemetryEvent["HeaderCloseButtonClicked"] = "HeaderCloseButtonClicked";
@@ -274,11 +277,42 @@ export let TelemetryEvent;
   TelemetryEvent["UXLCWChatButtonLoadingStart"] = "UXLCWChatButtonLoadingStart";
   TelemetryEvent["UXLCWChatButtonLoadingCompleted"] = "UXLCWChatButtonLoadingCompleted";
   TelemetryEvent["UXConfirmationPaneStart"] = "UXConfirmationPaneStart";
+  TelemetryEvent["UXCitationPaneStart"] = "UXCitationPaneStart";
   TelemetryEvent["UXConfirmationPaneCompleted"] = "UXConfirmationPaneCompleted";
+  TelemetryEvent["UXCitationPaneCompleted"] = "UXCitationPaneCompleted";
   TelemetryEvent["UXLiveChatWidgetStart"] = "UXLiveChatWidgetStart";
   TelemetryEvent["UXLiveChatWidgetCompleted"] = "UXLiveChatWidgetCompleted";
+  TelemetryEvent["UXPostChatPaneStarted"] = "UXPostChatPaneStarted";
+  TelemetryEvent["UXPostChatPaneCompleted"] = "UXPostChatPaneCompleted";
   TelemetryEvent["AppInsightsInitialized"] = "AppInsightsInitialized";
   TelemetryEvent["AppInsightsInitFailed"] = "AppInsightsInitFailed";
+  TelemetryEvent["ConvertPersistentChatHistoryMessageToActivityFailed"] = "ConvertPersistentChatHistoryMessageToActivityFailed";
+  TelemetryEvent["UXLCWPersistentChatHistoryInitialized"] = "UXLCWPersistentChatHistoryInitialized";
+  TelemetryEvent["LCWPersistentChatHistoryFetchStarted"] = "LCWPersistentChatHistoryFetchStarted";
+  TelemetryEvent["LCWPersistentChatHistoryFetchCompleted"] = "LCWPersistentChatHistoryFetchCompleted";
+  TelemetryEvent["LCWPersistentChatHistoryFetchFailed"] = "LCWPersistentChatHistoryFetchFailed";
+  TelemetryEvent["LCWWebChatStorePollingStarted"] = "LCWWebChatStorePollingStarted";
+  TelemetryEvent["LCWWebChatStoreReady"] = "LCWWebChatStoreReady";
+  TelemetryEvent["LCWWebChatConnected"] = "LCWWebChatConnected";
+  TelemetryEvent["LCWWebChatDisconnected"] = "LCWWebChatDisconnected";
+  TelemetryEvent["LCWWebChatConnectionCheckFailed"] = "LCWWebChatConnectionCheckFailed";
+  TelemetryEvent["LCWPersistentConversationHandlerInitialized"] = "LCWPersistentConversationHandlerInitialized";
+  TelemetryEvent["LCWPersistentHistoryPullBlocked"] = "LCWPersistentHistoryPullBlocked";
+  TelemetryEvent["LCWPersistentHistoryPullCompleted"] = "LCWPersistentHistoryPullCompleted";
+  TelemetryEvent["LCWLazyLoadInitializationStarted"] = "LCWLazyLoadInitializationStarted";
+  TelemetryEvent["LCWLazyLoadContainerNotFound"] = "LCWLazyLoadContainerNotFound";
+  TelemetryEvent["LCWLazyLoadInitializationCompleted"] = "LCWLazyLoadInitializationCompleted";
+  TelemetryEvent["LCWLazyLoadSessionMetrics"] = "LCWLazyLoadSessionMetrics";
+  TelemetryEvent["LCWLazyLoadTargetElementNotFound"] = "LCWLazyLoadTargetElementNotFound";
+  TelemetryEvent["LCWLazyLoadScrollFailed"] = "LCWLazyLoadScrollFailed";
+  TelemetryEvent["LCWLazyLoadActivityMounted"] = "LCWLazyLoadActivityMounted";
+  TelemetryEvent["LCWLazyLoadReset"] = "LCWLazyLoadReset";
+  TelemetryEvent["LCWLazyLoadNoMoreHistory"] = "LCWLazyLoadNoMoreHistory";
+  TelemetryEvent["LCWLazyLoadDestroyed"] = "LCWLazyLoadDestroyed";
+  TelemetryEvent["SecureEventBusUnauthorizedDispatch"] = "SecureEventBusUnauthorizedDispatch";
+  TelemetryEvent["SecureEventBusListenerError"] = "SecureEventBusListenerError";
+  TelemetryEvent["SecureEventBusDispatchError"] = "SecureEventBusDispatchError";
+  TelemetryEvent["StartChatComplete"] = "StartChatComplete";
 })(TelemetryEvent || (TelemetryEvent = {}));
 export let TelemetryConstants = /*#__PURE__*/function () {
   function TelemetryConstants() {
@@ -346,6 +380,9 @@ export let TelemetryConstants = /*#__PURE__*/function () {
         case TelemetryEvent.PostChatWorkflowFromAgent:
         case TelemetryEvent.PostChatWorkflowFromBot:
         case TelemetryEvent.AppStatesException:
+        case TelemetryEvent.SecureEventBusUnauthorizedDispatch:
+        case TelemetryEvent.SecureEventBusListenerError:
+        case TelemetryEvent.SecureEventBusDispatchError:
           return ScenarioType.ACTIONS;
         case TelemetryEvent.StartChatSDKCall:
         case TelemetryEvent.StartChatEventReceived:
@@ -405,4 +442,10 @@ export let TelemetryConstants = /*#__PURE__*/function () {
     }
   }]);
   return TelemetryConstants;
-}();
+}();
+export let ConversationStage;
+(function (ConversationStage) {
+  ConversationStage["Initialization"] = "Initialization";
+  ConversationStage["CSREngagement"] = "CSR Engagement";
+  ConversationStage["ConversationEnd"] = "Conversation End";
+})(ConversationStage || (ConversationStage = {}));

package/lib/esm/common/telemetry/loggers/appInsightsLogger.js

@@ -1,19 +1,16 @@
-import { LogLevel, TelemetryEvent } from "../TelemetryConstants";
+import { ConversationStage, LogLevel, TelemetryEvent } from "../TelemetryConstants";
 import ScenarioMarker from "../ScenarioMarker";
 import { TelemetryHelper } from "../TelemetryHelper";
 import { AppInsightsTelemetryMessage } from "../../Constants";
 import { AppInsightsEventMapping } from "../AppInsightsEvents";
 var AllowedKeys;
 (function (AllowedKeys) {
-  AllowedKeys["LogLevel"] = "LogLevel";
+  AllowedKeys["OrganizationId"] = "OrganizationId";
+  AllowedKeys["ConversationId"] = "LiveWorkItemId";
+  AllowedKeys["ElapsedTimeInMilliseconds"] = "Duration";
   AllowedKeys["Description"] = "Description";
-  AllowedKeys["ExceptionDetails"] = "ExceptionDetails";
-  AllowedKeys["ChannelId"] = "ChannelId";
+  AllowedKeys["ChannelId"] = "ChannelType";
   AllowedKeys["LCWRuntimeId"] = "ClientSessionId";
-  AllowedKeys["ConversationId"] = "LiveWorkItemId";
-  AllowedKeys["ChatId"] = "ChatThreadId";
-  AllowedKeys["OrganizationId"] = "OrganizationId";
-  AllowedKeys["ElapsedTimeInMilliseconds"] = "DurationInMilliseconds";
 })(AllowedKeys || (AllowedKeys = {}));
 let initializationPromise = null;
 export const appInsightsLogger = appInsightsKey => {
@@ -86,9 +83,9 @@ export const appInsightsLogger = appInsightsKey => {
         if (!_logger) return;
         const eventName = telemetryInput === null || telemetryInput === void 0 ? void 0 : (_telemetryInput$paylo = telemetryInput.payload) === null || _telemetryInput$paylo === void 0 ? void 0 : _telemetryInput$paylo.Event;
         const telemetryInfo = telemetryInput === null || telemetryInput === void 0 ? void 0 : (_telemetryInput$telem = telemetryInput.telemetryInfo) === null || _telemetryInput$telem === void 0 ? void 0 : _telemetryInput$telem.telemetryInfo;
-        const eventProperties = setEventProperties(telemetryInfo);
         if (eventName) {
           const trackingEventName = getTrackingEventName(logLevel, eventName);
+          const eventProperties = setEventProperties(trackingEventName, telemetryInfo);
           _logger.trackEvent({
             name: trackingEventName,
             properties: eventProperties
@@ -107,17 +104,36 @@ export const appInsightsLogger = appInsightsKey => {
   };
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  function setEventProperties(telemetryInfo) {
+  function setEventProperties(eventName, telemetryInfo) {
     const eventProperties = {};
     if (telemetryInfo) {
       for (const key in AllowedKeys) {
-        const finalKey = AllowedKeys[key]; // get renamed keys for LCWRuntimeId, ConversationId, ChatId
+        const finalKey = AllowedKeys[key]; // get renamed keys for LCWRuntimeId, ConversationId
         const value = telemetryInfo[key];
         if (value !== undefined && value !== null && value !== "") {
           eventProperties[finalKey] = value;
         }
       }
     }
+    // Include exception details in description for error events
+    if (telemetryInfo !== null && telemetryInfo !== void 0 && telemetryInfo.ExceptionDetails) {
+      eventProperties[AllowedKeys.Description] = JSON.stringify(telemetryInfo.ExceptionDetails);
+    }
+    const customProperties = (() => {
+      if (!(telemetryInfo !== null && telemetryInfo !== void 0 && telemetryInfo.CustomProperties)) {
+        return {};
+      }
+      try {
+        return typeof telemetryInfo.CustomProperties === "string" ? JSON.parse(telemetryInfo.CustomProperties) : telemetryInfo.CustomProperties;
+      } catch (error) {
+        console.warn("Failed to parse CustomProperties:", error);
+        return {};
+      }
+    })();
+    // Additional properties
+    eventProperties["ConversationStage"] = customProperties.ConversationStage ?? ConversationStage.CSREngagement;
+    eventProperties["Scenario"] = "Conversation Diagnostics";
+    eventProperties["OperationName"] = eventName.includes(": ") ? eventName.split(": ")[1] : eventName;
     return eventProperties;
   }
   function getTrackingEventName(logLevel, eventName) {