@azerion/bunosaurus-theme-search-algolia 0.0.0-stage → 4.0.0

package/README.md

@@ -1,3 +1,7 @@
-# Temporary Holding Version
+# `@docusaurus/theme-search-algolia`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Algolia search component for Docusaurus.
+
+## Usage
+
+See [`@docusaurus/theme-search-algolia` documentation](https://docusaurus.io/docs/api/themes/@docusaurus/theme-search-algolia).

package/lib/client/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export { useAlgoliaThemeConfig } from './useAlgoliaThemeConfig';
+export { useAlgoliaContextualFacetFilters, useAlgoliaContextualFacetFiltersIfEnabled, } from './useAlgoliaContextualFacetFilters';
+export { useSearchResultUrlProcessor } from './useSearchResultUrlProcessor';
+export { useAlgoliaAskAi } from './useAlgoliaAskAi';
+export { useSearchQueryString, useSearchLinkCreator } from './searchPage';
+export { mergeFacetFilters } from './utils';

package/lib/client/index.js

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export { useAlgoliaThemeConfig } from './useAlgoliaThemeConfig';
+export { useAlgoliaContextualFacetFilters, useAlgoliaContextualFacetFiltersIfEnabled, } from './useAlgoliaContextualFacetFilters';
+export { useSearchResultUrlProcessor } from './useSearchResultUrlProcessor';
+export { useAlgoliaAskAi } from './useAlgoliaAskAi';
+export { useSearchQueryString, useSearchLinkCreator } from './searchPage';
+export { mergeFacetFilters } from './utils';

package/lib/client/searchPage.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * Permits to read/write the current search query string
+ */
+export declare function useSearchQueryString(): [string, (newValue: string) => void];
+/**
+ * Permits to create links to the search page with the appropriate query string
+ */
+export declare function useSearchLinkCreator(): (searchValue: string) => string;

package/lib/client/searchPage.js

@@ -0,0 +1,29 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { useCallback } from 'react';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import { useQueryString } from '@docusaurus/theme-common';
+import { useAlgoliaThemeConfig } from './useAlgoliaThemeConfig';
+const SEARCH_PARAM_QUERY = 'q';
+/**
+ * Permits to read/write the current search query string
+ */
+export function useSearchQueryString() {
+    return useQueryString(SEARCH_PARAM_QUERY);
+}
+/**
+ * Permits to create links to the search page with the appropriate query string
+ */
+export function useSearchLinkCreator() {
+    const { siteConfig: { baseUrl }, } = useDocusaurusContext();
+    const { algolia: { searchPagePath }, } = useAlgoliaThemeConfig();
+    return useCallback(function createSearchLink(searchValue) {
+        // Refer to https://github.com/facebook/docusaurus/pull/2838
+        // Note: if searchPagePath is falsy, useSearchPage() will not be called
+        return `${baseUrl}${searchPagePath}?${SEARCH_PARAM_QUERY}=${encodeURIComponent(searchValue)}`;
+    }, [baseUrl, searchPagePath]);
+}

package/lib/client/useAlgoliaAskAi.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { AskAiConfig } from '@docusaurus/theme-search-algolia';
+import type { DocSearchModalProps, DocSearchTranslations } from '@docsearch/react';
+interface DocSearchV4PropsLite {
+    indexName: string;
+    apiKey: string;
+    appId: string;
+    placeholder?: string;
+    translations?: DocSearchTranslations;
+    searchParameters?: DocSearchModalProps['searchParameters'];
+    askAi?: AskAiConfig;
+}
+type UseAskAiResult = {
+    canHandleAskAi: boolean;
+    isAskAiActive: boolean;
+    currentPlaceholder: string | undefined;
+    onAskAiToggle: (active: boolean) => void;
+    askAi?: AskAiConfig;
+    extraAskAiProps: Partial<DocSearchModalProps> & {
+        askAi?: AskAiConfig;
+        canHandleAskAi?: boolean;
+        isAskAiActive?: boolean;
+        onAskAiToggle?: (active: boolean) => void;
+    };
+};
+export declare function useAlgoliaAskAi(props: DocSearchV4PropsLite): UseAskAiResult;
+export {};

package/lib/client/useAlgoliaAskAi.js

@@ -0,0 +1,59 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { useCallback, useMemo, useState } from 'react';
+import { version as docsearchVersion } from '@docsearch/react/version';
+import translations from '@theme/SearchTranslations';
+import { useAlgoliaContextualFacetFiltersIfEnabled } from './useAlgoliaContextualFacetFilters';
+import { mergeFacetFilters } from './utils';
+const isV4 = docsearchVersion.startsWith('4.');
+// We need to apply contextualSearch facetFilters to AskAI filters
+// This can't be done at config normalization time because contextual filters
+// can only be determined at runtime
+function applyAskAiContextualSearch(askAi, contextualSearchFilters) {
+    if (!askAi) {
+        return undefined;
+    }
+    if (!contextualSearchFilters) {
+        return askAi;
+    }
+    const askAiFacetFilters = askAi.searchParameters?.facetFilters;
+    return {
+        ...askAi,
+        searchParameters: {
+            ...askAi.searchParameters,
+            facetFilters: mergeFacetFilters(askAiFacetFilters, contextualSearchFilters),
+        },
+    };
+}
+export function useAlgoliaAskAi(props) {
+    const [isAskAiActive, setIsAskAiActive] = useState(false);
+    const contextualSearchFilters = useAlgoliaContextualFacetFiltersIfEnabled();
+    const askAi = useMemo(() => {
+        return applyAskAiContextualSearch(props.askAi, contextualSearchFilters);
+    }, [props.askAi, contextualSearchFilters]);
+    const canHandleAskAi = Boolean(askAi);
+    const currentPlaceholder = isAskAiActive && isV4
+        ? translations.modal?.searchBox?.placeholderTextAskAi
+        : translations.modal?.searchBox?.placeholderText || props?.placeholder;
+    const onAskAiToggle = useCallback((askAiToggle) => {
+        setIsAskAiActive(askAiToggle);
+    }, []);
+    const extraAskAiProps = {
+        askAi: askAi,
+        canHandleAskAi,
+        isAskAiActive,
+        onAskAiToggle,
+    };
+    return {
+        canHandleAskAi,
+        isAskAiActive,
+        currentPlaceholder,
+        onAskAiToggle,
+        askAi,
+        extraAskAiProps,
+    };
+}

package/lib/client/useAlgoliaContextualFacetFilters.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { FacetFilters } from 'algoliasearch/lite';
+export declare function useAlgoliaContextualFacetFilters(): FacetFilters;
+export declare function useAlgoliaContextualFacetFiltersIfEnabled(): FacetFilters | undefined;

package/lib/client/useAlgoliaContextualFacetFilters.js

@@ -0,0 +1,34 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { DEFAULT_SEARCH_TAG } from '@docusaurus/theme-common/internal';
+import { useDocsContextualSearchTags } from '@docusaurus/plugin-content-docs/client';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import { useAlgoliaThemeConfig } from './useAlgoliaThemeConfig';
+function useSearchTags() {
+    // only docs have custom search tags per version
+    const docsTags = useDocsContextualSearchTags();
+    return [DEFAULT_SEARCH_TAG, ...docsTags];
+}
+// Translate search-engine agnostic search tags to Algolia search filters
+export function useAlgoliaContextualFacetFilters() {
+    const locale = useDocusaurusContext().i18n.currentLocale;
+    const tags = useSearchTags();
+    // Seems safe to convert locale->language, see AlgoliaSearchMetadata comment
+    const languageFilter = `language:${locale}`;
+    const tagsFilter = tags.map((tag) => `docusaurus_tag:${tag}`);
+    return [languageFilter, tagsFilter];
+}
+export function useAlgoliaContextualFacetFiltersIfEnabled() {
+    const { algolia: { contextualSearch }, } = useAlgoliaThemeConfig();
+    const facetFilters = useAlgoliaContextualFacetFilters();
+    if (contextualSearch) {
+        return facetFilters;
+    }
+    else {
+        return undefined;
+    }
+}

package/lib/client/useAlgoliaThemeConfig.d.ts

@@ -0,0 +1,2 @@
+import type { ThemeConfig } from '@docusaurus/theme-search-algolia';
+export declare function useAlgoliaThemeConfig(): ThemeConfig;

package/lib/client/useAlgoliaThemeConfig.js

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+export function useAlgoliaThemeConfig() {
+    const { siteConfig: { themeConfig }, } = useDocusaurusContext();
+    return themeConfig;
+}

package/lib/client/useSearchResultUrlProcessor.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * Process the search result url from Algolia to its final form, ready to be
+ * navigated to or used as a link
+ */
+export declare function useSearchResultUrlProcessor(): (url: string) => string;

package/lib/client/useSearchResultUrlProcessor.js

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { useCallback } from 'react';
+import { isRegexpStringMatch } from '@docusaurus/theme-common';
+import { useBaseUrlUtils } from '@docusaurus/useBaseUrl';
+import { useAlgoliaThemeConfig } from './useAlgoliaThemeConfig';
+function replacePathname(pathname, replaceSearchResultPathname) {
+    return replaceSearchResultPathname
+        ? pathname.replaceAll(new RegExp(replaceSearchResultPathname.from, 'g'), replaceSearchResultPathname.to)
+        : pathname;
+}
+/**
+ * Process the search result url from Algolia to its final form, ready to be
+ * navigated to or used as a link
+ */
+export function useSearchResultUrlProcessor() {
+    const { withBaseUrl } = useBaseUrlUtils();
+    const { algolia: { externalUrlRegex, replaceSearchResultPathname }, } = useAlgoliaThemeConfig();
+    return useCallback((url) => {
+        const parsedURL = new URL(url);
+        // Algolia contains an external domain => navigate to URL
+        if (isRegexpStringMatch(externalUrlRegex, parsedURL.href)) {
+            return url;
+        }
+        // Otherwise => transform to relative URL for SPA navigation
+        const relativeUrl = `${parsedURL.pathname}${parsedURL.search}${parsedURL.hash}`;
+        return withBaseUrl(replacePathname(relativeUrl, replaceSearchResultPathname));
+    }, [withBaseUrl, externalUrlRegex, replaceSearchResultPathname]);
+}

package/lib/client/utils.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { FacetFilters } from 'algoliasearch/lite';
+export declare function mergeFacetFilters(f1: FacetFilters, f2: FacetFilters): FacetFilters;
+export declare function mergeFacetFilters(f1: FacetFilters | undefined, f2: FacetFilters | undefined): FacetFilters | undefined;

package/lib/client/utils.js

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export function mergeFacetFilters(f1, f2) {
+    if (f1 === undefined) {
+        return f2;
+    }
+    if (f2 === undefined) {
+        return f1;
+    }
+    const normalize = (f) => typeof f === 'string' ? [f] : f;
+    // Historical behavior: we flatten everything
+    // TODO I'm pretty sure this is incorrect
+    //  see https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/?client=javascript
+    //  Note: Algolia is working to provide a reliable facet merging strategy
+    //  see https://github.com/facebook/docusaurus/pull/11327#issuecomment-3284742923
+    return [...normalize(f1), ...normalize(f2)];
+}

package/lib/docSearchVersion.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export declare const docSearchV3: boolean;

package/lib/docSearchVersion.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.docSearchV3 = void 0;
+const react_1 = require("@docsearch/react");
+// TODO Docusaurus v4: upgrade to DocSearch v4
+//  drop v3 compat, remove this file?
+exports.docSearchV3 = react_1.version.startsWith('3.');

package/lib/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { LoadContext, Plugin } from '@docusaurus/types';
+export default function themeSearchAlgolia(context: LoadContext): Plugin<void>;
+export { validateThemeConfig } from './validateThemeConfig';

package/lib/index.js

@@ -0,0 +1,74 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateThemeConfig = void 0;
+exports.default = themeSearchAlgolia;
+const utils_1 = require("@docusaurus/utils");
+const theme_translations_1 = require("@docusaurus/theme-translations");
+const opensearch_1 = require("./opensearch");
+const docSearchVersion_1 = require("./docSearchVersion");
+function themeSearchAlgolia(context) {
+    const { baseUrl, siteConfig: { themeConfig }, i18n: { currentLocale }, } = context;
+    const { algolia: { searchPagePath }, } = themeConfig;
+    return {
+        name: 'docusaurus-theme-search-algolia',
+        getThemePath() {
+            return '../lib/theme';
+        },
+        getTypeScriptThemePath() {
+            return '../src/theme';
+        },
+        getDefaultCodeTranslationMessages() {
+            return (0, theme_translations_1.readDefaultCodeTranslationMessages)({
+                locale: currentLocale,
+                name: 'theme-search-algolia',
+            });
+        },
+        contentLoaded({ actions: { addRoute } }) {
+            if (searchPagePath) {
+                addRoute({
+                    path: (0, utils_1.normalizeUrl)([baseUrl, searchPagePath]),
+                    component: '@theme/SearchPage',
+                    exact: true,
+                });
+            }
+        },
+        async postBuild() {
+            if ((0, opensearch_1.shouldCreateOpenSearchFile)({ context })) {
+                await (0, opensearch_1.createOpenSearchFile)({ context });
+            }
+        },
+        injectHtmlTags() {
+            if ((0, opensearch_1.shouldCreateOpenSearchFile)({ context })) {
+                return { headTags: (0, opensearch_1.createOpenSearchHeadTags)({ context }) };
+            }
+            return {};
+        },
+        configureWebpack() {
+            // TODO Docusaurus v4: remove after dropping DocSearch v3 support
+            if (docSearchVersion_1.docSearchV3) {
+                // These aliases ensure DocSearch v3 imports are compatible with
+                // the newly added DocSearch v4 entry points
+                // See https://github.com/algolia/docsearch/pull/2764
+                const docSearchV3Entry = require.resolve('@docsearch/react');
+                return {
+                    resolve: {
+                        alias: {
+                            '@docsearch/react/version': docSearchV3Entry,
+                            '@docsearch/react/useDocSearchKeyboardEvents': docSearchV3Entry,
+                            '@docsearch/react/useTheme': docSearchV3Entry,
+                        },
+                    },
+                };
+            }
+            return undefined;
+        },
+    };
+}
+var validateThemeConfig_1 = require("./validateThemeConfig");
+Object.defineProperty(exports, "validateThemeConfig", { enumerable: true, get: function () { return validateThemeConfig_1.validateThemeConfig; } });

package/lib/opensearch.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { HtmlTags, LoadContext } from '@docusaurus/types';
+export declare function shouldCreateOpenSearchFile({ context, }: {
+    context: LoadContext;
+}): boolean;
+export declare function createOpenSearchFile({ context, }: {
+    context: LoadContext;
+}): Promise<void>;
+export declare function createOpenSearchHeadTags({ context, }: {
+    context: LoadContext;
+}): HtmlTags;

package/lib/opensearch.js

@@ -0,0 +1,66 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldCreateOpenSearchFile = shouldCreateOpenSearchFile;
+exports.createOpenSearchFile = createOpenSearchFile;
+exports.createOpenSearchHeadTags = createOpenSearchHeadTags;
+const tslib_1 = require("tslib");
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const eta_1 = require("eta");
+const utils_1 = require("@docusaurus/utils");
+const fs_1 = require("@docusaurus/fs");
+const opensearch_1 = tslib_1.__importDefault(require("./templates/opensearch"));
+const eta = new eta_1.Eta();
+const getCompiledOpenSearchTemplate = lodash_1.default.memoize(() => eta.compile(opensearch_1.default.trim()));
+function renderOpenSearchTemplate(data) {
+    const compiled = getCompiledOpenSearchTemplate();
+    return eta.render(compiled, data);
+}
+const OPEN_SEARCH_FILENAME = 'opensearch.xml';
+function shouldCreateOpenSearchFile({ context, }) {
+    const { siteConfig: { themeConfig, future: { experimental_router: router }, }, } = context;
+    const { algolia: { searchPagePath }, } = themeConfig;
+    return !!searchPagePath && router !== 'hash';
+}
+function createOpenSearchFileContent({ context, searchPagePath, }) {
+    const { baseUrl, siteConfig: { title, url, favicon }, } = context;
+    const siteUrl = (0, utils_1.normalizeUrl)([url, baseUrl]);
+    return renderOpenSearchTemplate({
+        title,
+        siteUrl,
+        searchUrl: (0, utils_1.normalizeUrl)([siteUrl, searchPagePath]),
+        faviconUrl: favicon ? (0, utils_1.normalizeUrl)([siteUrl, favicon]) : null,
+    });
+}
+async function createOpenSearchFile({ context, }) {
+    const { outDir, siteConfig: { themeConfig }, } = context;
+    const { algolia: { searchPagePath }, } = themeConfig;
+    if (!searchPagePath) {
+        throw new Error('no searchPagePath provided in themeConfig.algolia');
+    }
+    const fileContent = createOpenSearchFileContent({ context, searchPagePath });
+    try {
+        await fs_1.fs.writeFile(node_path_1.default.join(outDir, OPEN_SEARCH_FILENAME), fileContent);
+    }
+    catch (err) {
+        throw new Error('Generating OpenSearch file failed.', { cause: err });
+    }
+}
+function createOpenSearchHeadTags({ context, }) {
+    const { baseUrl, siteConfig: { title }, } = context;
+    return {
+        tagName: 'link',
+        attributes: {
+            rel: 'search',
+            type: 'application/opensearchdescription+xml',
+            title,
+            href: (0, utils_1.normalizeUrl)([baseUrl, OPEN_SEARCH_FILENAME]),
+        },
+    };
+}

package/lib/templates/opensearch.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+declare const _default = "\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OpenSearchDescription xmlns=\"http://a9.com/-/spec/opensearch/1.1/\"\n                       xmlns:moz=\"http://www.mozilla.org/2006/browser/search/\">\n  <ShortName><%= it.title %></ShortName>\n  <Description>Search <%= it.title %></Description>\n  <InputEncoding>UTF-8</InputEncoding>\n  <% if (it.faviconUrl) { _%>\n    <Image width=\"16\" height=\"16\" type=\"image/x-icon\"><%= it.faviconUrl %></Image>\n  <% } _%>\n  <Url type=\"text/html\" method=\"get\" template=\"<%= it.searchUrl %>?q={searchTerms}\"/>\n  <Url type=\"application/opensearchdescription+xml\" rel=\"self\" template=\"<%= it.siteUrl %>opensearch.xml\" />\n  <moz:SearchForm><%= it.siteUrl %></moz:SearchForm>\n</OpenSearchDescription>\n";
+export default _default;

package/lib/templates/opensearch.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = `
+<?xml version="1.0" encoding="UTF-8"?>
+<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"
+                       xmlns:moz="http://www.mozilla.org/2006/browser/search/">
+  <ShortName><%= it.title %></ShortName>
+  <Description>Search <%= it.title %></Description>
+  <InputEncoding>UTF-8</InputEncoding>
+  <% if (it.faviconUrl) { _%>
+    <Image width="16" height="16" type="image/x-icon"><%= it.faviconUrl %></Image>
+  <% } _%>
+  <Url type="text/html" method="get" template="<%= it.searchUrl %>?q={searchTerms}"/>
+  <Url type="application/opensearchdescription+xml" rel="self" template="<%= it.siteUrl %>opensearch.xml" />
+  <moz:SearchForm><%= it.siteUrl %></moz:SearchForm>
+</OpenSearchDescription>
+`;

package/lib/theme/SearchBar/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { type ReactNode } from 'react';
+import type { DocSearchModalProps, DocSearchTranslations } from '@docsearch/react';
+import type { ThemeConfigAlgolia } from '@docusaurus/theme-search-algolia';
+type DocSearchProps = Omit<DocSearchModalProps, 'onClose' | 'initialScrollY'> & {
+    contextualSearch?: string;
+    externalUrlRegex?: string;
+    searchPagePath: boolean | string;
+    askAi?: Exclude<(DocSearchModalProps & {
+        askAi: unknown;
+    })['askAi'], string | undefined>;
+};
+interface DocSearchV4Props extends Omit<DocSearchProps, 'askAi'> {
+    indexName: string;
+    askAi?: ThemeConfigAlgolia['askAi'];
+    translations?: DocSearchTranslations;
+}
+export default function SearchBar(props: Partial<DocSearchV4Props>): ReactNode;
+export {};