@easyops-cn/docusaurus-search-local 0.28.0 → 0.29.2

package/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 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.29.2](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.29.1...v0.29.2) (2022-07-19)
+
+
+### Bug Fixes
+
+* fix website with docs multi-instance ([f61304e](https://github.com/easyops-cn/docusaurus-search-local/commit/f61304e5f3318388d56c1ef791881cd3e3c6e331)), closes [#211](https://github.com/easyops-cn/docusaurus-search-local/issues/211)
+
+## [0.29.1](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.29.0...v0.29.1) (2022-07-19)
+
+
+### Bug Fixes
+
+* require docusaurus v2.0.0-rc.1 ([41a4e67](https://github.com/easyops-cn/docusaurus-search-local/commit/41a4e67543b03f4166589da84cac76a196488e3d))
+* add hack for useDocsPreferredVersion crash in SearchPage ([02fdc42](https://github.com/easyops-cn/docusaurus-search-local/commit/02fdc42a043a4cc1d3fafe9705b478e883543d2b))
+* fix error when not using versions ([f11293f](https://github.com/easyops-cn/docusaurus-search-local/commit/f11293f78c111948c3ea3b8c25a8bb782304ee93))
+
+## [0.29.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.28.0...v0.29.0) (2022-07-07)
+
+
+### Features
+
+* support disabling search bar shortcut ([e0ea5ae](https://github.com/easyops-cn/docusaurus-search-local/commit/e0ea5aeab027724083b0f51290d6ea7e4bc89fa6))
+* support hiding search bar shortcut hint ([9344bd2](https://github.com/easyops-cn/docusaurus-search-local/commit/9344bd20e16c3dd60b3d59fc918dca10e8cfd48f))
+
 ## [0.28.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.27.2...v0.28.0) (2022-06-28)
 
 

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

@@ -4,13 +4,13 @@ import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
 import { useHistory, useLocation } from "@docusaurus/router";
 import { translate } from "@docusaurus/Translate";
-import { useDocsPreferredVersion } from "@docusaurus/theme-common";
+import { ReactContextError, useDocsPreferredVersion, } from "@docusaurus/theme-common";
 import { useActivePlugin } from "@docusaurus/plugin-content-docs/client";
 import { fetchIndexes } from "./fetchIndexes";
 import { SearchSourceFactory } from "../../utils/SearchSourceFactory";
 import { SuggestionTemplate } from "./SuggestionTemplate";
 import { EmptyTemplate } from "./EmptyTemplate";
-import { searchResultLimits, Mark } from "../../utils/proxiedGenerated";
+import { searchResultLimits, Mark, searchBarShortcut, searchBarShortcutHint, docsPluginIdForPreferredVersion, } from "../../utils/proxiedGenerated";
 import LoadingRing from "../LoadingRing/LoadingRing";
 import styles from "./SearchBar.module.css";
 async function fetchAutoCompleteJS() {
@@ -36,9 +36,24 @@ export default function SearchBar({ handleSearchBarToggle, }) {
     // this will throw an error of:
     //   > Docusaurus plugin global data not found for "docusaurus-plugin-content-docs" plugin with id "default".
     // It seems that we can not get the correct id for non-docs pages.
-    const { preferredVersion } = useDocsPreferredVersion(activePlugin?.pluginId);
-    if (preferredVersion && !preferredVersion.isLast) {
-        versionUrl = preferredVersion.path + "/";
+    try {
+        // The try-catch is a hack because useDocsPreferredVersion just throws an
+        // exception when versions are not used.
+        // The same hack is used in SearchPage.tsx
+        // eslint-disable-next-line react-hooks/rules-of-hooks
+        const { preferredVersion } = useDocsPreferredVersion(activePlugin?.pluginId ?? docsPluginIdForPreferredVersion);
+        if (preferredVersion && !preferredVersion.isLast) {
+            versionUrl = preferredVersion.path + "/";
+        }
+    }
+    catch (e) {
+        if (e instanceof ReactContextError) {
+            console.error("useDocsPreferredVersion", e);
+            /* ignore, happens when website doesn't use versions */
+        }
+        else {
+            throw e;
+        }
     }
     const history = useHistory();
     const location = useLocation();
@@ -185,14 +200,17 @@ export default function SearchBar({ handleSearchBarToggle, }) {
         ? /mac/i.test(navigator.userAgentData?.platform ?? navigator.platform)
         : false;
     useEffect(() => {
+        if (!searchBarShortcut) {
+            return;
+        }
         // Add shortcuts command/ctrl + K
-        function handleShortcut(event) {
+        const handleShortcut = (event) => {
             if ((isMac ? event.metaKey : event.ctrlKey) && event.code === "KeyK") {
                 event.preventDefault();
                 searchBarRef.current?.focus();
                 onInputFocus();
             }
-        }
+        };
         document.addEventListener("keydown", handleShortcut);
         return () => {
             document.removeEventListener("keydown", handleShortcut);
@@ -221,11 +239,13 @@ export default function SearchBar({ handleSearchBarToggle, }) {
             description: "The ARIA label and placeholder for search button",
         })} aria-label="Search" className="navbar__search-input" onMouseEnter={onInputMouseEnter} onFocus={onInputFocus} onBlur={onInputBlur} onChange={onInputChange} ref={searchBarRef} value={inputValue}/>
       <LoadingRing className={styles.searchBarLoadingRing}/>
-      {inputValue !== "" ? (<button className={styles.searchClearButton} onClick={onClearSearch}>
-          ✕
-        </button>) : (<div className={styles.searchHintContainer}>
-          <kbd className={styles.searchHint}>{isMac ? "⌘" : "ctrl"}</kbd>
-          <kbd className={styles.searchHint}>K</kbd>
-        </div>)}
+      {searchBarShortcut &&
+            searchBarShortcutHint &&
+            (inputValue !== "" ? (<button className={styles.searchClearButton} onClick={onClearSearch}>
+            ✕
+          </button>) : (<div className={styles.searchHintContainer}>
+            <kbd className={styles.searchHint}>{isMac ? "⌘" : "ctrl"}</kbd>
+            <kbd className={styles.searchHint}>K</kbd>
+          </div>))}
     </div>);
 }

package/dist/client/client/theme/SearchBar/SearchBar.module.css

@@ -231,7 +231,7 @@ html[data-theme="dark"] .noResultsIcon {
 
 .searchHint {
   color: var(--ifm-navbar-search-input-placeholder-color);
-  background-color: var(--ifm-navbar-background-color);
+  background-color: var(--ifm-navbar-search-input-background-color);
   border: 1px solid var(--ifm-color-emphasis-500);
   box-shadow: inset 0 -1px 0 var(--ifm-color-emphasis-500);
 }

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

@@ -4,7 +4,7 @@ import Layout from "@theme/Layout";
 import Head from "@docusaurus/Head";
 import Link from "@docusaurus/Link";
 import { translate } from "@docusaurus/Translate";
-import { usePluralForm, useDocsPreferredVersion, } from "@docusaurus/theme-common";
+import { usePluralForm, useDocsPreferredVersion, ReactContextError, } from "@docusaurus/theme-common";
 import { useActivePlugin } from "@docusaurus/plugin-content-docs/client";
 import useSearchQuery from "../hooks/useSearchQuery";
 import { fetchIndexes } from "../SearchBar/fetchIndexes";
@@ -13,8 +13,9 @@ import { highlight } from "../../utils/highlight";
 import { highlightStemmed } from "../../utils/highlightStemmed";
 import { getStemmedPositions } from "../../utils/getStemmedPositions";
 import LoadingRing from "../LoadingRing/LoadingRing";
-import styles from "./SearchPage.module.css";
 import { concatDocumentPath } from "../../utils/concatDocumentPath";
+import { docsPluginIdForPreferredVersion } from "../../utils/proxiedGenerated";
+import styles from "./SearchPage.module.css";
 export default function SearchPage() {
     return (<Layout>
       <SearchPageContent />
@@ -26,9 +27,24 @@ function SearchPageContent() {
     const activePlugin = useActivePlugin();
     let versionUrl = baseUrl;
     // There is an issue, see `SearchBar.tsx`.
-    const { preferredVersion } = useDocsPreferredVersion(activePlugin?.pluginId);
-    if (preferredVersion && !preferredVersion.isLast) {
-        versionUrl = preferredVersion.path + "/";
+    try {
+        // The try-catch is a hack because useDocsPreferredVersion just throws an
+        // exception when versions are not used.
+        // The same hack is used in SearchBar.tsx
+        // eslint-disable-next-line react-hooks/rules-of-hooks
+        const { preferredVersion } = useDocsPreferredVersion(activePlugin?.pluginId ?? docsPluginIdForPreferredVersion);
+        if (preferredVersion && !preferredVersion.isLast) {
+            versionUrl = preferredVersion.path + "/";
+        }
+    }
+    catch (e) {
+        if (e instanceof ReactContextError) {
+            console.error("useDocsPreferredVersion", e);
+            /* ignore, happens when website doesn't use versions */
+        }
+        else {
+            throw e;
+        }
     }
     const { selectMessage } = usePluralForm();
     const { searchValue, updateSearchPath } = useSearchQuery();

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

@@ -5,6 +5,7 @@ export const indexHash = "abc";
 export const searchResultLimits = 8;
 export const searchResultContextMaxLength = 50;
 export const explicitSearchResultPath = false;
+export const docsPluginIdForPreferredVersion = undefined;
 export function __setLanguage(value) {
     language = value;
 }

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, } = config;
+    const { language, removeDefaultStopWordFilter, removeDefaultStemmer, highlightSearchTermsOnTargetPage, searchResultLimits, searchResultContextMaxLength, explicitSearchResultPath, searchBarShortcut, searchBarShortcutHint, docsPluginIdForPreferredVersion, } = config;
     const indexHash = (0, getIndexHash_1.getIndexHash)(config);
     const contents = [
         `import lunr from ${JSON.stringify(require.resolve("lunr"))};`,
@@ -38,6 +38,11 @@ function generate(config, dir) {
     contents.push(`export const indexHash = ${JSON.stringify(indexHash)};`);
     contents.push(`export const searchResultLimits = ${JSON.stringify(searchResultLimits)};`, `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)};`);
+    contents.push(`export const docsPluginIdForPreferredVersion = ${docsPluginIdForPreferredVersion === undefined
+        ? "undefined"
+        : JSON.stringify(docsPluginIdForPreferredVersion)};`);
     fs_1.default.writeFileSync(path_1.default.join(dir, "generated.js"), contents.join("\n"));
 }
 exports.generate = generate;

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

@@ -16,7 +16,7 @@ function postBuildFactory(config) {
             (0, debug_1.debugInfo)("gathering documents");
             const data = (0, processDocInfos_1.processDocInfos)(buildData, config);
             (0, debug_1.debugInfo)("parsing documents");
-            for (let versionData of data) {
+            for (const versionData of data) {
                 // 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");

package/dist/server/server/utils/processDocInfos.js

@@ -3,32 +3,40 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.processDocInfos = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
+const debug_1 = require("./debug");
 function processDocInfos({ routesPaths, outDir, baseUrl, siteConfig, plugins }, { indexDocs, indexBlog, indexPages, docsRouteBasePath, blogRouteBasePath, ignoreFiles, }) {
     const emptySet = new Set();
-    let versionData = [{ versionOutDir: outDir, docs: emptySet }];
+    let versionData = new Map([[outDir, emptySet]]);
     if (plugins) {
-        const docsPluginData = plugins.find((element) => element.name === "docusaurus-plugin-content-docs");
-        if (docsPluginData) {
-            versionData = [];
-            const loadedVersions = docsPluginData.content.loadedVersions;
+        // Handle docs multi-instance.
+        const docsPlugins = plugins.filter((item) => item.name === "docusaurus-plugin-content-docs");
+        const loadedVersions = docsPlugins.flatMap((plugin) => plugin.content.loadedVersions);
+        (0, debug_1.debugVerbose)("loadedVersions:", loadedVersions);
+        if (loadedVersions.length > 0) {
+            versionData = new Map();
             for (const loadedVersion of loadedVersions) {
-                const docs = new Set();
-                for (const doc of loadedVersion.docs) {
-                    docs.add(doc.permalink);
-                }
                 const route = loadedVersion.path.substr(baseUrl.length);
                 let versionOutDir = outDir;
                 // The last versions search-index should always be placed in the root since it is the one used from non-docs pages
                 if (!loadedVersion.isLast) {
                     versionOutDir = path_1.default.join(outDir, ...route.split("/").filter((i) => i));
                 }
-                versionData.push({ versionOutDir, docs });
+                // Merge docs which share the same `versionOutDir`.
+                let docs = versionData.get(versionOutDir);
+                if (!docs) {
+                    docs = new Set();
+                    versionData.set(versionOutDir, docs);
+                }
+                for (const doc of loadedVersion.docs) {
+                    docs.add(doc.permalink);
+                }
             }
+            (0, debug_1.debugVerbose)("versionData:", versionData);
         }
     }
     // Create a list of files to index per document version. This will always include all pages and blogs.
     const result = [];
-    for (const { versionOutDir, docs } of versionData) {
+    for (const [versionOutDir, docs] of versionData.entries()) {
         const versionPaths = routesPaths
             .map((url) => {
             // istanbul ignore next

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

@@ -21,6 +21,9 @@ const schema = utils_validation_1.Joi.object({
     searchResultContextMaxLength: utils_validation_1.Joi.number().default(50),
     explicitSearchResultPath: utils_validation_1.Joi.boolean().default(false),
     ignoreFiles: isArrayOfStringsOrRegExpsOrStringOrRegExp.default([]),
+    searchBarShortcut: utils_validation_1.Joi.boolean().default(true),
+    searchBarShortcutHint: utils_validation_1.Joi.boolean().default(true),
+    docsPluginIdForPreferredVersion: utils_validation_1.Joi.string(),
 });
 function validateOptions({ options, validate, }) {
     return validate(schema, options || {});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.28.0",
+  "version": "0.29.2",
   "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",
@@ -23,11 +23,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/plugin-content-docs": "^2.0.0-beta.20",
-    "@docusaurus/theme-translations": "^2.0.0-beta.20",
-    "@docusaurus/utils": "^2.0.0-beta.20",
-    "@docusaurus/utils-common": "^2.0.0-beta.20",
-    "@docusaurus/utils-validation": "^2.0.0-beta.20",
+    "@docusaurus/plugin-content-docs": "^2.0.0-rc.1",
+    "@docusaurus/theme-translations": "^2.0.0-rc.1",
+    "@docusaurus/utils": "^2.0.0-rc.1",
+    "@docusaurus/utils-common": "^2.0.0-rc.1",
+    "@docusaurus/utils-validation": "^2.0.0-rc.1",
     "@easyops-cn/autocomplete.js": "^0.38.1",
     "@node-rs/jieba": "^1.6.0",
     "cheerio": "^1.0.0-rc.3",
@@ -41,9 +41,9 @@
     "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^2.0.0-beta.20",
-    "@docusaurus/theme-common": "^2.0.0-beta.20",
-    "@docusaurus/types": "^2.0.0-beta.20",
+    "@docusaurus/module-type-aliases": "^2.0.0-rc.1",
+    "@docusaurus/theme-common": "^2.0.0-rc.1",
+    "@docusaurus/types": "^2.0.0-rc.1",
     "@tsconfig/docusaurus": "^1.0.2",
     "@types/cheerio": "^0.22.31",
     "@types/debug": "^4.1.5",
@@ -58,10 +58,10 @@
     "concurrently": "^7.0.0",
     "copyfiles": "^2.4.0",
     "rimraf": "^3.0.2",
-    "typescript": "^4.6.4"
+    "typescript": "^4.7.4"
   },
   "peerDependencies": {
-    "@docusaurus/theme-common": "^2.0.0-beta.20",
+    "@docusaurus/theme-common": "^2.0.0-rc.1",
     "react": "^16.14.0 || ^17.0.0 || ^18.0.0",
     "react-dom": "^16.14.0 || ^17.0.0 || ^18.0.0"
   }