feat: add proximity precision settings (#1619)

* feat: add proximity precision settings

* Update proximity precision default value byWord

Author: mdubus

README.md

@@ -903,64 +903,84 @@ 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-prximity-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>
+```
+
 ### Keys <!-- omit in toc -->
 
 #### [Get keys](https://www.meilisearch.com/docs/reference/api/keys#get-all-keys)

src/indexes.ts

@@ -50,6 +50,7 @@ import {
   SeparatorTokens,
   NonSeparatorTokens,
   Dictionary,
+  ProximityPrecision,
 } from './types'
 import { removeUndefinedFromObject } from './utils'
 import { HttpRequests } from './http-requests'
@@ -1222,7 +1223,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 +1248,50 @@ 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
+  }
 }
 
 export { Index }

src/types/types.ts

@@ -316,6 +316,7 @@ export type TypoTolerance = {
 export type SeparatorTokens = string[] | null
 export type NonSeparatorTokens = string[] | null
 export type Dictionary = string[] | null
+export type ProximityPrecision = 'byWord' | 'byAttribute'
 
 export type FacetOrder = 'alpha' | 'count'
 
@@ -343,6 +344,7 @@ export type Settings = {
   separatorTokens?: SeparatorTokens
   nonSeparatorTokens?: NonSeparatorTokens
   dictionary?: Dictionary
+  proximityPrecision?: ProximityPrecision
 }
 
 /*

tests/__snapshots__/settings.test.ts.snap

@@ -18,6 +18,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "words",
     "typo",
@@ -63,6 +64,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "words",
     "typo",
@@ -108,6 +110,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "words",
     "typo",
@@ -153,6 +156,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "words",
     "typo",
@@ -198,6 +202,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "words",
     "typo",
@@ -243,6 +248,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "words",
     "typo",
@@ -297,6 +303,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byAttribute",
   "rankingRules": Array [
     "id:asc",
     "typo",
@@ -354,6 +361,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "title:asc",
     "typo",
@@ -397,6 +405,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "words",
     "typo",
@@ -442,6 +451,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "words",
     "typo",
@@ -487,6 +497,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "words",
     "typo",
@@ -532,6 +543,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "words",
     "typo",
@@ -577,6 +589,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "words",
     "typo",
@@ -622,6 +635,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "words",
     "typo",
@@ -667,6 +681,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "words",
     "typo",
@@ -721,6 +736,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byAttribute",
   "rankingRules": Array [
     "id:asc",
     "typo",
@@ -778,6 +794,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "title:asc",
     "typo",
@@ -821,6 +838,7 @@ Object {
   "pagination": Object {
     "maxTotalHits": 1000,
   },
+  "proximityPrecision": "byWord",
   "rankingRules": Array [
     "words",
     "typo",