Changes related to the next Meilisearch release (v0.30.0)

.github/workflows/tests.yml

@@ -26,8 +26,8 @@ jobs:
         cache: gradle
     - name: Grant execute permission for gradlew
       run: chmod +x gradlew
-    - name: Meilisearch (v0.29.3 version) setup with Docker
-      run: docker run -d -p 7700:7700 getmeili/meilisearch:v0.29.3 meilisearch --no-analytics --master-key='masterKey'
+    - name: Meilisearch (v0.30.5 version) setup with Docker
+      run: docker run -d -p 7700:7700 getmeili/meilisearch:v0.30.5 meilisearch --no-analytics --master-key='masterKey'
     - name: Build and run unit and integration tests
       run: ./gradlew build integrationTest
     - name: Archive test report

README.md

@@ -263,7 +263,7 @@ Client client = new Client(config);
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees compatibility with the [version v0.29.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.29.0).
+This package only guarantees compatibility with the [version v0.30.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.30.0).
 
 ## 💡 Learn more
 

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

@@ -7,12 +7,15 @@
 import com.auth0.jwt.algorithms.Algorithm;
 import com.meilisearch.sdk.exceptions.MeilisearchException;
 import com.meilisearch.sdk.json.JsonHandler;
+import com.meilisearch.sdk.model.CancelTasksQuery;
+import com.meilisearch.sdk.model.DeleteTasksQuery;
 import com.meilisearch.sdk.model.IndexesQuery;
 import com.meilisearch.sdk.model.Key;
 import com.meilisearch.sdk.model.KeyUpdate;
 import com.meilisearch.sdk.model.KeysQuery;
 import com.meilisearch.sdk.model.Results;
 import com.meilisearch.sdk.model.Stats;
+import com.meilisearch.sdk.model.SwapIndexesParams;
 import com.meilisearch.sdk.model.Task;
 import com.meilisearch.sdk.model.TaskInfo;
 import com.meilisearch.sdk.model.TasksQuery;
@@ -175,6 +178,18 @@ public TaskInfo deleteIndex(String uid) throws MeilisearchException {
         return this.indexesHandler.deleteIndex(uid);
     }
 
+    /**
+     * Swap the documents, settings, and task history of two or more indexes
+     * https://docs.meilisearch.com/reference/api/indexes.html#swap-indexes
+     *
+     * @param param accepted by the swap-indexes route
+     * @return Meilisearch API response as TaskInfo
+     * @throws MeilisearchException if an error occurs
+     */
+    public TaskInfo swapIndexes(SwapIndexesParams[] param) throws MeilisearchException {
+        return config.httpClient.post("/swap-indexes", param, TaskInfo.class);
+    }
+
     /**
      * Triggers the creation of a Meilisearch dump.
      * https://docs.meilisearch.com/reference/api/dump.html#create-a-dump
@@ -264,6 +279,30 @@ public TasksResults getTasks(TasksQuery param) throws MeilisearchException {
         return this.tasksHandler.getTasks(param);
     }
 
+    /**
+     * Cancel any number of enqueued or processing tasks
+     * https://docs.meilisearch.com/reference/api/tasks.html#cancel-tasks
+     *
+     * @param param accept by the tasks route
+     * @return Meilisearch API response as TaskInfo
+     * @throws MeilisearchException if an error occurs
+     */
+    public TaskInfo cancelTasks(CancelTasksQuery param) throws MeilisearchException {
+        return this.tasksHandler.cancelTasks(param);
+    }
+
+    /**
+     * Delete a finished (succeeded, failed, or canceled) task
+     * https://docs.meilisearch.com/reference/api/tasks.html#delete-tasks
+     *
+     * @param param accept by the tasks route
+     * @return Meilisearch API response as TaskInfo
+     * @throws MeilisearchException if an error occurs
+     */
+    public TaskInfo deleteTasks(DeleteTasksQuery param) throws MeilisearchException {
+        return this.tasksHandler.deleteTasks(param);
+    }
+
     /**
      * Waits for a task to be processed
      *

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

@@ -6,6 +6,7 @@
 import com.meilisearch.sdk.model.IndexStats;
 import com.meilisearch.sdk.model.Results;
 import com.meilisearch.sdk.model.SearchResult;
+import com.meilisearch.sdk.model.Searchable;
 import com.meilisearch.sdk.model.Settings;
 import com.meilisearch.sdk.model.Task;
 import com.meilisearch.sdk.model.TaskInfo;
@@ -345,7 +346,7 @@ public SearchResult search(String q) throws MeilisearchException {
      * @return Meilisearch API response
      * @throws MeilisearchException if an error occurs
      */
-    public SearchResult search(SearchRequest searchRequest) throws MeilisearchException {
+    public Searchable search(SearchRequest searchRequest) throws MeilisearchException {
         return this.search.search(this.uid, searchRequest);
     }
 

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

@@ -2,6 +2,8 @@
 
 import com.meilisearch.sdk.exceptions.MeilisearchException;
 import com.meilisearch.sdk.model.SearchResult;
+import com.meilisearch.sdk.model.SearchResultPaginated;
+import com.meilisearch.sdk.model.Searchable;
 
 /**
  * Class used for searching on Meilisearch indexes
@@ -67,7 +69,10 @@ SearchResult search(String uid, String q) throws MeilisearchException {
      * @return search results
      * @throws MeilisearchException Search Exception or Client Error
      */
-    SearchResult search(String uid, SearchRequest sr) throws MeilisearchException {
+    Searchable search(String uid, SearchRequest sr) throws MeilisearchException {
+        if (sr != null && (sr.getPage() != null || sr.getHitsPerPage() != null)) {
+            return httpClient.jsonHandler.decode(rawSearch(uid, sr), SearchResultPaginated.class);
+        }
         return httpClient.jsonHandler.decode(rawSearch(uid, sr), SearchResult.class);
     }
 }

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

@@ -34,6 +34,8 @@ public class SearchRequest {
     private Boolean showMatchesPosition;
     private String[] facets;
     private String[] sort;
+    protected Integer page;
+    protected Integer hitsPerPage;
 
     /**
      * Constructor for SearchRequest for building search queries with the default values: offset: 0,
@@ -85,6 +87,8 @@ public String toString() {
                         .put("showMatchesPosition", this.showMatchesPosition)
                         .put("facets", this.facets)
                         .put("sort", this.sort)
+                        .put("page", this.page)
+                        .put("hitsPerPage", this.hitsPerPage)
                         .putOpt("attributesToCrop", this.attributesToCrop)
                         .putOpt("attributesToHighlight", this.attributesToHighlight)
                         .putOpt("filter", this.filter)

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

@@ -3,7 +3,10 @@
 import com.meilisearch.sdk.exceptions.MeilisearchException;
 import com.meilisearch.sdk.exceptions.MeilisearchTimeoutException;
 import com.meilisearch.sdk.http.URLBuilder;
+import com.meilisearch.sdk.model.CancelTasksQuery;
+import com.meilisearch.sdk.model.DeleteTasksQuery;
 import com.meilisearch.sdk.model.Task;
+import com.meilisearch.sdk.model.TaskInfo;
 import com.meilisearch.sdk.model.TasksQuery;
 import com.meilisearch.sdk.model.TasksResults;
 import java.util.Date;
@@ -88,18 +91,40 @@ TasksResults getTasks(String indexUid) throws MeilisearchException {
      * @throws MeilisearchException if client request causes an error
      */
     TasksResults getTasks(String indexUid, TasksQuery param) throws MeilisearchException {
-        String[] newIndexUid = new String[param.getIndexUid().length + 1];
-        if (param != null && param.getIndexUid() != null) {
-            for (int i = 0; i < param.getIndexUid().length; i++)
-                newIndexUid[i] = param.getIndexUid()[i];
-            newIndexUid[param.getIndexUid().length] = indexUid;
-        }
+        param = addIndexUidToQuery(indexUid, param);
 
         TasksResults result =
                 httpClient.get(tasksPath().addQuery(param.toQuery()).getURL(), TasksResults.class);
         return result;
     }
 
+    /**
+     * Delete tasks from the client
+     *
+     * @param param accept by the tasks route
+     * @return Meilisearch API response as TaskInfo
+     * @throws MeilisearchException if client request causes an error
+     */
+    TaskInfo cancelTasks(CancelTasksQuery param) throws MeilisearchException {
+        URLBuilder urlb = tasksPath().addSubroute("cancel");
+        TaskInfo result =
+                httpClient.post(urlb.addQuery(param.toQuery()).getURL(), null, TaskInfo.class);
+        return result;
+    }
+
+    /**
+     * Delete tasks from the client
+     *
+     * @param param accept by the tasks route
+     * @return Meilisearch API response as TaskInfo
+     * @throws MeilisearchException if client request causes an error
+     */
+    TaskInfo deleteTasks(DeleteTasksQuery param) throws MeilisearchException {
+        TaskInfo result =
+                httpClient.delete(tasksPath().addQuery(param.toQuery()).getURL(), TaskInfo.class);
+        return result;
+    }
+
     /**
      * Waits for a task to be processed
      *
@@ -143,4 +168,20 @@ void waitForTask(int taskUid, int timeoutInMs, int intervalInMs) throws Meilisea
     private URLBuilder tasksPath() {
         return new URLBuilder("/tasks");
     }
+
+    /** Add index uid to index uids list in task query */
+    TasksQuery addIndexUidToQuery(String indexUid, TasksQuery param) {
+        if (param != null && param.getIndexUids() != null) {
+            String[] newIndexUid = new String[param.getIndexUids().length + 1];
+            for (int i = 0; i < param.getIndexUids().length; i++)
+                newIndexUid[i] = param.getIndexUids()[i];
+            newIndexUid[param.getIndexUids().length] = indexUid;
+            param.setIndexUids(newIndexUid);
+        } else if (param != null) {
+            param.setIndexUids(new String[] {indexUid});
+        } else {
+            param = new TasksQuery().setIndexUids(new String[] {indexUid});
+        }
+        return param;
+    }
 }

src/main/java/com/meilisearch/sdk/http/URLBuilder.java

@@ -1,5 +1,8 @@
 package com.meilisearch.sdk.http;
 
+import java.text.SimpleDateFormat;
+import java.util.Arrays;
+import java.util.Date;
 import lombok.Getter;
 
 @Getter
@@ -52,6 +55,27 @@ public URLBuilder addParameter(String parameter, String[] value) {
         return this;
     }
 
+    public URLBuilder addParameter(String parameter, int[] value) {
+        if (value != null && value.length > 0) {
+            addSeparator();
+            params.append(parameter);
+            params.append("=");
+            params.append(formatArrayParameters(value));
+        }
+        return this;
+    }
+
+    public URLBuilder addParameter(String parameter, Date value) {
+        if (value != null) {
+            SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd");
+            addSeparator();
+            params.append(parameter);
+            params.append("=");
+            params.append(formatter.format(value));
+        }
+        return this;
+    }
+
     public URLBuilder addQuery(String query) {
         this.params.append(query);
         return this;
@@ -70,6 +94,11 @@ private String formatArrayParameters(String[] fields) {
         return String.join(",", fields);
     }
 
+    private String formatArrayParameters(int[] fields) {
+        String[] arr = Arrays.stream(fields).mapToObj(String::valueOf).toArray(String[]::new);
+        return String.join(",", arr);
+    }
+
     public String getURL() {
         return routes.toString() + params.toString();
     }

src/main/java/com/meilisearch/sdk/model/CancelTasksQuery.java

@@ -0,0 +1,42 @@
+package com.meilisearch.sdk.model;
+
+import com.meilisearch.sdk.http.URLBuilder;
+import java.util.Date;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+/**
+ * Data structure of a query parameter for tasks route
+ *
+ * <p>https://docs.meilisearch.com/reference/api/tasks.html#query-parameters
+ */
+@Setter
+@Getter
+@Accessors(chain = true)
+public class CancelTasksQuery {
+    private int[] uids;
+    private String[] statuses;
+    private String[] types;
+    private String[] indexUids;
+    private Date beforeEnqueuedAt;
+    private Date afterEnqueuedAt;
+    private Date beforeStartedAt;
+    private Date afterStartedAt;
+
+    public CancelTasksQuery() {}
+
+    public String toQuery() {
+        URLBuilder urlb =
+                new URLBuilder()
+                        .addParameter("uids", this.getUids())
+                        .addParameter("statuses", this.getStatuses())
+                        .addParameter("types", this.getTypes())
+                        .addParameter("indexUids", this.getIndexUids())
+                        .addParameter("beforeEnqueuedAt", this.getBeforeEnqueuedAt())
+                        .addParameter("afterEnqueuedAt", this.getAfterEnqueuedAt())
+                        .addParameter("beforeStartedAt", this.getBeforeStartedAt())
+                        .addParameter("afterStartedAt", this.getAfterStartedAt());
+        return urlb.getURL();
+    }
+}

src/main/java/com/meilisearch/sdk/model/DeleteTasksQuery.java

@@ -0,0 +1,48 @@
+package com.meilisearch.sdk.model;
+
+import com.meilisearch.sdk.http.URLBuilder;
+import java.util.Date;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+/**
+ * Data structure of a query parameter for tasks route
+ *
+ * <p>https://docs.meilisearch.com/reference/api/tasks.html#query-parameters
+ */
+@Setter
+@Getter
+@Accessors(chain = true)
+public class DeleteTasksQuery {
+    private int[] uids;
+    private String[] statuses;
+    private String[] types;
+    private String[] indexUids;
+    private int[] canceledBy;
+    private Date beforeEnqueuedAt;
+    private Date afterEnqueuedAt;
+    private Date beforeStartedAt;
+    private Date afterStartedAt;
+    private Date beforeFinishedAt;
+    private Date afterFinishedAt;
+
+    public DeleteTasksQuery() {}
+
+    public String toQuery() {
+        URLBuilder urlb =
+                new URLBuilder()
+                        .addParameter("uids", this.getUids())
+                        .addParameter("statuses", this.getStatuses())
+                        .addParameter("types", this.getTypes())
+                        .addParameter("indexUids", this.getIndexUids())
+                        .addParameter("canceledBy", this.getCanceledBy())
+                        .addParameter("beforeEnqueuedAt", this.getBeforeEnqueuedAt())
+                        .addParameter("afterEnqueuedAt", this.getAfterEnqueuedAt())
+                        .addParameter("beforeStartedAt", this.getBeforeStartedAt())
+                        .addParameter("afterStartedAt", this.getAfterStartedAt())
+                        .addParameter("beforeFinishedAt", this.getBeforeFinishedAt())
+                        .addParameter("afterFinishedAt", this.getAfterFinishedAt());
+        return urlb.getURL();
+    }
+}

src/main/java/com/meilisearch/sdk/model/Faceting.java

@@ -0,0 +1,12 @@
+package com.meilisearch.sdk.model;
+
+import lombok.Getter;
+import lombok.Setter;
+
+@Setter
+@Getter
+public class Faceting {
+    protected int maxValuesPerFacet;
+
+    public Faceting() {}
+}

src/main/java/com/meilisearch/sdk/model/Pagination.java

@@ -0,0 +1,12 @@
+package com.meilisearch.sdk.model;
+
+import lombok.Getter;
+import lombok.Setter;
+
+@Setter
+@Getter
+public class Pagination {
+    protected int maxTotalHits;
+
+    public Pagination() {}
+}