RichMessageBase and Welcome message.

src/Infrastructure/BotSharp.Abstraction/Conversations/ConversationHookBase.cs

@@ -81,4 +81,9 @@ public virtual Task OnConversationInitialized(Conversation conversation)
     {
         return Task.CompletedTask;
     }
+
+    public virtual Task OnUserAgentConnectedInitially(Conversation conversation)
+    {
+        return Task.CompletedTask;
+    }
 }

src/Infrastructure/BotSharp.Abstraction/Conversations/IConversationHook.cs

@@ -10,6 +10,14 @@ public interface IConversationHook
     Conversation Conversation { get; }
     IConversationHook SetConversation(Conversation conversation);
 
+    /// <summary>
+    /// Triggered when user connects with agent first time.
+    /// This hook is the good timing to show welcome infomation.
+    /// </summary>
+    /// <param name="conversation"></param>
+    /// <returns></returns>
+    Task OnUserAgentConnectedInitially(Conversation conversation);
+
     /// <summary>
     /// Triggered once for every new conversation.
     /// </summary>

src/Infrastructure/BotSharp.Abstraction/Conversations/IConversationService.cs

@@ -5,6 +5,7 @@ public interface IConversationService
     IConversationStateService States { get; }
     string ConversationId { get; }
     Task<Conversation> NewConversation(Conversation conversation);
+    Task MarkConnectionReady(string conversationId);
     void SetConversationId(string conversationId, List<string> states);
     Task<Conversation> GetConversation(string id);
     Task<List<Conversation>> GetConversations();

src/Infrastructure/BotSharp.Abstraction/Messaging/IRichMessage.cs

@@ -2,5 +2,6 @@ namespace BotSharp.Abstraction.Messaging;
 
 public interface IRichMessage
 {
+    string Type { get; }
     string Text { get; set; }
 }

src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/QuickReplyMessage.cs

@@ -1,8 +1,8 @@
 namespace BotSharp.Abstraction.Messaging.Models.RichContent
 {
-    public class QuickReplyMessage : IRichMessage
+    public class QuickReplyMessage : RichMessageBase, IRichMessage
     {
-        public string Text { get; set; } = string.Empty;
+        public override string Type => "quick reply";
 
         [JsonPropertyName("quick_replies")]
         public List<QuickReplyElement> QuickReplies { get; set; } = new List<QuickReplyElement>();

src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/ButtonTemplateMessage.cs

@@ -3,12 +3,12 @@ namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template
     /// <summary>
     /// https://developers.facebook.com/docs/messenger-platform/send-messages/buttons
     /// </summary>
-    public class ButtonTemplateMessage : IRichMessage
+    public class ButtonTemplateMessage : RichMessageBase, IRichMessage, ITemplateMessage
     {
-        public string Text { get; set; } = string.Empty;
+        public override string Type => "template";
 
         [JsonPropertyName("template_type")]
-        public string TemplateType => "button"; 
+        public override string TemplateType => "button"; 
         public List<ButtonElement> Buttons { get; set; } = new List<ButtonElement>();
     }
 

src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/CouponTemplateMessage.cs

@@ -4,16 +4,18 @@ namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template;
 /// Coupon Template
 /// https://developers.facebook.com/docs/messenger-platform/send-messages/template/coupon
 /// </summary>
-public class CouponTemplateMessage : IRichMessage, ITemplateMessage
+public class CouponTemplateMessage : RichMessageBase, IRichMessage, ITemplateMessage
 {
+    public override string Type => "template";
+
+    [JsonPropertyName("template_type")]
+    public override string TemplateType => "coupon";
+
     [JsonIgnore]
-    public string Text { get; set; }
+    public override string Text { get; set; }
     public string Title { get; set; }
     public string Subtitle { get; set; }
 
-    [JsonPropertyName("template_type")]
-    public string TemplateType => "coupon";
-
     [JsonPropertyName("coupon_code")]
     public string CouponCode { get; set; }
 

src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/MultiSelectTemplateMessage.cs

@@ -1,8 +1,8 @@
 namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template
 {
-    public class MultiSelectTemplateMessage : IRichMessage
+    public class MultiSelectTemplateMessage : RichMessageBase, IRichMessage
     {
-        public string Text { get; set; } = string.Empty;
+        public override string Type => "template";
 
         [JsonPropertyName("template_type")]
         public string TemplateType => "multi-select";

src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/ProductTemplateMessage.cs

@@ -2,6 +2,7 @@ namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template;
 
 public class ProductTemplateMessage : TemplateMessageBase<ProductElement>, IRichMessage
 {
+    [JsonPropertyName("template_type")]
     public override string TemplateType => "product";
 }
 

src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/TemplateMessageBase.cs

@@ -1,12 +1,15 @@
 namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template
 {
-    public class TemplateMessageBase<T>
+    public class TemplateMessageBase<T> : RichMessageBase
     {
         [JsonIgnore]
         public string Text { get; set; }
 
+        public override string Type => "template";
+
         [JsonPropertyName("template_type")]
         public virtual string TemplateType => string.Empty;
+
         public T[] Elements { get; set; }
     }
 }

src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/TextMessage.cs

@@ -1,8 +1,8 @@
 namespace BotSharp.Abstraction.Messaging.Models.RichContent;
 
-public class TextMessage : IRichMessage
+public class TextMessage : RichMessageBase, IRichMessage
 {
-    public string Text { get; set; } = string.Empty;
+    public string Type => "text";
 
     public TextMessage(string text)
     {

src/Infrastructure/BotSharp.Abstraction/Messaging/RichMessageBase.cs

@@ -0,0 +1,11 @@
+namespace BotSharp.Abstraction.Messaging;
+
+public class RichMessageBase
+{
+    public virtual string Type { get; }
+
+    public virtual string Text { get; set; }
+
+    [JsonPropertyName("template_type")]
+    public virtual string TemplateType { get; }
+}

src/Infrastructure/BotSharp.Core/Conversations/Services/ConversationService.cs

@@ -84,6 +84,9 @@ public async Task<Conversation> NewConversation(Conversation sess)
         var hooks = _services.GetServices<IConversationHook>().ToList();
         foreach (var hook in hooks)
         {
+            // If user connect agent first time
+            await hook.OnUserAgentConnectedInitially(sess);
+
             await hook.OnConversationInitialized(record);
         }
 
@@ -115,4 +118,15 @@ public void SetConversationId(string conversationId, List<string> states)
         _state.Load(_conversationId);
         states.ForEach(x => _state.SetState(x.Split('=')[0], x.Split('=')[1]));
     }
+
+    public async Task MarkConnectionReady(string conversationId)
+    {
+        var hooks = _services.GetServices<IConversationHook>();
+        var conv = await GetConversation(conversationId);
+        foreach (var hook in hooks)
+        {
+            // Need to check if user connected with agent is the first time.
+            await hook.OnUserAgentConnectedInitially(conv);
+        }
+    }
 }

src/Infrastructure/BotSharp.OpenAPI/Controllers/ConversationController.cs

@@ -41,6 +41,13 @@ public async Task<ConversationViewModel> NewConversation([FromRoute] string agen
         return ConversationViewModel.FromSession(conv);
     }
 
+    [HttpPatch("/conversation/{conversationId}/ready")]
+    public async Task ReadyToInteractive([FromRoute] string conversationId)
+    {
+        var service = _services.GetRequiredService<IConversationService>();
+        await service.MarkConnectionReady(conversationId);
+    }
+
     [HttpGet("/conversations/{agentId}")]
     public async Task<IEnumerable<ConversationViewModel>> GetConversations()
     {

src/Infrastructure/BotSharp.OpenAPI/ViewModels/Agents/AgentViewModel.cs

@@ -1,6 +1,7 @@
 using BotSharp.Abstraction.Agents.Models;
 using BotSharp.Abstraction.Functions.Models;
 using BotSharp.Abstraction.Routing.Models;
+using System.Text.Json.Serialization;
 
 namespace BotSharp.OpenAPI.ViewModels.Agents;
 
@@ -15,12 +16,20 @@ public class AgentViewModel
     public List<AgentResponse> Responses { get; set; }
     public List<string> Samples { get; set; }
     public bool IsPublic { get; set; }
+
+    [JsonPropertyName("allow_routing")]
     public bool AllowRouting { get; set; }
     public bool Disabled { get; set; }
     public List<string> Profiles { get; set; }
+
+    [JsonPropertyName("routing_rules")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public List<RoutingRule> RoutingRules { get; set; }
 
+    [JsonPropertyName("created_datetime")]
     public DateTime CreatedDateTime { get; set; }
+
+    [JsonPropertyName("updated_datetime")]
     public DateTime UpdatedDateTime { get; set; }
 
     public static AgentViewModel FromAgent(Agent agent)

src/Plugins/BotSharp.Plugin.AzureOpenAI/BotSharp.Plugin.AzureOpenAI.csproj

@@ -1,12 +1,12 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
     <Nullable>enable</Nullable>
     <LangVersion>$(LangVersion)</LangVersion>
     <VersionPrefix>$(BotSharpVersion)</VersionPrefix>
     <GeneratePackageOnBuild>$(GeneratePackageOnBuild)</GeneratePackageOnBuild>
-    <GenerateDocumentationFile>True</GenerateDocumentationFile>
+    <GenerateDocumentationFile>$(GenerateDocumentationFile)</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

src/Plugins/BotSharp.Plugin.ChatHub/BotSharp.Plugin.ChatHub.csproj

@@ -7,7 +7,7 @@
     <LangVersion>$(LangVersion)</LangVersion>
     <VersionPrefix>$(BotSharpVersion)</VersionPrefix>
     <GeneratePackageOnBuild>$(GeneratePackageOnBuild)</GeneratePackageOnBuild>
-    <GenerateDocumentationFile>True</GenerateDocumentationFile>
+    <GenerateDocumentationFile>$(GenerateDocumentationFile)</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

src/Plugins/BotSharp.Plugin.ChatHub/Hooks/ChatHubConversationHook.cs

@@ -1,3 +1,4 @@
+using BotSharp.Abstraction.Messaging;
 using Microsoft.AspNetCore.SignalR;
 
 namespace BotSharp.Plugin.ChatHub.Hooks;
@@ -14,6 +15,30 @@ public ChatHubConversationHook(IServiceProvider services,
         _chatHub = chatHub;
     }
 
+    public override async Task OnUserAgentConnectedInitially(Conversation conversation)
+    {
+        var agentService = _services.GetService<IAgentService>();
+        var agent = await agentService.LoadAgent(conversation.AgentId);
+
+        // Check if the Welcome template exists.
+        var welcomeTemplate = agent.Templates.FirstOrDefault(x => x.Name == "welcome");
+        if (welcomeTemplate != null)
+        {
+            var messages = JsonSerializer.Deserialize<RichMessageBase[]>(welcomeTemplate.Content, new JsonSerializerOptions
+            {
+                PropertyNameCaseInsensitive = true
+            });
+
+            foreach (var message in messages)
+            {
+                await Task.Delay(300);
+                await OnResponseGenerated(new RoleDialogModel(AgentRole.Assistant, message.Text));
+            }
+        }
+
+        await base.OnUserAgentConnectedInitially(conversation);
+    }
+
     public override async Task OnConversationInitialized(Conversation conversation)
     {
         var userService = _services.GetRequiredService<IUserService>();

src/Plugins/BotSharp.Plugin.ChatHub/SignalRHub.cs

@@ -17,28 +17,6 @@ public SignalRHub(IServiceProvider services,
         _user = user;
     }
 
-    public async Task OnMessageReceivedFromClient(string message)
-    {
-        // await Clients.User(_user.Id).SendAsync("ReceiveMessage", message);
-    }
-
-    /// <summary>
-    /// Received message from client
-    /// </summary>
-    /// <param name="user"></param>
-    /// <param name="message"></param>
-    /// <returns></returns>
-    public async Task SendMessage(string user, string message)
-    {
-        // await Clients.User(_user.Id).SendAsync("ReceiveMessage", message);
-    }
-
-    public async Task SendMessageToCaller(string user, string message)
-        => await Clients.Caller.SendAsync("ReceiveMessage", user, message);
-
-    public async Task SendMessageToGroup(string user, string message)
-        => await Clients.Group("SignalR Users").SendAsync("ReceiveMessage", user, message);
-
     public override Task OnConnectedAsync()
     {
         Console.WriteLine($"SignalR Hub: {Context.UserIdentifier} connected in {Context.ConnectionId} [{DateTime.Now}]");

src/Plugins/BotSharp.Plugin.ChatbotUI/BotSharp.Plugin.ChatbotUI.csproj

@@ -6,7 +6,7 @@
     <LangVersion>$(LangVersion)</LangVersion>
     <VersionPrefix>$(BotSharpVersion)</VersionPrefix>
     <GeneratePackageOnBuild>$(GeneratePackageOnBuild)</GeneratePackageOnBuild>
-    <GenerateDocumentationFile>True</GenerateDocumentationFile>
+    <GenerateDocumentationFile>$(GenerateDocumentationFile)</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

src/Plugins/BotSharp.Plugin.GoogleAI/BotSharp.Plugin.GoogleAI.csproj

@@ -6,7 +6,7 @@
     <LangVersion>$(LangVersion)</LangVersion>
     <VersionPrefix>$(BotSharpVersion)</VersionPrefix>
     <GeneratePackageOnBuild>$(GeneratePackageOnBuild)</GeneratePackageOnBuild>
-    <GenerateDocumentationFile>True</GenerateDocumentationFile>
+    <GenerateDocumentationFile>$(GenerateDocumentationFile)</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

src/Plugins/BotSharp.Plugin.MetaAI/BotSharp.Plugin.MetaAI.csproj

@@ -6,7 +6,7 @@
     <LangVersion>$(LangVersion)</LangVersion>
     <VersionPrefix>$(BotSharpVersion)</VersionPrefix>
     <GeneratePackageOnBuild>$(GeneratePackageOnBuild)</GeneratePackageOnBuild>
-    <GenerateDocumentationFile>True</GenerateDocumentationFile>
+    <GenerateDocumentationFile>$(GenerateDocumentationFile)</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

src/Plugins/BotSharp.Plugin.MetaMessenger/BotSharp.Plugin.MetaMessenger.csproj

@@ -5,7 +5,7 @@
     <LangVersion>$(LangVersion)</LangVersion>
     <VersionPrefix>$(BotSharpVersion)</VersionPrefix>
     <GeneratePackageOnBuild>$(GeneratePackageOnBuild)</GeneratePackageOnBuild>
-    <GenerateDocumentationFile>GenerateDocumentationFile</GenerateDocumentationFile>
+    <GenerateDocumentationFile>$(GenerateDocumentationFile)</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

src/Plugins/BotSharp.Plugin.MetaMessenger/MessagingModels/AttachmentMessage.cs

@@ -10,4 +10,6 @@ public class AttachmentMessage : IRichMessage
 
     [JsonPropertyName("attachment")]
     public AttachmentBody Attachment { get; set; }
+
+    public string Type => "template";
 }

src/Plugins/BotSharp.Plugin.TelegramBots/BotSharp.Plugin.TelegramBots.csproj

@@ -6,7 +6,7 @@
     <LangVersion>$(LangVersion)</LangVersion>
     <VersionPrefix>$(BotSharpVersion)</VersionPrefix>
     <GeneratePackageOnBuild>$(GeneratePackageOnBuild)</GeneratePackageOnBuild>
-    <GenerateDocumentationFile>True</GenerateDocumentationFile>
+    <GenerateDocumentationFile>$(GenerateDocumentationFile)</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

src/Plugins/BotSharp.Plugin.WeChat/BotSharp.Plugin.WeChat.csproj

@@ -5,7 +5,7 @@
     <LangVersion>$(LangVersion)</LangVersion>
     <VersionPrefix>$(BotSharpVersion)</VersionPrefix>
     <GeneratePackageOnBuild>$(GeneratePackageOnBuild)</GeneratePackageOnBuild>
-    <GenerateDocumentationFile>True</GenerateDocumentationFile>
+    <GenerateDocumentationFile>$(GenerateDocumentationFile)</GenerateDocumentationFile>
   </PropertyGroup>
 
   <PropertyGroup>

src/WebStarter/data/agents/01fcc3e5-9af7-49e6-ad7a-a760bd12dc4a/templates/welcome.liquid

@@ -0,0 +1,8 @@
+[
+  {
+    "text": "Hello, I'm an AI assistant that help you do variety of tasks."
+  },
+  {
+      "text": "How can I help you today?"
+  }
+]