Merge branch 'main' into meili-bot/v0-30-code-samples

Author: bidoubiwa

CONTRIBUTING.md

@@ -142,7 +142,7 @@ Here are the steps to release a beta version of this package:
       ```bash
         git checkout -b my-feature-beta
       ```
-    - During the Meilisearch pre-release, create a branch originating from `bump-meilisearch-v*.*.*` named `meilisearch-v*.*.*-beta`. <br>
+    - During the Meilisearch pre-release, create a branch originating from `bump-meilisearch-v*.*.*` named `bump-meilisearch-v*.*.*-beta`. <br>
     `v*.*.*` is the next version of the package, NOT the version of Meilisearch!
 
       ```bash

README.md

@@ -329,7 +329,7 @@ controller.abort()
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.29.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.29.0).
+This package only guarantees the compatibility with the [version v0.30.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.30.0).
 
 ## 💡 Learn more
 
@@ -432,6 +432,18 @@ client.getTasks(parameters: TasksQuery): Promise<TasksResults>
 client.getTask(uid: number): Promise<Task>
 ```
 
+#### [Delete tasks](https://docs.meilisearch.com/reference/api/tasks.html#delete-task)
+
+```ts
+client.deleteTasks(parameters: DeleteTasksQuery = {}): Promise<EnqueuedTask>
+```
+
+#### [Cancel tasks](https://docs.meilisearch.com/reference/api/tasks.html#cancel-task)
+
+```ts
+client.cancelTasks(parameters: CancelTasksQuery = {}): Promise<EnqueuedTask>
+```
+
 #### [Get all tasks of an index](https://docs.meilisearch.com/reference/api/tasks.html#get-all-tasks-by-index)
 
 ```ts
@@ -444,6 +456,7 @@ client.index('myIndex').getTasks(parameters: TasksQuery): Promise<TasksResults>
 client.index('myIndex').getTask(uid: number): Promise<Task>
 ```
 
+
 #### Wait for one task
 
 
@@ -562,6 +575,12 @@ client.index('myIndex').fetchInfo(): Promise<Index>
 client.index('myIndex').fetchPrimaryKey(): Promise<string | undefined>
 ```
 
+##### Swap two indexes
+
+```ts
+client.swapIndexes(params: SwapIndexesParams): Promise<EnqueuedTask>
+```
+
 ### Settings <!-- omit in toc -->
 
 #### [Get settings](https://docs.meilisearch.com/reference/api/settings.html#get-settings)

src/clients/client.ts

@@ -29,6 +29,9 @@ import {
   KeysResults,
   TasksResults,
   EnqueuedTaskObject,
+  SwapIndexesParams,
+  CancelTasksQuery,
+  DeleteTasksQuery,
 } from '../types'
 import { HttpRequests } from '../http-requests'
 import { TaskClient, Task } from '../task'
@@ -184,6 +187,19 @@ class Client {
     }
   }
 
+  /**
+   * Swaps a list of index tuples.
+   *
+   * @memberof MeiliSearch
+   * @method swapIndexes
+   * @param {SwapIndexesParams} params - List of indexes tuples to swap.
+   * @returns {Promise<EnqueuedTask>} - Promise returning object of the enqueued task
+   */
+  async swapIndexes(params: SwapIndexesParams): Promise<EnqueuedTask> {
+    const url = '/swap-indexes'
+    return await this.httpRequest.post(url, params)
+  }
+
   ///
   /// TASKS
   ///
@@ -252,6 +268,30 @@ class Client {
     })
   }
 
+  /**
+   * Cancel a list of enqueued or processing tasks.
+   * @memberof MeiliSearch
+   * @method cancelTasks
+   * @param {CancelTasksQuery} [parameters={}] - Parameters to filter the tasks.
+   *
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
+   */
+  async cancelTasks(parameters: CancelTasksQuery): Promise<EnqueuedTask> {
+    return await this.tasks.cancelTasks(parameters)
+  }
+
+  /**
+   * Delete a list of tasks.
+   * @memberof MeiliSearch
+   * @method deleteTasks
+   * @param {DeleteTasksQuery} [parameters={}] - Parameters to filter the tasks.
+   *
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
+   */
+  async deleteTasks(parameters: DeleteTasksQuery = {}): Promise<EnqueuedTask> {
+    return await this.tasks.deleteTasks(parameters)
+  }
+
   ///
   /// KEYS
   ///

src/http-requests.ts

@@ -11,6 +11,25 @@ import {
 
 import { addTrailingSlash, addProtocolIfNotPresent } from './utils'
 
+type queryParams<T> = { [key in keyof T]: string }
+
+function toQueryParams<T extends object>(parameters: T): queryParams<T> {
+  const params = Object.keys(parameters) as Array<keyof T>
+
+  const queryParams = params.reduce<queryParams<T>>((acc, key) => {
+    const value = parameters[key]
+    if (value === undefined) {
+      return acc
+    } else if (Array.isArray(value)) {
+      return { ...acc, [key]: value.join(',') }
+    } else if (value instanceof Date) {
+      return { ...acc, [key]: value.toISOString() }
+    }
+    return { ...acc, [key]: value }
+  }, {} as queryParams<T>)
+  return queryParams
+}
+
 function constructHostURL(host: string): string {
   try {
     host = addProtocolIfNotPresent(host)
@@ -219,4 +238,4 @@ class HttpRequests {
   }
 }
 
-export { HttpRequests }
+export { HttpRequests, toQueryParams }

src/indexes.ts

@@ -244,7 +244,7 @@ class Index<T = Record<string, any>> {
    * @returns {Promise<TasksResults>} - Promise containing all tasks
    */
   async getTasks(parameters: TasksQuery = {}): Promise<TasksResults> {
-    return await this.tasks.getTasks({ ...parameters, indexUid: [this.uid] })
+    return await this.tasks.getTasks({ ...parameters, indexUids: [this.uid] })
   }
 
   /**

src/task.ts

@@ -6,17 +6,20 @@ import {
   TasksQuery,
   TasksResults,
   TaskObject,
+  CancelTasksQuery,
   TasksResultsObject,
+  DeleteTasksQuery,
 } from './types'
-import { HttpRequests } from './http-requests'
-import { removeUndefinedFromObject, sleep } from './utils'
+import { HttpRequests, toQueryParams } from './http-requests'
+import { sleep } from './utils'
+import { EnqueuedTask } from './enqueued-task'
 
 class Task {
   indexUid: TaskObject['indexUid']
   status: TaskObject['status']
   type: TaskObject['type']
   uid: TaskObject['uid']
-  batchUid: TaskObject['batchUid']
+  canceledBy: TaskObject['canceledBy']
   details: TaskObject['details']
   error: TaskObject['error']
   duration: TaskObject['duration']
@@ -29,8 +32,8 @@ class Task {
     this.status = task.status
     this.type = task.type
     this.uid = task.uid
-    this.batchUid = task.batchUid
     this.details = task.details
+    this.canceledBy = task.canceledBy
     this.error = task.error
     this.duration = task.duration
 
@@ -70,17 +73,9 @@ class TaskClient {
   async getTasks(parameters: TasksQuery = {}): Promise<TasksResults> {
     const url = `tasks`
 
-    const queryParams = {
-      indexUid: parameters?.indexUid?.join(','),
-      type: parameters?.type?.join(','),
-      status: parameters?.status?.join(','),
-      from: parameters.from,
-      limit: parameters.limit,
-    }
-
     const tasks = await this.httpRequest.get<Promise<TasksResultsObject>>(
       url,
-      removeUndefinedFromObject(queryParams)
+      toQueryParams<TasksQuery>(parameters)
     )
 
     return {
@@ -139,6 +134,45 @@ class TaskClient {
     }
     return tasks
   }
+
+  /**
+   * Cancel a list of enqueued or processing tasks.
+   * @memberof Tasks
+   * @method cancelTasks
+   * @param {CancelTasksQuery} [parameters={}] - Parameters to filter the tasks.
+   *
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
+   */
+  async cancelTasks(parameters: CancelTasksQuery = {}): Promise<EnqueuedTask> {
+    const url = `tasks/cancel`
+
+    const task = await this.httpRequest.post(
+      url,
+      {},
+      toQueryParams<CancelTasksQuery>(parameters)
+    )
+
+    return new EnqueuedTask(task)
+  }
+
+  /**
+   * Delete a list tasks.
+   * @memberof Tasks
+   * @method deleteTasks
+   * @param {DeleteTasksQuery} [parameters={}] - Parameters to filter the tasks.
+   *
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
+   */
+  async deleteTasks(parameters: DeleteTasksQuery = {}): Promise<EnqueuedTask> {
+    const url = `tasks`
+
+    const task = await this.httpRequest.delete(
+      url,
+      {},
+      toQueryParams<DeleteTasksQuery>(parameters)
+    )
+    return new EnqueuedTask(task)
+  }
 }
 
 export { TaskClient, Task }