Merge branch 'main' into jsr

Author: flevi29

.code-samples.meilisearch.yaml

@@ -417,47 +417,29 @@ primary_field_guide_add_document_primary_key: |-
       price: 5.00
     }
   ], { primaryKey: 'reference_number' })
-getting_started_add_documents_md: |-
-  ```bash
-  npm install meilisearch
-  ```
+getting_started_add_documents: |-
+  // With npm:
+  // npm install meilisearch
 
-  Or, if you are using `yarn`
-  ```bash
-  yarn add meilisearch
-  ```
+  // Or with yarn:
+  // yarn add meilisearch
 
-  **Import**
-
-  `require` syntax:
-  ```js
+  // In your .js file:
+  // With the `require` syntax:
   const { MeiliSearch } = require('meilisearch')
   const movies = require('./movies.json')
-  ```
-
-  `import` syntax:
-  ```js
+  // With the `import` syntax:
   import { MeiliSearch } from 'meilisearch'
   import movies from './movies.json'
-  ```
 
-  **Use**
-  ```js
   const client = new MeiliSearch({
     host: 'http://localhost:7700',
     apiKey: 'aSampleMasterKey'
   })
   client.index('movies').addDocuments(movies)
     .then((res) => console.log(res))
-  ```
-
-  [About this SDK](https://github.com/meilisearch/meilisearch-js/)
-getting_started_search_md: |-
-  ```js
+getting_started_search: |-
   client.index('movies').search('botman').then((res) => console.log(res))
-  ```
-
-  [About this SDK](https://github.com/meilisearch/meilisearch-js/)
 getting_started_update_ranking_rules: |-
   client.index('movies').updateRankingRules([
     'exactness',
@@ -528,8 +510,14 @@ get_filterable_attributes_1: |-
 update_filterable_attributes_1: |-
   client.index('movies')
     .updateFilterableAttributes([
-      'genres',
-      'director'
+      "genres",
+      {
+        attributePatterns: ["genre"],
+        features: {
+          facetSearch: true,
+          filter: { equality: true, comparison: false },
+        },
+      }
     ])
 reset_filterable_attributes_1: |-
   client.index('movies').resetFilterableAttributes()

.github/release-draft-template.yml

@@ -31,7 +31,5 @@ replacers:
     replace: ''
   - search: '/(?:and )?@dependabot(?:\[bot\])?,?/g'
     replace: ''
-  - search: '/(?:and )?@bors(?:\[bot\])?,?/g'
-    replace: ''
   - search: '/(?:and )?@meili-bot,?/g'
     replace: ''

.github/workflows/tests.yml

@@ -5,11 +5,9 @@ env:
 
 on:
   pull_request:
+  merge_group:
   push:
-    # trying and staging branches are for BORS config
     branches:
-      - trying
-      - staging
       - main
 
 jobs:

CONTRIBUTING.md

@@ -94,7 +94,7 @@ Some notes on GitHub PRs:
 
 - [Convert your PR as a draft](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request) if your changes are a work in progress: no one will review it until you pass your PR as ready for review.<br>
   The draft PR can be very useful if you want to show that you are working on something and make your work visible.
-- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md) to automatically enforce this requirement without the PR author having to do it manually.
+- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project uses [GitHub Merge Queues](https://github.blog/news-insights/product-news/github-merge-queue-is-generally-available/) to automatically enforce this requirement without the PR author having to rebase manually.
 - All PRs must be reviewed and approved by at least one maintainer.
 - The PR title should be accurate and descriptive of the changes. The title of the PR will be indeed automatically added to the next [release changelogs](https://github.com/meilisearch/meilisearch-js/releases/).
 
@@ -104,8 +104,7 @@ Meilisearch tools follow the [Semantic Versioning Convention](https://semver.org
 
 ### Automation to Rebase and Merge the PRs
 
-This project integrates a bot that helps us manage pull requests merging.<br>
-_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md)._
+This project uses GitHub Merge Queues that helps us manage pull requests merging.
 
 ### Automated Changelogs
 

README.md

@@ -20,7 +20,7 @@
   <a href="https://codecov.io/gh/meilisearch/meilisearch-js"><img src="https://codecov.io/github/meilisearch/meilisearch-js/coverage.svg?branch=main" alt="Codecov"></a>
   <a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg" alt="Prettier"></a>
   <a href="https://github.com/meilisearch/meilisearch-js/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
-  <a href="https://ms-bors.herokuapp.com/repositories/10"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
+  <a href="https://github.com/meilisearch/meilisearch-js/queue"><img alt="Merge Queues enabled" src="https://img.shields.io/badge/Merge_Queues-enabled-%2357cf60?logo=github"></a>
 </p>
 
 <p align="center">⚡ The Meilisearch API client written for JavaScript</p>
@@ -564,34 +564,16 @@ client.index('myIndex').getTasks(parameters: TasksQuery): Promise<TasksResults>
 client.index('myIndex').getTask(uid: number): Promise<Task>
 ```
 
-
 #### Wait for one task
 
-
-##### Using the client
-
-```ts
-client.waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise<Task>
-```
-
-##### Using the index
-
 ```ts
-client.index('myIndex').waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise<Task>
+client.tasks.waitForTask(uid: number, { timeout?: number, interval?: number }): Promise<Task>
 ```
 
 #### Wait for multiple tasks
 
-##### Using the client
-
-```ts
-client.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Task[]>
-```
-
-##### Using the index
-
 ```ts
-client.index('myIndex').waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Task[]>
+client.tasks.waitForTasks(uids: number[], { timeout?: number, interval?: number }): Promise<Task[]>
 ```
 
 ### Batches <!-- omit in toc -->

bors.toml

@@ -29,30 +29,12 @@ export default tseslint.config([
       },
     },
     rules: {
-      // TODO: Remove the ones between "~~", adapt code
-      // ~~
-      "@typescript-eslint/prefer-as-const": "off",
-      "@typescript-eslint/ban-ts-comment": "off",
-      "@typescript-eslint/no-unsafe-call": "off",
-      "@typescript-eslint/no-unsafe-member-access": "off",
-      "@typescript-eslint/no-unsafe-return": "off",
-      "@typescript-eslint/no-unsafe-assignment": "off",
-      "@typescript-eslint/no-unsafe-argument": "off",
-      "@typescript-eslint/no-floating-promises": "off",
-      // ~~
-      "@typescript-eslint/array-type": ["warn", { default: "array-simple" }],
-      // TODO: Should be careful with this rule, should leave it be and disable
-      //       it within files where necessary with explanations
-      "@typescript-eslint/no-explicit-any": "off",
       "@typescript-eslint/no-unused-vars": [
         "error",
         // argsIgnorePattern: https://eslint.org/docs/latest/rules/no-unused-vars#argsignorepattern
         // varsIgnorePattern: https://eslint.org/docs/latest/rules/no-unused-vars#varsignorepattern
         { args: "all", argsIgnorePattern: "^_", varsIgnorePattern: "^_" },
       ],
-      // TODO: Not recommended to disable rule, should instead disable locally
-      //       with explanation
-      "@typescript-eslint/ban-ts-ignore": "off",
     },
   },
   // Vitest

eslint.config.js

@@ -1,6 +1,6 @@
 {
   "name": "meilisearch",
-  "version": "0.49.0",
+  "version": "0.50.0",
   "description": "The Meilisearch JS client for Node.js and the browser.",
   "keywords": [
     "meilisearch",
@@ -36,7 +36,7 @@
   "sideEffects": false,
   "repository": {
     "type": "git",
-    "url": "https://github.com/meilisearch/meilisearch-js"
+    "url": "https://github.com/meilisearch/meilisearch-js.git"
   },
   "scripts": {
     "playground:javascript": "vite serve playgrounds/javascript --open",
@@ -70,25 +70,24 @@
     "CONTRIBUTING.md"
   ],
   "devDependencies": {
-    "@eslint/js": "^9.19.0",
-    "@types/eslint__js": "^8.42.3",
-    "@vitest/coverage-v8": "^3.0.7",
-    "@types/node": "^22.13.8",
-    "@typescript-eslint/utils": "^8.22.0",
-    "@vitest/eslint-plugin": "^1.1.25",
-    "eslint": "^9.21.0",
-    "eslint-config-prettier": "^10.0.2",
+    "@eslint/js": "^9.23.0",
+    "@vitest/coverage-v8": "^3.1.1",
+    "@types/node": "^22.13.15",
+    "@typescript-eslint/utils": "^8.29.0",
+    "@vitest/eslint-plugin": "^1.1.38",
+    "eslint": "^9.23.0",
+    "eslint-config-prettier": "^10.1.1",
     "eslint-plugin-tsdoc": "^0.4.0",
     "typescript": "^5.8.2",
-    "vite": "^6.2.0",
+    "vite": "^6.2.6",
     "globals": "^16.0.0",
     "husky": "^9.1.7",
-    "lint-staged": "15.4.3",
-    "prettier": "^3.5.2",
+    "lint-staged": "15.5.0",
+    "prettier": "^3.5.3",
     "prettier-plugin-jsdoc": "^1.3.2",
-    "typedoc": "^0.27.9",
-    "typescript-eslint": "^8.25.0",
-    "vitest": "^3.0.7"
+    "typedoc": "^0.28.1",
+    "typescript-eslint": "^8.29.0",
+    "vitest": "^3.1.1"
   },
   "packageManager": "[email protected]"
 }

package.json

@@ -12,23 +12,22 @@ const index = client.index<{ id: number; title: string; genres: string[] }>(
 export async function addDocuments(): Promise<void> {
   await client.deleteIndexIfExists(indexUid);
 
-  const task1 = await client.createIndex(indexUid);
-  await client.waitForTask(task1.taskUid);
-
-  const task2 = await index.addDocuments([
-    { id: 1, title: "Carol", genres: ["Romance", "Drama"] },
-    { id: 2, title: "Wonder Woman", genres: ["Action", "Adventure"] },
-    { id: 3, title: "Life of Pi", genres: ["Adventure", "Drama"] },
-    {
-      id: 4,
-      title: "Mad Max: Fury Road",
-      genres: ["Adventure", "Science Fiction"],
-    },
-    { id: 5, title: "Moana", genres: ["Fantasy", "Action"] },
-    { id: 6, title: "Philadelphia", genres: ["Drama"] },
-  ]);
-
-  await client.index(indexUid).waitForTask(task2.taskUid);
+  await client.createIndex(indexUid).waitTask();
+
+  await index
+    .addDocuments([
+      { id: 1, title: "Carol", genres: ["Romance", "Drama"] },
+      { id: 2, title: "Wonder Woman", genres: ["Action", "Adventure"] },
+      { id: 3, title: "Life of Pi", genres: ["Adventure", "Drama"] },
+      {
+        id: 4,
+        title: "Mad Max: Fury Road",
+        genres: ["Adventure", "Science Fiction"],
+      },
+      { id: 5, title: "Moana", genres: ["Fantasy", "Action"] },
+      { id: 6, title: "Philadelphia", genres: ["Drama"] },
+    ])
+    .waitTask();
 }
 
 export async function getAllHits(element: HTMLDivElement): Promise<void> {

playgrounds/javascript/src/meilisearch.ts

@@ -1,69 +1,38 @@
 import type {
-  Config,
-  BatchObject,
-  BatchesQuery,
+  Batch,
   BatchesResults,
-  BatchesResultsObject,
-} from "./types.js";
-import { HttpRequests } from "./http-requests.js";
-
-class Batch {
-  uid: BatchObject["uid"];
-  details: BatchObject["details"];
-  stats: BatchObject["stats"];
-  startedAt: BatchObject["startedAt"];
-  finishedAt: BatchObject["finishedAt"];
-  duration: BatchObject["duration"];
-  progress: BatchObject["progress"];
-
-  constructor(batch: BatchObject) {
-    this.uid = batch.uid;
-    this.details = batch.details;
-    this.stats = batch.stats;
-    this.startedAt = batch.startedAt;
-    this.finishedAt = batch.finishedAt;
-    this.duration = batch.duration;
-    this.progress = batch.progress;
-  }
-}
-
-class BatchClient {
-  httpRequest: HttpRequests;
-
-  constructor(config: Config) {
-    this.httpRequest = new HttpRequests(config);
+  TasksOrBatchesQuery,
+} from "./types/index.js";
+import type { HttpRequests } from "./http-requests.js";
+
+/**
+ * Class for handling batches.
+ *
+ * @see {@link https://www.meilisearch.com/docs/reference/api/batches}
+ */
+export class BatchClient {
+  readonly #httpRequest: HttpRequests;
+
+  constructor(httpRequests: HttpRequests) {
+    this.#httpRequest = httpRequests;
   }
 
-  /**
-   * Get one batch
-   *
-   * @param uid - Unique identifier of the batch
-   * @returns
-   */
+  /** {@link https://www.meilisearch.com/docs/reference/api/batches#get-one-batch} */
   async getBatch(uid: number): Promise<Batch> {
-    const batch = await this.httpRequest.get<BatchObject>({
+    const batch = await this.#httpRequest.get<Batch>({
       path: `batches/${uid}`,
     });
-    return new Batch(batch);
+    return batch;
   }
 
-  /**
-   * Get batches
-   *
-   * @param parameters - Parameters to browse the batches
-   * @returns Promise containing all batches
-   */
-  async getBatches(batchesQuery?: BatchesQuery): Promise<BatchesResults> {
-    const batches = await this.httpRequest.get<BatchesResultsObject>({
+  /** {@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,
-      results: batches.results.map((batch) => new Batch(batch)),
-    };
+    return batches;
   }
 }
-
-export { BatchClient, Batch };