add rankingScoreThreshold as a search parameter

Author: Strift

package.json

@@ -43,5 +43,6 @@
   "dependencies": {
     "@changesets/cli": "^2.26.1",
     "instantsearch.css": "^8.0.0"
-  }
+  },
+  "packageManager": "[email protected]"
 }

packages/instant-meilisearch/src/adapter/search-request-adapter/__tests__/search-params.test.ts

@@ -95,6 +95,19 @@ describe('Parameters adapter', () => {
     expect(searchParams.hybrid).toBe(hybridSearchConfig)
   })
 
+  test('ranking score threshold can be set via search parameters', () => {
+    const rankingScoreThreshold = 0.974
+
+    const searchParams = adaptSearchParams({
+      ...DEFAULT_CONTEXT,
+      meiliSearchParams: {
+        rankingScoreThreshold,
+      },
+    })
+
+    expect(searchParams.rankingScoreThreshold).toBe(rankingScoreThreshold)
+  })
+
   test('distinct search configuration can be set via search parameters', () => {
     const distinctSearchConfig = 'title'
 

packages/instant-meilisearch/src/adapter/search-request-adapter/search-params-adapter.ts

@@ -244,6 +244,12 @@ export function MeiliParamsCreator(searchContext: SearchContext) {
         meiliSearchParams.distinct = value
       }
     },
+    addRankingScoreThreshold() {
+      const value = overrideParams?.rankingScoreThreshold
+      if (value !== undefined) {
+        meiliSearchParams.rankingScoreThreshold = value
+      }
+    },
   }
 }
 
@@ -277,6 +283,7 @@ export function adaptSearchParams(
   meilisearchParams.addAttributesToSearchOn()
   meilisearchParams.addHybridSearch()
   meilisearchParams.addDistinct()
+  meilisearchParams.addRankingScoreThreshold()
 
   return meilisearchParams.getParams()
 }

packages/instant-meilisearch/src/types/types.ts

@@ -43,19 +43,20 @@ export type InstantSearchParams = NonNullable<
 
 export type OverridableMeiliSearchSearchParameters = Pick<
   MeiliSearchMultiSearchParams,
-  | 'attributesToRetrieve'
   | 'attributesToCrop'
+  | 'attributesToRetrieve'
+  | 'attributesToSearchOn'
   | 'cropLength'
   | 'cropMarker'
   | 'attributesToHighlight'
+  | 'distinct'
   | 'highlightPreTag'
   | 'highlightPostTag'
-  | 'showMatchesPosition'
+  | 'hybrid'
   | 'matchingStrategy'
+  | 'rankingScoreThreshold'
+  | 'showMatchesPosition'
   | 'showRankingScore'
-  | 'attributesToSearchOn'
-  | 'hybrid'
-  | 'distinct'
 >
 
 type BaseInstantMeiliSearchOptions = {