Add the searchForFacetValues method for Meilisearch v1.3.0 (#1513)

* Add the searchForFacetValue method * Update version for the next release (v0.33.0-prototype-search-for-facet-values.0) (#1514) * Update package.json * Update src/package-version.ts * Change name of searchForFacetValue to searchForFacetValues * Add error codes * Remove only label on test * Fix the typing of the search parameters * Remove unecessary INVALID_SEARCH_FACET error * Fix tests * Update returned fields from hits to facetHits and query to facetQuery * Update version for the next release (vv0.33.0-prototype-search-for-facet-values.1) (#1515) * Update package.json * Update src/package-version.ts --------- Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com> * Apply suggestions from code review * Update README.md Co-authored-by: Bruno Casali <brunoocasali@gmail.com> --------- Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com> Co-authored-by: Bruno Casali <brunoocasali@gmail.com>
meilisearch · Jul 12, 2023 · b61a8e5 · b61a8e5
1 parent 13846f0
commit b61a8e5
Show file tree

Hide file tree

Showing 5 changed files with 369 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -418,6 +418,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>('myIndex').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)

diff --git a/src/indexes.ts b/src/indexes.ts
@@ -45,6 +45,8 @@ import {
   ContentType,
   DocumentsIds,
   DocumentsDeletionQuery,
+  SearchForFacetValuesParams,
+  SearchForFacetValuesResponse,
 } from './types'
 import { removeUndefinedFromObject } from './utils'
 import { HttpRequests } from './http-requests'
@@ -148,6 +150,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
   ///

diff --git a/src/types/types.ts b/src/types/types.ts
@@ -78,6 +78,22 @@ export type Crop = {
   cropMarker?: string
 }
 
+// `facetName` becomes mandatory when using `searchForFacetValues`
+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 +106,8 @@ export type SearchParams = Query &
     matchingStrategy?: MatchingStrategies
     hitsPerPage?: number
     page?: number
+    facetName?: string
+    facetQuery?: string
     vector?: number[] | null
     attributesToSearchOn?: string[] | null
   }
@@ -835,6 +853,15 @@ 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#missing_facet_search_facet_name */
+  MISSING_FACET_SEARCH_FACET_NAME = 'missing_facet_search_facet_name',
+
+  /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_facet_search_facet_query */
+  INVALID_FACET_SEARCH_FACET_QUERY = 'invalid_facet_search_facet_query',
 }
 
 export type TokenIndexRules = {

diff --git a/tests/__snapshots__/facet_search.test.ts.snap b/tests/__snapshots__/facet_search.test.ts.snap
@@ -0,0 +1,205 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Test on POST search Admin key: basic facet value search 1`] = `
+Object {
+  "facetHits": Array [
+    Object {
+      "count": 1,
+      "value": "action",
+    },
+    Object {
+      "count": 2,
+      "value": "adventure",
+    },
+  ],
+  "facetQuery": "a",
+  "processingTimeMs": 0,
+}
+`;
+
+exports[`Test on POST search Admin key: facet value search with filter 1`] = `
+Object {
+  "facetHits": Array [
+    Object {
+      "count": 1,
+      "value": "action",
+    },
+  ],
+  "facetQuery": "a",
+  "processingTimeMs": 0,
+}
+`;
+
+exports[`Test on POST search Admin key: facet value search with no facet query 1`] = `
+Object {
+  "facetHits": Array [
+    Object {
+      "count": 1,
+      "value": "action",
+    },
+    Object {
+      "count": 2,
+      "value": "adventure",
+    },
+    Object {
+      "count": 1,
+      "value": "comedy",
+    },
+    Object {
+      "count": 2,
+      "value": "romance",
+    },
+  ],
+  "facetQuery": null,
+  "processingTimeMs": 0,
+}
+`;
+
+exports[`Test on POST search Admin key: facet value search with search query 1`] = `
+Object {
+  "facetHits": Array [
+    Object {
+      "count": 1,
+      "value": "adventure",
+    },
+  ],
+  "facetQuery": "a",
+  "processingTimeMs": 0,
+}
+`;
+
+exports[`Test on POST search Master key: basic facet value search 1`] = `
+Object {
+  "facetHits": Array [
+    Object {
+      "count": 1,
+      "value": "action",
+    },
+    Object {
+      "count": 2,
+      "value": "adventure",
+    },
+  ],
+  "facetQuery": "a",
+  "processingTimeMs": 0,
+}
+`;
+
+exports[`Test on POST search Master key: facet value search with filter 1`] = `
+Object {
+  "facetHits": Array [
+    Object {
+      "count": 1,
+      "value": "action",
+    },
+  ],
+  "facetQuery": "a",
+  "processingTimeMs": 0,
+}
+`;
+
+exports[`Test on POST search Master key: facet value search with no facet query 1`] = `
+Object {
+  "facetHits": Array [
+    Object {
+      "count": 1,
+      "value": "action",
+    },
+    Object {
+      "count": 2,
+      "value": "adventure",
+    },
+    Object {
+      "count": 1,
+      "value": "comedy",
+    },
+    Object {
+      "count": 2,
+      "value": "romance",
+    },
+  ],
+  "facetQuery": null,
+  "processingTimeMs": 0,
+}
+`;
+
+exports[`Test on POST search Master key: facet value search with search query 1`] = `
+Object {
+  "facetHits": Array [
+    Object {
+      "count": 1,
+      "value": "adventure",
+    },
+  ],
+  "facetQuery": "a",
+  "processingTimeMs": 0,
+}
+`;
+
+exports[`Test on POST search Search key: basic facet value search 1`] = `
+Object {
+  "facetHits": Array [
+    Object {
+      "count": 1,
+      "value": "action",
+    },
+    Object {
+      "count": 2,
+      "value": "adventure",
+    },
+  ],
+  "facetQuery": "a",
+  "processingTimeMs": 0,
+}
+`;
+
+exports[`Test on POST search Search key: facet value search with filter 1`] = `
+Object {
+  "facetHits": Array [
+    Object {
+      "count": 1,
+      "value": "action",
+    },
+  ],
+  "facetQuery": "a",
+  "processingTimeMs": 0,
+}
+`;
+
+exports[`Test on POST search Search key: facet value search with no facet query 1`] = `
+Object {
+  "facetHits": Array [
+    Object {
+      "count": 1,
+      "value": "action",
+    },
+    Object {
+      "count": 2,
+      "value": "adventure",
+    },
+    Object {
+      "count": 1,
+      "value": "comedy",
+    },
+    Object {
+      "count": 2,
+      "value": "romance",
+    },
+  ],
+  "facetQuery": null,
+  "processingTimeMs": 0,
+}
+`;
+
+exports[`Test on POST search Search key: facet value search with search query 1`] = `
+Object {
+  "facetHits": Array [
+    Object {
+      "count": 1,
+      "value": "adventure",
+    },
+  ],
+  "facetQuery": "a",
+  "processingTimeMs": 0,
+}
+`;