@microsoft/omnichannel-chat-widget 1.7.4-main.562254b → 1.7.4-main.8d43b20

package/lib/cjs/common/facades/FacadeChatSDK.js

@@ -0,0 +1,298 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FacadeChatSDK = void 0;
+var _TelemetryConstants = require("../telemetry/TelemetryConstants");
+var _authHelper = require("../../components/livechatwidget/common/authHelper");
+var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components");
+var _TelemetryHelper = require("../telemetry/TelemetryHelper");
+var _utils = require("../utils");
+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); }
+class FacadeChatSDK {
+  isSDKMocked() {
+    return this.sdkMocked;
+  }
+  getChatSDK() {
+    return this.chatSDK;
+  }
+  destroy() {
+    this.token = null;
+    this.expiration = 0;
+  }
+  isTokenSet() {
+    return !(0, _utils.isNullOrEmptyString)(this.token);
+  }
+  constructor(input) {
+    _defineProperty(this, "chatSDK", void 0);
+    _defineProperty(this, "chatConfig", void 0);
+    _defineProperty(this, "token", "");
+    _defineProperty(this, "expiration", 0);
+    _defineProperty(this, "isAuthenticated", void 0);
+    _defineProperty(this, "getAuthToken", void 0);
+    _defineProperty(this, "sdkMocked", void 0);
+    this.chatSDK = input.chatSDK;
+    this.chatConfig = input.chatConfig;
+    this.getAuthToken = input.getAuthToken;
+    this.isAuthenticated = input.isAuthenticated;
+    this.sdkMocked = input.isSDKMocked;
+  }
+
+  //set default expiration to zero, for undefined or missed exp in jwt
+  convertExpiration() {
+    let expiration = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
+    // Converting expiration to seconds, if contains decimals or is identified as milliseconds
+    if (expiration.toString().length === 13) {
+      return Math.floor(expiration / 1000);
+    }
+    // If the epoch value is already in seconds, return it as is
+    return expiration;
+  }
+  isTokenExpired() {
+    // if expiration is 0, token is not going to be validated ( this is to cover the case of token with no expiration)
+    if (this.expiration === 0) {
+      return false;
+    }
+
+    // obtain current time in seconds
+    const now = Math.floor(Date.now() / 1000);
+
+    // compare expiration time with current time
+    if (now > this.expiration) {
+      console.log("Token is expired", now, this.expiration, now > this.expiration);
+      return true;
+    }
+    return false;
+  }
+  async setToken(token) {
+    // token must be not null, and must be new
+    if (!(0, _utils.isNullOrEmptyString)(token) && token !== this.token) {
+      var _this$token;
+      const instant = Math.floor(Date.now() / 1000);
+      this.token = token;
+      // decompose token
+      const tokenParts = (_this$token = this.token) === null || _this$token === void 0 ? void 0 : _this$token.split(".");
+      if (!tokenParts || tokenParts.length <= 1) {
+        _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEvent(_TelemetryConstants.LogLevel.ERROR, {
+          Event: _TelemetryConstants.TelemetryEvent.NewTokenFailed,
+          Description: "Invalid token format",
+          ExceptionDetails: "Token must be in JWT format"
+        });
+        throw new Error("Invalid token format, must be in JWT format");
+      }
+      // decode token
+      const tokenDecoded = JSON.parse(atob(tokenParts[1]));
+      // calculate expiration time
+      this.expiration = this.convertExpiration(tokenDecoded.exp);
+
+      // this is a control , in case the getAuthToken function returns same token
+      if (this.expiration > 0 && this.expiration < instant) {
+        _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEvent(_TelemetryConstants.LogLevel.ERROR, {
+          Event: _TelemetryConstants.TelemetryEvent.NewTokenExpired,
+          Description: "New token is already expired",
+          ExceptionDetails: {
+            "Instant": instant,
+            "Expiration": this.expiration
+          }
+        });
+        throw new Error("New token is already expired, with epoch time " + this.expiration);
+      }
+    }
+  }
+  async tokenRing() {
+    // this is needed for storybooks, specifically for reconnect pane which requires authentication bypass
+    if (this.sdkMocked === true) {
+      return {
+        result: true,
+        message: "Authentication not needed"
+      };
+    }
+    if (!this.isAuthenticated) {
+      return {
+        result: true,
+        message: "Authentication not needed"
+      };
+    }
+    if (this.isTokenSet() && !this.isTokenExpired()) {
+      return {
+        result: true,
+        message: "Token is valid"
+      };
+    }
+    if (this.getAuthToken === undefined) {
+      _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEvent(_TelemetryConstants.LogLevel.ERROR, {
+        Event: _TelemetryConstants.TelemetryEvent.NewTokenFailed,
+        Description: "GetAuthToken function is not present",
+        ExceptionDetails: "Missing function : " + (0, _authHelper.getAuthClientFunction)(this.chatConfig)
+      });
+      return {
+        result: false,
+        message: "GetAuthToken function is not present"
+      };
+    }
+
+    // if token is not set, or token is already expired , then go to grab a token
+    this.token = "";
+    this.expiration = 0;
+    try {
+      const ring = await (0, _authHelper.handleAuthentication)(this.chatSDK, this.chatConfig, this.getAuthToken);
+      if (ring.result === true && ring.token) {
+        await this.setToken(ring.token);
+        _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEvent(_TelemetryConstants.LogLevel.INFO, {
+          Event: _TelemetryConstants.TelemetryEvent.NewTokenSuccess,
+          Description: "New Token obtained",
+          Data: {
+            "Token_Expiration": this.expiration
+          }
+        });
+        return {
+          result: true,
+          message: "New Token obtained"
+        };
+      } else {
+        var _ring$error, _ring$error2;
+        console.error("Failed to get token", ring);
+        _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEvent(_TelemetryConstants.LogLevel.ERROR, {
+          Event: _TelemetryConstants.TelemetryEvent.NewTokenFailed,
+          Description: (_ring$error = ring.error) === null || _ring$error === void 0 ? void 0 : _ring$error.message,
+          ExceptionDetails: ring.error
+        });
+        return {
+          result: false,
+          message: ((_ring$error2 = ring.error) === null || _ring$error2 === void 0 ? void 0 : _ring$error2.message) || "Failed to get token"
+        };
+      }
+    } catch (e) {
+      console.error("Unexpected error while getting token", e);
+      _TelemetryHelper.TelemetryHelper.logFacadeChatSDKEvent(_TelemetryConstants.LogLevel.ERROR, {
+        Event: _TelemetryConstants.TelemetryEvent.NewTokenFailed,
+        Description: "Unexpected error while getting token",
+        ExceptionDetails: e
+      });
+      return {
+        result: false,
+        message: "Unexpected error while getting token"
+      };
+    }
+  }
+  async validateAndExecuteCall(functionName, fn) {
+    const pingResponse = await this.tokenRing();
+    if (pingResponse.result === true) {
+      return fn();
+    }
+    const executionErrorMessage = `Authentication failed: Process to get a token failed for ${functionName}, ${pingResponse.message}`;
+    //telemetry is already logged in tokenRing, so no need to log again, just return the error and communicate to the console
+    console.error(executionErrorMessage);
+    _omnichannelChatComponents.BroadcastService.postMessage({
+      eventName: _TelemetryConstants.BroadcastEvent.OnWidgetError,
+      payload: {
+        errorMessage: executionErrorMessage
+      }
+    });
+    throw new Error(executionErrorMessage);
+  }
+  async initialize() {
+    let optionalParams = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return this.validateAndExecuteCall("initialize", () => this.chatSDK.initialize(optionalParams));
+  }
+  async getChatReconnectContext() {
+    let optionalParams = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return this.validateAndExecuteCall("getChatReconnectContext", () => this.chatSDK.getChatReconnectContext(optionalParams));
+  }
+  async startChat() {
+    let optionalParams = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return this.validateAndExecuteCall("startChat", () => this.chatSDK.startChat(optionalParams));
+  }
+  async endChat() {
+    let optionalParams = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return this.validateAndExecuteCall("endChat", () => this.chatSDK.endChat(optionalParams));
+  }
+  async getCurrentLiveChatContext() {
+    return this.validateAndExecuteCall("getCurrentLiveChatContext", () => this.chatSDK.getCurrentLiveChatContext());
+  }
+  async getConversationDetails() {
+    let optionalParams = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return this.validateAndExecuteCall("getConversationDetails", () => this.chatSDK.getConversationDetails(optionalParams));
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  async getPreChatSurvey() {
+    let parse = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+    //prechat survey is obtained from config object, which is not required to be authenticated
+    // removing the tokenRing function from this call for backward compatibility
+    // TODO ::  wrap this function around authentication
+    return this.chatSDK.getPreChatSurvey(parse);
+  }
+  async getLiveChatConfig(optionalParams) {
+    return this.validateAndExecuteCall("getLiveChatConfig", () => this.chatSDK.getLiveChatConfig(optionalParams));
+  }
+  async getChatToken() {
+    let cached = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+    let optionalParams = arguments.length > 1 ? arguments[1] : undefined;
+    return this.validateAndExecuteCall("getChatToken", () => this.chatSDK.getChatToken(cached, optionalParams));
+  }
+  async getCallingToken() {
+    return this.validateAndExecuteCall("getCallingToken", () => this.chatSDK.getCallingToken());
+  }
+  async getMessages() {
+    return this.validateAndExecuteCall("getMessages", () => this.chatSDK.getMessages());
+  }
+  async getDataMaskingRules() {
+    return this.validateAndExecuteCall("getDataMaskingRules", () => this.chatSDK.getDataMaskingRules());
+  }
+  async sendMessage(message) {
+    return this.validateAndExecuteCall("sendMessage", () => this.chatSDK.sendMessage(message));
+  }
+  async onNewMessage(onNewMessageCallback) {
+    let optionalParams = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    return this.validateAndExecuteCall("onNewMessage", () => this.chatSDK.onNewMessage(onNewMessageCallback, optionalParams));
+  }
+  async sendTypingEvent() {
+    return this.validateAndExecuteCall("sendTypingEvent", () => this.chatSDK.sendTypingEvent());
+  }
+  async onTypingEvent(onTypingEventCallback) {
+    return this.validateAndExecuteCall("onTypingEvent", () => this.chatSDK.onTypingEvent(onTypingEventCallback));
+  }
+  async onAgentEndSession(onAgentEndSessionCallback) {
+    return this.validateAndExecuteCall("onAgentEndSession", () => this.chatSDK.onAgentEndSession(onAgentEndSessionCallback));
+  }
+  async uploadFileAttachment(fileInfo) {
+    return this.validateAndExecuteCall("uploadFileAttachment", () => this.chatSDK.uploadFileAttachment(fileInfo));
+  }
+  async downloadFileAttachment(fileMetadata) {
+    return this.validateAndExecuteCall("downloadFileAttachment", () => this.chatSDK.downloadFileAttachment(fileMetadata));
+  }
+  async emailLiveChatTranscript(body) {
+    let optionalParams = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    return this.validateAndExecuteCall("emailLiveChatTranscript", () => this.chatSDK.emailLiveChatTranscript(body, optionalParams));
+  }
+  async getLiveChatTranscript() {
+    let optionalParams = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return this.validateAndExecuteCall("getLiveChatTranscript", () => this.chatSDK.getLiveChatTranscript(optionalParams));
+  }
+
+  // response from origin is unknown, but this definition breaks create adapter for shimAdapter, switching to any until type is returned from origin
+  async createChatAdapter() {
+    let optionalParams = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return this.validateAndExecuteCall("createChatAdapter", () => this.chatSDK.createChatAdapter(optionalParams));
+  }
+  async isVoiceVideoCallingEnabled() {
+    this.tokenRing();
+    return this.chatSDK.isVoiceVideoCallingEnabled();
+  }
+  async getVoiceVideoCalling() {
+    let params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return this.validateAndExecuteCall("getVoiceVideoCalling", () => this.chatSDK.getVoiceVideoCalling(params));
+  }
+  async getPostChatSurveyContext() {
+    return this.validateAndExecuteCall("getPostChatSurveyContext", () => this.chatSDK.getPostChatSurveyContext());
+  }
+  async getAgentAvailability() {
+    let optionalParams = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return this.validateAndExecuteCall("getAgentAvailability", () => this.chatSDK.getAgentAvailability(optionalParams));
+  }
+}
+exports.FacadeChatSDK = FacadeChatSDK;

package/lib/cjs/common/facades/types/IFacadeChatSDKInput.js

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

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

@@ -188,6 +188,7 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["SendTypingIndicatorSucceeded"] = "SendTypingIndicatorSucceeded";
   TelemetryEvent["SendTypingIndicatorFailed"] = "SendTypingIndicatorFailed";
   TelemetryEvent["WebChatEvent"] = "WebChatEvent";
+  TelemetryEvent["FacadeChatSDKEvent"] = "FacadeChatSDKEvent";
   TelemetryEvent["PreChatSurveyStartChatMethodFailed"] = "PreChatSurveyStartChatMethodFailed";
   TelemetryEvent["ChatAlreadyTriggered"] = "ChatAlreadyTriggered";
   TelemetryEvent["StartProactiveChatEventReceived"] = "StartProactiveChatEventReceived";
@@ -218,6 +219,10 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["ChatDisconnectThreadEventReceived"] = "ChatDisconnectThreadEventReceived";
   TelemetryEvent["HiddenAdaptiveCardMessageReceived"] = "HiddenAdaptiveCardMessageReceived";
   TelemetryEvent["EndingAdapterAfterDisconnectionError"] = "EndingAdapterAfterDisconnectionError";
+  TelemetryEvent["NewTokenSuccess"] = "NewTokenSuccess";
+  TelemetryEvent["NewTokenFailed"] = "NewTokenFailed";
+  TelemetryEvent["NewTokenExpired"] = "NewTokenExpired";
+  TelemetryEvent["TokenEmptyOrSame"] = "TokenEmptyOrSame";
 })(TelemetryEvent || (exports.TelemetryEvent = TelemetryEvent = {}));
 class TelemetryConstants {
   static map(eventTypeOrScenarioType) {

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

@@ -264,4 +264,14 @@ _defineProperty(TelemetryHelper, "logWebChatEvent", (logLevel, payload) => {
     }
   };
   _omnichannelChatComponents.BroadcastService.postMessage(telemetryEvent);
+});
+_defineProperty(TelemetryHelper, "logFacadeChatSDKEvent", (logLevel, payload) => {
+  const telemetryEvent = {
+    eventName: (payload === null || payload === void 0 ? void 0 : payload.Event) ?? _TelemetryConstants.TelemetryEvent.FacadeChatSDKEvent,
+    logLevel: logLevel,
+    payload: {
+      ...payload
+    }
+  };
+  _omnichannelChatComponents.BroadcastService.postMessage(telemetryEvent);
 });

package/lib/cjs/common/utils.js

@@ -390,7 +390,7 @@ const isThisSessionPopout = href => {
 };
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 exports.isThisSessionPopout = isThisSessionPopout;
-const getConversationDetailsCall = async function (chatSDK) {
+const getConversationDetailsCall = async function (facadeChatSDK) {
   let liveChatContext = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : null;
   let conversationDetails = undefined; // eslint-disable-line @typescript-eslint/no-explicit-any
   const optionalParams = {}; // eslint-disable-line @typescript-eslint/no-explicit-any
@@ -403,7 +403,7 @@ const getConversationDetailsCall = async function (chatSDK) {
       Event: _TelemetryConstants.TelemetryEvent.GetConversationDetailsCallStarted,
       Description: "Conversation details call started"
     });
-    conversationDetails = await chatSDK.getConversationDetails(optionalParams);
+    conversationDetails = await facadeChatSDK.getConversationDetails(optionalParams);
   } catch (error) {
     checkContactIdError(error);
     _TelemetryHelper.TelemetryHelper.logSDKEvent(_TelemetryConstants.LogLevel.ERROR, {

package/lib/cjs/components/callingcontainerstateful/CallingContainerStateful.js

@@ -10,18 +10,14 @@ var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components
 var _LiveChatWidgetActionType = require("../../contexts/common/LiveChatWidgetActionType");
 var _TelemetryHelper = require("../../common/telemetry/TelemetryHelper");
 var _useChatContextStore = _interopRequireDefault(require("../../hooks/useChatContextStore"));
-var _useChatSDKStore = _interopRequireDefault(require("../../hooks/useChatSDKStore"));
+var _useFacadeChatSDKStore = _interopRequireDefault(require("../../hooks/useFacadeChatSDKStore"));
 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); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 const CallingContainerStateful = props => {
   var _props$controlProps, _props$controlProps2, _props$controlProps2$, _props$controlProps3, _props$controlProps3$, _props$controlProps3$2, _props$controlProps4, _props$controlProps4$, _props$controlProps4$2, _props$controlProps5;
-  //TODO : Close button confirmation implmentation is pending
-
   const [state, dispatch] = (0, _useChatContextStore.default)();
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const chatSDK = (0, _useChatSDKStore.default)();
-
+  const [facadeChatSDK] = (0, _useFacadeChatSDKStore.default)();
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const {
     voiceVideoCallingSdk
@@ -54,7 +50,7 @@ const CallingContainerStateful = props => {
   (0, _react.useEffect)(() => {
     const init = async () => {
       try {
-        var _controlProps$current, _controlProps$current2, _controlProps$current3, _controlProps$current4;
+        var _controlProps$current, _controlProps$current2, _controlProps$current3, _controlProps$current4, _facadeChatSDK$getCha;
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         _TelemetryHelper.TelemetryHelper.callId = callId;
         await voiceVideoCallingSdk.initialize({
@@ -63,7 +59,7 @@ const CallingContainerStateful = props => {
           // HTML element id where video stream of the agent will be rendered
           remoteVideoHTMLElementId: (_controlProps$current3 = controlProps.currentCallControlProps) === null || _controlProps$current3 === void 0 ? void 0 : (_controlProps$current4 = _controlProps$current3.nonActionIds) === null || _controlProps$current4 === void 0 ? void 0 : _controlProps$current4.remoteVideoTileId,
           // HTML element id where video stream of the customer will be rendered
-          OCClient: chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.OCClient
+          OCClient: (_facadeChatSDK$getCha = facadeChatSDK.getChatSDK()) === null || _facadeChatSDK$getCha === void 0 ? void 0 : _facadeChatSDK$getCha.OCClient
         });
       } catch (e) {
         _TelemetryHelper.TelemetryHelper.logCallingEvent(_TelemetryConstants.LogLevel.ERROR, {

package/lib/cjs/components/emailtranscriptpanestateful/EmailTranscriptPaneStateful.js

@@ -14,9 +14,9 @@ var _NotificationHandler = require("../webchatcontainerstateful/webchatcontrolle
 var _NotificationScenarios = require("../webchatcontainerstateful/webchatcontroller/enums/NotificationScenarios");
 var _Constants = require("../../common/Constants");
 var _TelemetryHelper = require("../../common/telemetry/TelemetryHelper");
-var _useChatContextStore = _interopRequireDefault(require("../../hooks/useChatContextStore"));
-var _useChatSDKStore = _interopRequireDefault(require("../../hooks/useChatSDKStore"));
 var _defaultMiddlewareLocalizedTexts = require("../webchatcontainerstateful/common/defaultProps/defaultMiddlewareLocalizedTexts");
+var _useChatContextStore = _interopRequireDefault(require("../../hooks/useChatContextStore"));
+var _useFacadeChatSDKStore = _interopRequireDefault(require("../../hooks/useFacadeChatSDKStore"));
 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); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -25,8 +25,7 @@ const EmailTranscriptPaneStateful = props => {
   const initialTabIndexMap = new Map();
   let elements = [];
   const [state, dispatch] = (0, _useChatContextStore.default)();
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const chatSDK = (0, _useChatSDKStore.default)();
+  const [facadeChatSDK] = (0, _useFacadeChatSDKStore.default)();
   const [initialEmail, setInitialEmail] = (0, _react.useState)("");
   const closeEmailTranscriptPane = () => {
     dispatch({
@@ -54,7 +53,7 @@ const EmailTranscriptPaneStateful = props => {
       attachmentMessage: (props === null || props === void 0 ? void 0 : props.attachmentMessage) ?? "The following attachment was uploaded during the conversation:"
     };
     try {
-      await (chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.emailLiveChatTranscript(chatTranscriptBody, {
+      await (facadeChatSDK === null || facadeChatSDK === void 0 ? void 0 : facadeChatSDK.emailLiveChatTranscript(chatTranscriptBody, {
         liveChatContext
       }));
       _NotificationHandler.NotificationHandler.notifySuccess(_NotificationScenarios.NotificationScenarios.EmailAddressSaved, _defaultMiddlewareLocalizedTexts.defaultMiddlewareLocalizedTexts === null || _defaultMiddlewareLocalizedTexts.defaultMiddlewareLocalizedTexts === void 0 ? void 0 : _defaultMiddlewareLocalizedTexts.defaultMiddlewareLocalizedTexts.MIDDLEWARE_BANNER_FILE_EMAIL_ADDRESS_RECORDED_SUCCESS);
@@ -72,7 +71,7 @@ const EmailTranscriptPaneStateful = props => {
       const message = (0, _utils.formatTemplateString)(_defaultMiddlewareLocalizedTexts.defaultMiddlewareLocalizedTexts.MIDDLEWARE_BANNER_FILE_EMAIL_ADDRESS_RECORDED_ERROR, [email]);
       _NotificationHandler.NotificationHandler.notifyError(_NotificationScenarios.NotificationScenarios.EmailTranscriptError, (props === null || props === void 0 ? void 0 : props.bannerMessageOnError) ?? message);
     }
-  }, [props.attachmentMessage, props.bannerMessageOnError, chatSDK, state.domainStates.liveChatContext]);
+  }, [props.attachmentMessage, props.bannerMessageOnError, facadeChatSDK, state.domainStates.liveChatContext]);
   const controlProps = {
     id: "oclcw-emailTranscriptDialogContainer",
     dir: state.domainStates.globalDir,

package/lib/cjs/components/footerstateful/FooterStateful.js

@@ -8,6 +8,7 @@ var _TelemetryConstants = require("../../common/telemetry/TelemetryConstants");
 var _react = _interopRequireWildcard(require("react"));
 var _AudioNotificationStateful = _interopRequireDefault(require("./audionotificationstateful/AudioNotificationStateful"));
 var _Constants = require("../../common/Constants");
+var _ConversationState = require("../../contexts/common/ConversationState");
 var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components");
 var _LiveChatWidgetActionType = require("../../contexts/common/LiveChatWidgetActionType");
 var _Audios = require("../../assets/Audios");
@@ -16,8 +17,7 @@ var _NotificationScenarios = require("../webchatcontainerstateful/webchatcontrol
 var _TelemetryHelper = require("../../common/telemetry/TelemetryHelper");
 var _DownloadTranscriptStateful = require("./downloadtranscriptstateful/DownloadTranscriptStateful");
 var _useChatContextStore = _interopRequireDefault(require("../../hooks/useChatContextStore"));
-var _useChatSDKStore = _interopRequireDefault(require("../../hooks/useChatSDKStore"));
-var _ConversationState = require("../../contexts/common/ConversationState");
+var _useFacadeChatSDKStore = _interopRequireDefault(require("../../hooks/useFacadeChatSDKStore"));
 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); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -34,8 +34,7 @@ const FooterStateful = props => {
     audioNotificationProps,
     hideFooterDisplay
   } = props;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const chatSDK = (0, _useChatSDKStore.default)();
+  const [facadeChatSDK] = (0, _useFacadeChatSDKStore.default)();
   const controlProps = {
     id: "oc-lcw-footer",
     dir: state.domainStates.globalDir,
@@ -45,7 +44,7 @@ const FooterStateful = props => {
           Event: _TelemetryConstants.TelemetryEvent.DownloadTranscriptButtonClicked,
           Description: "Download Transcript button clicked."
         });
-        await (0, _DownloadTranscriptStateful.downloadTranscript)(chatSDK, downloadTranscriptProps, state);
+        await (0, _DownloadTranscriptStateful.downloadTranscript)(facadeChatSDK, downloadTranscriptProps, state);
       } catch (ex) {
         _TelemetryHelper.TelemetryHelper.logActionEvent(_TelemetryConstants.LogLevel.ERROR, {
           Event: _TelemetryConstants.TelemetryEvent.DownloadTranscriptFailed,

package/lib/cjs/components/footerstateful/downloadtranscriptstateful/DownloadTranscriptStateful.js

@@ -5,15 +5,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.downloadTranscript = void 0;
 var _Constants = require("../../../common/Constants");
-var _NotificationScenarios = require("../../webchatcontainerstateful/webchatcontroller/enums/NotificationScenarios");
+var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants");
+var _utils = require("../../../common/utils");
+var _dompurify = _interopRequireDefault(require("dompurify"));
+var _LiveChatWidgetActionType = require("../../../contexts/common/LiveChatWidgetActionType");
 var _NotificationHandler = require("../../webchatcontainerstateful/webchatcontroller/notification/NotificationHandler");
+var _NotificationScenarios = require("../../webchatcontainerstateful/webchatcontroller/enums/NotificationScenarios");
 var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
-var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants");
 var _createChatTranscript = _interopRequireDefault(require("../../../plugins/createChatTranscript"));
-var _dompurify = _interopRequireDefault(require("dompurify"));
-var _utils = require("../../../common/utils");
 var _createReducer = require("../../../contexts/createReducer");
-var _LiveChatWidgetActionType = require("../../../contexts/common/LiveChatWidgetActionType");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const processDisplayName = displayName => {
   // if displayname matches "teamsvisitor:<some alphanumeric string>", we replace it with "Customer"
@@ -163,9 +163,7 @@ const beautifyChatTranscripts = (chatTranscripts, renderMarkDown, attachmentMess
   const str = docTypeTag + docStartTag + docMetaTag + bodyStartTag + mainTranscriptSection + beautifiedChats + divEndTag + bodyEndTag + docEndTag;
   return str;
 };
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-const downloadTranscript = async (chatSDK, downloadTranscriptProps, state) => {
+const downloadTranscript = async (facadeChatSDK, downloadTranscriptProps, state) => {
   var _state$domainStates;
   // Need to keep existing live chat context for scenarios when transcript is downloaded after endchat
   let liveChatContext = state === null || state === void 0 ? void 0 : (_state$domainStates = state.domainStates) === null || _state$domainStates === void 0 ? void 0 : _state$domainStates.liveChatContext;
@@ -176,7 +174,7 @@ const downloadTranscript = async (chatSDK, downloadTranscriptProps, state) => {
     });
     liveChatContext = inMemoryState.domainStates.liveChatContext;
   }
-  let data = await (chatSDK === null || chatSDK === void 0 ? void 0 : chatSDK.getLiveChatTranscript({
+  let data = await (facadeChatSDK === null || facadeChatSDK === void 0 ? void 0 : facadeChatSDK.getLiveChatTranscript({
     liveChatContext
   }));
   if (typeof data === _Constants.Constants.String) {
@@ -194,7 +192,7 @@ const downloadTranscript = async (chatSDK, downloadTranscriptProps, state) => {
       const transcriptOptions = {
         ...webChatTranscript
       };
-      await (0, _createChatTranscript.default)(data[_Constants.Constants.ChatMessagesJson], chatSDK, false, transcriptOptions);
+      await (0, _createChatTranscript.default)(data[_Constants.Constants.ChatMessagesJson], facadeChatSDK, false, transcriptOptions);
     } else {
       // Legacy Transcript
       const chatTranscripts = window.btoa(encodeURIComponent(beautifyChatTranscripts(data[_Constants.Constants.ChatMessagesJson], renderMarkDown, attachmentMessage)));

package/lib/cjs/components/livechatwidget/LiveChatWidget.js

@@ -8,29 +8,52 @@ var _react = _interopRequireWildcard(require("react"));
 var _ChatAdapterStore = require("../../contexts/ChatAdapterStore");
 var _ChatContextStore = require("../../contexts/ChatContextStore");
 var _ChatSDKStore = require("../../contexts/ChatSDKStore");
+var _FacadeChatSDK = require("../../common/facades/FacadeChatSDK");
+var _FacadeChatSDKStore = require("../../contexts/FacadeChatSDKStore");
 var _LiveChatWidgetStateful = _interopRequireDefault(require("./livechatwidgetstateful/LiveChatWidgetStateful"));
 var _createReducer = require("../../contexts/createReducer");
 var _LiveChatWidgetContextInitialState = require("../../contexts/common/LiveChatWidgetContextInitialState");
 var _getMockChatSDKIfApplicable = require("./common/getMockChatSDKIfApplicable");
+var _utils = require("../../common/utils");
 var _overridePropsOnMockIfApplicable = _interopRequireDefault(require("./common/overridePropsOnMockIfApplicable"));
 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); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 const LiveChatWidget = props => {
-  var _props$mock;
+  var _props$mock, _props$chatConfig, _props$chatConfig$Liv;
   const reducer = (0, _createReducer.createReducer)();
   const [state, dispatch] = (0, _react.useReducer)(reducer, (0, _LiveChatWidgetContextInitialState.getLiveChatWidgetContextInitialState)(props));
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const [adapter, setAdapter] = (0, _react.useState)(undefined);
+  const [facadeChatSDK, setFacadeChatSDK] = (0, _react.useState)(undefined);
   const chatSDK = (0, _getMockChatSDKIfApplicable.getMockChatSDKIfApplicable)(props.chatSDK, props === null || props === void 0 ? void 0 : (_props$mock = props.mock) === null || _props$mock === void 0 ? void 0 : _props$mock.type);
   (0, _overridePropsOnMockIfApplicable.default)(props);
-  return /*#__PURE__*/_react.default.createElement(_ChatSDKStore.ChatSDKStore.Provider, {
+  if (!props.chatConfig) {
+    throw new Error("chatConfig is required");
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const isAuthenticatedChat = !!((_props$chatConfig = props.chatConfig) !== null && _props$chatConfig !== void 0 && (_props$chatConfig$Liv = _props$chatConfig.LiveChatConfigAuthSettings) !== null && _props$chatConfig$Liv !== void 0 && _props$chatConfig$Liv.msdyn_javascriptclientfunction);
+  if (!facadeChatSDK) {
+    var _props$mock2;
+    setFacadeChatSDK(new _FacadeChatSDK.FacadeChatSDK({
+      "chatSDK": chatSDK,
+      "chatConfig": props.chatConfig,
+      "isAuthenticated": isAuthenticatedChat,
+      "getAuthToken": props === null || props === void 0 ? void 0 : props.getAuthToken,
+      //when type is not undefined, it means the SDK is mocked
+      "isSDKMocked": !(0, _utils.isNullOrUndefined)(props === null || props === void 0 ? void 0 : (_props$mock2 = props.mock) === null || _props$mock2 === void 0 ? void 0 : _props$mock2.type)
+    }));
+  }
+  return /*#__PURE__*/_react.default.createElement(_FacadeChatSDKStore.FacadeChatSDKStore.Provider, {
+    value: [facadeChatSDK, setFacadeChatSDK]
+  }, /*#__PURE__*/_react.default.createElement(_ChatSDKStore.ChatSDKStore.Provider, {
     value: chatSDK
   }, /*#__PURE__*/_react.default.createElement(_ChatAdapterStore.ChatAdapterStore.Provider, {
     value: [adapter, setAdapter]
   }, /*#__PURE__*/_react.default.createElement(_ChatContextStore.ChatContextStore.Provider, {
     value: [state, dispatch]
-  }, /*#__PURE__*/_react.default.createElement(_LiveChatWidgetStateful.default, props))));
+  }, /*#__PURE__*/_react.default.createElement(_LiveChatWidgetStateful.default, props)))));
 };
 exports.LiveChatWidget = LiveChatWidget;
 var _default = LiveChatWidget;

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

@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.removeAuthTokenProvider = exports.handleAuthentication = exports.getAuthClientFunction = void 0;
 var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants");
 var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
-var _utils = require("../../../common/utils");
 var _Constants = require("../../../common/Constants");
+var _utils = require("../../../common/utils");
 const getAuthClientFunction = chatConfig => {
   let authClientFunction = undefined;
   if (chatConfig !== null && chatConfig !== void 0 && chatConfig.LiveChatConfigAuthSettings) {
@@ -16,8 +16,6 @@ const getAuthClientFunction = chatConfig => {
   }
   return authClientFunction;
 };
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 exports.getAuthClientFunction = getAuthClientFunction;
 const handleAuthentication = async (chatSDK, chatConfig, getAuthToken) => {
   const authClientFunction = getAuthClientFunction(chatConfig);
@@ -31,7 +29,10 @@ const handleAuthentication = async (chatSDK, chatConfig, getAuthToken) => {
       chatSDK.setAuthTokenProvider(async () => {
         return token;
       });
-      return true;
+      return {
+        "result": true,
+        "token": token
+      };
     } else {
       // instead of returning false, it's more appropiate to thrown an error to force error handling on the caller side
       // this will help to avoid the error to be ignored and the chat to be started
@@ -41,7 +42,15 @@ const handleAuthentication = async (chatSDK, chatConfig, getAuthToken) => {
       throw new Error(_Constants.WidgetLoadCustomErrorString.AuthenticationFailedErrorString);
     }
   }
-  return false;
+  return {
+    "result": false,
+    "token": null,
+    "error": {
+      "message": "No auth client function or getAuthToken function provided",
+      "getAuthTokenPresent": getAuthToken ? true : false,
+      "authClientFunctionPresent": authClientFunction ? true : false
+    }
+  };
 };
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any