Merge branch 'main' into optional-words-beta

Author: bidoubiwa

.github/workflows/publish.yml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 12
+          node-version: 16
           registry-url: https://registry.npmjs.org/
       - name: Check release validity
         run: sh .github/scripts/check-release.sh

CONTRIBUTING.md

@@ -175,9 +175,7 @@ Here are the steps to release a beta version of this package:
       git checkout -b bump-meilisearch-v*.*.*-beta
       ```
 
-- Change the version in `package.json` with `*.*.*-xxx-beta.0` and commit it to the `v*.*.*-beta` branch. None or multiple `-xxx`are valid. Examples:
-  - `v*.*.*-my-feature-beta.0`
-  - `v*.*.*-beta.0`
+- Change the version in [`package.json`](/package.json) and [`src/package-version`](/src/package-version.ts) with `*.*.*-xxx-beta.0` and commit it to the `v*.*.*-beta` branch.
 
 - Go to the [GitHub interface for releasing](https://github.com/meilisearch/instant-meilisearch/releases): on this page, click on `Draft a new release`.
 
@@ -194,7 +192,7 @@ GitHub Actions will be triggered and push the beta version to [npm](https://www.
 💡 If you need to release a new beta for the same version (i.e. `vX.X.X-beta.1`):
 - merge the change into `bump-meilisearch-v*.*.*`
 - rebase the `vX.X.X-beta.0` branch
-- change the version name in `package.json`
+- change the version name in [`package.json`](/package.json) and [`src/package-version`](/src/package-version.ts)
 - creata a pre-release via the GitHub interface
 
 <hr>

README.md

@@ -127,7 +127,7 @@ Usage:
 
 ### Finite Pagination
 
-Finite pagination is used when you want to add a numbered pagination at the bottom of your hits (for example: `< << 1, 2, 3 > >>`).
+Finite pagination is used when you want to add a numbered pagination at the bottom of your hits (for example: `<< < 1, 2, 3 > >>`).
 To be able to know the amount of page numbers you have, a search is done requesting `paginationTotalHits` documents (default: `200`).
 With the amount of documents returned, instantsearch is able to render the correct amount of numbers in the pagination widget.
 
@@ -271,7 +271,7 @@ This package only guarantees the compatibility with the [version v0.28.0 of Meil
 
 **Node / NPM versions**:
 
-- NodeJS >= 12.10 <= 14
+- NodeJS >= 12.10 <= 18
 - NPM >= 6.x
 
 ## 📜 API resources

src/adapter/search-request-adapter/__tests__/facets-distribution-assigns.tests.ts

@@ -5,11 +5,13 @@ test('One field in cache present in distribution', () => {
     { genre: ['comedy'] },
     { genre: { comedy: 1 } }
   )
+
   expect(returnedDistribution).toMatchObject({ genre: { comedy: 1 } })
 })
 
 test('One field in cache not present in distribution', () => {
   const returnedDistribution = addMissingFacets({ genre: ['comedy'] }, {})
+
   expect(returnedDistribution).toMatchObject({ genre: { comedy: 0 } })
 })
 
@@ -18,6 +20,7 @@ test('two field in cache only one present in distribution', () => {
     { genre: ['comedy'], title: ['hamlet'] },
     { genre: { comedy: 12 } }
   )
+
   expect(returnedDistribution).toMatchObject({
     genre: { comedy: 12 },
     title: { hamlet: 0 },
@@ -29,6 +32,7 @@ test('two field in cache w/ different facet name none present in distribution',
     { genre: ['comedy'], title: ['hamlet'] },
     {}
   )
+
   expect(returnedDistribution).toMatchObject({
     genre: { comedy: 0 },
     title: { hamlet: 0 },
@@ -40,6 +44,7 @@ test('two field in cache w/ different facet name both present in distribution',
     { genre: ['comedy'], title: ['hamlet'] },
     { genre: { comedy: 12 }, title: { hamlet: 1 } }
   )
+
   expect(returnedDistribution).toMatchObject({
     genre: { comedy: 12 },
     title: { hamlet: 1 },
@@ -51,6 +56,7 @@ test('Three field in cache w/ different facet name two present in distribution',
     { genre: ['comedy', 'horror'], title: ['hamlet'] },
     { genre: { comedy: 12 }, title: { hamlet: 1 } }
   )
+
   expect(returnedDistribution).toMatchObject({
     genre: { comedy: 12, horror: 0 },
     title: { hamlet: 1 },
@@ -61,25 +67,30 @@ test('Cache is undefined and facets distribution is not', () => {
   const returnedDistribution = addMissingFacets(undefined, {
     genre: { comedy: 12 },
   })
+
   expect(returnedDistribution).toMatchObject({ genre: { comedy: 12 } })
 })
 
 test('Cache is empty object and facets distribution is not', () => {
   const returnedDistribution = addMissingFacets({}, { genre: { comedy: 12 } })
+
   expect(returnedDistribution).toMatchObject({ genre: { comedy: 12 } })
 })
 
 test('Cache is empty object and facets distribution empty object', () => {
   const returnedDistribution = addMissingFacets({}, {})
+
   expect(returnedDistribution).toMatchObject({})
 })
 
 test('Cache is undefined and facets distribution empty object', () => {
   const returnedDistribution = addMissingFacets(undefined, {})
+
   expect(returnedDistribution).toMatchObject({})
 })
 
 test('Cache is undefined and facets distribution is undefined', () => {
   const returnedDistribution = addMissingFacets(undefined, undefined)
+
   expect(returnedDistribution).toMatchObject({})
 })

src/adapter/search-request-adapter/__tests__/filter-cache.tests.ts

@@ -64,6 +64,7 @@ describe.each(facetCacheData)(
         { keepZeroFacets: false, defaultFacetDistribution: {} },
         { filter: filters }
       )
+
       expect(cache).toEqual(expectedCache)
     })
   }

src/adapter/search-request-adapter/__tests__/geo-rules.tests.ts

@@ -17,20 +17,23 @@ test('Adapt geoPoints rules with integer geo points', () => {
   const rules = adaptGeoPointsRules({
     insideBoundingBox: '1,2,3,4',
   })
+
   expect(rules?.filter).toBe('_geoRadius(3.17650, 3.19394, 157201.47551181243)')
 })
 
 test('Try geoContext with only a radius', () => {
   const rules = adaptGeoPointsRules({
     aroundRadius: 1,
   })
+
   expect(rules).toBeUndefined()
 })
 
 test('Try geoContext with an aroundLatLng', () => {
   const rules = adaptGeoPointsRules({
     aroundLatLng: '51.1241999, 9.662499900000057',
   })
+
   expect(rules?.filter).toBeUndefined()
 })
 
@@ -39,6 +42,7 @@ test('Try geoContext with an aroundLatLng and a radius', () => {
     aroundLatLng: '51.1241999, 9.662499900000057',
     aroundRadius: 1,
   })
+
   expect(rules?.filter).toBe('_geoRadius(51.12420, 9.66250, 1)')
 })
 
@@ -47,6 +51,7 @@ test('Try geoContext with an aroundLatLng and a 0 radius', () => {
     aroundLatLng: '51.1241999, 9.662499900000057',
     aroundRadius: 0,
   })
+
   expect(rules?.filter).toBe('_geoRadius(51.12420, 9.66250, 0)')
 })
 
@@ -56,19 +61,22 @@ test('Try geoContext with aroundLatLng, radius and insideBoundingBox', () => {
     aroundRadius: 1,
     insideBoundingBox: '1,2,3,4',
   })
+
   expect(rules?.filter).toBe('_geoRadius(3.17650, 3.19394, 157201.47551181243)')
 })
 test('Try geoContext with a radius and insideBoundingBox', () => {
   const rules = adaptGeoPointsRules({
     aroundRadius: 1,
     insideBoundingBox: '1,2,3,4',
   })
+
   expect(rules?.filter).toBe('_geoRadius(3.17650, 3.19394, 157201.47551181243)')
 })
 test('Try geoContext with aroundLatLng and insideBoundingBox', () => {
   const rules = adaptGeoPointsRules({
     aroundLatLng: '51.1241999, 9.662499900000057',
     insideBoundingBox: '1,2,3,4',
   })
+
   expect(rules?.filter).toBe('_geoRadius(3.17650, 3.19394, 157201.47551181243)')
 })