Merge #768

768: Changes related to the next Meilisearch release (v0.28.0) r=bidoubiwa a=meili-bot

This PR gathers the changes related to the next Meilisearch release (v0.28.0) so that this package is ready when the official release is out.

⚠️ This PR should NOT be merged until:
  - the next release of Meilisearch (v0.28.0) is out.
  - the [`meilisearch-js`](https://github.com/meilisearch/meilisearch-js) dependency has been released to be compatible with Meilisearch v0.28.0.
  Once the release is out, the upgrade of the `meilisearch-js` dependency might be committed to this branch.

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

_Related to this issue: https://github.com/meilisearch/integration-guides/issues/205_


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

Author: 3 people

.github/scripts/check-release.sh

@@ -2,10 +2,16 @@
 
 # Checking if current tag matches the package version
 current_tag=$(echo $GITHUB_REF | cut -d '/' -f 3 | tr -d ' ',v)
-file_tag=$(grep '"version":' package.json | cut -d ':' -f 2- | tr -d ' ' | tr -d '"' | tr -d ',')
-if [ "$current_tag" != "$file_tag" ]; then
-  echo "Error: the current tag does not match the version in package file(s)."
-  echo "$current_tag vs $file_tag"
+
+package_file_tag=$(grep '"version":' package.json | cut -d ':' -f 2- | tr -d ' ' | tr -d '"' | tr -d ',')
+package_file_name='package.json'
+version_file_tag=$(grep "PACKAGE_VERSION =" src/package-version.ts | cut -d "=" -f 2- | tr -d " " | tr -d "'")
+version_file_name='src/package-version.ts'
+
+if [ "$current_tag" != "$package_file_tag" ] || [ "$current_tag" != "$version_file_tag" ]; then
+  echo 'Error: the current tag does not match the version in package file(s).'
+  echo "$package_file_name: $current_tag vs $package_file_tag"
+  echo "$version_file_name: $current_tag vs $version_file_tag"
   exit 1
 fi
 

CONTRIBUTING.md

@@ -131,10 +131,16 @@ _[Read more about this](https://github.com/meilisearch/integration-guides/blob/m
 
 ⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md).
 
-Make a PR modifying the file [`package.json`](/package.json) with the right version.
+Make a PR modifying the following files with the right version:
 
+[`package.json`](/package.json):
 ```javascript
-"version": "X.X.X"
+"version": "X.X.X",
+```
+
+[`src/package-version`](/src/package-version.ts)
+```javascript
+export const PACKAGE_VERSION = 'X.X.X'
 ```
 
 Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/instant-meilisearch/releases): on this page, click on `Edit` (related to the draft release) > update the description (be sure you apply [these recommandations](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md#writting-the-release-description)) > when you are ready, click on `Publish release`.

README.md

@@ -253,7 +253,7 @@ This package only guarantees the compatibility with the [version v4 of InstantSe
 
 **Supported Meilisearch versions**:
 
-This package only guarantees the compatibility with the [version v0.27.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.27.0).
+This package only guarantees the compatibility with the [version v0.28.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0).
 
 **Node / NPM versions**:
 

package.json

@@ -57,7 +57,7 @@
     "url": "https://github.com/meilisearch/instant-meilisearch.git"
   },
   "dependencies": {
-    "meilisearch": "0.26.0"
+    "meilisearch": "^0.27.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.18.6",

src/adapter/search-request-adapter/filters.ts

@@ -1,7 +1,7 @@
 import {
   Filter,
   ParsedFilter,
-  FacetsDistribution,
+  FacetDistribution,
   FacetsCache,
   MeiliSearchParams,
   SearchContext,
@@ -62,10 +62,10 @@ export function getFacetsFromFilter(filters?: Filter): FacetsCache {
 }
 
 function getFacetsFromDefaultDistribution(
-  facetsDistribution: FacetsDistribution
+  facetDistribution: FacetDistribution
 ): FacetsCache {
-  return Object.keys(facetsDistribution).reduce((cache: any, facet) => {
-    const facetValues = Object.keys(facetsDistribution[facet])
+  return Object.keys(facetDistribution).reduce((cache: any, facet) => {
+    const facetValues = Object.keys(facetDistribution[facet])
     return {
       ...cache,
       [facet]: facetValues,
@@ -91,19 +91,19 @@ export function extractFacets(
 }
 
 /**
- * Assign missing filters to facetsDistribution.
- * All facet passed as filter should appear in the facetsDistribution.
+ * Assign missing filters to facetDistribution.
+ * All facets passed as filter should appear in the facetDistribution.
  * If not present, the facet is added with 0 as value.
  *
  *
  * @param  {FacetsCache} cache?
- * @param  {FacetsDistribution} distribution?
- * @returns {FacetsDistribution}
+ * @param  {FacetDistribution} distribution?
+ * @returns {FacetDistribution}
  */
 export function addMissingFacets(
   cachedFacets?: FacetsCache,
-  distribution?: FacetsDistribution
-): FacetsDistribution {
+  distribution?: FacetDistribution
+): FacetDistribution {
   distribution = distribution || {}
 
   // If cachedFacets contains something

src/adapter/search-request-adapter/search-params-adapter.ts

@@ -22,7 +22,7 @@ export function adaptSearchParams(
   // Facets
   const facets = searchContext?.facets
   if (facets?.length) {
-    meiliSearchParams.facetsDistribution = facets
+    meiliSearchParams.facets = facets
   }
 
   // Attributes To Crop

src/adapter/search-request-adapter/search-resolver.ts

@@ -10,11 +10,10 @@ import { addMissingFacets, extractFacets } from './filters'
 const emptySearch: MeiliSearchResponse<Record<string, any>> = {
   hits: [],
   query: '',
-  facetsDistribution: {},
+  facetDistribution: {},
   limit: 0,
   offset: 0,
-  exhaustiveNbHits: false,
-  nbHits: 0,
+  estimatedTotalHits: 0,
   processingTimeMs: 0,
 }
 
@@ -69,10 +68,10 @@ export function SearchResolver(cache: SearchCacheInterface) {
         .index(searchContext.indexUid)
         .search(searchContext.query, searchParams)
 
-      // Add missing facets back into facetsDistribution
-      searchResponse.facetsDistribution = addMissingFacets(
+      // Add missing facets back into facetDistribution
+      searchResponse.facetDistribution = addMissingFacets(
         facetsCache,
-        searchResponse.facetsDistribution
+        searchResponse.facetDistribution
       )
 
       // Cache response

src/adapter/search-response-adapter/hits-adapter.ts

@@ -21,7 +21,11 @@ export function adaptHits(
   let adaptedHits = paginatedHits.map((hit: Record<string, any>) => {
     // Creates Hit object compliant with InstantSearch
     if (Object.keys(hit).length > 0) {
-      const { _formatted: formattedHit, _matchesInfo, ...documentFields } = hit
+      const {
+        _formatted: formattedHit,
+        _matchesPosition,
+        ...documentFields
+      } = hit
 
       const adaptedHit: Record<string, any> = Object.assign(
         documentFields,

src/adapter/search-response-adapter/search-response-adapter.ts

@@ -21,22 +21,16 @@ export function adaptSearchResponse<T>(
 ): { results: Array<AlgoliaSearchResponse<T>> } {
   const searchResponseOptionals: Record<string, any> = {}
 
-  const facets = searchResponse.facetsDistribution
+  const facets = searchResponse.facetDistribution
   const { pagination } = searchContext
 
-  const exhaustiveFacetsCount = searchResponse?.exhaustiveFacetsCount
-  if (exhaustiveFacetsCount) {
-    searchResponseOptionals.exhaustiveFacetsCount = exhaustiveFacetsCount
-  }
-
   const nbPages = ceiledDivision(
     searchResponse.hits.length,
     pagination.hitsPerPage
   )
   const hits = adaptHits(searchResponse.hits, searchContext, pagination)
 
-  const exhaustiveNbHits = searchResponse.exhaustiveNbHits
-  const nbHits = searchResponse.nbHits
+  const estimatedTotalHits = searchResponse.estimatedTotalHits
   const processingTimeMs = searchResponse.processingTimeMs
   const query = searchResponse.query
 
@@ -49,12 +43,12 @@ export function adaptSearchResponse<T>(
     page,
     facets,
     nbPages,
-    exhaustiveNbHits,
-    nbHits,
+    nbHits: estimatedTotalHits,
     processingTimeMS: processingTimeMs,
     query,
     hits,
     params: '',
+    exhaustiveNbHits: false,
     ...searchResponseOptionals,
   }
   return {

src/cache/__tests__/assets/utils.ts

@@ -4,6 +4,6 @@ export const searchResponse = {
   offset: 0,
   limit: 0,
   processingTimeMs: 0,
-  nbHits: 0,
+  estimatedTotalHits: 0,
   exhaustiveNbHits: false,
 }