@microsoft/omnichannel-chat-widget 1.8.2 → 1.8.3-main.1381896

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

@@ -0,0 +1,133 @@
+import { LogLevel, TelemetryEvent } from "../../../../../common/telemetry/TelemetryConstants";
+import { LiveChatWidgetActionType } from "../../../../../contexts/common/LiveChatWidgetActionType";
+import { TelemetryHelper } from "../../../../../common/telemetry/TelemetryHelper";
+import { executeReducer } from "../../../../../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.
+
+export 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 = executeReducer(state, {
+          type: 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.SET_CITATIONS,
+            payload: updatedCitations
+          });
+        } catch (innerErr) {
+          TelemetryHelper.logActionEvent(LogLevel.WARN, {
+            Event: TelemetryEvent.CitationMiddlewareFailed,
+            ExceptionDetails: {
+              ErrorData: "Error while populating citation map",
+              Exception: innerErr
+            }
+          });
+        }
+      } catch (error) {
+        TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+          Event: TelemetryEvent.CitationMiddlewareFailed,
+          ExceptionDetails: {
+            ErrorData: "Error while converting citation labels",
+            Exception: error
+          }
+        });
+      }
+    }
+  }
+  return next(action);
+};
+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.logActionEvent(LogLevel.ERROR, {
+      Event: TelemetryEvent.CitationMiddlewareFailed,
+      ExceptionDetails: {
+        ErrorData: "Error while finding citations references",
+        Exception: error
+      }
+    });
+    return text;
+  }
+};

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

@@ -0,0 +1,46 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { Constants } from "../../../../../common/Constants";
+import { getIconText } from "../../../../../common/utils";
+import { defaultWebChatStyles } from "../../../common/defaultStyles/defaultWebChatStyles";
+import { WebChatActionType } from "../../enums/WebChatActionType";
+let currentAgentInitials = defaultWebChatStyles.botAvatarInitials;
+export const localizedStringsBotInitialsMiddleware = () => _ref => {
+  let {
+    dispatch
+  } = _ref;
+  return next => action => {
+    if (action.type === 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.userMessageTag && activity.from.name !== 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.systemMessageTag)) || ((_activity$tags = activity.tags) === null || _activity$tags === void 0 ? void 0 : _activity$tags.includes(Constants.systemMessageTag));
+        if (!isSystemMessage && agentName !== "") {
+          // Update initials for valid agent/bot names
+          const newInitials = getIconText(agentName) || currentAgentInitials;
+          currentAgentInitials = newInitials;
+        }
+      }
+    }
+    return next(action);
+  };
+};
+export 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;
+  };
+};

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

@@ -1,7 +1,7 @@
-import { WebChatActionType } from "../../enums/WebChatActionType";
 import { LogLevel, TelemetryEvent } from "../../../../../common/telemetry/TelemetryConstants";
-import { TelemetryHelper } from "../../../../../common/telemetry/TelemetryHelper";
 import { LiveChatWidgetActionType } from "../../../../../contexts/common/LiveChatWidgetActionType";
+import { TelemetryHelper } from "../../../../../common/telemetry/TelemetryHelper";
+import { WebChatActionType } from "../../enums/WebChatActionType";
 import { executeReducer } from "../../../../../contexts/createReducer";
 import { isEndConversationDueToOverflowActivity } from "../../../../../common/utils";
 const queueOverflowHandlingHelper = async (state, dispatch) => {

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

@@ -3,49 +3,50 @@ export let 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 || (LiveChatWidgetActionType = {}));

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

@@ -39,6 +39,8 @@ export 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,
       preChatSurveyResponse: "{}",

package/lib/esm/contexts/createReducer.js

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

package/lib/esm/firstresponselatency/util.js

@@ -114,4 +114,13 @@ export const createTrackingMessage = (payload, type) => {
     type: type,
     checkTime: new Date().getTime()
   };
+};
+export const maskPayloadText = payload => {
+  if (!payload) {
+    return payload;
+  }
+  return {
+    ...payload,
+    text: "*contents hidden*"
+  };
 };

package/lib/esm/index.js

@@ -7,5 +7,6 @@ import useFacadeChatSDKStore from "./hooks/useFacadeChatSDKStore";
 export { default as LiveChatWidget } from "./components/livechatwidget/LiveChatWidget";
 export { getMockChatSDKIfApplicable } from "./components/livechatwidget/common/getMockChatSDKIfApplicable";
 export { getWidgetCacheId, getWidgetEndChatEventName, ConversationState };
+export { LiveChatWidgetMockType } from "./components/livechatwidget/interfaces/IMockProps";
 export { encodeComponentString, decodeComponentString, BroadcastService, useChatSDKStore, useChatContextStore, useFacadeChatSDKStore };
 export * from "./components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares";

package/lib/esm/plugins/newMessageEventHandler.js

@@ -1,6 +1,6 @@
 import { BroadcastEvent, LogLevel, TelemetryEvent } from "../common/telemetry/TelemetryConstants";
 import { ScenarioType } from "../firstresponselatency/Constants";
-import { buildMessagePayload, getScenarioType, isHistoryMessage, polyfillMessagePayloadForEvent } from "../firstresponselatency/util";
+import { buildMessagePayload, getScenarioType, isHistoryMessage, maskPayloadText, polyfillMessagePayloadForEvent } from "../firstresponselatency/util";
 import { BroadcastService } from "@microsoft/omnichannel-chat-components";
 import { Constants } from "../common/Constants";
 import { FirstResponseLatencyTracker } from "../firstresponselatency/FirstResponseLatencyTracker";
@@ -65,7 +65,7 @@ export const createOnNewAdapterActivityHandler = (chatId, userId, startTime) =>
       TelemetryHelper.logActionEventToAllTelemetry(LogLevel.INFO, {
         Event: TelemetryEvent.RehydrateMessageReceived,
         Description: "History message received",
-        CustomProperties: payload
+        CustomProperties: maskPayloadText(payload)
       });
     }
   };
@@ -102,7 +102,7 @@ export const createOnNewAdapterActivityHandler = (chatId, userId, startTime) =>
     TelemetryHelper.logActionEventToAllTelemetry(LogLevel.INFO, {
       Event: TelemetryEvent.MessageReceived,
       Description: "New message received",
-      CustomProperties: payload
+      CustomProperties: maskPayloadText(payload)
     });
   };
   const raiseMessageEvent = activity => {

package/lib/types/common/Constants.d.ts

@@ -153,6 +153,8 @@ export declare class HtmlAttributeNames {
     static readonly adaptiveCardTextBlockClassName = "ac-textBlock";
     static readonly adaptiveCardToggleInputClassName = "ac-toggleInput";
     static readonly adaptiveCardActionSetClassName = "ac-actionSet";
+    static readonly ocwCitationPaneClassName = "ocw-citation-pane";
+    static readonly ocwCitationPaneTitle = "Citation";
 }
 export declare class WebChatMiddlewareConstants {
     static readonly nextVisibleActivity = "nextVisibleActivity";

package/lib/types/common/telemetry/TelemetryConstants.d.ts

@@ -136,6 +136,7 @@ export declare enum TelemetryEvent {
     EmailTranscriptLoaded = "EmailTranscriptLoaded",
     OutOfOfficePaneLoaded = "OutOfOfficePaneLoaded",
     ConfirmationPaneLoaded = "ConfirmationPaneLoaded",
+    CitationPaneLoaded = "CitationPaneLoaded",
     ProactiveChatPaneLoaded = "ProactiveChatPaneLoaded",
     ReconnectChatPaneLoaded = "ReconnectChatPaneLoaded",
     HeaderCloseButtonClicked = "HeaderCloseButtonClicked",
@@ -177,6 +178,7 @@ export declare enum TelemetryEvent {
     ProcessingSanitizationMiddlewareFailed = "ProcessingSanitizationMiddlewareFailed",
     FormatTagsMiddlewareJSONStringifyFailed = "FormatTagsMiddlewareJSONStringifyFailed",
     AttachmentUploadValidatorMiddlewareFailed = "AttachmentUploadValidatorMiddlewareFailed",
+    CitationMiddlewareFailed = "CitationMiddlewareFailed",
     QueuePositionMessageRecieved = "QueuePositionMessageRecieved",
     AverageWaitTimeMessageRecieved = "AverageWaitTimeMessageRecieved",
     DataMaskingRuleApplied = "DataMaskingRuleApplied",
@@ -261,7 +263,9 @@ export declare enum TelemetryEvent {
     UXLCWChatButtonLoadingStart = "UXLCWChatButtonLoadingStart",
     UXLCWChatButtonLoadingCompleted = "UXLCWChatButtonLoadingCompleted",
     UXConfirmationPaneStart = "UXConfirmationPaneStart",
+    UXCitationPaneStart = "UXCitationPaneStart",
     UXConfirmationPaneCompleted = "UXConfirmationPaneCompleted",
+    UXCitationPaneCompleted = "UXCitationPaneCompleted",
     UXLiveChatWidgetStart = "UXLiveChatWidgetStart",
     UXLiveChatWidgetCompleted = "UXLiveChatWidgetCompleted",
     AppInsightsInitialized = "AppInsightsInitialized",

package/lib/types/components/citationpanestateful/CitationDim.d.ts

@@ -0,0 +1,5 @@
+import React from "react";
+export declare const CitationDim: React.FC<{
+    brightness?: string;
+}>;
+export default CitationDim;

package/lib/types/components/citationpanestateful/CitationPaneStateful.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { ICitationPaneStatefulProps } from "./interfaces/ICitationPaneStatefulProps";
+export declare const CitationPaneStateful: (props: ICitationPaneStatefulProps) => React.JSX.Element;
+export default CitationPaneStateful;

package/lib/types/components/citationpanestateful/common/defaultProps/defaultCitationPaneProps.d.ts

@@ -0,0 +1,11 @@
+export declare const defaultCitationPaneStyles: {
+    pane: React.CSSProperties;
+};
+export declare const defaultCitationContentCSS: (controlId: string) => string;
+declare const _default: {
+    defaultCitationPaneStyles: {
+        pane: React.CSSProperties;
+    };
+    defaultCitationContentCSS: (controlId: string) => string;
+};
+export default _default;

package/lib/types/components/citationpanestateful/interfaces/ICitationPaneStatefulProps.d.ts

@@ -0,0 +1,19 @@
+import { ICitationPaneProps } from "@microsoft/omnichannel-chat-components/lib/types/components/citationpane/interfaces/ICitationPaneProps";
+export interface ICitationPaneStatefulProps extends ICitationPaneProps {
+    /**
+     * id: Optional custom ID for the citation pane container
+     */
+    id?: string;
+    /**
+     * title: Optional title for the citation pane
+     */
+    title?: string;
+    /**
+     * onClose: Optional callback function called when the citation pane is closed
+     */
+    onClose?: () => void;
+    /**
+     * contentHtml: Optional HTML content to display in the citation pane
+     */
+    contentHtml?: string;
+}

package/lib/types/components/confirmationpanestateful/common/defaultProps/defaultConfirmationPaneLocalizedTexts.d.ts

@@ -1,2 +1,2 @@
-import { IConfirmationPaneLocalizedTexts } from "../../interfaces/IConfirmationPaneLocalizedText";
+import { IConfirmationPaneLocalizedTexts } from "../../interfaces/IConfirmationPaneLocalizedTexts";
 export declare const defaultConfirmationPaneLocalizedTexts: IConfirmationPaneLocalizedTexts;

package/lib/types/components/confirmationpanestateful/interfaces/IConfirmationPaneStatefulProps.d.ts

@@ -1,4 +1,4 @@
-import { IConfirmationPaneLocalizedTexts } from "./IConfirmationPaneLocalizedText";
+import { IConfirmationPaneLocalizedTexts } from "./IConfirmationPaneLocalizedTexts";
 import { IConfirmationPaneProps } from "@microsoft/omnichannel-chat-components/lib/types/components/confirmationpane/interfaces/IConfirmationPaneProps";
 export interface IConfirmationPaneStatefulProps extends IConfirmationPaneProps {
     /**

package/lib/types/components/livechatwidget/common/getMockChatSDKIfApplicable.d.ts

@@ -1 +1,2 @@
-export declare const getMockChatSDKIfApplicable: (chatSDK: any, type?: string) => any;
+import { IMockProps } from "../interfaces/IMockProps";
+export declare const getMockChatSDKIfApplicable: (chatSDK: any, mockProps?: IMockProps) => any;

package/lib/types/components/livechatwidget/interfaces/ILiveChatWidgetProps.d.ts

@@ -1,7 +1,9 @@
 import ChatConfig from "@microsoft/omnichannel-chat-sdk/lib/core/ChatConfig";
+import { IAppInsightsConfig } from "../../../common/telemetry/interfaces/IAppInsightsConfig";
 import { IAudioNotificationProps } from "../../footerstateful/audionotificationstateful/interfaces/IAudioNotificationProps";
 import { ICallingContainerProps } from "@microsoft/omnichannel-chat-components/lib/types/components/callingcontainer/interfaces/ICallingContainerProps";
 import { IChatButtonProps } from "@microsoft/omnichannel-chat-components/lib/types/components/chatbutton/interfaces/IChatButtonProps";
+import { ICitationPaneStatefulProps } from "../../citationpanestateful/interfaces/ICitationPaneStatefulProps";
 import { IConfirmationPaneStatefulProps } from "../../confirmationpanestateful/interfaces/IConfirmationPaneStatefulProps";
 import { IContextDataStore } from "../../../common/interfaces/IContextDataStore";
 import { IDownloadTranscriptProps } from "../../footerstateful/downloadtranscriptstateful/interfaces/IDownloadTranscriptProps";
@@ -27,7 +29,6 @@ import { IStartChatErrorPaneProps } from "../../startchaterrorpanestateful/inter
 import { ITelemetryConfig } from "../../../common/telemetry/interfaces/ITelemetryConfig";
 import { IWebChatContainerStatefulProps } from "../../webchatcontainerstateful/interfaces/IWebChatContainerStatefulProps";
 import { OmnichannelChatSDK } from "@microsoft/omnichannel-chat-sdk";
-import { IAppInsightsConfig } from "../../../common/telemetry/interfaces/IAppInsightsConfig";
 export interface ILiveChatWidgetProps {
     audioNotificationProps?: IAudioNotificationProps;
     callingContainerProps?: ICallingContainerProps;
@@ -51,6 +52,7 @@ export interface ILiveChatWidgetProps {
     preChatSurveyPaneProps?: IPreChatSurveyPaneProps;
     proactiveChatPaneProps?: IProactiveChatPaneStatefulProps;
     reconnectChatPaneProps?: IReconnectChatPaneStatefulProps;
+    citationPaneProps?: ICitationPaneStatefulProps;
     startChatErrorPaneProps?: IStartChatErrorPaneProps;
     styleProps?: ILiveChatWidgetStyleProps;
     telemetryConfig: ITelemetryConfig;

package/lib/types/components/livechatwidget/interfaces/IMockProps.d.ts

@@ -1,8 +1,10 @@
-declare enum LiveChatWidgetMockType {
+import { Message } from "botframework-directlinejs";
+export declare enum LiveChatWidgetMockType {
     Test = "Test",
-    Demo = "Demo"
+    Demo = "Demo",
+    Designer = "Designer"
 }
 export interface IMockProps {
     type: LiveChatWidgetMockType;
+    mockMessages?: Message[];
 }
-export {};

package/lib/types/components/webchatcontainerstateful/common/DesignerChatAdapter.d.ts

@@ -1,8 +1,10 @@
 import { Message } from "botframework-directlinejs";
-import { Observable } from "rxjs/Observable";
 import MockAdapter from "./mockadapter";
+import { Observable } from "rxjs/Observable";
 export declare class DesignerChatAdapter extends MockAdapter {
-    constructor();
+    messages?: Message[];
+    constructor(messages?: Message[]);
+    private processMessage;
     private postUserActivity;
     postActivity(activity: Message): Observable<string>;
 }

package/lib/types/components/webchatcontainerstateful/common/DesignerChatSDK.d.ts

@@ -1,7 +1,12 @@
 import { DesignerChatAdapter } from "./DesignerChatAdapter";
+import { Message } from "botframework-directlinejs";
 import { MockChatSDK } from "./mockchatsdk";
 export declare class DesignerChatSDK extends MockChatSDK {
     constructor();
+    /**
+     * Create a chat adapter for the designer. Uses this.mockMessages if set.
+     */
+    mockMessages?: Message[];
     createChatAdapter(): DesignerChatAdapter;
     localeId: string;
     /**

package/lib/types/components/webchatcontainerstateful/common/utils/chatAdapterUtils.d.ts

@@ -1,4 +1,4 @@
-import { Activity, Attachment, Message, User } from "botframework-directlinejs";
+import { Activity, Attachment, AttachmentLayout, CardAction, Message, User } from "botframework-directlinejs";
 import { Subscriber } from "rxjs/Subscriber";
 export declare const customerUser: User;
 export declare const botUser: User;
@@ -9,3 +9,8 @@ export declare const postAgentMessageActivity: (activityObserver: Subscriber<Act
 export declare const postSystemMessageActivity: (activityObserver: Subscriber<Activity> | undefined, text: string, delay?: number) => void;
 export declare const postBotTypingActivity: (activityObserver: Subscriber<Activity> | undefined, delay?: number) => void;
 export declare const postBotAttachmentActivity: (activityObserver: Subscriber<Activity> | undefined, attachments?: Attachment[], delay?: number) => void;
+export declare const postAgentAttachmentActivity: (activityObserver: Subscriber<Activity> | undefined, attachments?: Attachment[], delay?: number, attachmentLayout?: AttachmentLayout) => void;
+export declare const postAgentSuggestedActionsActivity: (activityObserver: Subscriber<Activity> | undefined, text: string, suggestedActions: {
+    actions: CardAction[];
+    to?: string[];
+}, delay?: number) => void;

package/lib/types/components/webchatcontainerstateful/common/utils/fontUtils.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Utility functions for font handling and emoji support
+ */
+/**
+ * Creates a font family optimized for iOS emoji support
+ * Uses system-ui as the primary font for better emoji rendering on iOS
+ * @param primaryFont - The base font family string (optional, used as fallback)
+ * @returns Font family string optimized for iOS emoji support
+ */
+export declare const createIOSOptimizedEmojiFont: (primaryFont?: string) => string;

package/lib/types/components/webchatcontainerstateful/interfaces/ICitation.d.ts

@@ -0,0 +1,12 @@
+export interface ICitation {
+    id: string;
+    text?: string;
+    title?: string;
+    type?: string;
+    position?: number;
+    entityType?: string;
+    entityContext?: string;
+    url?: string;
+    searchSourceId?: string;
+    chunkId?: string;
+}

package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/citationsMiddleware.d.ts

@@ -0,0 +1,4 @@
+import { ILiveChatWidgetAction } from "../../../../../contexts/common/ILiveChatWidgetAction";
+import { ILiveChatWidgetContext } from "../../../../../contexts/common/ILiveChatWidgetContext";
+import { IWebChatAction } from "../../../interfaces/IWebChatAction";
+export declare const createCitationsMiddleware: (state: ILiveChatWidgetContext, dispatch: (action: ILiveChatWidgetAction) => void) => () => (next: (action: IWebChatAction) => void) => (action: IWebChatAction) => void;

package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/localizedStringsBotInitialsMiddleware.d.ts

@@ -0,0 +1,5 @@
+import { IWebChatAction } from "../../../interfaces/IWebChatAction";
+export declare const localizedStringsBotInitialsMiddleware: () => ({ dispatch }: {
+    dispatch: any;
+}) => (next: any) => (action: IWebChatAction) => any;
+export declare const getOverriddenLocalizedStrings: (existingOverrides?: any) => (strings: any) => any;

package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/queueOverflowHandlerMiddleware.d.ts

@@ -1,5 +1,5 @@
-import { IWebChatAction } from "../../../interfaces/IWebChatAction";
-import { ILiveChatWidgetContext } from "../../../../../contexts/common/ILiveChatWidgetContext";
 import { Dispatch } from "react";
 import { ILiveChatWidgetAction } from "../../../../../contexts/common/ILiveChatWidgetAction";
+import { ILiveChatWidgetContext } from "../../../../../contexts/common/ILiveChatWidgetContext";
+import { IWebChatAction } from "../../../interfaces/IWebChatAction";
 export declare const createQueueOverflowMiddleware: (state: ILiveChatWidgetContext, dispatch: Dispatch<ILiveChatWidgetAction>) => () => (next: (action: IWebChatAction) => void) => (action: IWebChatAction) => void;