@microsoft/omnichannel-chat-widget 1.8.2-main.d82a79b → 1.8.2-main.f638bed

package/README.md

@@ -223,6 +223,51 @@ const customizedFooterProp: IFooterProps = {
 
 > :pushpin: Note that [WebChat hooks](https://github.com/microsoft/BotFramework-WebChat/blob/main/docs/HOOKS.md) can also be used in any custom components.
 
+#### Bidirectional Custom Events
+- Sending events from a hosting web page to bots/agents
+    - Register a function to post event
+        ```js
+        //define sendCustomEvent function
+        const sendCustomEvent = (payload) => {
+            const customEvent = {
+                eventName: "sendCustomEvent",
+                payload
+            };
+            BroadcastService.postMessage(customEvent);
+        };
+
+        //attach the sendCustomEvent function to window object
+        window["sendCustomEvent"] = sendCustomEvent;
+
+        //invoke the sendCustomEvent function with some customized payload
+        window.sendCustomEvent({
+            customEventName: "TestEvent",
+            customEventValue: {
+                boolVar: true,
+                displayableVar: {
+                    isDisplayable: true,
+                    value: "From C2: "+ new Date().toISOString()
+                },
+                numberVar: -10.5,
+                stringVar: "Hello from C2 str: " + new Date().toISOString()
+            }
+        })
+        ```
+    - Receiving events from bots/agents
+        ```js
+        //define setOnCustomEvent function
+        const setOnCustomEvent = (callback) => {
+            BroadcastService.getMessageByEventName("onCustomEvent").subscribe((event) => {
+                if (event && typeof callback === "function") {
+                    callback(event);
+                }
+            });
+        };
+
+        //set callback function
+        setOnCustomEvent((event) => console.log(event));
+        ```
+
 ## See Also
 
 [Customizations Dev Guide](https://github.com/microsoft/omnichannel-chat-widget/blob/main/docs/customizations/getstarted.md)\
@@ -232,4 +277,4 @@ const customizedFooterProp: IFooterProps = {
 [How to Add Visual Regression Tests](https://github.com/microsoft/omnichannel-chat-widget/blob/main/docs/VisualRegressionTestingGuide.md)\
 [Security](https://github.com/microsoft/omnichannel-chat-widget/blob/main/SECURITY.md)\
 [Third Party Cookie Support](https://github.com/microsoft/omnichannel-chat-widget/blob/main/docs/Tpc.md)\
-[Storybook](https://microsoft.github.io/omnichannel-chat-widget/docs/storybook/)
+[Storybook](https://microsoft.github.io/omnichannel-chat-widget/docs/storybook/)

package/lib/cjs/common/Constants.js

@@ -131,6 +131,11 @@ _defineProperty(Constants, "InitContextParamsResponse", "initContextParamsRespon
 _defineProperty(Constants, "OCOriginalMessageId", "OriginalMessageId");
 _defineProperty(Constants, "WebchatSequenceIdAttribute", "webchat:sequence-id");
 _defineProperty(Constants, "MessageSequenceIdOverride", "MessageSequenceIdOverride");
+_defineProperty(Constants, "sendCustomEvent", "sendCustomEvent");
+_defineProperty(Constants, "onCustomEvent", "onCustomEvent");
+_defineProperty(Constants, "customEventName", "customEventName");
+_defineProperty(Constants, "customEventValue", "customEventValue");
+_defineProperty(Constants, "Hidden", "Hidden");
 _defineProperty(Constants, "EndConversationDueToOverflow", "endconversationduetooverflow");
 const Regex = (_class = /*#__PURE__*/_createClass(function Regex() {
   _classCallCheck(this, Regex);

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

@@ -229,6 +229,7 @@ exports.TelemetryEvent = TelemetryEvent;
   TelemetryEvent["SystemMessageReceived"] = "SystemMessageReceived";
   TelemetryEvent["RehydrateMessageReceived"] = "RehydrateMessageReceived";
   TelemetryEvent["CustomContextReceived"] = "CustomContextReceived";
+  TelemetryEvent["CustomEventAction"] = "CustomEventAction";
   TelemetryEvent["NetworkDisconnected"] = "NetworkDisconnected";
   TelemetryEvent["NetworkReconnected"] = "NetworkReconnected";
   TelemetryEvent["LinkModePostChatWorkflowStarted"] = "LinkModePostChatWorkflowStarted";

package/lib/cjs/common/utils.js

@@ -3,11 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getConversationDetailsCall = exports.getBroadcastChannelName = exports.formatTemplateString = exports.findParentFocusableElementsWithoutChildContainer = exports.findAllFocusableElement = exports.extractPreChatSurveyResponseValues = exports.escapeHtml = exports.debounceLeading = exports.createTimer = exports.createFileAndDownload = exports.checkContactIdError = exports.changeLanguageCodeFormatForWebChat = exports.addDelayInMs = void 0;
+exports.getCustomEventValue = exports.getConversationDetailsCall = exports.getBroadcastChannelName = exports.formatTemplateString = exports.findParentFocusableElementsWithoutChildContainer = exports.findAllFocusableElement = exports.extractPreChatSurveyResponseValues = exports.escapeHtml = exports.debounceLeading = exports.createTimer = exports.createFileAndDownload = exports.checkContactIdError = exports.changeLanguageCodeFormatForWebChat = exports.addDelayInMs = void 0;
 exports.getDeviceType = getDeviceType;
 exports.getWidgetEndChatEventName = exports.getWidgetCacheIdfromProps = exports.getWidgetCacheId = exports.getTimestampHourMinute = exports.getStateFromCache = exports.getLocaleDirection = exports.getIconText = exports.getDomain = void 0;
 exports.isEndConversationDueToOverflowActivity = isEndConversationDueToOverflowActivity;
-exports.setTabIndices = exports.setOcUserAgent = exports.setFocusOnSendBox = exports.setFocusOnElement = exports.preventFocusToMoveOutOfElement = exports.parseLowerCaseString = exports.parseAdaptiveCardPayload = exports.newGuid = exports.isUndefinedOrEmpty = exports.isThisSessionPopout = exports.isNullOrUndefined = exports.isNullOrEmptyString = void 0;
+exports.setTabIndices = exports.setOcUserAgent = exports.setFocusOnSendBox = exports.setFocusOnElement = exports.preventFocusToMoveOutOfElement = exports.parseLowerCaseString = exports.parseAdaptiveCardPayload = exports.newGuid = exports.isValidCustomEvent = exports.isUndefinedOrEmpty = exports.isThisSessionPopout = exports.isNullOrUndefined = exports.isNullOrEmptyString = void 0;
 var _Constants = require("./Constants");
 var _TelemetryConstants = require("./telemetry/TelemetryConstants");
 var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components");
@@ -497,6 +497,25 @@ function getDeviceType() {
     return "standard";
   }
 }
+
+//Bots expect a payload containing:
+//1. customEventName: this should be string describe the event name
+//2. customEventValue: given the value is from customer with unknown type, it is required to stringify the payload later
+const isValidCustomEvent = payload => {
+  if (_Constants.Constants.customEventName in payload && payload.customEventName && typeof payload.customEventName === _Constants.Constants.String && _Constants.Constants.customEventValue in payload && payload.customEventValue) return true;
+  return false;
+};
+exports.isValidCustomEvent = isValidCustomEvent;
+const getCustomEventValue = customEventPayload => {
+  let returnVal = "";
+  try {
+    returnVal = typeof customEventPayload.customEventValue === _Constants.Constants.String ? customEventPayload.customEventValue : JSON.stringify(customEventPayload.customEventValue);
+  } catch (error) {
+    console.error(error);
+  }
+  return returnVal;
+};
+exports.getCustomEventValue = getCustomEventValue;
 function isEndConversationDueToOverflowActivity(activity) {
   var _activity$channelData, _activity$channelData2;
   return (activity === null || activity === void 0 ? void 0 : (_activity$channelData = activity.channelData) === null || _activity$channelData === void 0 ? void 0 : _activity$channelData.tags) && Array.isArray(activity === null || activity === void 0 ? void 0 : (_activity$channelData2 = activity.channelData) === null || _activity$channelData2 === void 0 ? void 0 : _activity$channelData2.tags) && activity.channelData.tags.includes(_Constants.Constants.EndConversationDueToOverflow);

package/lib/cjs/components/chatbuttonstateful/ChatButtonStateful.js

@@ -74,7 +74,6 @@ const ChatButtonStateful = props => {
   };
   const outOfOfficeStyleProps = Object.assign({}, _defaultOutOfOfficeChatButtonStyleProps.defaultOutOfOfficeChatButtonStyleProps, outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.styleProps);
   const controlProps = {
-    ...(buttonProps === null || buttonProps === void 0 ? void 0 : buttonProps.controlProps),
     id: "oc-lcw-chat-button",
     dir: state.domainStates.globalDir,
     titleText: "Let's Chat!",
@@ -83,7 +82,8 @@ const ChatButtonStateful = props => {
     unreadMessageCount: state.appStates.unreadMessageCount ? state.appStates.unreadMessageCount > _Constants.Constants.maximumUnreadMessageCount ? (_props$buttonProps = props.buttonProps) === null || _props$buttonProps === void 0 ? void 0 : (_props$buttonProps$co = _props$buttonProps.controlProps) === null || _props$buttonProps$co === void 0 ? void 0 : _props$buttonProps$co.largeUnreadMessageString : state.appStates.unreadMessageCount.toString() : "0",
     unreadMessageString: (_props$buttonProps2 = props.buttonProps) === null || _props$buttonProps2 === void 0 ? void 0 : (_props$buttonProps2$c = _props$buttonProps2.controlProps) === null || _props$buttonProps2$c === void 0 ? void 0 : _props$buttonProps2$c.unreadMessageString,
     // Regular chat button onClick - this will always take precedence
-    onClick: () => ref.current()
+    onClick: () => ref.current(),
+    ...(buttonProps === null || buttonProps === void 0 ? void 0 : buttonProps.controlProps)
   };
   const outOfOfficeControlProps = {
     // Only take specific properties from outOfOfficeButtonProps, never onClick
@@ -92,7 +92,6 @@ const ChatButtonStateful = props => {
     titleText: (outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : (_outOfOfficeButtonPro = outOfOfficeButtonProps.controlProps) === null || _outOfOfficeButtonPro === void 0 ? void 0 : _outOfOfficeButtonPro.titleText) || "We're Offline",
     subtitleText: (outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : (_outOfOfficeButtonPro2 = outOfOfficeButtonProps.controlProps) === null || _outOfOfficeButtonPro2 === void 0 ? void 0 : _outOfOfficeButtonPro2.subtitleText) || "No agents available",
     unreadMessageString: (_props$buttonProps3 = props.buttonProps) === null || _props$buttonProps3 === void 0 ? void 0 : (_props$buttonProps3$c = _props$buttonProps3.controlProps) === null || _props$buttonProps3$c === void 0 ? void 0 : _props$buttonProps3$c.unreadMessageString,
-    ...(outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.controlProps),
     // Out-of-office specific onClick - this will ALWAYS take precedence
     onClick: () => {
       if (state.appStates.isMinimized) {
@@ -105,7 +104,8 @@ const ChatButtonStateful = props => {
         type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_CONVERSATION_STATE,
         payload: _ConversationState.ConversationState.OutOfOffice
       });
-    }
+    },
+    ...(outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.controlProps)
   };
   (0, _react.useEffect)(() => {
     _TelemetryHelper.TelemetryHelper.logLoadingEvent(_TelemetryConstants.LogLevel.INFO, {

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

@@ -0,0 +1,53 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.subscribeToSendCustomEvent = exports.customEventCallback = void 0;
+var _Constants = require("../../../common/Constants");
+var _TelemetryHelper = require("../../../common/telemetry/TelemetryHelper");
+var _TelemetryConstants = require("../../../common/telemetry/TelemetryConstants");
+var _utils = require("../../../common/utils");
+const customEventCallback = facadeChatSDK => event => {
+  if (!(_Constants.Constants.payload in event)) return;
+  if ((0, _utils.isValidCustomEvent)(event.payload)) {
+    const customEventPayload = event.payload;
+    try {
+      const customEventValueStr = (0, _utils.getCustomEventValue)(customEventPayload);
+      const customEventName = customEventPayload.customEventName;
+      const messageMeta = {
+        customEvent: _Constants.Constants.true,
+        customEventName: customEventName,
+        customEventValue: customEventValueStr
+      };
+      const messagePayload = {
+        content: "",
+        tags: [_Constants.Constants.Hidden],
+        metadata: messageMeta,
+        timestamp: new Date()
+      };
+      facadeChatSDK.sendMessage(messagePayload);
+      _TelemetryHelper.TelemetryHelper.logActionEventToAllTelemetry(_TelemetryConstants.LogLevel.DEBUG, {
+        Event: _TelemetryConstants.TelemetryEvent.CustomEventAction,
+        Description: "Sent customEvent.",
+        CustomProperties: {
+          customEventName,
+          lengthCustomEventValue: customEventValueStr.length
+        }
+      });
+    } catch (error) {
+      _TelemetryHelper.TelemetryHelper.logActionEventToAllTelemetry(_TelemetryConstants.LogLevel.ERROR, {
+        Event: _TelemetryConstants.TelemetryEvent.CustomEventAction,
+        Description: "Failed to process CustomEvent.",
+        ExceptionDetails: {
+          error
+        }
+      });
+    }
+  }
+};
+exports.customEventCallback = customEventCallback;
+const subscribeToSendCustomEvent = (broadcastService, facadeChatSDK, customEventCallback) => {
+  broadcastService.getMessageByEventName(_Constants.Constants.sendCustomEvent).subscribe(customEventCallback(facadeChatSDK));
+};
+exports.subscribeToSendCustomEvent = subscribeToSendCustomEvent;

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

@@ -37,9 +37,11 @@ var _htmlPlayerMiddleware = _interopRequireDefault(require("../../webchatcontain
 var _htmlTextMiddleware = _interopRequireDefault(require("../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/htmlTextMiddleware"));
 var _preProcessingMiddleware = _interopRequireDefault(require("../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/preProcessingMiddleware"));
 var _sanitizationMiddleware = _interopRequireDefault(require("../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/sanitizationMiddleware"));
+var _customEventMiddleware = _interopRequireDefault(require("../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/customEventMiddleware"));
 var _ConversationState = require("../../../contexts/common/ConversationState");
 var _createReducer = require("../../../contexts/createReducer");
 var _queueOverflowHandlerMiddleware = require("../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/queueOverflowHandlerMiddleware");
+var _omnichannelChatComponents = require("@microsoft/omnichannel-chat-components");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endChat) => {
@@ -118,7 +120,7 @@ const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endChat) =>
     };
     webChatStore = (0, _botframeworkWebchat.createStore)({},
     //initial state
-    _preProcessingMiddleware.default, _attachmentProcessingMiddleware.default, (0, _attachmentUploadValidatorMiddleware.default)((_state$domainStates$l = state.domainStates.liveChatConfig) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.allowedFileExtensions, (_state$domainStates$l2 = state.domainStates.liveChatConfig) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.maxUploadFileSize, localizedTexts), (0, _queueOverflowHandlerMiddleware.createQueueOverflowMiddleware)(state, dispatch), (0, _channelDataMiddleware.default)(addConversationalSurveyTagsCallback), (0, _conversationEndMiddleware.default)(conversationEndCallback, startConversationalSurveyCallback, endConversationalSurveyCallback), (0, _dataMaskingMiddleware.default)((_state$domainStates$l3 = state.domainStates.liveChatConfig) === null || _state$domainStates$l3 === void 0 ? void 0 : _state$domainStates$l3.DataMaskingInfo), _messageTimestampMiddleware.createMessageTimeStampMiddleware, _messageSequenceIdOverrideMiddleware.createMessageSequenceIdOverrideMiddleware, _gifUploadMiddleware.default, _htmlPlayerMiddleware.default, (0, _htmlTextMiddleware.default)(honorsTargetInHTMLLinks), (0, _maxMessageSizeValidator.default)(localizedTexts), _sanitizationMiddleware.default,
+    _preProcessingMiddleware.default, _attachmentProcessingMiddleware.default, (0, _attachmentUploadValidatorMiddleware.default)((_state$domainStates$l = state.domainStates.liveChatConfig) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.allowedFileExtensions, (_state$domainStates$l2 = state.domainStates.liveChatConfig) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.maxUploadFileSize, localizedTexts), (0, _customEventMiddleware.default)(_omnichannelChatComponents.BroadcastService), (0, _queueOverflowHandlerMiddleware.createQueueOverflowMiddleware)(state, dispatch), (0, _channelDataMiddleware.default)(addConversationalSurveyTagsCallback), (0, _conversationEndMiddleware.default)(conversationEndCallback, startConversationalSurveyCallback, endConversationalSurveyCallback), (0, _dataMaskingMiddleware.default)((_state$domainStates$l3 = state.domainStates.liveChatConfig) === null || _state$domainStates$l3 === void 0 ? void 0 : _state$domainStates$l3.DataMaskingInfo), _messageTimestampMiddleware.createMessageTimeStampMiddleware, _messageSequenceIdOverrideMiddleware.createMessageSequenceIdOverrideMiddleware, _gifUploadMiddleware.default, _htmlPlayerMiddleware.default, (0, _htmlTextMiddleware.default)(honorsTargetInHTMLLinks), (0, _maxMessageSizeValidator.default)(localizedTexts), _sanitizationMiddleware.default,
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     ...(((_props$webChatContain7 = props.webChatContainerProps) === null || _props$webChatContain7 === void 0 ? void 0 : _props$webChatContain7.storeMiddlewares) ?? []));
     _WebChatStoreLoader.WebChatStoreLoader.store = webChatStore;

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

@@ -57,6 +57,7 @@ var _startProactiveChat = require("../common/startProactiveChat");
 var _useChatAdapterStore = _interopRequireDefault(require("../../../hooks/useChatAdapterStore"));
 var _useChatContextStore = _interopRequireDefault(require("../../../hooks/useChatContextStore"));
 var _useFacadeChatSDKStore = _interopRequireDefault(require("../../../hooks/useFacadeChatSDKStore"));
+var _customEventHandler = require("../common/customEventHandler");
 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; }
@@ -421,7 +422,7 @@ const LiveChatWidgetStateful = props => {
     _omnichannelChatComponents.BroadcastService.getMessageByEventName(_TelemetryConstants.BroadcastEvent.StartChat).subscribe(msg => {
       var _msg$payload5, _msg$payload6, _msg$payload7, _msg$payload9, _inMemoryState$appSta2, _inMemoryState$appSta3, _inMemoryState$appSta4;
       // If chat is out of operating hours chat widget sets the conversation state to OutOfOffice.
-      if (state.appStates.outsideOperatingHours === true) {
+      if (state.appStates.outsideOperatingHours && state.appStates.conversationState !== _ConversationState.ConversationState.Active) {
         dispatch({
           type: _LiveChatWidgetActionType.LiveChatWidgetActionType.SET_MINIMIZED,
           payload: false
@@ -588,6 +589,9 @@ const LiveChatWidgetStateful = props => {
       }
     });
 
+    // subscribe custom event
+    (0, _customEventHandler.subscribeToSendCustomEvent)(_omnichannelChatComponents.BroadcastService, facadeChatSDK, _customEventHandler.customEventCallback);
+
     // Check for TPC and log in telemetry if blocked
     (0, _defaultClientDataStoreProvider.isCookieAllowed)();
     return () => {

package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/customEventMiddleware.js

@@ -0,0 +1,41 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isValidCustomEvent = exports.default = void 0;
+var _Constants = require("../../../../../common/Constants");
+var _WebChatActionType = require("../../enums/WebChatActionType");
+/******
+ * CustomEventMiddleware
+ *
+ * This middleware is invoked when a custom event is received.
+ * The callback is then invoked to handle the custom event.
+ ******/
+
+const isValidCustomEvent = activity => {
+  var _activity$channelData, _activity$channelData2, _activity$channelData3, _activity$channelData4, _activity$channelData5, _activity$channelData6, _activity$channelData7, _activity$from, _activity$channelData8, _activity$channelData9, _activity$channelData10, _activity$channelData11;
+  return !!(activity !== null && activity !== void 0 && (_activity$channelData = activity.channelData) !== null && _activity$channelData !== void 0 && (_activity$channelData2 = _activity$channelData.metadata) !== null && _activity$channelData2 !== void 0 && _activity$channelData2.customEvent && typeof (activity === null || activity === void 0 ? void 0 : (_activity$channelData3 = activity.channelData) === null || _activity$channelData3 === void 0 ? void 0 : (_activity$channelData4 = _activity$channelData3.metadata) === null || _activity$channelData4 === void 0 ? void 0 : _activity$channelData4.customEvent) === _Constants.Constants.String && (activity === null || activity === void 0 ? void 0 : (_activity$channelData5 = activity.channelData) === null || _activity$channelData5 === void 0 ? void 0 : (_activity$channelData6 = _activity$channelData5.metadata) === null || _activity$channelData6 === void 0 ? void 0 : (_activity$channelData7 = _activity$channelData6.customEvent) === null || _activity$channelData7 === void 0 ? void 0 : _activity$channelData7.toLowerCase()) === _Constants.Constants.true && (activity === null || activity === void 0 ? void 0 : (_activity$from = activity.from) === null || _activity$from === void 0 ? void 0 : _activity$from.role) !== _Constants.Constants.userMessageTag && typeof (activity === null || activity === void 0 ? void 0 : (_activity$channelData8 = activity.channelData) === null || _activity$channelData8 === void 0 ? void 0 : (_activity$channelData9 = _activity$channelData8.metadata) === null || _activity$channelData9 === void 0 ? void 0 : _activity$channelData9.customEventName) === _Constants.Constants.String && activity !== null && activity !== void 0 && (_activity$channelData10 = activity.channelData) !== null && _activity$channelData10 !== void 0 && (_activity$channelData11 = _activity$channelData10.metadata) !== null && _activity$channelData11 !== void 0 && _activity$channelData11.customEventValue);
+};
+exports.isValidCustomEvent = isValidCustomEvent;
+const createCustomEventMiddleware = broadcastservice => () => next => action => {
+  var _action$payload;
+  if ((action === null || action === void 0 ? void 0 : action.type) == _WebChatActionType.WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY && (_action$payload = action.payload) !== null && _action$payload !== void 0 && _action$payload.activity) {
+    const activity = action.payload.activity;
+    if (isValidCustomEvent(activity)) {
+      const customEvent = {
+        eventName: _Constants.Constants.onCustomEvent,
+        payload: {
+          messageId: activity.messageid ?? activity.id,
+          customEventName: activity.channelData.metadata.customEventName,
+          customEventValue: activity.channelData.metadata.customEventValue
+        }
+      };
+      broadcastservice.postMessage(customEvent);
+      return;
+    }
+  }
+  return next(action);
+};
+var _default = createCustomEventMiddleware;
+exports.default = _default;

package/lib/cjs/contexts/common/CustomEventType.js

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

package/lib/esm/common/Constants.js

@@ -124,6 +124,11 @@ _defineProperty(Constants, "InitContextParamsResponse", "initContextParamsRespon
 _defineProperty(Constants, "OCOriginalMessageId", "OriginalMessageId");
 _defineProperty(Constants, "WebchatSequenceIdAttribute", "webchat:sequence-id");
 _defineProperty(Constants, "MessageSequenceIdOverride", "MessageSequenceIdOverride");
+_defineProperty(Constants, "sendCustomEvent", "sendCustomEvent");
+_defineProperty(Constants, "onCustomEvent", "onCustomEvent");
+_defineProperty(Constants, "customEventName", "customEventName");
+_defineProperty(Constants, "customEventValue", "customEventValue");
+_defineProperty(Constants, "Hidden", "Hidden");
 _defineProperty(Constants, "EndConversationDueToOverflow", "endconversationduetooverflow");
 export const Regex = (_class = /*#__PURE__*/_createClass(function Regex() {
   _classCallCheck(this, Regex);

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

@@ -223,6 +223,7 @@ export let TelemetryEvent;
   TelemetryEvent["SystemMessageReceived"] = "SystemMessageReceived";
   TelemetryEvent["RehydrateMessageReceived"] = "RehydrateMessageReceived";
   TelemetryEvent["CustomContextReceived"] = "CustomContextReceived";
+  TelemetryEvent["CustomEventAction"] = "CustomEventAction";
   TelemetryEvent["NetworkDisconnected"] = "NetworkDisconnected";
   TelemetryEvent["NetworkReconnected"] = "NetworkReconnected";
   TelemetryEvent["LinkModePostChatWorkflowStarted"] = "LinkModePostChatWorkflowStarted";

package/lib/esm/common/utils.js

@@ -454,6 +454,23 @@ export function getDeviceType() {
     return "standard";
   }
 }
+
+//Bots expect a payload containing:
+//1. customEventName: this should be string describe the event name
+//2. customEventValue: given the value is from customer with unknown type, it is required to stringify the payload later
+export const isValidCustomEvent = payload => {
+  if (Constants.customEventName in payload && payload.customEventName && typeof payload.customEventName === Constants.String && Constants.customEventValue in payload && payload.customEventValue) return true;
+  return false;
+};
+export const getCustomEventValue = customEventPayload => {
+  let returnVal = "";
+  try {
+    returnVal = typeof customEventPayload.customEventValue === Constants.String ? customEventPayload.customEventValue : JSON.stringify(customEventPayload.customEventValue);
+  } catch (error) {
+    console.error(error);
+  }
+  return returnVal;
+};
 export function isEndConversationDueToOverflowActivity(activity) {
   var _activity$channelData, _activity$channelData2;
   return (activity === null || activity === void 0 ? void 0 : (_activity$channelData = activity.channelData) === null || _activity$channelData === void 0 ? void 0 : _activity$channelData.tags) && Array.isArray(activity === null || activity === void 0 ? void 0 : (_activity$channelData2 = activity.channelData) === null || _activity$channelData2 === void 0 ? void 0 : _activity$channelData2.tags) && activity.channelData.tags.includes(Constants.EndConversationDueToOverflow);

package/lib/esm/components/chatbuttonstateful/ChatButtonStateful.js

@@ -65,7 +65,6 @@ export const ChatButtonStateful = props => {
   };
   const outOfOfficeStyleProps = Object.assign({}, defaultOutOfOfficeChatButtonStyleProps, outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.styleProps);
   const controlProps = {
-    ...(buttonProps === null || buttonProps === void 0 ? void 0 : buttonProps.controlProps),
     id: "oc-lcw-chat-button",
     dir: state.domainStates.globalDir,
     titleText: "Let's Chat!",
@@ -74,7 +73,8 @@ export const ChatButtonStateful = props => {
     unreadMessageCount: state.appStates.unreadMessageCount ? state.appStates.unreadMessageCount > Constants.maximumUnreadMessageCount ? (_props$buttonProps = props.buttonProps) === null || _props$buttonProps === void 0 ? void 0 : (_props$buttonProps$co = _props$buttonProps.controlProps) === null || _props$buttonProps$co === void 0 ? void 0 : _props$buttonProps$co.largeUnreadMessageString : state.appStates.unreadMessageCount.toString() : "0",
     unreadMessageString: (_props$buttonProps2 = props.buttonProps) === null || _props$buttonProps2 === void 0 ? void 0 : (_props$buttonProps2$c = _props$buttonProps2.controlProps) === null || _props$buttonProps2$c === void 0 ? void 0 : _props$buttonProps2$c.unreadMessageString,
     // Regular chat button onClick - this will always take precedence
-    onClick: () => ref.current()
+    onClick: () => ref.current(),
+    ...(buttonProps === null || buttonProps === void 0 ? void 0 : buttonProps.controlProps)
   };
   const outOfOfficeControlProps = {
     // Only take specific properties from outOfOfficeButtonProps, never onClick
@@ -83,7 +83,6 @@ export const ChatButtonStateful = props => {
     titleText: (outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : (_outOfOfficeButtonPro = outOfOfficeButtonProps.controlProps) === null || _outOfOfficeButtonPro === void 0 ? void 0 : _outOfOfficeButtonPro.titleText) || "We're Offline",
     subtitleText: (outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : (_outOfOfficeButtonPro2 = outOfOfficeButtonProps.controlProps) === null || _outOfOfficeButtonPro2 === void 0 ? void 0 : _outOfOfficeButtonPro2.subtitleText) || "No agents available",
     unreadMessageString: (_props$buttonProps3 = props.buttonProps) === null || _props$buttonProps3 === void 0 ? void 0 : (_props$buttonProps3$c = _props$buttonProps3.controlProps) === null || _props$buttonProps3$c === void 0 ? void 0 : _props$buttonProps3$c.unreadMessageString,
-    ...(outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.controlProps),
     // Out-of-office specific onClick - this will ALWAYS take precedence
     onClick: () => {
       if (state.appStates.isMinimized) {
@@ -96,7 +95,8 @@ export const ChatButtonStateful = props => {
         type: LiveChatWidgetActionType.SET_CONVERSATION_STATE,
         payload: ConversationState.OutOfOffice
       });
-    }
+    },
+    ...(outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.controlProps)
   };
   useEffect(() => {
     TelemetryHelper.logLoadingEvent(LogLevel.INFO, {

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

@@ -0,0 +1,45 @@
+import { Constants } from "../../../common/Constants";
+import { TelemetryHelper } from "../../../common/telemetry/TelemetryHelper";
+import { LogLevel, TelemetryEvent } from "../../../common/telemetry/TelemetryConstants";
+import { getCustomEventValue, isValidCustomEvent } from "../../../common/utils";
+export const customEventCallback = facadeChatSDK => event => {
+  if (!(Constants.payload in event)) return;
+  if (isValidCustomEvent(event.payload)) {
+    const customEventPayload = event.payload;
+    try {
+      const customEventValueStr = getCustomEventValue(customEventPayload);
+      const customEventName = customEventPayload.customEventName;
+      const messageMeta = {
+        customEvent: Constants.true,
+        customEventName: customEventName,
+        customEventValue: customEventValueStr
+      };
+      const messagePayload = {
+        content: "",
+        tags: [Constants.Hidden],
+        metadata: messageMeta,
+        timestamp: new Date()
+      };
+      facadeChatSDK.sendMessage(messagePayload);
+      TelemetryHelper.logActionEventToAllTelemetry(LogLevel.DEBUG, {
+        Event: TelemetryEvent.CustomEventAction,
+        Description: "Sent customEvent.",
+        CustomProperties: {
+          customEventName,
+          lengthCustomEventValue: customEventValueStr.length
+        }
+      });
+    } catch (error) {
+      TelemetryHelper.logActionEventToAllTelemetry(LogLevel.ERROR, {
+        Event: TelemetryEvent.CustomEventAction,
+        Description: "Failed to process CustomEvent.",
+        ExceptionDetails: {
+          error
+        }
+      });
+    }
+  }
+};
+export const subscribeToSendCustomEvent = (broadcastService, facadeChatSDK, customEventCallback) => {
+  broadcastService.getMessageByEventName(Constants.sendCustomEvent).subscribe(customEventCallback(facadeChatSDK));
+};

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

@@ -32,9 +32,11 @@ import htmlTextMiddleware from "../../webchatcontainerstateful/webchatcontroller
 import preProcessingMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/preProcessingMiddleware";
 import sanitizationMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/sanitizationMiddleware";
 import { Constants } from "../../../common/Constants";
+import createCustomEventMiddleware from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/customEventMiddleware";
 import { ConversationState } from "../../../contexts/common/ConversationState";
 import { executeReducer } from "../../../contexts/createReducer";
 import { createQueueOverflowMiddleware } from "../../webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/queueOverflowHandlerMiddleware";
+import { BroadcastService } from "@microsoft/omnichannel-chat-components";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endChat) => {
@@ -113,7 +115,7 @@ export const initWebChatComposer = (props, state, dispatch, facadeChatSDK, endCh
     };
     webChatStore = createStore({},
     //initial state
-    preProcessingMiddleware, attachmentProcessingMiddleware, createAttachmentUploadValidatorMiddleware((_state$domainStates$l = state.domainStates.liveChatConfig) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.allowedFileExtensions, (_state$domainStates$l2 = state.domainStates.liveChatConfig) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.maxUploadFileSize, localizedTexts), createQueueOverflowMiddleware(state, dispatch), channelDataMiddleware(addConversationalSurveyTagsCallback), createConversationEndMiddleware(conversationEndCallback, startConversationalSurveyCallback, endConversationalSurveyCallback), createDataMaskingMiddleware((_state$domainStates$l3 = state.domainStates.liveChatConfig) === null || _state$domainStates$l3 === void 0 ? void 0 : _state$domainStates$l3.DataMaskingInfo), createMessageTimeStampMiddleware, createMessageSequenceIdOverrideMiddleware, gifUploadMiddleware, htmlPlayerMiddleware, htmlTextMiddleware(honorsTargetInHTMLLinks), createMaxMessageSizeValidator(localizedTexts), sanitizationMiddleware,
+    preProcessingMiddleware, attachmentProcessingMiddleware, createAttachmentUploadValidatorMiddleware((_state$domainStates$l = state.domainStates.liveChatConfig) === null || _state$domainStates$l === void 0 ? void 0 : _state$domainStates$l.allowedFileExtensions, (_state$domainStates$l2 = state.domainStates.liveChatConfig) === null || _state$domainStates$l2 === void 0 ? void 0 : _state$domainStates$l2.maxUploadFileSize, localizedTexts), createCustomEventMiddleware(BroadcastService), createQueueOverflowMiddleware(state, dispatch), channelDataMiddleware(addConversationalSurveyTagsCallback), createConversationEndMiddleware(conversationEndCallback, startConversationalSurveyCallback, endConversationalSurveyCallback), createDataMaskingMiddleware((_state$domainStates$l3 = state.domainStates.liveChatConfig) === null || _state$domainStates$l3 === void 0 ? void 0 : _state$domainStates$l3.DataMaskingInfo), createMessageTimeStampMiddleware, createMessageSequenceIdOverrideMiddleware, gifUploadMiddleware, htmlPlayerMiddleware, htmlTextMiddleware(honorsTargetInHTMLLinks), createMaxMessageSizeValidator(localizedTexts), sanitizationMiddleware,
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     ...(((_props$webChatContain7 = props.webChatContainerProps) === null || _props$webChatContain7 === void 0 ? void 0 : _props$webChatContain7.storeMiddlewares) ?? []));
     WebChatStoreLoader.store = webChatStore;

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

@@ -53,6 +53,7 @@ import { startProactiveChat } from "../common/startProactiveChat";
 import useChatAdapterStore from "../../../hooks/useChatAdapterStore";
 import useChatContextStore from "../../../hooks/useChatContextStore";
 import useFacadeSDKStore from "../../../hooks/useFacadeChatSDKStore";
+import { customEventCallback, subscribeToSendCustomEvent } from "../common/customEventHandler";
 let uiTimer;
 export const LiveChatWidgetStateful = props => {
   var _props$webChatContain, _props$webChatContain2, _props$webChatContain3, _props$webChatContain4, _props$webChatContain5, _props$webChatContain6, _props$webChatContain7, _props$webChatContain8, _props$webChatContain9, _props$styleProps, _props$webChatContain10, _props$webChatContain11, _props$controlProps, _props$controlProps3, _state$appStates7, _props$webChatContain15, _state$appStates14, _props$webChatContain17, _props$webChatContain18, _props$controlProps12, _props$draggableChatW, _props$draggableChatW2, _props$draggableChatW3, _props$draggableChatW4, _props$draggableChatW5, _livechatProps$webCha, _livechatProps$styleP, _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$contro10, _livechatProps$contro11, _livechatProps$compon9, _livechatProps$contro12, _livechatProps$compon10, _livechatProps$contro13, _livechatProps$compon11, _livechatProps$compon12, _livechatProps$compon13;
@@ -413,7 +414,7 @@ export const LiveChatWidgetStateful = props => {
     BroadcastService.getMessageByEventName(BroadcastEvent.StartChat).subscribe(msg => {
       var _msg$payload5, _msg$payload6, _msg$payload7, _msg$payload9, _inMemoryState$appSta2, _inMemoryState$appSta3, _inMemoryState$appSta4;
       // If chat is out of operating hours chat widget sets the conversation state to OutOfOffice.
-      if (state.appStates.outsideOperatingHours === true) {
+      if (state.appStates.outsideOperatingHours && state.appStates.conversationState !== ConversationState.Active) {
         dispatch({
           type: LiveChatWidgetActionType.SET_MINIMIZED,
           payload: false
@@ -580,6 +581,9 @@ export const LiveChatWidgetStateful = props => {
       }
     });
 
+    // subscribe custom event
+    subscribeToSendCustomEvent(BroadcastService, facadeChatSDK, customEventCallback);
+
     // Check for TPC and log in telemetry if blocked
     isCookieAllowed();
     return () => {

package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/customEventMiddleware.js

@@ -0,0 +1,33 @@
+/******
+ * CustomEventMiddleware
+ *
+ * This middleware is invoked when a custom event is received.
+ * The callback is then invoked to handle the custom event.
+ ******/
+
+import { Constants } from "../../../../../common/Constants";
+import { WebChatActionType } from "../../enums/WebChatActionType";
+export const isValidCustomEvent = activity => {
+  var _activity$channelData, _activity$channelData2, _activity$channelData3, _activity$channelData4, _activity$channelData5, _activity$channelData6, _activity$channelData7, _activity$from, _activity$channelData8, _activity$channelData9, _activity$channelData10, _activity$channelData11;
+  return !!(activity !== null && activity !== void 0 && (_activity$channelData = activity.channelData) !== null && _activity$channelData !== void 0 && (_activity$channelData2 = _activity$channelData.metadata) !== null && _activity$channelData2 !== void 0 && _activity$channelData2.customEvent && typeof (activity === null || activity === void 0 ? void 0 : (_activity$channelData3 = activity.channelData) === null || _activity$channelData3 === void 0 ? void 0 : (_activity$channelData4 = _activity$channelData3.metadata) === null || _activity$channelData4 === void 0 ? void 0 : _activity$channelData4.customEvent) === Constants.String && (activity === null || activity === void 0 ? void 0 : (_activity$channelData5 = activity.channelData) === null || _activity$channelData5 === void 0 ? void 0 : (_activity$channelData6 = _activity$channelData5.metadata) === null || _activity$channelData6 === void 0 ? void 0 : (_activity$channelData7 = _activity$channelData6.customEvent) === null || _activity$channelData7 === void 0 ? void 0 : _activity$channelData7.toLowerCase()) === Constants.true && (activity === null || activity === void 0 ? void 0 : (_activity$from = activity.from) === null || _activity$from === void 0 ? void 0 : _activity$from.role) !== Constants.userMessageTag && typeof (activity === null || activity === void 0 ? void 0 : (_activity$channelData8 = activity.channelData) === null || _activity$channelData8 === void 0 ? void 0 : (_activity$channelData9 = _activity$channelData8.metadata) === null || _activity$channelData9 === void 0 ? void 0 : _activity$channelData9.customEventName) === Constants.String && activity !== null && activity !== void 0 && (_activity$channelData10 = activity.channelData) !== null && _activity$channelData10 !== void 0 && (_activity$channelData11 = _activity$channelData10.metadata) !== null && _activity$channelData11 !== void 0 && _activity$channelData11.customEventValue);
+};
+const createCustomEventMiddleware = broadcastservice => () => next => action => {
+  var _action$payload;
+  if ((action === null || action === void 0 ? void 0 : action.type) == WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY && (_action$payload = action.payload) !== null && _action$payload !== void 0 && _action$payload.activity) {
+    const activity = action.payload.activity;
+    if (isValidCustomEvent(activity)) {
+      const customEvent = {
+        eventName: Constants.onCustomEvent,
+        payload: {
+          messageId: activity.messageid ?? activity.id,
+          customEventName: activity.channelData.metadata.customEventName,
+          customEventValue: activity.channelData.metadata.customEventValue
+        }
+      };
+      broadcastservice.postMessage(customEvent);
+      return;
+    }
+  }
+  return next(action);
+};
+export default createCustomEventMiddleware;

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

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

package/lib/types/common/Constants.d.ts

@@ -96,6 +96,11 @@ export declare class Constants {
     static readonly OCOriginalMessageId = "OriginalMessageId";
     static readonly WebchatSequenceIdAttribute = "webchat:sequence-id";
     static readonly MessageSequenceIdOverride = "MessageSequenceIdOverride";
+    static readonly sendCustomEvent = "sendCustomEvent";
+    static readonly onCustomEvent = "onCustomEvent";
+    static readonly customEventName = "customEventName";
+    static readonly customEventValue = "customEventValue";
+    static readonly Hidden = "Hidden";
     static readonly EndConversationDueToOverflow = "endconversationduetooverflow";
 }
 export declare const Regex: {

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

@@ -211,6 +211,7 @@ export declare enum TelemetryEvent {
     SystemMessageReceived = "SystemMessageReceived",
     RehydrateMessageReceived = "RehydrateMessageReceived",
     CustomContextReceived = "CustomContextReceived",
+    CustomEventAction = "CustomEventAction",
     NetworkDisconnected = "NetworkDisconnected",
     NetworkReconnected = "NetworkReconnected",
     LinkModePostChatWorkflowStarted = "LinkModePostChatWorkflowStarted",

package/lib/types/common/utils.d.ts

@@ -1,5 +1,6 @@
 import { FacadeChatSDK } from "./facades/FacadeChatSDK";
 import { ITimer } from "./interfaces/ITimer";
+import * as CustomEventType from "../contexts/common/CustomEventType";
 export declare const setTabIndices: (elements: HTMLElement[] | null, tabIndexMap: Map<string, number>, shouldBeFocusable: boolean) => void;
 export declare const findParentFocusableElementsWithoutChildContainer: (elementId: string) => HTMLElement[] | null;
 export declare const findAllFocusableElement: (parent: string | HTMLElement) => any[] | null;
@@ -47,6 +48,8 @@ export declare const formatTemplateString: (templateMessage: string, values: any
 export declare const parseLowerCaseString: (property: string | boolean | undefined) => string;
 export declare const setOcUserAgent: (chatSDK: any) => void;
 export declare function getDeviceType(): string;
+export declare const isValidCustomEvent: (payload: object) => boolean;
+export declare const getCustomEventValue: (customEventPayload: CustomEventType.ICustomEvent) => string;
 export declare function isEndConversationDueToOverflowActivity(activity: {
     channelData?: {
         tags?: string[];

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

@@ -0,0 +1,4 @@
+import { FacadeChatSDK } from "../../../common/facades/FacadeChatSDK";
+import { BroadcastService } from "@microsoft/omnichannel-chat-components";
+export declare const customEventCallback: (facadeChatSDK: FacadeChatSDK) => (event: object) => void;
+export declare const subscribeToSendCustomEvent: (broadcastService: typeof BroadcastService, facadeChatSDK: FacadeChatSDK, customEventCallback: (fackageSdK: FacadeChatSDK) => (event: object) => void) => void;

package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/storemiddlewares/customEventMiddleware.d.ts

@@ -0,0 +1,22 @@
+/******
+ * CustomEventMiddleware
+ *
+ * This middleware is invoked when a custom event is received.
+ * The callback is then invoked to handle the custom event.
+ ******/
+import { IWebChatAction } from "../../../interfaces/IWebChatAction";
+import { BroadcastService } from "@microsoft/omnichannel-chat-components";
+export declare const isValidCustomEvent: (activity: {
+    channelData?: {
+        metadata?: {
+            customEvent?: string;
+            customEventName?: string;
+            customEventValue?: unknown;
+        };
+    };
+    from?: {
+        role: string;
+    };
+}) => boolean;
+declare const createCustomEventMiddleware: (broadcastservice: typeof BroadcastService) => () => (next: (action: IWebChatAction) => void) => (action: IWebChatAction) => void;
+export default createCustomEventMiddleware;

package/lib/types/contexts/common/CustomEventType.d.ts

@@ -0,0 +1,6 @@
+export interface ICustomEvent {
+    messageId?: string;
+    customEvent?: string;
+    customEventName: string;
+    customEventValue: unknown;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/omnichannel-chat-widget",
-  "version": "1.8.2-main.d82a79b",
+  "version": "1.8.2-main.f638bed",
   "description": "Microsoft Omnichannel Chat Widget",
   "main": "lib/cjs/index.js",
   "types": "lib/types/index.d.ts",