Search method can only accept array of string on bigamous fields

Author: bidoubiwa

src/index.ts

@@ -7,11 +7,11 @@
 
 'use strict'
 
-import MeiliSearchTimeOutError from './errors/meilisearch-timeout-error'
 import MeiliSearchError from './errors/meilisearch-error'
+import MeiliSearchTimeOutError from './errors/meilisearch-timeout-error'
 import MeiliAxiosWrapper from './meili-axios-wrapper'
 import * as Types from './types'
-import { sleep, joinIfArray, createArrayIfString } from './utils'
+import { sleep } from './utils'
 
 class Index<T> extends MeiliAxiosWrapper implements Types.IndexInterface<T> {
   uid: string
@@ -79,51 +79,44 @@ class Index<T> extends MeiliAxiosWrapper implements Types.IndexInterface<T> {
     method: 'POST' | 'GET' = 'POST'
   ): Promise<Types.SearchResponse<T, P>> {
     const url = `/indexes/${this.uid}/search`
-    let params: Types.SearchRequest = {
+    const params: Types.SearchRequest = {
       q: query,
       offset: options?.offset,
       limit: options?.limit,
       cropLength: options?.cropLength,
       filters: options?.filters,
       matches: options?.matches,
+      facetFilters: options?.facetFilters,
+      facetsDistribution: options?.facetsDistribution,
+      attributesToRetrieve: options?.attributesToRetrieve,
+      attributesToCrop: options?.attributesToCrop,
+      attributesToHighlight: options?.attributesToHighlight,
     }
     if (method.toUpperCase() === 'POST') {
-      params = {
-        ...params,
-        facetFilters: options?.facetFilters,
-        facetsDistribution: options?.facetsDistribution,
-        attributesToRetrieve: options?.attributesToRetrieve
-          ? createArrayIfString(options.attributesToRetrieve)
-          : undefined,
-        attributesToCrop: options?.attributesToCrop
-          ? createArrayIfString(options.attributesToCrop)
-          : undefined,
-        attributesToHighlight: options?.attributesToHighlight
-          ? createArrayIfString(options.attributesToHighlight)
-          : undefined,
-      }
       return await this.post(url, params, {
         cancelToken: this.cancelTokenSource.token,
       })
     } else if (method.toUpperCase() === 'GET') {
       const getParams: Types.GetSearchRequest = {
         ...params,
-        facetFilters: options?.facetFilters
-          ? JSON.stringify(options.facetFilters)
-          : undefined,
+        facetFilters:
+          Array.isArray(options?.facetFilters) && options?.facetFilters
+            ? JSON.stringify(options.facetFilters)
+            : undefined,
         facetsDistribution: options?.facetsDistribution
           ? JSON.stringify(options.facetsDistribution)
           : undefined,
         attributesToRetrieve: options?.attributesToRetrieve
-          ? joinIfArray(options.attributesToRetrieve)
+          ? options.attributesToRetrieve.join(',')
           : undefined,
         attributesToCrop: options?.attributesToCrop
-          ? joinIfArray(options.attributesToCrop)
+          ? options.attributesToCrop.join(',')
           : undefined,
         attributesToHighlight: options?.attributesToHighlight
-          ? joinIfArray(options.attributesToHighlight)
+          ? options.attributesToHighlight.join(',')
           : undefined,
       }
+
       return await this.get(url, {
         params: getParams,
         cancelToken: this.cancelTokenSource.token,

src/types.ts

@@ -58,18 +58,12 @@ export type FacetFilter = Array<string | string[]>
 export interface SearchParams<T> {
   offset?: number
   limit?: number
-  attributesToRetrieve?:
-    | Array<Extract<keyof T, string>>
-    | Extract<keyof T, string>
-  attributesToCrop?:
-    | Array<Extract<keyof T, string> | '*'>
-    | (Extract<keyof T, string> | '*')
+  attributesToRetrieve?: Array<Extract<keyof T, string> | '*'>
+  attributesToCrop?: Array<Extract<keyof T, string> | '*'>
   cropLength?: number
-  attributesToHighlight?:
-    | Array<Extract<keyof T, string> | '*'>
-    | (Extract<keyof T, string> | '*')
+  attributesToHighlight?: Array<Extract<keyof T, string> | '*'>
   filters?: string
-  facetFilters?: string | FacetFilter | FacetFilter[]
+  facetFilters?: FacetFilter | FacetFilter[]
   facetsDistribution?: string[]
   matches?: boolean
 }
@@ -109,16 +103,7 @@ export interface SearchResponse<T, P extends SearchParams<T>> {
   // P represents the SearchParams
   // and by using the indexer P['attributesToRetrieve'], we're able to pick the type of `attributesToRetrieve`
   // and check whether the attribute is a single key present in the generic
-  hits: P['attributesToRetrieve'] extends keyof T // `attributesToRetrieve` contains one single key
-    ? Array<
-        // So we return an array of
-        Hit<
-          // hits
-          // We exclude the `attributesToRetrieve` first from the generic, and then we exclude what has been returned to make sure we only Pick the `attributesToRetrieve` on the generic T
-          Pick<T, Exclude<keyof T, Exclude<keyof T, P['attributesToRetrieve']>>>
-        >
-      >
-    : P['attributesToRetrieve'] extends Array<infer K> // Otherwise if P['attributesToRetrieve'] is an array, we use `infer K` to extract the keys in the array in place
+  hits: P['attributesToRetrieve'] extends Array<infer K> // if P['attributesToRetrieve'] is an array, we use `infer K` to extract the keys in the array in place
     ? Array<Hit<Pick<T, Exclude<keyof T, Exclude<keyof T, K>>>>> // Same extraction method as above when we have a single `attributesToRetrieve`
     : Array<Hit<T>> // Finally return the full type as `attributesToRetrieve` is neither a single key nor an array of keys
   offset: number

src/utils.ts

@@ -2,14 +2,4 @@ async function sleep(ms: number): Promise<void> {
   return await new Promise((resolve) => setTimeout(resolve, ms))
 }
 
-function joinIfArray(params: string | string[]): string {
-  if (Array.isArray(params)) return params.join(',')
-  else return params
-}
-
-function createArrayIfString(params: string | string[]): string[] {
-  if (Array.isArray(params)) return params
-  else return [params]
-}
-
-export { sleep, joinIfArray, createArrayIfString }
+export { sleep }

tests/get_search_tests.ts

@@ -160,7 +160,7 @@ describe.each([
         'prince',
         {
           filters: 'title = "Le Petit Prince"',
-          attributesToCrop: '*',
+          attributesToCrop: ['*'],
           cropLength: 5,
           matches: true,
         },
@@ -189,9 +189,9 @@ describe.each([
           limit: 5,
           offset: 0,
           attributesToRetrieve: ['id', 'title'],
-          attributesToCrop: '*',
+          attributesToCrop: ['*'],
           cropLength: 6,
-          attributesToHighlight: '*',
+          attributesToHighlight: ['*'],
           filters: 'title = "Le Petit Prince"',
           matches: true,
         },
@@ -233,10 +233,10 @@ describe.each([
         {
           limit: 5,
           offset: 0,
-          attributesToRetrieve: '*',
-          attributesToCrop: '*',
+          attributesToRetrieve: ['*'],
+          attributesToCrop: ['*'],
           cropLength: 6,
-          attributesToHighlight: '*',
+          attributesToHighlight: ['*'],
           filters: 'title = "Le Petit Prince"',
           matches: true,
         },
@@ -383,20 +383,6 @@ describe.each([
       })
   })
 
-  test(`${permission} key: Search with one string facetFilters `, async () => {
-    await expect(
-      client.getIndex(index.uid).search(
-        'a',
-        {
-          facetFilters: 'genre:romance',
-        },
-        'GET'
-      )
-    ).rejects.toThrowError(
-      `error processing facet filter: unexpected token "genre:romance", expected Array`
-    )
-  })
-
   test(`${permission} key: Try to Search on deleted index and fail`, async () => {
     await masterClient.getIndex(index.uid).deleteIndex()
     await expect(

tests/search_tests.ts

@@ -154,7 +154,7 @@ describe.each([
       .getIndex(index.uid)
       .search('prince', {
         filters: 'title = "Le Petit Prince"',
-        attributesToCrop: '*',
+        attributesToCrop: ['*'],
         cropLength: 5,
         matches: true,
       })
@@ -179,9 +179,9 @@ describe.each([
         limit: 5,
         offset: 0,
         attributesToRetrieve: ['id', 'title'],
-        attributesToCrop: '*',
+        attributesToCrop: ['*'],
         cropLength: 6,
-        attributesToHighlight: '*',
+        attributesToHighlight: ['*'],
         filters: 'title = "Le Petit Prince"',
         matches: true,
       })
@@ -219,10 +219,10 @@ describe.each([
       .search('prince', {
         limit: 5,
         offset: 0,
-        attributesToRetrieve: '*',
-        attributesToCrop: '*',
+        attributesToRetrieve: ['*'],
+        attributesToCrop: ['*'],
         cropLength: 6,
-        attributesToHighlight: '*',
+        attributesToHighlight: ['*'],
         filters: 'title = "Le Petit Prince"',
         matches: true,
       })