@easyops-cn/docusaurus-search-local 0.46.0 → 0.47.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.47.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.46.1...v0.47.0) (2025-01-07)
+
+
+### Features
+
+* support React 19 ([725074e](https://github.com/easyops-cn/docusaurus-search-local/commit/725074eb84f153f84974cd6f4bac21d8aee79187)), closes [#474](https://github.com/easyops-cn/docusaurus-search-local/issues/474)
+
+## [0.46.1](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.46.0...v0.46.1) (2024-11-27)
+
+
+### Bug Fixes
+
+* fix Uncaught ReferenceError: importScripts is not defined ([139b82b](https://github.com/easyops-cn/docusaurus-search-local/commit/139b82befc22a574d71eb307b3a79afb2984ea69))
+
 ## [0.46.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.45.0...v0.46.0) (2024-11-27)
 
 

package/dist/client/client/theme/searchByWorker.js

@@ -1,7 +1,7 @@
 import * as Comlink from "comlink";
 let remoteWorkerPromise;
 function getRemoteWorker() {
-    if (!remoteWorkerPromise) {
+    if (process.env.NODE_ENV === "production" && !remoteWorkerPromise) {
         remoteWorkerPromise = (async () => {
             const Remote = Comlink.wrap(new Worker(new URL("./worker.js", import.meta.url)));
             return await new Remote();

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

@@ -1,12 +1,11 @@
 import * as Comlink from "comlink";
 import lunr from "lunr";
-import { searchIndexUrl, searchResultLimits } from "../utils/proxiedGenerated";
+import { searchIndexUrl, searchResultLimits, language } from "../utils/proxiedGeneratedConstants";
 import { tokenize } from "../utils/tokenize";
 import { smartQueries } from "../utils/smartQueries";
 import { SearchDocumentType, } from "../../shared/interfaces";
 import { sortSearchResults } from "../utils/sortSearchResults";
 import { processTreeStatusOfSearchResults } from "../utils/processTreeStatusOfSearchResults";
-import { language } from "../utils/proxiedGenerated";
 const cache = new Map();
 export class SearchWorker {
     async fetchIndexes(baseUrl, searchContext) {

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

@@ -1,18 +1,5 @@
-export let language = ["en", "zh"];
-export let removeDefaultStopWordFilter = false;
-export let removeDefaultStemmer = false;
-export const searchIndexUrl = "search-index{dir}.json?_=abc";
-export const searchResultLimits = 8;
+export const removeDefaultStemmer = false;
 export const searchResultContextMaxLength = 50;
 export const explicitSearchResultPath = false;
 export const docsPluginIdForPreferredVersion = undefined;
 export const indexDocs = true;
-export function __setLanguage(value) {
-    language = value;
-}
-export function __setRemoveDefaultStopWordFilter(value) {
-    removeDefaultStopWordFilter = value;
-}
-export function __setRemoveDefaultStemmer(value) {
-    removeDefaultStemmer = value;
-}

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

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

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

@@ -0,0 +1,2 @@
+// This file is auto generated while building.
+export * from "@generated/@easyops-cn/docusaurus-search-local/default/generated-constants.js";

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

@@ -1,6 +1,6 @@
 import lunr from "lunr";
 import { smartTerms } from "./smartTerms";
-import { language, removeDefaultStopWordFilter } from "./proxiedGenerated";
+import { language, removeDefaultStopWordFilter } from "./proxiedGeneratedConstants";
 /**
  * Get all possible queries for a list of tokens consists of words mixed English and Chinese,
  * by a Chinese words dictionary.

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

@@ -8,26 +8,7 @@ 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 indexHash = (0, getIndexHash_1.getIndexHash)(config);
-    const contents = [
-        `import lunr from ${JSON.stringify(require.resolve("lunr"))};`,
-    ];
-    if (language.length > 1 || language.some((item) => item !== "en")) {
-        contents.push(`require(${JSON.stringify(require.resolve("lunr-languages/lunr.stemmer.support"))})(lunr);`);
-    }
-    if (language.includes("ja") || language.includes("jp")) {
-        contents.push(`require(${JSON.stringify(require.resolve("lunr-languages/tinyseg"))})(lunr);`);
-    }
-    for (const lang of language.filter((item) => item !== "en" && item !== "zh")) {
-        contents.push(`require(${JSON.stringify(require.resolve(`lunr-languages/lunr.${lang}`))})(lunr);`);
-    }
-    if (language.includes("zh")) {
-        contents.push(`require(${JSON.stringify(require.resolve("@easyops-cn/docusaurus-search-local/dist/client/shared/lunrLanguageZh"))}).lunrLanguageZh(lunr);`);
-    }
-    if (language.length > 1) {
-        contents.push(`require(${JSON.stringify(require.resolve("lunr-languages/lunr.multi"))})(lunr);`);
-    }
-    contents.push(`export const language = ${JSON.stringify(language)};`);
-    contents.push(`export const removeDefaultStopWordFilter = ${JSON.stringify(removeDefaultStopWordFilter)};`);
+    const contents = [];
     contents.push(`export const removeDefaultStemmer = ${JSON.stringify(removeDefaultStemmer)};`);
     if (highlightSearchTermsOnTargetPage) {
         contents.push(`export { default as Mark } from ${JSON.stringify(require.resolve("mark.js"))}`);
@@ -45,9 +26,7 @@ function generate(config, dir) {
             searchIndexQuery = `?_=${indexHash}`;
         }
     }
-    const searchIndexUrl = searchIndexFilename + searchIndexQuery;
-    contents.push(`export const searchIndexUrl = ${JSON.stringify(searchIndexUrl)};`);
-    contents.push(`export const searchResultLimits = ${JSON.stringify(searchResultLimits)};`, `export const searchResultContextMaxLength = ${JSON.stringify(searchResultContextMaxLength)};`);
+    contents.push(`export const searchResultContextMaxLength = ${JSON.stringify(searchResultContextMaxLength)};`);
     contents.push(`export const explicitSearchResultPath = ${JSON.stringify(explicitSearchResultPath)};`);
     contents.push(`export const searchBarShortcut = ${JSON.stringify(searchBarShortcut)};`);
     contents.push(`export const searchBarShortcutHint = ${JSON.stringify(searchBarShortcutHint)};`);
@@ -62,6 +41,29 @@ function generate(config, dir) {
     contents.push(`export const hideSearchBarWithNoSearchContext = ${JSON.stringify(!!hideSearchBarWithNoSearchContext)};`);
     contents.push(`export const useAllContextsWithNoSearchContext = ${JSON.stringify(!!useAllContextsWithNoSearchContext)};`);
     fs_1.default.writeFileSync(path_1.default.join(dir, "generated.js"), contents.join("\n"));
+    const constantContents = [
+        `import lunr from ${JSON.stringify(require.resolve("lunr"))};`,
+    ];
+    if (language.length > 1 || language.some((item) => item !== "en")) {
+        constantContents.push(`require(${JSON.stringify(require.resolve("lunr-languages/lunr.stemmer.support"))})(lunr);`);
+    }
+    if (language.includes("ja") || language.includes("jp")) {
+        constantContents.push(`require(${JSON.stringify(require.resolve("lunr-languages/tinyseg"))})(lunr);`);
+    }
+    for (const lang of language.filter((item) => item !== "en" && item !== "zh")) {
+        constantContents.push(`require(${JSON.stringify(require.resolve(`lunr-languages/lunr.${lang}`))})(lunr);`);
+    }
+    if (language.includes("zh")) {
+        constantContents.push(`require(${JSON.stringify(require.resolve("@easyops-cn/docusaurus-search-local/dist/client/shared/lunrLanguageZh"))}).lunrLanguageZh(lunr);`);
+    }
+    if (language.length > 1) {
+        constantContents.push(`require(${JSON.stringify(require.resolve("lunr-languages/lunr.multi"))})(lunr);`);
+    }
+    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)};`);
+    fs_1.default.writeFileSync(path_1.default.join(dir, "generated-constants.js"), constantContents.join("\n"));
     return searchIndexFilename;
 }
 exports.generate = generate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.46.0",
+  "version": "0.47.0",
   "description": "An offline/local search plugin for Docusaurus v3",
   "repository": {
     "type": "git",
@@ -38,7 +38,7 @@
     "@easyops-cn/autocomplete.js": "^0.38.1",
     "@node-rs/jieba": "^1.6.0",
     "cheerio": "^1.0.0",
-    "clsx": "^1.1.1",
+    "clsx": "^2.1.1",
     "comlink": "^4.4.2",
     "debug": "^4.2.0",
     "fs-extra": "^10.0.0",
@@ -60,8 +60,8 @@
     "@types/klaw-sync": "^6.0.0",
     "@types/lunr": "^2.3.3",
     "@types/node": "^18.0.0",
-    "@types/react": "^18.2.37",
-    "@types/react-helmet": "^6.1.0",
+    "@types/react": "^19.0.3",
+    "@types/react-helmet": "^6.1.1",
     "@types/react-router-dom": "^5.1.6",
     "concurrently": "^7.0.0",
     "copyfiles": "^2.4.0",
@@ -70,7 +70,7 @@
   },
   "peerDependencies": {
     "@docusaurus/theme-common": "^2 || ^3",
-    "react": "^16.14.0 || ^17 || ^18",
-    "react-dom": "^16.14.0 || 17 || ^18"
+    "react": "^16.14.0 || ^17 || ^18 || ^19",
+    "react-dom": "^16.14.0 || 17 || ^18 || ^19"
   }
 }

package/dist/client/client/utils/SearchSourceFactory.js

@@ -1,52 +0,0 @@
-import { tokenize } from "./tokenize";
-import { smartQueries } from "./smartQueries";
-import { SearchDocumentType, } from "../../shared/interfaces";
-import { sortSearchResults } from "./sortSearchResults";
-import { processTreeStatusOfSearchResults } from "./processTreeStatusOfSearchResults";
-import { language } from "./proxiedGenerated";
-export function SearchSourceFactory(wrappedIndexes, zhDictionary, resultsLimit) {
-    return function searchSource(input, callback) {
-        const rawTokens = tokenize(input, language);
-        if (rawTokens.length === 0) {
-            callback([]);
-            return;
-        }
-        const queries = smartQueries(rawTokens, zhDictionary);
-        const results = [];
-        search: for (const { term, tokens } of queries) {
-            for (const { documents, index, type } of wrappedIndexes) {
-                results.push(...index
-                    .query((query) => {
-                    for (const item of term) {
-                        query.term(item.value, {
-                            wildcard: item.wildcard,
-                            presence: item.presence,
-                        });
-                    }
-                })
-                    .slice(0, resultsLimit)
-                    // Remove duplicated results.
-                    .filter((result) => !results.some((item) => item.document.i.toString() === result.ref))
-                    .slice(0, resultsLimit - results.length)
-                    .map((result) => {
-                    const document = documents.find((doc) => doc.i.toString() === result.ref);
-                    return {
-                        document,
-                        type,
-                        page: type !== SearchDocumentType.Title &&
-                            wrappedIndexes[0].documents.find((doc) => doc.i === document.p),
-                        metadata: result.matchData.metadata,
-                        tokens,
-                        score: result.score,
-                    };
-                }));
-                if (results.length >= resultsLimit) {
-                    break search;
-                }
-            }
-        }
-        sortSearchResults(results);
-        processTreeStatusOfSearchResults(results);
-        callback(results);
-    };
-}