Add facetStats compatibility to be aware of min and max for MS v1.1.0

Author: bidoubiwa

packages/instant-meilisearch/src/adapter/search-response-adapter/adapt-facet-stats.ts

@@ -0,0 +1,19 @@
+import {
+  AlgoliaSearchResponse,
+  MeiliFacetStats,
+  AlgoliaFacetStats,
+} from '../../types'
+
+export function adaptFacetStats(
+  meiliFacetStats: MeiliFacetStats
+): AlgoliaSearchResponse['facets_stats'] {
+  const facetStats = Object.keys(meiliFacetStats).reduce(
+    (stats: AlgoliaFacetStats, facet: string) => {
+      stats[facet] = { ...meiliFacetStats[facet], avg: 0, sum: 0 } // Set at 0 as these numbers are not provided by Meilisearch
+
+      return stats
+    },
+    {} as AlgoliaFacetStats
+  )
+  return facetStats
+}

packages/instant-meilisearch/src/adapter/search-response-adapter/search-response-adapter.ts

@@ -8,6 +8,7 @@ import { adaptHits } from './hits-adapter'
 import { adaptTotalHits } from './total-hits-adapter'
 import { adaptPaginationParameters } from './pagination-adapter'
 import { adaptFacetDistribution } from './facet-distribution-adapter'
+import { adaptFacetStats } from './adapt-facet-stats'
 
 /**
  * Adapt multiple search results from Meilisearch
@@ -54,6 +55,7 @@ export function adaptSearchResult<T>(
     query,
     indexUid,
     facetDistribution: responseFacetDistribution = {},
+    facetStats = {},
   } = meiliSearchResult
 
   const facets = Object.keys(responseFacetDistribution)
@@ -86,6 +88,7 @@ export function adaptSearchResult<T>(
     hits,
     params: '',
     exhaustiveNbHits: false,
+    facets_stats: adaptFacetStats(facetStats),
   }
   return adaptedSearchResult
 }

packages/instant-meilisearch/src/types/types.ts

@@ -15,7 +15,12 @@ export type {
 }
 export type { SearchResponse as AlgoliaSearchResponse } from '@algolia/client-search'
 
-export type { Filter, FacetDistribution, MeiliSearch } from 'meilisearch'
+export type {
+  Filter,
+  FacetDistribution,
+  MeiliSearch,
+  FacetStats as MeiliFacetStats,
+} from 'meilisearch'
 
 export type InstantSearchParams = AlgoliaMultipleQueriesQuery['params']
 
@@ -109,3 +114,25 @@ export type MultiSearchResolver = {
     instantSearchPagination: PaginationState[]
   ) => Promise<MeilisearchMultiSearchResult[]>
 }
+
+export type AlgoliaFacetStats = Record<
+  string,
+  {
+    /**
+     * The minimum value in the result set.
+     */
+    min: number
+    /**
+     * The maximum value in the result set.
+     */
+    max: number
+    /**
+     * The average facet value in the result set.
+     */
+    avg: number
+    /**
+     * The sum of all values in the result set.
+     */
+    sum: number
+  }
+>