@microsoft/omnichannel-chat-widget 1.8.3-main.717ca8d → 1.8.3-main.b5b8289

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

@@ -10,6 +10,7 @@ var _TelemetryConstants = require("../../common/telemetry/TelemetryConstants");
 var _react2 = _interopRequireWildcard(require("react"));
 var _utils = require("../../common/utils");
 var _BotMagicCodeStore = require("./webchatcontroller/BotMagicCodeStore");
+var _CitationPaneStateful = _interopRequireDefault(require("../citationpanestateful/CitationPaneStateful"));
 var _botframeworkWebchat = require("botframework-webchat");
 var _LiveChatWidgetActionType = require("../../contexts/common/LiveChatWidgetActionType");
 var _NotificationHandler = require("./webchatcontroller/notification/NotificationHandler");
@@ -25,12 +26,12 @@ var _defaultSystemMessageBoxStyles = require("./webchatcontroller/middlewares/re
 var _defaultUserMessageBoxStyles = require("./webchatcontroller/middlewares/renderingmiddlewares/defaultStyles/defaultUserMessageBoxStyles");
 var _defaultWebChatContainerStatefulProps = require("./common/defaultProps/defaultWebChatContainerStatefulProps");
 var _ = require("../..");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
 let uiTimer;
 const broadcastChannelMessageEvent = "message";
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const postActivity = activity => {
   // eslint-disable-line @typescript-eslint/no-explicit-any
   return {
@@ -56,13 +57,24 @@ const createMagicCodeSuccessResponse = signin => {
   };
 };
 const WebChatContainerStateful = props => {
-  var _webChatContainerProp, _webChatContainerProp2, _webChatContainerProp3, _webChatContainerProp4, _webChatContainerProp5, _webChatContainerProp6, _webChatContainerProp7, _webChatContainerProp8, _props$webChatContain5, _props$webChatContain6, _defaultWebChatContai, _props$webChatContain7, _props$webChatContain8, _defaultWebChatContai2, _webChatContainerProp9, _webChatContainerProp10, _webChatContainerProp11, _webChatContainerProp12, _webChatContainerProp13, _webChatContainerProp14, _webChatContainerProp15, _webChatContainerProp16, _webChatContainerProp17, _webChatContainerProp18, _webChatContainerProp19, _webChatContainerProp20, _webChatContainerProp21, _webChatContainerProp22, _webChatContainerProp23, _props$webChatContain9, _props$webChatContain10;
+  var _webChatContainerProp, _webChatContainerProp2, _webChatContainerProp3, _webChatContainerProp4, _webChatContainerProp5, _webChatContainerProp6, _webChatContainerProp7, _webChatContainerProp8, _props$webChatContain5, _props$webChatContain6, _defaultWebChatContai, _props$webChatContain7, _props$webChatContain8, _defaultWebChatContai2, _webChatContainerProp9, _webChatContainerProp10, _webChatContainerProp11, _webChatContainerProp12, _webChatContainerProp13, _webChatContainerProp14, _webChatContainerProp15, _webChatContainerProp16, _webChatContainerProp17, _webChatContainerProp18, _webChatContainerProp19, _webChatContainerProp20, _webChatContainerProp21, _webChatContainerProp22, _webChatContainerProp23, _props$webChatContain9, _props$webChatContain10, _props$citationPanePr, _props$citationPanePr2, _props$citationPanePr3, _props$citationPanePr4;
   (0, _react2.useEffect)(() => {
     uiTimer = (0, _utils.createTimer)();
     _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.INFO, {
       Event: _TelemetryConstants.TelemetryEvent.UXWebchatContainerCompleted
     });
   }, []);
+
+  // Citation pane state
+  const [citationPaneOpen, setCitationPaneOpen] = (0, _react2.useState)(false);
+  const [citationPaneText, setCitationPaneText] = (0, _react2.useState)("");
+
+  // Guard to prevent handling multiple rapid clicks which could cause
+  // the dim layer and pane to re-render out of sync and create a flicker.
+  const citationOpeningRef = (0, _react2.useRef)(false);
+
+  // ...existing code...
+
   const {
     BasicWebChat
   } = _botframeworkWebchat.Components;
@@ -71,6 +83,53 @@ const WebChatContainerStateful = props => {
     webChatContainerProps,
     contextDataStore
   } = props;
+
+  // Delegated click handler for citation anchors. Placed after state is
+  // available so we can prefer reading citations from app state and fall
+  // back to the legacy window map for backward-compatibility in tests.
+  (0, _react2.useEffect)(() => {
+    const clickHandler = ev => {
+      try {
+        if (citationOpeningRef.current) {
+          return;
+        }
+        const target = ev.target;
+        // Only consider anchors whose href starts with the citation scheme
+        const anchor = target.closest && target.closest("a[href^=\"cite:\"]");
+        if (anchor) {
+          ev.preventDefault();
+          citationOpeningRef.current = true;
+          // Rely only on the href to identify the citation key
+          let text = "";
+          try {
+            var _state$domainStates;
+            const cid = anchor.getAttribute("href");
+            // Prefer state-based citations injected by middleware
+            if (state !== null && state !== void 0 && (_state$domainStates = state.domainStates) !== null && _state$domainStates !== void 0 && _state$domainStates.citations && cid) {
+              text = state.domainStates.citations[cid] ?? "";
+            }
+            // If state lookup failed, fall back to the anchor's title or innerText
+            if (!text) {
+              text = anchor.getAttribute("title") || anchor.innerText || "";
+            }
+          } catch (e) {
+            // ignore
+          }
+          setCitationPaneOpen(true);
+          setCitationPaneText(text);
+
+          // Simple debounce - reset guard after a short delay
+          setTimeout(() => {
+            citationOpeningRef.current = false;
+          }, 100);
+        }
+      } catch (e) {
+        citationOpeningRef.current = false;
+      }
+    };
+    document.addEventListener("click", clickHandler);
+    return () => document.removeEventListener("click", clickHandler);
+  }, [state]);
   const containerStyles = {
     root: Object.assign({}, _defaultWebChatContainerStatefulProps.defaultWebChatContainerStatefulProps.containerStyles, webChatContainerProps === null || webChatContainerProps === void 0 ? void 0 : webChatContainerProps.containerStyles, {
       display: state.appStates.isMinimized ? "none" : ""
@@ -105,8 +164,10 @@ const WebChatContainerStateful = props => {
         localStorage;
         sessionStorage;
       } catch (error) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         if (!window.TPCWarningShown) {
           _NotificationHandler.NotificationHandler.notifyWarning(_NotificationScenarios.NotificationScenarios.TPC, (localizedTexts === null || localizedTexts === void 0 ? void 0 : localizedTexts.THIRD_PARTY_COOKIES_BLOCKED_ALERT_MESSAGE) ?? "");
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
           window.TPCWarningShown = true;
         }
       }
@@ -295,11 +356,34 @@ const WebChatContainerStateful = props => {
             overflow-y: unset;
             }
 
-        
+        /* Custom styles for carousel hero cards */
+		ul.webchat__carousel-filmstrip__attachments .ac-image {
+			width: 200px !important;
+			height: 150px !important;
+			object-fit: cover !important;
+			border-radius: 8px !important;
+			border: 1px solid #e0e0e0 !important;
+		}
+
+		.webchat__carousel-filmstrip-attachment .webchat__bubble {
+			height: 100% !important;
+		}
+
+		.webchat__carousel-filmstrip-attachment .webchat__bubble #ms_lcw_webchat_adaptive_card {
+			height: 100% !important;
+		}
+
         `), /*#__PURE__*/_react2.default.createElement(_react.Stack, {
     styles: containerStyles,
     className: "webchat__stacked-layout_container"
-  }, /*#__PURE__*/_react2.default.createElement(BasicWebChat, null)));
+  }, /*#__PURE__*/_react2.default.createElement(BasicWebChat, null)), citationPaneOpen && /*#__PURE__*/_react2.default.createElement(_CitationPaneStateful.default, {
+    id: ((_props$citationPanePr = props.citationPaneProps) === null || _props$citationPanePr === void 0 ? void 0 : _props$citationPanePr.id) || _Constants.HtmlAttributeNames.ocwCitationPaneClassName,
+    title: ((_props$citationPanePr2 = props.citationPaneProps) === null || _props$citationPanePr2 === void 0 ? void 0 : _props$citationPanePr2.title) || _Constants.HtmlAttributeNames.ocwCitationPaneTitle,
+    contentHtml: citationPaneText,
+    onClose: () => setCitationPaneOpen(false),
+    controlProps: (_props$citationPanePr3 = props.citationPaneProps) === null || _props$citationPanePr3 === void 0 ? void 0 : _props$citationPanePr3.controlProps,
+    styleProps: (_props$citationPanePr4 = props.citationPaneProps) === null || _props$citationPanePr4 === void 0 ? void 0 : _props$citationPanePr4.styleProps
+  }));
 };
 exports.WebChatContainerStateful = WebChatContainerStateful;
 var _default = WebChatContainerStateful;

package/lib/cjs/components/webchatcontainerstateful/interfaces/ICitation.js

@@ -0,0 +1 @@
+"use strict";

package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/citationsMiddleware.js

@@ -0,0 +1,139 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createCitationsMiddleware = void 0;
+var _TelemetryConstants = require("../../../../../common/telemetry/TelemetryConstants");
+var _LiveChatWidgetActionType = require("../../../../../contexts/common/LiveChatWidgetActionType");
+var _TelemetryHelper = require("../../../../../common/telemetry/TelemetryHelper");
+var _createReducer = require("../../../../../contexts/createReducer");
+// Middleware that extracts citation metadata from incoming ACS activities and
+// updates in-memory app state with a global citation map. Also rewrites
+// per-message citation labels in the activity text to use a stable,
+// message-scoped prefix when the producer provides a message id.
+
+const createCitationsMiddleware = (state, dispatch) => () => next => action => {
+  var _action$payload;
+  if ((_action$payload = action.payload) !== null && _action$payload !== void 0 && _action$payload.activity) {
+    if (isApplicable(action)) {
+      try {
+        var _action$payload2, _action$payload2$acti, _gptFeedback$summariz, _gptFeedback$summariz2;
+        const inMemoryState = (0, _createReducer.executeReducer)(state, {
+          type: _LiveChatWidgetActionType.LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
+          payload: null
+        });
+
+        // Use the producer-supplied messageid as a stable per-message prefix
+        // when present. Do not derive a prefix from activity.id or timestamps.
+        const messagePrefix = ((_action$payload2 = action.payload) === null || _action$payload2 === void 0 ? void 0 : (_action$payload2$acti = _action$payload2.activity) === null || _action$payload2$acti === void 0 ? void 0 : _action$payload2$acti.messageid) ?? "";
+        const gptFeedback = JSON.parse(action.payload.activity.channelData.metadata["pva:gpt-feedback"]);
+        // Extract citation objects from the model response
+        const citations = (_gptFeedback$summariz = gptFeedback.summarizationOpenAIResponse) === null || _gptFeedback$summariz === void 0 ? void 0 : (_gptFeedback$summariz2 = _gptFeedback$summariz.result) === null || _gptFeedback$summariz2 === void 0 ? void 0 : _gptFeedback$summariz2.textCitations;
+        // Rewrite inline citation labels in activity.text to match the global map keys
+        const updatedText = replaceCitations(action.payload.activity.text, citations, messagePrefix);
+        action.payload.activity.text = updatedText;
+        // Build a global citation map keyed by the prefixed citation id and
+        // dispatch it to app state so the UI container can render citations.
+        try {
+          var _inMemoryState$domain;
+          const citationMap = {};
+          if (citations && Array.isArray(citations)) {
+            citations.forEach(citation => {
+              if (citation !== null && citation !== void 0 && citation.id) {
+                // Preserve the 'cite:' scheme so renderer click handling remains consistent
+                const idWithoutScheme = citation.id.replace(/^cite:/, "");
+                const prefixedId = `cite:${messagePrefix}_${idWithoutScheme}`;
+                citationMap[prefixedId] = citation.text || citation.title || "";
+              }
+            });
+          }
+
+          // Read current in-memory state to merge with existing citations
+          //const inMemoryState = executeReducer(state, { type: LiveChatWidgetActionType.GET_IN_MEMORY_STATE, payload: null });
+          const existingCitations = (inMemoryState === null || inMemoryState === void 0 ? void 0 : (_inMemoryState$domain = inMemoryState.domainStates) === null || _inMemoryState$domain === void 0 ? void 0 : _inMemoryState$domain.citations) || {};
+          const updatedCitations = {
+            ...existingCitations,
+            ...citationMap
+          };
+          // Always dispatch to app state
+          dispatch({
+            type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CITATIONS,
+            payload: updatedCitations
+          });
+        } catch (innerErr) {
+          _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.WARN, {
+            Event: _TelemetryConstants.TelemetryEvent.CitationMiddlewareFailed,
+            ExceptionDetails: {
+              ErrorData: "Error while populating citation map",
+              Exception: innerErr
+            }
+          });
+        }
+      } catch (error) {
+        _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.ERROR, {
+          Event: _TelemetryConstants.TelemetryEvent.CitationMiddlewareFailed,
+          ExceptionDetails: {
+            ErrorData: "Error while converting citation labels",
+            Exception: error
+          }
+        });
+      }
+    }
+  }
+  return next(action);
+};
+exports.createCitationsMiddleware = createCitationsMiddleware;
+const isApplicable = action => {
+  var _action$payload3, _action$payload3$acti, _action$payload4, _action$payload4$acti;
+  if ((action === null || action === void 0 ? void 0 : (_action$payload3 = action.payload) === null || _action$payload3 === void 0 ? void 0 : (_action$payload3$acti = _action$payload3.activity) === null || _action$payload3$acti === void 0 ? void 0 : _action$payload3$acti.actionType) === "DIRECT_LINE/INCOMING_ACTIVITY" && (action === null || action === void 0 ? void 0 : (_action$payload4 = action.payload) === null || _action$payload4 === void 0 ? void 0 : (_action$payload4$acti = _action$payload4.activity) === null || _action$payload4$acti === void 0 ? void 0 : _action$payload4$acti.channelId) === "ACS_CHANNEL") {
+    var _action$payload5, _action$payload5$acti, _action$payload5$acti2, _action$payload5$acti3;
+    // Only applicable for ACS incoming activities that include pva:gpt-feedback
+    if (action !== null && action !== void 0 && (_action$payload5 = action.payload) !== null && _action$payload5 !== void 0 && (_action$payload5$acti = _action$payload5.activity) !== null && _action$payload5$acti !== void 0 && (_action$payload5$acti2 = _action$payload5$acti.channelData) !== null && _action$payload5$acti2 !== void 0 && (_action$payload5$acti3 = _action$payload5$acti2.metadata) !== null && _action$payload5$acti3 !== void 0 && _action$payload5$acti3["pva:gpt-feedback"]) {
+      return true;
+    }
+  }
+  return false;
+};
+const replaceCitations = (text, citations, messagePrefix) => {
+  if (!citations || !Array.isArray(citations)) {
+    return text;
+  }
+  try {
+    let updatedText = text;
+
+    // First, handle the citation reference definitions at the end (e.g., [1]: cite:1757450535119_1 "index.html")
+    // These should NOT be escaped as they are proper citation definitions
+    updatedText = updatedText.replace(/\[(\d+)\]:\s(cite:\d+)\s"([^\\"]+)"/g, (match, number, citeId) => {
+      // Attempt to find a citation object matching the inline cite id and
+      // update the displayed id/title. When a messagePrefix exists we
+      // rewrite the id to the prefixed form so it aligns with the
+      // global citation map keys.
+      const lookupId = citeId;
+      const citation = citations.find(c => c.id === lookupId);
+      if (citation) {
+        const idWithoutScheme = citeId.replace(/^cite:/, "");
+        const prefixed = messagePrefix ? `cite:${messagePrefix}_${idWithoutScheme}` : citeId;
+        return `[${number}]: ${prefixed} "${citation.title}"`;
+      }
+      return match;
+    });
+
+    // Second, escape inline citation references that are NOT followed by a colon
+    // This handles cases like "[1][2]"" in the middle of text that should be escaped for markdown
+    updatedText = updatedText.replace(/\[(\d+)\](?!:)/g, (match, number) => {
+      // Escape the brackets to prevent markdown from treating them as incomplete link syntax
+      return `[${number}]`;
+    });
+    return updatedText;
+  } catch (error) {
+    _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.ERROR, {
+      Event: _TelemetryConstants.TelemetryEvent.CitationMiddlewareFailed,
+      ExceptionDetails: {
+        ErrorData: "Error while finding citations references",
+        Exception: error
+      }
+    });
+    return text;
+  }
+};

package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/localizedStringsBotInitialsMiddleware.js

@@ -0,0 +1,54 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.localizedStringsBotInitialsMiddleware = exports.getOverriddenLocalizedStrings = void 0;
+var _Constants = require("../../../../../common/Constants");
+var _utils = require("../../../../../common/utils");
+var _defaultWebChatStyles = require("../../../common/defaultStyles/defaultWebChatStyles");
+var _WebChatActionType = require("../../enums/WebChatActionType");
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+let currentAgentInitials = _defaultWebChatStyles.defaultWebChatStyles.botAvatarInitials;
+const localizedStringsBotInitialsMiddleware = () => _ref => {
+  let {
+    dispatch
+  } = _ref;
+  return next => action => {
+    if (action.type === _WebChatActionType.WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY) {
+      var _action$payload, _activity$from;
+      const activity = (_action$payload = action.payload) === null || _action$payload === void 0 ? void 0 : _action$payload.activity;
+      if (activity !== null && activity !== void 0 && (_activity$from = activity.from) !== null && _activity$from !== void 0 && _activity$from.name && activity.from.role !== _Constants.Constants.userMessageTag && activity.from.name !== _Constants.Constants.userMessageTag) {
+        var _activity$channelData, _activity$channelData2, _activity$tags;
+        const agentName = activity.from.name.trim();
+        const isSystemMessage = agentName === "__agent__" || agentName.startsWith("__") || ((_activity$channelData = activity.channelData) === null || _activity$channelData === void 0 ? void 0 : (_activity$channelData2 = _activity$channelData.tags) === null || _activity$channelData2 === void 0 ? void 0 : _activity$channelData2.includes(_Constants.Constants.systemMessageTag)) || ((_activity$tags = activity.tags) === null || _activity$tags === void 0 ? void 0 : _activity$tags.includes(_Constants.Constants.systemMessageTag));
+        if (!isSystemMessage && agentName !== "") {
+          // Update initials for valid agent/bot names
+          const newInitials = (0, _utils.getIconText)(agentName) || currentAgentInitials;
+          currentAgentInitials = newInitials;
+        }
+      }
+    }
+    return next(action);
+  };
+};
+exports.localizedStringsBotInitialsMiddleware = localizedStringsBotInitialsMiddleware;
+const getOverriddenLocalizedStrings = existingOverrides => {
+  return strings => {
+    const result = {
+      ...strings,
+      ...existingOverrides
+    };
+
+    // Apply dynamic bot initials to alt text if not already overridden through props
+    if (!(existingOverrides !== null && existingOverrides !== void 0 && existingOverrides.ACTIVITY_BOT_SAID_ALT)) {
+      result.ACTIVITY_BOT_SAID_ALT = `${currentAgentInitials} said:`;
+    }
+    if (!(existingOverrides !== null && existingOverrides !== void 0 && existingOverrides.ACTIVITY_BOT_ATTACHED_ALT)) {
+      result.ACTIVITY_BOT_ATTACHED_ALT = `${currentAgentInitials} attached:`;
+    }
+    return result;
+  };
+};
+exports.getOverriddenLocalizedStrings = getOverriddenLocalizedStrings;

package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/queueOverflowHandlerMiddleware.js

@@ -4,10 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createQueueOverflowMiddleware = void 0;
-var _WebChatActionType = require("../../enums/WebChatActionType");
 var _TelemetryConstants = require("../../../../../common/telemetry/TelemetryConstants");
-var _TelemetryHelper = require("../../../../../common/telemetry/TelemetryHelper");
 var _LiveChatWidgetActionType = require("../../../../../contexts/common/LiveChatWidgetActionType");
+var _TelemetryHelper = require("../../../../../common/telemetry/TelemetryHelper");
+var _WebChatActionType = require("../../enums/WebChatActionType");
 var _createReducer = require("../../../../../contexts/createReducer");
 var _utils = require("../../../../../common/utils");
 const queueOverflowHandlingHelper = async (state, dispatch) => {

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

@@ -10,49 +10,50 @@ exports.LiveChatWidgetActionType = LiveChatWidgetActionType;
   LiveChatWidgetActionType[LiveChatWidgetActionType["SET_WIDGET_ELEMENT_ID"] = 0] = "SET_WIDGET_ELEMENT_ID";
   LiveChatWidgetActionType[LiveChatWidgetActionType["SET_RENDERING_MIDDLEWARE_PROPS"] = 1] = "SET_RENDERING_MIDDLEWARE_PROPS";
   LiveChatWidgetActionType[LiveChatWidgetActionType["SET_MIDDLEWARE_LOCALIZED_TEXTS"] = 2] = "SET_MIDDLEWARE_LOCALIZED_TEXTS";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_GLOBAL_DIR"] = 3] = "SET_GLOBAL_DIR";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_MINIMIZED"] = 4] = "SET_MINIMIZED";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATION_STATE"] = 5] = "SET_CONVERSATION_STATE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_PREVIOUS_FOCUSED_ELEMENT_ID"] = 6] = "SET_PREVIOUS_FOCUSED_ELEMENT_ID";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_START_CHAT_FAILING"] = 7] = "SET_START_CHAT_FAILING";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_START_CHAT_FAILURE_TYPE"] = 8] = "SET_START_CHAT_FAILURE_TYPE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_OUTSIDE_OPERATING_HOURS"] = 9] = "SET_OUTSIDE_OPERATING_HOURS";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_PRE_CHAT_SURVEY_RESPONSE"] = 10] = "SET_PRE_CHAT_SURVEY_RESPONSE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CUSTOM_CONTEXT"] = 11] = "SET_CUSTOM_CONTEXT";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SHOW_CONFIRMATION"] = 12] = "SET_SHOW_CONFIRMATION";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SHOW_EMAIL_TRANSCRIPT_PANE"] = 13] = "SET_SHOW_EMAIL_TRANSCRIPT_PANE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_PRECHAT_RESPONSE_EMAIL"] = 14] = "SET_PRECHAT_RESPONSE_EMAIL";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_AUDIO_NOTIFICATION"] = 15] = "SET_AUDIO_NOTIFICATION";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_E2VV_ENABLED"] = 16] = "SET_E2VV_ENABLED";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_POST_CHAT_CONTEXT"] = 17] = "SET_POST_CHAT_CONTEXT";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SHOW_CALLING_CONTAINER"] = 18] = "SHOW_CALLING_CONTAINER";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_INCOMING_CALL"] = 19] = "SET_INCOMING_CALL";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["DISABLE_VIDEO_CALL"] = 20] = "DISABLE_VIDEO_CALL";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["DISABLE_LOCAL_VIDEO"] = 21] = "DISABLE_LOCAL_VIDEO";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["DISABLE_REMOTE_VIDEO"] = 22] = "DISABLE_REMOTE_VIDEO";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CHAT_TOKEN"] = 23] = "SET_CHAT_TOKEN";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_START_CHAT_BUTTON_DISPLAY"] = 24] = "SET_START_CHAT_BUTTON_DISPLAY";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_PROACTIVE_CHAT_PARAMS"] = 25] = "SET_PROACTIVE_CHAT_PARAMS";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_TELEMETRY_DATA"] = 26] = "SET_TELEMETRY_DATA";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_RECONNECT_ID"] = 27] = "SET_RECONNECT_ID";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_UNREAD_MESSAGE_COUNT"] = 28] = "SET_UNREAD_MESSAGE_COUNT";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_FOCUS_CHAT_BUTTON"] = 29] = "SET_FOCUS_CHAT_BUTTON";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATION_ENDED_BY_AGENT_EVENT_RECEIVED"] = 30] = "SET_CONVERSATION_ENDED_BY_AGENT_EVENT_RECEIVED";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATION_ENDED_BY"] = 31] = "SET_CONVERSATION_ENDED_BY";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_WIDGET_STATE"] = 32] = "SET_WIDGET_STATE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_LIVE_CHAT_CONTEXT"] = 33] = "SET_LIVE_CHAT_CONTEXT";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_BOT_OAUTH_SIGNIN_ID"] = 34] = "SET_BOT_OAUTH_SIGNIN_ID";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_WIDGET_SIZE"] = 35] = "SET_WIDGET_SIZE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_WIDGET_INSTANCE_ID"] = 36] = "SET_WIDGET_INSTANCE_ID";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_LIVE_CHAT_CONFIG"] = 37] = "SET_LIVE_CHAT_CONFIG";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_POST_CHAT_WORKFLOW_IN_PROGRESS"] = 38] = "SET_POST_CHAT_WORKFLOW_IN_PROGRESS";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_INITIAL_CHAT_SDK_REQUEST_ID"] = 39] = "SET_INITIAL_CHAT_SDK_REQUEST_ID";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SHOULD_USE_BOT_SURVEY"] = 40] = "SET_SHOULD_USE_BOT_SURVEY";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CHAT_DISCONNECT_EVENT_RECEIVED"] = 41] = "SET_CHAT_DISCONNECT_EVENT_RECEIVED";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SURVEY_MODE"] = 42] = "SET_SURVEY_MODE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONFIRMATION_STATE"] = 43] = "SET_CONFIRMATION_STATE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_POST_CHAT_PARTICIPANT_TYPE"] = 44] = "SET_POST_CHAT_PARTICIPANT_TYPE";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATIONAL_SURVEY_ENABLED"] = 45] = "SET_CONVERSATIONAL_SURVEY_ENABLED";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATIONAL_SURVEY_DISPLAY"] = 46] = "SET_CONVERSATIONAL_SURVEY_DISPLAY";
-  LiveChatWidgetActionType[LiveChatWidgetActionType["GET_IN_MEMORY_STATE"] = 47] = "GET_IN_MEMORY_STATE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CITATIONS"] = 3] = "SET_CITATIONS";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_GLOBAL_DIR"] = 4] = "SET_GLOBAL_DIR";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_MINIMIZED"] = 5] = "SET_MINIMIZED";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATION_STATE"] = 6] = "SET_CONVERSATION_STATE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_PREVIOUS_FOCUSED_ELEMENT_ID"] = 7] = "SET_PREVIOUS_FOCUSED_ELEMENT_ID";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_START_CHAT_FAILING"] = 8] = "SET_START_CHAT_FAILING";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_START_CHAT_FAILURE_TYPE"] = 9] = "SET_START_CHAT_FAILURE_TYPE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_OUTSIDE_OPERATING_HOURS"] = 10] = "SET_OUTSIDE_OPERATING_HOURS";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_PRE_CHAT_SURVEY_RESPONSE"] = 11] = "SET_PRE_CHAT_SURVEY_RESPONSE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CUSTOM_CONTEXT"] = 12] = "SET_CUSTOM_CONTEXT";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SHOW_CONFIRMATION"] = 13] = "SET_SHOW_CONFIRMATION";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SHOW_EMAIL_TRANSCRIPT_PANE"] = 14] = "SET_SHOW_EMAIL_TRANSCRIPT_PANE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_PRECHAT_RESPONSE_EMAIL"] = 15] = "SET_PRECHAT_RESPONSE_EMAIL";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_AUDIO_NOTIFICATION"] = 16] = "SET_AUDIO_NOTIFICATION";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_E2VV_ENABLED"] = 17] = "SET_E2VV_ENABLED";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_POST_CHAT_CONTEXT"] = 18] = "SET_POST_CHAT_CONTEXT";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SHOW_CALLING_CONTAINER"] = 19] = "SHOW_CALLING_CONTAINER";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_INCOMING_CALL"] = 20] = "SET_INCOMING_CALL";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["DISABLE_VIDEO_CALL"] = 21] = "DISABLE_VIDEO_CALL";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["DISABLE_LOCAL_VIDEO"] = 22] = "DISABLE_LOCAL_VIDEO";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["DISABLE_REMOTE_VIDEO"] = 23] = "DISABLE_REMOTE_VIDEO";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CHAT_TOKEN"] = 24] = "SET_CHAT_TOKEN";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_START_CHAT_BUTTON_DISPLAY"] = 25] = "SET_START_CHAT_BUTTON_DISPLAY";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_PROACTIVE_CHAT_PARAMS"] = 26] = "SET_PROACTIVE_CHAT_PARAMS";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_TELEMETRY_DATA"] = 27] = "SET_TELEMETRY_DATA";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_RECONNECT_ID"] = 28] = "SET_RECONNECT_ID";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_UNREAD_MESSAGE_COUNT"] = 29] = "SET_UNREAD_MESSAGE_COUNT";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_FOCUS_CHAT_BUTTON"] = 30] = "SET_FOCUS_CHAT_BUTTON";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATION_ENDED_BY_AGENT_EVENT_RECEIVED"] = 31] = "SET_CONVERSATION_ENDED_BY_AGENT_EVENT_RECEIVED";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATION_ENDED_BY"] = 32] = "SET_CONVERSATION_ENDED_BY";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_WIDGET_STATE"] = 33] = "SET_WIDGET_STATE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_LIVE_CHAT_CONTEXT"] = 34] = "SET_LIVE_CHAT_CONTEXT";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_BOT_OAUTH_SIGNIN_ID"] = 35] = "SET_BOT_OAUTH_SIGNIN_ID";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_WIDGET_SIZE"] = 36] = "SET_WIDGET_SIZE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_WIDGET_INSTANCE_ID"] = 37] = "SET_WIDGET_INSTANCE_ID";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_LIVE_CHAT_CONFIG"] = 38] = "SET_LIVE_CHAT_CONFIG";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_POST_CHAT_WORKFLOW_IN_PROGRESS"] = 39] = "SET_POST_CHAT_WORKFLOW_IN_PROGRESS";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_INITIAL_CHAT_SDK_REQUEST_ID"] = 40] = "SET_INITIAL_CHAT_SDK_REQUEST_ID";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SHOULD_USE_BOT_SURVEY"] = 41] = "SET_SHOULD_USE_BOT_SURVEY";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CHAT_DISCONNECT_EVENT_RECEIVED"] = 42] = "SET_CHAT_DISCONNECT_EVENT_RECEIVED";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_SURVEY_MODE"] = 43] = "SET_SURVEY_MODE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONFIRMATION_STATE"] = 44] = "SET_CONFIRMATION_STATE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_POST_CHAT_PARTICIPANT_TYPE"] = 45] = "SET_POST_CHAT_PARTICIPANT_TYPE";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATIONAL_SURVEY_ENABLED"] = 46] = "SET_CONVERSATIONAL_SURVEY_ENABLED";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATIONAL_SURVEY_DISPLAY"] = 47] = "SET_CONVERSATIONAL_SURVEY_DISPLAY";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["GET_IN_MEMORY_STATE"] = 48] = "GET_IN_MEMORY_STATE";
 })(LiveChatWidgetActionType || (exports.LiveChatWidgetActionType = LiveChatWidgetActionType = {}));

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/util.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.polyfillMessagePayloadForEvent = exports.isHistoryMessage = exports.getScenarioType = exports.extractTimestampFromId = exports.createTrackingMessage = exports.buildMessagePayload = void 0;
+exports.polyfillMessagePayloadForEvent = exports.maskPayloadText = exports.isHistoryMessage = exports.getScenarioType = exports.extractTimestampFromId = exports.createTrackingMessage = exports.buildMessagePayload = void 0;
 var _Constants = require("./Constants");
 var _Constants2 = require("../common/Constants");
 const DELTA_WITHIN_LIMITS_IN_MS = 250;
@@ -126,4 +126,14 @@ const createTrackingMessage = (payload, type) => {
     checkTime: new Date().getTime()
   };
 };
-exports.createTrackingMessage = createTrackingMessage;
+exports.createTrackingMessage = createTrackingMessage;
+const maskPayloadText = payload => {
+  if (!payload) {
+    return payload;
+  }
+  return {
+    ...payload,
+    text: "*contents hidden*"
+  };
+};
+exports.maskPayloadText = maskPayloadText;

package/lib/cjs/plugins/newMessageEventHandler.js

@@ -71,7 +71,7 @@ const createOnNewAdapterActivityHandler = (chatId, userId, startTime) => {
       _TelemetryHelper.TelemetryHelper.logActionEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {
         Event: _TelemetryConstants.TelemetryEvent.RehydrateMessageReceived,
         Description: "History message received",
-        CustomProperties: payload
+        CustomProperties: (0, _util.maskPayloadText)(payload)
       });
     }
   };
@@ -108,7 +108,7 @@ const createOnNewAdapterActivityHandler = (chatId, userId, startTime) => {
     _TelemetryHelper.TelemetryHelper.logActionEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {
       Event: _TelemetryConstants.TelemetryEvent.MessageReceived,
       Description: "New message received",
-      CustomProperties: payload
+      CustomProperties: (0, _util.maskPayloadText)(payload)
     });
   };
   const raiseMessageEvent = activity => {

package/lib/esm/common/Constants.js

@@ -184,6 +184,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/telemetry/TelemetryConstants.js

@@ -148,6 +148,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";
@@ -189,6 +190,7 @@ export let TelemetryEvent;
   TelemetryEvent["ProcessingSanitizationMiddlewareFailed"] = "ProcessingSanitizationMiddlewareFailed";
   TelemetryEvent["FormatTagsMiddlewareJSONStringifyFailed"] = "FormatTagsMiddlewareJSONStringifyFailed";
   TelemetryEvent["AttachmentUploadValidatorMiddlewareFailed"] = "AttachmentUploadValidatorMiddlewareFailed";
+  TelemetryEvent["CitationMiddlewareFailed"] = "CitationMiddlewareFailed";
   TelemetryEvent["QueuePositionMessageRecieved"] = "QueuePositionMessageRecieved";
   TelemetryEvent["AverageWaitTimeMessageRecieved"] = "AverageWaitTimeMessageRecieved";
   TelemetryEvent["DataMaskingRuleApplied"] = "DataMaskingRuleApplied";
@@ -273,7 +275,9 @@ 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["AppInsightsInitialized"] = "AppInsightsInitialized";

package/lib/esm/components/citationpanestateful/CitationDim.js

@@ -0,0 +1,20 @@
+import React from "react";
+import ReactDOM from "react-dom";
+import { DimLayer } from "../dimlayer/DimLayer";
+const CONTAINER_SELECTOR = ".webchat__stacked-layout_container";
+export const CitationDim = _ref => {
+  let {
+    brightness = "0.2"
+  } = _ref;
+  const container = document.querySelector(CONTAINER_SELECTOR);
+  if (!container) return null;
+  return /*#__PURE__*/ReactDOM.createPortal( /*#__PURE__*/React.createElement("div", {
+    style: {
+      position: "absolute",
+      inset: 0
+    }
+  }, /*#__PURE__*/React.createElement(DimLayer, {
+    brightness: brightness
+  })), container);
+};
+export default CitationDim;