Feature/add options support to liek and regex

package.json

@@ -1,6 +1,6 @@
 {
     "name": "rsql-query-builder-mongodb",
-    "version": "1.2.0",
+    "version": "1.3.0",
     "description": "Library for building RSQL query strings for MongoDB.",
     "main": "dist/index.js",
     "module": "dist/index.mjs",

src/RSQLBuilderMongoDB.test.ts

@@ -1,22 +1,66 @@
 import { describe, it, expect } from 'vitest';
 
-import { RSQLBuilderMongoDB } from './';
+import { MongoRegexOptions, RSQLBuilderMongoDB } from './';
 
 describe('RSQLBuilderMongoDB', () => {
     it("Test operator REGEX ('=regex=')", () => {
-        expect(new RSQLBuilderMongoDB().regex('name', 'Filip').toString()).toBe('name=regex="Filip"');
+        expect(new RSQLBuilderMongoDB().regex('name', 'Fil*').toString()).toBe('name=regex="Fil*"');
+        expect(new RSQLBuilderMongoDB().regex('name', 'Fil*', 'si').toString()).toBe('name=regex="Fil*"=si');
+        expect(
+            new RSQLBuilderMongoDB()
+                .regex('name', 'Fil*', [
+                    MongoRegexOptions.DOTALL,
+                    MongoRegexOptions.CASE_INSENSITIVE,
+                    MongoRegexOptions.MULTILINE,
+                    MongoRegexOptions.EXTENDED
+                ])
+                .toString()
+        ).toBe('name=regex="Fil*"=simx');
     });
 
     it("Test operator NOT REGEX ('=notregex=')", () => {
         expect(new RSQLBuilderMongoDB().notRegex('name', 'Filip').toString()).toBe('name=notregex="Filip"');
+        expect(new RSQLBuilderMongoDB().notRegex('name', 'Fil*', 'si').toString()).toBe('name=notregex="Fil*"=si');
+        expect(
+            new RSQLBuilderMongoDB()
+                .notRegex('name', 'Fil*', [
+                    MongoRegexOptions.DOTALL,
+                    MongoRegexOptions.CASE_INSENSITIVE,
+                    MongoRegexOptions.MULTILINE,
+                    MongoRegexOptions.EXTENDED
+                ])
+                .toString()
+        ).toBe('name=notregex="Fil*"=simx');
     });
 
     it("Test operator LIKE ('=regex=')", () => {
         expect(new RSQLBuilderMongoDB().like('name', 'Fil*').toString()).toBe('name=regex="Fil*"');
+        expect(new RSQLBuilderMongoDB().like('name', 'Fil*', 'si').toString()).toBe('name=regex="Fil*"=si');
+        expect(
+            new RSQLBuilderMongoDB()
+                .like('name', 'Fil*', [
+                    MongoRegexOptions.DOTALL,
+                    MongoRegexOptions.CASE_INSENSITIVE,
+                    MongoRegexOptions.MULTILINE,
+                    MongoRegexOptions.EXTENDED
+                ])
+                .toString()
+        ).toBe('name=regex="Fil*"=simx');
     });
 
     it("Test operator LIKE ('=notregex=')", () => {
         expect(new RSQLBuilderMongoDB().notLike('name', 'Fil*').toString()).toBe('name=notregex="Fil*"');
+        expect(new RSQLBuilderMongoDB().notLike('name', 'Fil*', 'si').toString()).toBe('name=notregex="Fil*"=si');
+        expect(
+            new RSQLBuilderMongoDB()
+                .notLike('name', 'Fil*', [
+                    MongoRegexOptions.DOTALL,
+                    MongoRegexOptions.CASE_INSENSITIVE,
+                    MongoRegexOptions.MULTILINE,
+                    MongoRegexOptions.EXTENDED
+                ])
+                .toString()
+        ).toBe('name=notregex="Fil*"=simx');
     });
 
     it("Test operator EXISTS ('=exists=')", () => {

src/RSQLBuilderMongoDB.ts

@@ -4,6 +4,13 @@ import { RSQLBuilderBase, RSQLBuilderOptions } from 'rsql-query-builder';
 
 type ComparisonOperator = 'regex' | 'notRegex' | 'exists';
 
+export enum MongoRegexOptions {
+    CASE_INSENSITIVE = 'i', // Ignore case
+    MULTILINE = 'm', // Multiline mode
+    DOTALL = 's', // Dot matches newline
+    EXTENDED = 'x' // Ignore whitespace and allow comments
+}
+
 /** RSQL Query Builder for MongoDB.
  *
  * @template Selector - The type of the selector. It is used to define the selector names and is a list of strings.
@@ -28,8 +35,16 @@ class RSQLBuilderMongoDB<TSelector extends string> extends RSQLBuilderBase<TSele
      *
      * @see https://www.mongodb.com/docs/manual/reference/operator/query/regex/
      */
-    public regex(selector: TSelector, regex: string, options?: string): RSQLBuilderMongoDB<TSelector> {
-        super.addComparison(selector, 'regex', regex);
+    public regex(
+        selector: TSelector,
+        regex: string,
+        options?: string | Array<MongoRegexOptions>
+    ): RSQLBuilderMongoDB<TSelector> {
+        if (Array.isArray(options)) {
+            options = options.join('');
+        }
+
+        super.addComparison(selector, 'regex', regex, options);
         return this;
     }
 
@@ -42,8 +57,16 @@ class RSQLBuilderMongoDB<TSelector extends string> extends RSQLBuilderBase<TSele
      *
      * @see https://www.mongodb.com/docs/manual/reference/operator/query/regex/
      */
-    public notRegex(selector: TSelector, regex: string, options?: string): RSQLBuilderMongoDB<TSelector> {
-        super.addComparison(selector, 'notRegex', regex);
+    public notRegex(
+        selector: TSelector,
+        regex: string,
+        options?: string | Array<MongoRegexOptions>
+    ): RSQLBuilderMongoDB<TSelector> {
+        if (Array.isArray(options)) {
+            options = options.join('');
+        }
+
+        super.addComparison(selector, 'notRegex', regex, options);
         return this;
     }
 
@@ -56,7 +79,15 @@ class RSQLBuilderMongoDB<TSelector extends string> extends RSQLBuilderBase<TSele
      *
      * @see https://www.mongodb.com/docs/manual/reference/operator/query/regex/
      */
-    public like(selector: TSelector, regex: string, options?: string): RSQLBuilderMongoDB<TSelector> {
+    public like(
+        selector: TSelector,
+        regex: string,
+        options?: string | Array<MongoRegexOptions>
+    ): RSQLBuilderMongoDB<TSelector> {
+        if (Array.isArray(options)) {
+            options = options.join('');
+        }
+
         return this.regex(selector, regex, options);
     }
 
@@ -69,7 +100,15 @@ class RSQLBuilderMongoDB<TSelector extends string> extends RSQLBuilderBase<TSele
      *
      * @see https://www.mongodb.com/docs/manual/reference/operator/query/regex/
      */
-    public notLike(selector: TSelector, regex: string, options?: string): RSQLBuilderMongoDB<TSelector> {
+    public notLike(
+        selector: TSelector,
+        regex: string,
+        options?: string | Array<MongoRegexOptions>
+    ): RSQLBuilderMongoDB<TSelector> {
+        if (Array.isArray(options)) {
+            options = options.join('');
+        }
+
         return this.notRegex(selector, regex, options);
     }
 

src/index.ts

@@ -1 +1 @@
-export {default as RSQLBuilderMongoDB} from './RSQLBuilderMongoDB';
+export { default as RSQLBuilderMongoDB, MongoRegexOptions } from './RSQLBuilderMongoDB';