Merge branch 'main' into improve-eslint-prettier-tsconfig

Author: flevi29

.code-samples.meilisearch.yaml

@@ -630,6 +630,12 @@ update_non_separator_tokens_1: |-
   client.index('books').updateNonSeparatorTokens(['@', '#'])
 reset_non_separator_tokens_1: |-
   client.index('books').resetNonSeparatorTokens()
+get_proximity_precision_settings_1: |-
+  client.index('books').getProximityPrecision()
+update_proximity_precision_settings_1: |-
+  client.index('books').updateProximityPrecision('byAttribute')
+reset_proximity_precision_settings_1: |-
+  client.index('books').resetProximityPrecision()
 search_parameter_guide_facet_stats_1: |-
   client.index('movie_ratings').search('Batman', { facets: ['genres', 'rating'] })
 geosearch_guide_filter_settings_1: |-

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

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

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

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

.github/workflows/publish.yml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
           registry-url: https://registry.npmjs.org/
           cache: 'yarn'
       - name: Check release validity

.github/workflows/tests.yml

@@ -34,7 +34,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: ['14', '16', '18']
+        node: ['18', '20']
     name: integration-tests (Node.js ${{ matrix.node }})
     steps:
       - uses: actions/checkout@v4
@@ -69,7 +69,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
           cache: 'yarn'
       - name: Install dependencies
         run: yarn --dev
@@ -87,7 +87,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
           cache: 'yarn'
       - name: Install dependencies
         run: yarn --dev

README.md

@@ -903,64 +903,106 @@ client.index('myIndex').resetTypoTolerance(): Promise<EnqueuedTask>
 
 ### Separator tokens <!-- omit in toc -->
 
-#### Get separator tokens
+#### [Get separator tokens](https://www.meilisearch.com/docs/reference/api/settings#get-separator-tokens)
 
 ```ts
 client.index('myIndex').getSeparatorTokens(): Promise<SeparatorTokens>
 ```
 
-#### Update separator tokens
+#### [Update separator tokens](https://www.meilisearch.com/docs/reference/api/settings#update-separator-tokens)
 
 ```ts
 client.index('myIndex').updateSeparatorTokens(separatorTokens: SeparatorTokens | null): Promise<EnqueuedTask>
 ```
 
-#### Reset separator tokens
+#### [Reset separator tokens](https://www.meilisearch.com/docs/reference/api/settings#reset-separator-tokens)
 
 ```ts
 client.index('myIndex').resetSeparatorTokens(): Promise<EnqueuedTask>
 ```
 
 ### Non Separator tokens <!-- omit in toc -->
 
-#### Get non separator tokens
+#### [Get non separator tokens](https://www.meilisearch.com/docs/reference/api/settings#get-non-separator-tokens)
 
 ```ts
 client.index('myIndex').getNonSeparatorTokens(): Promise<NonSeparatorTokens>
 ```
 
-#### Update non separator tokens
+#### [Update non separator tokens](https://www.meilisearch.com/docs/reference/api/settings#update-non-separator-tokens)
 
 ```ts
 client.index('myIndex').updateNonSeparatorTokens(nonSeparatorTokens: NonSeparatorTokens | null): Promise<EnqueuedTask>
 ```
 
-#### Reset non separator tokens
+#### [Reset non separator tokens](https://www.meilisearch.com/docs/reference/api/settings#reset-non-separator-tokens)
 
 ```ts
 client.index('myIndex').resetNonSeparatorTokens(): Promise<EnqueuedTask>
 ```
 
 ### Dictionary <!-- omit in toc -->
 
-#### Get dictionary
+#### [Get dictionary](https://www.meilisearch.com/docs/reference/api/settings#get-dictionary)
 
 ```ts
 client.index('myIndex').getDictionary(): Promise<Dictionary>
 ```
 
-#### Update dictionary
+#### [Update dictionary](https://www.meilisearch.com/docs/reference/api/settings#update-dictionary)
 
 ```ts
 client.index('myIndex').updateDictionary(dictionary: Dictionary | null): Promise<EnqueuedTask>
 ```
 
-#### Reset dictionary
+#### [Reset dictionary](https://www.meilisearch.com/docs/reference/api/settings#reset-dictionary)
 
 ```ts
 client.index('myIndex').resetDictionary(): Promise<EnqueuedTask>
 ```
 
+### Proximity Precision <!-- omit in toc -->
+
+#### [Get proximity precision](https://www.meilisearch.com/docs/reference/api/settings#get-proximity-precision)
+
+```ts
+client.index('myIndex').getProximityPrecision(): Promise<ProximityPrecision>
+```
+
+#### [Update proximity precision](https://www.meilisearch.com/docs/reference/api/settings#update-proximity-precision)
+
+```ts
+client.index('myIndex').updateProximityPrecision(proximityPrecision: ProximityPrecision): Promise<EnqueuedTask>
+```
+
+#### [Reset proximity precision](https://www.meilisearch.com/docs/reference/api/settings#reset-proximity-precision)
+
+```ts
+client.index('myIndex').resetProximityPrecision(): 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) 
+
+#### [Get embedders](https://www.meilisearch.com/docs/reference/api/settings#get-embedders)
+
+```ts
+client.index('myIndex').getEmbedders(): Promise<Embedders>
+```
+
+#### [Update embedders](https://www.meilisearch.com/docs/reference/api/settings#update-embedders)
+
+```ts
+client.index('myIndex').updateEmbedders(embedders: Embedders): Promise<EnqueuedTask>
+```
+
+#### [Reset embedders](https://www.meilisearch.com/docs/reference/api/settings#reset-embedders)
+
+```ts
+client.index('myIndex').resetEmbedders(): Promise<EnqueuedTask>
+```
+
 ### Keys <!-- omit in toc -->
 
 #### [Get keys](https://www.meilisearch.com/docs/reference/api/keys#get-all-keys)

bors.toml

@@ -1,9 +1,8 @@
 status = [
   'style-check',
   'types-check',
-  'integration-tests (Node.js 14)',
-  'integration-tests (Node.js 16)',
   'integration-tests (Node.js 18)',
+  'integration-tests (Node.js 20)',
 ]
 # 1 hour timeout
 timeout-sec = 3600

package.json

@@ -1,6 +1,6 @@
 {
   "name": "meilisearch",
-  "version": "0.36.0",
+  "version": "0.37.0",
   "description": "The Meilisearch JS client for Node.js and the browser.",
   "keywords": [
     "meilisearch",

src/indexes.ts

@@ -50,6 +50,8 @@ import {
   SeparatorTokens,
   NonSeparatorTokens,
   Dictionary,
+  ProximityPrecision,
+  Embedders,
 } from './types'
 import { removeUndefinedFromObject } from './utils'
 import { HttpRequests } from './http-requests'
@@ -1222,7 +1224,7 @@ class Index<T extends Record<string, any> = Record<string, any>> {
   }
 
   /**
-   * Update the the dictionary settings. Overwrite the old settings.
+   * Update the dictionary settings. Overwrite the old settings.
    *
    * @param dictionary - Array that contains the new dictionary settings.
    * @returns Promise containing an EnqueuedTask or null
@@ -1247,6 +1249,91 @@ class Index<T extends Record<string, any> = Record<string, any>> {
 
     return task
   }
+
+  ///
+  /// PROXIMITY PRECISION
+  ///
+
+  /**
+   * Get the proximity precision settings of a Meilisearch index.
+   *
+   * @returns Promise containing the proximity precision settings
+   */
+  async getProximityPrecision(): Promise<ProximityPrecision> {
+    const url = `indexes/${this.uid}/settings/proximity-precision`
+    return await this.httpRequest.get<ProximityPrecision>(url)
+  }
+
+  /**
+   * Update the proximity precision settings. Overwrite the old settings.
+   *
+   * @param proximityPrecision - String that contains the new proximity
+   *   precision settings.
+   * @returns Promise containing an EnqueuedTask or null
+   */
+  async updateProximityPrecision(
+    proximityPrecision: ProximityPrecision
+  ): Promise<EnqueuedTask> {
+    const url = `indexes/${this.uid}/settings/proximity-precision`
+    const task = await this.httpRequest.put(url, proximityPrecision)
+
+    return new EnqueuedTask(task)
+  }
+
+  /**
+   * Reset the proximity precision settings to its default value
+   *
+   * @returns Promise containing an EnqueuedTask
+   */
+  async resetProximityPrecision(): Promise<EnqueuedTask> {
+    const url = `indexes/${this.uid}/settings/proximity-precision`
+    const task = await this.httpRequest.delete<EnqueuedTask>(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
+  }
+
+  ///
+  /// EMBEDDERS
+  ///
+
+  /**
+   * Get the embedders settings of a Meilisearch index.
+   *
+   * @returns Promise containing the embedders settings
+   */
+  async getEmbedders(): Promise<Embedders> {
+    const url = `indexes/${this.uid}/settings/embedders`
+    return await this.httpRequest.get<Embedders>(url)
+  }
+
+  /**
+   * Update the embedders settings. Overwrite the old settings.
+   *
+   * @param embedders - Object that contains the new embedders settings.
+   * @returns Promise containing an EnqueuedTask or null
+   */
+  async updateEmbedders(embedders: Embedders): Promise<EnqueuedTask> {
+    const url = `indexes/${this.uid}/settings/embedders`
+    const task = await this.httpRequest.patch(url, embedders)
+
+    return new EnqueuedTask(task)
+  }
+
+  /**
+   * Reset the embedders settings to its default value
+   *
+   * @returns Promise containing an EnqueuedTask
+   */
+  async resetEmbedders(): Promise<EnqueuedTask> {
+    const url = `indexes/${this.uid}/settings/embedders`
+    const task = await this.httpRequest.delete<EnqueuedTask>(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
+  }
 }
 
 export { Index }

src/package-version.ts

@@ -1 +1 @@
-export const PACKAGE_VERSION = '0.36.0'
+export const PACKAGE_VERSION = '0.37.0'