@microsoft/omnichannel-chat-widget 2.0.0-main.83798ba → 2.0.0-main.87c8f6c

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

@@ -111,6 +111,7 @@ let TelemetryEvent = exports.TelemetryEvent = /*#__PURE__*/function (TelemetryEv
   TelemetryEvent["MidConversationAuthSucceeded"] = "MidConversationAuthSucceeded";
   TelemetryEvent["MidConversationAuthFailed"] = "MidConversationAuthFailed";
   TelemetryEvent["MidConversationAuthReset"] = "MidConversationAuthReset";
+  TelemetryEvent["RecoveryEligibilityEvaluated"] = "RecoveryEligibilityEvaluated";
   TelemetryEvent["GetConversationDetailsCallStarted"] = "GetConversationDetailsCallStarted";
   TelemetryEvent["GetConversationDetailsCallFailed"] = "GetConversationDetailsCallFailed";
   TelemetryEvent["EndChatSDKCallFailed"] = "EndChatSDKCallFailed";
@@ -414,6 +415,7 @@ let TelemetryConstants = exports.TelemetryConstants = /*#__PURE__*/function () {
         case TelemetryEvent.SecureEventBusDispatchError:
         case TelemetryEvent.AgentJoinedConversation:
         case TelemetryEvent.BrowserTabHidden:
+        case TelemetryEvent.RecoveryEligibilityEvaluated:
           return ScenarioType.ACTIONS;
         case TelemetryEvent.StartChatSDKCall:
         case TelemetryEvent.StartChatEventReceived:

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

@@ -0,0 +1,60 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.logRecoveryEligibilityTelemetry = exports.getRecoveryEligibilityTelemetryProperties = exports.RecoveryEligibilityReason = void 0;
+var _ConversationState = require("../../../contexts/common/ConversationState");
+var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants");
+var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
+var _utils = require("../../../common/utils");
+let RecoveryEligibilityReason = exports.RecoveryEligibilityReason = /*#__PURE__*/function (RecoveryEligibilityReason) {
+  RecoveryEligibilityReason["ReconnectIdPresent"] = "ReconnectIdPresent";
+  RecoveryEligibilityReason["ActiveContextPresent"] = "ActiveContextPresent";
+  RecoveryEligibilityReason["MissingContext"] = "MissingContext";
+  RecoveryEligibilityReason["CachedContextNonActive"] = "CachedContextNonActive";
+  return RecoveryEligibilityReason;
+}({});
+const getConversationStateName = conversationState => {
+  if (typeof conversationState !== "number") {
+    return "Unknown";
+  }
+  const stateName = _ConversationState.ConversationState[conversationState];
+  return typeof stateName === "string" ? stateName : "Unknown";
+};
+const getRecoveryEligibilityTelemetryProperties = (state, eligible) => {
+  var _state$appStates, _state$domainStates, _state$appStates2, _state$appStates3;
+  const reconnectId = (_state$appStates = state.appStates) === null || _state$appStates === void 0 ? void 0 : _state$appStates.reconnectId;
+  const liveChatContext = (_state$domainStates = state.domainStates) === null || _state$domainStates === void 0 ? void 0 : _state$domainStates.liveChatContext;
+  const hasReconnectId = !(0, _utils.isUndefinedOrEmpty)(reconnectId);
+  const hasLiveChatContext = !(0, _utils.isUndefinedOrEmpty)(liveChatContext);
+  const hasRequestId = !(0, _utils.isUndefinedOrEmpty)(liveChatContext === null || liveChatContext === void 0 ? void 0 : liveChatContext.requestId);
+  let reason = RecoveryEligibilityReason.ActiveContextPresent;
+  if (hasReconnectId) {
+    reason = RecoveryEligibilityReason.ReconnectIdPresent;
+  } else if (!hasLiveChatContext) {
+    reason = RecoveryEligibilityReason.MissingContext;
+  } else if (((_state$appStates2 = state.appStates) === null || _state$appStates2 === void 0 ? void 0 : _state$appStates2.conversationState) !== _ConversationState.ConversationState.Active) {
+    reason = RecoveryEligibilityReason.CachedContextNonActive;
+  }
+  return {
+    conversationState: getConversationStateName((_state$appStates3 = state.appStates) === null || _state$appStates3 === void 0 ? void 0 : _state$appStates3.conversationState),
+    hasReconnectId,
+    hasLiveChatContext,
+    hasRequestId,
+    eligible,
+    reason
+  };
+};
+exports.getRecoveryEligibilityTelemetryProperties = getRecoveryEligibilityTelemetryProperties;
+const logRecoveryEligibilityTelemetry = (state, eligible) => {
+  try {
+    _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
+      Event: _TelemetryConstants.TelemetryEvent.RecoveryEligibilityEvaluated,
+      CustomProperties: getRecoveryEligibilityTelemetryProperties(state, eligible)
+    });
+  } catch (error) {
+    console.warn(error);
+  }
+};
+exports.logRecoveryEligibilityTelemetry = logRecoveryEligibilityTelemetry;

package/lib/cjs/components/livechatwidget/livechatwidgetstateful/LiveChatWidgetStateful.js

@@ -60,6 +60,7 @@ var _useChatAdapterStore3 = _interopRequireDefault(require("../../../hooks/useCh
 var _useChatContextStore3 = _interopRequireDefault(require("../../../hooks/useChatContextStore"));
 var _useFacadeChatSDKStore = _interopRequireDefault(require("../../../hooks/useFacadeChatSDKStore"));
 var _renderSurveyHelpers = require("../common/renderSurveyHelpers");
+var _recoveryEligibilityTelemetry = require("../common/recoveryEligibilityTelemetry");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
 function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
@@ -157,6 +158,7 @@ const LiveChatWidgetStateful = props => {
       activeCachedChatExist = false;
       optionalParams = {};
     }
+    (0, _recoveryEligibilityTelemetry.logRecoveryEligibilityTelemetry)(state, activeCachedChatExist);
   };
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -1172,18 +1174,18 @@ const LiveChatWidgetStateful = props => {
             .webchat__auto-resize-textarea.webchat__send-box-text-box__text-area {
                 min-height: ${sendBoxTextArea === null || sendBoxTextArea === void 0 ? void 0 : sendBoxTextArea.minHeight} !important;
             }`}
-            `), /*#__PURE__*/_react2.default.createElement(_DraggableChatWidget.default, chatWidgetDraggableConfig, /*#__PURE__*/_react2.default.createElement(Composer, _extends({}, webChatProps, {
-    userID: userID,
-    styleOptions: styleOptions,
-    directLine: directLine
-  }), /*#__PURE__*/_react2.default.createElement(_react.Stack, {
+            `), /*#__PURE__*/_react2.default.createElement(_DraggableChatWidget.default, chatWidgetDraggableConfig, /*#__PURE__*/_react2.default.createElement(_react.Stack, {
     id: widgetElementId,
     styles: generalStyles,
     className: (_livechatProps$styleP = livechatProps.styleProps) === null || _livechatProps$styleP === void 0 ? void 0 : _livechatProps$styleP.className,
     role: isWidgetOpen ? "dialog" : undefined,
     "aria-modal": isWidgetOpen ? true : undefined,
     "aria-label": isWidgetOpen ? ((_props$headerProps = props.headerProps) === null || _props$headerProps === void 0 || (_props$headerProps = _props$headerProps.controlProps) === null || _props$headerProps === void 0 || (_props$headerProps = _props$headerProps.headerTitleProps) === null || _props$headerProps === void 0 ? void 0 : _props$headerProps.text) ?? "Live Chat" : undefined
-  }, !((_livechatProps$contro = livechatProps.controlProps) !== null && _livechatProps$contro !== void 0 && _livechatProps$contro.hideChatButton) && !((_livechatProps$contro2 = livechatProps.controlProps) !== null && _livechatProps$contro2 !== void 0 && _livechatProps$contro2.hideStartChatButton) && (0, _componentController.shouldShowChatButton)(state) && ((0, _omnichannelChatComponents.decodeComponentString)((_livechatProps$compon = livechatProps.componentOverrides) === null || _livechatProps$compon === void 0 ? void 0 : _livechatProps$compon.chatButton) || /*#__PURE__*/_react2.default.createElement(_ChatButtonStateful.default, {
+  }, /*#__PURE__*/_react2.default.createElement(Composer, _extends({}, webChatProps, {
+    userID: userID,
+    styleOptions: styleOptions,
+    directLine: directLine
+  }), !((_livechatProps$contro = livechatProps.controlProps) !== null && _livechatProps$contro !== void 0 && _livechatProps$contro.hideChatButton) && !((_livechatProps$contro2 = livechatProps.controlProps) !== null && _livechatProps$contro2 !== void 0 && _livechatProps$contro2.hideStartChatButton) && (0, _componentController.shouldShowChatButton)(state) && ((0, _omnichannelChatComponents.decodeComponentString)((_livechatProps$compon = livechatProps.componentOverrides) === null || _livechatProps$compon === void 0 ? void 0 : _livechatProps$compon.chatButton) || /*#__PURE__*/_react2.default.createElement(_ChatButtonStateful.default, {
     buttonProps: livechatProps.chatButtonProps,
     outOfOfficeButtonProps: livechatProps.outOfOfficeChatButtonProps,
     startChat: prepareStartChatRelay

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

@@ -109,6 +109,7 @@ export let TelemetryEvent = /*#__PURE__*/function (TelemetryEvent) {
   TelemetryEvent["MidConversationAuthSucceeded"] = "MidConversationAuthSucceeded";
   TelemetryEvent["MidConversationAuthFailed"] = "MidConversationAuthFailed";
   TelemetryEvent["MidConversationAuthReset"] = "MidConversationAuthReset";
+  TelemetryEvent["RecoveryEligibilityEvaluated"] = "RecoveryEligibilityEvaluated";
   TelemetryEvent["GetConversationDetailsCallStarted"] = "GetConversationDetailsCallStarted";
   TelemetryEvent["GetConversationDetailsCallFailed"] = "GetConversationDetailsCallFailed";
   TelemetryEvent["EndChatSDKCallFailed"] = "EndChatSDKCallFailed";
@@ -412,6 +413,7 @@ export let TelemetryConstants = /*#__PURE__*/function () {
         case TelemetryEvent.SecureEventBusDispatchError:
         case TelemetryEvent.AgentJoinedConversation:
         case TelemetryEvent.BrowserTabHidden:
+        case TelemetryEvent.RecoveryEligibilityEvaluated:
           return ScenarioType.ACTIONS;
         case TelemetryEvent.StartChatSDKCall:
         case TelemetryEvent.StartChatEventReceived:

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

@@ -0,0 +1,52 @@
+import { ConversationState } from "../../../contexts/common/ConversationState";
+import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
+import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
+import { isUndefinedOrEmpty } from "../../../common/utils";
+export let RecoveryEligibilityReason = /*#__PURE__*/function (RecoveryEligibilityReason) {
+  RecoveryEligibilityReason["ReconnectIdPresent"] = "ReconnectIdPresent";
+  RecoveryEligibilityReason["ActiveContextPresent"] = "ActiveContextPresent";
+  RecoveryEligibilityReason["MissingContext"] = "MissingContext";
+  RecoveryEligibilityReason["CachedContextNonActive"] = "CachedContextNonActive";
+  return RecoveryEligibilityReason;
+}({});
+const getConversationStateName = conversationState => {
+  if (typeof conversationState !== "number") {
+    return "Unknown";
+  }
+  const stateName = ConversationState[conversationState];
+  return typeof stateName === "string" ? stateName : "Unknown";
+};
+export const getRecoveryEligibilityTelemetryProperties = (state, eligible) => {
+  var _state$appStates, _state$domainStates, _state$appStates2, _state$appStates3;
+  const reconnectId = (_state$appStates = state.appStates) === null || _state$appStates === void 0 ? void 0 : _state$appStates.reconnectId;
+  const liveChatContext = (_state$domainStates = state.domainStates) === null || _state$domainStates === void 0 ? void 0 : _state$domainStates.liveChatContext;
+  const hasReconnectId = !isUndefinedOrEmpty(reconnectId);
+  const hasLiveChatContext = !isUndefinedOrEmpty(liveChatContext);
+  const hasRequestId = !isUndefinedOrEmpty(liveChatContext === null || liveChatContext === void 0 ? void 0 : liveChatContext.requestId);
+  let reason = RecoveryEligibilityReason.ActiveContextPresent;
+  if (hasReconnectId) {
+    reason = RecoveryEligibilityReason.ReconnectIdPresent;
+  } else if (!hasLiveChatContext) {
+    reason = RecoveryEligibilityReason.MissingContext;
+  } else if (((_state$appStates2 = state.appStates) === null || _state$appStates2 === void 0 ? void 0 : _state$appStates2.conversationState) !== ConversationState.Active) {
+    reason = RecoveryEligibilityReason.CachedContextNonActive;
+  }
+  return {
+    conversationState: getConversationStateName((_state$appStates3 = state.appStates) === null || _state$appStates3 === void 0 ? void 0 : _state$appStates3.conversationState),
+    hasReconnectId,
+    hasLiveChatContext,
+    hasRequestId,
+    eligible,
+    reason
+  };
+};
+export const logRecoveryEligibilityTelemetry = (state, eligible) => {
+  try {
+    TelemetryHelper.logActionEvent(LogLevel.INFO, {
+      Event: TelemetryEvent.RecoveryEligibilityEvaluated,
+      CustomProperties: getRecoveryEligibilityTelemetryProperties(state, eligible)
+    });
+  } catch (error) {
+    console.warn(error);
+  }
+};

package/lib/esm/components/livechatwidget/livechatwidgetstateful/LiveChatWidgetStateful.js

@@ -62,6 +62,7 @@ import useChatAdapterStore from "../../../hooks/useChatAdapterStore";
 import useChatContextStore from "../../../hooks/useChatContextStore";
 import useFacadeSDKStore from "../../../hooks/useFacadeChatSDKStore";
 import { getPostChatContext, initiatePostChat } from "../common/renderSurveyHelpers";
+import { logRecoveryEligibilityTelemetry } from "../common/recoveryEligibilityTelemetry";
 let uiTimer;
 export const LiveChatWidgetStateful = props => {
   var _props$webChatContain, _props$webChatContain2, _props$webChatContain3, _props$webChatContain4, _props$webChatContain5, _props$styleProps, _props$webChatContain6, _props$controlProps, _props$controlProps3, _state$appStates7, _props$webChatContain9, _state$appStates8, _props$webChatContain1, _props$webChatContain10, _props$controlProps10, _props$draggableChatW, _props$draggableChatW2, _props$draggableChatW3, _props$draggableChatW4, _props$draggableChatW5, _livechatProps$webCha, _livechatProps$styleP, _props$headerProps, _livechatProps$contro, _livechatProps$contro2, _livechatProps$compon, _livechatProps$contro3, _livechatProps$compon2, _livechatProps$contro4, _livechatProps$compon3, _livechatProps$contro5, _livechatProps$compon4, _livechatProps$contro6, _livechatProps$compon5, _livechatProps$contro7, _livechatProps$compon6, _livechatProps$contro8, _livechatProps$compon7, _livechatProps$contro9, _livechatProps$compon8, _livechatProps$contro0, _livechatProps$contro1, _livechatProps$compon9, _livechatProps$contro10, _livechatProps$compon0, _livechatProps$contro11, _livechatProps$compon1, _livechatProps$compon10, _livechatProps$compon11;
@@ -150,6 +151,7 @@ export const LiveChatWidgetStateful = props => {
       activeCachedChatExist = false;
       optionalParams = {};
     }
+    logRecoveryEligibilityTelemetry(state, activeCachedChatExist);
   };
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -1165,18 +1167,18 @@ export const LiveChatWidgetStateful = props => {
             .webchat__auto-resize-textarea.webchat__send-box-text-box__text-area {
                 min-height: ${sendBoxTextArea === null || sendBoxTextArea === void 0 ? void 0 : sendBoxTextArea.minHeight} !important;
             }`}
-            `), /*#__PURE__*/React.createElement(DraggableChatWidget, chatWidgetDraggableConfig, /*#__PURE__*/React.createElement(Composer, _extends({}, webChatProps, {
-    userID: userID,
-    styleOptions: styleOptions,
-    directLine: directLine
-  }), /*#__PURE__*/React.createElement(Stack, {
+            `), /*#__PURE__*/React.createElement(DraggableChatWidget, chatWidgetDraggableConfig, /*#__PURE__*/React.createElement(Stack, {
     id: widgetElementId,
     styles: generalStyles,
     className: (_livechatProps$styleP = livechatProps.styleProps) === null || _livechatProps$styleP === void 0 ? void 0 : _livechatProps$styleP.className,
     role: isWidgetOpen ? "dialog" : undefined,
     "aria-modal": isWidgetOpen ? true : undefined,
     "aria-label": isWidgetOpen ? ((_props$headerProps = props.headerProps) === null || _props$headerProps === void 0 || (_props$headerProps = _props$headerProps.controlProps) === null || _props$headerProps === void 0 || (_props$headerProps = _props$headerProps.headerTitleProps) === null || _props$headerProps === void 0 ? void 0 : _props$headerProps.text) ?? "Live Chat" : undefined
-  }, !((_livechatProps$contro = livechatProps.controlProps) !== null && _livechatProps$contro !== void 0 && _livechatProps$contro.hideChatButton) && !((_livechatProps$contro2 = livechatProps.controlProps) !== null && _livechatProps$contro2 !== void 0 && _livechatProps$contro2.hideStartChatButton) && shouldShowChatButton(state) && (decodeComponentString((_livechatProps$compon = livechatProps.componentOverrides) === null || _livechatProps$compon === void 0 ? void 0 : _livechatProps$compon.chatButton) || /*#__PURE__*/React.createElement(ChatButtonStateful, {
+  }, /*#__PURE__*/React.createElement(Composer, _extends({}, webChatProps, {
+    userID: userID,
+    styleOptions: styleOptions,
+    directLine: directLine
+  }), !((_livechatProps$contro = livechatProps.controlProps) !== null && _livechatProps$contro !== void 0 && _livechatProps$contro.hideChatButton) && !((_livechatProps$contro2 = livechatProps.controlProps) !== null && _livechatProps$contro2 !== void 0 && _livechatProps$contro2.hideStartChatButton) && shouldShowChatButton(state) && (decodeComponentString((_livechatProps$compon = livechatProps.componentOverrides) === null || _livechatProps$compon === void 0 ? void 0 : _livechatProps$compon.chatButton) || /*#__PURE__*/React.createElement(ChatButtonStateful, {
     buttonProps: livechatProps.chatButtonProps,
     outOfOfficeButtonProps: livechatProps.outOfOfficeChatButtonProps,
     startChat: prepareStartChatRelay

package/lib/types/common/telemetry/TelemetryConstants.d.ts

@@ -95,6 +95,7 @@ export declare enum TelemetryEvent {
     MidConversationAuthSucceeded = "MidConversationAuthSucceeded",
     MidConversationAuthFailed = "MidConversationAuthFailed",
     MidConversationAuthReset = "MidConversationAuthReset",
+    RecoveryEligibilityEvaluated = "RecoveryEligibilityEvaluated",
     GetConversationDetailsCallStarted = "GetConversationDetailsCallStarted",
     GetConversationDetailsCallFailed = "GetConversationDetailsCallFailed",
     EndChatSDKCallFailed = "EndChatSDKCallFailed",

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

@@ -0,0 +1,17 @@
+import { ILiveChatWidgetContext } from "../../../contexts/common/ILiveChatWidgetContext";
+export declare enum RecoveryEligibilityReason {
+    ReconnectIdPresent = "ReconnectIdPresent",
+    ActiveContextPresent = "ActiveContextPresent",
+    MissingContext = "MissingContext",
+    CachedContextNonActive = "CachedContextNonActive"
+}
+export interface RecoveryEligibilityTelemetryProperties {
+    conversationState: string;
+    hasReconnectId: boolean;
+    hasLiveChatContext: boolean;
+    hasRequestId: boolean;
+    eligible: boolean;
+    reason: RecoveryEligibilityReason;
+}
+export declare const getRecoveryEligibilityTelemetryProperties: (state: ILiveChatWidgetContext, eligible: boolean) => RecoveryEligibilityTelemetryProperties;
+export declare const logRecoveryEligibilityTelemetry: (state: ILiveChatWidgetContext, eligible: boolean) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/omnichannel-chat-widget",
-  "version": "2.0.0-main.83798ba",
+  "version": "2.0.0-main.87c8f6c",
   "description": "Microsoft Omnichannel Chat Widget",
   "main": "lib/cjs/index.js",
   "types": "lib/types/index.d.ts",
@@ -104,7 +104,7 @@
     "markdown-it-for-inline": "^0.1.1",
     "md5-typescript": "^1.0.5",
     "rxjs": "5.5.12",
-    "sanitize-html": "2.17.6",
+    "sanitize-html": "2.17.7",
     "simple-update-in": "2.2.0",
     "slack-markdown-it": "^1.0.5"
   },