Remove undefined from object before sending search

Author: bidoubiwa

src/index.ts

@@ -11,7 +11,7 @@ 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 } from './utils'
+import { sleep, removeUndefinedFromObject } from './utils'
 
 class Index<T> extends MeiliAxiosWrapper implements Types.IndexInterface<T> {
   uid: string
@@ -93,7 +93,7 @@ class Index<T> extends MeiliAxiosWrapper implements Types.IndexInterface<T> {
       attributesToHighlight: options?.attributesToHighlight,
     }
     if (method.toUpperCase() === 'POST') {
-      return await this.post(url, params, {
+      return await this.post(url, removeUndefinedFromObject(params), {
         cancelToken: this.cancelTokenSource.token,
       })
     } else if (method.toUpperCase() === 'GET') {
@@ -118,7 +118,7 @@ class Index<T> extends MeiliAxiosWrapper implements Types.IndexInterface<T> {
       }
 
       return await this.get(url, {
-        params: getParams,
+        params: removeUndefinedFromObject(getParams),
         cancelToken: this.cancelTokenSource.token,
       })
     } else {

src/types.ts

@@ -76,7 +76,7 @@ export interface SearchRequest {
   attributesToRetrieve?: string[]
   attributesToCrop?: string[]
   attributesToHighlight?: string[]
-  facetFilters?: string | FacetFilter | FacetFilter[]
+  facetFilters?: FacetFilter | FacetFilter[]
   facetsDistribution?: string[]
   filters?: string
   matches?: boolean

src/utils.ts

@@ -1,5 +1,14 @@
+function removeUndefinedFromObject(object: Record<string, any>): object {
+  return Object.keys(object).reduce((acc: Record<string, any>, key: string) => {
+    if (object[key] !== undefined) {
+      acc[key] = object[key]
+    }
+    return acc
+  }, {})
+}
+
 async function sleep(ms: number): Promise<void> {
   return await new Promise((resolve) => setTimeout(resolve, ms))
 }
 
-export { sleep }
+export { sleep, removeUndefinedFromObject }

tests/search_tests.ts

@@ -351,16 +351,6 @@ describe.each([
       })
   })
 
-  test(`${permission} key: Try to Search with one string facetFilters and fail`, async () => {
-    await expect(
-      client.getIndex(index.uid).search('a', {
-        facetFilters: 'genre:romance',
-      })
-    ).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(