Allow query in search options

Author: bidoubiwa

src/indexes.ts

@@ -81,7 +81,7 @@ class Index<T = Record<string, any>> {
 
     return await this.httpRequest.post(
       url,
-      removeUndefinedFromObject({ ...options, q: query }),
+      removeUndefinedFromObject({ q: query, ...options }),
       undefined,
       config
     )

src/types/types.ts

@@ -66,7 +66,8 @@ export type Crop = {
   cropMarker?: string
 }
 
-export type SearchParams = Pagination &
+export type SearchParams = Query &
+  Pagination &
   Highlight &
   Crop & {
     filter?: Filter
@@ -76,8 +77,6 @@ export type SearchParams = Pagination &
     matches?: boolean
   }
 
-export type SearchRequest = SearchParams & Query
-
 // Search parameters for searches made with the GET method
 // Are different than the parameters for the POST method
 export type SearchRequestGET = Pagination &

tests/search.test.ts

@@ -93,6 +93,32 @@ describe.each([
     expect(response.hits.length).toEqual(2)
   })
 
+  test(`${permission} key: Search with query in searchParams overwriting query`, async () => {
+    const client = await getClient(permission)
+    const response = await client
+      .index(index.uid)
+      .search('other', { q: 'prince' })
+
+    expect(response).toHaveProperty('hits', expect.any(Array))
+    expect(response).toHaveProperty('offset', 0)
+    expect(response).toHaveProperty('limit', 20)
+    expect(response).toHaveProperty('processingTimeMs', expect.any(Number))
+    expect(response).toHaveProperty('query', 'prince')
+    expect(response.hits.length).toEqual(2)
+  })
+
+  test(`${permission} key: Search with query in searchParams overwriting null query`, async () => {
+    const client = await getClient(permission)
+    const response = await client.index(index.uid).search(null, { q: 'prince' })
+
+    expect(response).toHaveProperty('hits', expect.any(Array))
+    expect(response).toHaveProperty('offset', 0)
+    expect(response).toHaveProperty('limit', 20)
+    expect(response).toHaveProperty('processingTimeMs', expect.any(Number))
+    expect(response).toHaveProperty('query', 'prince')
+    expect(response.hits.length).toEqual(2)
+  })
+
   test(`${permission} key: Basic phrase search`, async () => {
     const client = await getClient(permission)
     const response = await client

tests/typed_search.test.ts

@@ -113,6 +113,15 @@ describe.each([
     expect(response.query === 'prince').toBeTruthy()
   })
 
+  test(`${permission} key: Search with query in searchParams`, async () => {
+    const client = await getClient(permission)
+    const response = await client
+      .index(index.uid)
+      .search('other', { q: 'prince' }) // ensures `q` is a valid field in SearchParams type
+
+    expect(response).toHaveProperty('query', 'prince')
+  })
+
   test(`${permission} key: Search with options`, async () => {
     const client = await getClient(permission)
     const response = await client