Merge with main

Author: flevi29

.code-samples.meilisearch.yaml

@@ -99,35 +99,35 @@ multi_search_1: |-
     },
   ]})
 get_all_tasks_1: |-
-  client.getTasks()
+  client.tasks.getTasks()
 get_task_1: |-
-  client.getTask(1)
+  client.tasks.getTask(1)
 async_guide_filter_by_date_1: |-
-  client.getTasks({ afterEnqueuedAt: '2020-10-11T11:49:53.000Z' })
+  client.tasks.getTasks({ afterEnqueuedAt: '2020-10-11T11:49:53.000Z' })
 async_guide_multiple_filters_1: |-
-  client.getTasks({
+  client.tasks.getTasks({
     indexUids: ['movies'],
     types: ['documentAdditionOrUpdate','documentDeletion'],
     statuses: ['processing']
   })
 async_guide_filter_by_ids_1: |-
-  client.getTasks({ uids: [5, 10, 13] })
+  client.tasks.getTasks({ uids: [5, 10, 13] })
 async_guide_filter_by_statuses_1: |-
-  client.getTasks({ statuses: ['failed', 'canceled'] })
+  client.tasks.getTasks({ statuses: ['failed', 'canceled'] })
 async_guide_filter_by_types_1: |-
-  client.getTasks({ types: ['dumpCreation', 'indexSwap'] })
+  client.tasks.getTasks({ types: ['dumpCreation', 'indexSwap'] })
 async_guide_filter_by_index_uids_1: |-
-  client.getTasks({ indexUids: ['movies'] })
+  client.tasks.getTasks({ indexUids: ['movies'] })
 get_all_tasks_paginating_1: |-
-  client.getTasks({ limit: 2, from: 10 })
+  client.tasks.getTasks({ limit: 2, from: 10 })
 get_all_tasks_paginating_2: |-
-  client.getTasks({ limit: 2, from: 8 })
+  client.tasks.getTasks({ limit: 2, from: 8 })
 async_guide_canceled_by_1: |-
-  client.getTasks({ canceledBy: [9, 15] })
+  client.tasks.getTasks({ canceledBy: [9, 15] })
 delete_tasks_1: |-
-  client.deleteTasks({ uids: [1, 2] })
+  client.tasks.deleteTasks({ uids: [1, 2] })
 cancel_tasks_1: |-
-  client.cancelTasks({ uids: [1, 2] })
+  client.tasks.cancelTasks({ uids: [1, 2] })
 get_one_key_1: |-
   client.getKey('6062abda-a5aa-4414-ac91-ecd7944c0f8d')
 get_all_keys_1: |-
@@ -458,7 +458,7 @@ getting_started_update_searchable_attributes: |-
 getting_started_update_stop_words: |-
   client.index('movies').updateStopWords(['the'])
 getting_started_check_task_status: |-
-  client.getTask(0)
+  client.tasks.getTask(0)
 getting_started_synonyms: |-
   client.index('movies').updateSynonyms({
     winnie: ['piglet'],
@@ -806,9 +806,9 @@ update_prefix_search_settings_1: |-
 reset_prefix_search_settings_1: |-
   client.index('INDEX_NAME').resetPrefixSearch();
 get_all_batches_1: |-
-  client.getBatches();
+  client.batches.getBatches();
 get_batch_1: |-
-  client.getBatch(BATCH_UID);
+  client.batches.getBatch(BATCH_UID);
 # Vector search
 update_embedders_1: |-
   client.index('INDEX_NAME').updateEmbedders({

.github/workflows/meilisearch-prototype-tests.yml

@@ -46,7 +46,7 @@ jobs:
           - '7700:7700'
     strategy:
       matrix:
-        node: ['18', '20', '22']
+        node: ['20', '22']
     name: integration-tests (Node.js ${{ matrix.node }})
     steps:
       - uses: actions/checkout@v4

.github/workflows/pre-release-tests.yml

@@ -43,7 +43,7 @@ jobs:
           - '7700:7700'
     strategy:
       matrix:
-        node: ['18', '20', '22']
+        node: ['20', '22']
     name: integration-tests (Node.js ${{ matrix.node }})
     steps:
       - uses: actions/checkout@v4

.github/workflows/tests.yml

@@ -36,7 +36,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: ['18', '20', '22']
+        node: ['20', '22']
     name: integration-tests (Node.js ${{ matrix.node }})
     steps:
       - uses: actions/checkout@v4

CONTRIBUTING.md

@@ -34,7 +34,7 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume
 
 To run this project, you will need:
 
-- Node >= v18 and Node <= 22
+- Node >= v20 and Node <= 22
 - Yarn v1.x
 
 ### Setup

docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   package:
-    image: node:18
+    image: node:22
     tty: true
     stdin_open: true
     working_dir: /home/package

package.json

@@ -71,21 +71,21 @@
   "devDependencies": {
     "@eslint/js": "^9.23.0",
     "@vitest/coverage-v8": "^3.1.1",
-    "@types/node": "^22.15.3",
+    "@types/node": "^22.15.29",
     "@typescript-eslint/utils": "^8.29.0",
-    "@vitest/eslint-plugin": "^1.1.38",
-    "eslint": "^9.25.1",
+    "@vitest/eslint-plugin": "^1.2.1",
+    "eslint": "^9.28.0",
     "eslint-config-prettier": "^10.1.2",
     "eslint-plugin-tsdoc": "^0.4.0",
     "typescript": "^5.8.3",
-    "vite": "^6.3.4",
-    "globals": "^16.0.0",
+    "vite": "^6.3.5",
+    "globals": "^16.2.0",
     "husky": "^9.1.7",
-    "lint-staged": "15.5.1",
+    "lint-staged": "16.1.0",
     "prettier": "^3.5.3",
     "prettier-plugin-jsdoc": "^1.3.2",
-    "typedoc": "^0.28.3",
-    "typescript-eslint": "^8.31.1",
+    "typedoc": "^0.28.5",
+    "typescript-eslint": "^8.33.0",
     "vitest": "^3.1.1"
   },
   "packageManager": "[email protected]"

src/batch.ts

@@ -19,20 +19,11 @@ export class BatchClient {
 
   /** {@link https://www.meilisearch.com/docs/reference/api/batches#get-one-batch} */
   async getBatch(uid: number): Promise<Batch> {
-    const batch = await this.#httpRequest.get<Batch>({
-      path: `batches/${uid}`,
-    });
-    return batch;
+    return await this.#httpRequest.get({ path: `batches/${uid}` });
   }
 
   /** {@link https://www.meilisearch.com/docs/reference/api/batches#get-batches} */
-  async getBatches(
-    batchesQuery?: TasksOrBatchesQuery,
-  ): Promise<BatchesResults> {
-    const batches = await this.#httpRequest.get<BatchesResults>({
-      path: "batches",
-      params: batchesQuery,
-    });
-    return batches;
+  async getBatches(params?: TasksOrBatchesQuery): Promise<BatchesResults> {
+    return await this.#httpRequest.get({ path: "batches", params });
   }
 }

src/http-requests.ts

@@ -69,9 +69,8 @@ function getHeaders(config: Config, headersInit?: HeadersInit): Headers {
   return headers;
 }
 
-// TODO: Convert to Symbol("timeout id") when Node.js 18 is dropped
 /** Used to identify whether an error is a timeout error after fetch request. */
-const TIMEOUT_ID = {};
+const TIMEOUT_ID = Symbol("<timeout>");
 
 /**
  * Attach a timeout signal to a {@link RequestInit}, while preserving original

src/task.ts

@@ -12,12 +12,11 @@ import type {
 } from "./types/index.js";
 import type { HttpRequests } from "./http-requests.js";
 
-// TODO: Convert to Symbol("timeout id") when Node.js 18 is dropped
 /**
  * Used to identify whether an error is a timeout error in
  * {@link TaskClient.waitForTask}.
  */
-const TIMEOUT_ID = {};
+const TIMEOUT_ID = Symbol("<task timeout>");
 
 /**
  * @returns A function which defines an extra function property on a
@@ -74,24 +73,20 @@ export class TaskClient {
     // TODO: Need to do this for all other methods: https://github.com/meilisearch/meilisearch-js/issues/1476
     extraRequestInit?: ExtraRequestInit,
   ): Promise<Task> {
-    const task = await this.#httpRequest.get<Task>({
+    return await this.#httpRequest.get({
       path: `tasks/${uid}`,
       extraRequestInit,
     });
-    return task;
   }
 
   /** {@link https://www.meilisearch.com/docs/reference/api/tasks#get-tasks} */
   async getTasks(params?: TasksOrBatchesQuery): Promise<TasksResults> {
-    const tasks = await this.#httpRequest.get<TasksResults>({
-      path: "tasks",
-      params,
-    });
-    return tasks;
+    return await this.#httpRequest.get({ path: "tasks", params });
   }
 
   /**
-   * Wait for an enqueued task to be processed.
+   * Wait for an enqueued task to be processed. This is done through polling
+   * with {@link TaskClient.getTask}.
    *
    * @remarks
    * If an {@link EnqueuedTask} needs to be awaited instantly, it is recommended
@@ -167,20 +162,14 @@ export class TaskClient {
   /** {@link https://www.meilisearch.com/docs/reference/api/tasks#cancel-tasks} */
   cancelTasks(params: DeleteOrCancelTasksQuery): EnqueuedTaskPromise {
     return this.#applyWaitTask(
-      this.#httpRequest.post({
-        path: "tasks/cancel",
-        params,
-      }),
+      this.#httpRequest.post({ path: "tasks/cancel", params }),
     );
   }
 
   /** {@link https://www.meilisearch.com/docs/reference/api/tasks#delete-tasks} */
   deleteTasks(params: DeleteOrCancelTasksQuery): EnqueuedTaskPromise {
     return this.#applyWaitTask(
-      this.#httpRequest.delete({
-        path: "tasks",
-        params,
-      }),
+      this.#httpRequest.delete({ path: "tasks", params }),
     );
   }
 }