@easyops-cn/docusaurus-search-local 0.48.4 → 0.49.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.49.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.48.5...v0.49.0) (2025-03-12)
+
+
+### Features
+
+* support fuzzy matching, closes [#504](https://github.com/easyops-cn/docusaurus-search-local/issues/504) ([#505](https://github.com/easyops-cn/docusaurus-search-local/issues/505)) ([c8310f3](https://github.com/easyops-cn/docusaurus-search-local/commit/c8310f39c05f0409ba227318a70dba828ca65aa0))
+
+## [0.48.5](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.48.4...v0.48.5) (2025-02-05)
+
+
+### Bug Fixes
+
+* fix contextual search, closes [#380](https://github.com/easyops-cn/docusaurus-search-local/issues/380) ([2a6d9d4](https://github.com/easyops-cn/docusaurus-search-local/commit/2a6d9d4f6ad7daea4f2c3c41604494a6a94492f3))
+
 ## [0.48.4](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.48.3...v0.48.4) (2025-01-20)
 
 

package/dist/client/client/theme/SearchBar/SearchBar.jsx

@@ -70,8 +70,14 @@ export default function SearchBar({ handleSearchBarToggle, }) {
     const search = useRef(null);
     const prevSearchContext = useRef("");
     const [searchContext, setSearchContext] = useState("");
+    const prevVersionUrl = useRef(baseUrl);
     useEffect(() => {
         if (!Array.isArray(searchContextByPaths)) {
+            if (prevVersionUrl.current !== versionUrl) {
+                // Reset index state map once version url is changed.
+                indexStateMap.current.delete("");
+                prevVersionUrl.current = versionUrl;
+            }
             return;
         }
         let nextSearchContext = "";

package/dist/client/client/theme/worker.js

@@ -36,6 +36,9 @@ export class SearchWorker {
                         query.term(item.value, {
                             wildcard: item.wildcard,
                             presence: item.presence,
+                            ...(item.editDistance
+                                ? { editDistance: item.editDistance }
+                                : null),
                         });
                     }
                 })

package/dist/client/client/utils/__mocks__/proxiedGeneratedConstants.js

@@ -2,9 +2,13 @@ export let language = ["en", "zh"];
 export let removeDefaultStopWordFilter = false;
 export const searchIndexUrl = "search-index{dir}.json?_=abc";
 export const searchResultLimits = 8;
+export let fuzzyMatchingDistance = 0;
 export function __setLanguage(value) {
     language = value;
 }
 export function __setRemoveDefaultStopWordFilter(value) {
     removeDefaultStopWordFilter = value;
 }
+export function __setFuzzyMatchingDistance(value) {
+    fuzzyMatchingDistance = value;
+}

package/dist/client/client/utils/smartQueries.js

@@ -1,6 +1,6 @@
 import lunr from "lunr";
 import { smartTerms } from "./smartTerms";
-import { language, removeDefaultStopWordFilter } from "./proxiedGeneratedConstants";
+import { language, removeDefaultStopWordFilter, fuzzyMatchingDistance, } from "./proxiedGeneratedConstants";
 /**
  * Get all possible queries for a list of tokens consists of words mixed English and Chinese,
  * by a Chinese words dictionary.
@@ -76,28 +76,42 @@ export function smartQueries(tokens, zhDictionary) {
             }
         }
     }
-    return getQueriesMaybeTyping(terms).concat(getQueriesMaybeTyping(extraTerms));
+    return getQueriesMaybeTyping(terms).concat(fuzzyMatchingDistance > 0
+        ? getQueriesMaybeTyping(terms, fuzzyMatchingDistance)
+        : [], getQueriesMaybeTyping(extraTerms), fuzzyMatchingDistance > 0
+        ? getQueriesMaybeTyping(extraTerms, fuzzyMatchingDistance)
+        : []);
 }
-function getQueriesMaybeTyping(terms) {
-    return termsToQueries(terms).concat(termsToQueries(
+function getQueriesMaybeTyping(terms, editDistance) {
+    return termsToQueries(terms, false, editDistance).concat(termsToQueries(
     // Ignore terms whose last token already has a trailing wildcard,
     // or the last token is not `maybeTyping`.
     terms.filter((term) => {
         const token = term[term.length - 1];
         return !token.trailing && token.maybeTyping;
-    }), true));
+    }), true, editDistance));
 }
-function termsToQueries(terms, maybeTyping) {
-    return terms.map((term) => ({
-        tokens: term.map((item) => item.value),
-        term: term.map((item) => ({
-            value: item.value,
-            presence: lunr.Query.presence.REQUIRED,
-            // The last token of a term maybe incomplete while user is typing.
-            // So append more queries with trailing wildcard added.
-            wildcard: (maybeTyping ? item.trailing || item.maybeTyping : item.trailing)
-                ? lunr.Query.wildcard.TRAILING
-                : lunr.Query.wildcard.NONE,
-        })),
-    }));
+function termsToQueries(terms, maybeTyping, editDistance) {
+    return terms.flatMap((term) => {
+        const query = {
+            tokens: term.map((item) => item.value),
+            term: term.map((item) => ({
+                value: item.value,
+                presence: lunr.Query.presence.REQUIRED,
+                // The last token of a term maybe incomplete while user is typing.
+                // So append more queries with trailing wildcard added.
+                wildcard: (maybeTyping ? item.trailing || item.maybeTyping : item.trailing)
+                    ? lunr.Query.wildcard.TRAILING
+                    : lunr.Query.wildcard.NONE,
+                editDistance: editDistance && item.value.length > editDistance
+                    ? editDistance
+                    : undefined,
+            })),
+        };
+        // Ignore queries that all terms ignored edit distance due to too short tokens.
+        if (editDistance && query.term.every((item) => !item.editDistance)) {
+            return [];
+        }
+        return query;
+    });
 }

package/dist/server/server/utils/generate.js

@@ -6,7 +6,7 @@ const fs_1 = tslib_1.__importDefault(require("fs"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const getIndexHash_1 = require("./getIndexHash");
 function generate(config, dir) {
-    const { language, removeDefaultStopWordFilter, removeDefaultStemmer, highlightSearchTermsOnTargetPage, searchResultLimits, searchResultContextMaxLength, explicitSearchResultPath, searchBarShortcut, searchBarShortcutHint, searchBarPosition, docsPluginIdForPreferredVersion, indexDocs, searchContextByPaths, hideSearchBarWithNoSearchContext, useAllContextsWithNoSearchContext, } = config;
+    const { language, removeDefaultStopWordFilter, removeDefaultStemmer, highlightSearchTermsOnTargetPage, searchResultLimits, searchResultContextMaxLength, explicitSearchResultPath, searchBarShortcut, searchBarShortcutHint, searchBarPosition, docsPluginIdForPreferredVersion, indexDocs, searchContextByPaths, hideSearchBarWithNoSearchContext, useAllContextsWithNoSearchContext, fuzzyMatchingDistance, } = config;
     const indexHash = (0, getIndexHash_1.getIndexHash)(config);
     const contents = [];
     contents.push(`export const removeDefaultStemmer = ${JSON.stringify(removeDefaultStemmer)};`);
@@ -62,7 +62,7 @@ function generate(config, dir) {
     constantContents.push(`export const removeDefaultStopWordFilter = ${JSON.stringify(removeDefaultStopWordFilter)};`);
     constantContents.push(`export const language = ${JSON.stringify(language)};`);
     const searchIndexUrl = searchIndexFilename + searchIndexQuery;
-    constantContents.push(`export const searchIndexUrl = ${JSON.stringify(searchIndexUrl)};`, `export const searchResultLimits = ${JSON.stringify(searchResultLimits)};`);
+    constantContents.push(`export const searchIndexUrl = ${JSON.stringify(searchIndexUrl)};`, `export const searchResultLimits = ${JSON.stringify(searchResultLimits)};`, `export const fuzzyMatchingDistance = ${JSON.stringify(fuzzyMatchingDistance)};`);
     fs_1.default.writeFileSync(path_1.default.join(dir, "generated-constants.js"), constantContents.join("\n"));
     return searchIndexFilename;
 }

package/dist/server/server/utils/validateOptions.js

@@ -36,6 +36,7 @@ const schema = utils_validation_1.Joi.object({
     hideSearchBarWithNoSearchContext: utils_validation_1.Joi.boolean().default(false),
     useAllContextsWithNoSearchContext: utils_validation_1.Joi.boolean().default(false),
     forceIgnoreNoIndex: utils_validation_1.Joi.boolean().default(false),
+    fuzzyMatchingDistance: utils_validation_1.Joi.number().default(1),
 });
 function validateOptions({ options, validate, }) {
     return validate(schema, options || {});

package/dist/types/index.d.ts

@@ -173,4 +173,11 @@ export interface PluginOptions {
      * @default false
      */
     forceIgnoreNoIndex?: boolean;
+    /**
+     * Set the edit distance for fuzzy matching during searches. Lower values will result in stricter matches,
+     * while higher values will allow for more lenient matches. Set 0 to disable fuzzy matching.
+     *
+     * @default 1
+     */
+    fuzzyMatchingDistance?: number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.48.4",
+  "version": "0.49.0",
   "description": "An offline/local search plugin for Docusaurus v3",
   "repository": {
     "type": "git",