fix: forbid minimumMatch argument with And operator

Author: bevzzz

src/collections/query/index.ts

@@ -247,6 +247,7 @@ export {
   BaseHybridOptions,
   BaseNearOptions,
   BaseNearTextOptions,
+  Bm25OperatorOptions,
   Bm25Options,
   FetchObjectByIdOptions,
   FetchObjectsOptions,
@@ -266,3 +267,5 @@ export {
   QueryReturn,
   SearchOptions,
 } from './types.js';
+
+export { Bm25Operator } from './utils.js';

src/collections/query/integration.test.ts

@@ -152,7 +152,7 @@ describe('Testing of the collection.query methods with a simple collection', ()
     it('should query with hybrid + bm25Operator', async () => {
       const ret = await collection.query.hybrid('carrot', {
         limit: 1,
-        bm25Operator: Bm25Operator.and({ minimumMatch: 1 }),
+        bm25Operator: Bm25Operator.and(),
       });
       expect(ret.objects.length).toEqual(1);
       expect(ret.objects[0].properties.testProp).toEqual('carrot');

src/collections/query/types.ts

@@ -84,10 +84,10 @@ export type Bm25QueryProperty<T> = {
   weight: number;
 };
 
-export type Bm25OperatorOptions = {
-  operator: 'And' | 'Or';
-  minimumMatch: number;
-};
+export type Bm25OperatorOr = { operator: 'Or'; minimumMatch: number };
+export type Bm25OperatorAnd = { operator: 'And' };
+
+export type Bm25OperatorOptions = Bm25OperatorOr | Bm25OperatorAnd;
 
 export type Bm25SearchOptions<T> = {
   /** Which properties of the collection to perform the keyword search on. */

src/collections/query/utils.ts

@@ -1,5 +1,5 @@
 import { MultiTargetVectorJoin } from '../index.js';
-import { Bm25OperatorOptions, NearVectorInputType, TargetVectorInputType } from './types.js';
+import { Bm25OperatorOptions, Bm25OperatorOr, NearVectorInputType, TargetVectorInputType } from './types.js';
 
 export class NearVectorInputGuards {
   public static is1DArray(input: NearVectorInputType): input is number[] {
@@ -36,11 +36,11 @@ export class TargetVectorInputGuards {
 }
 
 export class Bm25Operator {
-  static and(opts: Omit<Bm25OperatorOptions, 'operator'>): Bm25OperatorOptions {
-    return { ...opts, operator: 'And' };
+  static and(): Bm25OperatorOptions {
+    return { operator: 'And' };
   }
 
-  static or(opts: Omit<Bm25OperatorOptions, 'operator'>): Bm25OperatorOptions {
+  static or(opts: Omit<Bm25OperatorOr, 'operator'>): Bm25OperatorOptions {
     return { ...opts, operator: 'Or' };
   }
 }

src/collections/serialize/index.ts

@@ -967,13 +967,14 @@ export class Serialize {
     searchOperator?: Bm25OperatorOptions
   ): SearchOperatorOptions | undefined => {
     if (searchOperator) {
-      return SearchOperatorOptions.fromPartial({
-        minimumOrTokensMatch: searchOperator.minimumMatch,
-        operator:
-          searchOperator.operator === ('And' as const)
-            ? SearchOperatorOptions_Operator.OPERATOR_AND
-            : SearchOperatorOptions_Operator.OPERATOR_OR,
-      });
+      return SearchOperatorOptions.fromPartial(
+        searchOperator.operator === ('And' as const)
+          ? { operator: SearchOperatorOptions_Operator.OPERATOR_AND }
+          : {
+              operator: SearchOperatorOptions_Operator.OPERATOR_OR,
+              minimumOrTokensMatch: searchOperator.minimumMatch,
+            }
+      );
     }
   };