@easyops-cn/docusaurus-search-local 0.52.3 → 0.54.0

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 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.54.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.53.0...v0.54.0) (2026-02-08)
+
+
+### Features
+
+* make open-ask-ai async and optional ([4c404ab](https://github.com/easyops-cn/docusaurus-search-local/commit/4c404ab21a6ea232d82e9bdd3041d6a1c7ac73d1))
+* make open-ask-ai async and optional ([e031739](https://github.com/easyops-cn/docusaurus-search-local/commit/e031739116d9cc1eee18ecb13e6752474fdd2f79)), closes [#558](https://github.com/easyops-cn/docusaurus-search-local/issues/558)
+
+## [0.53.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.52.3...v0.53.0) (2026-02-05)
+
+
+### Features
+
+* support Ask AI ([8a5d29e](https://github.com/easyops-cn/docusaurus-search-local/commit/8a5d29e2e5b3b1cb534b1bbf13075f6824307d2e))
+* support Ask AI ([3b2e339](https://github.com/easyops-cn/docusaurus-search-local/commit/3b2e339a04ac9347e73fe39d63237ffa3e63242a))
+
 ## [0.52.3](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.52.2...v0.52.3) (2026-01-29)
 
 

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

@@ -8,7 +8,8 @@ import { useActivePlugin, useActiveVersion, } from "@docusaurus/plugin-content-d
 import { fetchIndexesByWorker, searchByWorker } from "../searchByWorker";
 import { SuggestionTemplate } from "./SuggestionTemplate";
 import { EmptyTemplate } from "./EmptyTemplate";
-import { Mark, searchBarShortcut, searchBarShortcutHint, searchBarShortcutKeymap, searchBarPosition, docsPluginIdForPreferredVersion, searchContextByPaths, hideSearchBarWithNoSearchContext, useAllContextsWithNoSearchContext, } from "../../utils/proxiedGenerated";
+import { SearchDocumentType } from "../../../shared/interfaces";
+import { Mark, searchBarShortcut, searchBarShortcutHint, searchBarShortcutKeymap, searchBarPosition, docsPluginIdForPreferredVersion, searchContextByPaths, hideSearchBarWithNoSearchContext, useAllContextsWithNoSearchContext, askAi, } from "../../utils/proxiedGenerated";
 import LoadingRing from "../LoadingRing/LoadingRing";
 import { normalizeContextByPath } from "../../utils/normalizeContextByPath";
 import { searchResultLimits } from "../../utils/proxiedGeneratedConstants";
@@ -28,6 +29,19 @@ async function fetchAutoCompleteJS() {
     }
     return autoComplete;
 }
+async function fetchOpenAskAI() {
+    try {
+        const openAskAIModule = await import("open-ask-ai");
+        await import("open-ask-ai/styles.css");
+        return {
+            AskAIWidget: openAskAIModule.AskAIWidget,
+        };
+    }
+    catch (error) {
+        // open-ask-ai is optional, return null if not available
+        return null;
+    }
+}
 const SEARCH_PARAM_HIGHLIGHT = "_highlight";
 export default function SearchBar({ handleSearchBarToggle, }) {
     const isBrowser = useIsBrowser();
@@ -49,6 +63,8 @@ export default function SearchBar({ handleSearchBarToggle, }) {
     const [inputChanged, setInputChanged] = useState(false);
     const [inputValue, setInputValue] = useState("");
     const search = useRef(null);
+    const askAIWidgetRef = useRef(null);
+    const [AskAIWidgetComponent, setAskAIWidgetComponent] = useState(null);
     const prevSearchContext = useRef("");
     const [searchContext, setSearchContext] = useState("");
     const prevVersionUrl = useRef(baseUrl);
@@ -94,10 +110,14 @@ export default function SearchBar({ handleSearchBarToggle, }) {
         indexStateMap.current.set(searchContext, "loading");
         search.current?.autocomplete.destroy();
         setLoading(true);
-        const [autoComplete] = await Promise.all([
+        const [autoComplete, openAskAIModule] = await Promise.all([
             fetchAutoCompleteJS(),
+            askAi ? fetchOpenAskAI() : Promise.resolve(null),
             fetchIndexesByWorker(versionUrl, searchContext),
         ]);
+        if (openAskAIModule) {
+            setAskAIWidgetComponent(() => openAskAIModule.AskAIWidget);
+        }
         const searchFooterLinkElement = ({ query, isEmpty, }) => {
             const a = document.createElement("a");
             const params = new URLSearchParams();
@@ -176,7 +196,25 @@ export default function SearchBar({ handleSearchBarToggle, }) {
             {
                 source: async (input, callback) => {
                     const result = await searchByWorker(versionUrl, searchContext, input, searchResultLimits);
-                    callback(result);
+                    if (input && askAi) {
+                        callback([
+                            {
+                                document: {
+                                    i: -1,
+                                    t: "",
+                                    u: "",
+                                },
+                                type: SearchDocumentType.AskAI,
+                                page: undefined,
+                                metadata: {},
+                                tokens: [input],
+                            },
+                            ...result,
+                        ]);
+                    }
+                    else {
+                        callback(result);
+                    }
                 },
                 templates: {
                     suggestion: SuggestionTemplate,
@@ -195,8 +233,12 @@ export default function SearchBar({ handleSearchBarToggle, }) {
                 },
             },
         ])
-            .on("autocomplete:selected", function (event, { document: { u, h }, tokens }) {
+            .on("autocomplete:selected", function (event, { document: { u, h }, type, tokens }) {
             searchBarRef.current?.blur();
+            if (type === SearchDocumentType.AskAI && askAi) {
+                askAIWidgetRef.current?.openWithNewSession(tokens.join(""));
+                return;
+            }
             let url = u;
             if (Mark && tokens.length > 0) {
                 const params = new URLSearchParams();
@@ -333,6 +375,9 @@ export default function SearchBar({ handleSearchBarToggle, }) {
             message: "Search",
             description: "The ARIA label and placeholder for search button",
         })} aria-label="Search" className={`navbar__search-input ${styles.searchInput}`} onMouseEnter={onInputMouseEnter} onFocus={onInputFocus} onBlur={onInputBlur} onChange={onInputChange} ref={searchBarRef} value={inputValue}/>
+      {askAi && AskAIWidgetComponent && (<AskAIWidgetComponent ref={askAIWidgetRef} {...askAi}>
+          <span hidden></span>
+        </AskAIWidgetComponent>)}
       <LoadingRing className={styles.searchBarLoadingRing}/>
       {searchBarShortcut &&
             searchBarShortcutHint &&

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

@@ -17,10 +17,37 @@
 }
 
 .searchInput:focus {
-  outline: 2px solid var(--search-local-input-active-border-color, var(--ifm-color-primary));
+  outline: 2px solid
+    var(--search-local-input-active-border-color, var(--ifm-color-primary));
   outline-offset: 0px;
 }
 
+html[data-theme="dark"] div:global(.ask-ai),
+div:global(.ask-ai) {
+  --ask-ai-primary: var(--ifm-color-primary);
+  --ask-ai-primary-hover: var(--ifm-color-primary-light);
+  --ask-ai-foreground: var(--ifm-color-content);
+  --ask-ai-border: var(--ifm-color-emphasis-300);
+  --ask-ai-error: var(--ifm-color-danger);
+  --ask-ai-button-bg: var(--ifm-color-emphasis-200);
+}
+
+:global(.ask-ai) {
+  --ask-ai-background: var(--search-local-modal-background, #f5f6f7);
+  --ask-ai-muted: var(--search-local-muted-color, #969faf);
+}
+
+html[data-theme="dark"] :global(.ask-ai) {
+  --ask-ai-background: var(
+    --search-local-modal-background,
+    var(--ifm-background-color)
+  );
+  --ask-ai-muted: var(
+    --search-local-muted-color,
+    var(--ifm-color-secondary-darkest)
+  );
+}
+
 @media not (max-width: 996px) {
   .searchBar.searchBarLeft .dropdownMenu {
     left: 0 !important;

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

@@ -1,12 +1,21 @@
 import { SearchDocumentType, } from "../../../shared/interfaces";
 import { concatDocumentPath } from "../../utils/concatDocumentPath";
+import { escapeHtml } from "../../utils/escapeHtml";
 import { getStemmedPositions } from "../../utils/getStemmedPositions";
 import { highlight } from "../../utils/highlight";
 import { highlightStemmed } from "../../utils/highlightStemmed";
 import { explicitSearchResultPath } from "../../utils/proxiedGenerated";
-import { iconAction, iconContent, iconHeading, iconTitle, iconTreeInter, iconTreeLast, } from "./icons";
+import { iconAction, iconAskAI, iconContent, iconHeading, iconTitle, iconTreeInter, iconTreeLast, } from "./icons";
 import styles from "./SearchBar.module.css";
 export function SuggestionTemplate({ document, type, page, metadata, tokens, isInterOfTree, isLastOfTree, }) {
+    if (type === SearchDocumentType.AskAI) {
+        return [
+            `<span class="${styles.hitIcon}">${iconAskAI}</span>`,
+            `<span class="${styles.hitWrapper}">`,
+            `<span class="${styles.hitTitle}">Ask AI: <mark>${escapeHtml(tokens.join(" "))}</mark></span>`,
+            `</span>`,
+        ].join("");
+    }
     const isTitle = type === SearchDocumentType.Title;
     const isKeywords = type === SearchDocumentType.Keywords;
     const isTitleRelated = isTitle || isKeywords;

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

@@ -5,3 +5,4 @@ export const iconAction = '<svg width="20" height="20" viewBox="0 0 20 20"><g st
 export const iconNoResults = '<svg width="40" height="40" viewBox="0 0 20 20" fill="none" fill-rule="evenodd" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"><path d="M15.5 4.8c2 3 1.7 7-1 9.7h0l4.3 4.3-4.3-4.3a7.8 7.8 0 01-9.8 1m-2.2-2.2A7.8 7.8 0 0113.2 2.4M2 18L18 2"></path></svg>';
 export const iconTreeInter = '<svg viewBox="0 0 24 54"><g stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"><path d="M8 6v42M20 27H8.3"></path></g></svg>';
 export const iconTreeLast = '<svg viewBox="0 0 24 54"><g stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"><path d="M8 6v21M20 27H8.3"></path></g></svg>';
+export const iconAskAI = '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-sparkles-icon lucide-sparkles"><path d="M11.017 2.814a1 1 0 0 1 1.966 0l1.051 5.558a2 2 0 0 0 1.594 1.594l5.558 1.051a1 1 0 0 1 0 1.966l-5.558 1.051a2 2 0 0 0-1.594 1.594l-1.051 5.558a1 1 0 0 1-1.966 0l-1.051-5.558a2 2 0 0 0-1.594-1.594l-5.558-1.051a1 1 0 0 1 0-1.966l5.558-1.051a2 2 0 0 0 1.594-1.594z"/><path d="M20 2v4"/><path d="M22 4h-4"/><circle cx="4" cy="20" r="2"/></svg>';

package/dist/client/shared/interfaces.js

@@ -5,4 +5,5 @@ export var SearchDocumentType;
     SearchDocumentType[SearchDocumentType["Description"] = 2] = "Description";
     SearchDocumentType[SearchDocumentType["Keywords"] = 3] = "Keywords";
     SearchDocumentType[SearchDocumentType["Content"] = 4] = "Content";
+    SearchDocumentType[SearchDocumentType["AskAI"] = 5] = "AskAI";
 })(SearchDocumentType || (SearchDocumentType = {}));

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, searchBarShortcutKeymap, searchBarPosition, docsPluginIdForPreferredVersion, indexDocs, searchContextByPaths, hideSearchBarWithNoSearchContext, useAllContextsWithNoSearchContext, fuzzyMatchingDistance, } = config;
+    const { language, removeDefaultStopWordFilter, removeDefaultStemmer, highlightSearchTermsOnTargetPage, searchResultLimits, searchResultContextMaxLength, explicitSearchResultPath, searchBarShortcut, searchBarShortcutHint, searchBarShortcutKeymap, searchBarPosition, docsPluginIdForPreferredVersion, indexDocs, searchContextByPaths, hideSearchBarWithNoSearchContext, useAllContextsWithNoSearchContext, fuzzyMatchingDistance, askAi, } = config;
     const indexHash = (0, getIndexHash_1.getIndexHash)(config);
     const contents = [];
     contents.push(`export const removeDefaultStemmer = ${JSON.stringify(removeDefaultStemmer)};`);
@@ -41,6 +41,7 @@ function generate(config, dir) {
         : null)};`);
     contents.push(`export const hideSearchBarWithNoSearchContext = ${JSON.stringify(!!hideSearchBarWithNoSearchContext)};`);
     contents.push(`export const useAllContextsWithNoSearchContext = ${JSON.stringify(!!useAllContextsWithNoSearchContext)};`);
+    contents.push(`export const askAi = ${JSON.stringify(askAi !== null && askAi !== void 0 ? askAi : null)};`);
     fs_1.default.writeFileSync(path_1.default.join(dir, "generated.js"), contents.join("\n"));
     const constantContents = [
         `import lunr from ${JSON.stringify(require.resolve("lunr"))};`,

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

@@ -40,6 +40,7 @@ const schema = utils_validation_1.Joi.object({
     useAllContextsWithNoSearchContext: utils_validation_1.Joi.boolean().default(false),
     forceIgnoreNoIndex: utils_validation_1.Joi.boolean().default(false),
     fuzzyMatchingDistance: utils_validation_1.Joi.number().default(1),
+    askAi: utils_validation_1.Joi.object().optional(),
 });
 function validateOptions({ options, validate, }) {
     return validate(schema, options || {});

package/dist/server/shared/interfaces.js

@@ -8,4 +8,5 @@ var SearchDocumentType;
     SearchDocumentType[SearchDocumentType["Description"] = 2] = "Description";
     SearchDocumentType[SearchDocumentType["Keywords"] = 3] = "Keywords";
     SearchDocumentType[SearchDocumentType["Content"] = 4] = "Content";
+    SearchDocumentType[SearchDocumentType["AskAI"] = 5] = "AskAI";
 })(SearchDocumentType || (exports.SearchDocumentType = SearchDocumentType = {}));

package/dist/types/declarations.d.ts

@@ -0,0 +1,55 @@
+declare module "ai" {
+    interface UIMessage {
+    }
+    interface UIMessageChunk {
+    }
+}
+declare module "@easyops-cn/autocomplete.js" {
+    const noConflict: () => void;
+}
+declare module "open-ask-ai" {
+    interface AskAIWidgetProps {
+        [key: string]: any;
+    }
+    interface AskAIWidgetRef {
+        openWithNewSession: (query: string) => void;
+    }
+    const AskAIWidget: any;
+}
+interface AskAIConfig {
+    [key: string]: any;
+}
+declare module "*/generated.js" {
+    const removeDefaultStemmer: string[];
+    class Mark {
+        constructor(root: HTMLElement);
+        mark: (terms: string[], options?: Record<string, unknown>) => void;
+        unmark: () => void;
+    }
+    const searchResultContextMaxLength: number;
+    const explicitSearchResultPath: boolean;
+    const searchBarShortcut: boolean;
+    const searchBarShortcutHint: boolean;
+    const searchBarShortcutKeymap: string;
+    const searchBarPosition: "left" | "right";
+    const docsPluginIdForPreferredVersion: string;
+    const indexDocs: boolean;
+    const searchContextByPaths: (string | {
+        label: string | Record<string, string>;
+        path: string;
+    })[];
+    const hideSearchBarWithNoSearchContext: boolean;
+    const useAllContextsWithNoSearchContext: boolean;
+    const forceIgnoreNoIndex: boolean;
+    const askAi: AskAIConfig | undefined;
+}
+declare module "*/generated-constants.js" {
+    const removeDefaultStopWordFilter: string[];
+    const language: string[];
+    const searchIndexUrl: string;
+    const searchResultLimits: number;
+    const fuzzyMatchingDistance: number;
+    const __setLanguage: (value: string[]) => void;
+    const __setRemoveDefaultStopWordFilter: (value: string[]) => void;
+}
+declare module "@docusaurus/Head";

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+import { AskAIWidgetProps } from "open-ask-ai";
 export interface PluginOptions {
     /**
      * Whether to index docs.
@@ -193,4 +194,8 @@ export interface PluginOptions {
      * @default 1
      */
     fuzzyMatchingDistance?: number;
+    /**
+     * Configuration for Ask AI widget integration. When not set, the Ask AI feature will be disabled.
+     */
+    askAi?: AskAIWidgetProps;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.52.3",
+  "version": "0.54.0",
   "description": "An offline/local search plugin for Docusaurus v3",
   "repository": {
     "type": "git",
@@ -48,6 +48,9 @@
     "mark.js": "^8.11.1",
     "tslib": "^2.4.0"
   },
+  "optionalDependencies": {
+    "open-ask-ai": "^0.7.3"
+  },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "^3.0.0",
     "@docusaurus/theme-common": "^3.0.0",