@easyops-cn/docusaurus-search-local 0.26.1 → 0.27.2

package/CHANGELOG.md

@@ -2,18 +2,39 @@
 
 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.26.1](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.26.0...v0.26.1) (2022-05-25)
+## [0.27.2](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.27.1...v0.27.2) (2022-06-21)
+
+
+### Bug Fixes
+
+* search page for non latest doc versions ([15f6161](https://github.com/easyops-cn/docusaurus-search-local/commit/15f61612f8d59dde0ba401e15d76d080865d8e8b))
+* use the active plugin id when getting the current docs version ([824e134](https://github.com/easyops-cn/docusaurus-search-local/commit/824e1347f3f571b45e1e39f708ffd75c01f13339))
+* fix active plugin may be undefined ([0bfbbb2](https://github.com/easyops-cn/docusaurus-search-local/commit/0bfbbb29cee66fcbb3be589da226caef6210fa5a))
+* make `@docusaurus/theme-common` as peer ([68dc812](https://github.com/easyops-cn/docusaurus-search-local/commit/68dc812c84451c68dc9f9448c4a2b39a3f8f3bcc))
+
+## [0.27.1](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.27.0...v0.27.1) (2022-06-13)
+
+### Bug Fixes
+
+- properly support no trailing slashes after fixing indexing top level pages ([999bd8b](https://github.com/easyops-cn/docusaurus-search-local/commit/999bd8bec8abe73f12abe20f58f8030be46c9ecd)), closes [#212](https://github.com/easyops-cn/docusaurus-search-local/issues/212)
 
+## [0.27.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.26.1...v0.27.0) (2022-05-29)
+
+### Features
+
+- versioned search ([6865e7c](https://github.com/easyops-cn/docusaurus-search-local/commit/6865e7c3eee416e53648877359cdf206119be043)), closes [#66](https://github.com/easyops-cn/docusaurus-search-local/issues/66)
+
+### [0.26.1](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.26.0...v0.26.1) (2022-05-25)
 
 ### Bug Fixes
 
-* fix i18n id of `theme.SearchPage.noResultsText` ([fe530f3](https://github.com/easyops-cn/docusaurus-search-local/commit/fe530f35da0b11c78c9d68cb6a7fea5871919e00))
+- fix i18n id of `theme.SearchPage.noResultsText` ([fe530f3](https://github.com/easyops-cn/docusaurus-search-local/commit/fe530f35da0b11c78c9d68cb6a7fea5871919e00))
 
 ## [0.26.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.26.0...v0.26.0) (2022-05-24)
 
 ### Features
 
-* add a clear button to the search bar [#170](https://github.com/easyops-cn/docusaurus-search-local/issues/170) ([f516123](https://github.com/easyops-cn/docusaurus-search-local/commit/f5161238cb7466fe7309e9166037d681e647f910))
+- add a clear button to the search bar [#170](https://github.com/easyops-cn/docusaurus-search-local/issues/170) ([f516123](https://github.com/easyops-cn/docusaurus-search-local/commit/f5161238cb7466fe7309e9166037d681e647f910))
 
 ## [0.25.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.24.1...v0.25.0) (2022-05-19)
 

package/README.md

@@ -0,0 +1 @@
+See https://github.com/easyops-cn/docusaurus-search-local#readme

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

@@ -4,6 +4,8 @@ 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 { useActivePlugin } from "@docusaurus/plugin-content-docs/client";
 import { fetchIndexes } from "./fetchIndexes";
 import { SearchSourceFactory } from "../../utils/SearchSourceFactory";
 import { SuggestionTemplate } from "./SuggestionTemplate";
@@ -27,6 +29,17 @@ async function fetchAutoCompleteJS() {
 const SEARCH_PARAM_HIGHLIGHT = "_highlight";
 export default function SearchBar({ handleSearchBarToggle, }) {
     const { siteConfig: { baseUrl }, } = useDocusaurusContext();
+    // It returns undefined for non-docs pages
+    const activePlugin = useActivePlugin();
+    let versionUrl = baseUrl;
+    // For non-docs pages while using plugin-content-docs with custom ids,
+    // 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 + "/";
+    }
     const history = useHistory();
     const location = useLocation();
     const searchBarRef = useRef(null);
@@ -45,7 +58,7 @@ export default function SearchBar({ handleSearchBarToggle, }) {
         indexState.current = "loading";
         setLoading(true);
         const [{ wrappedIndexes, zhDictionary }, autoComplete] = await Promise.all([
-            fetchIndexes(baseUrl),
+            fetchIndexes(versionUrl),
             fetchAutoCompleteJS(),
         ]);
         search.current = autoComplete(searchBarRef.current, {
@@ -123,7 +136,7 @@ export default function SearchBar({ handleSearchBarToggle, }) {
             }
             input.focus();
         }
-    }, [baseUrl, history]);
+    }, [baseUrl, versionUrl, history]);
     useEffect(() => {
         if (!Mark) {
             return;
@@ -188,15 +201,17 @@ export default function SearchBar({ handleSearchBarToggle, }) {
     const onClearSearch = useCallback(() => {
         const params = new URLSearchParams(location.search);
         params.delete(SEARCH_PARAM_HIGHLIGHT);
-        let paramsStr = params.toString();
-        let searchUrl = location.pathname + (paramsStr != "" ? `?${paramsStr}` : "") + location.hash;
+        const paramsStr = params.toString();
+        const searchUrl = location.pathname +
+            (paramsStr != "" ? `?${paramsStr}` : "") +
+            location.hash;
         if (searchUrl != location.pathname + location.search + location.hash) {
             history.push(searchUrl);
         }
         // We always clear these here because in case no match was selected the above history push wont happen
         setInputValue("");
         search.current?.autocomplete.setVal("");
-    }, [location.pathname, location.search, location.hash]);
+    }, [location.pathname, location.search, location.hash, history]);
     return (<div className={clsx("navbar__search", styles.searchBarContainer, {
             [styles.searchIndexLoading]: loading && inputChanged,
         })}>

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

@@ -4,7 +4,8 @@ import Layout from "@theme/Layout";
 import Head from "@docusaurus/Head";
 import Link from "@docusaurus/Link";
 import { translate } from "@docusaurus/Translate";
-import { usePluralForm } from "@docusaurus/theme-common";
+import { usePluralForm, useDocsPreferredVersion, } from "@docusaurus/theme-common";
+import { useActivePlugin } from "@docusaurus/plugin-content-docs/client";
 import useSearchQuery from "../hooks/useSearchQuery";
 import { fetchIndexes } from "../SearchBar/fetchIndexes";
 import { SearchSourceFactory } from "../../utils/SearchSourceFactory";
@@ -15,7 +16,20 @@ import LoadingRing from "../LoadingRing/LoadingRing";
 import styles from "./SearchPage.module.css";
 import { concatDocumentPath } from "../../utils/concatDocumentPath";
 export default function SearchPage() {
+    return (<Layout>
+      <SearchPageContent />
+    </Layout>);
+}
+function SearchPageContent() {
     const { siteConfig: { baseUrl }, } = useDocusaurusContext();
+    // It returns undefined for non-docs pages.
+    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 + "/";
+    }
     const { selectMessage } = usePluralForm();
     const { searchValue, updateSearchPath } = useSearchQuery();
     const [searchQuery, setSearchQuery] = useState(searchValue);
@@ -59,12 +73,12 @@ export default function SearchPage() {
     }, [searchValue]);
     useEffect(() => {
         async function doFetchIndexes() {
-            const { wrappedIndexes, zhDictionary } = await fetchIndexes(baseUrl);
+            const { wrappedIndexes, zhDictionary } = await fetchIndexes(versionUrl);
             setSearchSource(() => SearchSourceFactory(wrappedIndexes, zhDictionary, 100));
         }
         doFetchIndexes();
-    }, [baseUrl]);
-    return (<Layout>
+    }, [versionUrl]);
+    return (<React.Fragment>
       <Head>
         {/*
          We should not index search pages
@@ -106,7 +120,7 @@ export default function SearchPage() {
             searchResults.map((item) => (<SearchResultItem key={item.document.i} searchResult={item}/>))}
         </section>
       </div>
-    </Layout>);
+    </React.Fragment>);
 }
 function SearchResultItem({ searchResult: { document, type, page, tokens, metadata }, }) {
     const isTitle = type === 0;

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

@@ -16,13 +16,15 @@ function postBuildFactory(config) {
             (0, debug_1.debugInfo)("gathering documents");
             const data = (0, processDocInfos_1.processDocInfos)(buildData, config);
             (0, debug_1.debugInfo)("parsing documents");
-            // 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)(data);
-            (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(buildData.outDir, "search-index.json"), JSON.stringify(searchIndex), { encoding: "utf8" });
-            (0, debug_1.debugInfo)("index written to disk successfully!");
+            for (let 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");
+                const searchIndex = (0, buildIndex_1.buildIndex)(allDocuments, config);
+                (0, debug_1.debugInfo)("writing index to disk");
+                yield writeFileAsync(path_1.default.join(versionData.outDir, "search-index.json"), JSON.stringify(searchIndex), { encoding: "utf8" });
+                (0, debug_1.debugInfo)("index written to disk successfully!");
+            }
         });
     };
 }

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

@@ -3,55 +3,89 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.processDocInfos = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
-function processDocInfos({ routesPaths, outDir, baseUrl, siteConfig }, { indexDocs, indexBlog, indexPages, docsRouteBasePath, blogRouteBasePath, ignoreFiles, }) {
-    return routesPaths
-        .map((url) => {
-        // istanbul ignore next
-        if (!url.startsWith(baseUrl)) {
-            throw new Error(`The route must start with the baseUrl "${baseUrl}", but was "${url}". This is a bug, please report it.`);
-        }
-        const route = url.substr(baseUrl.length).replace(/\/$/, "");
-        // Do not index homepage, error page and search page.
-        if (((!docsRouteBasePath || docsRouteBasePath[0] !== "") && route === "") ||
-            route === "404.html" ||
-            route === "search") {
-            return;
-        }
-        // ignore files
-        if (ignoreFiles === null || ignoreFiles === void 0 ? void 0 : ignoreFiles.some((reg) => {
-            if (typeof reg === "string") {
-                return route === reg;
+function processDocInfos({ routesPaths, outDir, baseUrl, siteConfig, plugins }, { indexDocs, indexBlog, indexPages, docsRouteBasePath, blogRouteBasePath, ignoreFiles, }) {
+    const emptySet = new Set();
+    let versionData = [{ versionOutDir: outDir, docs: emptySet }];
+    if (plugins) {
+        const docsPluginData = plugins.find((element) => element.name === "docusaurus-plugin-content-docs");
+        if (docsPluginData) {
+            versionData = [];
+            const loadedVersions = docsPluginData.content.loadedVersions;
+            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 });
             }
-            return route.match(reg);
-        })) {
-            return;
         }
-        if (indexBlog &&
-            blogRouteBasePath.some((basePath) => isSameOrSubRoute(route, basePath))) {
-            if (blogRouteBasePath.some((basePath) => isSameRoute(route, basePath) ||
-                isSameOrSubRoute(route, path_1.default.posix.join(basePath, "tags")))) {
-                // Do not index list of blog posts and tags filter pages
+    }
+    // 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) {
+        const versionPaths = routesPaths
+            .map((url) => {
+            // istanbul ignore next
+            if (!url.startsWith(baseUrl)) {
+                throw new Error(`The route must start with the baseUrl "${baseUrl}", but was "${url}". This is a bug, please report it.`);
+            }
+            const route = url.substr(baseUrl.length).replace(/\/$/, "");
+            // Do not index homepage, error page and search page.
+            if (((!docsRouteBasePath || docsRouteBasePath[0] !== "") &&
+                route === "") ||
+                route === "404.html" ||
+                route === "search") {
                 return;
             }
-            return { route, url, type: "blog" };
-        }
-        if (indexDocs &&
-            docsRouteBasePath.some((basePath) => isSameOrSubRoute(route, basePath))) {
-            return { route, url, type: "docs" };
-        }
-        if (indexPages) {
-            return { route, url, type: "page" };
+            // ignore files
+            if (ignoreFiles === null || ignoreFiles === void 0 ? void 0 : ignoreFiles.some((reg) => {
+                if (typeof reg === "string") {
+                    return route === reg;
+                }
+                return route.match(reg);
+            })) {
+                return;
+            }
+            if (indexBlog &&
+                blogRouteBasePath.some((basePath) => isSameOrSubRoute(route, basePath))) {
+                if (blogRouteBasePath.some((basePath) => isSameRoute(route, basePath) ||
+                    isSameOrSubRoute(route, path_1.default.posix.join(basePath, "tags")))) {
+                    // Do not index list of blog posts and tags filter pages
+                    return;
+                }
+                return { route, url, type: "blog" };
+            }
+            if (indexDocs &&
+                docsRouteBasePath.some((basePath) => isSameOrSubRoute(route, basePath))) {
+                if (docs.size === 0 || docs.has(url)) {
+                    return { route, url, type: "docs" };
+                }
+                return;
+            }
+            if (indexPages) {
+                return { route, url, type: "page" };
+            }
+            return;
+        })
+            .filter(Boolean)
+            .map(({ route, url, type }) => ({
+            filePath: path_1.default.join(outDir, siteConfig.trailingSlash === false && route != ""
+                ? `${route}.html`
+                : `${route}/index.html`),
+            url,
+            type,
+        }));
+        if (versionPaths.length > 0) {
+            result.push({ outDir: versionOutDir, paths: versionPaths });
         }
-        return;
-    })
-        .filter(Boolean)
-        .map(({ route, url, type }) => ({
-        filePath: path_1.default.join(outDir, siteConfig.trailingSlash === false
-            ? `${route}.html`
-            : `${route}/index.html`),
-        url,
-        type,
-    }));
+    }
+    return result;
 }
 exports.processDocInfos = processDocInfos;
 function isSameRoute(routeA, routeB) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.26.1",
+  "version": "0.27.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,7 +23,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/theme-common": "^2.0.0-beta.20",
+    "@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",
@@ -42,6 +42,7 @@
   },
   "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",
     "@tsconfig/docusaurus": "^1.0.2",
     "@types/cheerio": "^0.22.31",
@@ -60,6 +61,8 @@
     "typescript": "^4.6.4"
   },
   "peerDependencies": {
-    "react": "^16.14.0 || 17 || 18"
+    "@docusaurus/theme-common": "^2.0.0-beta.20",
+    "react": "^16.14.0 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^16.14.0 || ^17.0.0 || ^18.0.0"
   }
 }