Merge main into feat/federated-distinct

MultiSearchFederation gained showPerformanceDetails on main while this branch
added distinct. The setter conflict cut through a method whose closing
'return this;' both sides shared, so it is resolved as two complete setters
rather than one with two signatures.

Author: GabrielBBaldez

.code-samples.meilisearch.yaml

@@ -391,14 +391,14 @@ getting_started_add_documents: |-
   // <dependency>
   //   <groupId>com.meilisearch.sdk</groupId>
   //   <artifactId>meilisearch-java</artifactId>
-  //   <version>0.20.1</version>
+  //   <version>0.21.0</version>
   //   <type>pom</type>
   // </dependency>
 
   // For Gradle
   // Add the following line to the `dependencies` section of your `build.gradle`:
   //
-  // implementation 'com.meilisearch.sdk:meilisearch-java:0.20.1'
+  // implementation 'com.meilisearch.sdk:meilisearch-java:0.21.0'
 
   // In your .java file:
   import com.meilisearch.sdk;
@@ -640,3 +640,50 @@ webhooks_patch_1: |-
   Webhook updated_webhook = this.client.updateWebhook(webhook.getUuid(), webhookReq2);
 webhooks_delete_1: |-
   this.client.deleteWebhook("WEBHOOK_UUID");
+
+post_render_template_1: |-
+  Map<String, Boolean> features = new HashMap<>();
+  features.put("renderRoute", true);
+  client.experimentalFeatures(features);
+
+  Map<String, Object> template = new HashMap<>();
+  template.put("kind", "inlineDocumentTemplate");
+  template.put("inline", "Product {{doc.name}} is a {{doc.color}} {{doc.category}}.");
+
+  Map<String, Object> product = new HashMap<>();
+  product.put("name", "Nike Air Max");
+  product.put("color", "Black");
+  product.put("category", "Shoes");
+
+  Map<String, Object> input = new HashMap<>();
+  input.put("kind", "inlineDocument");
+  input.put("inline", product);
+
+  RenderTemplateRequest request = new RenderTemplateRequest()
+      .setTemplate(template)
+      .setInput(input);
+
+  client.renderTemplate(request);
+
+
+list_dynamic_search_rules_1: |-
+  DynamicSearchRulesQuery query = new DynamicSearchRulesQuery();
+  Results<DynamicSearchRule> rules = client.listDynamicSearchRules(query);
+get_dynamic_search_rule_1: |-
+  DynamicSearchRule rule = client.getDynamicSearchRule("black-friday");
+patch_dynamic_search_rule_1: |-
+  Map<String, Object> conditions = Map.of(
+      "query", Map.of("isEmpty", true),
+      "time", Map.of("start", "2025-11-28T00:00:00Z", "end", "2025-11-28T23:59:59Z"));
+
+  List<Map<String, Object>> actions = List.of(
+      Map.of(
+          "selector", Map.of("indexUid", "products", "id", "123"),
+          "action", Map.of("type", "pin", "position", 1)));
+
+  DynamicSearchRule rule = new DynamicSearchRule(
+      "black-friday", "Black Friday 2025 rules", 10, true, conditions, actions);
+
+  TaskInfo task = client.updateDynamicSearchRule("black-friday", rule);
+delete_dynamic_search_rule_1: |-
+  TaskInfo task = client.deleteDynamicSearchRule("black-friday");

.github/release-draft-template.yml

@@ -17,7 +17,7 @@ categories:
   - title: '🔒 Security'
     label: 'security'
   - title: '⚙️ Maintenance/misc'
-    label:
+    labels:
       - 'dependencies'
       - 'maintenance'
       - 'documentation'

README.md

@@ -57,7 +57,7 @@ Add the following code to the `<dependencies>` section of your project:
 <dependency>
   <groupId>com.meilisearch.sdk</groupId>
   <artifactId>meilisearch-java</artifactId>
-  <version>0.20.1</version>
+  <version>0.21.0</version>
   <type>pom</type>
 </dependency>
 ```
@@ -67,7 +67,7 @@ Add the following code to the `<dependencies>` section of your project:
 Add the following line to the `dependencies` section of your `build.gradle`:
 
 ```groovy
-implementation 'com.meilisearch.sdk:meilisearch-java:0.20.1'
+implementation 'com.meilisearch.sdk:meilisearch-java:0.21.0'
 ```
 
 :warning: `meilisearch-java` also requires `okhttp` as a peer dependency.

build.gradle

@@ -16,7 +16,7 @@ plugins {
 }
 
 group = 'com.meilisearch.sdk'
-version = '0.20.1'
+version = '0.21.0'
 
 base {
 	archivesName.set('meilisearch-java')

src/main/java/com/meilisearch/sdk/Client.java

@@ -21,6 +21,7 @@ public class Client {
     private KeysHandler keysHandler;
     private JsonHandler jsonHandler;
     private WebHooksHandler webHooksHandler;
+    private DynamicSearchRulesHandler dynamicSearchRulesHandler;
 
     /**
      * Calls instance for Meilisearch client
@@ -35,6 +36,7 @@ public Client(Config config) {
         this.keysHandler = new KeysHandler(config);
         this.jsonHandler = config.jsonHandler;
         this.webHooksHandler = new WebHooksHandler(config);
+        this.dynamicSearchRulesHandler = new DynamicSearchRulesHandler(config);
     }
 
     /**
@@ -482,6 +484,18 @@ public void experimentalFeatures(Map<String, Boolean> features) {
         this.config.httpClient.patch("/experimental-features", features, Void.class);
     }
 
+    /**
+     * Renders a template using the experimental render-template route.
+     *
+     * @param request Render template request body
+     * @return Rendered template result
+     * @throws MeilisearchException if an error occurs
+     */
+    public RenderTemplateResult renderTemplate(RenderTemplateRequest request)
+            throws MeilisearchException {
+        return this.config.httpClient.post("/render-template", request, RenderTemplateResult.class);
+    }
+
     public String generateTenantToken(String apiKeyUid, Map<String, Object> searchRules)
             throws MeilisearchException {
         return this.generateTenantToken(apiKeyUid, searchRules, new TenantTokenOptions());
@@ -612,4 +626,50 @@ private Boolean isValidUUID(String apiKeyUid) {
         }
         return true;
     }
+    /**
+     * Get a list of all dynamic search rules.
+     *
+     * @param query Query parameters for pagination and filtering (offset, limit, filter).
+     * @return Results containing a list of DynamicSearchRule instances.
+     * @throws MeilisearchException If an error occurs.
+     */
+    public Results<DynamicSearchRule> listDynamicSearchRules(DynamicSearchRulesQuery query)
+            throws MeilisearchException {
+        return this.dynamicSearchRulesHandler.listDynamicSearchRules(query);
+    }
+
+    /**
+     * Get a single dynamic search rule by its uid.
+     *
+     * @param uid Unique identifier of the dynamic search rule.
+     * @return A single DynamicSearchRule instance.
+     * @throws MeilisearchException If an error occurs.
+     */
+    public DynamicSearchRule getDynamicSearchRule(String uid) throws MeilisearchException {
+        return this.dynamicSearchRulesHandler.getDynamicSearchRule(uid);
+    }
+
+    /**
+     * Create a new dynamic search rule, or update it if a rule with the given uid already exists.
+     *
+     * @param uid Unique identifier of the dynamic search rule.
+     * @param dynamicSearchRule Request body containing the rule configuration.
+     * @return TaskInfo instance for the enqueued upsert operation.
+     * @throws MeilisearchException If an error occurs.
+     */
+    public TaskInfo updateDynamicSearchRule(String uid, DynamicSearchRule dynamicSearchRule)
+            throws MeilisearchException {
+        return this.dynamicSearchRulesHandler.updateDynamicSearchRule(uid, dynamicSearchRule);
+    }
+
+    /**
+     * Delete a dynamic search rule.
+     *
+     * @param uid Unique identifier of the dynamic search rule.
+     * @return TaskInfo instance for the enqueued delete operation.
+     * @throws MeilisearchException If an error occurs.
+     */
+    public TaskInfo deleteDynamicSearchRule(String uid) throws MeilisearchException {
+        return this.dynamicSearchRulesHandler.deleteDynamicSearchRule(uid);
+    }
 }

src/main/java/com/meilisearch/sdk/DynamicSearchRulesHandler.java

@@ -0,0 +1,44 @@
+package com.meilisearch.sdk;
+
+import com.meilisearch.sdk.exceptions.MeilisearchException;
+import com.meilisearch.sdk.http.URLBuilder;
+import com.meilisearch.sdk.model.DynamicSearchRule;
+import com.meilisearch.sdk.model.DynamicSearchRulesQuery;
+import com.meilisearch.sdk.model.Results;
+import com.meilisearch.sdk.model.TaskInfo;
+
+class DynamicSearchRulesHandler {
+    private final HttpClient httpClient;
+
+    protected DynamicSearchRulesHandler(Config config) {
+        httpClient = config.httpClient;
+    }
+
+    Results<DynamicSearchRule> listDynamicSearchRules(DynamicSearchRulesQuery query)
+            throws MeilisearchException {
+        return httpClient.post(
+                dynamicSearchRulesPath().getURL(), query, Results.class, DynamicSearchRule.class);
+    }
+
+    DynamicSearchRule getDynamicSearchRule(String uid) throws MeilisearchException {
+        return httpClient.get(
+                dynamicSearchRulesPath().addSubroute(uid).getURL(), DynamicSearchRule.class);
+    }
+
+    TaskInfo updateDynamicSearchRule(String uid, DynamicSearchRule dynamicSearchRule)
+            throws MeilisearchException {
+        return httpClient.patch(
+                dynamicSearchRulesPath().addSubroute(uid).getURL(),
+                dynamicSearchRule,
+                TaskInfo.class);
+    }
+
+    TaskInfo deleteDynamicSearchRule(String uid) throws MeilisearchException {
+        return httpClient.delete(
+                dynamicSearchRulesPath().addSubroute(uid).getURL(), TaskInfo.class);
+    }
+
+    private URLBuilder dynamicSearchRulesPath() {
+        return new URLBuilder("/dynamic-search-rules");
+    }
+}

src/main/java/com/meilisearch/sdk/MultiSearchFederation.java

@@ -12,6 +12,7 @@ public class MultiSearchFederation {
     private MergeFacets mergeFacets;
     private Map<String, String[]> facetsByIndex;
     private String distinct;
+    private Boolean showPerformanceDetails;
 
     public MultiSearchFederation setLimit(Integer limit) {
         this.limit = limit;
@@ -38,6 +39,11 @@ public MultiSearchFederation setDistinct(String distinct) {
         return this;
     }
 
+    public MultiSearchFederation setShowPerformanceDetails(Boolean showPerformanceDetails) {
+        this.showPerformanceDetails = showPerformanceDetails;
+        return this;
+    }
+
     /**
      * Method that returns the JSON String of the MultiSearchFederation
      *

src/main/java/com/meilisearch/sdk/RenderTemplateRequest.java

@@ -0,0 +1,30 @@
+package com.meilisearch.sdk;
+
+import java.util.Map;
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+import org.json.JSONObject;
+
+@Builder
+@AllArgsConstructor(access = AccessLevel.PACKAGE)
+@Getter
+@Setter
+@Accessors(chain = true)
+public class RenderTemplateRequest {
+    private Map<String, Object> template;
+    private Map<String, Object> input;
+
+    public RenderTemplateRequest() {}
+
+    @Override
+    public String toString() {
+        JSONObject jsonObject = new JSONObject();
+        jsonObject.put("template", this.template);
+        jsonObject.putOpt("input", this.input);
+        return jsonObject.toString();
+    }
+}

src/main/java/com/meilisearch/sdk/SearchRequest.java

@@ -46,6 +46,7 @@ public class SearchRequest {
     protected Hybrid hybrid;
     protected Double[] vector;
     protected Boolean retrieveVectors;
+    protected Boolean showPerformanceDetails;
     /**
      * Constructor for SearchRequest for building search queries with the default values: offset: 0,
      * limit: 20, attributesToRetrieve: ["*"], attributesToCrop: null, cropLength: 200,
@@ -110,7 +111,8 @@ public String toString() {
                         .putOpt("locales", this.locales)
                         .putOpt("distinct", this.distinct)
                         .putOpt("vector", this.vector)
-                        .putOpt("retrieveVectors", this.retrieveVectors);
+                        .putOpt("retrieveVectors", this.retrieveVectors)
+                        .putOpt("showPerformanceDetails", this.showPerformanceDetails);
 
         if (this.hybrid != null) {
             jsonObject.put("hybrid", this.hybrid.toJSONObject());

src/main/java/com/meilisearch/sdk/SimilarDocumentRequest.java

@@ -20,6 +20,7 @@ public class SimilarDocumentRequest {
     private Boolean showRankingScoreDetails;
     private Double rankingScoreThreshold;
     private Boolean retrieveVectors;
+    private Boolean showPerformanceDetails;
 
     /** Constructor for SimilarDocumentsRequest for building search request for similar documents */
     public SimilarDocumentRequest() {}
@@ -37,6 +38,7 @@ public String toString() {
         jsonObject.putOpt("showRankingScoreDetails", this.showRankingScoreDetails);
         jsonObject.putOpt("rankingScoreThreshold", this.rankingScoreThreshold);
         jsonObject.putOpt("retrieveVectors", this.retrieveVectors);
+        jsonObject.putOpt("showPerformanceDetails", this.showPerformanceDetails);
 
         return jsonObject.toString();
     }