@easyops-cn/docusaurus-search-local 0.29.4 → 0.30.2

package/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 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.30.2](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.30.1...v0.30.2) (2022-07-23)
+
+
+### Bug Fixes
+
+* remove useDocsPreferredVersion error log entirely ([56f5ab5](https://github.com/easyops-cn/docusaurus-search-local/commit/56f5ab51a77f682c565d357bcbf7a37567c2b21e))
+* use debug instead of console.error for useDocsPreferredVersion message ([3a09e39](https://github.com/easyops-cn/docusaurus-search-local/commit/3a09e39ef569a9dd1d99b1e251fdc79f909cff0f))
+
+## [0.30.1](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.30.0...v0.30.1) (2022-07-22)
+
+
+### Bug Fixes
+
+* fix building error when docs disabled ([07b1724](https://github.com/easyops-cn/docusaurus-search-local/commit/07b17245ff526783dfc1469de91928d5a64bb909))
+
+## [0.30.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.29.4...v0.30.0) (2022-07-22)
+
+
+### Features
+
+* support saving hash in filename instead of query ([4930a88](https://github.com/easyops-cn/docusaurus-search-local/commit/4930a88779813ffcaa932a56f786066f969aff6e)), closes [#171](https://github.com/easyops-cn/docusaurus-search-local/issues/171)
+
 ## [0.29.4](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.29.3...v0.29.4) (2022-07-22)
 
 

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, docsPluginIdForPreferredVersion, } from "../../utils/proxiedGenerated";
+import { searchResultLimits, Mark, searchBarShortcut, searchBarShortcutHint, docsPluginIdForPreferredVersion, indexDocs, } from "../../utils/proxiedGenerated";
 import LoadingRing from "../LoadingRing/LoadingRing";
 import styles from "./SearchBar.module.css";
 async function fetchAutoCompleteJS() {
@@ -47,12 +47,13 @@ export default function SearchBar({ handleSearchBarToggle, }) {
         }
     }
     catch (e) {
-        if (e instanceof ReactContextError) {
-            console.error("useDocsPreferredVersion", e);
-            /* ignore, happens when website doesn't use versions */
-        }
-        else {
-            throw e;
+        if (indexDocs) {
+            if (e instanceof ReactContextError) {
+                /* ignore, happens when website doesn't use versions */
+            }
+            else {
+                throw e;
+            }
         }
     }
     const history = useHistory();

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

@@ -1,8 +1,8 @@
 import lunr from "lunr";
-import { indexHash } from "../../utils/proxiedGenerated";
+import { searchIndexUrl } from "../../utils/proxiedGenerated";
 export async function fetchIndexes(baseUrl) {
     if (process.env.NODE_ENV === "production") {
-        const json = (await (await fetch(`${baseUrl}search-index.json?_=${indexHash}`)).json());
+        const json = (await (await fetch(`${baseUrl}${searchIndexUrl}`)).json());
         const wrappedIndexes = json.map(({ documents, index }, type) => ({
             type: type,
             documents,

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

@@ -14,7 +14,7 @@ import { highlightStemmed } from "../../utils/highlightStemmed";
 import { getStemmedPositions } from "../../utils/getStemmedPositions";
 import LoadingRing from "../LoadingRing/LoadingRing";
 import { concatDocumentPath } from "../../utils/concatDocumentPath";
-import { docsPluginIdForPreferredVersion } from "../../utils/proxiedGenerated";
+import { docsPluginIdForPreferredVersion, indexDocs, } from "../../utils/proxiedGenerated";
 import styles from "./SearchPage.module.css";
 export default function SearchPage() {
     return (<Layout>
@@ -38,12 +38,13 @@ function SearchPageContent() {
         }
     }
     catch (e) {
-        if (e instanceof ReactContextError) {
-            console.error("useDocsPreferredVersion", e);
-            /* ignore, happens when website doesn't use versions */
-        }
-        else {
-            throw e;
+        if (indexDocs) {
+            if (e instanceof ReactContextError) {
+                /* ignore, happens when website doesn't use versions */
+            }
+            else {
+                throw e;
+            }
         }
     }
     const { selectMessage } = usePluralForm();

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

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

package/dist/server/server/index.js

@@ -14,7 +14,7 @@ function DocusaurusSearchLocalPlugin(context, options) {
     const config = (0, processPluginOptions_1.processPluginOptions)(options, context.siteDir);
     const dir = path_1.default.join(context.generatedFilesDir, PLUGIN_NAME, "default");
     fs_extra_1.default.ensureDirSync(dir);
-    (0, generate_1.generate)(config, dir);
+    const searchIndexFilename = (0, generate_1.generate)(config, dir);
     const themePath = path_1.default.resolve(__dirname, "../../client/client/theme");
     const pagePath = path_1.default.join(themePath, "SearchPage/index.js");
     return {
@@ -22,7 +22,7 @@ function DocusaurusSearchLocalPlugin(context, options) {
         getThemePath() {
             return themePath;
         },
-        postBuild: (0, postBuildFactory_1.postBuildFactory)(config),
+        postBuild: (0, postBuildFactory_1.postBuildFactory)(config, searchIndexFilename),
         getPathsToWatch() {
             return [pagePath];
         },

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

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

@@ -10,7 +10,7 @@ const debug_1 = require("./debug");
 const processDocInfos_1 = require("./processDocInfos");
 const scanDocuments_1 = require("./scanDocuments");
 const writeFileAsync = util_1.default.promisify(fs_1.default.writeFile);
-function postBuildFactory(config) {
+function postBuildFactory(config, searchIndexFilename) {
     return function postBuild(buildData) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             (0, debug_1.debugInfo)("gathering documents");
@@ -22,7 +22,7 @@ function postBuildFactory(config) {
                 (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" });
+                yield writeFileAsync(path_1.default.join(versionData.outDir, searchIndexFilename), JSON.stringify(searchIndex), { encoding: "utf8" });
                 (0, debug_1.debugInfo)("index written to disk successfully!");
             }
         });

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const isStringOrArrayOfStrings = utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.array().items(utils_validation_1.Joi.string()));
+const isBooleanOrString = utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.boolean(), utils_validation_1.Joi.string());
 const isArrayOfStringsOrRegExpsOrStringOrRegExp = utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.array().items(utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.object().regex())), utils_validation_1.Joi.string(), utils_validation_1.Joi.object().regex());
 const schema = utils_validation_1.Joi.object({
     indexDocs: utils_validation_1.Joi.boolean().default(true),
@@ -11,7 +12,7 @@ const schema = utils_validation_1.Joi.object({
     docsRouteBasePath: isStringOrArrayOfStrings.default(["docs"]),
     blogRouteBasePath: isStringOrArrayOfStrings.default(["blog"]),
     language: isStringOrArrayOfStrings.default(["en"]),
-    hashed: utils_validation_1.Joi.boolean().default(false),
+    hashed: isBooleanOrString.default(false),
     docsDir: isStringOrArrayOfStrings.default(["docs"]),
     blogDir: isStringOrArrayOfStrings.default(["blog"]),
     removeDefaultStopWordFilter: utils_validation_1.Joi.boolean().default(false),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.29.4",
+  "version": "0.30.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",