@microsoft/omnichannel-chat-widget 0.1.0-main.07f52ee → 0.1.0-main.0e38a73

package/lib/cjs/common/storage/default/defaultClientDataStoreProvider.js

@@ -0,0 +1,102 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.defaultClientDataStoreProvider = void 0;
+var _defaultInMemoryDataStore = require("./defaultInMemoryDataStore");
+var _TelemetryHelper = require("../../telemetry/TelemetryHelper");
+var _TelemetryConstants = require("../../telemetry/TelemetryConstants");
+const defaultClientDataStoreProvider = () => {
+  const isCookieAllowed = () => {
+    try {
+      localStorage;
+      sessionStorage;
+      return true;
+    } catch (error) {
+      console.error("Third party cookie blocked");
+      return false;
+    }
+  };
+  const TtlInMs = 15 * 60 * 1000; // 15 mins
+  const dataStoreProvider = {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    setData: (key, data, type) => {
+      if (isCookieAllowed()) {
+        try {
+          if (key) {
+            const now = new Date();
+            const item = {
+              data: data,
+              expiry: now.getTime() + TtlInMs
+            };
+            const strItem = JSON.stringify(item);
+            if (type === "localStorage") {
+              localStorage.setItem(key, strItem);
+            } else {
+              sessionStorage.setItem(key, strItem);
+            }
+          }
+        } catch (error) {
+          _TelemetryHelper.TelemetryHelper.logConfigDataEvent(_TelemetryConstants.LogLevel.ERROR, {
+            Event: _TelemetryConstants.TelemetryEvent.ClientDataStoreProviderFailed,
+            ExceptionDetails: error,
+            Description: "Unable to store data in localStorage."
+          });
+        }
+      } else {
+        const dataToCache = {
+          key: key,
+          data: data,
+          type: type
+        };
+        parent.postMessage(dataToCache, "*");
+      }
+    },
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    getData: (key, type) => {
+      if (isCookieAllowed()) {
+        let item;
+        if (type === "localStorage") {
+          item = localStorage.getItem(key);
+        } else {
+          item = sessionStorage.getItem(key);
+        }
+        //Return item if not expired
+        let itemInJson = undefined;
+        if (item !== null) {
+          itemInJson = JSON.parse(item);
+          const now = new Date();
+          // compare the expiry time of the item with the current time
+          if (now.getTime() > itemInJson.expiry) {
+            // If the item is expired, delete the item from storage
+            // and return null
+            localStorage.removeItem(key);
+            return null;
+          }
+          return itemInJson.data;
+        }
+      } else {
+        // get data from in memory db when cookie is disabled
+        return (0, _defaultInMemoryDataStore.inMemoryDataStore)().getData(key);
+      }
+    },
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    removeData: (key, type) => {
+      if (isCookieAllowed()) {
+        if (key) {
+          if (type === "localStorage") {
+            return localStorage.removeItem(key);
+          } else {
+            return sessionStorage.removeItem(key);
+          }
+        }
+      } else {
+        // get data from in memory db when cookie is disabled
+        return (0, _defaultInMemoryDataStore.inMemoryDataStore)().removeData(key);
+      }
+    }
+  };
+  return dataStoreProvider;
+};
+exports.defaultClientDataStoreProvider = defaultClientDataStoreProvider;

package/lib/cjs/common/storage/default/defaultInMemoryDataStore.js

@@ -0,0 +1,78 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.inMemoryDataStore = exports.defaultInitializeInMemoryDataStore = void 0;
+var _TelemetryConstants = require("../../telemetry/TelemetryConstants");
+var _TelemetryHelper = require("../../telemetry/TelemetryHelper");
+var _defaultCacheManager = require("./defaultCacheManager");
+const defaultInitializeInMemoryDataStore = widgetId => {
+  try {
+    localStorage;
+  } catch (error) {
+    // Register below events when localStorage is not accessible
+    // Listening to event raised from client browser
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    window.addEventListener("message", function (e) {
+      try {
+        if (e.data.key) {
+          const browserData = e.data;
+          if (_defaultCacheManager.defaultCacheManager.InternalCache[browserData.key]) {
+            delete _defaultCacheManager.defaultCacheManager.InternalCache[browserData.key];
+          }
+          _defaultCacheManager.defaultCacheManager.InternalCache[browserData.key] = browserData.data;
+        }
+      } catch (error) {
+        _TelemetryHelper.TelemetryHelper.logConfigDataEvent(_TelemetryConstants.LogLevel.ERROR, {
+          Event: _TelemetryConstants.TelemetryEvent.InMemoryDataStoreFailed,
+          ExceptionDetails: error,
+          Description: "Unable to register default in-memory cache."
+        });
+      }
+    });
+
+    // send cache initialize message to client
+    if (_defaultCacheManager.defaultCacheManager.InternalCache === undefined || {}) {
+      parent.postMessage({
+        data: "cacheinitialize",
+        widgetId: widgetId
+      }, "*");
+    }
+  }
+};
+exports.defaultInitializeInMemoryDataStore = defaultInitializeInMemoryDataStore;
+const inMemoryDataStore = () => {
+  const dataStoreProvider = {
+    getData: key => {
+      if (_defaultCacheManager.defaultCacheManager.InternalCache && _defaultCacheManager.defaultCacheManager.InternalCache[key]) {
+        return _defaultCacheManager.defaultCacheManager.InternalCache[key];
+      }
+    },
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    setData: (key, data) => {
+      try {
+        _defaultCacheManager.defaultCacheManager.InternalCache[key] = data;
+      } catch (error) {
+        _TelemetryHelper.TelemetryHelper.logConfigDataEvent(_TelemetryConstants.LogLevel.ERROR, {
+          Event: _TelemetryConstants.TelemetryEvent.InMemoryDataStoreFailed,
+          ExceptionDetails: error,
+          Description: "Unable to set data in default in-memory cache."
+        });
+      }
+    },
+    removeData: key => {
+      try {
+        _defaultCacheManager.defaultCacheManager.InternalCache[key] = {};
+      } catch (error) {
+        _TelemetryHelper.TelemetryHelper.logConfigDataEvent(_TelemetryConstants.LogLevel.ERROR, {
+          Event: _TelemetryConstants.TelemetryEvent.InMemoryDataStoreFailed,
+          ExceptionDetails: error,
+          Description: "Unable to remove data from default in-memory cache."
+        });
+      }
+    }
+  };
+  return dataStoreProvider;
+};
+exports.inMemoryDataStore = inMemoryDataStore;

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

@@ -3,10 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.TelemetryEvent = exports.TelemetryConstants = exports.ScenarioType = exports.LogLevel = void 0;
+exports.TelemetryEvent = exports.TelemetryConstants = exports.ScenarioType = exports.LogLevel = exports.BroadcastEvent = void 0;
 let ScenarioType;
 exports.ScenarioType = ScenarioType;
-
 (function (ScenarioType) {
   ScenarioType["CONFIG_VALIDATION"] = "LCW_ConfigValidationEvents";
   ScenarioType["LOAD"] = "LCW_LoadEvents";
@@ -19,20 +18,45 @@ exports.ScenarioType = ScenarioType;
   ScenarioType["UNDEFINED"] = "LCW_Undefined";
   ScenarioType["ACS_ADAPTER"] = "LCW_ACSAdapterEvents";
 })(ScenarioType || (exports.ScenarioType = ScenarioType = {}));
-
-let LogLevel;
+let LogLevel; // Events used in certain functionalities that are not being logged
 exports.LogLevel = LogLevel;
-
 (function (LogLevel) {
   LogLevel["INFO"] = "INFO";
   LogLevel["DEBUG"] = "DEBUG";
   LogLevel["WARN"] = "WARN";
   LogLevel["ERROR"] = "ERROR";
 })(LogLevel || (exports.LogLevel = LogLevel = {}));
-
+let BroadcastEvent; // Events being logged
+exports.BroadcastEvent = BroadcastEvent;
+(function (BroadcastEvent) {
+  BroadcastEvent["LoadPostChatSurvey"] = "LoadPostChatSurvey";
+  BroadcastEvent["ChatEnded"] = "ChatEnded";
+  BroadcastEvent["NewMessageNotification"] = "NewMessageNotification";
+  BroadcastEvent["UnreadMessageCount"] = "UnreadMessageCount";
+  BroadcastEvent["StartProactiveChat"] = "StartProactiveChat";
+  BroadcastEvent["ProactiveChatStartChat"] = "ProactiveChatStartChat";
+  BroadcastEvent["ProactiveChatStartPopoutChat"] = "ProactiveChatStartPopoutChat";
+  BroadcastEvent["ProactiveChatIsInPopoutMode"] = "ProactiveChatIsInPopoutMode";
+  BroadcastEvent["ResetProactiveChatParams"] = "ResetProactiveChatParams";
+  BroadcastEvent["InvalidAdaptiveCardFormat"] = "InvalidAdaptiveCardFormat";
+  BroadcastEvent["NewMessageSent"] = "NewMessageSent";
+  BroadcastEvent["NewMessageReceived"] = "NewMessageReceived";
+  BroadcastEvent["HistoryMessageReceived"] = "HistoryMessageReceived";
+  BroadcastEvent["RedirectPageRequest"] = "RedirectPageRequest";
+  BroadcastEvent["StartChat"] = "StartChat";
+  BroadcastEvent["StartChatSkippingChatButtonRendering"] = "StartChatSkippingChatButtonRendering";
+  BroadcastEvent["StartUnauthenticatedReconnectChat"] = "StartUnauthenticatedReconnectChat";
+  BroadcastEvent["InitiateEndChat"] = "InitiateEndChat";
+  BroadcastEvent["SetCustomContext"] = "SetCustomContext";
+  BroadcastEvent["ChatRetrievedFromCache"] = "ChatRetrievedFromCache";
+  BroadcastEvent["MaximizeChat"] = "MaximizeChat";
+  BroadcastEvent["ChatInitiated"] = "ChatInitiated";
+  BroadcastEvent["CloseChat"] = "CloseChat";
+  BroadcastEvent["InitiateEndChatOnBrowserUnload"] = "InitiateEndChatOnBrowserUnload";
+  BroadcastEvent["ClosePopoutWindow"] = "ClosePopoutWindow";
+})(BroadcastEvent || (exports.BroadcastEvent = BroadcastEvent = {}));
 let TelemetryEvent;
 exports.TelemetryEvent = TelemetryEvent;
-
 (function (TelemetryEvent) {
   TelemetryEvent["CallAdded"] = "CallAdded";
   TelemetryEvent["LocalVideoStreamAdded"] = "LocalVideoStreamAdded";
@@ -42,8 +66,8 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["CallDisconnected"] = "CallDisconnected";
   TelemetryEvent["CallDisconnectedException"] = "CallDisconnectedException";
   TelemetryEvent["IncomingCallEnded"] = "incomingCallEnded";
-  TelemetryEvent["VoiceVideoInitialize"] = "VoiceVideoInitialize";
-  TelemetryEvent["VoiceVideoInitializeException"] = "VoiceVideoInitializeException";
+  TelemetryEvent["VoiceVideoSdkInitialize"] = "VoiceVideoSdkInitialize";
+  TelemetryEvent["VoiceVideoSdkInitializeException"] = "VoiceVideoSdkInitializeException";
   TelemetryEvent["VoiceVideoLoading"] = "VoiceVideoLoading";
   TelemetryEvent["VoiceVideoNotLoaded"] = "VoiceVideoNotLoaded";
   TelemetryEvent["VoiceVideoLoadingException"] = "VoiceVideoLoadingException";
@@ -69,6 +93,8 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["PostChatContextCallSucceed"] = "PostChatContextCallSucceed";
   TelemetryEvent["PostChatContextCallFailed"] = "PostChatContextCallFailed";
   TelemetryEvent["ParseAdaptiveCardFailed"] = "ParseAdaptiveCardFailed";
+  TelemetryEvent["ClientDataStoreProviderFailed"] = "ClientDataStoreProviderFailed";
+  TelemetryEvent["InMemoryDataStoreFailed"] = "InMemoryDataStoreFailed";
   TelemetryEvent["WebChatLoaded"] = "WebChatLoaded";
   TelemetryEvent["LCWChatButtonClicked"] = "LCWChatButtonClicked";
   TelemetryEvent["LCWChatButtonShow"] = "LCWChatButtonShow";
@@ -79,7 +105,10 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["PrechatSurveyLoaded"] = "PrechatSurveyLoaded";
   TelemetryEvent["PrechatSubmitted"] = "PrechatSubmitted";
   TelemetryEvent["StartChatSDKCall"] = "StartChatCall";
-  TelemetryEvent["EndChatSDKCall"] = "EndChatCall";
+  TelemetryEvent["StartChatEventRecevied"] = "StartChatEventReceived";
+  TelemetryEvent["EndChatSDKCall"] = "EndChatSDKCall";
+  TelemetryEvent["EndChatEventReceived"] = "EndChatEventReceived";
+  TelemetryEvent["WindowClosed"] = "WindowClosed";
   TelemetryEvent["OnNewMessageFailed"] = "OnNewMessageFailed";
   TelemetryEvent["OnNewMessageAudioNotificationFailed"] = "OnNewMessageAudioNotificationFailed";
   TelemetryEvent["DownloadTranscriptResponseNullOrUndefined"] = "DownloadTranscriptResponseNullOrUndefined";
@@ -93,6 +122,7 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["LoadingPaneLoaded"] = "LoadingPaneLoaded";
   TelemetryEvent["EmailTranscriptLoaded"] = "EmailTranscriptLoaded";
   TelemetryEvent["OutOfOfficePaneLoaded"] = "OutOfOfficePaneLoaded";
+  TelemetryEvent["PostChatSurveyLoadingPaneLoaded"] = "PostChatSurveyLoadingPaneLoaded";
   TelemetryEvent["PostChatSurveyLoaded"] = "PostChatSurveyLoaded";
   TelemetryEvent["ConfirmationPaneLoaded"] = "ConfirmationPaneLoaded";
   TelemetryEvent["ProactiveChatPaneLoaded"] = "ProactiveChatPaneLoaded";
@@ -103,18 +133,31 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["EmailTranscriptButtonClicked"] = "EmailTranscriptButtonClicked";
   TelemetryEvent["EmailTranscriptCancelButtonClicked"] = "EmailTranscriptCancelButtonClicked";
   TelemetryEvent["AudioToggleButtonClicked"] = "AudioToggleButtonClicked";
+  TelemetryEvent["SuppressBotMagicCodeSucceeded"] = "SuppressBotMagicCodeSucceeded";
+  TelemetryEvent["SuppressBotMagicCodeFailed"] = "SuppressBotMagicCodeFailed";
+  TelemetryEvent["GetConversationDetailsException"] = "GetConversationDetailsException";
+  TelemetryEvent["BrowserUnloadEventStarted"] = "BrowserUnloadEventStarted";
+  TelemetryEvent["GetAuthTokenCalled"] = "GetAuthTokenCalled";
+  TelemetryEvent["ReceivedNullOrEmptyToken"] = "ReceivedNullOrEmptyToken";
+  TelemetryEvent["CustomerVoiceResponsePageLoaded"] = "CustomerVoiceResponsePageLoaded";
+  TelemetryEvent["CustomerVoiceFormResponseSubmitted"] = "CustomerVoiceFormResponseSubmitted";
+  TelemetryEvent["CustomerVoiceFormResponseError"] = "CustomerVoiceFormResponseError";
   TelemetryEvent["ProcessingHTMLTextMiddlewareFailed"] = "ProcessingHTMLTextMiddlewareFailed";
   TelemetryEvent["ProcessingSanitizationMiddlewareFailed"] = "ProcessingSanitizationMiddlewareFailed";
   TelemetryEvent["FormatTagsMiddlewareJSONStringifyFailed"] = "FormatTagsMiddlewareJSONStringifyFailed";
   TelemetryEvent["QueuePositionMessageRecieved"] = "QueuePositionMessageRecieved";
   TelemetryEvent["AverageWaitTimeMessageRecieved"] = "AverageWaitTimeMessageRecieved";
   TelemetryEvent["DataMaskingRuleApplied"] = "DataMaskingRuleApplied";
+  TelemetryEvent["DataMaskingRuleApplyFailed"] = "DataMaskingRuleApplyFailed";
   TelemetryEvent["IC3ClientEvent"] = "IC3ClientEvent";
   TelemetryEvent["ConversationEndedThreadEventReceived"] = "ConversationEndedThreadEventReceived";
   TelemetryEvent["InvalidConfiguration"] = "InvalidConfiguration";
   TelemetryEvent["SendTypingIndicatorSucceeded"] = "SendTypingIndicatorSucceeded";
   TelemetryEvent["SendTypingIndicatorFailed"] = "SendTypingIndicatorFailed";
+  TelemetryEvent["WebChatEvent"] = "WebChatEvent";
   TelemetryEvent["PreChatSurveyStartChatMethodFailed"] = "PreChatSurveyStartChatMethodFailed";
+  TelemetryEvent["ChatAlreadyTriggered"] = "ChatAlreadyTriggered";
+  TelemetryEvent["StartProactiveChatEventReceived"] = "StartProactiveChatEventReceived";
   TelemetryEvent["StartProactiveChatMethodFailed"] = "StartProactiveChatMethodFailed";
   TelemetryEvent["ProactiveChatAccepted"] = "ProactiveChatAccepted";
   TelemetryEvent["ProactiveChatRejected"] = "ProactiveChatRejected";
@@ -123,15 +166,21 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["ReconnectChatContinueConversation"] = "ReconnectChatContinueConversation";
   TelemetryEvent["ReconnectChatStartNewConversation"] = "ReconnectChatStartNewConversation";
   TelemetryEvent["ReconnectChatMinimize"] = "ReconnectChatMinimize";
-  TelemetryEvent["ChatWidgetStateChanged"] = "ChatWidgetStateChanged";
+  TelemetryEvent["MessageSent"] = "MessageSent";
+  TelemetryEvent["MessageReceived"] = "MessageReceived";
+  TelemetryEvent["CustomContextReceived"] = "CustomContextReceived";
+  TelemetryEvent["NetworkDisconnected"] = "NetworkDisconnected";
+  TelemetryEvent["NetworkReconnected"] = "NetworkReconnected";
 })(TelemetryEvent || (exports.TelemetryEvent = TelemetryEvent = {}));
-
 class TelemetryConstants {
   static map(eventTypeOrScenarioType) {
     switch (eventTypeOrScenarioType) {
       case TelemetryEvent.ParseAdaptiveCardFailed:
+      case TelemetryEvent.ReceivedNullOrEmptyToken:
+      case TelemetryEvent.GetAuthTokenCalled:
+      case TelemetryEvent.SuppressBotMagicCodeSucceeded:
+      case TelemetryEvent.SuppressBotMagicCodeFailed:
         return ScenarioType.CONFIG_VALIDATION;
-
       case TelemetryEvent.WebChatLoaded:
       case TelemetryEvent.WidgetLoadComplete:
       case TelemetryEvent.WidgetLoadFailed:
@@ -139,13 +188,13 @@ class TelemetryConstants {
       case TelemetryEvent.LCWChatButtonShow:
       case TelemetryEvent.PrechatSurveyLoaded:
       case TelemetryEvent.LoadingPaneLoaded:
+      case TelemetryEvent.PostChatSurveyLoadingPaneLoaded:
       case TelemetryEvent.PostChatSurveyLoaded:
       case TelemetryEvent.EmailTranscriptLoaded:
       case TelemetryEvent.OutOfOfficePaneLoaded:
       case TelemetryEvent.ConfirmationPaneLoaded:
       case TelemetryEvent.ProactiveChatPaneLoaded:
         return ScenarioType.LOAD;
-
       case TelemetryEvent.PrechatSubmitted:
       case TelemetryEvent.LCWChatButtonClicked:
       case TelemetryEvent.ProactiveChatAccepted:
@@ -165,20 +214,34 @@ class TelemetryConstants {
       case TelemetryEvent.PreChatSurveyStartChatMethodFailed:
       case TelemetryEvent.HeaderCloseButtonClicked:
       case TelemetryEvent.HeaderMinimizeButtonClicked:
+      case TelemetryEvent.MessageSent:
+      case TelemetryEvent.MessageReceived:
+      case TelemetryEvent.CustomContextReceived:
+      case TelemetryEvent.BrowserUnloadEventStarted:
+      case TelemetryEvent.NetworkDisconnected:
+      case TelemetryEvent.NetworkReconnected:
+      case TelemetryEvent.AudioToggleButtonClicked:
+      case TelemetryEvent.EmailTranscriptCancelButtonClicked:
+      case TelemetryEvent.CustomerVoiceResponsePageLoaded:
+      case TelemetryEvent.CustomerVoiceFormResponseSubmitted:
+      case TelemetryEvent.CustomerVoiceFormResponseError:
         return ScenarioType.ACTIONS;
-
       case TelemetryEvent.StartChatSDKCall:
+      case TelemetryEvent.StartChatEventRecevied:
       case TelemetryEvent.StartChatMethodException:
       case TelemetryEvent.CloseChatMethodException:
+      case TelemetryEvent.StartProactiveChatEventReceived:
       case TelemetryEvent.StartProactiveChatMethodFailed:
       case TelemetryEvent.OnNewMessageFailed:
       case TelemetryEvent.OnNewMessageAudioNotificationFailed:
       case TelemetryEvent.GetConversationDetailsCallFailed:
+      case TelemetryEvent.EndChatSDKCall:
+      case TelemetryEvent.EndChatEventReceived:
       case TelemetryEvent.EndChatSDKCallFailed:
       case TelemetryEvent.PostChatContextCallFailed:
       case TelemetryEvent.PostChatContextCallSucceed:
+      case TelemetryEvent.GetConversationDetailsException:
         return ScenarioType.SDK;
-
       case TelemetryEvent.VideoCallAcceptButtonClick:
       case TelemetryEvent.CallAdded:
       case TelemetryEvent.LocalVideoStreamAdded:
@@ -188,8 +251,8 @@ class TelemetryConstants {
       case TelemetryEvent.CallDisconnected:
       case TelemetryEvent.CallDisconnectedException:
       case TelemetryEvent.IncomingCallEnded:
-      case TelemetryEvent.VoiceVideoInitialize:
-      case TelemetryEvent.VoiceVideoInitializeException:
+      case TelemetryEvent.VoiceVideoSdkInitialize:
+      case TelemetryEvent.VoiceVideoSdkInitializeException:
       case TelemetryEvent.VoiceVideoLoading:
       case TelemetryEvent.VoiceVideoNotLoaded:
       case TelemetryEvent.VoiceVideoLoadingException:
@@ -209,16 +272,12 @@ class TelemetryConstants {
       case TelemetryEvent.CallingSDKLoadSuccess:
       case TelemetryEvent.CallingSDKLoadFailed:
         return ScenarioType.CALLING;
-
       default:
         return ScenarioType.ACTIONS;
     }
   }
-
   static mapEventToScenario(eventTypeOrScenarioType) {
     return TelemetryConstants.map(eventTypeOrScenarioType);
   }
-
 }
-
 exports.TelemetryConstants = TelemetryConstants;