@docusaurus/theme-search-algolia 3.10.2 → 4.0.0-canary-6809

package/lib/client/index.d.ts

@@ -8,4 +8,5 @@ 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

@@ -8,4 +8,5 @@ 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/opensearch.js

@@ -16,10 +16,11 @@ const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const eta_1 = require("eta");
 const utils_1 = require("@docusaurus/utils");
 const opensearch_1 = tslib_1.__importDefault(require("./templates/opensearch"));
-const getCompiledOpenSearchTemplate = lodash_1.default.memoize(() => (0, eta_1.compile)(opensearch_1.default.trim()));
+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 compiled(data, eta_1.defaultConfig);
+    return eta.render(compiled, data);
 }
 const OPEN_SEARCH_FILENAME = 'opensearch.xml';
 function shouldCreateOpenSearchFile({ context, }) {

package/lib/templates/opensearch.d.ts

@@ -4,5 +4,5 @@
  * 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";
+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/theme/SearchBar/index.js

@@ -11,15 +11,13 @@ import {useDocSearchKeyboardEvents} from '@docsearch/react/useDocSearchKeyboardE
 import Head from '@docusaurus/Head';
 import Link from '@docusaurus/Link';
 import {useHistory} from '@docusaurus/router';
-import {
-  isRegexpStringMatch,
-  useSearchLinkCreator,
-} from '@docusaurus/theme-common';
+import {isRegexpStringMatch} from '@docusaurus/theme-common';
 import {
   useAlgoliaContextualFacetFilters,
   useSearchResultUrlProcessor,
   useAlgoliaAskAi,
   mergeFacetFilters,
+  useSearchLinkCreator,
 } from '@docusaurus/theme-search-algolia/client';
 import Translate from '@docusaurus/Translate';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
@@ -84,8 +82,8 @@ function useTransformItems(props) {
 function useResultsFooterComponent({closeModal}) {
   return useMemo(
     () =>
-      ({state}) =>
-        <ResultsFooter state={state} onClose={closeModal} />,
+      // eslint-disable-next-line react/display-name
+      ({state}) => <ResultsFooter state={state} onClose={closeModal} />,
     [closeModal],
   );
 }
@@ -193,6 +191,8 @@ function DocSearch({externalUrlRegex, ...props}) {
 
       {isOpen &&
         DocSearchModal &&
+        // TODO fix this
+        // eslint-disable-next-line react-hooks/refs
         searchContainer.current &&
         createPortal(
           <DocSearchModal
@@ -212,6 +212,8 @@ function DocSearch({externalUrlRegex, ...props}) {
             searchParameters={searchParameters}
             {...extraAskAiProps}
           />,
+          // TODO fix this
+          // eslint-disable-next-line react-hooks/refs
           searchContainer.current,
         )}
     </>

package/lib/theme/SearchPage/index.js

@@ -18,13 +18,13 @@ import {
   PageMetadata,
   useEvent,
   usePluralForm,
-  useSearchQueryString,
 } from '@docusaurus/theme-common';
 import Translate, {translate} from '@docusaurus/Translate';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import {
   useAlgoliaThemeConfig,
   useSearchResultUrlProcessor,
+  useSearchQueryString,
 } from '@docusaurus/theme-search-algolia/client';
 import Layout from '@theme/Layout';
 import Heading from '@theme/Heading';
@@ -309,7 +309,7 @@ function SearchPageContent() {
     ExecutionEnvironment.canUseIntersectionObserver &&
       new IntersectionObserver(
         // TODO need to fix this React Compiler lint error
-        // eslint-disable-next-line react-compiler/react-compiler
+        // eslint-disable-next-line react-hooks/refs
         (entries) => {
           const {
             isIntersecting,
@@ -461,7 +461,6 @@ function SearchPageContent() {
                             key={index}
                             className="breadcrumbs__item"
                             // Developer provided the HTML, so assume it's safe.
-                            // eslint-disable-next-line react/no-danger
                             dangerouslySetInnerHTML={{__html: html}}
                           />
                         ))}
@@ -473,7 +472,6 @@ function SearchPageContent() {
                     <p
                       className={styles.searchResultItemSummary}
                       // Developer provided the HTML, so assume it's safe.
-                      // eslint-disable-next-line react/no-danger
                       dangerouslySetInnerHTML={{__html: summary}}
                     />
                   )}

package/lib/theme/SearchPage/styles.module.css

@@ -70,7 +70,7 @@
   font-style: italic;
 }
 
-@media only screen and (max-width: 996px) {
+@media only screen and (width <= 996px) {
   .searchQueryColumn {
     max-width: 60% !important;
   }
@@ -89,7 +89,7 @@
   }
 }
 
-@media screen and (max-width: 576px) {
+@media screen and (width <= 576px) {
   .searchQueryColumn {
     max-width: 100% !important;
   }

package/lib/validateThemeConfig.js

@@ -8,7 +8,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Schema = exports.DEFAULT_CONFIG = void 0;
 exports.validateThemeConfig = validateThemeConfig;
-const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const docSearchVersion_1 = require("./docSearchVersion");
 exports.DEFAULT_CONFIG = {
@@ -42,7 +41,7 @@ exports.Schema = utils_validation_1.Joi.object({
         replaceSearchResultPathname: utils_validation_1.Joi.object({
             from: utils_validation_1.Joi.custom((from) => {
                 if (typeof from === 'string') {
-                    return (0, utils_1.escapeRegexp)(from);
+                    return RegExp.escape(from);
                 }
                 else if (from instanceof RegExp) {
                     return from.source;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-search-algolia",
-  "version": "3.10.2",
+  "version": "4.0.0-canary-6809",
   "description": "Algolia search component for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": [
@@ -27,39 +27,41 @@
   },
   "license": "MIT",
   "scripts": {
-    "build": "tsc --build && node ../../admin/scripts/copyUntypedFiles.js && prettier --config ../../.prettierrc --write \"lib/theme/**/*.js\"",
+    "build": "tsc --build && node ../../admin/scripts/copyUntypedFiles.js && oxfmt \"lib/theme/**/*.js\"",
     "watch": "run-p -c copy:watch build:watch",
     "build:watch": "tsc --build --watch",
     "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch"
   },
   "dependencies": {
-    "@algolia/autocomplete-core": "^1.19.2",
-    "@docsearch/react": "^3.9.0 || ^4.3.2",
-    "@docusaurus/core": "3.10.2",
-    "@docusaurus/logger": "3.10.2",
-    "@docusaurus/plugin-content-docs": "3.10.2",
-    "@docusaurus/theme-common": "3.10.2",
-    "@docusaurus/theme-translations": "3.10.2",
-    "@docusaurus/utils": "3.10.2",
-    "@docusaurus/utils-validation": "3.10.2",
-    "algoliasearch": "^5.37.0",
-    "algoliasearch-helper": "^3.26.0",
-    "clsx": "^2.0.0",
-    "eta": "^2.2.0",
-    "fs-extra": "^11.1.1",
-    "lodash": "^4.17.21",
-    "tslib": "^2.6.0",
-    "utility-types": "^3.10.0"
+    "@algolia/autocomplete-core": "^1.19.10",
+    "@docsearch/react": "^4.7.0",
+    "@docusaurus/core": "4.0.0-canary-6809",
+    "@docusaurus/logger": "4.0.0-canary-6809",
+    "@docusaurus/plugin-content-docs": "4.0.0-canary-6809",
+    "@docusaurus/theme-classic": "4.0.0-canary-6809",
+    "@docusaurus/theme-common": "4.0.0-canary-6809",
+    "@docusaurus/theme-translations": "4.0.0-canary-6809",
+    "@docusaurus/utils": "4.0.0-canary-6809",
+    "@docusaurus/utils-validation": "4.0.0-canary-6809",
+    "algoliasearch": "^5.57.0",
+    "algoliasearch-helper": "^3.29.3",
+    "clsx": "^2.1.1",
+    "eta": "^4.6.0",
+    "fs-extra": "^11.4.0",
+    "lodash": "^4.18.1",
+    "tslib": "^2.8.1",
+    "utility-types": "^3.11.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.10.2"
+    "@docusaurus/module-type-aliases": "4.0.0-canary-6809",
+    "@docusaurus/types": "4.0.0-canary-6809"
   },
   "peerDependencies": {
-    "react": "^18.0.0 || ^19.0.0",
-    "react-dom": "^18.0.0 || ^19.0.0"
+    "react": "^19.3.0",
+    "react-dom": "^19.3.0"
   },
   "engines": {
-    "node": ">=20.0"
+    "node": ">=24.14"
   },
-  "gitHead": "f37f9035584917a97a260b91fc2842cba4f8b94f"
+  "gitHead": "db942b07f3529b5359bcae27ab3796cb07dec10e"
 }

package/src/client/index.ts

@@ -12,4 +12,5 @@ export {
 } from './useAlgoliaContextualFacetFilters';
 export {useSearchResultUrlProcessor} from './useSearchResultUrlProcessor';
 export {useAlgoliaAskAi} from './useAlgoliaAskAi';
+export {useSearchQueryString, useSearchLinkCreator} from './searchPage';
 export {mergeFacetFilters} from './utils';

package/src/client/searchPage.ts

@@ -0,0 +1,43 @@
+/**
+ * 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(): [string, (newValue: string) => void] {
+  return useQueryString(SEARCH_PARAM_QUERY);
+}
+
+/**
+ * Permits to create links to the search page with the appropriate query string
+ */
+export function useSearchLinkCreator(): (searchValue: string) => string {
+  const {
+    siteConfig: {baseUrl},
+  } = useDocusaurusContext();
+  const {
+    algolia: {searchPagePath},
+  } = useAlgoliaThemeConfig();
+
+  return useCallback(
+    function createSearchLink(searchValue: string) {
+      // Refer to https://github.com/facebook/docusaurus/pull/2838
+      // Note: if searchPagePath is falsy, useSearchPage() will not be called
+      return `${baseUrl}${
+        searchPagePath as string
+      }?${SEARCH_PARAM_QUERY}=${encodeURIComponent(searchValue)}`;
+    },
+    [baseUrl, searchPagePath],
+  );
+}

package/src/deps.d.ts

@@ -8,13 +8,3 @@
 declare module '@docsearch/react/modal';
 
 declare module '@docsearch/react/style';
-
-// TODO incompatible declaration file
-declare module 'eta' {
-  export const defaultConfig: object;
-
-  export function compile(
-    template: string,
-    options?: object,
-  ): (data: object, config: object) => string;
-}

package/src/opensearch.ts

@@ -8,15 +8,17 @@
 import path from 'path';
 import fs from 'fs-extra';
 import _ from 'lodash';
-import {defaultConfig, compile} from 'eta';
+import {Eta} from 'eta';
 import {normalizeUrl} from '@docusaurus/utils';
 import openSearchTemplate from './templates/opensearch';
 
 import type {HtmlTags, LoadContext} from '@docusaurus/types';
 import type {ThemeConfig} from '@docusaurus/theme-search-algolia';
 
+const eta = new Eta();
+
 const getCompiledOpenSearchTemplate = _.memoize(() =>
-  compile(openSearchTemplate.trim()),
+  eta.compile(openSearchTemplate.trim()),
 );
 
 function renderOpenSearchTemplate(data: {
@@ -26,7 +28,7 @@ function renderOpenSearchTemplate(data: {
   faviconUrl: string | null;
 }) {
   const compiled = getCompiledOpenSearchTemplate();
-  return compiled(data, defaultConfig);
+  return eta.render(compiled, data);
 }
 
 const OPEN_SEARCH_FILENAME = 'opensearch.xml';

package/src/theme/SearchBar/index.tsx

@@ -18,15 +18,13 @@ import {useDocSearchKeyboardEvents} from '@docsearch/react/useDocSearchKeyboardE
 import Head from '@docusaurus/Head';
 import Link from '@docusaurus/Link';
 import {useHistory} from '@docusaurus/router';
-import {
-  isRegexpStringMatch,
-  useSearchLinkCreator,
-} from '@docusaurus/theme-common';
+import {isRegexpStringMatch} from '@docusaurus/theme-common';
 import {
   useAlgoliaContextualFacetFilters,
   useSearchResultUrlProcessor,
   useAlgoliaAskAi,
   mergeFacetFilters,
+  useSearchLinkCreator,
 } from '@docusaurus/theme-search-algolia/client';
 import Translate from '@docusaurus/Translate';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
@@ -140,8 +138,8 @@ function useResultsFooterComponent({
 }): DocSearchProps['resultsFooterComponent'] {
   return useMemo(
     () =>
-      ({state}) =>
-        <ResultsFooter state={state} onClose={closeModal} />,
+      // eslint-disable-next-line react/display-name
+      ({state}) => <ResultsFooter state={state} onClose={closeModal} />,
     [closeModal],
   );
 }
@@ -287,6 +285,8 @@ function DocSearch({externalUrlRegex, ...props}: DocSearchV4Props) {
 
       {isOpen &&
         DocSearchModal &&
+        // TODO fix this
+        // eslint-disable-next-line react-hooks/refs
         searchContainer.current &&
         createPortal(
           <DocSearchModal
@@ -306,6 +306,9 @@ function DocSearch({externalUrlRegex, ...props}: DocSearchV4Props) {
             searchParameters={searchParameters}
             {...extraAskAiProps}
           />,
+
+          // TODO fix this
+          // eslint-disable-next-line react-hooks/refs
           searchContainer.current,
         )}
     </>

package/src/theme/SearchPage/index.tsx

@@ -28,13 +28,13 @@ import {
   PageMetadata,
   useEvent,
   usePluralForm,
-  useSearchQueryString,
 } from '@docusaurus/theme-common';
 import Translate, {translate} from '@docusaurus/Translate';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import {
   useAlgoliaThemeConfig,
   useSearchResultUrlProcessor,
+  useSearchQueryString,
 } from '@docusaurus/theme-search-algolia/client';
 import Layout from '@theme/Layout';
 import Heading from '@theme/Heading';
@@ -372,7 +372,7 @@ function SearchPageContent(): ReactNode {
     ExecutionEnvironment.canUseIntersectionObserver &&
       new IntersectionObserver(
         // TODO need to fix this React Compiler lint error
-        // eslint-disable-next-line react-compiler/react-compiler
+        // eslint-disable-next-line react-hooks/refs
         (entries) => {
           const {
             isIntersecting,
@@ -536,7 +536,6 @@ function SearchPageContent(): ReactNode {
                             key={index}
                             className="breadcrumbs__item"
                             // Developer provided the HTML, so assume it's safe.
-                            // eslint-disable-next-line react/no-danger
                             dangerouslySetInnerHTML={{__html: html}}
                           />
                         ))}
@@ -548,7 +547,6 @@ function SearchPageContent(): ReactNode {
                     <p
                       className={styles.searchResultItemSummary}
                       // Developer provided the HTML, so assume it's safe.
-                      // eslint-disable-next-line react/no-danger
                       dangerouslySetInnerHTML={{__html: summary}}
                     />
                   )}

package/src/theme/SearchPage/styles.module.css

@@ -70,7 +70,7 @@
   font-style: italic;
 }
 
-@media only screen and (max-width: 996px) {
+@media only screen and (width <= 996px) {
   .searchQueryColumn {
     max-width: 60% !important;
   }
@@ -89,7 +89,7 @@
   }
 }
 
-@media screen and (max-width: 576px) {
+@media screen and (width <= 576px) {
   .searchQueryColumn {
     max-width: 100% !important;
   }

package/src/validateThemeConfig.ts

@@ -5,7 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {escapeRegexp} from '@docusaurus/utils';
 import {Joi} from '@docusaurus/utils-validation';
 import {docSearchV3} from './docSearchVersion';
 import type {ThemeConfigValidationContext} from '@docusaurus/types';
@@ -50,7 +49,7 @@ export const Schema = Joi.object<ThemeConfig>({
     replaceSearchResultPathname: Joi.object({
       from: Joi.custom((from) => {
         if (typeof from === 'string') {
-          return escapeRegexp(from);
+          return RegExp.escape(from);
         } else if (from instanceof RegExp) {
           return from.source;
         }