@microsoft/omnichannel-chat-widget 0.1.0-main.07f52ee → 0.1.0-main.7338c17

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

@@ -115,11 +115,15 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["SendTypingIndicatorSucceeded"] = "SendTypingIndicatorSucceeded";
   TelemetryEvent["SendTypingIndicatorFailed"] = "SendTypingIndicatorFailed";
   TelemetryEvent["PreChatSurveyStartChatMethodFailed"] = "PreChatSurveyStartChatMethodFailed";
+  TelemetryEvent["ChatAlreadyTriggered"] = "ChatAlreadyTriggered";
+  TelemetryEvent["StartProactiveChatEventReceived"] = "StartProactiveChatEventReceived";
   TelemetryEvent["StartProactiveChatMethodFailed"] = "StartProactiveChatMethodFailed";
   TelemetryEvent["ProactiveChatAccepted"] = "ProactiveChatAccepted";
   TelemetryEvent["ProactiveChatRejected"] = "ProactiveChatRejected";
   TelemetryEvent["IncomingProactiveChatScreenLoaded"] = "IncomingProactiveChatScreenLoaded";
   TelemetryEvent["ProactiveChatClosed"] = "ProactiveChatClosed";
+  TelemetryEvent["ProactiveChatStartChat"] = "ProactiveChatStartChat";
+  TelemetryEvent["ProactiveChatStartPopoutChat"] = "ProactiveChatStartPopoutChat";
   TelemetryEvent["ReconnectChatContinueConversation"] = "ReconnectChatContinueConversation";
   TelemetryEvent["ReconnectChatStartNewConversation"] = "ReconnectChatStartNewConversation";
   TelemetryEvent["ReconnectChatMinimize"] = "ReconnectChatMinimize";

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

@@ -16,12 +16,12 @@ var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
 var _TelemetryManager = require("../../../common/telemetry/TelemetryManager");
 
 // Defines startProactiveChat callback
-const startProactiveChat = (dispatch, bodyTitle, showPrechat, inNewWindow) => {
+const startProactiveChat = (dispatch, notificationConfig, enablePreChat, inNewWindow) => {
   dispatch({
     type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_PROACTIVE_CHAT_PARAMS,
     payload: {
-      proactiveChatBodyTitle: bodyTitle ?? "",
-      proactiveChatEnablePrechat: showPrechat ?? false,
+      proactiveChatBodyTitle: notificationConfig && notificationConfig.message ? notificationConfig.message : "",
+      proactiveChatEnablePrechat: enablePreChat ?? false,
       proactiveChatInNewWindow: inNewWindow ?? false
     }
   });

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

@@ -87,6 +87,8 @@ var _disposeTelemetryLoggers = require("../common/disposeTelemetryLoggers");
 
 var _DataStoreManager = require("../../../common/contextDataStore/DataStoreManager");
 
+var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
+
 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); }
@@ -195,10 +197,20 @@ const LiveChatWidgetStateful = props => {
   }, [state.appStates.skipChatButtonRendering]);
   (0, _react2.useEffect)(() => {
     _omnichannelChatComponents.BroadcastService.getMessageByEventName("StartProactiveChat").subscribe(msg => {
+      _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
+        Event: _TelemetryConstants.TelemetryEvent.StartProactiveChatEventReceived,
+        Description: "Start proactive chat event received."
+      });
+
       if (canStartProactiveChat.current) {
         var _msg$payload, _msg$payload2, _msg$payload3;
 
-        (0, _startProactiveChat.startProactiveChat)(dispatch, msg === null || msg === void 0 ? void 0 : (_msg$payload = msg.payload) === null || _msg$payload === void 0 ? void 0 : _msg$payload.bodyTitle, msg === null || msg === void 0 ? void 0 : (_msg$payload2 = msg.payload) === null || _msg$payload2 === void 0 ? void 0 : _msg$payload2.showPrechat, msg === null || msg === void 0 ? void 0 : (_msg$payload3 = msg.payload) === null || _msg$payload3 === void 0 ? void 0 : _msg$payload3.inNewWindow);
+        (0, _startProactiveChat.startProactiveChat)(dispatch, msg === null || msg === void 0 ? void 0 : (_msg$payload = msg.payload) === null || _msg$payload === void 0 ? void 0 : _msg$payload.notificationConfig, msg === null || msg === void 0 ? void 0 : (_msg$payload2 = msg.payload) === null || _msg$payload2 === void 0 ? void 0 : _msg$payload2.enablePreChat, msg === null || msg === void 0 ? void 0 : (_msg$payload3 = msg.payload) === null || _msg$payload3 === void 0 ? void 0 : _msg$payload3.inNewWindow);
+      } else {
+        _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.INFO, {
+          Event: _TelemetryConstants.TelemetryEvent.ChatAlreadyTriggered,
+          Description: "Start proactive chat method called, when chat was already triggered."
+        });
       }
     });
 

package/lib/cjs/components/proactivechatpanestateful/ProactiveChatPaneStateful.js

@@ -75,14 +75,14 @@ const ProactiveChatPaneStateful = props => {
       if (state.appStates.proactiveChatStates.proactiveChatInNewWindow) {
         // TODO: BroadcastService: replace with the sdk broadcast service, when in place
         const startPopoutChatEvent = {
-          eventName: "StartPopoutChat"
+          eventName: _TelemetryConstants.TelemetryEvent.ProactiveChatStartPopoutChat
         };
 
         _omnichannelChatComponents.BroadcastService.postMessage(startPopoutChatEvent);
 
         dispatch({
-          type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_SKIP_CHAT_BUTTON_RENDERING,
-          payload: true
+          type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+          payload: _ConversationState.ConversationState.Closed
         });
       } else if (((_state$domainStates$l = state.domainStates.liveChatConfig) === null || _state$domainStates$l === void 0 ? void 0 : (_state$domainStates$l2 = _state$domainStates$l.LiveWSAndLiveChatEngJoin) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.OutOfOperatingHours) === "True") {
         dispatch({
@@ -94,6 +94,12 @@ const ProactiveChatPaneStateful = props => {
           payload: _ConversationState.ConversationState.OutOfOffice
         });
       } else {
+        const proactiveChatStarted = {
+          eventName: _TelemetryConstants.TelemetryEvent.ProactiveChatStartChat
+        };
+
+        _omnichannelChatComponents.BroadcastService.postMessage(proactiveChatStarted);
+
         await startChat();
       }
     },

package/lib/cjs/components/proactivechatpanestateful/interfaces/IProactiveChatNotificationConfig.js

@@ -0,0 +1 @@
+"use strict";

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

@@ -106,11 +106,15 @@ export let TelemetryEvent;
   TelemetryEvent["SendTypingIndicatorSucceeded"] = "SendTypingIndicatorSucceeded";
   TelemetryEvent["SendTypingIndicatorFailed"] = "SendTypingIndicatorFailed";
   TelemetryEvent["PreChatSurveyStartChatMethodFailed"] = "PreChatSurveyStartChatMethodFailed";
+  TelemetryEvent["ChatAlreadyTriggered"] = "ChatAlreadyTriggered";
+  TelemetryEvent["StartProactiveChatEventReceived"] = "StartProactiveChatEventReceived";
   TelemetryEvent["StartProactiveChatMethodFailed"] = "StartProactiveChatMethodFailed";
   TelemetryEvent["ProactiveChatAccepted"] = "ProactiveChatAccepted";
   TelemetryEvent["ProactiveChatRejected"] = "ProactiveChatRejected";
   TelemetryEvent["IncomingProactiveChatScreenLoaded"] = "IncomingProactiveChatScreenLoaded";
   TelemetryEvent["ProactiveChatClosed"] = "ProactiveChatClosed";
+  TelemetryEvent["ProactiveChatStartChat"] = "ProactiveChatStartChat";
+  TelemetryEvent["ProactiveChatStartPopoutChat"] = "ProactiveChatStartPopoutChat";
   TelemetryEvent["ReconnectChatContinueConversation"] = "ReconnectChatContinueConversation";
   TelemetryEvent["ReconnectChatStartNewConversation"] = "ReconnectChatStartNewConversation";
   TelemetryEvent["ReconnectChatMinimize"] = "ReconnectChatMinimize";

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

@@ -2,14 +2,14 @@ import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryCon
 import { ConversationState } from "../../../contexts/common/ConversationState";
 import { LiveChatWidgetActionType } from "../../../contexts/common/LiveChatWidgetActionType";
 import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
-import { TelemetryTimers } from "../../../common/telemetry/TelemetryManager"; // Defines startProactiveChat callback
-
-export const startProactiveChat = (dispatch, bodyTitle, showPrechat, inNewWindow) => {
+import { TelemetryTimers } from "../../../common/telemetry/TelemetryManager";
+// Defines startProactiveChat callback
+export const startProactiveChat = (dispatch, notificationConfig, enablePreChat, inNewWindow) => {
   dispatch({
     type: LiveChatWidgetActionType.SET_PROACTIVE_CHAT_PARAMS,
     payload: {
-      proactiveChatBodyTitle: bodyTitle ?? "",
-      proactiveChatEnablePrechat: showPrechat ?? false,
+      proactiveChatBodyTitle: notificationConfig && notificationConfig.message ? notificationConfig.message : "",
+      proactiveChatEnablePrechat: enablePreChat ?? false,
       proactiveChatInNewWindow: inNewWindow ?? false
     }
   });

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

@@ -39,9 +39,10 @@ import { startProactiveChat } from "../common/startProactiveChat";
 import useChatAdapterStore from "../../../hooks/useChatAdapterStore";
 import useChatContextStore from "../../../hooks/useChatContextStore";
 import useChatSDKStore from "../../../hooks/useChatSDKStore";
-import { TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
+import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
 import { disposeTelemetryLoggers } from "../common/disposeTelemetryLoggers";
 import { DataStoreManager } from "../../../common/contextDataStore/DataStoreManager";
+import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
 export const LiveChatWidgetStateful = props => {
   var _props$webChatContain, _props$styleProps, _props$controlProps, _props$webChatContain3, _props$webChatContain4, _props$styleProps2, _props$controlProps5, _props$componentOverr, _props$controlProps6, _props$componentOverr2, _props$controlProps7, _props$componentOverr3, _props$controlProps8, _props$componentOverr4, _props$controlProps9, _props$componentOverr5, _props$controlProps10, _props$componentOverr6, _props$controlProps11, _props$controlProps12, _props$controlProps13, _props$componentOverr7, _props$controlProps14, _props$componentOverr8, _props$controlProps15, _props$componentOverr9, _props$componentOverr10, _props$componentOverr11;
 
@@ -142,10 +143,20 @@ export const LiveChatWidgetStateful = props => {
   }, [state.appStates.skipChatButtonRendering]);
   useEffect(() => {
     BroadcastService.getMessageByEventName("StartProactiveChat").subscribe(msg => {
+      TelemetryHelper.logActionEvent(LogLevel.INFO, {
+        Event: TelemetryEvent.StartProactiveChatEventReceived,
+        Description: "Start proactive chat event received."
+      });
+
       if (canStartProactiveChat.current) {
         var _msg$payload, _msg$payload2, _msg$payload3;
 
-        startProactiveChat(dispatch, msg === null || msg === void 0 ? void 0 : (_msg$payload = msg.payload) === null || _msg$payload === void 0 ? void 0 : _msg$payload.bodyTitle, msg === null || msg === void 0 ? void 0 : (_msg$payload2 = msg.payload) === null || _msg$payload2 === void 0 ? void 0 : _msg$payload2.showPrechat, msg === null || msg === void 0 ? void 0 : (_msg$payload3 = msg.payload) === null || _msg$payload3 === void 0 ? void 0 : _msg$payload3.inNewWindow);
+        startProactiveChat(dispatch, msg === null || msg === void 0 ? void 0 : (_msg$payload = msg.payload) === null || _msg$payload === void 0 ? void 0 : _msg$payload.notificationConfig, msg === null || msg === void 0 ? void 0 : (_msg$payload2 = msg.payload) === null || _msg$payload2 === void 0 ? void 0 : _msg$payload2.enablePreChat, msg === null || msg === void 0 ? void 0 : (_msg$payload3 = msg.payload) === null || _msg$payload3 === void 0 ? void 0 : _msg$payload3.inNewWindow);
+      } else {
+        TelemetryHelper.logActionEvent(LogLevel.INFO, {
+          Event: TelemetryEvent.ChatAlreadyTriggered,
+          Description: "Start proactive chat method called, when chat was already triggered."
+        });
       }
     });
     window.addEventListener("beforeunload", event => {

package/lib/esm/components/proactivechatpanestateful/ProactiveChatPaneStateful.js

@@ -51,12 +51,12 @@ export const ProactiveChatPaneStateful = props => {
       if (state.appStates.proactiveChatStates.proactiveChatInNewWindow) {
         // TODO: BroadcastService: replace with the sdk broadcast service, when in place
         const startPopoutChatEvent = {
-          eventName: "StartPopoutChat"
+          eventName: TelemetryEvent.ProactiveChatStartPopoutChat
         };
         BroadcastService.postMessage(startPopoutChatEvent);
         dispatch({
-          type: LiveChatWidgetActionType.SET_SKIP_CHAT_BUTTON_RENDERING,
-          payload: true
+          type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
+          payload: ConversationState.Closed
         });
       } else if (((_state$domainStates$l = state.domainStates.liveChatConfig) === null || _state$domainStates$l === void 0 ? void 0 : (_state$domainStates$l2 = _state$domainStates$l.LiveWSAndLiveChatEngJoin) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.OutOfOperatingHours) === "True") {
         dispatch({
@@ -68,6 +68,10 @@ export const ProactiveChatPaneStateful = props => {
           payload: ConversationState.OutOfOffice
         });
       } else {
+        const proactiveChatStarted = {
+          eventName: TelemetryEvent.ProactiveChatStartChat
+        };
+        BroadcastService.postMessage(proactiveChatStarted);
         await startChat();
       }
     },

package/lib/esm/components/proactivechatpanestateful/interfaces/IProactiveChatNotificationConfig.js

@@ -0,0 +1 @@
+export {};

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

@@ -99,11 +99,15 @@ export declare enum TelemetryEvent {
     SendTypingIndicatorSucceeded = "SendTypingIndicatorSucceeded",
     SendTypingIndicatorFailed = "SendTypingIndicatorFailed",
     PreChatSurveyStartChatMethodFailed = "PreChatSurveyStartChatMethodFailed",
+    ChatAlreadyTriggered = "ChatAlreadyTriggered",
+    StartProactiveChatEventReceived = "StartProactiveChatEventReceived",
     StartProactiveChatMethodFailed = "StartProactiveChatMethodFailed",
     ProactiveChatAccepted = "ProactiveChatAccepted",
     ProactiveChatRejected = "ProactiveChatRejected",
     IncomingProactiveChatScreenLoaded = "IncomingProactiveChatScreenLoaded",
     ProactiveChatClosed = "ProactiveChatClosed",
+    ProactiveChatStartChat = "ProactiveChatStartChat",
+    ProactiveChatStartPopoutChat = "ProactiveChatStartPopoutChat",
     ReconnectChatContinueConversation = "ReconnectChatContinueConversation",
     ReconnectChatStartNewConversation = "ReconnectChatStartNewConversation",
     ReconnectChatMinimize = "ReconnectChatMinimize",

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

@@ -1,3 +1,4 @@
 import { Dispatch } from "react";
 import { ILiveChatWidgetAction } from "../../../contexts/common/ILiveChatWidgetAction";
-export declare const startProactiveChat: (dispatch: Dispatch<ILiveChatWidgetAction>, bodyTitle?: string | undefined, showPrechat?: boolean | undefined, inNewWindow?: boolean | undefined) => void;
+import { IProactiveChatNotificationConfig } from "../../proactivechatpanestateful/interfaces/IProactiveChatNotificationConfig";
+export declare const startProactiveChat: (dispatch: Dispatch<ILiveChatWidgetAction>, notificationConfig?: IProactiveChatNotificationConfig | undefined, enablePreChat?: boolean | undefined, inNewWindow?: boolean | undefined) => void;

package/lib/types/components/proactivechatpanestateful/interfaces/IProactiveChatNotificationConfig.d.ts

@@ -0,0 +1,3 @@
+export interface IProactiveChatNotificationConfig {
+    message?: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/omnichannel-chat-widget",
-  "version": "0.1.0-main.07f52ee",
+  "version": "0.1.0-main.7338c17",
   "description": "Microsoft Omnichannel Chat Widget",
   "main": "lib/cjs/index.js",
   "types": "lib/types/index.d.ts",