Merge #1458

1458: Add multi search method of Meilisearch v1.1 r=bidoubiwa a=bidoubiwa

Introduces the `client.multiSearch()` method as per the [specifications](meilisearch/specifications#225)

SDK requirements: meilisearch/integration-guides#251

Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>

README.md

@@ -362,6 +362,16 @@ client.index<T>('xxx').search(query: string, options: SearchParams = {}, config?
 client.index<T>('xxx').searchGet(query: string, options: SearchParams = {}, config?: Partial<Request>): Promise<SearchResponse<T>>
 ```
 
+### Multi Search
+
+#### [Make multiple search requests](https://docs.meilisearch.com/reference/api/multi-search.html)
+
+```ts
+client.multiSearch(queries?: MultiSearchParams, config?: Partial<Request>): Promise<Promise<MultiSearchResponse<T>>>
+```
+
+`multiSearch` uses the `POST` method when performing its request to Meilisearch.
+
 ### Documents <!-- omit in toc -->
 
 #### [Add or replace multiple documents](https://docs.meilisearch.com/reference/api/documents.html#add-or-replace-documents)

src/clients/client.ts

@@ -32,6 +32,8 @@ import {
   SwapIndexesParams,
   CancelTasksQuery,
   DeleteTasksQuery,
+  MultiSearchParams,
+  MultiSearchResponse,
 } from '../types'
 import { HttpRequests } from '../http-requests'
 import { TaskClient, Task } from '../task'
@@ -189,6 +191,40 @@ class Client {
     return await this.httpRequest.post(url, params)
   }
 
+  ///
+  /// Multi Search
+  ///
+
+  /**
+   * Perform multiple search queries.
+   *
+   * It is possible to make multiple search queries on the same index or on
+   * different ones
+   *
+   * @example
+   *
+   * ```ts
+   * client.multiSearch({
+   *   queries: [
+   *     { indexUid: 'movies', q: 'wonder' },
+   *     { indexUid: 'books', q: 'flower' },
+   *   ],
+   * })
+   * ```
+   *
+   * @param queries - Search queries
+   * @param config - Additional request configuration options
+   * @returns Promise containing the search responses
+   */
+  async multiSearch<T extends Record<string, any> = Record<string, any>>(
+    queries?: MultiSearchParams,
+    config?: Partial<Request>
+  ): Promise<MultiSearchResponse<T>> {
+    const url = `/multi-search`
+
+    return await this.httpRequest.post(url, queries, undefined, config)
+  }
+
   ///
   /// TASKS
   ///

src/types/types.ts

@@ -106,6 +106,10 @@ export type SearchRequestGET = Pagination &
     showMatchesPosition?: boolean
   }
 
+export type MultiSearchParams = {
+  queries: Array<SearchParams & { indexUid: string }>
+}
+
 export type CategoriesDistribution = {
   [category: string]: number
 }
@@ -168,6 +172,10 @@ type HasPage<S extends SearchParams> = undefined extends S['page']
   ? false
   : true
 
+export type MultiSearchResponse<T = Record<string, any>> = {
+  results: Array<SearchResponse<T> & { indexUid: string }>
+}
+
 export type FieldDistribution = {
   [field: string]: number
 }

tests/search.test.ts

@@ -17,6 +17,13 @@ const emptyIndex = {
   uid: 'empty_test',
 }
 
+type Books = {
+  id: number
+  title: string
+  comment: string
+  genre: string
+}
+
 const dataset = [
   {
     id: 123,
@@ -85,6 +92,52 @@ describe.each([
     await client.waitForTask(task2)
   })
 
+  test(`${permission} key: Multi index search no queries`, async () => {
+    const client = await getClient(permission)
+    const response = await client.multiSearch({
+      queries: [],
+    })
+
+    expect(response.results.length).toEqual(0)
+  })
+
+  test(`${permission} key: Multi index search with one query`, async () => {
+    const client = await getClient(permission)
+    const response = await client.multiSearch({
+      queries: [{ indexUid: index.uid, q: 'prince' }],
+    })
+
+    expect(response.results[0].hits.length).toEqual(2)
+  })
+
+  test(`${permission} key: Multi index search with multiple queries`, async () => {
+    const client = await getClient(permission)
+    const response = await client.multiSearch({
+      queries: [
+        { indexUid: index.uid, q: 'something' },
+        { indexUid: emptyIndex.uid, q: 'something' },
+      ],
+    })
+
+    expect(response.results.length).toEqual(2)
+  })
+
+  test(`${permission} key: Multi index search with one query`, async () => {
+    const client = await getClient(permission)
+
+    type MyIndex = {
+      id: 1
+    }
+
+    const response = await client.multiSearch<MyIndex & Books>({
+      queries: [{ indexUid: index.uid, q: 'prince' }],
+    })
+
+    expect(response.results[0].hits.length).toEqual(2)
+    expect(response.results[0].hits[0].id).toEqual(456)
+    expect(response.results[0].hits[0].title).toEqual('Le Petit Prince')
+  })
+
   test(`${permission} key: Basic search`, async () => {
     const client = await getClient(permission)
     const response = await client.index(index.uid).search('prince', {})
@@ -739,6 +792,14 @@ describe.each([{ permission: 'No' }])(
         ErrorStatusCode.MISSING_AUTHORIZATION_HEADER
       )
     })
+
+    test(`${permission} key: Try multi search and be denied`, async () => {
+      const client = await getClient(permission)
+      await expect(client.multiSearch({ queries: [] })).rejects.toHaveProperty(
+        'code',
+        ErrorStatusCode.MISSING_AUTHORIZATION_HEADER
+      )
+    })
   }
 )