@microsoft/omnichannel-chat-widget 2.0.0 → 2.0.1-main.38c3c85

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/README.md +61 -2
  2. package/lib/cjs/common/telemetry/TelemetryConstants.js +8 -0
  3. package/lib/cjs/components/chatbuttonstateful/ChatButtonStateful.js +42 -25
  4. package/lib/cjs/components/livechatwidget/common/endChat.js +39 -0
  5. package/lib/cjs/components/livechatwidget/common/initWebChatComposer.js +42 -13
  6. package/lib/cjs/components/livechatwidget/common/reconnectChatHelper.js +29 -1
  7. package/lib/cjs/components/livechatwidget/common/recoveryEligibilityTelemetry.js +60 -0
  8. package/lib/cjs/components/livechatwidget/common/startChat.js +118 -36
  9. package/lib/cjs/components/livechatwidget/common/updateSessionDataForTelemetry.js +34 -5
  10. package/lib/cjs/components/livechatwidget/livechatwidgetstateful/LiveChatWidgetStateful.js +13 -23
  11. package/lib/cjs/components/webchatcontainerstateful/WebChatContainerStateful.js +2 -2
  12. package/lib/cjs/components/webchatcontainerstateful/common/defaultProps/defaultMiddlewareLocalizedTexts.js +2 -1
  13. package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachmentForScreenReaderMiddleware.js +159 -0
  14. package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachments/AdaptiveCardAccessibilityWrapper.js +16 -2
  15. package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentSentAnnouncementMiddleware.js +68 -40
  16. package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentUploadValidatorMiddleware.js +0 -27
  17. package/lib/esm/common/telemetry/TelemetryConstants.js +8 -0
  18. package/lib/esm/components/chatbuttonstateful/ChatButtonStateful.js +42 -25
  19. package/lib/esm/components/livechatwidget/common/endChat.js +39 -0
  20. package/lib/esm/components/livechatwidget/common/initWebChatComposer.js +40 -13
  21. package/lib/esm/components/livechatwidget/common/reconnectChatHelper.js +28 -1
  22. package/lib/esm/components/livechatwidget/common/recoveryEligibilityTelemetry.js +52 -0
  23. package/lib/esm/components/livechatwidget/common/startChat.js +115 -34
  24. package/lib/esm/components/livechatwidget/common/updateSessionDataForTelemetry.js +34 -5
  25. package/lib/esm/components/livechatwidget/livechatwidgetstateful/LiveChatWidgetStateful.js +14 -24
  26. package/lib/esm/components/webchatcontainerstateful/WebChatContainerStateful.js +2 -2
  27. package/lib/esm/components/webchatcontainerstateful/common/defaultProps/defaultMiddlewareLocalizedTexts.js +2 -1
  28. package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachmentForScreenReaderMiddleware.js +153 -0
  29. package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachments/AdaptiveCardAccessibilityWrapper.js +16 -2
  30. package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentSentAnnouncementMiddleware.js +65 -39
  31. package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentUploadValidatorMiddleware.js +0 -27
  32. package/lib/types/common/telemetry/TelemetryConstants.d.ts +4 -0
  33. package/lib/types/components/livechatwidget/common/initWebChatComposer.d.ts +8 -0
  34. package/lib/types/components/livechatwidget/common/reconnectChatHelper.d.ts +6 -1
  35. package/lib/types/components/livechatwidget/common/recoveryEligibilityTelemetry.d.ts +17 -0
  36. package/lib/types/components/livechatwidget/common/startChat.d.ts +5 -1
  37. package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachmentForScreenReaderMiddleware.d.ts +11 -0
  38. package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentSentAnnouncementMiddleware.d.ts +11 -4
  39. package/lib/types/contexts/common/ILiveChatWidgetLocalizedTexts.d.ts +9 -2
  40. package/package.json +7 -7
@@ -3,31 +3,41 @@
3
3
  Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
- exports.default = void 0;
6
+ exports.getFileSentMessage = exports.default = exports.createAttachmentSentAnnouncementMiddleware = exports.ATTACHMENT_ANNOUNCEMENT_REGION_ID = void 0;
7
7
  var _IWebChatAction = require("../../../interfaces/IWebChatAction");
8
8
  var _WebChatActionType = require("../../enums/WebChatActionType");
9
9
  /******
10
10
  * AttachmentSentAnnouncementMiddleware
11
11
  *
12
12
  * When a file attachment is successfully sent, announces the result to
13
- * screen readers via an aria-live region so that assistive technology
14
- * users receive immediate feedback.
13
+ * screen readers so that assistive technology users receive immediate
14
+ * feedback ("File report.pdf sent").
15
+ *
16
+ * The announcement region lives inside the chat dialog. While the dialog is
17
+ * open it is aria-modal and its host siblings are aria-hidden, so screen
18
+ * readers (TalkBack, VoiceOver) ignore live regions outside it.
15
19
  ******/
16
20
 
17
- const ARIA_LIVE_REGION_ID = "oc-lcw-attachment-announcement";
21
+ const ATTACHMENT_ANNOUNCEMENT_REGION_ID = exports.ATTACHMENT_ANNOUNCEMENT_REGION_ID = "oc-lcw-attachment-announcement";
22
+ const DEFAULT_FILE_SENT_TEXT = "File {2} sent";
23
+ const DEFAULT_FILES_SENT_TEXT = "{0} files sent";
24
+
25
+ // Let the send-box focus shift settle before speaking, then keep the node
26
+ // long enough for the screen reader to read it.
27
+ const ANNOUNCE_DELAY_MS = 100;
28
+ const ANNOUNCEMENT_LIFETIME_MS = 5000;
18
29
 
19
30
  /**
20
- * Ensures a visually-hidden aria-live region exists in the DOM for
21
- * announcing attachment upload results to screen readers.
31
+ * Ensures a visually-hidden aria-live region exists inside the chat dialog
32
+ * for announcing attachment upload results to screen readers.
22
33
  */
23
- const ensureAriaLiveRegion = () => {
24
- let region = document.getElementById(ARIA_LIVE_REGION_ID);
34
+ const ensureAriaLiveRegion = widgetElementId => {
35
+ const host = document.getElementById(widgetElementId) || document.body;
36
+ let region = document.getElementById(ATTACHMENT_ANNOUNCEMENT_REGION_ID);
25
37
  if (!region) {
26
38
  region = document.createElement("div");
27
- region.id = ARIA_LIVE_REGION_ID;
39
+ region.id = ATTACHMENT_ANNOUNCEMENT_REGION_ID;
28
40
  region.setAttribute("aria-live", "polite");
29
- region.setAttribute("role", "status");
30
- region.setAttribute("aria-atomic", "true");
31
41
  // Visually hidden but available to screen readers
32
42
  Object.assign(region.style, {
33
43
  position: "absolute",
@@ -40,44 +50,62 @@ const ensureAriaLiveRegion = () => {
40
50
  whiteSpace: "nowrap",
41
51
  border: "0"
42
52
  });
43
- const container = document.getElementById("oc-lcw-container");
44
- (container || document.body).appendChild(region);
53
+ }
54
+ if (region.parentElement !== host) {
55
+ host.appendChild(region);
45
56
  }
46
57
  return region;
47
58
  };
48
59
 
49
60
  /**
50
- * Announces a message to screen readers by updating the aria-live region.
51
- * Clears it briefly first so repeated identical messages are still announced.
61
+ * Announces a message by appending a fresh node to the live region.
62
+ * TalkBack reliably speaks newly added nodes but often misses text changes
63
+ * on an existing node, so each announcement gets its own element.
52
64
  */
53
- const announce = message => {
54
- const region = ensureAriaLiveRegion();
55
- region.textContent = "";
56
- // Small delay so the screen reader detects the content change
65
+ const announce = (message, widgetElementId) => {
66
+ const region = ensureAriaLiveRegion(widgetElementId);
57
67
  setTimeout(() => {
58
- region.textContent = message;
59
- }, 100);
68
+ const node = document.createElement("div");
69
+ node.textContent = message;
70
+ region.appendChild(node);
71
+ setTimeout(() => node.remove(), ANNOUNCEMENT_LIFETIME_MS);
72
+ }, ANNOUNCE_DELAY_MS);
60
73
  };
61
74
 
62
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
63
- const attachmentSentAnnouncementMiddleware = _ref => {
64
- let dispatch = _ref.dispatch;
65
- return next => action => {
66
- if (!(0, _IWebChatAction.isWebChatAction)(action)) {
67
- return next(action);
68
- }
75
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
76
+ const getFileSentMessage = (attachments, localizedTexts) => {
77
+ var _attachments$;
78
+ if (attachments.length > 1) {
79
+ // Replacer callbacks insert values literally; a string would treat "$&" or "$$" as patterns.
80
+ return ((localizedTexts === null || localizedTexts === void 0 ? void 0 : localizedTexts.MIDDLEWARE_BANNER_FILES_SENT) || DEFAULT_FILES_SENT_TEXT).replace("{0}", () => String(attachments.length));
81
+ }
82
+ const name = typeof ((_attachments$ = attachments[0]) === null || _attachments$ === void 0 ? void 0 : _attachments$.name) === "string" ? attachments[0].name.trim() : "";
83
+ return ((localizedTexts === null || localizedTexts === void 0 ? void 0 : localizedTexts.MIDDLEWARE_BANNER_FILE_SENT) || DEFAULT_FILE_SENT_TEXT).replace("{2}", () => name).replace(/\s{2,}/g, " ").trim();
84
+ };
85
+ exports.getFileSentMessage = getFileSentMessage;
86
+ const createAttachmentSentAnnouncementMiddleware = function (localizedTexts) {
87
+ let widgetElementId = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "oc-lcw";
88
+ return (
89
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
90
+ _ref => {
91
+ let dispatch = _ref.dispatch;
92
+ return next => action => {
93
+ if (!(0, _IWebChatAction.isWebChatAction)(action)) {
94
+ return next(action);
95
+ }
69
96
 
70
- // Intercept successfully posted activities that contain attachments
71
- if (action.type === _WebChatActionType.WebChatActionType.DIRECT_LINE_POST_ACTIVITY_FULFILLED) {
72
- var _action$payload;
73
- const attachments = (_action$payload = action.payload) === null || _action$payload === void 0 || (_action$payload = _action$payload.activity) === null || _action$payload === void 0 ? void 0 : _action$payload.attachments;
74
- if (attachments && attachments.length > 0) {
75
- const count = attachments.length;
76
- const message = count === 1 ? "File sent" : `${count} files sent`;
77
- announce(message);
78
- }
97
+ // Intercept successfully posted activities that contain attachments
98
+ if (action.type === _WebChatActionType.WebChatActionType.DIRECT_LINE_POST_ACTIVITY_FULFILLED) {
99
+ var _action$payload;
100
+ const attachments = (_action$payload = action.payload) === null || _action$payload === void 0 || (_action$payload = _action$payload.activity) === null || _action$payload === void 0 ? void 0 : _action$payload.attachments;
101
+ if (attachments && attachments.length > 0) {
102
+ announce(getFileSentMessage(attachments, localizedTexts), widgetElementId);
103
+ }
104
+ }
105
+ return next(action);
106
+ };
79
107
  }
80
- return next(action);
81
- };
108
+ );
82
109
  };
83
- var _default = exports.default = attachmentSentAnnouncementMiddleware;
110
+ exports.createAttachmentSentAnnouncementMiddleware = createAttachmentSentAnnouncementMiddleware;
111
+ var _default = exports.default = createAttachmentSentAnnouncementMiddleware;
@@ -18,27 +18,6 @@ var _WebChatActionType = require("../../enums/WebChatActionType");
18
18
  ******/
19
19
 
20
20
  const MBtoBRatio = 1000000;
21
- const announceFileSent = message => {
22
- // TalkBack on Android WebView reliably announces newly *appended*
23
- // role="alert" nodes but often misses text-content updates on existing
24
- // nodes. Wait 500ms for the send-box focus shift to settle, then inject
25
- // a fresh alert element appended to document.body and remove it after 3s.
26
- setTimeout(() => {
27
- const el = document.createElement("div");
28
- el.setAttribute("role", "alert");
29
- el.setAttribute("aria-live", "assertive");
30
- el.setAttribute("aria-atomic", "true");
31
- el.style.cssText = "position:absolute;left:-9999px;top:auto;width:1px;height:1px;overflow:hidden;";
32
- el.textContent = message;
33
- document.body.appendChild(el);
34
- // Remove after TalkBack has had time to read it
35
- setTimeout(() => {
36
- if (el.parentNode) {
37
- el.parentNode.removeChild(el);
38
- }
39
- }, 3000);
40
- }, 500);
41
- };
42
21
 
43
22
  /*
44
23
  * If an attachment is invalid, delete this attachment from the attachments list
@@ -227,13 +206,7 @@ const createAttachmentUploadValidatorMiddleware = (allowedFileExtensions, maxFil
227
206
  var _payload$activity, _payload$activity2;
228
207
  const payload = action.payload;
229
208
  if (payload !== null && payload !== void 0 && payload.activity.attachments && payload.activity.attachments.length > 0 && (payload === null || payload === void 0 || (_payload$activity = payload.activity) === null || _payload$activity === void 0 || (_payload$activity = _payload$activity.attachments) === null || _payload$activity === void 0 ? void 0 : _payload$activity.length) === (payload === null || payload === void 0 || (_payload$activity2 = payload.activity) === null || _payload$activity2 === void 0 || (_payload$activity2 = _payload$activity2.channelData) === null || _payload$activity2 === void 0 || (_payload$activity2 = _payload$activity2.attachmentSizes) === null || _payload$activity2 === void 0 ? void 0 : _payload$activity2.length)) {
230
- var _validatedAction$payl;
231
209
  const validatedAction = validateAttachment(action, allowedFileExtensions, maxFileSizeSupportedByDynamics, localizedTexts);
232
-
233
- // Announce to screen readers that the file was sent when validation passes
234
- if (((_validatedAction$payl = validatedAction.payload) === null || _validatedAction$payl === void 0 || (_validatedAction$payl = _validatedAction$payl.activity) === null || _validatedAction$payl === void 0 || (_validatedAction$payl = _validatedAction$payl.attachments) === null || _validatedAction$payl === void 0 ? void 0 : _validatedAction$payl.length) > 0) {
235
- announceFileSent(localizedTexts.MIDDLEWARE_BANNER_FILE_SENT ?? "File sent successfully.");
236
- }
237
210
  return next(validatedAction);
238
211
  }
239
212
  }
@@ -109,8 +109,10 @@ export let TelemetryEvent = /*#__PURE__*/function (TelemetryEvent) {
109
109
  TelemetryEvent["MidConversationAuthSucceeded"] = "MidConversationAuthSucceeded";
110
110
  TelemetryEvent["MidConversationAuthFailed"] = "MidConversationAuthFailed";
111
111
  TelemetryEvent["MidConversationAuthReset"] = "MidConversationAuthReset";
112
+ TelemetryEvent["RecoveryEligibilityEvaluated"] = "RecoveryEligibilityEvaluated";
112
113
  TelemetryEvent["GetConversationDetailsCallStarted"] = "GetConversationDetailsCallStarted";
113
114
  TelemetryEvent["GetConversationDetailsCallFailed"] = "GetConversationDetailsCallFailed";
115
+ TelemetryEvent["UpdateTelemetryDataFailed"] = "UpdateTelemetryDataFailed";
114
116
  TelemetryEvent["EndChatSDKCallFailed"] = "EndChatSDKCallFailed";
115
117
  TelemetryEvent["DisconnectEndChatSDKCallFailed"] = "DisconnectEndChatSDKCallFailed";
116
118
  TelemetryEvent["GetChatReconnectContextSDKCallStarted"] = "GetChatReconnectContextSDKCallStarted";
@@ -140,6 +142,8 @@ export let TelemetryEvent = /*#__PURE__*/function (TelemetryEvent) {
140
142
  TelemetryEvent["PrechatSubmitted"] = "PrechatSubmitted";
141
143
  TelemetryEvent["StartChatSDKCall"] = "StartChatCall";
142
144
  TelemetryEvent["StartChatEventReceived"] = "StartChatEventReceived";
145
+ TelemetryEvent["ConcurrentStartChatRejected"] = "ConcurrentStartChatRejected";
146
+ TelemetryEvent["ChatSDKStateCleanUpDisconnectFailed"] = "ChatSDKStateCleanUpDisconnectFailed";
143
147
  TelemetryEvent["EndChatSDKCall"] = "EndChatSDKCall";
144
148
  TelemetryEvent["PrepareEndChat"] = "PrepareEndChat";
145
149
  TelemetryEvent["EndChatEventReceived"] = "EndChatEventReceived";
@@ -412,6 +416,9 @@ export let TelemetryConstants = /*#__PURE__*/function () {
412
416
  case TelemetryEvent.SecureEventBusDispatchError:
413
417
  case TelemetryEvent.AgentJoinedConversation:
414
418
  case TelemetryEvent.BrowserTabHidden:
419
+ case TelemetryEvent.ConcurrentStartChatRejected:
420
+ case TelemetryEvent.ChatSDKStateCleanUpDisconnectFailed:
421
+ case TelemetryEvent.RecoveryEligibilityEvaluated:
415
422
  return ScenarioType.ACTIONS;
416
423
  case TelemetryEvent.StartChatSDKCall:
417
424
  case TelemetryEvent.StartChatEventReceived:
@@ -422,6 +429,7 @@ export let TelemetryConstants = /*#__PURE__*/function () {
422
429
  case TelemetryEvent.OnNewMessageFailed:
423
430
  case TelemetryEvent.OnNewMessageAudioNotificationFailed:
424
431
  case TelemetryEvent.GetConversationDetailsCallFailed:
432
+ case TelemetryEvent.UpdateTelemetryDataFailed:
425
433
  case TelemetryEvent.EndChatSDKCall:
426
434
  case TelemetryEvent.EndChatEventReceived:
427
435
  case TelemetryEvent.EndChatSDKCallFailed:
@@ -50,37 +50,54 @@ export const ChatButtonStateful = props => {
50
50
  const ref = useRef(() => {
51
51
  return;
52
52
  });
53
+ // Optimistic guard against rapid double-clicks. `conversationState` only flips to
54
+ // `Loading` after React re-renders, so the button stays visible and clickable for the
55
+ // whole duration of the first click's async work. Without this ref two concurrent
56
+ // startChat() calls can create two conversations on the backend.
57
+ const startChatInProgressRef = useRef(false);
53
58
  ref.current = async () => {
54
- TelemetryHelper.logActionEventToAllTelemetry(LogLevel.INFO, {
55
- Event: TelemetryEvent.LCWChatButtonClicked,
56
- Description: "Chat button click action started",
57
- CustomProperties: {
58
- ConversationStage: ConversationStage.Initialization
59
- }
60
- });
61
- if (state.appStates.isMinimized) {
62
- dispatch({
63
- type: LiveChatWidgetActionType.SET_MINIMIZED,
64
- payload: false
59
+ if (startChatInProgressRef.current) {
60
+ TelemetryHelper.logActionEvent(LogLevel.WARN, {
61
+ Event: TelemetryEvent.ConcurrentStartChatRejected,
62
+ Description: "Chat button click ignored, a start chat operation is already in progress."
65
63
  });
66
- dispatch({
67
- type: LiveChatWidgetActionType.SET_UNREAD_MESSAGE_COUNT,
68
- payload: 0
64
+ return;
65
+ }
66
+ startChatInProgressRef.current = true;
67
+ try {
68
+ TelemetryHelper.logActionEventToAllTelemetry(LogLevel.INFO, {
69
+ Event: TelemetryEvent.LCWChatButtonClicked,
70
+ Description: "Chat button click action started",
71
+ CustomProperties: {
72
+ ConversationStage: ConversationStage.Initialization
73
+ }
69
74
  });
70
- // If chat is minimized and then unminimized, start a chat if convesation state is closed.
71
- if (state.appStates.conversationState === ConversationState.Closed) {
75
+ if (state.appStates.isMinimized) {
76
+ dispatch({
77
+ type: LiveChatWidgetActionType.SET_MINIMIZED,
78
+ payload: false
79
+ });
80
+ dispatch({
81
+ type: LiveChatWidgetActionType.SET_UNREAD_MESSAGE_COUNT,
82
+ payload: 0
83
+ });
84
+ // If chat is minimized and then unminimized, start a chat if convesation state is closed.
85
+ if (state.appStates.conversationState === ConversationState.Closed) {
86
+ await startChat();
87
+ }
88
+ } else {
72
89
  await startChat();
73
90
  }
74
- } else {
75
- await startChat();
91
+ TelemetryHelper.logActionEventToAllTelemetry(LogLevel.INFO, {
92
+ Event: TelemetryEvent.LCWChatButtonActionCompleted,
93
+ Description: "Chat button action completed",
94
+ CustomProperties: {
95
+ ConversationStage: ConversationStage.Initialization
96
+ }
97
+ });
98
+ } finally {
99
+ startChatInProgressRef.current = false;
76
100
  }
77
- TelemetryHelper.logActionEventToAllTelemetry(LogLevel.INFO, {
78
- Event: TelemetryEvent.LCWChatButtonActionCompleted,
79
- Description: "Chat button action completed",
80
- CustomProperties: {
81
- ConversationStage: ConversationStage.Initialization
82
- }
83
- });
84
101
  };
85
102
  const outOfOfficeStyleProps = Object.assign({}, defaultOutOfOfficeChatButtonStyleProps, outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.styleProps);
86
103
  const controlProps = {
@@ -349,14 +349,53 @@ export const closeChatStateCleanUp = dispatch => {
349
349
  });
350
350
  };
351
351
 
352
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
353
+ const logCleanUpDisconnectFailure = error => {
354
+ TelemetryHelper.logActionEvent(LogLevel.WARN, {
355
+ Event: TelemetryEvent.ChatSDKStateCleanUpDisconnectFailed,
356
+ Description: "Failed to disconnect the previous conversation during chat SDK state clean up.",
357
+ ExceptionDetails: {
358
+ exception: (error === null || error === void 0 ? void 0 : error.message) ?? error
359
+ }
360
+ });
361
+ };
362
+
363
+ // Releases the previous session's conversation. Mirrors the cleanup OmnichannelChatSDK.endChat()
364
+ // runs in its finally block (disconnect, then drop the reference). Without it, a conversation
365
+ // left over from a failed or orphaned start chat, or from a chat ended in another tab (which
366
+ // skips the SDK endChat), keeps its messaging session open and leaks into the next chat.
367
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
368
+ const disconnectConversation = chatSDK => {
369
+ const conversation = chatSDK.conversation;
370
+ if (!conversation || typeof conversation.disconnect !== "function") {
371
+ return;
372
+ }
373
+ try {
374
+ // ACS conversations disconnect asynchronously; legacy IC3 conversations may not return a promise.
375
+ const result = conversation.disconnect();
376
+ if (result && typeof result.catch === "function") {
377
+ result.catch(logCleanUpDisconnectFailure);
378
+ }
379
+ } catch (error) {
380
+ logCleanUpDisconnectFailure(error);
381
+ }
382
+ };
383
+
352
384
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
353
385
  export const chatSDKStateCleanUp = chatSDK => {
386
+ if (!chatSDK) {
387
+ return;
388
+ }
389
+
354
390
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
355
391
  chatSDK.requestId = uuidv4();
356
392
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
357
393
  chatSDK.chatToken = {};
358
394
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
359
395
  chatSDK.reconnectId = null;
396
+ disconnectConversation(chatSDK);
397
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
398
+ chatSDK.conversation = null;
360
399
  };
361
400
 
362
401
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -11,10 +11,11 @@ import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidge
11
11
  import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
12
12
  import { WebChatStoreLoader } from "../../webchatcontainerstateful/webchatcontroller/WebChatStoreLoader";
13
13
  import attachmentProcessingMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentProcessingMiddleware";
14
- import attachmentSentAnnouncementMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentSentAnnouncementMiddleware";
14
+ import createAttachmentSentAnnouncementMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentSentAnnouncementMiddleware";
15
15
  import channelDataMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/channelDataMiddleware";
16
16
  import { createActivityMiddleware } from "../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityMiddleware";
17
17
  import { createActivityStatusMiddleware } from "../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityStatusMiddleware";
18
+ import { createAttachmentForScreenReaderMiddleware } from "../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachmentForScreenReaderMiddleware";
18
19
  import { createAttachmentMiddleware } from "../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachmentMiddleware";
19
20
  import createAttachmentUploadValidatorMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/attachmentUploadValidatorMiddleware";
20
21
  import { createAvatarMiddleware } from "../../webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/avatarMiddleware";
@@ -42,6 +43,31 @@ import htmlPlayerMiddleware from "../../webchatcontainerstateful/webchatcontroll
42
43
  import htmlTextMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/htmlTextMiddleware";
43
44
  import preProcessingMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/preProcessingMiddleware";
44
45
  import sanitizationMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/sanitizationMiddleware";
46
+ const markdownSanitizeConfig = {
47
+ FORBID_TAGS: ["form", "button", "script", "div", "input"],
48
+ FORBID_ATTR: ["action"],
49
+ ADD_ATTR: ["target"]
50
+ };
51
+
52
+ /**
53
+ * Renders Markdown for the screen reader text of Adaptive Cards, from the same pieces as the visible card:
54
+ * the host renderMarkdown when set, the hyperlink text override, and the same sanitization.
55
+ * Markdown is always formatted, also when the widget shows Markdown unformatted, so that screen readers do not read the syntax.
56
+ * Styles are removed with their content because the card does not show them.
57
+ */
58
+ export const createScreenReaderMarkdownRenderer = webChatContainerProps => {
59
+ var _webChatContainerProp;
60
+ const hostRenderMarkdown = webChatContainerProps === null || webChatContainerProps === void 0 || (_webChatContainerProp = webChatContainerProps.webChatProps) === null || _webChatContainerProp === void 0 ? void 0 : _webChatContainerProp.renderMarkdown;
61
+ const markdown = createMarkdown(false, (webChatContainerProps === null || webChatContainerProps === void 0 ? void 0 : webChatContainerProps.disableNewLineMarkdownSupport) ?? defaultWebChatContainerStatefulProps.disableNewLineMarkdownSupport, webChatContainerProps === null || webChatContainerProps === void 0 ? void 0 : webChatContainerProps.opensMarkdownLinksInSameTab);
62
+ const hyperlinkTextOverrideRenderer = new HyperlinkTextOverrideRenderer((webChatContainerProps === null || webChatContainerProps === void 0 ? void 0 : webChatContainerProps.hyperlinkTextOverride) ?? defaultWebChatContainerStatefulProps.hyperlinkTextOverride);
63
+ return text => {
64
+ const html = hostRenderMarkdown ? hostRenderMarkdown(text) : markdown.render(text);
65
+ return DOMPurify.sanitize(hyperlinkTextOverrideRenderer.render(html), {
66
+ ...markdownSanitizeConfig,
67
+ FORBID_TAGS: [...markdownSanitizeConfig.FORBID_TAGS, "style"]
68
+ });
69
+ };
70
+ };
45
71
 
46
72
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
47
73
  export const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endChat) => {
@@ -62,7 +88,7 @@ export const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endCh
62
88
  // Initialize Web Chat's redux store
63
89
  let webChatStore = WebChatStoreLoader.store;
64
90
  if (!webChatStore) {
65
- var _state$domainStates$l, _state$domainStates$l2, _state$domainStates$l3, _props$webChatContain7;
91
+ var _state$domainStates$l, _state$domainStates$l2, _props$controlProps, _state$domainStates$l3, _props$webChatContain7;
66
92
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
67
93
  const addConversationalSurveyTagsCallback = action => {
68
94
  var _inMemoryState$appSta;
@@ -121,7 +147,7 @@ export const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endCh
121
147
  };
122
148
  webChatStore = createStore({},
123
149
  //initial state
124
- preProcessingMiddleware, attachmentProcessingMiddleware, createAttachmentUploadValidatorMiddleware((_state$domainStates$l = state.domainStates.liveChatConfig) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.allowedFileExtensions, (_state$domainStates$l2 = state.domainStates.liveChatConfig) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.maxUploadFileSize, localizedTexts), attachmentSentAnnouncementMiddleware, createCustomEventMiddleware(BroadcastService), createQueueOverflowMiddleware(state, dispatch), channelDataMiddleware(addConversationalSurveyTagsCallback), createConversationEndMiddleware(conversationEndCallback, startConversationalSurveyCallback, endConversationalSurveyCallback), createDataMaskingMiddleware((_state$domainStates$l3 = state.domainStates.liveChatConfig) === null || _state$domainStates$l3 === void 0 ? void 0 : _state$domainStates$l3.DataMaskingInfo), createMessageTimeStampMiddleware, createMessageSequenceIdOverrideMiddleware, createCitationsMiddleware(state, dispatch), gifUploadMiddleware, htmlPlayerMiddleware, htmlTextMiddleware(honorsTargetInHTMLLinks), createMaxMessageSizeValidator(localizedTexts), sanitizationMiddleware, createCallActionMiddleware(),
150
+ preProcessingMiddleware, attachmentProcessingMiddleware, createAttachmentUploadValidatorMiddleware((_state$domainStates$l = state.domainStates.liveChatConfig) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.allowedFileExtensions, (_state$domainStates$l2 = state.domainStates.liveChatConfig) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.maxUploadFileSize, localizedTexts), createAttachmentSentAnnouncementMiddleware(localizedTexts, ((_props$controlProps = props.controlProps) === null || _props$controlProps === void 0 ? void 0 : _props$controlProps.id) || "oc-lcw"), createCustomEventMiddleware(BroadcastService), createQueueOverflowMiddleware(state, dispatch), channelDataMiddleware(addConversationalSurveyTagsCallback), createConversationEndMiddleware(conversationEndCallback, startConversationalSurveyCallback, endConversationalSurveyCallback), createDataMaskingMiddleware((_state$domainStates$l3 = state.domainStates.liveChatConfig) === null || _state$domainStates$l3 === void 0 ? void 0 : _state$domainStates$l3.DataMaskingInfo), createMessageTimeStampMiddleware, createMessageSequenceIdOverrideMiddleware, createCitationsMiddleware(state, dispatch), gifUploadMiddleware, htmlPlayerMiddleware, htmlTextMiddleware(honorsTargetInHTMLLinks), createMaxMessageSizeValidator(localizedTexts), sanitizationMiddleware, createCallActionMiddleware(),
125
151
  // Pass a callback so middleware can push initials into React context for reactivity
126
152
  localizedStringsBotInitialsMiddleware(initials => {
127
153
  dispatch({
@@ -149,12 +175,7 @@ export const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endCh
149
175
  });
150
176
 
151
177
  // EXISTING sanitization (continues to work as before)
152
- const config = {
153
- FORBID_TAGS: ["form", "button", "script", "div", "input"],
154
- FORBID_ATTR: ["action"],
155
- ADD_ATTR: ["target"]
156
- };
157
- text = DOMPurify.sanitize(text, config);
178
+ text = DOMPurify.sanitize(text, markdownSanitizeConfig);
158
179
 
159
180
  // MONITOR-ONLY: Test what the stricter allowlist would remove (Phase 1)
160
181
  // This does NOT modify the text, only logs telemetry
@@ -251,6 +272,12 @@ export const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endCh
251
272
  // Track what would be removed
252
273
  const removedTags = [];
253
274
  const removedAttributes = [];
275
+ const trackAttribute = name => {
276
+ const attrName = name.toLowerCase();
277
+ if (!strictConfig.ALLOWED_ATTR.includes(attrName) && attrName !== "class" && attrName !== "id") {
278
+ removedAttributes.push(attrName);
279
+ }
280
+ };
254
281
 
255
282
  // Add hooks to the isolated monitoring instance
256
283
  monitorDOMPurify.addHook("uponSanitizeElement", (node, data) => {
@@ -259,6 +286,8 @@ export const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endCh
259
286
  // Filter out "body" tag which is DOMPurify's internal wrapper
260
287
  if (node.nodeType === 1 && !strictConfig.ALLOWED_TAGS.includes(tagName) && tagName !== "body") {
261
288
  removedTags.push(tagName);
289
+ // DOMPurify 3.4.16+ skips uponSanitizeAttribute for removed elements
290
+ Array.from(node.attributes ?? []).forEach(attr => trackAttribute(attr.name));
262
291
  }
263
292
  } catch (hookError) {
264
293
  // Silently ignore hook errors
@@ -266,10 +295,7 @@ export const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endCh
266
295
  });
267
296
  monitorDOMPurify.addHook("uponSanitizeAttribute", (node, data) => {
268
297
  try {
269
- const attrName = data.attrName.toLowerCase();
270
- if (!strictConfig.ALLOWED_ATTR.includes(attrName) && attrName !== "class" && attrName !== "id") {
271
- removedAttributes.push(attrName);
272
- }
298
+ trackAttribute(data.attrName);
273
299
  } catch (hookError) {
274
300
  // Silently ignore hook errors
275
301
  }
@@ -353,6 +379,7 @@ export const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endCh
353
379
  store: webChatStore,
354
380
  activityMiddleware: (_props$webChatContain0 = props.webChatContainerProps) !== null && _props$webChatContain0 !== void 0 && (_props$webChatContain0 = _props$webChatContain0.renderingMiddlewareProps) !== null && _props$webChatContain0 !== void 0 && _props$webChatContain0.disableActivityMiddleware ? undefined : createActivityMiddleware(renderMarkdown, (_state$domainStates$r = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r === void 0 ? void 0 : _state$domainStates$r.systemMessageStyleProps, (_state$domainStates$r2 = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r2 === void 0 ? void 0 : _state$domainStates$r2.userMessageStyleProps, localizedTexts),
355
381
  attachmentMiddleware: (_props$webChatContain1 = props.webChatContainerProps) !== null && _props$webChatContain1 !== void 0 && (_props$webChatContain1 = _props$webChatContain1.renderingMiddlewareProps) !== null && _props$webChatContain1 !== void 0 && _props$webChatContain1.disableAttachmentMiddleware ? undefined : createAttachmentMiddleware(((_state$domainStates$r3 = state.domainStates.renderingMiddlewareProps) === null || _state$domainStates$r3 === void 0 || (_state$domainStates$r3 = _state$domainStates$r3.attachmentProps) === null || _state$domainStates$r3 === void 0 ? void 0 : _state$domainStates$r3.enableInlinePlaying) ?? defaultAttachmentProps.enableInlinePlaying),
382
+ attachmentForScreenReaderMiddleware: createAttachmentForScreenReaderMiddleware(createScreenReaderMarkdownRenderer(props.webChatContainerProps)),
356
383
  activityStatusMiddleware: (_props$webChatContain10 = props.webChatContainerProps) !== null && _props$webChatContain10 !== void 0 && (_props$webChatContain10 = _props$webChatContain10.renderingMiddlewareProps) !== null && _props$webChatContain10 !== void 0 && _props$webChatContain10.disableActivityStatusMiddleware ? undefined : createActivityStatusMiddleware(getLocaleStringFromId((_state$domainStates$l5 = state.domainStates.liveChatConfig) === null || _state$domainStates$l5 === void 0 || (_state$domainStates$l5 = _state$domainStates$l5.ChatWidgetLanguage) === null || _state$domainStates$l5 === void 0 ? void 0 : _state$domainStates$l5.msdyn_localeid)),
357
384
  toastMiddleware: (_props$webChatContain11 = props.webChatContainerProps) !== null && _props$webChatContain11 !== void 0 && (_props$webChatContain11 = _props$webChatContain11.renderingMiddlewareProps) !== null && _props$webChatContain11 !== void 0 && _props$webChatContain11.disableToastMiddleware ? undefined : createToastMiddleware(props.notificationPaneProps, endChat),
358
385
  renderMarkdown,
@@ -7,6 +7,7 @@ import { BroadcastService } from "@microsoft/omnichannel-chat-components";
7
7
  import { ConversationState } from "../../../contexts/common/ConversationState";
8
8
  import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidgetActionType";
9
9
  import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
10
+ import { executeReducer } from "../../../contexts/createReducer";
10
11
  import { handleStartChatError } from "./startChatErrorHandler";
11
12
 
12
13
  // Return value: should start normal chat flow when reconnect is enabled
@@ -50,6 +51,32 @@ const handleChatReconnect = async (facadeChatSDK, props, dispatch, setAdapter, i
50
51
  return true;
51
52
  };
52
53
 
54
+ /**
55
+ * Returns true when chat reconnect took over the start: it started the chat itself or showed the reconnect pane.
56
+ * In that case the caller must not start another chat.
57
+ */
58
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
59
+ const isReconnectTriggered = async (facadeChatSDK, props, dispatch, setAdapter, initStartChat, state) => {
60
+ if (isReconnectEnabled(props.chatConfig) === true && !isPersistentEnabled(props.chatConfig)) {
61
+ let reconnectChatStarted = false;
62
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
63
+ const initStartChatAndTrack = async function () {
64
+ reconnectChatStarted = await initStartChat(...arguments);
65
+ };
66
+ const noValidReconnectId = await handleChatReconnect(facadeChatSDK, props, dispatch, setAdapter, initStartChatAndTrack, state);
67
+ // initStartChat resolves before React renders Active, so the in-memory state can still read Loading here.
68
+ // Its result tells whether reconnect started the chat; the in-memory state covers the reconnect pane.
69
+ const inMemoryState = executeReducer(state, {
70
+ type: LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
71
+ payload: null
72
+ });
73
+ if (!noValidReconnectId && (reconnectChatStarted || inMemoryState.appStates.conversationState === ConversationState.Active || inMemoryState.appStates.conversationState === ConversationState.ReconnectChat)) {
74
+ return true;
75
+ }
76
+ }
77
+ return false;
78
+ };
79
+
53
80
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
54
81
  const getChatReconnectContext = async (facadeChatSDK, chatConfig, props, isAuthenticatedChat, dispatch) => {
55
82
  try {
@@ -143,4 +170,4 @@ const isPersistentEnabled = chatConfig => {
143
170
  const hasReconnectId = reconnectAvailabilityResponse => {
144
171
  return reconnectAvailabilityResponse && !isNullOrUndefined(reconnectAvailabilityResponse.reconnectId);
145
172
  };
146
- export { handleChatReconnect, isReconnectEnabled, isPersistentEnabled, getChatReconnectContext };
173
+ export { handleChatReconnect, isReconnectTriggered, isReconnectEnabled, isPersistentEnabled, getChatReconnectContext };
@@ -0,0 +1,52 @@
1
+ import { ConversationState } from "../../../contexts/common/ConversationState";
2
+ import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
3
+ import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
4
+ import { isUndefinedOrEmpty } from "../../../common/utils";
5
+ export let RecoveryEligibilityReason = /*#__PURE__*/function (RecoveryEligibilityReason) {
6
+ RecoveryEligibilityReason["ReconnectIdPresent"] = "ReconnectIdPresent";
7
+ RecoveryEligibilityReason["ActiveContextPresent"] = "ActiveContextPresent";
8
+ RecoveryEligibilityReason["MissingContext"] = "MissingContext";
9
+ RecoveryEligibilityReason["CachedContextNonActive"] = "CachedContextNonActive";
10
+ return RecoveryEligibilityReason;
11
+ }({});
12
+ const getConversationStateName = conversationState => {
13
+ if (typeof conversationState !== "number") {
14
+ return "Unknown";
15
+ }
16
+ const stateName = ConversationState[conversationState];
17
+ return typeof stateName === "string" ? stateName : "Unknown";
18
+ };
19
+ export const getRecoveryEligibilityTelemetryProperties = (state, eligible) => {
20
+ var _state$appStates, _state$domainStates, _state$appStates2, _state$appStates3;
21
+ const reconnectId = (_state$appStates = state.appStates) === null || _state$appStates === void 0 ? void 0 : _state$appStates.reconnectId;
22
+ const liveChatContext = (_state$domainStates = state.domainStates) === null || _state$domainStates === void 0 ? void 0 : _state$domainStates.liveChatContext;
23
+ const hasReconnectId = !isUndefinedOrEmpty(reconnectId);
24
+ const hasLiveChatContext = !isUndefinedOrEmpty(liveChatContext);
25
+ const hasRequestId = !isUndefinedOrEmpty(liveChatContext === null || liveChatContext === void 0 ? void 0 : liveChatContext.requestId);
26
+ let reason = RecoveryEligibilityReason.ActiveContextPresent;
27
+ if (hasReconnectId) {
28
+ reason = RecoveryEligibilityReason.ReconnectIdPresent;
29
+ } else if (!hasLiveChatContext) {
30
+ reason = RecoveryEligibilityReason.MissingContext;
31
+ } else if (((_state$appStates2 = state.appStates) === null || _state$appStates2 === void 0 ? void 0 : _state$appStates2.conversationState) !== ConversationState.Active) {
32
+ reason = RecoveryEligibilityReason.CachedContextNonActive;
33
+ }
34
+ return {
35
+ conversationState: getConversationStateName((_state$appStates3 = state.appStates) === null || _state$appStates3 === void 0 ? void 0 : _state$appStates3.conversationState),
36
+ hasReconnectId,
37
+ hasLiveChatContext,
38
+ hasRequestId,
39
+ eligible,
40
+ reason
41
+ };
42
+ };
43
+ export const logRecoveryEligibilityTelemetry = (state, eligible) => {
44
+ try {
45
+ TelemetryHelper.logActionEvent(LogLevel.INFO, {
46
+ Event: TelemetryEvent.RecoveryEligibilityEvaluated,
47
+ CustomProperties: getRecoveryEligibilityTelemetryProperties(state, eligible)
48
+ });
49
+ } catch (error) {
50
+ console.warn(error);
51
+ }
52
+ };