@microsoft/omnichannel-chat-widget 1.8.4-main.2e1ef38 → 1.8.4-main.33bfa22

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 (52) hide show
  1. package/README.md +12 -3
  2. package/lib/cjs/common/facades/FacadeChatSDK.js +235 -9
  3. package/lib/cjs/common/telemetry/TelemetryConstants.js +13 -0
  4. package/lib/cjs/components/livechatwidget/LiveChatWidget.js +9 -1
  5. package/lib/cjs/components/livechatwidget/common/ChatWidgetEvents.js +1 -0
  6. package/lib/cjs/components/livechatwidget/common/PersistentConversationHandler.js +9 -0
  7. package/lib/cjs/components/livechatwidget/common/authHelper.js +44 -4
  8. package/lib/cjs/components/livechatwidget/common/startChat.js +31 -14
  9. package/lib/cjs/components/livechatwidget/livechatwidgetstateful/LiveChatWidgetStateful.js +60 -1
  10. package/lib/cjs/components/webchatcontainerstateful/WebChatContainerStateful.js +11 -3
  11. package/lib/cjs/components/webchatcontainerstateful/common/activityConverters/convertPersistentChatHistoryMessageToActivity.js +92 -19
  12. package/lib/cjs/components/webchatcontainerstateful/common/defaultStyles/defaultWebChatStyles.js +2 -2
  13. package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/WebChatEventSubscribers.js +13 -2
  14. package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activities/LazyLoadActivity.js +160 -167
  15. package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityMiddleware.js +1 -1
  16. package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/defaultStyles/defaultAvatarTextStyles.js +1 -1
  17. package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/defaultStyles/defaultSystemMessageStyles.js +1 -1
  18. package/lib/cjs/contexts/common/LiveChatWidgetActionType.js +1 -0
  19. package/lib/cjs/contexts/common/LiveChatWidgetContextInitialState.js +6 -1
  20. package/lib/cjs/contexts/createReducer.js +15 -0
  21. package/lib/cjs/controller/componentController.js +13 -1
  22. package/lib/cjs/plugins/newMessageEventHandler.js +20 -3
  23. package/lib/esm/common/facades/FacadeChatSDK.js +236 -10
  24. package/lib/esm/common/telemetry/TelemetryConstants.js +13 -0
  25. package/lib/esm/components/livechatwidget/LiveChatWidget.js +9 -1
  26. package/lib/esm/components/livechatwidget/common/ChatWidgetEvents.js +1 -0
  27. package/lib/esm/components/livechatwidget/common/PersistentConversationHandler.js +9 -0
  28. package/lib/esm/components/livechatwidget/common/authHelper.js +44 -4
  29. package/lib/esm/components/livechatwidget/common/startChat.js +31 -14
  30. package/lib/esm/components/livechatwidget/livechatwidgetstateful/LiveChatWidgetStateful.js +60 -1
  31. package/lib/esm/components/webchatcontainerstateful/WebChatContainerStateful.js +11 -3
  32. package/lib/esm/components/webchatcontainerstateful/common/activityConverters/convertPersistentChatHistoryMessageToActivity.js +92 -19
  33. package/lib/esm/components/webchatcontainerstateful/common/defaultStyles/defaultWebChatStyles.js +2 -2
  34. package/lib/esm/components/webchatcontainerstateful/webchatcontroller/WebChatEventSubscribers.js +13 -2
  35. package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activities/LazyLoadActivity.js +160 -171
  36. package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityMiddleware.js +1 -1
  37. package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/defaultStyles/defaultAvatarTextStyles.js +1 -1
  38. package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/defaultStyles/defaultSystemMessageStyles.js +1 -1
  39. package/lib/esm/contexts/common/LiveChatWidgetActionType.js +1 -0
  40. package/lib/esm/contexts/common/LiveChatWidgetContextInitialState.js +6 -1
  41. package/lib/esm/contexts/createReducer.js +15 -0
  42. package/lib/esm/controller/componentController.js +13 -1
  43. package/lib/esm/plugins/newMessageEventHandler.js +20 -3
  44. package/lib/types/common/facades/FacadeChatSDK.d.ts +29 -0
  45. package/lib/types/common/facades/types/IFacadeChatSDKInput.d.ts +3 -1
  46. package/lib/types/common/telemetry/TelemetryConstants.d.ts +13 -2
  47. package/lib/types/components/livechatwidget/common/ChatWidgetEvents.d.ts +2 -1
  48. package/lib/types/components/livechatwidget/common/authHelper.d.ts +9 -2
  49. package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activities/LazyLoadActivity.d.ts +14 -38
  50. package/lib/types/contexts/common/ILiveChatWidgetContext.d.ts +1 -0
  51. package/lib/types/contexts/common/LiveChatWidgetActionType.d.ts +2 -1
  52. package/package.json +4 -4
package/README.md CHANGED
@@ -177,7 +177,7 @@ Header's and Footer's child components consist of three parts:
177
177
  1. "middleGroup" - adding child components in the middle of the Header/Footer
178
178
  1. "rightGroup" - adding child components at the right of the Header/Footer
179
179
 
180
- By default Header has the header icon and title on the left and minimize and close buttons on the right, and Footer has Download Transcript and Email Transcript buttons on the left and audio notification button on the right. These components can be overriden with [ComponentOverrides](#ComponentOverrides). In addition, other custom child components can be added to both Header and Footer by creating custom react nodes and adding them to attributes "leftGroup", "middleGroup" or "rightGroup" of "controlProps".
180
+ By default Header has the header icon and title on the left and minimize and close buttons on the right, and Footer has Download Transcript and Email Transcript buttons on the left and audio notification button on the right. These components can be overriden with [ComponentOverrides](#componentoverrides). In addition, other custom child components can be added to both Header and Footer by creating custom react nodes and adding them to attributes "leftGroup", "middleGroup" or "rightGroup" of "controlProps".
181
181
 
182
182
  ```js
183
183
  const buttonStyleProps: IButtonStyles = {
@@ -224,8 +224,10 @@ const customizedFooterProp: IFooterProps = {
224
224
  > :pushpin: Note that [WebChat hooks](https://github.com/microsoft/BotFramework-WebChat/blob/main/docs/HOOKS.md) can also be used in any custom components.
225
225
 
226
226
  #### Bidirectional Custom Events
227
+
227
228
  - Sending events from a hosting web page to bots/agents
228
- - Register a function to post event
229
+ - Register a function to post event
230
+
229
231
  ```js
230
232
  //define sendCustomEvent function
231
233
  const sendCustomEvent = (payload) => {
@@ -253,7 +255,9 @@ const customizedFooterProp: IFooterProps = {
253
255
  }
254
256
  })
255
257
  ```
256
- - Receiving events from bots/agents
258
+
259
+ - Receiving events from bots/agents
260
+
257
261
  ```js
258
262
  //define setOnCustomEvent function
259
263
  const setOnCustomEvent = (callback) => {
@@ -269,8 +273,10 @@ const customizedFooterProp: IFooterProps = {
269
273
  ```
270
274
 
271
275
  #### Trigger initiateEndChat event
276
+
272
277
  Customer can trigger the initiateEndChat event via BroadcastService to end a chat session.
273
278
  When needed, the payload below could be triggered:
279
+
274
280
  ```js
275
281
  const endChatEvent = {
276
282
  eventName: "InitiateEndChat",
@@ -283,18 +289,21 @@ BroadcastService.postMessage(endChatEvent);
283
289
 
284
290
  The payload of the event is optional, only needed when force closing of a persistent chat session is not required.
285
291
  When chat widget receives the event without any payload, it will:
292
+
286
293
  1. set the widget to closed state, the widget panel will be minimized. Post chat survey will not be displayed.
287
294
  2. trigger a sessionclose service network request to OmniChannel services.
288
295
 
289
296
  If skipSessionCloseForPersistentChat is set to true. The session close network request will not be triggered, instead, if postChat survey is available, post chat survey will be displayed.
290
297
 
291
298
  After successfully processed initiateEndChat event. The CloseChat event is broadcasted.
299
+
292
300
  ```js
293
301
  BroadcastService.getMessageByEventName("CloseChat").subscribe(async (msg) => {
294
302
  console.log("close chat received: ", msg);
295
303
  //more actions to unmount component and resources
296
304
  })
297
305
  ```
306
+
298
307
  ## See Also
299
308
 
300
309
  [Customizations Dev Guide](https://github.com/microsoft/omnichannel-chat-widget/blob/main/docs/customizations/getstarted.md)\
@@ -26,6 +26,8 @@ let FacadeChatSDK = /*#__PURE__*/function () {
26
26
  _defineProperty(this, "getAuthToken", void 0);
27
27
  _defineProperty(this, "sdkMocked", void 0);
28
28
  _defineProperty(this, "disableReauthentication", void 0);
29
+ // Stays true so CASE 1 re-triggers on every startChat to set deferInitialAuth
30
+ _defineProperty(this, "pendingMidAuthUnauthenticatedState", false);
29
31
  this.chatSDK = input.chatSDK;
30
32
  this.chatConfig = input.chatConfig;
31
33
  this.getAuthToken = input.getAuthToken;
@@ -50,6 +52,12 @@ let FacadeChatSDK = /*#__PURE__*/function () {
50
52
  value: function destroy() {
51
53
  this.token = null;
52
54
  this.expiration = 0;
55
+ if ((0, _authHelper.isMidAuthEnabled)(this.chatConfig)) {
56
+ this.pendingMidAuthUnauthenticatedState = false;
57
+ this.isAuthenticated = true;
58
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
59
+ this.chatSDK.deferInitialAuth = false;
60
+ }
53
61
  }
54
62
  }, {
55
63
  key: "isTokenSet",
@@ -214,6 +222,10 @@ let FacadeChatSDK = /*#__PURE__*/function () {
214
222
  message: "Token is valid"
215
223
  };
216
224
  }
225
+
226
+ // Token missing or expired - need to get a new one via getAuthToken
227
+ // For mid-auth: getAuthToken receives { isMidAuthEnabled: true } so customer implementations
228
+ // can check portal state and return null for logged-out users
217
229
  _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {
218
230
  Event: _TelemetryConstants.TelemetryEvent.NewTokenValidationStarted,
219
231
  Description: "Token validation started."
@@ -234,6 +246,7 @@ let FacadeChatSDK = /*#__PURE__*/function () {
234
246
  this.token = "";
235
247
  this.expiration = 0;
236
248
  try {
249
+ var _ring$error, _ring$error2;
237
250
  const ring = await (0, _authHelper.handleAuthentication)(this.chatSDK, this.chatConfig, this.getAuthToken);
238
251
  if ((ring === null || ring === void 0 ? void 0 : ring.result) === true && ring !== null && ring !== void 0 && ring.token) {
239
252
  await this.setToken(ring.token);
@@ -248,18 +261,35 @@ let FacadeChatSDK = /*#__PURE__*/function () {
248
261
  result: true,
249
262
  message: "New Token obtained"
250
263
  };
251
- } else {
252
- var _ring$error, _ring$error2;
253
- _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEventToAllTelemetry(_TelemetryConstants.LogLevel.ERROR, {
254
- Event: _TelemetryConstants.TelemetryEvent.NewTokenValidationFailed,
255
- Description: (_ring$error = ring.error) === null || _ring$error === void 0 ? void 0 : _ring$error.message,
256
- ExceptionDetails: ring === null || ring === void 0 ? void 0 : ring.error
264
+ }
265
+
266
+ // Mid-auth: no token available - set pending flag for startChat to handle
267
+ const isEmptyTokenWithoutError = (0, _utils.isNullOrEmptyString)(ring === null || ring === void 0 ? void 0 : ring.token) && ((ring === null || ring === void 0 ? void 0 : ring.result) === true || (ring === null || ring === void 0 ? void 0 : ring.result) === false && !(ring !== null && ring !== void 0 && ring.error));
268
+ if ((0, _authHelper.isMidAuthEnabled)(this.chatConfig) && isEmptyTokenWithoutError) {
269
+ // Clear Facade and SDK token state so API calls use unauthenticated endpoints
270
+ this.token = "";
271
+ this.expiration = 0;
272
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
273
+ this.chatSDK.authenticatedUserToken = null;
274
+ this.pendingMidAuthUnauthenticatedState = true;
275
+ _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {
276
+ Event: _TelemetryConstants.TelemetryEvent.NewTokenValidationCompleted,
277
+ Description: "Mid-auth enabled: no token returned; proceeding as unauthenticated"
257
278
  });
258
279
  return {
259
- result: false,
260
- message: (ring === null || ring === void 0 ? void 0 : (_ring$error2 = ring.error) === null || _ring$error2 === void 0 ? void 0 : _ring$error2.message) || "Failed to get token"
280
+ result: true,
281
+ message: "Mid-auth: proceeding as unauthenticated"
261
282
  };
262
283
  }
284
+ _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEventToAllTelemetry(_TelemetryConstants.LogLevel.ERROR, {
285
+ Event: _TelemetryConstants.TelemetryEvent.NewTokenValidationFailed,
286
+ Description: (_ring$error = ring.error) === null || _ring$error === void 0 ? void 0 : _ring$error.message,
287
+ ExceptionDetails: ring === null || ring === void 0 ? void 0 : ring.error
288
+ });
289
+ return {
290
+ result: false,
291
+ message: (ring === null || ring === void 0 ? void 0 : (_ring$error2 = ring.error) === null || _ring$error2 === void 0 ? void 0 : _ring$error2.message) || "Failed to get token"
292
+ };
263
293
  } catch (e) {
264
294
  console.error("Unexpected error while getting token", e);
265
295
  _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEventToAllTelemetry(_TelemetryConstants.LogLevel.ERROR, {
@@ -273,6 +303,155 @@ let FacadeChatSDK = /*#__PURE__*/function () {
273
303
  };
274
304
  }
275
305
  }
306
+
307
+ /**
308
+ * Sets unauthenticated state for mid-auth flow.
309
+ * Clears SDK internal state to prevent reconnection to previous authenticated session.
310
+ */
311
+ }, {
312
+ key: "setMidAuthUnauthenticatedState",
313
+ value: function setMidAuthUnauthenticatedState() {
314
+ var _sdk$chatToken, _sdk$chatToken2;
315
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
316
+ const sdk = this.chatSDK;
317
+ const hadExistingChat = !!((_sdk$chatToken = sdk.chatToken) !== null && _sdk$chatToken !== void 0 && _sdk$chatToken.chatId);
318
+ const previousChatId = (_sdk$chatToken2 = sdk.chatToken) === null || _sdk$chatToken2 === void 0 ? void 0 : _sdk$chatToken2.chatId;
319
+ this.clearAuthState();
320
+
321
+ // Clear SDK internal state for fresh unauthenticated chat
322
+ sdk.chatToken = {};
323
+ sdk.reconnectId = null;
324
+ sdk.requestId = null;
325
+ sdk.sessionId = null;
326
+ sdk.conversation = null;
327
+ _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {
328
+ Event: _TelemetryConstants.TelemetryEvent.MidConversationAuthReset,
329
+ Description: hadExistingChat ? "Mid-auth without token: local state cleared" : "Mid-auth: initialized as unauthenticated (no prior chat)",
330
+ Data: hadExistingChat ? {
331
+ previousChatId
332
+ } : undefined
333
+ });
334
+ }
335
+
336
+ /** Clears authentication state in both FacadeChatSDK and underlying SDK */
337
+ }, {
338
+ key: "clearAuthState",
339
+ value: function clearAuthState() {
340
+ this.token = "";
341
+ this.expiration = 0;
342
+ this.isAuthenticated = false;
343
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
344
+ this.chatSDK.authenticatedUserToken = null;
345
+ }
346
+
347
+ /**
348
+ * Migrates conversation from unauthenticated to authenticated via authenticateChat.
349
+ * Called after startChat() when user has a valid token but the backend conversation
350
+ * was started as unauthenticated.
351
+ */
352
+ }, {
353
+ key: "migrateConversationToAuthenticated",
354
+ value: async function migrateConversationToAuthenticated() {
355
+ try {
356
+ await this.chatSDK.authenticateChat(this.token, {
357
+ refreshChatToken: true
358
+ });
359
+ this.isAuthenticated = true;
360
+ _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {
361
+ Event: _TelemetryConstants.TelemetryEvent.MidConversationAuthSucceeded,
362
+ Description: "Mid-auth: authenticateChat completed, conversation migrated to authenticated"
363
+ });
364
+ } catch (e) {
365
+ // Non-fatal: Chat is already active via startChat, will retry on next reconnect
366
+ _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEventToAllTelemetry(_TelemetryConstants.LogLevel.WARN, {
367
+ Event: _TelemetryConstants.TelemetryEvent.MidConversationAuthFailed,
368
+ Description: "Mid-auth: authenticateChat returned error after startChat, chat still active",
369
+ ExceptionDetails: {
370
+ message: e === null || e === void 0 ? void 0 : e.message
371
+ }
372
+ });
373
+ }
374
+ }
375
+
376
+ /**
377
+ * Configures SDK auth state before startChat.
378
+ * CASE 1: Pending unauthenticated (no token) - sets deferInitialAuth=true
379
+ * CASE 2: Authenticated with valid token - sets SDK token and deferInitialAuth based on scenario
380
+ */
381
+ }, {
382
+ key: "configureMidAuthState",
383
+ value: function configureMidAuthState(isReconnect, wasPreviousSessionAuthenticated) {
384
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
385
+ const sdk = this.chatSDK;
386
+
387
+ // CASE 1: No token available (user not logged in)
388
+ // pendingMidAuthUnauthenticatedState stays true until user logs in (cleared in tokenRing)
389
+ if (this.pendingMidAuthUnauthenticatedState) {
390
+ const shouldClear = this.handlePendingUnauthenticatedState(wasPreviousSessionAuthenticated);
391
+ sdk.deferInitialAuth = true;
392
+ _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {
393
+ Event: _TelemetryConstants.TelemetryEvent.MidConversationAuthReset,
394
+ Description: "Mid-auth configureMidAuthState: CASE 1 - unauthenticated, deferInitialAuth=true",
395
+ Data: {
396
+ isReconnect: String(isReconnect),
397
+ wasPreviousSessionAuthenticated: String(wasPreviousSessionAuthenticated),
398
+ shouldClearReconnectParams: String(shouldClear)
399
+ }
400
+ });
401
+ return {
402
+ shouldClearReconnectParams: shouldClear
403
+ };
404
+ }
405
+
406
+ // CASE 2: Authenticated with valid token
407
+ if (this.isTokenSet() && !this.isTokenExpired()) {
408
+ this.handleAuthenticatedState(isReconnect, wasPreviousSessionAuthenticated);
409
+ }
410
+ return {
411
+ shouldClearReconnectParams: false
412
+ };
413
+ }
414
+
415
+ /**
416
+ * CASE 1 handler: Returns true if reconnect params should be cleared (Auth -> Unauth transition)
417
+ */
418
+ }, {
419
+ key: "handlePendingUnauthenticatedState",
420
+ value: function handlePendingUnauthenticatedState(wasPreviousSessionAuthenticated) {
421
+ if (wasPreviousSessionAuthenticated) {
422
+ // Auth -> Unauth: user logged out, clear state for fresh chat
423
+ this.setMidAuthUnauthenticatedState();
424
+ return true;
425
+ }
426
+
427
+ // Unauth -> Unauth: keep liveChatContext for reconnection
428
+ this.isAuthenticated = false;
429
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
430
+ this.chatSDK.authenticatedUserToken = null;
431
+ return false;
432
+ }
433
+
434
+ /**
435
+ * CASE 2 handler: Sets deferInitialAuth only for reconnects to unauthenticated sessions (need migration).
436
+ * For new chats or reconnects to authenticated sessions, SDK handles auth internally.
437
+ */
438
+ }, {
439
+ key: "handleAuthenticatedState",
440
+ value: function handleAuthenticatedState(isReconnect, wasPreviousSessionAuthenticated) {
441
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
442
+ const sdk = this.chatSDK;
443
+ sdk.authenticatedUserToken = this.token;
444
+ if (isReconnect && !wasPreviousSessionAuthenticated) {
445
+ sdk.deferInitialAuth = true;
446
+ _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {
447
+ Event: _TelemetryConstants.TelemetryEvent.MidConversationAuthSucceeded,
448
+ Description: "Mid-auth handleAuthenticatedState: CASE 2 - reconnect to unauth session, deferInitialAuth=true (migration needed)"
449
+ });
450
+ } else {
451
+ // Reset to prevent inheriting deferInitialAuth=true from a previous unauthenticated chat
452
+ sdk.deferInitialAuth = false;
453
+ }
454
+ }
276
455
  }, {
277
456
  key: "validateAndExecuteCall",
278
457
  value: async function validateAndExecuteCall(functionName, fn) {
@@ -307,7 +486,53 @@ let FacadeChatSDK = /*#__PURE__*/function () {
307
486
  key: "startChat",
308
487
  value: async function startChat() {
309
488
  let optionalParams = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
310
- return this.validateAndExecuteCall("startChat", () => this.chatSDK.startChat(optionalParams));
489
+ const midAuthEnabled = (0, _authHelper.isMidAuthEnabled)(this.chatConfig);
490
+ const isReconnect = !!optionalParams.liveChatContext || !!optionalParams.reconnectId;
491
+ const wasPreviousSessionAuthenticated = optionalParams.wasAuthenticated === true;
492
+ return this.validateAndExecuteCall("startChat", async () => {
493
+ if (midAuthEnabled) {
494
+ const {
495
+ shouldClearReconnectParams
496
+ } = this.configureMidAuthState(isReconnect, wasPreviousSessionAuthenticated);
497
+ if (shouldClearReconnectParams) {
498
+ delete optionalParams.liveChatContext;
499
+ delete optionalParams.reconnectId;
500
+ }
501
+ }
502
+ await this.chatSDK.startChat(optionalParams);
503
+
504
+ // Migrate to authenticated if needed (reconnects to unauthenticated sessions only)
505
+ if (midAuthEnabled) {
506
+ const shouldMigrateToAuth = isReconnect && this.isTokenSet() && !this.isTokenExpired() && !wasPreviousSessionAuthenticated;
507
+ if (shouldMigrateToAuth) {
508
+ _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEventToAllTelemetry(_TelemetryConstants.LogLevel.INFO, {
509
+ Event: _TelemetryConstants.TelemetryEvent.MidConversationAuthSucceeded,
510
+ Description: "Mid-auth startChat: initiating migration to authenticated",
511
+ Data: {
512
+ isReconnect: String(isReconnect),
513
+ wasPreviousSessionAuthenticated: String(wasPreviousSessionAuthenticated)
514
+ }
515
+ });
516
+ await this.migrateConversationToAuthenticated();
517
+ }
518
+ }
519
+
520
+ // Broadcast final auth state after startChat completes (only on state change)
521
+ if (midAuthEnabled) {
522
+ const isAuthenticatedAfterStart = this.isTokenSet() && !this.isTokenExpired();
523
+ const authStateChanged = !isReconnect || isAuthenticatedAfterStart !== wasPreviousSessionAuthenticated;
524
+ if (authStateChanged) {
525
+ _omnichannelChatComponents.BroadcastService.postMessage({
526
+ eventName: isAuthenticatedAfterStart ? _TelemetryConstants.BroadcastEvent.MidConversationAuthSucceeded : _TelemetryConstants.BroadcastEvent.MidConversationAuthReset,
527
+ payload: {
528
+ isAuthenticated: isAuthenticatedAfterStart,
529
+ isStartChatComplete: true,
530
+ isReconnect
531
+ }
532
+ });
533
+ }
534
+ }
535
+ });
311
536
  }
312
537
  }, {
313
538
  key: "endChat",
@@ -445,6 +670,7 @@ let FacadeChatSDK = /*#__PURE__*/function () {
445
670
  let optionalParams = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
446
671
  return this.validateAndExecuteCall("getAgentAvailability", () => this.chatSDK.getAgentAvailability(optionalParams));
447
672
  }
673
+
448
674
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
449
675
  }, {
450
676
  key: "getReconnectableChats",
@@ -74,6 +74,8 @@ exports.BroadcastEvent = BroadcastEvent;
74
74
  BroadcastEvent["FMLTrackingCompletedAck"] = "FMLTrackingCompletedAck";
75
75
  BroadcastEvent["FMLTrackingCompleted"] = "FMLTrackingCompleted";
76
76
  BroadcastEvent["PersistentConversationReset"] = "PersistentConversationReset";
77
+ BroadcastEvent["MidConversationAuthSucceeded"] = "MidConversationAuthSucceeded";
78
+ BroadcastEvent["MidConversationAuthReset"] = "MidConversationAuthReset";
77
79
  })(BroadcastEvent || (exports.BroadcastEvent = BroadcastEvent = {}));
78
80
  let TelemetryEvent;
79
81
  exports.TelemetryEvent = TelemetryEvent;
@@ -108,6 +110,9 @@ exports.TelemetryEvent = TelemetryEvent;
108
110
  TelemetryEvent["CallingSDKInitFailed"] = "CallingSDKInitFailed";
109
111
  TelemetryEvent["CallingSDKLoadSuccess"] = "CallingSDKLoadSuccess";
110
112
  TelemetryEvent["CallingSDKLoadFailed"] = "CallingSDKLoadFailed";
113
+ TelemetryEvent["MidConversationAuthSucceeded"] = "MidConversationAuthSucceeded";
114
+ TelemetryEvent["MidConversationAuthFailed"] = "MidConversationAuthFailed";
115
+ TelemetryEvent["MidConversationAuthReset"] = "MidConversationAuthReset";
111
116
  TelemetryEvent["GetConversationDetailsCallStarted"] = "GetConversationDetailsCallStarted";
112
117
  TelemetryEvent["GetConversationDetailsCallFailed"] = "GetConversationDetailsCallFailed";
113
118
  TelemetryEvent["EndChatSDKCallFailed"] = "EndChatSDKCallFailed";
@@ -318,10 +323,16 @@ exports.TelemetryEvent = TelemetryEvent;
318
323
  TelemetryEvent["LCWLazyLoadNoMoreHistory"] = "LCWLazyLoadNoMoreHistory";
319
324
  TelemetryEvent["LCWLazyLoadHistoryError"] = "LCWLazyLoadHistoryError";
320
325
  TelemetryEvent["LCWLazyLoadDestroyed"] = "LCWLazyLoadDestroyed";
326
+ TelemetryEvent["LCWLazyLoadTriggerFired"] = "LCWLazyLoadTriggerFired";
327
+ TelemetryEvent["LCWLazyLoadBatchReceived"] = "LCWLazyLoadBatchReceived";
328
+ TelemetryEvent["LCWLazyLoadInitialLoadComplete"] = "LCWLazyLoadInitialLoadComplete";
329
+ TelemetryEvent["LCWLazyLoadScrollAnchorApplied"] = "LCWLazyLoadScrollAnchorApplied";
321
330
  TelemetryEvent["SecureEventBusUnauthorizedDispatch"] = "SecureEventBusUnauthorizedDispatch";
322
331
  TelemetryEvent["SecureEventBusListenerError"] = "SecureEventBusListenerError";
323
332
  TelemetryEvent["SecureEventBusDispatchError"] = "SecureEventBusDispatchError";
324
333
  TelemetryEvent["StartChatComplete"] = "StartChatComplete";
334
+ TelemetryEvent["AgentJoinedConversation"] = "AgentJoinedConversation";
335
+ TelemetryEvent["BrowserTabHidden"] = "BrowserTabHidden";
325
336
  })(TelemetryEvent || (exports.TelemetryEvent = TelemetryEvent = {}));
326
337
  let TelemetryConstants = /*#__PURE__*/function () {
327
338
  function TelemetryConstants() {
@@ -392,6 +403,8 @@ let TelemetryConstants = /*#__PURE__*/function () {
392
403
  case TelemetryEvent.SecureEventBusUnauthorizedDispatch:
393
404
  case TelemetryEvent.SecureEventBusListenerError:
394
405
  case TelemetryEvent.SecureEventBusDispatchError:
406
+ case TelemetryEvent.AgentJoinedConversation:
407
+ case TelemetryEvent.BrowserTabHidden:
395
408
  return ScenarioType.ACTIONS;
396
409
  case TelemetryEvent.StartChatSDKCall:
397
410
  case TelemetryEvent.StartChatEventReceived:
@@ -35,8 +35,16 @@ const LiveChatWidget = props => {
35
35
  throw new Error("chatConfig is required");
36
36
  }
37
37
 
38
+ // Check configuration flags
38
39
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
39
- const isAuthenticatedChat = !!((_props$chatConfig = props.chatConfig) !== null && _props$chatConfig !== void 0 && (_props$chatConfig$Liv = _props$chatConfig.LiveChatConfigAuthSettings) !== null && _props$chatConfig$Liv !== void 0 && _props$chatConfig$Liv.msdyn_javascriptclientfunction) || (0, _liveChatConfigUtils.isPersistentChatEnabled)((_props$chatConfig2 = props.chatConfig) === null || _props$chatConfig2 === void 0 ? void 0 : (_props$chatConfig2$Li = _props$chatConfig2.LiveWSAndLiveChatEngJoin) === null || _props$chatConfig2$Li === void 0 ? void 0 : _props$chatConfig2$Li.msdyn_conversationmode);
40
+ const hasAuthClientFn = !!((_props$chatConfig = props.chatConfig) !== null && _props$chatConfig !== void 0 && (_props$chatConfig$Liv = _props$chatConfig.LiveChatConfigAuthSettings) !== null && _props$chatConfig$Liv !== void 0 && _props$chatConfig$Liv.msdyn_javascriptclientfunction);
41
+ const persistentChatEnabled = (0, _liveChatConfigUtils.isPersistentChatEnabled)((_props$chatConfig2 = props.chatConfig) === null || _props$chatConfig2 === void 0 ? void 0 : (_props$chatConfig2$Li = _props$chatConfig2.LiveWSAndLiveChatEngJoin) === null || _props$chatConfig2$Li === void 0 ? void 0 : _props$chatConfig2$Li.msdyn_conversationmode);
42
+
43
+ // isAuthenticatedChat determines if FacadeChatSDK should require authentication:
44
+ // REGULAR AUTH FLOW (config-based):
45
+ // - Persistent chat enabled ? always authenticated
46
+ // - Auth settings exist ? authenticated from start
47
+ const isAuthenticatedChat = persistentChatEnabled || hasAuthClientFn;
40
48
  if (!facadeChatSDK) {
41
49
  var _props$mock;
42
50
  setFacadeChatSDK(new _FacadeChatSDK.FacadeChatSDK({
@@ -10,6 +10,7 @@ var ChatWidgetEvents;
10
10
  ChatWidgetEvents["FETCH_PERSISTENT_CHAT_HISTORY"] = "CHAT_WIDGET/FETCH_PERSISTENT_CHAT_HISTORY";
11
11
  ChatWidgetEvents["NO_MORE_HISTORY_AVAILABLE"] = "CHAT_WIDGET/NO_MORE_HISTORY_AVAILABLE";
12
12
  ChatWidgetEvents["HISTORY_LOAD_ERROR"] = "CHAT_WIDGET/HISTORY_LOAD_ERROR";
13
+ ChatWidgetEvents["HISTORY_BATCH_LOADED"] = "CHAT_WIDGET/HISTORY_BATCH_LOADED";
13
14
  })(ChatWidgetEvents || (ChatWidgetEvents = {}));
14
15
  var _default = ChatWidgetEvents;
15
16
  exports.default = _default;
@@ -133,6 +133,12 @@ let PersistentConversationHandler = /*#__PURE__*/function () {
133
133
  }
134
134
  const messagesDescOrder = (_ref = [...messages]) === null || _ref === void 0 ? void 0 : _ref.reverse();
135
135
  this.processHistoryMessages(messagesDescOrder);
136
+
137
+ // Signal that a batch of history messages has been added to the store.
138
+ // LazyLoadActivity subscribes to this to apply scroll anchoring after render.
139
+ (0, _dispatchCustomEvent.default)(_ChatWidgetEvents.default.HISTORY_BATCH_LOADED, {
140
+ messageCount: messages.length
141
+ });
136
142
  _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
137
143
  Event: _TelemetryConstants.TelemetryEvent.LCWPersistentHistoryPullCompleted,
138
144
  Description: "History pull completed successfully",
@@ -241,6 +247,9 @@ let PersistentConversationHandler = /*#__PURE__*/function () {
241
247
  value: function processMessageToActivity(message) {
242
248
  try {
243
249
  const activity = (0, _convertPersistentChatHistoryMessageToActivity.default)(message);
250
+ if (!activity) {
251
+ return null;
252
+ }
244
253
  activity.id = activity.id || `activity-${this.count}`;
245
254
  activity.channelData = {
246
255
  ...activity.channelData,
@@ -3,11 +3,22 @@
3
3
  Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
- exports.removeAuthTokenProvider = exports.handleAuthentication = exports.getAuthClientFunction = void 0;
6
+ exports.removeAuthTokenProvider = exports.isMidAuthEnabled = exports.handleAuthentication = exports.getAuthClientFunction = void 0;
7
7
  var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants");
8
8
  var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
9
9
  var _Constants = require("../../../common/Constants");
10
10
  var _utils = require("../../../common/utils");
11
+ /**
12
+ * Check if mid-auth is enabled based on chatConfig.
13
+ * Mid-auth flag lives under LiveWSAndLiveChatEngJoin.msdyn_authenticatedsigninoptional.
14
+ */
15
+ const isMidAuthEnabled = chatConfig => {
16
+ var _chatConfig$LiveWSAnd, _value$toString, _value$toString$call$, _value$toString$call;
17
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
18
+ const value = chatConfig === null || chatConfig === void 0 ? void 0 : (_chatConfig$LiveWSAnd = chatConfig.LiveWSAndLiveChatEngJoin) === null || _chatConfig$LiveWSAnd === void 0 ? void 0 : _chatConfig$LiveWSAnd.msdyn_authenticatedsigninoptional;
19
+ return (value === null || value === void 0 ? void 0 : (_value$toString = value.toString) === null || _value$toString === void 0 ? void 0 : (_value$toString$call$ = (_value$toString$call = _value$toString.call(value)).toLowerCase) === null || _value$toString$call$ === void 0 ? void 0 : _value$toString$call$.call(_value$toString$call)) === "true";
20
+ };
21
+ exports.isMidAuthEnabled = isMidAuthEnabled;
11
22
  const getAuthClientFunction = chatConfig => {
12
23
  let authClientFunction = undefined;
13
24
  if (chatConfig !== null && chatConfig !== void 0 && chatConfig.LiveChatConfigAuthSettings) {
@@ -19,12 +30,17 @@ const getAuthClientFunction = chatConfig => {
19
30
  exports.getAuthClientFunction = getAuthClientFunction;
20
31
  const handleAuthentication = async (chatSDK, chatConfig, getAuthToken) => {
21
32
  var _chatSDK$chatSDKConfi;
33
+ const midAuthEnabled = isMidAuthEnabled(chatConfig);
22
34
  const authClientFunction = getAuthClientFunction(chatConfig);
23
35
  if (getAuthToken && authClientFunction) {
24
36
  _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
25
37
  Event: _TelemetryConstants.TelemetryEvent.GetAuthTokenCalled
26
38
  });
27
- const token = await getAuthToken(authClientFunction);
39
+
40
+ // Only pass isMidAuthEnabled option when mid-auth is enabled.
41
+ const token = midAuthEnabled ? await getAuthToken(authClientFunction, {
42
+ isMidAuthEnabled: midAuthEnabled
43
+ }) : await getAuthToken(authClientFunction);
28
44
  if (!(0, _utils.isNullOrEmptyString)(token)) {
29
45
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
30
46
  chatSDK.setAuthTokenProvider(async () => {
@@ -35,8 +51,21 @@ const handleAuthentication = async (chatSDK, chatConfig, getAuthToken) => {
35
51
  "token": token
36
52
  };
37
53
  } else {
38
- // instead of returning false, it's more appropiate to thrown an error to force error handling on the caller side
39
- // this will help to avoid the error to be ignored and the chat to be started
54
+ // For mid-auth scenarios, empty token means "user not signed in" - this is expected behavior.
55
+ // Return result: true with empty token so caller can decide to proceed unauthenticated.
56
+ if (midAuthEnabled) {
57
+ // Expected behavior for mid-auth: user not signed in
58
+ _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
59
+ Event: _TelemetryConstants.TelemetryEvent.GetAuthTokenCalled,
60
+ Description: "Mid-auth: token provider returned empty; user not signed in"
61
+ });
62
+ return {
63
+ "result": true,
64
+ "token": null
65
+ };
66
+ }
67
+
68
+ // For non-mid-auth scenarios, empty token is an error
40
69
  _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.ERROR, {
41
70
  Event: _TelemetryConstants.TelemetryEvent.ReceivedNullOrEmptyToken
42
71
  });
@@ -46,6 +75,17 @@ const handleAuthentication = async (chatSDK, chatConfig, getAuthToken) => {
46
75
  var _chatSDK$chatSDKConfi2;
47
76
  const token = await ((_chatSDK$chatSDKConfi2 = chatSDK.chatSDKConfig) === null || _chatSDK$chatSDKConfi2 === void 0 ? void 0 : _chatSDK$chatSDKConfi2.getAuthToken());
48
77
  if ((0, _utils.isNullOrEmptyString)(token)) {
78
+ // For mid-auth scenarios, empty token from SDK's getAuthToken is also expected
79
+ if (midAuthEnabled) {
80
+ _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
81
+ Event: _TelemetryConstants.TelemetryEvent.GetAuthTokenCalled,
82
+ Description: "Mid-auth: SDK getAuthToken returned empty; user not signed in"
83
+ });
84
+ return {
85
+ "result": true,
86
+ "token": null
87
+ };
88
+ }
49
89
  _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.ERROR, {
50
90
  Event: _TelemetryConstants.TelemetryEvent.ReceivedNullOrEmptyToken,
51
91
  Description: "getAuthToken in chat SDK returns empty string"