Merge branch 'master' into fix221017

.yarnrc.yml

@@ -2,6 +2,6 @@ plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
     spec: "@yarnpkg/plugin-workspace-tools"
 
-yarnPath: .yarn/releases/yarn-3.2.2.cjs
+yarnPath: .yarn/releases/yarn-3.2.3.cjs
 
 npmPublishAccess: public

docusaurus-search-local/CHANGELOG.md

@@ -2,6 +2,41 @@
 
 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)
+
+
+### Bug Fixes
+
+* fix indexing when trailingSlash is explicitly set ([cfc603d](https://github.com/easyops-cn/docusaurus-search-local/commit/cfc603db8f0b2467dca064ec2f2f00b3449f4574))
+
+## [0.32.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.31.0...v0.32.0) (2022-09-05)
+
+
+### Features
+
+* support setting searchBarPosition ([60b27d4](https://github.com/easyops-cn/docusaurus-search-local/commit/60b27d4a6e1f3342ac7afda586202fc5d7b8a3bc)), closes [#263](https://github.com/easyops-cn/docusaurus-search-local/issues/263)
+
+## [0.31.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.30.2...v0.31.0) (2022-08-08)
+
+
+### Features
+
+* support `zhUserDict` and `zhUserDictPath` ([33f1ea4](https://github.com/easyops-cn/docusaurus-search-local/commit/33f1ea4765b0e134689fd65aa655c2bc1b4e6f0b)), closes [#246](https://github.com/easyops-cn/docusaurus-search-local/issues/246)
+
 ## [0.30.2](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.30.1...v0.30.2) (2022-07-23)
 
 

docusaurus-search-local/README.md

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

docusaurus-search-local/package.json

@@ -1,19 +1,22 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.30.2",
+  "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"

docusaurus-search-local/src/client/theme/SearchBar/SearchBar.module.css

@@ -16,6 +16,13 @@
   padding: var(--search-local-spacing, 12px);
 }
 
+@media not (max-width: 996px) {
+  .searchBar.searchBarLeft .dropdownMenu {
+    left: 0 !important;
+    right: auto !important;
+  }
+}
+
 @media (max-width: 576px) {
   :global(.navbar__search-input):not(:focus) {
     width: 2rem;

docusaurus-search-local/src/client/theme/SearchBar/SearchBar.tsx

@@ -26,8 +26,11 @@ import {
   Mark,
   searchBarShortcut,
   searchBarShortcutHint,
+  searchBarPosition,
   docsPluginIdForPreferredVersion,
   indexDocs,
+  searchContextByPaths,
+  hideSearchBarWithNoSearchContext,
 } from "../../utils/proxiedGenerated";
 import LoadingRing from "../LoadingRing/LoadingRing";
 
@@ -91,24 +94,54 @@ export default function SearchBar({
   const history = useHistory();
   const location = useLocation();
   const searchBarRef = useRef<HTMLInputElement>(null);
-  const indexState = useRef("empty"); // empty, loaded, done
+  const indexStateMap = useRef(new Map<string, "loading" | "done">());
   // 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<any>(null);
 
+  const prevSearchContext = useRef<string>("");
+  const [searchContext, setSearchContext] = useState<string>("");
+  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(),
     ]);
 
@@ -119,7 +152,9 @@ export default function SearchBar({
         autoselect: true,
         openOnFocus: true,
         cssClasses: {
-          root: styles.searchBar,
+          root: clsx(styles.searchBar, {
+            [styles.searchBarLeft]: searchBarPosition === "left",
+          }),
           noPrefix: true,
           dropdownMenu: styles.dropdownMenu,
           input: styles.input,
@@ -146,7 +181,11 @@ export default function SearchBar({
                 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",
@@ -155,7 +194,7 @@ export default function SearchBar({
               a.addEventListener("click", (e) => {
                 if (!e.ctrlKey && !e.metaKey) {
                   e.preventDefault();
-                  search.current.autocomplete.close();
+                  search.current?.autocomplete.close();
                   history.push(url);
                 }
               });
@@ -191,17 +230,17 @@ export default function SearchBar({
         searchBarRef.current?.blur();
       });
 
-    indexState.current = "done";
+    indexStateMap.current.set(searchContext, "done");
     setLoading(false);
 
     if (focusAfterIndexLoaded.current) {
       const input = searchBarRef.current as HTMLInputElement;
       if (input.value) {
-        search.current.autocomplete.open();
+        search.current?.autocomplete.open();
       }
       input.focus();
     }
-  }, [baseUrl, versionUrl, history]);
+  }, [hidden, searchContext, versionUrl, baseUrl, history]);
 
   useEffect(() => {
     if (!Mark) {
@@ -308,6 +347,7 @@ export default function SearchBar({
         [styles.searchIndexLoading]: loading && inputChanged,
         [styles.focused]: focused,
       })}
+      hidden={hidden}
     >
       <input
         placeholder={translate({

docusaurus-search-local/src/client/theme/SearchBar/fetchIndexes.spec.ts

@@ -1,5 +1,5 @@
 import lunr from "lunr";
-import { fetchIndexes } from "./fetchIndexes";
+import { legacyFetchIndexes as fetchIndexes } from "./fetchIndexes";
 
 jest.mock("lunr");
 jest.mock("../../utils/proxiedGenerated");
@@ -29,7 +29,7 @@ describe("fetchIndexes", () => {
     mockFetch.mockResolvedValueOnce({
       json: () => Promise.resolve([]),
     });
-    const result = await fetchIndexes(baseUrl);
+    const result = await fetchIndexes(baseUrl, "");
     expect(mockFetch).toBeCalledWith("/search-index.json?_=abc");
     expect(result).toEqual({
       wrappedIndexes: [],
@@ -58,8 +58,8 @@ describe("fetchIndexes", () => {
           },
         ]),
     });
-    const result = await fetchIndexes(baseUrl);
-    expect(mockFetch).toBeCalledWith("/search-index.json?_=abc");
+    const result = await fetchIndexes(baseUrl, "community");
+    expect(mockFetch).toBeCalledWith("/search-index-community.json?_=abc");
     expect(result).toEqual({
       wrappedIndexes: [
         {
@@ -74,7 +74,7 @@ describe("fetchIndexes", () => {
 
   test("development", async () => {
     process.env.NODE_ENV = "development";
-    const result = await fetchIndexes(baseUrl);
+    const result = await fetchIndexes(baseUrl, "");
     expect(mockFetch).not.toBeCalled();
     expect(result).toEqual({
       wrappedIndexes: [],

docusaurus-search-local/src/client/theme/SearchBar/fetchIndexes.ts

@@ -13,13 +13,38 @@ interface SerializedIndex {
   };
 }
 
-export async function fetchIndexes(baseUrl: string): Promise<{
+export interface IndexesData {
   wrappedIndexes: WrappedIndex[];
   zhDictionary: string[];
-}> {
+}
+
+const cache = new Map<string, Promise<IndexesData>>();
+
+export function fetchIndexes(
+  baseUrl: string,
+  searchContext: string
+): Promise<IndexesData> {
+  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: string,
+  searchContext: string
+): Promise<IndexesData> {
   if (process.env.NODE_ENV === "production") {
     const json = (await (
-      await fetch(`${baseUrl}${searchIndexUrl}`)
+      await fetch(
+        `${baseUrl}${searchIndexUrl.replace(
+          "{dir}",
+          searchContext ? `-${searchContext.replace(/\//g, "-")}` : ""
+        )}`
+      )
     ).json()) as SerializedIndex[];
 
     const wrappedIndexes: WrappedIndex[] = json.map(

docusaurus-search-local/src/client/theme/SearchPage/SearchPage.tsx

@@ -23,6 +23,7 @@ import { concatDocumentPath } from "../../utils/concatDocumentPath";
 import {
   docsPluginIdForPreferredVersion,
   indexDocs,
+  searchContextByPaths,
 } from "../../utils/proxiedGenerated";
 
 import styles from "./SearchPage.module.css";
@@ -66,7 +67,7 @@ function SearchPageContent(): React.ReactElement {
     }
   }
   const { selectMessage } = usePluralForm();
-  const { searchValue, updateSearchPath } = useSearchQuery();
+  const { searchValue, searchContext, updateSearchPath } = useSearchQuery();
   const [searchQuery, setSearchQuery] = useState(searchValue);
   const [searchSource, setSearchSource] =
     useState<
@@ -127,13 +128,16 @@ function SearchPageContent(): React.ReactElement {
 
   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>

docusaurus-search-local/src/client/theme/hooks/useSearchQuery.ts

@@ -8,8 +8,12 @@
 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(): any {
   const history = useHistory();
@@ -18,11 +22,13 @@ function useSearchQuery(): any {
     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: string) => {
       const searchParams = new URLSearchParams(location.search);
 
@@ -37,8 +43,12 @@ function useSearchQuery(): any {
       });
     },
     generateSearchPageLink: (searchValue: string) => {
+      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)}` : ""
+      }`;
     },
   };
 }

docusaurus-search-local/src/client/utils/__mocks__/proxiedGenerated.ts

@@ -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;