@microsoft/omnichannel-chat-widget 1.8.3 → 1.8.4-main.4478bbf

package/lib/esm/common/utils/SecureEventBus.js

@@ -0,0 +1,328 @@
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+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); }
+import { TelemetryHelper } from "../telemetry/TelemetryHelper";
+import { LogLevel, TelemetryEvent } from "../telemetry/TelemetryConstants";
+
+/**
+ * SecureEventBus - A private, authenticated event system for internal chat widget communication
+ * 
+ * This replaces the vulnerable global window event system to prevent external scripts
+ * from injecting malicious events into the chat widget.
+ * 
+ * @example
+ * ```typescript
+ * const eventBus = SecureEventBus.getInstance();
+ * const token = eventBus.getAuthToken();
+ * 
+ * // Subscribe to an event
+ * const unsubscribe = eventBus.subscribe('userMessage', (payload) => {
+ *   console.log('Message received:', payload);
+ * });
+ * 
+ * // Dispatch an event
+ * eventBus.dispatch('userMessage', { text: 'Hello' }, token);
+ * 
+ * // Unsubscribe
+ * unsubscribe();
+ * ```
+ */
+
+/**
+ * Interface representing an event listener with callback and unique identifier
+ */
+/**
+ * SecureEventBus class implementing the singleton pattern for secure event communication.
+ * Provides authentication-based event dispatching to prevent unauthorized external access.
+ */
+let SecureEventBus = /*#__PURE__*/function () {
+  /**
+   * Private constructor to enforce singleton pattern.
+   * Generates a unique authentication token for this session.
+   */
+  function SecureEventBus() {
+    _classCallCheck(this, SecureEventBus);
+    _defineProperty(this, "listeners", new Map());
+    _defineProperty(this, "authToken", void 0);
+    _defineProperty(this, "eventCounter", 0);
+    // Generate a secure, unique token for this session
+    this.authToken = this.generateAuthToken();
+  }
+
+  /**
+   * Get the singleton instance of SecureEventBus.
+   * Creates a new instance if one doesn't exist.
+   * 
+   * @returns The singleton instance of SecureEventBus
+   * 
+   * @example
+   * ```typescript
+   * const eventBus = SecureEventBus.getInstance();
+   * ```
+   */
+  _createClass(SecureEventBus, [{
+    key: "generateAuthToken",
+    value:
+    /**
+     * Generate a cryptographically secure authentication token.
+     * Uses crypto.getRandomValues when available, falls back to Math.random.
+     * 
+     * @private
+     * @returns A 64-character hexadecimal string representing the authentication token
+     */
+    function generateAuthToken() {
+      const array = new Uint8Array(32);
+      if (typeof crypto !== "undefined" && crypto.getRandomValues) {
+        crypto.getRandomValues(array);
+      } else {
+        // Fallback for environments without crypto.getRandomValues
+        for (let i = 0; i < array.length; i++) {
+          array[i] = Math.floor(Math.random() * 256);
+        }
+      }
+      return Array.from(array, byte => byte.toString(16).padStart(2, "0")).join("");
+    }
+
+    /**
+     * Get the authentication token for this SecureEventBus instance.
+     * This token is required for dispatching events and should only be used internally.
+     * 
+     * @returns The authentication token string
+     * 
+     * @example
+     * ```typescript
+     * const eventBus = SecureEventBus.getInstance();
+     * const token = eventBus.getAuthToken();
+     * eventBus.dispatch('myEvent', { data: 'value' }, token);
+     * ```
+     */
+  }, {
+    key: "getAuthToken",
+    value: function getAuthToken() {
+      return this.authToken;
+    }
+
+    /**
+     * Dispatch an event with authentication to all registered listeners.
+     * Verifies the authentication token before dispatching to prevent unauthorized access.
+     * 
+     * @param eventName - The name of the event to dispatch
+     * @param payload - The data to send with the event (optional)
+     * @param token - Authentication token (must match the internal token)
+     * @returns true if event was successfully dispatched, false if unauthorized or error occurred
+     * 
+     * @example
+     * ```typescript
+     * const eventBus = SecureEventBus.getInstance();
+     * const token = eventBus.getAuthToken();
+     * 
+     * // Dispatch with payload
+     * const success = eventBus.dispatch('userAction', { action: 'click', target: 'button' }, token);
+     * 
+     * // Dispatch without payload
+     * eventBus.dispatch('windowClosed', undefined, token);
+     * ```
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  }, {
+    key: "dispatch",
+    value: function dispatch(eventName, payload, token) {
+      // Verify authentication token
+      if (token !== this.authToken) {
+        TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+          Event: TelemetryEvent.SecureEventBusUnauthorizedDispatch,
+          Description: `Unauthorized event dispatch attempt blocked: ${eventName}`,
+          ExceptionDetails: {
+            eventName,
+            providedToken: token ? "provided" : "missing",
+            expectedToken: "secured"
+          }
+        });
+        return false;
+      }
+      const listeners = this.listeners.get(eventName);
+      if (!listeners || listeners.length === 0) {
+        return true; // No listeners, but not an error
+      }
+
+      // Dispatch to all registered listeners
+      try {
+        listeners.forEach(listener => {
+          try {
+            listener.callback(payload);
+          } catch (error) {
+            TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+              Event: TelemetryEvent.SecureEventBusListenerError,
+              Description: `Error in event listener for event: ${eventName}`,
+              ExceptionDetails: error
+            });
+          }
+        });
+        return true;
+      } catch (error) {
+        TelemetryHelper.logActionEvent(LogLevel.ERROR, {
+          Event: TelemetryEvent.SecureEventBusDispatchError,
+          Description: `Error dispatching event: ${eventName}`,
+          ExceptionDetails: error
+        });
+        return false;
+      }
+    }
+
+    /**
+     * Subscribe to an event with a callback function.
+     * The callback will be executed whenever the specified event is dispatched.
+     * 
+     * @param eventName - The name of the event to listen for
+     * @param callback - The function to execute when the event is fired
+     * @returns A function that can be called to unsubscribe from the event
+     * 
+     * @example
+     * ```typescript
+     * const eventBus = SecureEventBus.getInstance();
+     * 
+     * // Subscribe to an event
+     * const unsubscribe = eventBus.subscribe('chatMessage', (message) => {
+     *   console.log('New message:', message.text);
+     *   console.log('From user:', message.userId);
+     * });
+     * 
+     * // Later, unsubscribe
+     * unsubscribe();
+     * ```
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  }, {
+    key: "subscribe",
+    value: function subscribe(eventName, callback) {
+      const listenerId = `listener_${++this.eventCounter}`;
+      if (!this.listeners.has(eventName)) {
+        this.listeners.set(eventName, []);
+      }
+      const listeners = this.listeners.get(eventName);
+      if (!listeners) {
+        throw new Error(`Listeners for event "${eventName}" not found.`);
+      }
+      const listener = {
+        callback,
+        id: listenerId
+      };
+      listeners.push(listener);
+
+      // Return unsubscribe function
+      return () => {
+        const currentListeners = this.listeners.get(eventName);
+        if (currentListeners) {
+          const index = currentListeners.findIndex(l => l.id === listenerId);
+          if (index !== -1) {
+            currentListeners.splice(index, 1);
+          }
+
+          // Clean up empty listener arrays
+          if (currentListeners.length === 0) {
+            this.listeners.delete(eventName);
+          }
+        }
+      };
+    }
+
+    /**
+     * Remove all listeners for a specific event.
+     * This completely removes the event from the internal listeners map.
+     * 
+     * @param eventName - The name of the event to remove all listeners for
+     * 
+     * @example
+     * ```typescript
+     * const eventBus = SecureEventBus.getInstance();
+     * 
+     * // Remove all listeners for 'chatClosed' event
+     * eventBus.removeAllListeners('chatClosed');
+     * ```
+     */
+  }, {
+    key: "removeAllListeners",
+    value: function removeAllListeners(eventName) {
+      this.listeners.delete(eventName);
+    }
+
+    /**
+     * Clear all listeners for all events.
+     * This resets the entire event bus to its initial state.
+     * Useful for cleanup during application shutdown or testing.
+     * 
+     * @example
+     * ```typescript
+     * const eventBus = SecureEventBus.getInstance();
+     * 
+     * // Clear all event listeners
+     * eventBus.clear();
+     * ```
+     */
+  }, {
+    key: "clear",
+    value: function clear() {
+      this.listeners.clear();
+    }
+
+    /**
+     * Get the number of listeners for a specific event.
+     * Useful for debugging and monitoring purposes.
+     * 
+     * @param eventName - The name of the event to count listeners for
+     * @returns The number of listeners registered for the event
+     * 
+     * @example
+     * ```typescript
+     * const eventBus = SecureEventBus.getInstance();
+     * 
+     * // Check how many listeners are registered for 'userAction'
+     * const count = eventBus.getListenerCount('userAction');
+     * console.log(`${count} listeners registered for userAction`);
+     * ```
+     */
+  }, {
+    key: "getListenerCount",
+    value: function getListenerCount(eventName) {
+      var _this$listeners$get;
+      return ((_this$listeners$get = this.listeners.get(eventName)) === null || _this$listeners$get === void 0 ? void 0 : _this$listeners$get.length) || 0;
+    }
+
+    /**
+     * Get all registered event names.
+     * Returns an array of event names that currently have listeners.
+     * Useful for debugging and monitoring purposes.
+     * 
+     * @returns An array of event names that have registered listeners
+     * 
+     * @example
+     * ```typescript
+     * const eventBus = SecureEventBus.getInstance();
+     * 
+     * // Get all registered events
+     * const events = eventBus.getRegisteredEvents();
+     * console.log('Active events:', events);
+     * // Output: ['userAction', 'chatMessage', 'windowResize']
+     * ```
+     */
+  }, {
+    key: "getRegisteredEvents",
+    value: function getRegisteredEvents() {
+      return Array.from(this.listeners.keys());
+    }
+  }], [{
+    key: "getInstance",
+    value: function getInstance() {
+      if (!SecureEventBus.instance) {
+        SecureEventBus.instance = new SecureEventBus();
+      }
+      return SecureEventBus.instance;
+    }
+  }]);
+  return SecureEventBus;
+}();
+_defineProperty(SecureEventBus, "instance", null);
+export default SecureEventBus;

package/lib/esm/common/utils/dispatchCustomEvent.js

@@ -0,0 +1,18 @@
+import SecureEventBus from "./SecureEventBus";
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const dispatchCustomEvent = (name, payload) => {
+  try {
+    const eventBus = SecureEventBus.getInstance();
+    const authToken = eventBus.getAuthToken();
+
+    // Dispatch through the secure event bus instead of global window
+    const success = eventBus.dispatch(name, payload, authToken);
+    if (!success) {
+      console.error("Failed to dispatch secure event:", name);
+    }
+  } catch (error) {
+    console.error("Error dispatching secure custom event:", name, payload, error);
+  }
+};
+export default dispatchCustomEvent;

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

@@ -1,4 +1,4 @@
-import { LogLevel, TelemetryEvent } from "../../common/telemetry/TelemetryConstants";
+import { ConversationStage, LogLevel, TelemetryEvent } from "../../common/telemetry/TelemetryConstants";
 import React, { useEffect, useRef, useState } from "react";
 import { createTimer, setFocusOnElement } from "../../common/utils";
 import { ChatButton } from "@microsoft/omnichannel-chat-components";
@@ -17,7 +17,10 @@ export const ChatButtonStateful = props => {
     uiTimer = createTimer();
     TelemetryHelper.logLoadingEventToAllTelemetry(LogLevel.INFO, {
       Event: TelemetryEvent.UXLCWChatButtonLoadingStart,
-      Description: "Chat button loading started"
+      Description: "Chat button loading started",
+      CustomProperties: {
+        ConversationStage: ConversationStage.Initialization
+      }
     });
   }, []);
 
@@ -40,7 +43,10 @@ export const ChatButtonStateful = props => {
   ref.current = async () => {
     TelemetryHelper.logActionEventToAllTelemetry(LogLevel.INFO, {
       Event: TelemetryEvent.LCWChatButtonClicked,
-      Description: "Chat button click action started"
+      Description: "Chat button click action started",
+      CustomProperties: {
+        ConversationStage: ConversationStage.Initialization
+      }
     });
     if (state.appStates.isMinimized) {
       dispatch({
@@ -60,7 +66,10 @@ export const ChatButtonStateful = props => {
     }
     TelemetryHelper.logActionEventToAllTelemetry(LogLevel.INFO, {
       Event: TelemetryEvent.LCWChatButtonActionCompleted,
-      Description: "Chat button action completed"
+      Description: "Chat button action completed",
+      CustomProperties: {
+        ConversationStage: ConversationStage.Initialization
+      }
     });
   };
   const outOfOfficeStyleProps = Object.assign({}, defaultOutOfOfficeChatButtonStyleProps, outOfOfficeButtonProps === null || outOfOfficeButtonProps === void 0 ? void 0 : outOfOfficeButtonProps.styleProps);
@@ -114,7 +123,10 @@ export const ChatButtonStateful = props => {
     TelemetryHelper.logLoadingEventToAllTelemetry(LogLevel.INFO, {
       Event: TelemetryEvent.UXLCWChatButtonLoadingCompleted,
       Description: "Chat button loading completed",
-      ElapsedTimeInMilliseconds: uiTimer.milliSecondsElapsed
+      ElapsedTimeInMilliseconds: uiTimer.milliSecondsElapsed,
+      CustomProperties: {
+        ConversationStage: ConversationStage.Initialization
+      }
     });
   }, []);
   useEffect(() => {

package/lib/esm/components/headerstateful/HeaderStateful.js

@@ -1,4 +1,4 @@
-import { LogLevel, TelemetryEvent } from "../../common/telemetry/TelemetryConstants";
+import { ConversationStage, LogLevel, TelemetryEvent } from "../../common/telemetry/TelemetryConstants";
 import React, { useEffect, useRef, useState } from "react";
 import { ConfirmationState } from "../../common/Constants";
 import { ConversationState } from "../../contexts/common/ConversationState";
@@ -61,7 +61,10 @@ export const HeaderStateful = props => {
       var _props$headerProps, _props$headerProps$co, _props$headerProps$co2;
       TelemetryHelper.logActionEventToAllTelemetry(LogLevel.INFO, {
         Event: TelemetryEvent.HeaderCloseButtonClicked,
-        Description: "Header Close action started."
+        Description: "Header Close action started.",
+        CustomProperties: {
+          ConversationStage: ConversationStage.ConversationEnd
+        }
       });
       if (localConfirmationPaneState.current !== ConfirmationState.Ok) {
         dispatch({
@@ -76,7 +79,10 @@ export const HeaderStateful = props => {
       }
       TelemetryHelper.logActionEventToAllTelemetry(LogLevel.INFO, {
         Event: TelemetryEvent.CloseChatActionCompleted,
-        Description: "Header Close action completed."
+        Description: "Header Close action completed.",
+        CustomProperties: {
+          ConversationStage: ConversationStage.ConversationEnd
+        }
       });
       const closeButtonId = ((_props$headerProps = props.headerProps) === null || _props$headerProps === void 0 ? void 0 : (_props$headerProps$co = _props$headerProps.controlProps) === null || _props$headerProps$co === void 0 ? void 0 : (_props$headerProps$co2 = _props$headerProps$co.closeButtonProps) === null || _props$headerProps$co2 === void 0 ? void 0 : _props$headerProps$co2.id) ?? `${controlProps.id}-close-button`;
       if (closeButtonId) {

package/lib/esm/components/livechatwidget/common/ActivitySubscriber/AddActivitySubscriber.js

@@ -0,0 +1,120 @@
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+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); }
+import { BroadcastEvent } from "../../../../common/telemetry/TelemetryConstants";
+import { BroadcastService } from "@microsoft/omnichannel-chat-components";
+import ChatWidgetEvents from "../ChatWidgetEvents";
+import SecureEventBus from "../../../../common/utils/SecureEventBus";
+
+/**
+ * The `AddActivitySubscriber` class is responsible for subscribing to the `ADD_ACTIVITY` event
+ * from the `ChatWidgetEvents` and notifying an observer when a new activity is added.
+ * 
+ * This class implements the `IActivitySubscriber` interface and acts as a bridge between
+ * the event system and the observer pattern.
+ */
+export let AddActivitySubscriber = /*#__PURE__*/function () {
+  /**
+   * The observer that will be notified when a new activity is added.
+   * This is expected to be an object with a `next` method, such as an RxJS `Observer`.
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+  /**
+   * Set to track processed activity IDs to prevent duplicate processing.
+   */
+
+  /**
+   * Unsubscribe function for the secure event listener
+   */
+
+  /**
+   * Subscription for PersistentConversationReset event
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+  /**
+   * Constructor initializes the `AddActivitySubscriber` and sets up a secure event listener
+   * for the `ChatWidgetEvents.ADD_ACTIVITY` event. When the event is triggered, it checks
+   * if the event payload contains an `activity` and notifies the observer.
+   */
+  function AddActivitySubscriber() {
+    _classCallCheck(this, AddActivitySubscriber);
+    _defineProperty(this, "observer", void 0);
+    _defineProperty(this, "processedActivityIds", new Set());
+    _defineProperty(this, "unsubscribeFromSecureEvent", null);
+    _defineProperty(this, "resetEventListener", void 0);
+    const eventBus = SecureEventBus.getInstance();
+
+    // Subscribe to the secure event bus instead of global window events
+    this.unsubscribeFromSecureEvent = eventBus.subscribe(ChatWidgetEvents.ADD_ACTIVITY, payload => {
+      if (payload !== null && payload !== void 0 && payload.activity) {
+        var _this$observer;
+        const activity = payload.activity;
+        const activityId = activity.id;
+        if (activity.identifier) {
+          if (this.processedActivityIds.has(activity === null || activity === void 0 ? void 0 : activity.identifier)) {
+            return; // Skip processing if already handled
+          }
+          // Add the activity ID to the processed set
+          this.processedActivityIds.add(activity === null || activity === void 0 ? void 0 : activity.identifier);
+        }
+
+        // Check if activity has an ID and if it has already been processed
+        if (activityId) {
+          if (this.processedActivityIds.has(activityId)) {
+            return; // Skip processing if already handled
+          }
+
+          // Add the activity ID to the processed set
+          this.processedActivityIds.add(activityId);
+        }
+
+        // Notify the observer with the new activity
+        (_this$observer = this.observer) === null || _this$observer === void 0 ? void 0 : _this$observer.next(activity);
+      }
+    });
+
+    // Subscribe to reset events for cleanup
+    this.resetEventListener = BroadcastService.getMessageByEventName(BroadcastEvent.PersistentConversationReset).subscribe(() => {
+      this.reset();
+      // Clean up the secure event listener when conversation resets
+      if (this.unsubscribeFromSecureEvent) {
+        this.unsubscribeFromSecureEvent();
+        this.unsubscribeFromSecureEvent = null;
+      }
+      // Unsubscribe from the reset event to prevent accumulation
+      if (this.resetEventListener) {
+        this.resetEventListener.unsubscribe();
+      }
+    });
+  }
+
+  /**
+   * The `next` method is a placeholder for processing the activity.
+   * This method can be overridden or extended as needed.
+   * 
+   * @param activity - The activity object to process.
+   * @returns The activity object (asynchronously).
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  _createClass(AddActivitySubscriber, [{
+    key: "next",
+    value: async function next(activity) {
+      return activity;
+    }
+
+    /**
+     * Reset the processed activity IDs when a conversation resets
+     */
+  }, {
+    key: "reset",
+    value: function reset() {
+      this.processedActivityIds.clear();
+    }
+  }]);
+  return AddActivitySubscriber;
+}();

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

@@ -0,0 +1,8 @@
+var ChatWidgetEvents;
+(function (ChatWidgetEvents) {
+  ChatWidgetEvents["ADD_ACTIVITY"] = "CHAT_WIDGET/ADD_ACTIVITY";
+  ChatWidgetEvents["FETCH_PERSISTENT_CHAT_HISTORY"] = "CHAT_WIDGET/FETCH_PERSISTENT_CHAT_HISTORY";
+  ChatWidgetEvents["NO_MORE_HISTORY_AVAILABLE"] = "CHAT_WIDGET/NO_MORE_HISTORY_AVAILABLE";
+  ChatWidgetEvents["HIDE_LOADING_BANNER"] = "CHAT_WIDGET/HIDE_LOADING_BANNER";
+})(ChatWidgetEvents || (ChatWidgetEvents = {}));
+export default ChatWidgetEvents;