@easyops-cn/docusaurus-search-local 0.32.1 → 0.33.1

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.33.1](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.33.0...v0.33.1) (2022-10-17)
+
+
+### Bug Fixes
+
+* refine search context, support `hideSearchBarWithNoSearchContext` ([38908ed](https://github.com/easyops-cn/docusaurus-search-local/commit/38908edd8dea6bbf5a38f2ea225f9a9530b406ed))
+
+## [0.33.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.32.1...v0.33.0) (2022-10-16)
+
+
+### Features
+
+* support search context by paths ([aa6de9a](https://github.com/easyops-cn/docusaurus-search-local/commit/aa6de9a2890cad2570bd40f41cccb0626a5163d6))
+
 ## [0.32.1](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.32.0...v0.32.1) (2022-10-08)
 
 

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

@@ -10,7 +10,7 @@ import { fetchIndexes } from "./fetchIndexes";
 import { SearchSourceFactory } from "../../utils/SearchSourceFactory";
 import { SuggestionTemplate } from "./SuggestionTemplate";
 import { EmptyTemplate } from "./EmptyTemplate";
-import { searchResultLimits, Mark, searchBarShortcut, searchBarShortcutHint, searchBarPosition, docsPluginIdForPreferredVersion, indexDocs, } from "../../utils/proxiedGenerated";
+import { searchResultLimits, Mark, searchBarShortcut, searchBarShortcutHint, searchBarPosition, docsPluginIdForPreferredVersion, indexDocs, searchContextByPaths, hideSearchBarWithNoSearchContext, } from "../../utils/proxiedGenerated";
 import LoadingRing from "../LoadingRing/LoadingRing";
 import styles from "./SearchBar.module.css";
 async function fetchAutoCompleteJS() {
@@ -59,22 +59,47 @@ export default function SearchBar({ handleSearchBarToggle, }) {
     const history = useHistory();
     const location = useLocation();
     const searchBarRef = useRef(null);
-    const indexState = useRef("empty"); // empty, loaded, done
+    const indexStateMap = useRef(new Map());
     // Should the input be focused after the index is loaded?
     const focusAfterIndexLoaded = useRef(false);
     const [loading, setLoading] = useState(false);
     const [inputChanged, setInputChanged] = useState(false);
     const [inputValue, setInputValue] = useState("");
     const search = useRef(null);
+    const prevSearchContext = useRef("");
+    const [searchContext, setSearchContext] = useState("");
+    useEffect(() => {
+        if (!Array.isArray(searchContextByPaths)) {
+            return;
+        }
+        let nextSearchContext = "";
+        if (location.pathname.startsWith(versionUrl)) {
+            const uri = location.pathname.substring(versionUrl.length);
+            const matchedPath = searchContextByPaths.find((path) => uri === path || uri.startsWith(`${path}/`));
+            if (matchedPath) {
+                nextSearchContext = matchedPath;
+            }
+        }
+        if (prevSearchContext.current !== nextSearchContext) {
+            // Reset index state map once search context is changed.
+            indexStateMap.current.delete(nextSearchContext);
+            prevSearchContext.current = nextSearchContext;
+        }
+        setSearchContext(nextSearchContext);
+    }, [location.pathname, versionUrl]);
+    const hidden = !!hideSearchBarWithNoSearchContext &&
+        Array.isArray(searchContextByPaths) &&
+        searchContext === "";
     const loadIndex = useCallback(async () => {
-        if (indexState.current !== "empty") {
+        if (hidden || indexStateMap.current.get(searchContext)) {
             // Do not load the index (again) if its already loaded or in the process of being loaded.
             return;
         }
-        indexState.current = "loading";
+        indexStateMap.current.set(searchContext, "loading");
+        search.current?.autocomplete.destroy();
         setLoading(true);
         const [{ wrappedIndexes, zhDictionary }, autoComplete] = await Promise.all([
-            fetchIndexes(versionUrl),
+            fetchIndexes(versionUrl, searchContext),
             fetchAutoCompleteJS(),
         ]);
         search.current = autoComplete(searchBarRef.current, {
@@ -106,7 +131,9 @@ export default function SearchBar({ handleSearchBarToggle, }) {
                             return;
                         }
                         const a = document.createElement("a");
-                        const url = `${baseUrl}search?q=${encodeURIComponent(query)}`;
+                        const url = `${baseUrl}search?q=${encodeURIComponent(query)}${Array.isArray(searchContextByPaths)
+                            ? `&ctx=${encodeURIComponent(searchContext)}`
+                            : ""}`;
                         a.href = url;
                         a.textContent = translate({
                             id: "theme.SearchBar.seeAll",
@@ -115,7 +142,7 @@ export default function SearchBar({ handleSearchBarToggle, }) {
                         a.addEventListener("click", (e) => {
                             if (!e.ctrlKey && !e.metaKey) {
                                 e.preventDefault();
-                                search.current.autocomplete.close();
+                                search.current?.autocomplete.close();
                                 history.push(url);
                             }
                         });
@@ -145,16 +172,16 @@ export default function SearchBar({ handleSearchBarToggle, }) {
             .on("autocomplete:closed", () => {
             searchBarRef.current?.blur();
         });
-        indexState.current = "done";
+        indexStateMap.current.set(searchContext, "done");
         setLoading(false);
         if (focusAfterIndexLoaded.current) {
             const input = searchBarRef.current;
             if (input.value) {
-                search.current.autocomplete.open();
+                search.current?.autocomplete.open();
             }
             input.focus();
         }
-    }, [baseUrl, versionUrl, history]);
+    }, [hidden, searchContext, versionUrl, baseUrl, history]);
     useEffect(() => {
         if (!Mark) {
             return;
@@ -239,7 +266,7 @@ export default function SearchBar({ handleSearchBarToggle, }) {
     return (<div className={clsx("navbar__search", styles.searchBarContainer, {
             [styles.searchIndexLoading]: loading && inputChanged,
             [styles.focused]: focused,
-        })}>
+        })} hidden={hidden}>
       <input placeholder={translate({
             id: "theme.SearchBar.label",
             message: "Search",

package/dist/client/client/theme/SearchBar/fetchIndexes.js

@@ -1,8 +1,18 @@
 import lunr from "lunr";
 import { searchIndexUrl } from "../../utils/proxiedGenerated";
-export async function fetchIndexes(baseUrl) {
+const cache = new Map();
+export function fetchIndexes(baseUrl, searchContext) {
+    const cacheKey = `${baseUrl}${searchContext}`;
+    let promise = cache.get(cacheKey);
+    if (!promise) {
+        promise = legacyFetchIndexes(baseUrl, searchContext);
+        cache.set(cacheKey, promise);
+    }
+    return promise;
+}
+export async function legacyFetchIndexes(baseUrl, searchContext) {
     if (process.env.NODE_ENV === "production") {
-        const json = (await (await fetch(`${baseUrl}${searchIndexUrl}`)).json());
+        const json = (await (await fetch(`${baseUrl}${searchIndexUrl.replace("{dir}", searchContext ? `-${searchContext.replace(/\//g, "-")}` : "")}`)).json());
         const wrappedIndexes = json.map(({ documents, index }, type) => ({
             type: type,
             documents,

package/dist/client/client/theme/SearchPage/SearchPage.jsx

@@ -48,7 +48,7 @@ function SearchPageContent() {
         }
     }
     const { selectMessage } = usePluralForm();
-    const { searchValue, updateSearchPath } = useSearchQuery();
+    const { searchValue, searchContext, updateSearchPath } = useSearchQuery();
     const [searchQuery, setSearchQuery] = useState(searchValue);
     const [searchSource, setSearchSource] = useState();
     const [searchResults, setSearchResults] = useState();
@@ -90,11 +90,11 @@ function SearchPageContent() {
     }, [searchValue]);
     useEffect(() => {
         async function doFetchIndexes() {
-            const { wrappedIndexes, zhDictionary } = await fetchIndexes(versionUrl);
+            const { wrappedIndexes, zhDictionary } = await fetchIndexes(versionUrl, searchContext);
             setSearchSource(() => SearchSourceFactory(wrappedIndexes, zhDictionary, 100));
         }
         doFetchIndexes();
-    }, [versionUrl]);
+    }, [searchContext, versionUrl]);
     return (<React.Fragment>
       <Head>
         {/*

package/dist/client/client/theme/hooks/useSearchQuery.js

@@ -7,15 +7,19 @@
 import { useHistory, useLocation } from "@docusaurus/router";
 import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
+import { searchContextByPaths, } from "../../utils/proxiedGenerated";
 const SEARCH_PARAM_QUERY = "q";
+const SEARCH_PARAM_CONTEXT = "ctx";
 function useSearchQuery() {
     const history = useHistory();
     const location = useLocation();
     const { siteConfig: { baseUrl }, } = useDocusaurusContext();
+    const params = ExecutionEnvironment.canUseDOM ? new URLSearchParams(location.search) : null;
+    const searchValue = params?.get(SEARCH_PARAM_QUERY) || "";
+    const searchContext = params?.get(SEARCH_PARAM_CONTEXT) || "";
     return {
-        searchValue: (ExecutionEnvironment.canUseDOM &&
-            new URLSearchParams(location.search).get(SEARCH_PARAM_QUERY)) ||
-            "",
+        searchValue,
+        searchContext,
         updateSearchPath: (searchValue) => {
             const searchParams = new URLSearchParams(location.search);
             if (searchValue) {
@@ -29,8 +33,10 @@ function useSearchQuery() {
             });
         },
         generateSearchPageLink: (searchValue) => {
+            const searchParams = new URLSearchParams(location.search);
+            const searchContext = searchParams.get(SEARCH_PARAM_CONTEXT) || "";
             // Refer to https://github.com/facebook/docusaurus/pull/2838
-            return `${baseUrl}search?q=${encodeURIComponent(searchValue)}`;
+            return `${baseUrl}search?q=${encodeURIComponent(searchValue)}${Array.isArray(searchContextByPaths) ? `&ctx=${encodeURIComponent(searchContext)}` : ""}`;
         },
     };
 }

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

@@ -1,7 +1,7 @@
 export let language = ["en", "zh"];
 export let removeDefaultStopWordFilter = false;
 export let removeDefaultStemmer = false;
-export const searchIndexUrl = "search-index.json?_=abc";
+export const searchIndexUrl = "search-index{dir}.json?_=abc";
 export const searchResultLimits = 8;
 export const searchResultContextMaxLength = 50;
 export const explicitSearchResultPath = false;

package/dist/client/index.js

@@ -0,0 +1 @@
+export {};

package/dist/server/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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, } = config;
+    const { language, removeDefaultStopWordFilter, removeDefaultStemmer, highlightSearchTermsOnTargetPage, searchResultLimits, searchResultContextMaxLength, explicitSearchResultPath, searchBarShortcut, searchBarShortcutHint, searchBarPosition, docsPluginIdForPreferredVersion, indexDocs, searchContextByPaths, hideSearchBarWithNoSearchContext, } = config;
     const indexHash = (0, getIndexHash_1.getIndexHash)(config);
     const contents = [
         `import lunr from ${JSON.stringify(require.resolve("lunr"))};`,
@@ -35,11 +35,11 @@ function generate(config, dir) {
     else {
         contents.push("export const Mark = null;");
     }
-    let searchIndexFilename = "search-index.json";
+    let searchIndexFilename = "search-index{dir}.json";
     let searchIndexQuery = "";
     if (indexHash) {
         if (config.hashed === "filename") {
-            searchIndexFilename = `search-index-${indexHash}.json`;
+            searchIndexFilename = `search-index{dir}-${indexHash}.json`;
         }
         else {
             searchIndexQuery = `?_=${indexHash}`;
@@ -56,6 +56,10 @@ function generate(config, dir) {
         ? "undefined"
         : JSON.stringify(docsPluginIdForPreferredVersion)};`);
     contents.push(`export const indexDocs = ${JSON.stringify(indexDocs)};`);
+    contents.push(`export const searchContextByPaths = ${JSON.stringify(Array.isArray(searchContextByPaths) && searchContextByPaths.length > 0
+        ? searchContextByPaths
+        : null)};`);
+    contents.push(`export const hideSearchBarWithNoSearchContext = ${JSON.stringify(!!hideSearchBarWithNoSearchContext)};`);
     fs_1.default.writeFileSync(path_1.default.join(dir, "generated.js"), contents.join("\n"));
     return searchIndexFilename;
 }

package/dist/server/server/utils/postBuildFactory.js

@@ -20,10 +20,55 @@ function postBuildFactory(config, searchIndexFilename) {
                 // Give every index entry a unique id so that the index does not need to store long URLs.
                 const allDocuments = yield (0, scanDocuments_1.scanDocuments)(versionData.paths);
                 (0, debug_1.debugInfo)("building index");
-                const searchIndex = (0, buildIndex_1.buildIndex)(allDocuments, config);
-                (0, debug_1.debugInfo)("writing index to disk");
-                yield writeFileAsync(path_1.default.join(versionData.outDir, searchIndexFilename), JSON.stringify(searchIndex), { encoding: "utf8" });
-                (0, debug_1.debugInfo)("index written to disk successfully!");
+                const docsByDirMap = new Map();
+                const { searchContextByPaths, hideSearchBarWithNoSearchContext } = config;
+                if (searchContextByPaths) {
+                    const { baseUrl } = buildData;
+                    const rootAllDocs = [];
+                    if (!hideSearchBarWithNoSearchContext) {
+                        docsByDirMap.set("", rootAllDocs);
+                    }
+                    let docIndex = 0;
+                    for (const documents of allDocuments) {
+                        rootAllDocs[docIndex] = [];
+                        for (const doc of documents) {
+                            if (doc.u.startsWith(baseUrl)) {
+                                const uri = doc.u.substring(baseUrl.length);
+                                const matchedPath = searchContextByPaths.find((path) => uri === path || uri.startsWith(`${path}/`));
+                                if (matchedPath) {
+                                    let dirAllDocs = docsByDirMap.get(matchedPath);
+                                    if (!dirAllDocs) {
+                                        dirAllDocs = [];
+                                        docsByDirMap.set(matchedPath, dirAllDocs);
+                                    }
+                                    let dirDocs = dirAllDocs[docIndex];
+                                    if (!dirDocs) {
+                                        dirAllDocs[docIndex] = dirDocs = [];
+                                    }
+                                    dirDocs.push(doc);
+                                    continue;
+                                }
+                            }
+                            rootAllDocs[docIndex].push(doc);
+                        }
+                        docIndex++;
+                    }
+                    for (const [k, v] of docsByDirMap) {
+                        const docsNotEmpty = v.filter((d) => !!d);
+                        if (docsNotEmpty.length < v.length) {
+                            docsByDirMap.set(k, docsNotEmpty);
+                        }
+                    }
+                }
+                else {
+                    docsByDirMap.set("", allDocuments);
+                }
+                for (const [k, allDocs] of docsByDirMap) {
+                    const searchIndex = (0, buildIndex_1.buildIndex)(allDocs, config);
+                    (0, debug_1.debugInfo)(`writing index (/${k}) to disk`);
+                    yield writeFileAsync(path_1.default.join(versionData.outDir, searchIndexFilename.replace("{dir}", k === "" ? "" : `-${k.replace(/\//g, "-")}`)), JSON.stringify(searchIndex), { encoding: "utf8" });
+                    (0, debug_1.debugInfo)(`index (/${k}) written to disk successfully!`);
+                }
             }
         });
     };

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

@@ -28,6 +28,8 @@ const schema = utils_validation_1.Joi.object({
     docsPluginIdForPreferredVersion: utils_validation_1.Joi.string(),
     zhUserDict: utils_validation_1.Joi.string(),
     zhUserDictPath: utils_validation_1.Joi.string(),
+    searchContextByPaths: utils_validation_1.Joi.array().items(utils_validation_1.Joi.string()),
+    hideSearchBarWithNoSearchContext: utils_validation_1.Joi.boolean().default(false),
 });
 function validateOptions({ options, validate, }) {
     return validate(schema, options || {});

package/dist/types/index.d.ts

@@ -0,0 +1,152 @@
+export interface PluginOptions {
+    /**
+     * Whether to index docs.
+     *
+     * @default true
+     */
+    indexDocs?: boolean;
+    /**
+     * Whether to index blog.
+     *
+     * @default true
+     */
+    indexBlog?: boolean;
+    /**
+     * Whether to index pages.
+     *
+     * @default false
+     */
+    indexPages?: boolean;
+    /**
+     * Base route path(s) of docs. Slash at beginning is not required.
+     *
+     * Note: for [docs-only mode](https://docusaurus.io/docs/docs-introduction#docs-only-mode),
+     * this needs to be the same as `routeBasePath` in your `@docusaurus/preset-classic` config e.g., `"/"`.
+     *
+     * @default "/docs"
+     */
+    docsRouteBasePath?: string | string[];
+    /**
+     * Base route path(s) of blog. Slash at beginning is not required.
+     *
+     * @default "/blog"
+     */
+    blogRouteBasePath?: string | string[];
+    /**
+     * All [lunr-languages](https://github.com/MihaiValentin/lunr-languages) supported languages, + `zh` 🔥.
+     */
+    language?: string | string[];
+    /**
+     * Whether to add a hashed query when fetching index (based on the content hash of all indexed
+     * `*.md` in `docsDir` and `blogDir` if applicable). Setting to `"filename"` will save hash in
+     * filename instead of query.
+     *
+     * @default false
+     */
+    hashed?: boolean | "query" | "filename";
+    /**
+     *  The dir(s) of docs to get the content hash, it's relative to the dir of your project.
+     *
+     * @default "docs"
+     */
+    docsDir?: string | string[];
+    /**
+     * The dir(s) of blog to get the content hash, it's relative to the dir of your project.
+     *
+     * @default "blog"
+     */
+    blogDir?: string | string[];
+    /**
+     * When you're using multi-instance of docs, set the docs plugin id which you'd like to
+     * check the preferred version with, for the search index.
+     */
+    docsPluginIdForPreferredVersion?: string;
+    /**
+     * Sometimes people (E.g., us) want to keep the English stop words as indexed, since they
+     * maybe are relevant in programming docs.
+     */
+    removeDefaultStopWordFilter?: boolean;
+    /**
+     * Enable this if you want to be able to search for any partial word at the cost of search performance.
+     *
+     * @default false
+     */
+    removeDefaultStemmer?: boolean;
+    /**
+     * Highlight search terms on target page.
+     *
+     * @default false
+     */
+    highlightSearchTermsOnTargetPage?: boolean;
+    /**
+     * Limit the search results.
+     *
+     * @default 8
+     */
+    searchResultLimits?: number;
+    /**
+     * Set the max length of characters of each search result to show.
+     *
+     * @default 50
+     */
+    searchResultContextMaxLength?: number;
+    /**
+     * Whether an explicit path to a heading should be presented on a suggestion template.
+     *
+     * @default false
+     */
+    explicitSearchResultPath?: boolean;
+    /**
+     * Set the match rules to ignore some routes. Put a string if you want an exact match,
+     * or put a regex if you want a partial match. Note: without the website base url.
+     *
+     * @default []
+     */
+    ignoreFiles?: string | RegExp | (string | RegExp)[];
+    /**
+     * Whether to enable keyboard shortcut to focus in search bar.
+     *
+     * @default true
+     */
+    searchBarShortcut?: boolean;
+    /**
+     * Whether to show keyboard shortcut hint in search bar. Disable it if you need to
+     * hide the hint while shortcut is still enabled.
+     *
+     * @default true
+     */
+    searchBarShortcutHint?: boolean;
+    /**
+     * The side of the navbar the search bar should appear on. By default,
+     * it will try to autodetect based on your docusaurus config according
+     * to [the docs](https://docusaurus.io/docs/api/themes/configuration#navbar-search).
+     *
+     * @default "auto"
+     */
+    searchBarPosition?: "auto" | "left" | "right";
+    /**
+     * Provide your custom dict for language of zh,
+     * [see here](https://github.com/fxsjy/jieba#%E8%BD%BD%E5%85%A5%E8%AF%8D%E5%85%B8)
+     */
+    zhUserDict?: string;
+    /**
+     * Provide the file path to your custom dict for language of zh,
+     * E.g.: `path.resolve("./src/zh-dict.txt")`
+     */
+    zhUserDictPath?: string;
+    /**
+     * Provide an list of sub-paths as separate search context, E.g.: `["docs", "community", "legacy/resources"]`.
+     * It will create multiple search indexes by these paths.
+     */
+    searchContextByPaths?: string[];
+    /**
+     * Whether to hide the search bar when no search context was matched.
+     *
+     * By default, if `searchContextByPaths` is set, pages which are not matched with it will be considered
+     * as with a search context of ROOT. By setting `hideSearchBarWithNoSearchContext` to false, these pages
+     * will be considered as with NO search context, and the search bar will be hidden.
+     *
+     * @default false
+     */
+    hideSearchBarWithNoSearchContext?: boolean;
+}

package/package.json

@@ -1,19 +1,22 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.32.1",
+  "version": "0.33.1",
   "description": "An offline/local search plugin for Docusaurus v2",
   "repository": "https://github.com/easyops-cn/docusaurus-search-local",
   "homepage": "https://github.com/easyops-cn/docusaurus-search-local",
   "scripts": {
-    "start": "concurrently -k -n client,server \"yarn run start:client\" \"yarn run start:server\"",
+    "start": "concurrently -k -n client,server,types \"yarn run start:client\" \"yarn run start:server\" \"yarn run start:types\"",
     "start:client": "tsc --watch --project tsconfig.client.json",
     "start:server": "tsc --watch --project tsconfig.server.json",
-    "build": "rimraf dist && yarn run build:client && yarn run build:server && yarn run copy-static-files",
+    "start:types": "tsc --project tsconfig.types.json --watch",
+    "build": "rimraf dist && yarn run build:client && yarn run build:server && yarn run build:types && yarn run copy-static-files",
     "build:client": "tsc --project tsconfig.client.json",
     "build:server": "tsc --project tsconfig.server.json",
+    "build:types": "tsc --project tsconfig.types.json",
     "copy-static-files": "copyfiles -u 3 \"src/client/theme/**/*.css\" dist/client/client/theme && copyfiles -u 1 \"locales/*.json\" dist/locales"
   },
   "main": "dist/server/server/index.js",
+  "typings": "dist/types/index.d.ts",
   "files": [
     "/dist",
     "!/dist/generated.js"