Merge pull request #281 from Sphere10/main

KoditkarVedant · web-flow · commit 9d6052ab57ca · 2022-08-11T09:29:57.000+05:30
Added Color abstraction (#251) 💖
diff --git a/Src/Notion.Client/Api/Databases/RequestParams/DatabasesCreateParameters/PropertySchema/SelectOptionSchema.cs b/Src/Notion.Client/Api/Databases/RequestParams/DatabasesCreateParameters/PropertySchema/SelectOptionSchema.cs
@@ -1,4 +1,5 @@
 ﻿using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace Notion.Client
 {
@@ -8,6 +9,7 @@ public class SelectOptionSchema
         public string Name { get; set; }
 
         [JsonProperty("color")]
-        public string Color { get; set; }
+        [JsonConverter(typeof(StringEnumConverter))]
+        public Color Color { get; set; }
     }
 }
diff --git a/Src/Notion.Client/Models/Blocks/BulletedListItemBlock.cs b/Src/Notion.Client/Models/Blocks/BulletedListItemBlock.cs
@@ -1,5 +1,6 @@
 ﻿using System.Collections.Generic;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace Notion.Client
 {
@@ -15,6 +16,10 @@ public class Info
             [JsonProperty("rich_text")]
             public IEnumerable<RichTextBase> RichText { get; set; }
 
+            [JsonProperty("color")]
+            [JsonConverter(typeof(StringEnumConverter))]
+            public Color Color { get; set; }
+
             [JsonProperty("children")]
             public IEnumerable<INonColumnBlock> Children { get; set; }
         }
diff --git a/Src/Notion.Client/Models/Blocks/CalloutBlock.cs b/Src/Notion.Client/Models/Blocks/CalloutBlock.cs
@@ -1,5 +1,6 @@
 ﻿using System.Collections.Generic;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace Notion.Client
 {
@@ -18,6 +19,10 @@ public class Info
             [JsonProperty("icon")]
             public IPageIcon Icon { get; set; }
 
+            [JsonProperty("color")]
+            [JsonConverter(typeof(StringEnumConverter))]
+            public Color Color { get; set; }
+
             [JsonProperty("children")]
             public IEnumerable<INonColumnBlock> Children { get; set; }
         }
diff --git a/Src/Notion.Client/Models/Blocks/Color.cs b/Src/Notion.Client/Models/Blocks/Color.cs
@@ -0,0 +1,64 @@
+﻿using System.Runtime.Serialization;
+
+namespace Notion.Client
+{
+    public enum Color
+    {
+        [EnumMember(Value = "default")]
+        Default,
+
+        [EnumMember(Value = "gray")]
+        Gray,
+
+        [EnumMember(Value = "brown")]
+        Brown,
+
+        [EnumMember(Value = "orange")]
+        Orange,
+
+        [EnumMember(Value = "yellow")]
+        Yellow,
+
+        [EnumMember(Value = "green")]
+        Green,
+
+        [EnumMember(Value = "blue")]
+        Blue,
+
+        [EnumMember(Value = "purple")]
+        Purple,
+
+        [EnumMember(Value = "pink")]
+        Pink,
+
+        [EnumMember(Value = "red")]
+        Red,
+
+        [EnumMember(Value = "gray_background")]
+        GrayBackground,
+
+        [EnumMember(Value = "brown_background")]
+        BrownBackground,
+
+        [EnumMember(Value = "orange_background")]
+        OrangeBackground,
+
+        [EnumMember(Value = "yellow_background")]
+        YellowBackground,
+
+        [EnumMember(Value = "green_background")]
+        GreenBackground,
+
+        [EnumMember(Value = "blue_background")]
+        BlueBackground,
+
+        [EnumMember(Value = "purple_background")]
+        PurpleBackground,
+
+        [EnumMember(Value = "pink_background")]
+        PinkBackground,
+
+        [EnumMember(Value = "red_background")]
+        RedBackground,
+    }
+}
diff --git a/Src/Notion.Client/Models/Blocks/HeadingOneBlock.cs b/Src/Notion.Client/Models/Blocks/HeadingOneBlock.cs
@@ -1,5 +1,6 @@
 ﻿using System.Collections.Generic;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace Notion.Client
 {
@@ -16,6 +17,10 @@ public class Info
         {
             [JsonProperty("rich_text")]
             public IEnumerable<RichTextBase> RichText { get; set; }
+
+            [JsonProperty("color")]
+            [JsonConverter(typeof(StringEnumConverter))]
+            public Color Color { get; set; }
         }
     }
 }
diff --git a/Src/Notion.Client/Models/Blocks/HeadingThreeeBlock.cs b/Src/Notion.Client/Models/Blocks/HeadingThreeeBlock.cs
@@ -1,5 +1,6 @@
 ﻿using System.Collections.Generic;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace Notion.Client
 {
@@ -16,6 +17,10 @@ public class Info
         {
             [JsonProperty("rich_text")]
             public IEnumerable<RichTextBase> RichText { get; set; }
+
+            [JsonProperty("color")]
+            [JsonConverter(typeof(StringEnumConverter))]
+            public Color Color { get; set; }
         }
     }
 }
diff --git a/Src/Notion.Client/Models/Blocks/HeadingTwoBlock.cs b/Src/Notion.Client/Models/Blocks/HeadingTwoBlock.cs
@@ -1,5 +1,6 @@
 ﻿using System.Collections.Generic;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace Notion.Client
 {
@@ -16,6 +17,10 @@ public class Info
         {
             [JsonProperty("rich_text")]
             public IEnumerable<RichTextBase> RichText { get; set; }
+
+            [JsonProperty("color")]
+            [JsonConverter(typeof(StringEnumConverter))]
+            public Color Color { get; set; }
         }
     }
 }
diff --git a/Src/Notion.Client/Models/Blocks/NumberedListItemBlock.cs b/Src/Notion.Client/Models/Blocks/NumberedListItemBlock.cs
@@ -1,5 +1,6 @@
 ﻿using System.Collections.Generic;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace Notion.Client
 {
@@ -15,6 +16,10 @@ public class Info
             [JsonProperty("rich_text")]
             public IEnumerable<RichTextBase> RichText { get; set; }
 
+            [JsonProperty("color")]
+            [JsonConverter(typeof(StringEnumConverter))]
+            public Color Color { get; set; }
+
             [JsonProperty("children")]
             public IEnumerable<INonColumnBlock> Children { get; set; }
         }
diff --git a/Src/Notion.Client/Models/Blocks/ParagraphBlock.cs b/Src/Notion.Client/Models/Blocks/ParagraphBlock.cs
@@ -1,5 +1,6 @@
 ﻿using System.Collections.Generic;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace Notion.Client
 {
@@ -15,6 +16,10 @@ public class Info
             [JsonProperty("rich_text")]
             public IEnumerable<RichTextBase> RichText { get; set; }
 
+            [JsonProperty("color")]
+            [JsonConverter(typeof(StringEnumConverter))]
+            public Color Color { get; set; }
+
             [JsonProperty("children")]
             public IEnumerable<INonColumnBlock> Children { get; set; }
         }
diff --git a/Src/Notion.Client/Models/Blocks/QuoteBlock.cs b/Src/Notion.Client/Models/Blocks/QuoteBlock.cs
@@ -1,5 +1,6 @@
 ﻿using System.Collections.Generic;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace Notion.Client
 {
@@ -15,6 +16,10 @@ public class Info
             [JsonProperty("rich_text")]
             public IEnumerable<RichTextBase> RichText { get; set; }
 
+            [JsonProperty("color")]
+            [JsonConverter(typeof(StringEnumConverter))]
+            public Color Color { get; set; }
+
             [JsonProperty("children")]
             public IEnumerable<INonColumnBlock> Children { get; set; }
         }
diff --git a/Src/Notion.Client/Models/Blocks/TableOfContentsBlock.cs b/Src/Notion.Client/Models/Blocks/TableOfContentsBlock.cs
@@ -1,4 +1,5 @@
 ﻿using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace Notion.Client
 {
@@ -11,6 +12,9 @@ public class TableOfContentsBlock : Block, IColumnChildrenBlock, INonColumnBlock
 
         public class Data
         {
+            [JsonProperty("color")]
+            [JsonConverter(typeof(StringEnumConverter))]
+            public Color Color { get; set; }
         }
     }
 }
diff --git a/Src/Notion.Client/Models/Blocks/ToDoBlock.cs b/Src/Notion.Client/Models/Blocks/ToDoBlock.cs
@@ -1,5 +1,6 @@
 ﻿using System.Collections.Generic;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace Notion.Client
 {
@@ -18,6 +19,10 @@ public class Info
             [JsonProperty("checked")]
             public bool IsChecked { get; set; }
 
+            [JsonProperty("color")]
+            [JsonConverter(typeof(StringEnumConverter))]
+            public Color Color { get; set; }
+
             [JsonProperty("children")]
             public IEnumerable<INonColumnBlock> Children { get; set; }
         }
diff --git a/Src/Notion.Client/Models/Blocks/ToggleBlock.cs b/Src/Notion.Client/Models/Blocks/ToggleBlock.cs
@@ -1,5 +1,6 @@
 ﻿using System.Collections.Generic;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace Notion.Client
 {
@@ -15,6 +16,10 @@ public class Info
             [JsonProperty("rich_text")]
             public IEnumerable<RichTextBase> RichText { get; set; }
 
+            [JsonProperty("color")]
+            [JsonConverter(typeof(StringEnumConverter))]
+            public Color Color { get; set; }
+
             [JsonProperty("children")]
             public IEnumerable<INonColumnBlock> Children { get; set; }
         }
diff --git a/Src/Notion.Client/Models/Database/Properties/SelectProperty.cs b/Src/Notion.Client/Models/Database/Properties/SelectProperty.cs
@@ -1,5 +1,6 @@
 ﻿using System.Collections.Generic;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace Notion.Client
 {
@@ -33,7 +34,8 @@ public class SelectOption
         /// Color of the option. Possible values are: "default", "gray", "brown", "red", "orange", "yellow", "green", "blue", "purple", "pink". Defaults to "default".
         /// </summary>
         [JsonProperty("color")]
-        public string Color { get; set; }
+        [JsonConverter(typeof(StringEnumConverter))]
+        public Color Color { get; set; }
     }
 
     public class MultiSelectProperty : Property
diff --git a/Src/Notion.Client/Models/Database/RichText/RichTextBase.cs b/Src/Notion.Client/Models/Database/RichText/RichTextBase.cs
@@ -42,7 +42,7 @@ public class Annotations
         public bool IsCode { get; set; }
 
         [JsonProperty("color")]
-        // color: Color | BackgroundColor
-        public string Color { get; set; }
+        [JsonConverter(typeof(StringEnumConverter))]
+        public Color Color { get; set; }
     }
 }
diff --git a/Test/Notion.UnitTests/DatabasesClientTests.cs b/Test/Notion.UnitTests/DatabasesClientTests.cs
@@ -214,17 +214,17 @@ public async Task CreateDatabaseAsync()
                             {
                                 new SelectOptionSchema
                                 {
-                                    Color = "green",
+                                    Color = Color.Green,
                                     Name = "🥦Vegetable"
                                 },
                                 new SelectOptionSchema
                                 {
-                                    Color = "red",
+                                    Color = Color.Red,
                                     Name = "🍎Fruit"
                                 },
                                 new SelectOptionSchema
                                 {
-                                    Color = "yellow",
+                                    Color = Color.Yellow,
                                     Name = "💪Protein"
                                 }
                             }
@@ -248,17 +248,17 @@ public async Task CreateDatabaseAsync()
                 option =>
                 {
                     option.Name.Should().Be("🥦Vegetable");
-                    option.Color.Should().Be("green");
+                    option.Color.Should().Be(Color.Green);
                 },
                 option =>
                 {
                     option.Name.Should().Be("🍎Fruit");
-                    option.Color.Should().Be("red");
+                    option.Color.Should().Be(Color.Red);
                 },
                 option =>
                 {
                     option.Name.Should().Be("💪Protein");
-                    option.Color.Should().Be("yellow");
+                    option.Color.Should().Be(Color.Yellow);
                 }
             );
         }
@@ -303,17 +303,17 @@ public async Task UpdateDatabaseAsync()
                             {
                                 new SelectOption
                                 {
-                                    Color = "green",
+                                    Color = Color.Green,
                                     Name = "🥦Vegetables"
                                 },
                                 new SelectOption
                                 {
-                                    Color = "red",
+                                    Color = Color.Red,
                                     Name = "🍎Fruit"
                                 },
                                 new SelectOption
                                 {
-                                    Color = "yellow",
+                                    Color = Color.Yellow,
                                     Name = "💪Protein"
                                 }
                             }
@@ -346,17 +346,17 @@ public async Task UpdateDatabaseAsync()
                 option =>
                 {
                     option.Name.Should().Be("🥦Vegetables");
-                    option.Color.Should().Be("green");
+                    option.Color.Should().Be(Color.Green);
                 },
                 option =>
                 {
                     option.Name.Should().Be("🍎Fruit");
-                    option.Color.Should().Be("red");
+                    option.Color.Should().Be(Color.Red);
                 },
                 option =>
                 {
                     option.Name.Should().Be("💪Protein");
-                    option.Color.Should().Be("yellow");
+                    option.Color.Should().Be(Color.Yellow);
                 }
             );
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using Newtonsoft.Json;`
	`2`	`+using Newtonsoft.Json.Converters;`
`2`	`3`
`3`	`4`	`namespace Notion.Client`
`4`	`5`	`{`
`@@ -8,6 +9,7 @@ public class SelectOptionSchema`
`8`	`9`	`public string Name { get; set; }`
`9`	`10`
`10`	`11`	`[JsonProperty("color")]`
`11`		`- public string Color { get; set; }`
	`12`	`+ [JsonConverter(typeof(StringEnumConverter))]`
	`13`	`+ public Color Color { get; set; }`
`12`	`14`	`}`
`13`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using System.Collections.Generic;`
`2`	`2`	`using Newtonsoft.Json;`
	`3`	`+using Newtonsoft.Json.Converters;`
`3`	`4`
`4`	`5`	`namespace Notion.Client`
`5`	`6`	`{`
`@@ -16,6 +17,10 @@ public class Info`
`16`	`17`	`{`
`17`	`18`	`[JsonProperty("rich_text")]`
`18`	`19`	`public IEnumerable<RichTextBase> RichText { get; set; }`
	`20`	`+`
	`21`	`+ [JsonProperty("color")]`
	`22`	`+ [JsonConverter(typeof(StringEnumConverter))]`
	`23`	`+ public Color Color { get; set; }`
`19`	`24`	`}`
`20`	`25`	`}`
`21`	`26`	`}`