Add a facet search context

Author: bidoubiwa

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

@@ -8,7 +8,7 @@ import {
   FacetDistribution,
   PaginationState,
   MeilisearchConfig,
-  AlgoliaSearchForFacetValuesRequest,
+  AlgoliaSearchForFacetValuesRequests,
   AlgoliaSearchForFacetValuesResponse,
 } from '../types'
 import {
@@ -21,7 +21,7 @@ import {
   adaptSearchParams,
   SearchResolver,
 } from '../adapter'
-import { createSearchContext } from '../contexts'
+import { createSearchContext, createFacetSearchContext } from '../contexts'
 import {
   SearchCache,
   initFacetDistribution,
@@ -135,13 +135,13 @@ export function instantMeiliSearch(
       }
     },
     searchForFacetValues: async function (
-      requests: AlgoliaSearchForFacetValuesRequest
+      requests: AlgoliaSearchForFacetValuesRequests
     ): Promise<AlgoliaSearchForFacetValuesResponse[]> {
       console.log(requests)
 
       const results = []
       for (const request of requests) {
-        const searchContext: SearchContext = createSearchContext(
+        const searchContext: SearchContext = createFacetSearchContext(
           request,
           instantMeiliSearchOptions
         )

packages/instant-meilisearch/src/contexts/index.ts

@@ -1 +1 @@
-export { createSearchContext } from './search-context'
+export { createSearchContext, createFacetSearchContext } from './search-context'

packages/instant-meilisearch/src/contexts/search-context.ts

@@ -2,6 +2,7 @@ import {
   InstantMeiliSearchOptions,
   AlgoliaMultipleQueriesQuery,
   SearchContext,
+  AlgoliaSearchForFacetValuesRequest,
 } from '../types'
 
 import { createPaginationState } from './pagination-context'
@@ -40,3 +41,37 @@ export function createSearchContext(
   }
   return searchContext
 }
+
+// TODO: avoid code duplication
+/**
+ * @param  {AlgoliaMultipleQueriesQuery} searchRequest
+ * @param  {Context} options
+ * @returns {SearchContext}
+ */
+export function createFacetSearchContext(
+  searchRequest: AlgoliaSearchForFacetValuesRequest,
+  options: InstantMeiliSearchOptions
+): SearchContext {
+  // Split index name and possible sorting rules
+  const [indexUid, ...sortByArray] = searchRequest.indexName.split(':')
+  const { params: instantSearchParams } = searchRequest
+
+  const paginationState = createPaginationState(
+    options.finitePagination,
+    instantSearchParams?.hitsPerPage,
+    instantSearchParams?.page
+  )
+
+  const sortState = createSortState(sortByArray.join(':'))
+
+  const searchContext: SearchContext = {
+    ...options,
+    ...instantSearchParams,
+    sort: sortState,
+    indexUid,
+    pagination: paginationState,
+    placeholderSearch: options.placeholderSearch !== false, // true by default
+    keepZeroFacets: !!options.keepZeroFacets, // false by default
+  }
+  return searchContext
+}

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

@@ -1,8 +1,7 @@
 import type { SearchClient } from 'instantsearch.js'
 import type {
   MultipleQueriesQuery as AlgoliaMultipleQueriesQuery,
-  SearchForFacetValuesQueryParams as AlgoliaSearchForFacetValuesQueryParams,
-  SearchOptions as AlgoliaSearchOptions,
+  multipleSearchForFacetValues,
 } from '@algolia/client-search'
 import type {
   MultiSearchQuery as MeiliSearchMultiSearchParams,
@@ -16,10 +15,12 @@ export type {
   SearchForFacetValuesResponse as AlgoliaSearchForFacetValuesResponse,
 } from '@algolia/client-search'
 
-export type AlgoliaSearchForFacetValuesRequest = Array<{
-  readonly indexName: string
-  readonly params: AlgoliaSearchForFacetValuesQueryParams & AlgoliaSearchOptions
-}>
+export type AlgoliaSearchForFacetValuesRequests = Parameters<
+  ReturnType<typeof multipleSearchForFacetValues>
+>[0]
+
+export type AlgoliaSearchForFacetValuesRequest =
+  AlgoliaSearchForFacetValuesRequests[0]
 
 export type {
   Filter,