Update search route request and response parameters naming v0.28.x (#779)

Author: bidoubiwa

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

@@ -62,10 +62,10 @@ export function getFacetsFromFilter(filters?: Filter): FacetsCache {
 }
 
 function getFacetsFromDefaultDistribution(
-  facetsDistribution: FacetsDistribution
+  facetDistribution: FacetsDistribution
 ): 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,8 +91,8 @@ 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.
  *
  *

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,
 }

src/cache/first-facets-distribution.ts

@@ -1,14 +1,14 @@
 import { FacetsDistribution } from '../types'
 
-export function cacheFirstFacetsDistribution(
+export function cacheFirstFacetDistribution(
   defaultFacetDistribution: FacetsDistribution,
   searchResponse: any
 ): FacetsDistribution {
   if (
     searchResponse.query === '' &&
     Object.keys(defaultFacetDistribution).length === 0
   ) {
-    return searchResponse.facetsDistribution
+    return searchResponse.facetDistribution
   }
   return defaultFacetDistribution
 }

src/client/instant-meilisearch-client.ts

@@ -12,7 +12,7 @@ import {
   SearchResolver,
 } from '../adapter'
 import { createSearchContext } from '../contexts'
-import { SearchCache, cacheFirstFacetsDistribution } from '../cache/'
+import { SearchCache, cacheFirstFacetDistribution } from '../cache/'
 
 /**
  * Instanciate SearchClient required by instantsearch.js.
@@ -60,9 +60,9 @@ export function instantMeiliSearch(
         )
 
         // Cache first facets distribution of the instantMeilisearch instance
-        // Needed to add in the facetsDistribution the fields that were not returned
+        // Needed to add in the facetDistribution the fields that were not returned
         // When the user sets `keepZeroFacets` to true.
-        defaultFacetDistribution = cacheFirstFacetsDistribution(
+        defaultFacetDistribution = cacheFirstFacetDistribution(
           defaultFacetDistribution,
           searchResponse
         )

src/types/types.ts

@@ -1,5 +1,4 @@
 import type {
-  MeiliSearch,
   SearchResponse as MeiliSearchResponse,
   FacetsDistribution,
 } from 'meilisearch'

tests/configure.attributes-to-retrieve.tests.ts

@@ -8,12 +8,12 @@ import {
 describe('Instant Meilisearch Browser test', () => {
   beforeAll(async () => {
     const deleteTask = await meilisearchClient.deleteIndex('movies')
-    await meilisearchClient.waitForTask(deleteTask.uid)
+    await meilisearchClient.waitForTask(deleteTask.taskUid)
 
     const documentsTask = await meilisearchClient
       .index('movies')
       .addDocuments(dataset)
-    await meilisearchClient.index('movies').waitForTask(documentsTask.uid)
+    await meilisearchClient.index('movies').waitForTask(documentsTask.taskUid)
   })
 
   test('Test attributesToRetrieve on no attributes', async () => {