@microsoft/omnichannel-chat-widget 1.7.2-main.42ab898 → 1.7.2-main.6642960

package/lib/cjs/common/Constants.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.WidgetLoadTelemetryMessage = exports.WidgetLoadCustomErrorString = exports.WebChatMiddlewareConstants = exports.TranscriptConstants = exports.StorageType = exports.StartChatErrorPaneConstants = exports.Regex = exports.PrepareEndChatDescriptionConstants = exports.ParticipantType = exports.NotificationPaneConstants = exports.MimeTypes = exports.LocaleConstants = exports.LiveWorkItemState = exports.HtmlIdNames = exports.HtmlElementSelectors = exports.HtmlClassNames = exports.HtmlAttributeNames = exports.EnvironmentVersion = exports.ElementType = exports.E2VVOptions = exports.ConversationMode = exports.ConversationEndEntity = exports.Constants = exports.ConfirmationState = exports.AriaTelemetryConstants = exports.AMSConstants = void 0;
+exports.WidgetLoadTelemetryMessage = exports.WidgetLoadCustomErrorString = exports.WebChatMiddlewareConstants = exports.TranscriptConstants = exports.StorageType = exports.StartChatErrorPaneConstants = exports.Regex = exports.PrepareEndChatDescriptionConstants = exports.PostChatSurveyTelemetryMessage = exports.ParticipantType = exports.NotificationPaneConstants = exports.MimeTypes = exports.LocaleConstants = exports.LiveWorkItemState = exports.HtmlIdNames = exports.HtmlElementSelectors = exports.HtmlClassNames = exports.HtmlAttributeNames = exports.EnvironmentVersion = exports.ElementType = exports.E2VVOptions = exports.ConversationMode = exports.ConversationEndEntity = exports.Constants = exports.ConfirmationState = exports.AriaTelemetryConstants = exports.AMSConstants = void 0;
 var _class;
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
@@ -318,4 +318,8 @@ _defineProperty(PrepareEndChatDescriptionConstants, "InitiateEndChatReceived", "
 _defineProperty(PrepareEndChatDescriptionConstants, "EndChatReceivedFromOtherTabs", "Received EndChat BroadcastEvent from other tabs. Closing this chat.");
 _defineProperty(PrepareEndChatDescriptionConstants, "CustomerCloseChatOnFailureOrPostChat", "Customer is trying to close chat widget on start chat failure or post chat pane.");
 _defineProperty(PrepareEndChatDescriptionConstants, "CustomerCloseInactiveChat", "Chat was Inactive and customer is trying to close chat widget or refreshing the page.");
-_defineProperty(PrepareEndChatDescriptionConstants, "BrowserUnload", "Browser unload event received. Ending chat.");
+_defineProperty(PrepareEndChatDescriptionConstants, "BrowserUnload", "Browser unload event received. Ending chat.");
+class PostChatSurveyTelemetryMessage {}
+exports.PostChatSurveyTelemetryMessage = PostChatSurveyTelemetryMessage;
+_defineProperty(PostChatSurveyTelemetryMessage, "PostChatContextCallFailed", "Failed to get post chat context.");
+_defineProperty(PostChatSurveyTelemetryMessage, "PostChatContextCallSucceed", "Postchat context call succeed.");

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

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isPostChatSurveyEnabled = void 0;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const isPostChatSurveyEnabled = async chatSDK => {
+  var _chatConfig$LiveWSAnd;
+  const chatConfig = await chatSDK.getLiveChatConfig();
+  const postChatEnabled = (_chatConfig$LiveWSAnd = chatConfig.LiveWSAndLiveChatEngJoin) === null || _chatConfig$LiveWSAnd === void 0 ? void 0 : _chatConfig$LiveWSAnd.msdyn_postconversationsurveyenable.toString().toLowerCase();
+  return postChatEnabled === "true";
+};
+exports.isPostChatSurveyEnabled = isPostChatSurveyEnabled;

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

@@ -11,6 +11,7 @@ var _utils = require("../../../common/utils");
 var _ConversationState = require("../../../contexts/common/ConversationState");
 var _LiveChatWidgetActionType = require("../../../contexts/common/LiveChatWidgetActionType");
 var _PostChatSurveyMode = require("../../postchatsurveypanestateful/enums/PostChatSurveyMode");
+var _liveChatConfigUtils = require("./liveChatConfigUtils");
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 let conversationDetails = undefined;
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -108,24 +109,27 @@ const isPostChatEnabled = (props, state) => {
 exports.checkPostChatEnabled = isPostChatEnabled;
 const getPostChatContext = async (chatSDK, state, dispatch) => {
   try {
-    var _state$domainStates2;
-    if ((state === null || state === void 0 ? void 0 : (_state$domainStates2 = state.domainStates) === null || _state$domainStates2 === void 0 ? void 0 : _state$domainStates2.postChatContext) === undefined) {
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      const context = await chatSDK.getPostChatSurveyContext();
-      _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
-        Event: _TelemetryConstants.TelemetryEvent.PostChatContextCallSucceed,
-        Description: "Postchat context call succeed."
-      });
-      dispatch({
-        type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_POST_CHAT_CONTEXT,
-        payload: context
-      });
-      return context;
+    const postChatEnabled = await (0, _liveChatConfigUtils.isPostChatSurveyEnabled)(chatSDK);
+    if (postChatEnabled) {
+      var _state$domainStates2;
+      if ((state === null || state === void 0 ? void 0 : (_state$domainStates2 = state.domainStates) === null || _state$domainStates2 === void 0 ? void 0 : _state$domainStates2.postChatContext) === undefined) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const context = await chatSDK.getPostChatSurveyContext();
+        _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+          Event: _TelemetryConstants.TelemetryEvent.PostChatContextCallSucceed,
+          Description: _Constants.PostChatSurveyTelemetryMessage.PostChatContextCallSucceed
+        });
+        dispatch({
+          type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_POST_CHAT_CONTEXT,
+          payload: context
+        });
+        return context;
+      }
     }
   } catch (error) {
-    _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+    _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.ERROR, {
       Event: _TelemetryConstants.TelemetryEvent.PostChatContextCallFailed,
-      Description: "Failed to get post chat context."
+      Description: _Constants.PostChatSurveyTelemetryMessage.PostChatContextCallFailed
     });
   }
 };

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

@@ -9,20 +9,25 @@ var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components
 var _ConversationState = require("../../../contexts/common/ConversationState");
 var _LiveChatWidgetActionType = require("../../../contexts/common/LiveChatWidgetActionType");
 var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
+var _Constants = require("../../../common/Constants");
+var _liveChatConfigUtils = require("./liveChatConfigUtils");
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const setPostChatContextAndLoadSurvey = async (chatSDK, dispatch, persistedChat) => {
   try {
-    if (!persistedChat) {
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      const context = await chatSDK.getPostChatSurveyContext();
-      _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
-        Event: _TelemetryConstants.TelemetryEvent.PostChatContextCallSucceed,
-        Description: "Postchat context call succeed."
-      });
-      dispatch({
-        type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_POST_CHAT_CONTEXT,
-        payload: context
-      });
+    const postChatEnabled = await (0, _liveChatConfigUtils.isPostChatSurveyEnabled)(chatSDK);
+    if (postChatEnabled) {
+      if (!persistedChat) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const context = await chatSDK.getPostChatSurveyContext();
+        _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+          Event: _TelemetryConstants.TelemetryEvent.PostChatContextCallSucceed,
+          Description: _Constants.PostChatSurveyTelemetryMessage.PostChatContextCallSucceed
+        });
+        dispatch({
+          type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_POST_CHAT_CONTEXT,
+          payload: context
+        });
+      }
     }
   } catch (ex) {
     _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.ERROR, {
@@ -32,7 +37,6 @@ const setPostChatContextAndLoadSurvey = async (chatSDK, dispatch, persistedChat)
       }
     });
   }
-
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   _omnichannelChatComponents.BroadcastService.getMessageByEventName("LoadPostChatSurvey").subscribe(msg => {
     dispatch({

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

@@ -58,6 +58,10 @@ const handleStartChatError = (dispatch, chatSDK, props, ex, isStartChatSuccessfu
       case _omnichannelChatSdk.ChatSDKErrorName.UninitializedChatSDK:
         handleUninitializedChatSDK(ex);
         break;
+      // Handle the case indicating failure to retrieve an authenticated chat conversation 
+      case _omnichannelChatSdk.ChatSDKErrorName.AuthenticatedChatConversationRetrievalFailure:
+        logWidgetLoadCompleteWithError(ex);
+        break;
       case _omnichannelChatSdk.ChatSDKErrorName.InvalidConversation:
       case _omnichannelChatSdk.ChatSDKErrorName.ClosedConversation:
         handleInvalidOrClosedConversation(dispatch, chatSDK, props, ex);

package/lib/cjs/components/webchatcontainerstateful/common/mockchatsdk.js

@@ -63,5 +63,12 @@ class MockChatSDK {
   getVoiceVideoCalling() {
     return null;
   }
+  getLiveChatConfig() {
+    return {
+      LiveWSAndLiveChatEngJoin: {
+        msdyn_postconversationsurveyenable: "true"
+      }
+    };
+  }
 }
 exports.MockChatSDK = MockChatSDK;

package/lib/esm/common/Constants.js

@@ -286,4 +286,7 @@ _defineProperty(PrepareEndChatDescriptionConstants, "InitiateEndChatReceived", "
 _defineProperty(PrepareEndChatDescriptionConstants, "EndChatReceivedFromOtherTabs", "Received EndChat BroadcastEvent from other tabs. Closing this chat.");
 _defineProperty(PrepareEndChatDescriptionConstants, "CustomerCloseChatOnFailureOrPostChat", "Customer is trying to close chat widget on start chat failure or post chat pane.");
 _defineProperty(PrepareEndChatDescriptionConstants, "CustomerCloseInactiveChat", "Chat was Inactive and customer is trying to close chat widget or refreshing the page.");
-_defineProperty(PrepareEndChatDescriptionConstants, "BrowserUnload", "Browser unload event received. Ending chat.");
+_defineProperty(PrepareEndChatDescriptionConstants, "BrowserUnload", "Browser unload event received. Ending chat.");
+export class PostChatSurveyTelemetryMessage {}
+_defineProperty(PostChatSurveyTelemetryMessage, "PostChatContextCallFailed", "Failed to get post chat context.");
+_defineProperty(PostChatSurveyTelemetryMessage, "PostChatContextCallSucceed", "Postchat context call succeed.");

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

@@ -0,0 +1,7 @@
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const isPostChatSurveyEnabled = async chatSDK => {
+  var _chatConfig$LiveWSAnd;
+  const chatConfig = await chatSDK.getLiveChatConfig();
+  const postChatEnabled = (_chatConfig$LiveWSAnd = chatConfig.LiveWSAndLiveChatEngJoin) === null || _chatConfig$LiveWSAnd === void 0 ? void 0 : _chatConfig$LiveWSAnd.msdyn_postconversationsurveyenable.toString().toLowerCase();
+  return postChatEnabled === "true";
+};

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

@@ -1,10 +1,12 @@
-import { Constants, ParticipantType } from "../../../common/Constants";
+import { Constants, ParticipantType, PostChatSurveyTelemetryMessage } from "../../../common/Constants";
 import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
 import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
 import { addDelayInMs } from "../../../common/utils";
 import { ConversationState } from "../../../contexts/common/ConversationState";
 import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidgetActionType";
 import { PostChatSurveyMode } from "../../postchatsurveypanestateful/enums/PostChatSurveyMode";
+import { isPostChatSurveyEnabled } from "./liveChatConfigUtils";
+
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 let conversationDetails = undefined;
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -100,24 +102,27 @@ const isPostChatEnabled = (props, state) => {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const getPostChatContext = async (chatSDK, state, dispatch) => {
   try {
-    var _state$domainStates2;
-    if ((state === null || state === void 0 ? void 0 : (_state$domainStates2 = state.domainStates) === null || _state$domainStates2 === void 0 ? void 0 : _state$domainStates2.postChatContext) === undefined) {
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      const context = await chatSDK.getPostChatSurveyContext();
-      TelemetryHelper.logSDKEvent(LogLevel.INFO, {
-        Event: TelemetryEvent.PostChatContextCallSucceed,
-        Description: "Postchat context call succeed."
-      });
-      dispatch({
-        type: LiveChatWidgetActionType.SET_POST_CHAT_CONTEXT,
-        payload: context
-      });
-      return context;
+    const postChatEnabled = await isPostChatSurveyEnabled(chatSDK);
+    if (postChatEnabled) {
+      var _state$domainStates2;
+      if ((state === null || state === void 0 ? void 0 : (_state$domainStates2 = state.domainStates) === null || _state$domainStates2 === void 0 ? void 0 : _state$domainStates2.postChatContext) === undefined) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const context = await chatSDK.getPostChatSurveyContext();
+        TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+          Event: TelemetryEvent.PostChatContextCallSucceed,
+          Description: PostChatSurveyTelemetryMessage.PostChatContextCallSucceed
+        });
+        dispatch({
+          type: LiveChatWidgetActionType.SET_POST_CHAT_CONTEXT,
+          payload: context
+        });
+        return context;
+      }
     }
   } catch (error) {
-    TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+    TelemetryHelper.logSDKEvent(LogLevel.ERROR, {
       Event: TelemetryEvent.PostChatContextCallFailed,
-      Description: "Failed to get post chat context."
+      Description: PostChatSurveyTelemetryMessage.PostChatContextCallFailed
     });
   }
 };

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

@@ -3,21 +3,26 @@ import { BroadcastService } from "@microsoft/omnichannel-chat-components";
 import { ConversationState } from "../../../contexts/common/ConversationState";
 import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidgetActionType";
 import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
+import { PostChatSurveyTelemetryMessage } from "../../../common/Constants";
+import { isPostChatSurveyEnabled } from "./liveChatConfigUtils";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const setPostChatContextAndLoadSurvey = async (chatSDK, dispatch, persistedChat) => {
   try {
-    if (!persistedChat) {
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      const context = await chatSDK.getPostChatSurveyContext();
-      TelemetryHelper.logSDKEvent(LogLevel.INFO, {
-        Event: TelemetryEvent.PostChatContextCallSucceed,
-        Description: "Postchat context call succeed."
-      });
-      dispatch({
-        type: LiveChatWidgetActionType.SET_POST_CHAT_CONTEXT,
-        payload: context
-      });
+    const postChatEnabled = await isPostChatSurveyEnabled(chatSDK);
+    if (postChatEnabled) {
+      if (!persistedChat) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const context = await chatSDK.getPostChatSurveyContext();
+        TelemetryHelper.logSDKEvent(LogLevel.INFO, {
+          Event: TelemetryEvent.PostChatContextCallSucceed,
+          Description: PostChatSurveyTelemetryMessage.PostChatContextCallSucceed
+        });
+        dispatch({
+          type: LiveChatWidgetActionType.SET_POST_CHAT_CONTEXT,
+          payload: context
+        });
+      }
     }
   } catch (ex) {
     TelemetryHelper.logSDKEvent(LogLevel.ERROR, {
@@ -27,7 +32,6 @@ export const setPostChatContextAndLoadSurvey = async (chatSDK, dispatch, persist
       }
     });
   }
-
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   BroadcastService.getMessageByEventName("LoadPostChatSurvey").subscribe(msg => {
     dispatch({

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

@@ -53,6 +53,10 @@ export const handleStartChatError = (dispatch, chatSDK, props, ex, isStartChatSu
       case ChatSDKErrorName.UninitializedChatSDK:
         handleUninitializedChatSDK(ex);
         break;
+      // Handle the case indicating failure to retrieve an authenticated chat conversation 
+      case ChatSDKErrorName.AuthenticatedChatConversationRetrievalFailure:
+        logWidgetLoadCompleteWithError(ex);
+        break;
       case ChatSDKErrorName.InvalidConversation:
       case ChatSDKErrorName.ClosedConversation:
         handleInvalidOrClosedConversation(dispatch, chatSDK, props, ex);

package/lib/esm/components/webchatcontainerstateful/common/mockchatsdk.js

@@ -56,4 +56,11 @@ export class MockChatSDK {
   getVoiceVideoCalling() {
     return null;
   }
+  getLiveChatConfig() {
+    return {
+      LiveWSAndLiveChatEngJoin: {
+        msdyn_postconversationsurveyenable: "true"
+      }
+    };
+  }
 }

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

@@ -267,3 +267,7 @@ export declare class PrepareEndChatDescriptionConstants {
     static readonly CustomerCloseInactiveChat = "Chat was Inactive and customer is trying to close chat widget or refreshing the page.";
     static readonly BrowserUnload = "Browser unload event received. Ending chat.";
 }
+export declare class PostChatSurveyTelemetryMessage {
+    static readonly PostChatContextCallFailed = "Failed to get post chat context.";
+    static readonly PostChatContextCallSucceed = "Postchat context call succeed.";
+}

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

@@ -0,0 +1 @@
+export declare const isPostChatSurveyEnabled: (chatSDK: any) => Promise<boolean>;

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

@@ -28,4 +28,9 @@ export declare class MockChatSDK {
         reconnectId: string;
     };
     getVoiceVideoCalling(): null;
+    getLiveChatConfig(): {
+        LiveWSAndLiveChatEngJoin: {
+            msdyn_postconversationsurveyenable: string;
+        };
+    };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/omnichannel-chat-widget",
-  "version": "1.7.2-main.42ab898",
+  "version": "1.7.2-main.6642960",
   "description": "Microsoft Omnichannel Chat Widget",
   "main": "lib/cjs/index.js",
   "types": "lib/types/index.d.ts",
@@ -75,7 +75,7 @@
   },
   "dependencies": {
     "@microsoft/omnichannel-chat-components": "1.1.5",
-    "@microsoft/omnichannel-chat-sdk": "^1.9.2",
+    "@microsoft/omnichannel-chat-sdk": "^1.9.4",
     "abort-controller-es5": "^2.0.1",
     "dompurify": "^2.3.4",
     "markdown-it": "^12.3.2",