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

package/lib/esm/plugins/newMessageEventHandler.js

@@ -6,13 +6,13 @@ import { Constants } from "../common/Constants";
 import { FirstResponseLatencyTracker } from "../firstresponselatency/FirstResponseLatencyTracker";
 import { TelemetryHelper } from "../common/telemetry/TelemetryHelper";
 import { TelemetryManager } from "../common/telemetry/TelemetryManager";
-export const createOnNewAdapterActivityHandler = (chatId, userId) => {
+export const createOnNewAdapterActivityHandler = (chatId, userId, startTime) => {
   // Hooking the message tracker in the listener, a bit invasive but easier to control.
   const firstResponseLatencyTracker = new FirstResponseLatencyTracker();
   // epoch time in utc for when start to listen.
   // We dont longer have a mechanism to know if a message is history or new, so any message older than the time we start listening will be considered a history message.
   // this is a workaround for the fact that we dont have a way to identify if a message is history or new, and it will provide consistency across different scenarios
-  const startTime = new Date().getTime();
+
   let isHistoryMessageReceivedEventRaised = false;
   const onNewAdapterActivityHandler = activity => {
     raiseMessageEvent(activity);
@@ -35,6 +35,7 @@ export const createOnNewAdapterActivityHandler = (chatId, userId) => {
     });
   };
   const systemMessageStrategy = activity => {
+    var _TelemetryManager$Int3;
     const payload = buildMessagePayload(activity, userId);
     payload.messageType = Constants.systemMessageTag;
     if (isHistoryMessage(activity, startTime)) {
@@ -42,6 +43,11 @@ export const createOnNewAdapterActivityHandler = (chatId, userId) => {
       historyMessageStrategy(polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int2 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int2 === void 0 ? void 0 : _TelemetryManager$Int2.conversationId));
       return;
     }
+    const newMessageReceivedEvent = {
+      eventName: BroadcastEvent.NewMessageReceived,
+      payload: polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int3 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int3 === void 0 ? void 0 : _TelemetryManager$Int3.conversationId)
+    };
+    BroadcastService.postMessage(newMessageReceivedEvent);
     TelemetryHelper.logActionEventToAllTelemetry(LogLevel.INFO, {
       Event: TelemetryEvent.SystemMessageReceived,
       Description: "System message received"
@@ -77,20 +83,20 @@ export const createOnNewAdapterActivityHandler = (chatId, userId) => {
     return true;
   };
   const receivedMessageStrategy = activity => {
-    var _TelemetryManager$Int4;
+    var _TelemetryManager$Int5;
     if (!isValidMessage(activity)) return;
     const isHistoryMessageReceived = isHistoryMessage(activity, startTime);
     const payload = buildMessagePayload(activity, userId);
     payload.messageType = Constants.userMessageTag;
     if (isHistoryMessageReceived) {
-      var _TelemetryManager$Int3;
-      historyMessageStrategy(polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int3 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int3 === void 0 ? void 0 : _TelemetryManager$Int3.conversationId));
+      var _TelemetryManager$Int4;
+      historyMessageStrategy(polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int4 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int4 === void 0 ? void 0 : _TelemetryManager$Int4.conversationId));
       return;
     }
     firstResponseLatencyTracker.stopClock(payload);
     const newMessageReceivedEvent = {
       eventName: BroadcastEvent.NewMessageReceived,
-      payload: polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int4 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int4 === void 0 ? void 0 : _TelemetryManager$Int4.conversationId)
+      payload: polyfillMessagePayloadForEvent(activity, payload, (_TelemetryManager$Int5 = TelemetryManager.InternalTelemetryData) === null || _TelemetryManager$Int5 === void 0 ? void 0 : _TelemetryManager$Int5.conversationId)
     };
     BroadcastService.postMessage(newMessageReceivedEvent);
     TelemetryHelper.logActionEventToAllTelemetry(LogLevel.INFO, {

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

@@ -7,6 +7,9 @@ export declare class Constants {
     static readonly historyMessageTag = "history";
     static readonly agentEndConversationMessageTag = "agentendconversation";
     static readonly supervisorForceCloseMessageTag = "supervisorforceclosedconversation";
+    static readonly endConversationalSurveyMessageTag = "endconversationalsurvey";
+    static readonly startConversationalSurveyMessageTag = "startconversationalsurvey";
+    static readonly c2ConversationalSurveyMessageTag = "c2conversationalsurvey";
     static readonly receivedMessageClassName = "ms_lcw_webchat_received_message";
     static readonly sentMessageClassName = "ms_lcw_webchat_sent_message";
     static readonly webchatChannelId = "webchat";
@@ -80,8 +83,7 @@ export declare class Constants {
     static readonly TargetRelationship = "rel";
     static readonly TargetRelationshipAttributes = "noopener noreferrer";
     static readonly OpenLinkIconCssClass = "webchat__render-markdown__external-link-icon";
-    static readonly internetConnectionTestUrl = "https://ocsdk-prod.azureedge.net/public/connecttest.txt";
-    static readonly internetConnectionTestUrlText = "Omnichannel Connect Test";
+    static readonly internetConnectionTestPath = "/livechatwidget/version.txt";
     static readonly ChatWidgetStateChangedPrefix = "ChatWidgetStateChanged";
     static readonly PostChatLoadingDurationInMs = 2000;
     static readonly BrowserUnloadConfirmationMessage = "Do you want to leave chat?";
@@ -94,6 +96,12 @@ export declare class Constants {
     static readonly OCOriginalMessageId = "OriginalMessageId";
     static readonly WebchatSequenceIdAttribute = "webchat:sequence-id";
     static readonly MessageSequenceIdOverride = "MessageSequenceIdOverride";
+    static readonly sendCustomEvent = "sendCustomEvent";
+    static readonly onCustomEvent = "onCustomEvent";
+    static readonly customEventName = "customEventName";
+    static readonly customEventValue = "customEventValue";
+    static readonly Hidden = "Hidden";
+    static readonly EndConversationDueToOverflow = "endconversationduetooverflow";
 }
 export declare const Regex: {
     new (): {};
@@ -180,6 +188,9 @@ export declare enum ConversationMode {
     Regular = "192350000",
     Persistent = "192350001"
 }
+export declare enum SurveyProvider {
+    MicrosoftCopilotStudio = "600990001"
+}
 export declare enum LiveWorkItemState {
     Active = "Active",
     Closed = "Closed",

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

@@ -172,6 +172,7 @@ export declare enum TelemetryEvent {
     BotAuthActivityUndefinedSignInId = "BotAuthActivityUndefinedSignInId",
     ThirdPartyCookiesBlocked = "ThirdPartyCookiesBlocked",
     ParticipantsRemovedEvent = "ParticipantsRemovedEvent",
+    QueueOverflowEvent = "QueueOverflowEvent",
     ProcessingHTMLTextMiddlewareFailed = "ProcessingHTMLTextMiddlewareFailed",
     ProcessingSanitizationMiddlewareFailed = "ProcessingSanitizationMiddlewareFailed",
     FormatTagsMiddlewareJSONStringifyFailed = "FormatTagsMiddlewareJSONStringifyFailed",
@@ -210,6 +211,7 @@ export declare enum TelemetryEvent {
     SystemMessageReceived = "SystemMessageReceived",
     RehydrateMessageReceived = "RehydrateMessageReceived",
     CustomContextReceived = "CustomContextReceived",
+    CustomEventAction = "CustomEventAction",
     NetworkDisconnected = "NetworkDisconnected",
     NetworkReconnected = "NetworkReconnected",
     LinkModePostChatWorkflowStarted = "LinkModePostChatWorkflowStarted",

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

@@ -1,5 +1,6 @@
 import { FacadeChatSDK } from "./facades/FacadeChatSDK";
 import { ITimer } from "./interfaces/ITimer";
+import * as CustomEventType from "../contexts/common/CustomEventType";
 export declare const setTabIndices: (elements: HTMLElement[] | null, tabIndexMap: Map<string, number>, shouldBeFocusable: boolean) => void;
 export declare const findParentFocusableElementsWithoutChildContainer: (elementId: string) => HTMLElement[] | null;
 export declare const findAllFocusableElement: (parent: string | HTMLElement) => any[] | null;
@@ -47,3 +48,10 @@ export declare const formatTemplateString: (templateMessage: string, values: any
 export declare const parseLowerCaseString: (property: string | boolean | undefined) => string;
 export declare const setOcUserAgent: (chatSDK: any) => void;
 export declare function getDeviceType(): string;
+export declare const isValidCustomEvent: (payload: object) => boolean;
+export declare const getCustomEventValue: (customEventPayload: CustomEventType.ICustomEvent) => string;
+export declare function isEndConversationDueToOverflowActivity(activity: {
+    channelData?: {
+        tags?: string[];
+    };
+}): boolean | undefined;

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

@@ -0,0 +1,4 @@
+import { FacadeChatSDK } from "../../../common/facades/FacadeChatSDK";
+import { BroadcastService } from "@microsoft/omnichannel-chat-components";
+export declare const customEventCallback: (facadeChatSDK: FacadeChatSDK) => (event: object) => void;
+export declare const subscribeToSendCustomEvent: (broadcastService: typeof BroadcastService, facadeChatSDK: FacadeChatSDK, customEventCallback: (fackageSdK: FacadeChatSDK) => (event: object) => void) => void;

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

@@ -1,3 +1,4 @@
 import { FacadeChatSDK } from "../../../common/facades/FacadeChatSDK";
 export declare const isPostChatSurveyEnabled: (facadeChatSDK: FacadeChatSDK) => Promise<boolean>;
+export declare const getPostChatSurveyConfig: (facadeChatSDK: FacadeChatSDK) => Promise<any>;
 export declare const isPersistentChatEnabled: (conversationMode: string | undefined) => boolean;

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

@@ -4,7 +4,7 @@
  * Adds necessary tags if not present so that the rendering middlewares can process them later.
  ******/
 import { IWebChatAction } from "../../../interfaces/IWebChatAction";
-declare const channelDataMiddleware: ({ dispatch }: {
+declare const channelDataMiddleware: (addConversationalSurveyTagsCallback: any) => ({ dispatch }: {
     dispatch: any;
 }) => (next: any) => (action: IWebChatAction) => any;
 export default channelDataMiddleware;

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

@@ -5,7 +5,7 @@
  * The callback is then invoked to hide the send box (by default).
  ******/
 import { IWebChatAction } from "../../../interfaces/IWebChatAction";
-declare const createConversationEndMiddleware: (conversationEndCallback: any) => ({ dispatch }: {
+declare const createConversationEndMiddleware: (conversationEndCallback: any, startConversationalSurveyCallback: any, endConversationalSurveyCallback: any) => ({ dispatch }: {
     dispatch: any;
 }) => (next: any) => (action: IWebChatAction) => any;
 export default createConversationEndMiddleware;

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

@@ -0,0 +1,22 @@
+/******
+ * CustomEventMiddleware
+ *
+ * This middleware is invoked when a custom event is received.
+ * The callback is then invoked to handle the custom event.
+ ******/
+import { IWebChatAction } from "../../../interfaces/IWebChatAction";
+import { BroadcastService } from "@microsoft/omnichannel-chat-components";
+export declare const isValidCustomEvent: (activity: {
+    channelData?: {
+        metadata?: {
+            customEvent?: string;
+            customEventName?: string;
+            customEventValue?: unknown;
+        };
+    };
+    from?: {
+        role: string;
+    };
+}) => boolean;
+declare const createCustomEventMiddleware: (broadcastservice: typeof BroadcastService) => () => (next: (action: IWebChatAction) => void) => (action: IWebChatAction) => void;
+export default createCustomEventMiddleware;

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

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

package/lib/types/contexts/common/CustomEventType.d.ts

@@ -0,0 +1,6 @@
+export interface ICustomEvent {
+    messageId?: string;
+    customEvent?: string;
+    customEventName: string;
+    customEventValue: unknown;
+}

package/lib/types/contexts/common/ILiveChatWidgetContext.d.ts

@@ -48,6 +48,8 @@ export interface ILiveChatWidgetContext {
         chatDisconnectEventReceived: boolean;
         selectedSurveyMode: string | null;
         postChatParticipantType: undefined | ParticipantType;
+        isConversationalSurvey: boolean;
+        isConversationalSurveyEnabled: boolean;
     };
     uiStates: {
         showConfirmationPane: boolean;

package/lib/types/contexts/common/LiveChatWidgetActionType.d.ts

@@ -44,5 +44,7 @@ export declare enum LiveChatWidgetActionType {
     SET_SURVEY_MODE = 42,
     SET_CONFIRMATION_STATE = 43,
     SET_POST_CHAT_PARTICIPANT_TYPE = 44,
-    GET_IN_MEMORY_STATE = 45
+    SET_CONVERSATIONAL_SURVEY_ENABLED = 45,
+    SET_CONVERSATIONAL_SURVEY_DISPLAY = 46,
+    GET_IN_MEMORY_STATE = 47
 }

package/lib/types/firstresponselatency/FirstResponseLatencyTracker.d.ts

@@ -1,11 +1,11 @@
 import { MessagePayload } from "./Constants";
 export declare class FirstResponseLatencyTracker {
     private isABotConversation;
-    private isStarted;
-    private isEnded;
+    private isTracking;
     private startTrackingMessage?;
     private stopTrackingMessage?;
     private isReady;
+    private trackingTimeoutId?;
     constructor();
     private createTrackingMessage;
     private startTracking;

package/lib/types/firstresponselatency/util.d.ts

@@ -1,6 +1,23 @@
 import { MessagePayload, ScenarioType, TrackingMessage } from "./Constants";
 import { IActivity } from "botframework-directlinejs";
+/**
+ * Determines whether a given activity is a historical message.
+ *
+ * This function checks if the activity is a message type and uses a combination
+ * of legacy tags and timestamp-based logic to determine if the message is historical.
+ *
+ * @param {IActivity} activity - The activity object to evaluate.
+ * @param {number} startTime - The start time (in milliseconds since epoch) to compare against.
+ * @returns {boolean} - Returns true if the activity is a historical message, false otherwise.
+ *
+ * Logic:
+ * - If the activity type is not a message, it is not historical.
+ * - If the activity contains a legacy history message tag, it is considered historical.
+ * - Otherwise, the function extracts a timestamp from the activity ID using `extractTimestampFromId`.
+ *   - If the ID is valid and the timestamp is older than the start time, the message is historical.
+ */
 export declare const isHistoryMessage: (activity: IActivity, startTime: number) => boolean;
+export declare const extractTimestampFromId: (activity: IActivity) => number;
 export declare const buildMessagePayload: (activity: IActivity, userId: string) => MessagePayload;
 export declare const polyfillMessagePayloadForEvent: (activity: IActivity, payload: MessagePayload, conversationId?: string) => MessagePayload;
 export declare const getScenarioType: (activity: IActivity) => ScenarioType;

package/lib/types/plugins/newMessageEventHandler.d.ts

@@ -1,2 +1,2 @@
 import { IActivity } from "botframework-directlinejs";
-export declare const createOnNewAdapterActivityHandler: (chatId: string, userId: string) => (activity: IActivity) => void;
+export declare const createOnNewAdapterActivityHandler: (chatId: string, userId: string, startTime: number) => (activity: IActivity) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/omnichannel-chat-widget",
-  "version": "1.8.2-main.e3c1d40",
+  "version": "1.8.2-main.f638bed",
   "description": "Microsoft Omnichannel Chat Widget",
   "main": "lib/cjs/index.js",
   "types": "lib/types/index.d.ts",
@@ -86,7 +86,7 @@
   "dependencies": {
     "@azure/core-tracing": "^1.2.0",
     "@microsoft/applicationinsights-web": "^3.3.6",
-    "@microsoft/omnichannel-chat-components": "1.1.12",
+    "@microsoft/omnichannel-chat-components": "1.1.13",
     "@microsoft/omnichannel-chat-sdk": "^1.11.4",
     "@opentelemetry/api": "^1.9.0",
     "abort-controller": "^3",
@@ -121,8 +121,8 @@
     "build:umd": "webpack --config ./webpack.umd.config.cjs",
     "verify": "yarn install && yarn build-storybook && yarn test:all && yarn build && yarn storybook",
     "testpack": "yarn build && yarn pack",
-    "build-sample": "yarn build && webpack --config ./webpack.config.cjs",
-    "build-sample:dev": "yarn build && webpack --config ./webpack.dev.config.cjs",
+    "build-sample": "yarn build && cross-env NODE_OPTIONS=--openssl-legacy-provider webpack --config ./webpack.config.cjs",
+    "build-sample:dev": "yarn build && cross-env NODE_OPTIONS=--openssl-legacy-provider webpack --config ./webpack.dev.config.cjs",
     "test:visual:build": "yarn build-storybook && yarn test:visual",
     "lint": "yarn eslint . --max-warnings=0",
     "prepush": "yarn lint && yarn danger:prepush",