add facets to search method

Author: Zechiax

Modrinth.Net.Test/FacetCollectionTests.cs

@@ -11,15 +11,15 @@ public void CollectionWithOnlyOneFacet()
     {
         var collection = new FacetCollection();
         collection.Add(Facet.Category("test"));
-        Assert.That(collection.ToString(), Is.EqualTo("[[\"category:test\"]]"));
+        Assert.That(collection.ToString(), Is.EqualTo("[[\"categories:test\"]]"));
     }
 
     [Test]
     public void CollectionWithMultipleFacets_OR()
     {
         var collection = new FacetCollection();
         collection.Add(Facet.Category("test"), Facet.Category("test2"));
-        Assert.That(collection.ToString(), Is.EqualTo("[[\"category:test\",\"category:test2\"]]"));
+        Assert.That(collection.ToString(), Is.EqualTo("[[\"categories:test\",\"categories:test2\"]]"));
     }
 
     [Test]
@@ -28,7 +28,7 @@ public void CollectionWithMultipleFacets_AND()
         var collection = new FacetCollection();
         collection.Add(Facet.Category("test"));
         collection.Add(Facet.Category("test2"));
-        Assert.That(collection.ToString(), Is.EqualTo("[[\"category:test\"],[\"category:test2\"]]"));
+        Assert.That(collection.ToString(), Is.EqualTo("[[\"categories:test\"],[\"categories:test2\"]]"));
     }
 
     [Test]
@@ -37,6 +37,6 @@ public void CollectionWithMultipleFacets_AND_OR()
         var collection = new FacetCollection();
         collection.Add(Facet.Category("test"));
         collection.Add(Facet.Category("test2"), Facet.Category("test3"));
-        Assert.That(collection.ToString(), Is.EqualTo("[[\"category:test\"],[\"category:test2\",\"category:test3\"]]"));
+        Assert.That(collection.ToString(), Is.EqualTo("[[\"categories:test\"],[\"categories:test2\",\"categories:test3\"]]"));
     }
 }

Modrinth.Net.Test/ModrinthApiTests/SearchTests.cs

@@ -1,4 +1,5 @@
-using Index = Modrinth.Models.Enums.Index;
+using Modrinth.Models.Facets;
+using Index = Modrinth.Models.Enums.Index;
 
 namespace Modrinth.Net.Test.ModrinthApiTests;
 
@@ -125,4 +126,18 @@ public async Task Search_WithUpdatedSort_ShouldReturnSortedByUpdatedList()
             search.Hits.Select(p => p.DateModified),
             Is.EqualTo(search.Hits.Select(p => p.DateModified).OrderByDescending(d => d)));
     }
+    
+    // Search with facets
+    [Test]
+    public async Task Search_WithFacets_ShouldReturnFilteredResults()
+    {
+        var facets = new FacetCollection();
+        
+        facets.Add(Facet.Category("adventure"));
+        
+        var search = await _client.Project.SearchAsync("", facets: facets);
+        
+        // Check that every search result has the adventure category
+        Assert.That(search.Hits.Select(p => p.Categories).All(c => c.Contains("adventure")));
+    }
 }

Modrinth.Net/Endpoints/Project/IProjectApi.cs

@@ -1,4 +1,5 @@
 using Modrinth.Models;
+using Modrinth.Models.Facets;
 using Index = Modrinth.Models.Enums.Index;
 
 namespace Modrinth.Endpoints.Project;
@@ -9,6 +10,7 @@ public interface IProjectApi
     ///     Search Modrinth for project by it's name
     /// </summary>
     /// <param name="query">The query to search for</param>
+    /// <param name="facets">Facets to filter the search by</param>
     /// <param name="index">The sorting method used for sorting search results</param>
     /// <param name="offset">The offset into the search. Skips this number of results</param>
     /// <param name="limit">The number of results returned by the search</param>
@@ -17,7 +19,8 @@ Task<SearchResponse> SearchAsync(
         string query,
         Index index = Index.Downloads,
         ulong offset = 0,
-        ulong limit = 10);
+        ulong limit = 10,
+        FacetCollection? facets = null);
 
     /// <summary>
     ///     Gets project by slug or ID

Modrinth.Net/Endpoints/Project/ProjectApi.cs

@@ -1,6 +1,7 @@
 using Flurl.Http;
 using Modrinth.Extensions;
 using Modrinth.Models;
+using Modrinth.Models.Facets;
 using Index = Modrinth.Models.Enums.Index;
 
 namespace Modrinth.Endpoints.Project;
@@ -64,13 +65,19 @@ public async Task UnfollowAsync(string slugOrId)
 
     /// <inheritdoc />
     public async Task<SearchResponse> SearchAsync(string query, Index index = Index.Downloads, ulong offset = 0,
-        ulong limit = 10)
+        ulong limit = 10, FacetCollection? facets = null)
     {
-        return await _client.Request("search")
+        var request = _client.Request("search")
             .SetQueryParam("query", query)
             .SetQueryParam("index", index.ToString().ToLower())
             .SetQueryParam("offset", offset)
-            .SetQueryParam("limit", limit)
-            .GetJsonAsync<SearchResponse>();
+            .SetQueryParam("limit", limit);
+        
+        if (facets is {Count: > 0})
+        {
+            request = request.SetQueryParam("facets", facets.ToString());
+        }
+        
+        return await request.GetJsonAsync<SearchResponse>();
     }
 }

Modrinth.Net/Models/Facets/Facet.cs

@@ -23,8 +23,8 @@ public override string ToString()
     {
         return Type switch
         {
-            FacetType.Categories => $"category:{Value}",
-            FacetType.Versions => $"version:{Value}",
+            FacetType.Categories => $"categories:{Value}",
+            FacetType.Versions => $"versions:{Value}",
             FacetType.License => $"license:{Value}",
             FacetType.ProjectType => $"project_type:{Value}",
             _ => string.Empty

Modrinth.Net/Models/Facets/FacetCollection.cs

@@ -2,6 +2,8 @@ namespace Modrinth.Models.Facets;
 
 public class FacetCollection
 {
+    public int Count => _facets.Count;
+    
     private readonly List<Facet[]> _facets = new();
 
     /// <summary>