feat: minimum should match parameter

Author: przemyslawwalczak

src/lib/parameters/get-minimum-should-match.ts

@@ -0,0 +1,8 @@
+export type MinimumShouldMatchParameter = {
+    minimum_should_match?: number | string
+}
+
+export const getMinimumShouldMatchParameter = (value: number | string): MinimumShouldMatchParameter => ({
+    // eslint-disable-next-line camelcase
+    minimum_should_match: value
+})

src/lib/parameters/index.ts

@@ -0,0 +1 @@
+export * from './get-minimum-should-match'

src/lib/queries/get-bool.spec.ts

@@ -1,15 +1,18 @@
 import { faker } from '@faker-js/faker'
+import { getMinimumShouldMatchParameter } from 'lib/parameters'
 import { HomeDocument, PropertyType } from 'test/module'
 import { getBoolQuery } from './get-bool'
 import { getRangeQuery } from './get-range'
+import { getShouldQuery } from './get-should'
 import { getTermQuery } from './get-term'
 import { getTermsQuery } from './get-terms'
 
 describe('getBoolQuery', () => {
     it('accepts optional must query', () => {
         const id = faker.string.uuid()
         const query = getBoolQuery<HomeDocument>({
-            should: [
+            ...getMinimumShouldMatchParameter(1),
+            ...getShouldQuery([
                 getTermQuery('id.keyword', id),
                 getTermQuery('id', id),
                 getTermsQuery('propertyType', [PropertyType.Apartment]),
@@ -22,7 +25,7 @@ describe('getBoolQuery', () => {
                     gte: 500,
                     lte: 1000
                 })
-            ]
+            ])
         })
 
         expect(query).toEqual({
@@ -41,7 +44,9 @@ describe('getBoolQuery', () => {
                             propertyAreaSquared: { gte: 500, lte: 1000 }
                         }
                     }
-                ]
+                ],
+                // eslint-disable-next-line camelcase
+                minimum_should_match: 1
             }
         })
     })

src/lib/queries/get-bool.ts

@@ -2,8 +2,13 @@ import { Document } from 'lib/types'
 import { ShouldQuery } from './get-should'
 import { MustQuery } from './get-must'
 import { MustNotQuery } from './get-must-not'
+import { MinimumShouldMatchParameter } from 'lib/parameters'
 
-export type BoolQueryBody<TDocument extends Document> = MustQuery<TDocument> & ShouldQuery<TDocument> & MustNotQuery<TDocument>
+export type BoolQueryBody<TDocument extends Document> =
+    MustQuery<TDocument> &
+    ShouldQuery<TDocument> &
+    MustNotQuery<TDocument> &
+    MinimumShouldMatchParameter
 
 export type BoolQuery<TDocument extends Document> = {
     bool: BoolQueryBody<TDocument> | Array<BoolQueryBody<TDocument>>