@microsoft/omnichannel-chat-widget 1.7.4-main.c391e9f → 1.7.4-main.c715d8f

package/lib/cjs/common/telemetry/TelemetryHelper.js

@@ -21,6 +21,7 @@ class TelemetryHelper {
       case _TelemetryConstants.ScenarioType.WEBCHAT:
         return TelemetryHelper.conformToWebChatContract(level, input);
       case _TelemetryConstants.ScenarioType.OCCHATSDK:
+      case _TelemetryConstants.ScenarioType.SDK:
         return TelemetryHelper.conformToOCChatSDKContract(level, input);
       case _TelemetryConstants.ScenarioType.ACTIONS:
         return TelemetryHelper.conformToActionsContract(level, input);
@@ -156,6 +157,7 @@ class TelemetryHelper {
       event.TransactionId = payload.TransactionId;
       event.ElapsedTimeInMilliseconds = payload.ElapsedTimeInMilliseconds;
       event.ExceptionDetails = JSON.stringify(payload.ExceptionDetails);
+      event.Description = payload.Description;
     });
   }
   static addChatConfigDataToTelemetry(chatConfig, telemetryInternalData) {

package/lib/cjs/components/footerstateful/FooterStateful.js

@@ -17,12 +17,13 @@ var _TelemetryHelper = require("../../common/telemetry/TelemetryHelper");
 var _DownloadTranscriptStateful = require("./downloadtranscriptstateful/DownloadTranscriptStateful");
 var _useChatContextStore = _interopRequireDefault(require("../../hooks/useChatContextStore"));
 var _useChatSDKStore = _interopRequireDefault(require("../../hooks/useChatSDKStore"));
+var _ConversationState = require("../../contexts/common/ConversationState");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const FooterStateful = props => {
-  var _footerProps$controlP3, _footerProps$controlP6;
+  var _footerProps$controlP3;
   const [state, dispatch] = (0, _useChatContextStore.default)();
   // hideFooterDisplay - the purpose of this is to keep the footer always "active",
   // but hide it visually in certain states (e.g., loading state) and show in some other states (e.g. active state).
@@ -90,21 +91,23 @@ const FooterStateful = props => {
     }
   };
   (0, _react.useEffect)(() => {
-    if (state.appStates.isAudioMuted === null) {
-      var _footerProps$controlP4, _footerProps$controlP5;
-      dispatch({
-        type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_AUDIO_NOTIFICATION,
-        payload: (footerProps === null || footerProps === void 0 ? void 0 : (_footerProps$controlP4 = footerProps.controlProps) === null || _footerProps$controlP4 === void 0 ? void 0 : (_footerProps$controlP5 = _footerProps$controlP4.audioNotificationButtonProps) === null || _footerProps$controlP5 === void 0 ? void 0 : _footerProps$controlP5.isAudioMuted) ?? false
-      });
+    if (state.appStates.conversationState === _ConversationState.ConversationState.Active) {
+      if (state.appStates.isAudioMuted === null) {
+        var _footerProps$controlP4, _footerProps$controlP5, _footerProps$controlP6;
+        dispatch({
+          type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_AUDIO_NOTIFICATION,
+          payload: footerProps !== null && footerProps !== void 0 && (_footerProps$controlP4 = footerProps.controlProps) !== null && _footerProps$controlP4 !== void 0 && _footerProps$controlP4.hideAudioNotificationButton ? true : (footerProps === null || footerProps === void 0 ? void 0 : (_footerProps$controlP5 = footerProps.controlProps) === null || _footerProps$controlP5 === void 0 ? void 0 : (_footerProps$controlP6 = _footerProps$controlP5.audioNotificationButtonProps) === null || _footerProps$controlP6 === void 0 ? void 0 : _footerProps$controlP6.isAudioMuted) ?? false
+        });
+      }
     }
-  }, []);
+  }, [state.appStates.conversationState]);
   return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, !hideFooterDisplay && /*#__PURE__*/_react.default.createElement(_omnichannelChatComponents.Footer, {
     componentOverrides: footerProps === null || footerProps === void 0 ? void 0 : footerProps.componentOverrides,
     controlProps: controlProps,
     styleProps: footerProps === null || footerProps === void 0 ? void 0 : footerProps.styleProps
   }), /*#__PURE__*/_react.default.createElement(_AudioNotificationStateful.default, {
     audioSrc: (audioNotificationProps === null || audioNotificationProps === void 0 ? void 0 : audioNotificationProps.audioSrc) ?? _Audios.NewMessageNotificationSoundBase64,
-    isAudioMuted: state.appStates.isAudioMuted === null ? (footerProps === null || footerProps === void 0 ? void 0 : (_footerProps$controlP6 = footerProps.controlProps) === null || _footerProps$controlP6 === void 0 ? void 0 : _footerProps$controlP6.hideAudioNotificationButton) ?? false : state.appStates.isAudioMuted ?? false
+    isAudioMuted: state.appStates.isAudioMuted ?? false
   }));
 };
 exports.FooterStateful = FooterStateful;

package/lib/cjs/components/headerstateful/HeaderStateful.js

@@ -88,6 +88,10 @@ const HeaderStateful = props => {
       text: "We're Offline"
     },
     onMinimizeClick: () => {
+      _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
+        Event: _TelemetryConstants.TelemetryEvent.HeaderMinimizeButtonClicked,
+        Description: "Header Minimize button clicked."
+      });
       dispatch({
         type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_MINIMIZED,
         payload: true

package/lib/cjs/components/livechatwidget/common/endChat.js

@@ -4,8 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.prepareEndChat = exports.endVoiceVideoCallIfOngoing = exports.endChatStateCleanUp = exports.endChat = exports.closeChatStateCleanUp = exports.chatSDKStateCleanUp = exports.callingStateCleanUp = void 0;
-var _Constants = require("../../../common/Constants");
 var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants");
+var _Constants = require("../../../common/Constants");
 var _utils = require("../../../common/utils");
 var _renderSurveyHelpers = require("./renderSurveyHelpers");
 var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components");
@@ -140,21 +140,25 @@ const prepareEndChat = async (props, chatSDK, state, dispatch, setAdapter, setWe
 exports.prepareEndChat = prepareEndChat;
 const endChat = async (props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, skipEndChatSDK, skipCloseChat, postMessageToOtherTab) => {
   if (!skipEndChatSDK && chatSDK.conversation) {
+    var _inMemoryState$appSta;
+    const inMemoryState = (0, _createReducer.executeReducer)(state, {
+      type: _LiveChatWidgetActionType.LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
+      payload: null
+    });
+    const endChatOptionalParameters = {
+      isSessionEnded: inMemoryState === null || inMemoryState === void 0 ? void 0 : (_inMemoryState$appSta = inMemoryState.appStates) === null || _inMemoryState$appSta === void 0 ? void 0 : _inMemoryState$appSta.chatDisconnectEventReceived
+    };
     try {
       _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
         Event: _TelemetryConstants.TelemetryEvent.EndChatSDKCall
       });
       //Get auth token again if chat continued for longer time, otherwise gets 401 error
       await (0, _authHelper.handleAuthentication)(chatSDK, props.chatConfig, props.getAuthToken);
-      await (chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.endChat());
+      await (chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.endChat(endChatOptionalParameters));
     } catch (ex) {
-      var _inMemoryState$appSta;
-      const inMemoryState = (0, _createReducer.executeReducer)(state, {
-        type: _LiveChatWidgetActionType.LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
-        payload: null
-      });
+      var _inMemoryState$appSta2;
       // if the chat was disconnected or ended by the agent, we don't want to log the error
-      if (!(inMemoryState !== null && inMemoryState !== void 0 && (_inMemoryState$appSta = inMemoryState.appStates) !== null && _inMemoryState$appSta !== void 0 && _inMemoryState$appSta.chatDisconnectEventReceived)) {
+      if (!(inMemoryState !== null && inMemoryState !== void 0 && (_inMemoryState$appSta2 = inMemoryState.appStates) !== null && _inMemoryState$appSta2 !== void 0 && _inMemoryState$appSta2.chatDisconnectEventReceived)) {
         _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.ERROR, {
           Event: _TelemetryConstants.TelemetryEvent.EndChatSDKCallFailed,
           ExceptionDetails: {
@@ -171,7 +175,7 @@ const endChat = async (props, chatSDK, state, dispatch, setAdapter, setWebChatSt
       }
       postMessageToOtherTab = false;
     } finally {
-      await endChatStateCleanUp(dispatch);
+      endChatStateCleanUp(dispatch);
     }
   }
   if (!skipCloseChat) {

package/lib/cjs/components/livechatwidget/common/startChat.js

@@ -377,14 +377,14 @@ const checkIfConversationStillValid = async (chatSDK, dispatch, state) => {
   try {
     chatSDK.requestId = requestIdFromCache;
     conversationDetails = await (0, _utils.getConversationDetailsCall)(chatSDK, liveChatContext);
-    if (Object.keys(conversationDetails).length === 0) {
-      return false;
-    }
-    if (conversationDetails.state === _Constants.LiveWorkItemState.Closed || conversationDetails.state === _Constants.LiveWorkItemState.WrapUp) {
+    if (Object.keys(conversationDetails).length === 0 || (0, _utils.isNullOrUndefined)(conversationDetails.state) || conversationDetails.state === _Constants.LiveWorkItemState.Closed || conversationDetails.state === _Constants.LiveWorkItemState.WrapUp) {
       dispatch({
         type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_LIVE_CHAT_CONTEXT,
         payload: undefined
       });
+      if (currentRequestId) {
+        chatSDK.requestId = currentRequestId;
+      }
       return false;
     }
     return true;

package/lib/esm/common/telemetry/TelemetryHelper.js

@@ -15,6 +15,7 @@ export class TelemetryHelper {
       case ScenarioType.WEBCHAT:
         return TelemetryHelper.conformToWebChatContract(level, input);
       case ScenarioType.OCCHATSDK:
+      case ScenarioType.SDK:
         return TelemetryHelper.conformToOCChatSDKContract(level, input);
       case ScenarioType.ACTIONS:
         return TelemetryHelper.conformToActionsContract(level, input);
@@ -150,6 +151,7 @@ export class TelemetryHelper {
       event.TransactionId = payload.TransactionId;
       event.ElapsedTimeInMilliseconds = payload.ElapsedTimeInMilliseconds;
       event.ExceptionDetails = JSON.stringify(payload.ExceptionDetails);
+      event.Description = payload.Description;
     });
   }
   static addChatConfigDataToTelemetry(chatConfig, telemetryInternalData) {

package/lib/esm/components/footerstateful/FooterStateful.js

@@ -11,10 +11,11 @@ import { TelemetryHelper } from "../../common/telemetry/TelemetryHelper";
 import { downloadTranscript } from "./downloadtranscriptstateful/DownloadTranscriptStateful";
 import useChatContextStore from "../../hooks/useChatContextStore";
 import useChatSDKStore from "../../hooks/useChatSDKStore";
+import { ConversationState } from "../../contexts/common/ConversationState";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const FooterStateful = props => {
-  var _footerProps$controlP3, _footerProps$controlP6;
+  var _footerProps$controlP3;
   const [state, dispatch] = useChatContextStore();
   // hideFooterDisplay - the purpose of this is to keep the footer always "active",
   // but hide it visually in certain states (e.g., loading state) and show in some other states (e.g. active state).
@@ -82,21 +83,23 @@ export const FooterStateful = props => {
     }
   };
   useEffect(() => {
-    if (state.appStates.isAudioMuted === null) {
-      var _footerProps$controlP4, _footerProps$controlP5;
-      dispatch({
-        type: LiveChatWidgetActionType.SET_AUDIO_NOTIFICATION,
-        payload: (footerProps === null || footerProps === void 0 ? void 0 : (_footerProps$controlP4 = footerProps.controlProps) === null || _footerProps$controlP4 === void 0 ? void 0 : (_footerProps$controlP5 = _footerProps$controlP4.audioNotificationButtonProps) === null || _footerProps$controlP5 === void 0 ? void 0 : _footerProps$controlP5.isAudioMuted) ?? false
-      });
+    if (state.appStates.conversationState === ConversationState.Active) {
+      if (state.appStates.isAudioMuted === null) {
+        var _footerProps$controlP4, _footerProps$controlP5, _footerProps$controlP6;
+        dispatch({
+          type: LiveChatWidgetActionType.SET_AUDIO_NOTIFICATION,
+          payload: footerProps !== null && footerProps !== void 0 && (_footerProps$controlP4 = footerProps.controlProps) !== null && _footerProps$controlP4 !== void 0 && _footerProps$controlP4.hideAudioNotificationButton ? true : (footerProps === null || footerProps === void 0 ? void 0 : (_footerProps$controlP5 = footerProps.controlProps) === null || _footerProps$controlP5 === void 0 ? void 0 : (_footerProps$controlP6 = _footerProps$controlP5.audioNotificationButtonProps) === null || _footerProps$controlP6 === void 0 ? void 0 : _footerProps$controlP6.isAudioMuted) ?? false
+        });
+      }
     }
-  }, []);
+  }, [state.appStates.conversationState]);
   return /*#__PURE__*/React.createElement(React.Fragment, null, !hideFooterDisplay && /*#__PURE__*/React.createElement(Footer, {
     componentOverrides: footerProps === null || footerProps === void 0 ? void 0 : footerProps.componentOverrides,
     controlProps: controlProps,
     styleProps: footerProps === null || footerProps === void 0 ? void 0 : footerProps.styleProps
   }), /*#__PURE__*/React.createElement(AudioNotificationStateful, {
     audioSrc: (audioNotificationProps === null || audioNotificationProps === void 0 ? void 0 : audioNotificationProps.audioSrc) ?? NewMessageNotificationSoundBase64,
-    isAudioMuted: state.appStates.isAudioMuted === null ? (footerProps === null || footerProps === void 0 ? void 0 : (_footerProps$controlP6 = footerProps.controlProps) === null || _footerProps$controlP6 === void 0 ? void 0 : _footerProps$controlP6.hideAudioNotificationButton) ?? false : state.appStates.isAudioMuted ?? false
+    isAudioMuted: state.appStates.isAudioMuted ?? false
   }));
 };
 export default FooterStateful;

package/lib/esm/components/headerstateful/HeaderStateful.js

@@ -79,6 +79,10 @@ export const HeaderStateful = props => {
       text: "We're Offline"
     },
     onMinimizeClick: () => {
+      TelemetryHelper.logActionEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.HeaderMinimizeButtonClicked,
+        Description: "Header Minimize button clicked."
+      });
       dispatch({
         type: LiveChatWidgetActionType.SET_MINIMIZED,
         payload: true

package/lib/esm/components/livechatwidget/common/endChat.js

@@ -1,5 +1,5 @@
-import { ConfirmationState, Constants, ConversationEndEntity, ParticipantType, PrepareEndChatDescriptionConstants } from "../../../common/Constants";
 import { BroadcastEvent, LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
+import { ConfirmationState, Constants, ConversationEndEntity, ParticipantType, PrepareEndChatDescriptionConstants } from "../../../common/Constants";
 import { getConversationDetailsCall, getWidgetEndChatEventName } from "../../../common/utils";
 import { getPostChatContext, initiatePostChat } from "./renderSurveyHelpers";
 import { BroadcastService } from "@microsoft/omnichannel-chat-components";
@@ -134,21 +134,25 @@ const prepareEndChat = async (props, chatSDK, state, dispatch, setAdapter, setWe
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const endChat = async (props, chatSDK, state, dispatch, setAdapter, setWebChatStyles, adapter, skipEndChatSDK, skipCloseChat, postMessageToOtherTab) => {
   if (!skipEndChatSDK && chatSDK.conversation) {
+    var _inMemoryState$appSta;
+    const inMemoryState = executeReducer(state, {
+      type: LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
+      payload: null
+    });
+    const endChatOptionalParameters = {
+      isSessionEnded: inMemoryState === null || inMemoryState === void 0 ? void 0 : (_inMemoryState$appSta = inMemoryState.appStates) === null || _inMemoryState$appSta === void 0 ? void 0 : _inMemoryState$appSta.chatDisconnectEventReceived
+    };
     try {
       TelemetryHelper.logSDKEvent(LogLevel.INFO, {
         Event: TelemetryEvent.EndChatSDKCall
       });
       //Get auth token again if chat continued for longer time, otherwise gets 401 error
       await handleAuthentication(chatSDK, props.chatConfig, props.getAuthToken);
-      await (chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.endChat());
+      await (chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.endChat(endChatOptionalParameters));
     } catch (ex) {
-      var _inMemoryState$appSta;
-      const inMemoryState = executeReducer(state, {
-        type: LiveChatWidgetActionType.GET_IN_MEMORY_STATE,
-        payload: null
-      });
+      var _inMemoryState$appSta2;
       // if the chat was disconnected or ended by the agent, we don't want to log the error
-      if (!(inMemoryState !== null && inMemoryState !== void 0 && (_inMemoryState$appSta = inMemoryState.appStates) !== null && _inMemoryState$appSta !== void 0 && _inMemoryState$appSta.chatDisconnectEventReceived)) {
+      if (!(inMemoryState !== null && inMemoryState !== void 0 && (_inMemoryState$appSta2 = inMemoryState.appStates) !== null && _inMemoryState$appSta2 !== void 0 && _inMemoryState$appSta2.chatDisconnectEventReceived)) {
         TelemetryHelper.logSDKEvent(LogLevel.ERROR, {
           Event: TelemetryEvent.EndChatSDKCallFailed,
           ExceptionDetails: {
@@ -165,7 +169,7 @@ const endChat = async (props, chatSDK, state, dispatch, setAdapter, setWebChatSt
       }
       postMessageToOtherTab = false;
     } finally {
-      await endChatStateCleanUp(dispatch);
+      endChatStateCleanUp(dispatch);
     }
   }
   if (!skipCloseChat) {

package/lib/esm/components/livechatwidget/common/startChat.js

@@ -1,6 +1,6 @@
 import { BroadcastEvent, LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
 import { Constants, LiveWorkItemState, WidgetLoadCustomErrorString, WidgetLoadTelemetryMessage } from "../../../common/Constants";
-import { checkContactIdError, createTimer, getConversationDetailsCall, getStateFromCache, getWidgetCacheIdfromProps, isNullOrEmptyString, isUndefinedOrEmpty } from "../../../common/utils";
+import { checkContactIdError, createTimer, getConversationDetailsCall, getStateFromCache, getWidgetCacheIdfromProps, isNullOrEmptyString, isNullOrUndefined, isUndefinedOrEmpty } from "../../../common/utils";
 import { getAuthClientFunction, handleAuthentication } from "./authHelper";
 import { handleChatReconnect, isPersistentEnabled, isReconnectEnabled } from "./reconnectChatHelper";
 import { handleStartChatError, logWidgetLoadComplete } from "./startChatErrorHandler";
@@ -369,14 +369,14 @@ const checkIfConversationStillValid = async (chatSDK, dispatch, state) => {
   try {
     chatSDK.requestId = requestIdFromCache;
     conversationDetails = await getConversationDetailsCall(chatSDK, liveChatContext);
-    if (Object.keys(conversationDetails).length === 0) {
-      return false;
-    }
-    if (conversationDetails.state === LiveWorkItemState.Closed || conversationDetails.state === LiveWorkItemState.WrapUp) {
+    if (Object.keys(conversationDetails).length === 0 || isNullOrUndefined(conversationDetails.state) || conversationDetails.state === LiveWorkItemState.Closed || conversationDetails.state === LiveWorkItemState.WrapUp) {
       dispatch({
         type: LiveChatWidgetActionType.SET_LIVE_CHAT_CONTEXT,
         payload: undefined
       });
+      if (currentRequestId) {
+        chatSDK.requestId = currentRequestId;
+      }
       return false;
     }
     return true;

package/lib/types/common/telemetry/definitions/Payload.d.ts

@@ -34,6 +34,7 @@ export interface OCChatSDKTelemetryData extends BaseTelemetryData {
     ElapsedTimeInMilliseconds?: number;
     TransactionId: string;
     ExceptionDetails?: object;
+    Description?: string;
 }
 export interface IC3ClientTelemetryData extends BaseTelemetryData {
     SubscriptionId?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/omnichannel-chat-widget",
-  "version": "1.7.4-main.c391e9f",
+  "version": "1.7.4-main.c715d8f",
   "description": "Microsoft Omnichannel Chat Widget",
   "main": "lib/cjs/index.js",
   "types": "lib/types/index.d.ts",
@@ -74,8 +74,10 @@
     "webpack-cli": "^4.9.2"
   },
   "dependencies": {
+    "@azure/core-tracing": "^1.2.0",
     "@microsoft/omnichannel-chat-components": "1.1.5",
-    "@microsoft/omnichannel-chat-sdk": "^1.10.1",
+    "@microsoft/omnichannel-chat-sdk": "^1.10.2",
+    "@opentelemetry/api": "^1.9.0",
     "abort-controller-es5": "^2.0.1",
     "dompurify": "^2.5.4",
     "markdown-it": "^12.3.2",