Add the searchForFacetValues method for Meilisearch v1.3.0

README.md

@@ -412,6 +412,14 @@ client.multiSearch(queries?: MultiSearchParams, config?: Partial<Request>): Prom
 
 `multiSearch` uses the `POST` method when performing its request to Meilisearch.
 
+### Search For Facet Values
+
+#### [Search for facet values](#)
+
+```ts
+client.index<T>('xxx').searchForFacetValues(params: SearchForFacetValuesParams, config?: Partial<Request>): Promise<SearchForFacetValuesResponse>
+```
+
 ### Documents <!-- omit in toc -->
 
 #### [Add or replace multiple documents](https://www.meilisearch.com/docs/reference/api/documents#add-or-replace-documents)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "meilisearch",
-  "version": "0.33.0",
+  "version": "v0.33.0-prototype-search-for-facet-values.1",
   "description": "The Meilisearch JS client for Node.js and the browser.",
   "keywords": [
     "meilisearch",

src/indexes.ts

@@ -45,6 +45,8 @@ import {
   ContentType,
   DocumentsIds,
   DocumentsDeletionQuery,
+  SearchForFacetValuesParams,
+  SearchForFacetValuesResponse,
 } from './types'
 import { removeUndefinedFromObject } from './utils'
 import { HttpRequests } from './http-requests'
@@ -146,6 +148,27 @@ class Index<T extends Record<string, any> = Record<string, any>> {
     )
   }
 
+  /**
+   * Search for facet values
+   *
+   * @param params - Parameters used to search on the facets
+   * @param config - Additional request configuration options
+   * @returns Promise containing the search response
+   */
+  async searchForFacetValues(
+    params: SearchForFacetValuesParams,
+    config?: Partial<Request>
+  ): Promise<SearchForFacetValuesResponse> {
+    const url = `indexes/${this.uid}/facet-search`
+
+    return await this.httpRequest.post(
+      url,
+      removeUndefinedFromObject(params),
+      undefined,
+      config
+    )
+  }
+
   ///
   /// INDEX
   ///

src/package-version.ts

@@ -1 +1 @@
-export const PACKAGE_VERSION = '0.33.0'
+export const PACKAGE_VERSION = 'v0.33.0-prototype-search-for-facet-values.1'

src/types/types.ts

@@ -78,6 +78,28 @@ export type Crop = {
   cropMarker?: string
 }
 
+export const SortFacetValuesBy = {
+  COUNT: 'error',
+  ALPHA: 'alpha',
+}
+
+export type SortFacetValuesBy = typeof SortFacetValuesBy[keyof typeof SortFacetValuesBy]
+
+export type SearchForFacetValuesParams = Omit<SearchParams, 'facetName'> & {
+  facetName: string
+}
+
+export type FacetHit = {
+  value: string
+  count: number
+}
+
+export type SearchForFacetValuesResponse = {
+  facetHits: FacetHit[]
+  facetQuery: string | null
+  processingTimeMs: number
+}
+
 export type SearchParams = Query &
   Pagination &
   Highlight &
@@ -90,6 +112,9 @@ export type SearchParams = Query &
     matchingStrategy?: MatchingStrategies
     hitsPerPage?: number
     page?: number
+    sortFacetValuesBy?: SortFacetValuesBy
+    facetName?: string
+    facetQuery?: string
   }
 
 // Search parameters for searches made with the GET method
@@ -816,6 +841,18 @@ export const enum ErrorStatusCode {
 
   /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_api_key_offset */
   INVALID_API_KEY_OFFSET = 'invalid_api_key_offset',
+
+  /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_facet_search_facet_name */
+  INVALID_FACET_SEARCH_FACET_NAME = 'invalid_facet_search_facet_name',
+
+  /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_facet_search_query */
+  INVALID_FACET_SEARCH_QUERY = 'invalid_facet_search_query',
+
+  /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_facet_search_name */
+  INVALID_FACET_SEARCH_NAME = 'invalid_facet_search_name',
+
+  /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#missing_facet_search_facet_name */
+  MISSING_FACET_SEARCH_FACET_NAME = 'missing_facet_search_facet_name',
 }
 
 export type TokenIndexRules = {

tests/facet_search.test.ts

@@ -0,0 +1,108 @@
+import {
+  clearAllIndexes,
+  config,
+  getClient,
+} from './utils/meilisearch-test-utils'
+
+const index = {
+  uid: 'movies_test',
+}
+
+const dataset = [
+  {
+    id: 123,
+    title: 'Pride and Prejudice',
+    genres: ['romance', 'action'],
+  },
+  {
+    id: 456,
+    title: 'Le Petit Prince',
+    genres: ['adventure', 'comedy'],
+  },
+  {
+    id: 2,
+    title: 'Le Rouge et le Noir',
+    genres: 'romance',
+  },
+  {
+    id: 1,
+    title: 'Alice In Wonderland',
+    genres: ['adventure'],
+  },
+]
+
+describe.each([
+  { permission: 'Master' },
+  { permission: 'Admin' },
+  { permission: 'Search' },
+])('Test on POST search', ({ permission }) => {
+  beforeAll(async () => {
+    await clearAllIndexes(config)
+    const client = await getClient('Master')
+    const newFilterableAttributes = ['genres', 'title']
+    await client.createIndex(index.uid)
+    await client.index(index.uid).updateSettings({
+      filterableAttributes: newFilterableAttributes,
+    })
+    const { taskUid } = await client.index(index.uid).addDocuments(dataset)
+    await client.waitForTask(taskUid)
+  })
+
+  test(`${permission} key: basic facet value search`, async () => {
+    const client = await getClient(permission)
+
+    const params = {
+      facetQuery: 'a',
+      facetName: 'genres',
+    }
+    const response = await client.index(index.uid).searchForFacetValues(params)
+
+    expect(response.facetHits.length).toEqual(2)
+    expect(response.facetQuery).toEqual('a')
+  })
+
+  test(`${permission} key: facet value search with no facet query`, async () => {
+    const client = await getClient(permission)
+
+    const params = {
+      facetName: 'genres',
+    }
+    const response = await client.index(index.uid).searchForFacetValues(params)
+
+    expect(response.facetHits.length).toEqual(4)
+    expect(response.facetQuery).toEqual(null)
+  })
+
+  test(`${permission} key: facet value search with filter`, async () => {
+    const client = await getClient(permission)
+
+    const params = {
+      facetName: 'genres',
+      facetQuery: 'a',
+      filter: ['genres = action'],
+    }
+
+    const response = await client.index(index.uid).searchForFacetValues(params)
+
+    expect(response.facetHits.length).toEqual(1)
+  })
+
+  test(`${permission} key: facet value search with search query`, async () => {
+    const client = await getClient(permission)
+
+    const params = {
+      facetName: 'genres',
+      facetQuery: 'a',
+      q: 'Alice',
+    }
+    const response = await client.index(index.uid).searchForFacetValues(params)
+
+    expect(response.facetHits.length).toEqual(1)
+  })
+})
+
+jest.setTimeout(100 * 1000)
+
+afterAll(() => {
+  return clearAllIndexes(config)
+})