Merge pull request #391 from notion-dotnet/feature/375-support-querying-wiki-databases

KoditkarVedant · web-flow · commit b422493ae7b7 · 2023-10-13T15:10:09.000+05:30
Add support for querying wiki databases
diff --git a/Src/Notion.Client/Api/Databases/DatabasesClient.cs b/Src/Notion.Client/Api/Databases/DatabasesClient.cs
@@ -1,12 +1,10 @@
-﻿using System.Collections.Generic;
-using System.Linq;
-using System.Threading;
+﻿using System.Threading;
 using System.Threading.Tasks;
 using static Notion.Client.ApiEndpoints;
 
 namespace Notion.Client
 {
-    public class DatabasesClient : IDatabasesClient
+    public sealed partial class DatabasesClient : IDatabasesClient
     {
         private readonly IRestClient _client;
 
@@ -20,24 +18,6 @@ public async Task<Database> RetrieveAsync(string databaseId, CancellationToken c
             return await _client.GetAsync<Database>(DatabasesApiUrls.Retrieve(databaseId), cancellationToken: cancellationToken);
         }
 
-        public async Task<PaginatedList<Page>> QueryAsync(
-            string databaseId,
-            DatabasesQueryParameters databasesQueryParameters, CancellationToken cancellationToken = default)
-        {
-            var body = (IDatabaseQueryBodyParameters)databasesQueryParameters;
-            var queryParameters = (IDatabaseQueryQueryParameters)databasesQueryParameters;
-
-            var queryParams = queryParameters.FilterProperties?
-                .Select(x => new KeyValuePair<string, string>("filter_properties", x));
-
-            return await _client.PostAsync<PaginatedList<Page>>(
-                DatabasesApiUrls.Query(databaseId),
-                body,
-                queryParams,
-                cancellationToken: cancellationToken
-            );
-        }
-
         public async Task<Database> CreateAsync(DatabasesCreateParameters databasesCreateParameters, CancellationToken cancellationToken = default)
         {
             var body = (IDatabasesCreateBodyParameters)databasesCreateParameters;
diff --git a/Src/Notion.Client/Api/Databases/IDatabasesClient.cs b/Src/Notion.Client/Api/Databases/IDatabasesClient.cs
@@ -24,7 +24,7 @@ public interface IDatabasesClient
         /// <returns>
         ///     <see cref="PaginatedList{T}" />
         /// </returns>
-        Task<PaginatedList<Page>> QueryAsync(string databaseId, DatabasesQueryParameters databasesQueryParameters, CancellationToken cancellationToken = default);
+        Task<DatabaseQueryResponse> QueryAsync(string databaseId, DatabasesQueryParameters databasesQueryParameters, CancellationToken cancellationToken = default);
 
         /// <summary>
         ///     Creates a database as a subpage in the specified parent page, with the specified properties schema.
diff --git a/Src/Notion.Client/Api/Databases/Query/DatabasesClient.cs b/Src/Notion.Client/Api/Databases/Query/DatabasesClient.cs
@@ -0,0 +1,28 @@
+﻿using System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Notion.Client
+{
+    public sealed partial class DatabasesClient
+    {
+        public async Task<DatabaseQueryResponse> QueryAsync(
+            string databaseId,
+            DatabasesQueryParameters databasesQueryParameters, CancellationToken cancellationToken = default)
+        {
+            var body = (IDatabaseQueryBodyParameters)databasesQueryParameters;
+            var queryParameters = (IDatabaseQueryQueryParameters)databasesQueryParameters;
+
+            var queryParams = queryParameters.FilterProperties?
+                .Select(x => new KeyValuePair<string, string>("filter_properties", x));
+
+            return await _client.PostAsync<DatabaseQueryResponse>(
+                ApiEndpoints.DatabasesApiUrls.Query(databaseId),
+                body,
+                queryParams,
+                cancellationToken: cancellationToken
+            );
+        }
+    }
+}
diff --git a/Src/Notion.Client/Api/Databases/Query/Request/DatabasesQueryParameters.cs b/Src/Notion.Client/Api/Databases/Query/Request/DatabasesQueryParameters.cs
diff --git a/Src/Notion.Client/Api/Databases/Query/Request/IDatabaseQueryBodyParameters.cs b/Src/Notion.Client/Api/Databases/Query/Request/IDatabaseQueryBodyParameters.cs
diff --git a/Src/Notion.Client/Api/Databases/Query/Request/IDatabaseQueryQueryParameters.cs b/Src/Notion.Client/Api/Databases/Query/Request/IDatabaseQueryQueryParameters.cs
diff --git a/Src/Notion.Client/Api/Databases/Query/Response/DatabaseQueryResponse.cs b/Src/Notion.Client/Api/Databases/Query/Response/DatabaseQueryResponse.cs
@@ -0,0 +1,7 @@
+﻿namespace Notion.Client
+{
+    // ReSharper disable once ClassNeverInstantiated.Global
+    public class DatabaseQueryResponse : PaginatedList<IWikiDatabase>
+    {
+    }
+}
diff --git a/Src/Notion.Client/Models/Database/Database.cs b/Src/Notion.Client/Models/Database/Database.cs
@@ -4,7 +4,7 @@
 
 namespace Notion.Client
 {
-    public class Database : IObject, IObjectModificationData
+    public class Database : IObject, IObjectModificationData, IWikiDatabase
     {
         [JsonProperty("title")]
         public List<RichTextBase> Title { get; set; }
diff --git a/Src/Notion.Client/Models/Database/IWikiDatabase.cs b/Src/Notion.Client/Models/Database/IWikiDatabase.cs
@@ -0,0 +1,12 @@
+﻿using JsonSubTypes;
+using Newtonsoft.Json;
+
+namespace Notion.Client
+{
+    [JsonConverter(typeof(JsonSubtypes), "object")]
+    [JsonSubtypes.KnownSubTypeAttribute(typeof(Page), ObjectType.Page)]
+    [JsonSubtypes.KnownSubTypeAttribute(typeof(Database), ObjectType.Database)]
+    public interface IWikiDatabase : IObject
+    {
+    }
+}
diff --git a/Src/Notion.Client/Models/Page/Page.cs b/Src/Notion.Client/Models/Page/Page.cs
@@ -4,7 +4,7 @@
 
 namespace Notion.Client
 {
-    public class Page : IObject, IObjectModificationData
+    public class Page : IObject, IObjectModificationData, IWikiDatabase
     {
         /// <summary>
         ///     The parent of this page. Can be a database, page, or workspace.
diff --git a/Test/Notion.IntegrationTests/DatabasesClientTests.cs b/Test/Notion.IntegrationTests/DatabasesClientTests.cs
@@ -0,0 +1,85 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Notion.Client;
+using Xunit;
+
+namespace Notion.IntegrationTests;
+
+public class DatabasesClientTests : IntegrationTestBase, IDisposable
+{
+    private readonly Page _page;
+
+    public DatabasesClientTests()
+    {
+        _page = Client.Pages.CreateAsync(
+            PagesCreateParametersBuilder.Create(
+                new ParentPageInput { PageId = ParentPageId }
+            ).Build()
+        ).Result;
+    }
+
+    public void Dispose()
+    {
+        Client.Pages.UpdateAsync(_page.Id, new PagesUpdateParameters { Archived = true }).Wait();
+    }
+
+    [Fact]
+    public async Task QueryDatabase()
+    {
+        // Arrange
+        var createdDatabase = await CreateDatabaseWithAPageAsync();
+
+        // Act
+        var response = await Client.Databases.QueryAsync(createdDatabase.Id, new DatabasesQueryParameters());
+
+        // Assert
+        Assert.NotNull(response.Results);
+        Assert.Single(response.Results);
+        var page = response.Results.Cast<Page>().First();
+        var title = page.Properties["Name"] as TitlePropertyValue;
+        Assert.Equal("Test Title", (title!.Title.Cast<RichTextText>().First()).Text.Content);
+    }
+
+    private async Task<Database> CreateDatabaseWithAPageAsync()
+    {
+        var createDbRequest = new DatabasesCreateParameters
+        {
+            Title = new List<RichTextBaseInput>
+            {
+                new RichTextTextInput
+                {
+                    Text = new Text
+                    {
+                        Content = "Test List",
+                        Link = null
+                    }
+                }
+            },
+            Properties = new Dictionary<string, IPropertySchema>
+            {
+                { "Name", new TitlePropertySchema { Title = new Dictionary<string, object>() } },
+            },
+            Parent = new ParentPageInput { PageId = _page.Id }
+        };
+
+        var createdDatabase = await Client.Databases.CreateAsync(createDbRequest);
+
+        var pagesCreateParameters = PagesCreateParametersBuilder
+            .Create(new DatabaseParentInput { DatabaseId = createdDatabase.Id })
+            .AddProperty("Name",
+                new TitlePropertyValue
+                {
+                    Title = new List<RichTextBase>
+                    {
+                        new RichTextText { Text = new Text { Content = "Test Title" } }
+                    }
+                })
+            .Build();
+
+        await Client.Pages.CreateAsync(pagesCreateParameters);
+
+        return createdDatabase;
+    }
+}
diff --git a/Test/Notion.UnitTests/DatabasesClientTests.cs b/Test/Notion.UnitTests/DatabasesClientTests.cs
@@ -64,8 +64,9 @@ public async Task QueryAsync()
 
         pagesPaginatedList.Results.Should().ContainSingle();
 
-        foreach (var page in pagesPaginatedList.Results)
+        foreach (var iWikiDatabase in pagesPaginatedList.Results)
         {
+            var page = (Page)iWikiDatabase;
             page.Parent.Should().BeAssignableTo<IPageParent>();
             page.Object.Should().Be(ObjectType.Page);
         }
@@ -476,8 +477,9 @@ var jsonData
 
         pagesPaginatedList.Results.Should().ContainSingle();
 
-        foreach (var page in pagesPaginatedList.Results)
+        foreach (var iWikiDatabase in pagesPaginatedList.Results)
         {
+            var page = (Page)iWikiDatabase;
             page.Parent.Should().BeAssignableTo<IPageParent>();
             page.Object.Should().Be(ObjectType.Page);
 

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace Notion.Client`
`6`	`6`	`{`
`7`		`- public class Database : IObject, IObjectModificationData`
	`7`	`+ public class Database : IObject, IObjectModificationData, IWikiDatabase`
`8`	`8`	`{`
`9`	`9`	`[JsonProperty("title")]`
`10`	`10`	`public List<RichTextBase> Title { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace Notion.Client`
`6`	`6`	`{`
`7`		`- public class Page : IObject, IObjectModificationData`
	`7`	`+ public class Page : IObject, IObjectModificationData, IWikiDatabase`
`8`	`8`	`{`
`9`	`9`	`/// <summary>`
`10`	`10`	`/// The parent of this page. Can be a database, page, or workspace.`