Merge #1188

1188: Changes related to the next Meilisearch release (v0.27.0) r=curquiza a=meili-bot

Related to this issue: meilisearch/integration-guides#190

This PR:
- gathers the changes related to the next Meilisearch release (v0.27.0) so that this package is ready when the official release is out.
- should pass the tests against the [latest pre-release of Meilisearch](https://github.com/meilisearch/meilisearch/releases).
- might eventually contain test failures until the Meilisearch v0.27.0 is out.

⚠️ This PR should NOT be merged until the next release of Meilisearch (v0.27.0) is out.

_This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/master/guides/pre-release-week.md) purpose._


Co-authored-by: meili-bot <[email protected]>
Co-authored-by: Charlotte Vermandel <[email protected]>
Co-authored-by: cvermand <[email protected]>

Author: 3 people

.code-samples.meilisearch.yaml

@@ -113,6 +113,15 @@ update_settings_1: |-
       synonyms: {
           'wolverine': ['xmen', 'logan'],
           'logan': ['wolverine']
+      },
+      typoTolerance: {
+          'minWordSizeForTypos': {
+              'oneTypo': 8,
+              'twoTypos': 10
+          },
+          'disableOnAttributes': [
+              'title'
+          ]
       }
   })
 reset_settings_1: |-
@@ -175,6 +184,20 @@ update_displayed_attributes_1: |-
   ])
 reset_displayed_attributes_1: |-
   client.index('movies').resetDisplayedAttributes()
+get_typo_tolerance_1: |-
+  client.index('books').getTypoTolerance()
+update_typo_tolerance_1: |-
+  client.index('books').updateTypoTolerance({
+    minWordSizeForTypos: {
+        oneTypo: 4,
+        twoTypos: 10
+      },
+      disableOnAttributes: [
+        'title'
+    ]
+  })
+reset_typo_tolerance_1: |-
+  client.index('books').resetTypoTolerance()
 get_index_stats_1: |-
   client.index('movies').getStats()
 get_indexes_stats_1: |-
@@ -231,12 +254,23 @@ search_parameter_guide_retrieve_1: |-
 search_parameter_guide_crop_1: |-
   client.index('movies').search('shifu', {
     attributesToCrop: ['overview'],
-    cropLength: 10
+    cropLength: 5
+  })
+search_parameter_guide_crop_marker_1: |-
+  client.index('movies').search('shifu', {
+    attributesToCrop: ['overview'],
+    cropMarker: '[…]'
   })
 search_parameter_guide_highlight_1: |-
   client.index('movies').search('winter feast', {
     attributesToHighlight: ['overview']
   })
+search_parameter_guide_highlight_tag_1: |-
+  client.index('movies').search('winter feast', {
+    attributesToHighlight: ['overview'],
+    highlightPreTag: '<span class="highlight">',
+    highlightPostTag: '</span>'
+  })
 search_parameter_guide_matches_1: |-
   client.index('movies').search('winter feast', {
     matches: true
@@ -296,6 +330,34 @@ settings_guide_sortable_1: |-
       'price'
     ]
   })
+settings_guide_typo_tolerance_1: |-
+  client.index('movies').updateTypoTolerance({
+    minWordSizeForTypos: {
+      twoTypos: 12
+    },
+    disableOnAttributes: [
+      'title'
+    ]
+  })
+typo_tolerance_guide_1: |-
+  client.index('movies').updateTypoTolerance({
+    enabled: false
+  })
+typo_tolerance_guide_2: |-
+  client.index('movies').updateTypoTolerance({
+    disableOnAttributes: ['title']
+  })
+typo_tolerance_guide_3: |-
+  client.index('movies').updateTypoTolerance({
+    disableOnWords: ['shrek']
+  })
+typo_tolerance_guide_4: |-
+  client.index('movies').updateTypoTolerance({
+    minWordSizeForTypos: {
+      oneTypo: 4,
+      twoTypos: 10
+    }
+  })
 add_movies_json_1: |-
   const movies = require('./movies.json')
   client.index('movies').addDocuments(movies).then((res) => console.log(res))

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

@@ -34,7 +34,7 @@ jobs:
       - name: Get the latest Meilisearch RC
         run: echo "MEILISEARCH_VERSION=$(curl https://raw.githubusercontent.com/meilisearch/integration-guides/main/scripts/get-latest-meilisearch-rc.sh | bash)" >> $GITHUB_ENV
       - name: Meilisearch (${{ env.MEILISEARCH_VERSION }}) setup with Docker
-        run: docker run -d -p 7700:7700 getmeili/meilisearch:${{ env.MEILISEARCH_VERSION }} ./meilisearch --master-key=masterKey --no-analytics
+        run: docker run -d -p 7700:7700 getmeili/meilisearch:${{ env.MEILISEARCH_VERSION }} meilisearch --master-key=masterKey --no-analytics
       - name: Run tests
         run: yarn test
       - name: Build project

.github/workflows/tests.yml

@@ -37,7 +37,7 @@ jobs:
       - name: Install dependencies
         run: yarn --dev
       - name: Meilisearch (latest) setup with Docker
-        run: docker run -d -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --no-analytics --master-key='masterKey'
+        run: docker run -d -p 7700:7700 getmeili/meilisearch:latest meilisearch --no-analytics --master-key='masterKey'
       - name: Run tests
         run: yarn test
       - name: Build project

README.md

@@ -342,7 +342,7 @@ controller.abort()
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.26.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.26.0).
+This package only guarantees the compatibility with the [version v0.27.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.27.0).
 
 ## 💡 Learn More
 
@@ -605,6 +605,17 @@ Using the index object:
 - [Reset Sortable Attributes](https://docs.meilisearch.com/reference/api/sortable_attributes.html#reset-sortable-attributes):
   `index.resetSortableAttributes(): Promise<EnqueuedTask>`
 
+### Typo Tolerance <!-- omit in toc -->
+
+- [Get Typo Tolerance](https://docs.meilisearch.com/reference/api/typo_tolerance.html#get-typo-tolerance):
+  `index.getTypoTolerance(): Promise<TypoTolerance>`
+
+- [Update Typo Tolerance](https://docs.meilisearch.com/reference/api/typo_tolerance.html#update-typo-tolerance):
+  `index.updateTypoTolerance(typoTolerance: TypoTolerance | null): Promise<EnqueuedTask>`
+
+- [Reset Typo Tolerance](https://docs.meilisearch.com/reference/api/typo_tolerance.html#reset-typo-tolerance):
+  `index.resetTypoTolerance(): Promise<EnqueuedTask>`
+
 ### Keys <!-- omit in toc -->
 
 - [Get keys](https://docs.meilisearch.com/reference/api/keys.html#get-all-keys):

src/lib/indexes.ts

@@ -33,6 +33,7 @@ import {
   SortableAttributes,
   SearchableAttributes,
   DisplayedAttributes,
+  TypoTolerance,
   Result,
 } from '../types'
 import { removeUndefinedFromObject } from './utils'
@@ -812,6 +813,46 @@ class Index<T = Record<string, any>> {
     const url = `indexes/${this.uid}/settings/displayed-attributes`
     return await this.httpRequest.delete<EnqueuedTask>(url)
   }
+
+  ///
+  /// TYPO TOLERANCE
+  ///
+
+  /**
+   * Get the typo tolerance settings.
+   * @memberof Index
+   * @method getTypoTolerance
+   * @returns {Promise<string[]>} Promise containing the typo tolerance settings.
+   */
+  async getTypoTolerance(): Promise<string[]> {
+    const url = `indexes/${this.uid}/settings/typo-tolerance`
+    return await this.httpRequest.get<string[]>(url)
+  }
+
+  /**
+   * Update the typo tolerance settings.
+   * @memberof Index
+   * @method updateTypoTolerance
+   * @param {TypoTolerance} typoTolerance Object containing the custom typo tolerance settings.
+   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+   */
+  async updateTypoTolerance(
+    typoTolerance: TypoTolerance
+  ): Promise<EnqueuedTask> {
+    const url = `indexes/${this.uid}/settings/typo-tolerance`
+    return await this.httpRequest.post(url, typoTolerance)
+  }
+
+  /**
+   * Reset the typo tolerance settings.
+   * @memberof Index
+   * @method resetTypoTolerance
+   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued update
+   */
+  async resetTypoTolerance(): Promise<EnqueuedTask> {
+    const url = `indexes/${this.uid}/settings/typo-tolerance`
+    return await this.httpRequest.delete<EnqueuedTask>(url)
+  }
 }
 
 export { Index }

src/types/types.ts

@@ -39,6 +39,10 @@ export type AddDocumentParams = {
   primaryKey?: string
 }
 
+/*
+ * SEARCH PARAMETERS
+ */
+
 export type Filter = string | Array<string | string[]>
 
 export type Pagination = {
@@ -50,30 +54,42 @@ export type Query = {
   q?: string | null
 }
 
-export type SearchParams = Pagination & {
-  filter?: Filter
-  sort?: string[]
-  facetsDistribution?: string[]
-  attributesToRetrieve?: string[]
+export type Highlight = {
   attributesToHighlight?: string[]
+  highlightPreTag?: string
+  highlightPostTag?: string
+}
+
+export type Crop = {
   attributesToCrop?: string[]
   cropLength?: number
-  matches?: boolean
+  cropMarker?: string
 }
 
+export type SearchParams = Pagination &
+  Highlight &
+  Crop & {
+    filter?: Filter
+    sort?: string[]
+    facetsDistribution?: string[]
+    attributesToRetrieve?: string[]
+    matches?: boolean
+  }
+
 export type SearchRequest = SearchParams & Query
 
 // Search parameters for searches made with the GET method
 // Are different than the parameters for the POST method
 export type SearchRequestGET = Pagination &
-  Query & {
+  Query &
+  Omit<Highlight, 'attributesToHighlight'> &
+  Omit<Crop, 'attributesToCrop'> & {
     filter?: string
     sort?: string
     facetsDistribution?: string
     attributesToRetrieve?: string
     attributesToHighlight?: string
     attributesToCrop?: string
-    cropLength?: number
     matches?: boolean
   }
 
@@ -143,6 +159,15 @@ export type StopWords = string[] | null
 export type Synonyms = {
   [field: string]: string[]
 } | null
+export type TypoTolerance = {
+  enabled?: boolean | null
+  disabledOnAttributes?: string[] | null
+  disableOnWords?: string[] | null
+  minWordSizeForTypos?: {
+    oneTypo?: number | null
+    twoTypos?: number | null
+  }
+} | null
 
 export type Settings = {
   filterableAttributes?: FilterableAttributes
@@ -153,6 +178,7 @@ export type Settings = {
   rankingRules?: RankingRules
   stopWords?: StopWords
   synonyms?: Synonyms
+  typoTolerance?: TypoTolerance
 }
 
 /*

tests/get_search_tests.ts

@@ -225,11 +225,52 @@ describe.each([
     expect(response.hits[0]).toHaveProperty('_formatted', expect.any(Object))
     expect(response.hits[0]._formatted).toHaveProperty(
       'title',
-      'Petit <em>Prince</em>'
+      'Le Petit <em>Prince</em>'
     )
     expect(response.hits[0]).toHaveProperty('_matchesInfo', expect.any(Object))
   })
 
+  test(`${permission} key: search on default cropping parameters`, async () => {
+    const client = await getClient(permission)
+    const response = await client.index(index.uid).searchGet('prince', {
+      attributesToCrop: ['*'],
+      cropLength: 6,
+    })
+
+    expect(response.hits[0]._formatted).toHaveProperty(
+      'comment',
+      '…book about a prince that walks…'
+    )
+  })
+
+  test(`${permission} key: search on customized cropMarker`, async () => {
+    const client = await getClient(permission)
+    const response = await client.index(index.uid).searchGet('prince', {
+      attributesToCrop: ['*'],
+      cropLength: 6,
+      cropMarker: '(ꈍᴗꈍ)',
+    })
+
+    expect(response.hits[0]._formatted).toHaveProperty(
+      'comment',
+      '(ꈍᴗꈍ)book about a prince that walks(ꈍᴗꈍ)'
+    )
+  })
+
+  test(`${permission} key: search on customized highlight tags`, async () => {
+    const client = await getClient(permission)
+    const response = await client.index(index.uid).searchGet('prince', {
+      attributesToHighlight: ['*'],
+      highlightPreTag: '(⊃｡•́‿•̀｡)⊃ ',
+      highlightPostTag: ' ⊂(´• ω •`⊂)',
+    })
+
+    expect(response.hits[0]._formatted).toHaveProperty(
+      'comment',
+      'A french book about a (⊃｡•́‿•̀｡)⊃ prince ⊂(´• ω •`⊂) that walks on little cute planets'
+    )
+  })
+
   test(`${permission} key: search with all options and all fields`, async () => {
     const client = await getClient(permission)
     const response = await client.index(index.uid).searchGet('prince', {
@@ -251,7 +292,7 @@ describe.each([
     expect(response.hits[0]).toHaveProperty('_formatted', expect.any(Object))
     expect(response.hits[0]._formatted).toHaveProperty(
       'title',
-      'Petit <em>Prince</em>'
+      'Le Petit <em>Prince</em>'
     )
     expect(response.hits[0]).toHaveProperty('_matchesInfo', expect.any(Object))
   })
@@ -284,7 +325,7 @@ describe.each([
     )
     expect(response.hits[0]._formatted).toHaveProperty(
       'title',
-      'Petit <em>Prince</em>'
+      'Le Petit <em>Prince</em>'
     )
     expect(response.hits[0]._formatted).not.toHaveProperty('comment')
     expect(response.hits[0]).toHaveProperty('_matchesInfo', expect.any(Object))