Add protocol-agnostic external chat relay infrastructure for real-time 3rd party communication (#383)

Author: MikeAlhayek

src/Abstractions/CrestApps.OrchardCore.AI.Abstractions/ChatNotificationActionNames.cs

@@ -0,0 +1,10 @@
+namespace CrestApps.OrchardCore.AI;
+
+/// <summary>
+/// Well-known notification action names used by built-in action handlers.
+/// </summary>
+public static class ChatNotificationActionNames
+{
+    public const string CancelTransfer = "cancel-transfer";
+    public const string EndSession = "end-session";
+}

src/Abstractions/CrestApps.OrchardCore.AI.Abstractions/ChatNotificationSenderExtensions.cs

@@ -0,0 +1,16 @@
+namespace CrestApps.OrchardCore.AI;
+
+/// <summary>
+/// Well-known notification types used by built-in chat notifications. Each type serves as
+/// both the unique identifier and the CSS styling class for the notification.
+/// </summary>
+public static class ChatNotificationTypes
+{
+    public const string Typing = "typing";
+    public const string Transfer = "transfer";
+    public const string AgentConnected = "agent-connected";
+    public const string AgentReconnecting = "agent-reconnecting";
+    public const string ConnectionLost = "connection-lost";
+    public const string ConversationEnded = "conversation-ended";
+    public const string SessionEnded = "session-ended";
+}

src/Abstractions/CrestApps.OrchardCore.AI.Abstractions/ChatNotificationTypes.cs

@@ -3,7 +3,7 @@
 namespace CrestApps.OrchardCore.AI;
 
 /// <summary>
-/// Handles user-initiated actions on chat notification bubbles.
+/// Handles user-initiated actions on chat system messages.
 /// When a user clicks an action button on a notification (e.g., "Cancel Transfer"),
 /// the hub resolves a keyed service whose key matches the action name.
 /// Register implementations using <c>services.AddKeyedScoped&lt;IChatNotificationActionHandler, YourHandler&gt;("your-action-name")</c>.

src/Abstractions/CrestApps.OrchardCore.AI.Abstractions/IChatNotificationActionHandler.cs

@@ -4,7 +4,7 @@ namespace CrestApps.OrchardCore.AI;
 
 /// <summary>
 /// Sends transient UI notifications to chat clients via SignalR.
-/// Notifications appear as visual bubbles in the chat interface and are separate
+/// Notifications appear as system messages in the chat interface and are separate
 /// from chat history. Use this service from webhooks, background tasks, or response
 /// handlers to provide real-time feedback to users.
 /// </summary>
@@ -17,7 +17,7 @@ public interface IChatNotificationSender
 {
     /// <summary>
     /// Sends a notification to all clients connected to the specified session.
-    /// If a notification with the same <see cref="ChatNotification.Id"/> already exists
+    /// If a notification with the same <see cref="ChatNotification.Type"/> already exists
     /// on the client, it will be replaced.
     /// </summary>
     /// <param name="sessionId">The session or interaction identifier.</param>
@@ -27,7 +27,7 @@ public interface IChatNotificationSender
 
     /// <summary>
     /// Updates an existing notification on all connected clients.
-    /// Only replaces the notification if one with a matching <see cref="ChatNotification.Id"/> exists.
+    /// Only replaces the notification if one with a matching <see cref="ChatNotification.Type"/> exists.
     /// </summary>
     /// <param name="sessionId">The session or interaction identifier.</param>
     /// <param name="chatType">The type of chat context.</param>
@@ -39,6 +39,6 @@ public interface IChatNotificationSender
     /// </summary>
     /// <param name="sessionId">The session or interaction identifier.</param>
     /// <param name="chatType">The type of chat context.</param>
-    /// <param name="notificationId">The identifier of the notification to remove.</param>
-    Task RemoveAsync(string sessionId, ChatContextType chatType, string notificationId);
+    /// <param name="notificationType">The type of the notification to remove.</param>
+    Task RemoveAsync(string sessionId, ChatContextType chatType, string notificationType);
 }

src/Abstractions/CrestApps.OrchardCore.AI.Abstractions/IChatNotificationSender.cs

@@ -11,7 +11,7 @@ namespace CrestApps.OrchardCore.AI;
 /// </summary>
 /// <remarks>
 /// <para>
-/// Each hub that supports notification bubbles should provide its own implementation
+/// Each hub that supports notification system messages should provide its own implementation
 /// and register it as a keyed service:
 /// </para>
 /// <code>
@@ -22,7 +22,7 @@ public interface IChatNotificationTransport
 {
     /// <summary>
     /// Sends a notification to all clients in the session group. If a notification
-    /// with the same <see cref="ChatNotification.Id"/> already exists on the client,
+    /// with the same <see cref="ChatNotification.Type"/> already exists on the client,
     /// it is replaced.
     /// </summary>
     /// <param name="sessionId">The session or interaction identifier.</param>
@@ -31,7 +31,7 @@ public interface IChatNotificationTransport
 
     /// <summary>
     /// Updates an existing notification on all connected clients in the session group.
-    /// Only replaces the notification if one with a matching <see cref="ChatNotification.Id"/> exists.
+    /// Only replaces the notification if one with a matching <see cref="ChatNotification.Type"/> exists.
     /// </summary>
     /// <param name="sessionId">The session or interaction identifier.</param>
     /// <param name="notification">The updated notification.</param>
@@ -41,6 +41,6 @@ public interface IChatNotificationTransport
     /// Removes a notification from all connected clients in the session group.
     /// </summary>
     /// <param name="sessionId">The session or interaction identifier.</param>
-    /// <param name="notificationId">The identifier of the notification to remove.</param>
-    Task RemoveNotificationAsync(string sessionId, string notificationId);
+    /// <param name="notificationType">The type of the notification to remove.</param>
+    Task RemoveNotificationAsync(string sessionId, string notificationType);
 }