Merge branch 'main' into token-web-crypto

Author: flevi29

.code-samples.meilisearch.yaml

@@ -805,3 +805,19 @@ update_localized_attribute_settings_1: |-
   ];)
 reset_localized_attribute_settings_1: |-
   client.index('INDEX_NAME').resetLocalizedAttributes()
+get_facet_search_settings_1: |-
+  client.index('INDEX_NAME').getFacetSearch();
+update_facet_search_settings_1: |-
+  client.index('INDEX_NAME').updateFacetSearch(false);
+reset_facet_search_settings_1: |-
+  client.index('INDEX_NAME').resetFacetSearch();
+get_prefix_search_settings_1: |-
+  client.index('INDEX_NAME').getPrefixSearch();
+update_prefix_search_settings_1: |-
+  client.index('INDEX_NAME').updatePrefixSearch('disabled');
+reset_prefix_search_settings_1: |-
+  client.index('INDEX_NAME').resetPrefixSearch();
+get_all_batches_1: |-
+  client.getBatches();
+get_batch_1: |-
+  client.getBatch(BATCH_UID);

CONTRIBUTING.md

@@ -34,9 +34,8 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume
 
 To run this project, you will need:
 
-- Node.js >= v16 and node <= 18
-- Yarn
-- vitest
+- Node >= v18 and Node <= 20
+- Yarn v1.x
 
 ### Setup
 

README.md

@@ -60,7 +60,7 @@ We recommend installing `meilisearch-js` in your project with your package manag
 npm install meilisearch
 ```
 
-`meilisearch-js` officially supports `node` versions >= 14 and <= 18.
+`meilisearch-js` officially supports `node` versions 18 LTS and 20 LTS.
 
 Instead of using a package manager, you may also import the library directly into your [HTML via a CDN](#include-script-tag).
 
@@ -565,6 +565,20 @@ client.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number })
 client.index('myIndex').waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Task[]>
 ```
 
+### Batches <!-- omit in toc -->
+
+#### [Get one batch](https://www.meilisearch.com/docs/reference/api/batches#get-one-batch)
+
+```ts
+client.getBatch(uid: number): Promise<Batch>
+```
+
+#### [Get all batches](https://www.meilisearch.com/docs/reference/api/batchess#get-batches)
+
+```ts
+client.getBatches(parameters: BatchesQuery = {}): Promise<BatchesResults>
+```
+
 ### Indexes <!-- omit in toc -->
 
 #### [Get all indexes in Index instances](https://www.meilisearch.com/docs/reference/api/indexes#list-all-indexes)
@@ -981,6 +995,46 @@ client.index('myIndex').updateProximityPrecision(proximityPrecision: ProximityPr
 client.index('myIndex').resetProximityPrecision(): Promise<EnqueuedTask>
 ```
 
+### Facet search settings <!-- omit in toc -->
+
+#### [Get facet search settings](https://www.meilisearch.com/docs/reference/api/settings#get-facet-search-settings)
+
+```ts
+client.index('myIndex').getFacetSearch(): Promise<boolean>
+```
+
+#### [Update facet search settings](https://www.meilisearch.com/docs/reference/api/settings#update-facet-search-settings)
+
+```ts
+client.index('myIndex').updateFacetSearch(enabled: boolean): Promise<EnqueuedTask>
+```
+
+#### [Reset facet search settings](https://www.meilisearch.com/docs/reference/api/settings#reset-facet-search-settings)
+
+```ts
+client.index('myIndex').resetFacetSearch(): Promise<EnqueuedTask>
+```
+
+### Prefix search settings <!-- omit in toc -->
+
+#### [Get prefix search settings](https://www.meilisearch.com/docs/reference/api/settings#get-prefix-search-settings)
+
+```ts
+client.index('myIndex').getPrefixSearch(): Promise<PrefixSearch>
+```
+
+#### [Update prefix search settings](https://www.meilisearch.com/docs/reference/api/settings#update-prefix-search-settings)
+
+```ts
+client.index('myIndex').updatePrefixSearch(prefixSearch: PrefixSearch): Promise<EnqueuedTask>
+```
+
+#### [Reset prefix search settings](https://www.meilisearch.com/docs/reference/api/settings#reset-prefix-search-settings)
+
+```ts
+client.index('myIndex').resetPrefixSearch(): Promise<EnqueuedTask>
+```
+
 ### Embedders <!-- omit in toc -->
 
 ⚠️ This feature is experimental. Activate the [`vectorStore` experimental feature to use it](https://www.meilisearch.com/docs/reference/api/experimental_features#configure-experimental-features)

eslint.config.js

@@ -5,35 +5,31 @@ const vitest = require("@vitest/eslint-plugin");
 const globals = require("globals");
 const prettier = require("eslint-config-prettier");
 
-/** @type {import("eslint").Linter.Config[]} */
-module.exports = [
+module.exports = tseslint.config([
+  { ignores: ["dist/", "tests/env/", "coverage/", "playgrounds/", "docs/"] },
+  eslint.configs.recommended,
   {
-    ignores: ["dist/", "tests/env/", "coverage/", "playgrounds/", "docs/"],
+    files: ["**/*.js"],
+    languageOptions: { sourceType: "commonjs", globals: globals.node },
   },
-  // Standard linting for js files
+  // TSDoc
   {
-    files: ["**/*.js"],
-    languageOptions: { sourceType: "script", globals: globals.node },
-    plugins: { eslint },
-    rules: eslint.configs.recommended.rules,
+    files: ["src/**/*.ts"],
+    plugins: { tsdoc },
+    rules: { "tsdoc/syntax": "error" },
   },
-  // TypeScript linting for ts files
-  ...tseslint.configs.recommendedTypeChecked.map((config) => ({
-    ...config,
+  // TypeScript
+  {
     files: ["**/*.ts"],
+    extends: [tseslint.configs.recommendedTypeChecked],
     languageOptions: {
-      ...config.languageOptions,
-      globals: { ...config.languageOptions?.globals, ...globals.node },
       parserOptions: {
-        ...config.languageOptions?.parserOptions,
-        project: "tsconfig.eslint.json",
+        projectService: true,
+        tsconfigRootDir: __dirname,
       },
     },
-    plugins: { ...config.plugins, tsdoc },
     rules: {
-      ...config.rules,
-      "tsdoc/syntax": "error",
-      // @TODO: Remove the ones between "~~", adapt code
+      // TODO: Remove the ones between "~~", adapt code
       // ~~
       "@typescript-eslint/prefer-as-const": "off",
       "@typescript-eslint/ban-ts-comment": "off",
@@ -45,7 +41,7 @@ module.exports = [
       "@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
+      // 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": [
@@ -54,16 +50,16 @@ module.exports = [
         // 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
+      // TODO: Not recommended to disable rule, should instead disable locally
       //       with explanation
       "@typescript-eslint/ban-ts-ignore": "off",
     },
-  })),
-  // Vitest linting for test files
+  },
+  // Vitest
   {
-    files: ["tests/*.ts"],
-    plugins: { vitest },
-    rules: vitest.configs.recommended.rules,
+    files: ["tests/**/*.test.ts"],
+    extends: [vitest.configs.recommended],
   },
+  // Disable any style linting, as prettier takes care of that separately
   prettier,
-];
+]);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "meilisearch",
-  "version": "0.46.0",
+  "version": "0.47.0",
   "description": "The Meilisearch JS client for Node.js and the browser.",
   "keywords": [
     "meilisearch",
@@ -66,8 +66,8 @@
     "style:fix": "yarn fmt:fix && yarn lint:fix",
     "fmt": "prettier -c ./**/*.{js,ts}",
     "fmt:fix": "prettier -w ./**/*.{js,ts}",
-    "lint": "eslint .",
-    "lint:fix": "eslint --fix .",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
     "typingsheader": "node scripts/build.js"
   },
   "files": [

rollup.config.js

@@ -18,7 +18,7 @@ const PLUGINS = [
   typescript({
     useTsconfigDeclarationDir: true,
     tsconfigOverride: {
-      compilerOptions: { allowJs: false },
+      tsconfig: "tsconfig.build.json",
       include: ["src"],
       exclude: ["tests", "examples", "*.js", "scripts"],
     },

src/batch.ts

@@ -0,0 +1,70 @@
+import {
+  Config,
+  BatchObject,
+  BatchesQuery,
+  BatchesResults,
+  BatchesResultsObject,
+} from "./types";
+import { HttpRequests, toQueryParams } from "./http-requests";
+
+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);
+  }
+
+  /**
+   * Get one batch
+   *
+   * @param uid - Unique identifier of the batch
+   * @returns
+   */
+  async getBatch(uid: number): Promise<Batch> {
+    const url = `batches/${uid}`;
+    const batch = await this.httpRequest.get<BatchObject>(url);
+    return new Batch(batch);
+  }
+
+  /**
+   * Get batches
+   *
+   * @param parameters - Parameters to browse the batches
+   * @returns Promise containing all batches
+   */
+  async getBatches(parameters: BatchesQuery = {}): Promise<BatchesResults> {
+    const url = `batches`;
+
+    const batches = await this.httpRequest.get<Promise<BatchesResultsObject>>(
+      url,
+      toQueryParams<BatchesQuery>(parameters),
+    );
+
+    return {
+      ...batches,
+      results: batches.results.map((batch) => new Batch(batch)),
+    };
+  }
+}
+
+export { BatchClient, Batch };

src/indexes.ts

@@ -56,6 +56,7 @@ import {
   SearchSimilarDocumentsParams,
   LocalizedAttributes,
   UpdateDocumentsByFunctionOptions,
+  PrefixSearch,
 } from "./types";
 import { removeUndefinedFromObject } from "./utils";
 import { HttpRequests } from "./http-requests";
@@ -1457,6 +1458,80 @@ class Index<T extends Record<string, any> = Record<string, any>> {
 
     return new EnqueuedTask(task);
   }
+
+  ///
+  /// FACET SEARCH SETTINGS
+  ///
+
+  /**
+   * Get the facet search settings.
+   *
+   * @returns Promise containing object of facet search settings
+   */
+  async getFacetSearch(): Promise<boolean> {
+    const url = `indexes/${this.uid}/settings/facet-search`;
+    return await this.httpRequest.get<boolean>(url);
+  }
+
+  /**
+   * Update the facet search settings.
+   *
+   * @param facetSearch - Boolean value
+   * @returns Promise containing an EnqueuedTask
+   */
+  async updateFacetSearch(facetSearch: boolean): Promise<EnqueuedTask> {
+    const url = `indexes/${this.uid}/settings/facet-search`;
+    const task = await this.httpRequest.put(url, facetSearch);
+    return new EnqueuedTask(task);
+  }
+
+  /**
+   * Reset the facet search settings.
+   *
+   * @returns Promise containing an EnqueuedTask
+   */
+  async resetFacetSearch(): Promise<EnqueuedTask> {
+    const url = `indexes/${this.uid}/settings/facet-search`;
+    const task = await this.httpRequest.delete(url);
+    return new EnqueuedTask(task);
+  }
+
+  ///
+  /// PREFIX SEARCH SETTINGS
+  ///
+
+  /**
+   * Get the prefix search settings.
+   *
+   * @returns Promise containing object of prefix search settings
+   */
+  async getPrefixSearch(): Promise<PrefixSearch> {
+    const url = `indexes/${this.uid}/settings/prefix-search`;
+    return await this.httpRequest.get<PrefixSearch>(url);
+  }
+
+  /**
+   * Update the prefix search settings.
+   *
+   * @param prefixSearch - PrefixSearch value
+   * @returns Promise containing an EnqueuedTask
+   */
+  async updatePrefixSearch(prefixSearch: PrefixSearch): Promise<EnqueuedTask> {
+    const url = `indexes/${this.uid}/settings/prefix-search`;
+    const task = await this.httpRequest.put(url, prefixSearch);
+    return new EnqueuedTask(task);
+  }
+
+  /**
+   * Reset the prefix search settings.
+   *
+   * @returns Promise containing an EnqueuedTask
+   */
+  async resetPrefixSearch(): Promise<EnqueuedTask> {
+    const url = `indexes/${this.uid}/settings/prefix-search`;
+    const task = await this.httpRequest.delete(url);
+    return new EnqueuedTask(task);
+  }
 }
 
 export { Index };