Merge pull request #317 from iceljc/features/refine-rich-type

Oceania2018 · web-flow · commit 32d5fc05bcc4 · 2024-02-24T19:39:31.000-06:00
refine rich type and template type
diff --git a/src/Infrastructure/BotSharp.Abstraction/Messaging/Enums/RichTypeEnum.cs b/src/Infrastructure/BotSharp.Abstraction/Messaging/Enums/RichTypeEnum.cs
@@ -0,0 +1,12 @@
+namespace BotSharp.Abstraction.Messaging.Enums;
+
+public static class RichTypeEnum
+{
+    public const string ButtonTemplate = "button_template";
+    public const string MultiSelectTemplate = "multi-select_template";
+    public const string CouponTemplate = "coupon_template";
+    public const string GenericTemplate = "generic_template";
+    public const string QuickReply = "quick_reply";
+    public const string Text = "text";
+    public const string Attachment = "attachment";
+}
diff --git a/src/Infrastructure/BotSharp.Abstraction/Messaging/Enums/TemplateTypeEnum.cs b/src/Infrastructure/BotSharp.Abstraction/Messaging/Enums/TemplateTypeEnum.cs
@@ -0,0 +1,10 @@
+namespace BotSharp.Abstraction.Messaging.Enums;
+
+public static class TemplateTypeEnum
+{
+    public const string Button = "button";
+    public const string Coupon = "coupon";
+    public const string Generic = "generic";
+    public const string MultiSelect = "multi-select";
+    public const string Product = "product";
+}
diff --git a/src/Infrastructure/BotSharp.Abstraction/Messaging/JsonConverters/RichContentJsonConverter .cs b/src/Infrastructure/BotSharp.Abstraction/Messaging/JsonConverters/RichContentJsonConverter .cs
@@ -1,3 +1,5 @@
+using BotSharp.Abstraction.Messaging.Enums;
+using BotSharp.Abstraction.Messaging.Models.RichContent;
 using BotSharp.Abstraction.Messaging.Models.RichContent.Template;
 using System.Text.Json;
 
@@ -13,13 +15,29 @@ public class RichContentJsonConverter : JsonConverter<IRichMessage>
         JsonElement element;
         object? res = null;
 
-        if (root.TryGetProperty("buttons", out element))
+        if (root.TryGetProperty("rich_type", out element))
         {
-            res = JsonSerializer.Deserialize<ButtonTemplateMessage>(jsonText, options);
-        }
-        else if (root.TryGetProperty("options", out element))
-        {
-            res = JsonSerializer.Deserialize<MultiSelectTemplateMessage>(jsonText, options);
+            var richType = element.GetString();
+            if (richType == RichTypeEnum.ButtonTemplate)
+            {
+                res = JsonSerializer.Deserialize<ButtonTemplateMessage>(jsonText, options);
+            }
+            else if (richType == RichTypeEnum.MultiSelectTemplate)
+            {
+                res = JsonSerializer.Deserialize<MultiSelectTemplateMessage>(jsonText, options);
+            }
+            else if (richType == RichTypeEnum.QuickReply)
+            {
+                res = JsonSerializer.Deserialize<QuickReplyMessage>(jsonText, options);
+            }
+            else if (richType == RichTypeEnum.CouponTemplate)
+            {
+                res = JsonSerializer.Deserialize<CouponTemplateMessage>(jsonText, options);
+            }
+            else if (richType == RichTypeEnum.Text)
+            {
+                res = JsonSerializer.Deserialize<TextMessage>(jsonText, options);
+            }
         }
 
         return res as IRichMessage;
diff --git a/src/Infrastructure/BotSharp.Abstraction/Messaging/JsonConverters/TemplateMessageJsonConverter.cs b/src/Infrastructure/BotSharp.Abstraction/Messaging/JsonConverters/TemplateMessageJsonConverter.cs
@@ -1,3 +1,4 @@
+using BotSharp.Abstraction.Messaging.Enums;
 using BotSharp.Abstraction.Messaging.Models.RichContent.Template;
 using System.Text.Json;
 
@@ -13,13 +14,25 @@ public class TemplateMessageJsonConverter : JsonConverter<ITemplateMessage>
         JsonElement element;
         object? res = null;
 
-        if (root.TryGetProperty("buttons", out element))
+        if (root.TryGetProperty("template_type", out element))
         {
-            res = JsonSerializer.Deserialize<ButtonTemplateMessage>(jsonText, options);
-        }
-        else if (root.TryGetProperty("options", out element))
-        {
-            res = JsonSerializer.Deserialize<MultiSelectTemplateMessage>(jsonText, options);
+            var templateType = element.GetString();
+            if (templateType == TemplateTypeEnum.Button)
+            {
+                res = JsonSerializer.Deserialize<ButtonTemplateMessage>(jsonText, options);
+            }
+            else if (templateType == TemplateTypeEnum.MultiSelect)
+            {
+                res = JsonSerializer.Deserialize<MultiSelectTemplateMessage>(jsonText, options);
+            }
+            else if (templateType == TemplateTypeEnum.Coupon)
+            {
+                res = JsonSerializer.Deserialize<CouponTemplateMessage>(jsonText, options);
+            }
+            else if (templateType == TemplateTypeEnum.Product)
+            {
+                res = JsonSerializer.Deserialize<ProductTemplateMessage>(jsonText, options);
+            }
         }
 
         return res as ITemplateMessage;
diff --git a/src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/QuickReplyMessage.cs b/src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/QuickReplyMessage.cs
@@ -1,9 +1,11 @@
+using BotSharp.Abstraction.Messaging.Enums;
+
 namespace BotSharp.Abstraction.Messaging.Models.RichContent;
 
 public class QuickReplyMessage : IRichMessage
 {
     [JsonPropertyName("rich_type")]
-    public string RichType => "quick_reply";
+    public string RichType => RichTypeEnum.QuickReply;
     public string Text { get; set; } = string.Empty;
 
     [JsonPropertyName("quick_replies")]
diff --git a/src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/ButtonTemplateMessage.cs b/src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/ButtonTemplateMessage.cs
@@ -1,3 +1,5 @@
+using BotSharp.Abstraction.Messaging.Enums;
+
 namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template;
 
 /// <summary>
@@ -6,13 +8,13 @@ namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template;
 public class ButtonTemplateMessage : IRichMessage, ITemplateMessage
 {
     [JsonPropertyName("rich_type")]
-    public string RichType => "button_template";
+    public string RichType => RichTypeEnum.ButtonTemplate;
 
     [JsonPropertyName("text")]
     public string Text { get; set; } = string.Empty;
 
     [JsonPropertyName("template_type")]
-    public string TemplateType => "button";
+    public string TemplateType => TemplateTypeEnum.Button;
 
     [JsonPropertyName("buttons")]
     public ButtonElement[] Buttons { get; set; } = new ButtonElement[0];
diff --git a/src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/CouponTemplateMessage.cs b/src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/CouponTemplateMessage.cs
@@ -1,3 +1,5 @@
+using BotSharp.Abstraction.Messaging.Enums;
+
 namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template;
 
 /// <summary>
@@ -7,14 +9,14 @@ namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template;
 public class CouponTemplateMessage : IRichMessage, ITemplateMessage
 {
     [JsonPropertyName("rich_type")]
-    public string RichType => "coupon_template";
+    public string RichType => RichTypeEnum.CouponTemplate;
     [JsonIgnore]
     public string Text { get; set; }
     public string Title { get; set; }
     public string Subtitle { get; set; }
 
     [JsonPropertyName("template_type")]
-    public string TemplateType => "coupon";
+    public string TemplateType => TemplateTypeEnum.Coupon;
 
     [JsonPropertyName("coupon_code")]
     public string CouponCode { get; set; }
diff --git a/src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/GenericTemplateMessage.cs b/src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/GenericTemplateMessage.cs
@@ -1,15 +1,17 @@
+using BotSharp.Abstraction.Messaging.Enums;
+
 namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template;
 
 public class GenericTemplateMessage<T> : IRichMessage, ITemplateMessage
 {
     [JsonPropertyName("rich_type")]
-    public string RichType => "generic_template";
+    public string RichType => RichTypeEnum.GenericTemplate;
 
     [JsonIgnore]
     public string Text { get; set; } = string.Empty;
 
     [JsonPropertyName("template_type")]
-    public string TemplateType => "generic";
+    public string TemplateType => TemplateTypeEnum.Generic;
 
     [JsonPropertyName("elements")]
     public List<T> Elements { get; set; } = new List<T>();
diff --git a/src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/MultiSelectTemplateMessage.cs b/src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/MultiSelectTemplateMessage.cs
@@ -1,14 +1,16 @@
+using BotSharp.Abstraction.Messaging.Enums;
+
 namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template;
 
 public class MultiSelectTemplateMessage : IRichMessage, ITemplateMessage
 {
     [JsonPropertyName("rich_type")]
-    public string RichType => "multi-select_template";
+    public string RichType => RichTypeEnum.MultiSelectTemplate;
 
     public string Text { get; set; } = string.Empty;
 
     [JsonPropertyName("template_type")]
-    public string TemplateType => "multi-select";
+    public string TemplateType => TemplateTypeEnum.MultiSelect;
     public List<OptionElement> Options { get; set; } = new List<OptionElement>();
 }
 
diff --git a/src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/ProductTemplateMessage.cs b/src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/ProductTemplateMessage.cs
@@ -1,15 +1,17 @@
+using BotSharp.Abstraction.Messaging.Enums;
+
 namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template;
 
 public class ProductTemplateMessage : IRichMessage, ITemplateMessage
 {
     [JsonPropertyName("rich_type")]
-    public string RichType => "generic_template";
+    public string RichType => RichTypeEnum.GenericTemplate;
 
     [JsonIgnore]
     public string Text { get; set; } = string.Empty;
 
     [JsonPropertyName("template_type")]
-    public string TemplateType => "product";
+    public string TemplateType => TemplateTypeEnum.Product;
 }
 
 public class ProductElement
diff --git a/src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/TextMessage.cs b/src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/TextMessage.cs
@@ -1,9 +1,11 @@
+using BotSharp.Abstraction.Messaging.Enums;
+
 namespace BotSharp.Abstraction.Messaging.Models.RichContent;
 
 public class TextMessage : IRichMessage
 {
     [JsonPropertyName("rich_type")]
-    public string RichType => "text";
+    public string RichType => RichTypeEnum.Text;
 
     public string Text { get; set; } = string.Empty;
 
diff --git a/src/Infrastructure/BotSharp.Core/Messaging/RichContentService.cs b/src/Infrastructure/BotSharp.Core/Messaging/RichContentService.cs
@@ -1,4 +1,5 @@
 using BotSharp.Abstraction.Messaging;
+using BotSharp.Abstraction.Messaging.Enums;
 using BotSharp.Abstraction.Messaging.Models.RichContent;
 
 namespace BotSharp.Core.Messaging;
@@ -16,17 +17,17 @@ public List<IRichMessage> ConvertToMessages(string content)
 
         foreach (var m in tempMessages)
         {
-            var richType = "text";
+            var richType = RichTypeEnum.Text;
             if (m.RootElement.TryGetProperty("rich_type", out var element))
             {
                 richType = element.GetString();
             }
             
-            if (richType == "text")
+            if (richType == RichTypeEnum.Text)
             {
                 messages.Add(JsonSerializer.Deserialize<TextMessage>(m.RootElement.ToString(), options));
             }
-            else if (richType == "quick_reply")
+            else if (richType == RichTypeEnum.QuickReply)
             {
                 messages.Add(JsonSerializer.Deserialize<QuickReplyMessage>(m.RootElement.ToString(), options));
             }
diff --git a/src/Plugins/BotSharp.Plugin.MetaMessenger/MessagingModels/AttachmentMessage.cs b/src/Plugins/BotSharp.Plugin.MetaMessenger/MessagingModels/AttachmentMessage.cs
@@ -6,7 +6,7 @@ namespace BotSharp.Plugin.MetaMessenger.MessagingModels;
 public class AttachmentMessage : IRichMessage
 {
     [JsonPropertyName("rich_type")]
-    public string RichType => "attachment";
+    public string RichType => RichTypeEnum.Attachment;
 
     [JsonIgnore]
     public string Text { get; set; }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using BotSharp.Abstraction.Messaging;`
	`2`	`+using BotSharp.Abstraction.Messaging.Enums;`
`2`	`3`	`using BotSharp.Abstraction.Messaging.Models.RichContent;`
`3`	`4`
`4`	`5`	`namespace BotSharp.Core.Messaging;`
`@@ -16,17 +17,17 @@ public List<IRichMessage> ConvertToMessages(string content)`
`16`	`17`
`17`	`18`	`foreach (var m in tempMessages)`
`18`	`19`	`{`
`19`		`- var richType = "text";`
	`20`	`+ var richType = RichTypeEnum.Text;`
`20`	`21`	`if (m.RootElement.TryGetProperty("rich_type", out var element))`
`21`	`22`	`{`
`22`	`23`	`richType = element.GetString();`
`23`	`24`	`}`
`24`	`25`
`25`		`- if (richType == "text")`
	`26`	`+ if (richType == RichTypeEnum.Text)`
`26`	`27`	`{`
`27`	`28`	`messages.Add(JsonSerializer.Deserialize<TextMessage>(m.RootElement.ToString(), options));`
`28`	`29`	`}`
`29`		`- else if (richType == "quick_reply")`
	`30`	`+ else if (richType == RichTypeEnum.QuickReply)`
`30`	`31`	`{`
`31`	`32`	`messages.Add(JsonSerializer.Deserialize<QuickReplyMessage>(m.RootElement.ToString(), options));`
`32`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ namespace BotSharp.Plugin.MetaMessenger.MessagingModels;`
`6`	`6`	`public class AttachmentMessage : IRichMessage`
`7`	`7`	`{`
`8`	`8`	`[JsonPropertyName("rich_type")]`
`9`		`- public string RichType => "attachment";`
	`9`	`+ public string RichType => RichTypeEnum.Attachment;`
`10`	`10`
`11`	`11`	`[JsonIgnore]`
`12`	`12`	`public string Text { get; set; }`