lucene-query-builder - npm Package Compare versions

Comparing version 0.7.3 to 0.7.4

lib/cjs/constants/defaultValues.d.ts

 export declare const defaultValues: {
     fuzzyLetters: number;
     fuzzyLevel: number;
+    proximity: number;
 };

lib/cjs/constants/defaultValues.js

@@ -5,4 +5,5 @@ "use strict";
 exports.defaultValues = {
-    fuzzyLetters: 5,
+    fuzzyLetters: 3,
     fuzzyLevel: 1,
+    proximity: 1,
 };

lib/cjs/functions/processPhrase.d.ts

@@ -9,2 +9,2 @@ import { PhraseOptions } from '../types';
  */
-export declare const processPhrase: (phrase?: string, { fuzzyLetters, fuzzyLevel, }?: PhraseOptions) => string;
+export declare const processPhrase: (phrase?: string, { fuzzyLetters, fuzzyLevel, proximity, }?: PhraseOptions) => string;

lib/cjs/functions/processPhrase.js

@@ -12,13 +12,17 @@ "use strict";
  */
-const processPhrase = (phrase, { fuzzyLetters = defaultValues_1.defaultValues.fuzzyLetters, fuzzyLevel = defaultValues_1.defaultValues.fuzzyLevel, } = {}) => {
+const processPhrase = (phrase, { fuzzyLetters = defaultValues_1.defaultValues.fuzzyLetters, fuzzyLevel = defaultValues_1.defaultValues.fuzzyLevel, proximity = defaultValues_1.defaultValues.proximity, } = {}) => {
     if (!phrase)
         return '*:*';
     phrase = phrase.trim();
-    if (phrase.length < fuzzyLetters)
-        return phrase;
-    return phrase
-        .split(/\s+/)
-        .map((word) => `"${word}"~${fuzzyLevel}`)
-        .join(' ');
+    let words = phrase.split(/\s+/);
+    // Single word - apply fuzzy search or append wildcard
+    if (words.length === 1) {
+        return words[0].length >= fuzzyLetters ? `${words[0]}~${fuzzyLevel}` : `${words[0]}*`;
+    }
+    // Multiple words - apply fuzzy and proximity search
+    words = words.map((word) => {
+        return word.length >= fuzzyLetters ? `${word}~${fuzzyLevel}` : word;
+    });
+    return `"${words.join(' ')}"~${proximity}`;
 };
 exports.processPhrase = processPhrase;

lib/cjs/LuceneBuilder.js

@@ -21,3 +21,3 @@ "use strict";
             urlEncoded: false,
-            strictDateRanges: false
+            strictDateRanges: false,
         };
@@ -24,0 +24,0 @@ this.options = Object.assign(Object.assign({}, defaultOptions), options);

lib/cjs/types.d.ts

@@ -29,6 +29,8 @@ /**
 export interface PhraseOptions {
-    /** Number of letters in phrase to start fuzzy matching. */
+    /** Number of letters in a word to start fuzzy matching. */
     fuzzyLetters?: number;
     /** Fuzzy matching level. */
     fuzzyLevel?: number;
+    /** Proximity distance. */
+    proximity?: number;
 }
@@ -35,0 +37,0 @@ /**

lib/esm/constants/defaultValues.d.ts

 export declare const defaultValues: {
     fuzzyLetters: number;
     fuzzyLevel: number;
+    proximity: number;
 };

lib/esm/constants/defaultValues.js

 export const defaultValues = {
-    fuzzyLetters: 5,
+    fuzzyLetters: 3,
     fuzzyLevel: 1,
+    proximity: 1,
 };

lib/esm/functions/processPhrase.d.ts

@@ -9,2 +9,2 @@ import { PhraseOptions } from '../types';
  */
-export declare const processPhrase: (phrase?: string, { fuzzyLetters, fuzzyLevel, }?: PhraseOptions) => string;
+export declare const processPhrase: (phrase?: string, { fuzzyLetters, fuzzyLevel, proximity, }?: PhraseOptions) => string;

lib/esm/functions/processPhrase.js

@@ -9,12 +9,16 @@ import { defaultValues } from '../constants/defaultValues';
  */
-export const processPhrase = (phrase, { fuzzyLetters = defaultValues.fuzzyLetters, fuzzyLevel = defaultValues.fuzzyLevel, } = {}) => {
+export const processPhrase = (phrase, { fuzzyLetters = defaultValues.fuzzyLetters, fuzzyLevel = defaultValues.fuzzyLevel, proximity = defaultValues.proximity, } = {}) => {
     if (!phrase)
         return '*:*';
     phrase = phrase.trim();
-    if (phrase.length < fuzzyLetters)
-        return phrase;
-    return phrase
-        .split(/\s+/)
-        .map((word) => `"${word}"~${fuzzyLevel}`)
-        .join(' ');
+    let words = phrase.split(/\s+/);
+    // Single word - apply fuzzy search or append wildcard
+    if (words.length === 1) {
+        return words[0].length >= fuzzyLetters ? `${words[0]}~${fuzzyLevel}` : `${words[0]}*`;
+    }
+    // Multiple words - apply fuzzy and proximity search
+    words = words.map((word) => {
+        return word.length >= fuzzyLetters ? `${word}~${fuzzyLevel}` : word;
+    });
+    return `"${words.join(' ')}"~${proximity}`;
 };

lib/esm/LuceneBuilder.js

@@ -18,3 +18,3 @@ import { query } from './query';
             urlEncoded: false,
-            strictDateRanges: false
+            strictDateRanges: false,
         };
@@ -21,0 +21,0 @@ this.options = Object.assign(Object.assign({}, defaultOptions), options);

lib/esm/types.d.ts

@@ -29,6 +29,8 @@ /**
 export interface PhraseOptions {
-    /** Number of letters in phrase to start fuzzy matching. */
+    /** Number of letters in a word to start fuzzy matching. */
     fuzzyLetters?: number;
     /** Fuzzy matching level. */
     fuzzyLevel?: number;
+    /** Proximity distance. */
+    proximity?: number;
 }
@@ -35,0 +37,0 @@ /**

package.json

 {
   "name": "lucene-query-builder",
-  "version": "0.7.3",
+  "version": "0.7.4",
   "description": "Library to build lucene queries in a typescript friendly way",
@@ -5,0 +5,0 @@ "main": "lib/cjs/index.js",

readme.md

@@ -171,6 +171,7 @@ # Lucene Query Builder
 |------------------|---------------|------------------------------------------------------------------------------------------------------|
-| `fuzzyLetters`   | `5`           | The number of letters in the phrase to start fuzzy matching.                                         |
+| `fuzzyLetters`   | `3`           | The number of letters in the phrase to start fuzzy matching.                                         |
 | `fuzzyLevel`     | `1`           | The level of fuzzy matching.                                                                         |
+| `proximity`      | `1`           | The number of words allowed between words in the phrase.                                             |
 | `urlEncoded`     | `false`       | A boolean indicating whether the returned query string should be URL-encoded.                        |
-| `strictDateRanges`| `false`      | Indicates whether the resulting date query should be strict (bonded with 'AND') or not (bonded with 'OR'). |
+| `strictDateRanges`| `false`       | Indicates whether the resulting date query should be strict (bonded with 'AND') or not (bonded with 'OR'). |
 
@@ -177,0 +178,0 @@ #### Option Details

No alert changes

Improved metrics

Total package byte prevSize

45744

increased by2.25%

Lines of code

882

increased by1.85%

Number of lines in readme file

200

increased by0.5%

No dependency changes