@microsoft/omnichannel-chat-widget 1.7.8-main.ab4d3b4 → 1.7.8-main.cf04c1c

package/lib/esm/components/webchatcontainerstateful/webchatcontroller/notification/NotificationHandler.js

@@ -1,3 +1,8 @@
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 import { HtmlClassNames, HtmlIdNames } from "../../../../common/Constants";
 import { NotificationLevel } from "../enums/NotificationLevel";
 import { WebChatActionType } from "../enums/WebChatActionType";
@@ -5,73 +10,96 @@ import { WebChatStoreLoader } from "../WebChatStoreLoader";
 import { setFocusOnSendBox } from "../../../../common/utils";
 import { BroadcastService } from "@microsoft/omnichannel-chat-components";
 import { BroadcastEvent } from "../../../../common/telemetry/TelemetryConstants";
-export class NotificationHandler {
-  static notify(id, level, message) {
-    if (WebChatStoreLoader.store) {
-      WebChatStoreLoader.store.dispatch({
-        type: WebChatActionType.WEB_CHAT_SET_NOTIFICATION,
-        payload: {
-          id,
-          level,
-          message
-        }
-      });
-      NotificationHandler.setFocusOnNotificationCloseButton();
-    }
+export let NotificationHandler = /*#__PURE__*/function () {
+  function NotificationHandler() {
+    _classCallCheck(this, NotificationHandler);
   }
-  static dismissNotification(id) {
-    if (WebChatStoreLoader.store) {
-      WebChatStoreLoader.store.dispatch({
-        type: WebChatActionType.WEB_CHAT_DISMISS_NOTIFICATION,
+  _createClass(NotificationHandler, null, [{
+    key: "notify",
+    value: function notify(id, level, message) {
+      if (WebChatStoreLoader.store) {
+        WebChatStoreLoader.store.dispatch({
+          type: WebChatActionType.WEB_CHAT_SET_NOTIFICATION,
+          payload: {
+            id,
+            level,
+            message
+          }
+        });
+        NotificationHandler.setFocusOnNotificationCloseButton();
+      }
+    }
+  }, {
+    key: "dismissNotification",
+    value: function dismissNotification(id) {
+      if (WebChatStoreLoader.store) {
+        WebChatStoreLoader.store.dispatch({
+          type: WebChatActionType.WEB_CHAT_DISMISS_NOTIFICATION,
+          payload: {
+            id
+          }
+        });
+      }
+    }
+  }, {
+    key: "notifyError",
+    value: function notifyError(id, message) {
+      BroadcastService.postMessage({
+        eventName: BroadcastEvent.OnWidgetError,
         payload: {
-          id
+          errorMessage: message
         }
       });
+      this.notify(id, NotificationLevel.Error, message);
     }
-  }
-  static notifyError(id, message) {
-    BroadcastService.postMessage({
-      eventName: BroadcastEvent.OnWidgetError,
-      payload: {
-        errorMessage: message
+  }, {
+    key: "notifyWarning",
+    value: function notifyWarning(id, message) {
+      this.notify(id, NotificationLevel.Warning, message);
+    }
+  }, {
+    key: "notifyInfo",
+    value: function notifyInfo(id, message) {
+      this.notify(id, NotificationLevel.Info, message);
+    }
+  }, {
+    key: "notifySuccess",
+    value: function notifySuccess(id, message) {
+      this.notify(id, NotificationLevel.Success, message);
+    }
+  }, {
+    key: "notifyWithLevel",
+    value: function notifyWithLevel(id, message, level) {
+      if (!level) {
+        this.notifyInfo(id, message);
+      } else {
+        this.notify(id, level, message);
       }
-    });
-    this.notify(id, NotificationLevel.Error, message);
-  }
-  static notifyWarning(id, message) {
-    this.notify(id, NotificationLevel.Warning, message);
-  }
-  static notifyInfo(id, message) {
-    this.notify(id, NotificationLevel.Info, message);
-  }
-  static notifySuccess(id, message) {
-    this.notify(id, NotificationLevel.Success, message);
-  }
-  static notifyWithLevel(id, message, level) {
-    if (!level) {
-      this.notifyInfo(id, message);
-    } else {
-      this.notify(id, level, message);
     }
-  }
 
-  /* Bypass WebChat behavior and focus on banner close button */
-  static setFocusOnNotificationCloseButton() {
-    const expandButton = document.querySelector(`#${HtmlIdNames.MSLiveChatWidget} .${HtmlClassNames.webChatBannerExpandButton}`);
-    if (expandButton) {
-      expandButton.focus();
-      return;
+    /* Bypass WebChat behavior and focus on banner close button */
+  }, {
+    key: "setFocusOnNotificationCloseButton",
+    value: function setFocusOnNotificationCloseButton() {
+      const expandButton = document.querySelector(`#${HtmlIdNames.MSLiveChatWidget} .${HtmlClassNames.webChatBannerExpandButton}`);
+      if (expandButton) {
+        expandButton.focus();
+        return;
+      }
+      const closeButton = document.querySelector(`#${HtmlIdNames.MSLiveChatWidget} .${HtmlClassNames.webChatBannerCloseButton}`);
+      if (closeButton) {
+        closeButton.focus();
+        NotificationHandler.registerOnCloseEvent(closeButton);
+        return;
+      }
     }
-    const closeButton = document.querySelector(`#${HtmlIdNames.MSLiveChatWidget} .${HtmlClassNames.webChatBannerCloseButton}`);
-    if (closeButton) {
-      closeButton.focus();
-      NotificationHandler.registerOnCloseEvent(closeButton);
-      return;
+  }, {
+    key: "registerOnCloseEvent",
+    value: function registerOnCloseEvent(button) {
+      button.onclick = () => {
+        setFocusOnSendBox();
+      };
     }
-  }
-  static registerOnCloseEvent(button) {
-    button.onclick = () => {
-      setFocusOnSendBox();
-    };
-  }
-}
+  }]);
+  return NotificationHandler;
+}();

package/lib/esm/contexts/common/LiveChatWidgetContextInitialState.js

@@ -16,6 +16,7 @@ export const getLiveChatWidgetContextInitialState = props => {
   const initialState = defaultClientDataStoreProvider(cacheTtlInMins, storageType).getData(widgetCacheId);
   if (!isNullOrUndefined(initialState)) {
     const initialStateFromCache = JSON.parse(initialState);
+    const outsideOperatingHours = isOutsideOperatingHours();
 
     /*
     * this step is needed to avoid the pre-chat pane to be injected in the DOM when the widget is reloaded, because wont be visible
@@ -23,17 +24,15 @@ export const getLiveChatWidgetContextInitialState = props => {
     * as part of the flow, the pre-chat will be detected and then it will be displayed properly 
     * this case is only and only for pre-chat pane.
     * **/
-    if (initialStateFromCache.appStates.conversationState === ConversationState.Prechat) {
+    if (initialStateFromCache.appStates.conversationState === ConversationState.Prechat || initialStateFromCache.appStates.conversationState === ConversationState.OutOfOffice || outsideOperatingHours) {
       initialStateFromCache.appStates.conversationState = ConversationState.Closed;
+      // if we are resetting the conversation state, there is no point to obtain minimized state from cache
+      initialStateFromCache.appStates.isMinimized = undefined;
     }
-
     // we are always setting the chatConfig from the props to avoid any issues with the cache
     initialStateFromCache.domainStates.liveChatConfig = props.chatConfig;
-
     // Cache the result of isOutsideOperatingHours() to ensure consistency
-    const outsideOperatingHours = isOutsideOperatingHours();
     initialStateFromCache.appStates.outsideOperatingHours = outsideOperatingHours;
-    initialStateFromCache.appStates.conversationState = outsideOperatingHours ? ConversationState.OutOfOffice : initialStateFromCache.appStates.conversationState;
     return initialStateFromCache;
   }
   const LiveChatWidgetContextInitialState = {
@@ -58,7 +57,7 @@ export const getLiveChatWidgetContextInitialState = props => {
       startChatFailureType: StartChatFailureType.Generic
     },
     appStates: {
-      conversationState: isOutsideOperatingHours() ? ConversationState.OutOfOffice : ConversationState.Closed,
+      conversationState: ConversationState.Closed,
       isMinimized: undefined,
       previousElementIdOnFocusBeforeModalOpen: null,
       startChatFailed: false,

package/lib/esm/controller/componentController.js

@@ -17,7 +17,7 @@ export const shouldShowEmailTranscriptPane = state => {
   return state.uiStates.showEmailTranscriptPane;
 };
 export const shouldShowWebChatContainer = state => {
-  return state.appStates.conversationState === ConversationState.Active || state.appStates.conversationState === ConversationState.InActive;
+  return !state.appStates.isMinimized && state.appStates.conversationState === ConversationState.Active || state.appStates.conversationState === ConversationState.InActive;
 };
 export const shouldShowLoadingPane = state => {
   return !state.appStates.isMinimized && state.appStates.conversationState === ConversationState.Loading;
@@ -32,7 +32,8 @@ export const shouldShowPostChatLoadingPane = state => {
   return !state.appStates.isMinimized && state.appStates.conversationState === ConversationState.PostchatLoading;
 };
 export const shouldShowOutOfOfficeHoursPane = state => {
-  return !state.appStates.isMinimized && state.appStates.conversationState === ConversationState.OutOfOffice;
+  // Show OOOH pane only when the conversation state is Closed and outside operating hours is true
+  return !state.appStates.isMinimized && state.appStates.outsideOperatingHours === true && state.appStates.conversationState === ConversationState.OutOfOffice;
 };
 export const shouldShowPreChatSurveyPane = state => {
   return state.appStates.conversationState === ConversationState.Prechat;

package/lib/esm/firstresponselatency/FirstResponseLatencyTracker.js

@@ -1,11 +1,15 @@
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
 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); }
 function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 import { BroadcastEvent, LogLevel, TelemetryEvent } from "../common/telemetry/TelemetryConstants";
 import { BroadcastService } from "@microsoft/omnichannel-chat-components";
 import { TelemetryHelper } from "../common/telemetry/TelemetryHelper";
-export class FirstResponseLatencyTracker {
-  constructor() {
+export let FirstResponseLatencyTracker = /*#__PURE__*/function () {
+  function FirstResponseLatencyTracker() {
+    _classCallCheck(this, FirstResponseLatencyTracker);
     _defineProperty(this, "isABotConversation", false);
     _defineProperty(this, "isStarted", false);
     _defineProperty(this, "isEnded", false);
@@ -41,132 +45,150 @@ export class FirstResponseLatencyTracker {
     // we do have a mechanism in place to prevent log agent messages.
     this.isABotConversation = true;
   }
-  createTrackingMessage(payload, type) {
-    return {
-      Id: payload.Id,
-      role: payload.role,
-      timestamp: payload === null || payload === void 0 ? void 0 : payload.timestamp,
-      tags: payload.tags,
-      messageType: payload.messageType,
-      text: payload.text,
-      type: type,
-      checkTime: new Date().getTime()
-    };
-  }
-
-  // Tracking Functions
-  startTracking(payload) {
-    if (!this.isReady) return;
-    //  this prevents to initiate tracking for multiple incoming messages
-    if (this.isStarted) {
-      return;
-    }
-    // this is to ensure we track only messages where bot is engaged
-    if (!this.isABotConversation) {
-      return;
-    }
-    // control of states to prevent clashing of messages
-    this.isStarted = true;
-    this.isEnded = false;
-    // The idea  of using types is to enrich telemetry data 
-    this.startTrackingMessage = this.createTrackingMessage(payload, "userMessage");
-  }
-  handleAgentMessage(payload) {
-    var _payload$tags;
-    // this tag so far is only present in agent messages
-    if (payload !== null && payload !== void 0 && (_payload$tags = payload.tags) !== null && _payload$tags !== void 0 && _payload$tags.includes("public")) {
-      this.deregister();
-    }
-  }
-  stopTracking(payload) {
-    var _this$stopTrackingMes, _this$startTrackingMe;
-    // this prevents execution for multiple incoming messages from the bot.
-    if (this.isEnded && !this.isStarted) {
-      return;
+  _createClass(FirstResponseLatencyTracker, [{
+    key: "createTrackingMessage",
+    value: function createTrackingMessage(payload, type) {
+      return {
+        Id: payload.Id,
+        role: payload.role,
+        timestamp: payload === null || payload === void 0 ? void 0 : payload.timestamp,
+        tags: payload.tags,
+        messageType: payload.messageType,
+        text: payload.text,
+        type: type,
+        checkTime: new Date().getTime()
+      };
     }
 
-    // control of states to prevent clashing of messages
-    this.isEnded = true;
-    this.isStarted = false;
-
-    // The idea  of using types is to enrich telemetry data 
-    this.stopTrackingMessage = this.createTrackingMessage(payload, "botMessage");
-    // calculating elapsed time
-    const elapsedTime = (((_this$stopTrackingMes = this.stopTrackingMessage) === null || _this$stopTrackingMes === void 0 ? void 0 : _this$stopTrackingMes.checkTime) ?? 0) - (((_this$startTrackingMe = this.startTrackingMessage) === null || _this$startTrackingMe === void 0 ? void 0 : _this$startTrackingMe.checkTime) ?? 0);
-    TelemetryHelper.logActionEvent(LogLevel.INFO, {
-      Event: TelemetryEvent.MessageLapTrack,
-      Description: "First response latency tracking",
-      CustomProperties: {
-        elapsedTime,
-        userMessage: this.startTrackingMessage,
-        botMessage: this.stopTrackingMessage
+    // Tracking Functions
+  }, {
+    key: "startTracking",
+    value: function startTracking(payload) {
+      if (!this.isReady) return;
+      //  this prevents to initiate tracking for multiple incoming messages
+      if (this.isStarted) {
+        return;
       }
-    });
-  }
-
-  // mechanism to ensure we track only allowed conversations
-  isMessageFromValidSender(payload) {
-    var _payload$tags2;
-    // agent scenario
-    if (payload !== null && payload !== void 0 && (_payload$tags2 = payload.tags) !== null && _payload$tags2 !== void 0 && _payload$tags2.includes("public")) {
-      this.handleAgentMessage(payload);
-      return false;
+      // this is to ensure we track only messages where bot is engaged
+      if (!this.isABotConversation) {
+        return;
+      }
+      // control of states to prevent clashing of messages
+      this.isStarted = true;
+      this.isEnded = false;
+      // The idea  of using types is to enrich telemetry data 
+      this.startTrackingMessage = this.createTrackingMessage(payload, "userMessage");
     }
-    return true;
-  }
-  startClock(payload) {
-    try {
-      if (!payload || !payload.Id) {
-        throw new Error("Invalid payload");
+  }, {
+    key: "handleAgentMessage",
+    value: function handleAgentMessage(payload) {
+      var _payload$tags;
+      // this tag so far is only present in agent messages
+      if (payload !== null && payload !== void 0 && (_payload$tags = payload.tags) !== null && _payload$tags !== void 0 && _payload$tags.includes("public")) {
+        this.deregister();
       }
-      this.startTracking(payload);
-    } catch (e) {
-      TelemetryHelper.logActionEvent(LogLevel.ERROR, {
-        Event: TelemetryEvent.MessageStartLapTrackError,
-        Description: "Error while starting the clock",
-        ExceptionDetails: e,
+    }
+  }, {
+    key: "stopTracking",
+    value: function stopTracking(payload) {
+      var _this$stopTrackingMes, _this$startTrackingMe;
+      // this prevents execution for multiple incoming messages from the bot.
+      if (this.isEnded && !this.isStarted) {
+        return;
+      }
+
+      // control of states to prevent clashing of messages
+      this.isEnded = true;
+      this.isStarted = false;
+
+      // The idea  of using types is to enrich telemetry data 
+      this.stopTrackingMessage = this.createTrackingMessage(payload, "botMessage");
+      // calculating elapsed time
+      const elapsedTime = (((_this$stopTrackingMes = this.stopTrackingMessage) === null || _this$stopTrackingMes === void 0 ? void 0 : _this$stopTrackingMes.checkTime) ?? 0) - (((_this$startTrackingMe = this.startTrackingMessage) === null || _this$startTrackingMe === void 0 ? void 0 : _this$startTrackingMe.checkTime) ?? 0);
+      TelemetryHelper.logActionEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.MessageLapTrack,
+        Description: "First response latency tracking",
         CustomProperties: {
-          payload: payload
+          elapsedTime,
+          userMessage: this.startTrackingMessage,
+          botMessage: this.stopTrackingMessage
         }
       });
     }
-  }
-  stopClock(payload) {
-    try {
-      if (!payload || !payload.Id) {
-        throw new Error("Invalid payload");
+
+    // mechanism to ensure we track only allowed conversations
+  }, {
+    key: "isMessageFromValidSender",
+    value: function isMessageFromValidSender(payload) {
+      var _payload$tags2;
+      // agent scenario
+      if (payload !== null && payload !== void 0 && (_payload$tags2 = payload.tags) !== null && _payload$tags2 !== void 0 && _payload$tags2.includes("public")) {
+        this.handleAgentMessage(payload);
+        return false;
       }
-      if (!this.isMessageFromValidSender(payload)) return;
-      if (this.isABotConversation && this.isStarted) {
-        this.stopTracking(payload);
+      return true;
+    }
+  }, {
+    key: "startClock",
+    value: function startClock(payload) {
+      try {
+        if (!payload || !payload.Id) {
+          throw new Error("Invalid payload");
+        }
+        this.startTracking(payload);
+      } catch (e) {
+        TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+          Event: TelemetryEvent.MessageStartLapTrackError,
+          Description: "Error while starting the clock",
+          ExceptionDetails: e,
+          CustomProperties: {
+            payload: payload
+          }
+        });
       }
-    } catch (e) {
-      console.error("FRL : error while trying to stop the tracker", e);
-      TelemetryHelper.logActionEvent(LogLevel.ERROR, {
-        Event: TelemetryEvent.MessageStopLapTrackError,
-        Description: "Error while stopping the clock",
-        ExceptionDetails: e,
-        CustomProperties: {
-          payload: payload
+    }
+  }, {
+    key: "stopClock",
+    value: function stopClock(payload) {
+      try {
+        if (!payload || !payload.Id) {
+          throw new Error("Invalid payload");
         }
-      });
-      //reset state
-      this.startTrackingMessage = undefined;
-      this.stopTrackingMessage = undefined;
+        if (!this.isMessageFromValidSender(payload)) return;
+        if (this.isABotConversation && this.isStarted) {
+          this.stopTracking(payload);
+        }
+      } catch (e) {
+        console.error("FRL : error while trying to stop the tracker", e);
+        TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+          Event: TelemetryEvent.MessageStopLapTrackError,
+          Description: "Error while stopping the clock",
+          ExceptionDetails: e,
+          CustomProperties: {
+            payload: payload
+          }
+        });
+        //reset state
+        this.startTrackingMessage = undefined;
+        this.stopTrackingMessage = undefined;
+        this.isStarted = false;
+        this.isEnded = false;
+      }
+    }
+  }, {
+    key: "deregister",
+    value: function deregister() {
+      // Reset State
+      this.isABotConversation = false;
       this.isStarted = false;
       this.isEnded = false;
+      this.startTrackingMessage = undefined;
+      this.stopTrackingMessage = undefined;
+      this.offlineNetworkListener.unsubscribe();
+      this.fmltrackingListener.unsubscribe();
+      this.rehydrateListener.unsubscribe();
+      this.historyListener.unsubscribe();
     }
-  }
-  deregister() {
-    // Reset State
-    this.isABotConversation = false;
-    this.isStarted = false;
-    this.isEnded = false;
-    this.startTrackingMessage = undefined;
-    this.stopTrackingMessage = undefined;
-    this.offlineNetworkListener.unsubscribe();
-    this.fmltrackingListener.unsubscribe();
-    this.rehydrateListener.unsubscribe();
-    this.historyListener.unsubscribe();
-  }
-}
+  }]);
+  return FirstResponseLatencyTracker;
+}();