@docusaurus/theme-search-algolia 2.0.0-beta.13 → 2.0.0-beta.15

package/lib/{theme/hooks/useSearchQuery.d.ts → client/index.d.ts}

@@ -4,6 +4,4 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { SearchQuery } from '@theme/hooks/useSearchQuery';
-declare function useSearchQuery(): SearchQuery;
-export default useSearchQuery;
+export { useAlgoliaContextualFacetFilters } from './useAlgoliaContextualFacetFilters';

package/lib/client/index.js

@@ -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 { useAlgoliaContextualFacetFilters } from './useAlgoliaContextualFacetFilters';

package/lib/client/useAlgoliaContextualFacetFilters.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 function useAlgoliaContextualFacetFilters(): [string, string[]];

package/lib/{theme/hooks → client}/useAlgoliaContextualFacetFilters.js

@@ -6,7 +6,7 @@
  */
 import { useContextualSearchFilters } from '@docusaurus/theme-common';
 // Translate search-engine agnostic search filters to Algolia search filters
-export default function useAlgoliaContextualFacetFilters() {
+export function useAlgoliaContextualFacetFilters() {
     const { locale, tags } = useContextualSearchFilters();
     // seems safe to convert locale->language, see AlgoliaSearchMetadata comment
     const languageFilter = `language:${locale}`;

package/lib/index.d.ts

@@ -4,8 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { DocusaurusContext, Plugin } from '@docusaurus/types';
-export default function theme(context: DocusaurusContext & {
-    baseUrl: string;
-}): Plugin<void>;
+import type { LoadContext, Plugin } from '@docusaurus/types';
+export default function themeSearchAlgolia(context: LoadContext): Plugin<void>;
 export { validateThemeConfig } from './validateThemeConfig';

package/lib/index.js

@@ -13,6 +13,7 @@ const fs_1 = (0, tslib_1.__importDefault)(require("fs"));
 const eta_1 = require("eta");
 const utils_1 = require("@docusaurus/utils");
 const theme_translations_1 = require("@docusaurus/theme-translations");
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 const opensearch_1 = (0, tslib_1.__importDefault)(require("./templates/opensearch"));
 const lodash_1 = require("lodash");
 const getCompiledOpenSearchTemplate = (0, lodash_1.memoize)(() => (0, eta_1.compile)(opensearch_1.default.trim()));
@@ -21,16 +22,10 @@ function renderOpenSearchTemplate(data) {
     return compiled(data, eta_1.defaultConfig);
 }
 const OPEN_SEARCH_FILENAME = 'opensearch.xml';
-function theme(context) {
+function themeSearchAlgolia(context) {
     const { baseUrl, siteConfig: { title, url, favicon }, i18n: { currentLocale }, } = context;
-    const pageComponent = './theme/SearchPage/index.js';
-    const pagePath = (0, utils_1.getSwizzledComponent)(pageComponent) ||
-        path_1.default.resolve(__dirname, pageComponent);
     return {
         name: 'docusaurus-theme-search-algolia',
-        getPathsToWatch() {
-            return [pagePath];
-        },
         getThemePath() {
             return path_1.default.resolve(__dirname, './theme');
         },
@@ -46,7 +41,7 @@ function theme(context) {
         async contentLoaded({ actions: { addRoute } }) {
             addRoute({
                 path: (0, utils_1.normalizeUrl)([baseUrl, 'search']),
-                component: pagePath,
+                component: '@theme/SearchPage',
                 exact: true,
             });
         },
@@ -58,9 +53,9 @@ function theme(context) {
                     favicon: favicon ? (0, utils_1.normalizeUrl)([url, baseUrl, favicon]) : null,
                 }));
             }
-            catch (err) {
-                console.error(err);
-                throw new Error(`Generating OpenSearch file failed: ${err}`);
+            catch (e) {
+                logger_1.default.error('Generating OpenSearch file failed.');
+                throw e;
             }
         },
         injectHtmlTags() {
@@ -80,6 +75,6 @@ function theme(context) {
         },
     };
 }
-exports.default = theme;
+exports.default = themeSearchAlgolia;
 var validateThemeConfig_1 = require("./validateThemeConfig");
 Object.defineProperty(exports, "validateThemeConfig", { enumerable: true, get: function () { return validateThemeConfig_1.validateThemeConfig; } });

package/lib/theme/SearchBar/index.js

@@ -12,10 +12,9 @@ import { useHistory } from '@docusaurus/router';
 import { useBaseUrlUtils } from '@docusaurus/useBaseUrl';
 import Link from '@docusaurus/Link';
 import Head from '@docusaurus/Head';
-import useSearchQuery from '@theme/hooks/useSearchQuery';
-import { isRegexpStringMatch } from '@docusaurus/theme-common';
+import { isRegexpStringMatch, useSearchPage } from '@docusaurus/theme-common';
 import { DocSearchButton, useDocSearchKeyboardEvents } from '@docsearch/react';
-import useAlgoliaContextualFacetFilters from '@theme/hooks/useAlgoliaContextualFacetFilters';
+import { useAlgoliaContextualFacetFilters } from '@docusaurus/theme-search-algolia/client';
 import { translate } from '@docusaurus/Translate';
 import styles from './styles.module.css';
 let DocSearchModal = null;
@@ -23,11 +22,15 @@ function Hit({ hit, children, }) {
     return <Link to={hit.url}>{children}</Link>;
 }
 function ResultsFooter({ state, onClose }) {
-    const { generateSearchPageLink } = useSearchQuery();
+    const { generateSearchPageLink } = useSearchPage();
     return (<Link to={generateSearchPageLink(state.query)} onClick={onClose}>
       See all {state.context.nbHits} results
     </Link>);
 }
+function mergeFacetFilters(f1, f2) {
+    const normalize = (f) => f instanceof Array ? f : [f];
+    return [...normalize(f1), ...normalize(f2)];
+}
 function DocSearch({ contextualSearch, externalUrlRegex, ...props }) {
     var _a, _b;
     const { siteMetadata } = useDocusaurusContext();
@@ -35,7 +38,7 @@ function DocSearch({ contextualSearch, externalUrlRegex, ...props }) {
     const configFacetFilters = (_b = (_a = props.searchParameters) === null || _a === void 0 ? void 0 : _a.facetFilters) !== null && _b !== void 0 ? _b : [];
     const facetFilters = contextualSearch
         ? // Merge contextual search filters with config filters
-            [...contextualSearchFacetFilters, ...configFacetFilters]
+            mergeFacetFilters(contextualSearchFacetFilters, configFacetFilters)
         : // ... or use config facetFilters
             configFacetFilters;
     // we let user override default searchParameters if he wants to
@@ -105,9 +108,9 @@ function DocSearch({ contextualSearch, externalUrlRegex, ...props }) {
             url: withBaseUrl(`${url.pathname}${url.hash}`),
         };
     })).current;
-    const resultsFooterComponent = useMemo(
+    const resultsFooterComponent = useMemo(() => 
     // eslint-disable-next-line react/no-unstable-nested-components
-    () => (footerProps) => <ResultsFooter {...footerProps} onClose={onClose}/>, [onClose]);
+    (footerProps) => <ResultsFooter {...footerProps} onClose={onClose}/>, [onClose]);
     const transformSearchClient = useCallback((searchClient) => {
         searchClient.addAlgoliaAgent('docusaurus', siteMetadata.docusaurusVersion);
         return searchClient;

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

@@ -4,7 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+/// <reference types="@docusaurus/theme-classic" />
 /// <reference types="react" />
-import type { SearchMetadataProps } from '@theme/SearchMetadata';
-declare function SearchMetadata({ locale, version, tag, }: SearchMetadataProps): JSX.Element;
+import type { Props } from '@theme/SearchMetadata';
+declare function SearchMetadata({ locale, version, tag }: Props): JSX.Element;
 export default SearchMetadata;

package/lib/theme/SearchMetadata/index.js

@@ -6,8 +6,8 @@
  */
 import React from 'react';
 import Head from '@docusaurus/Head';
-// Override default/agnostic SearchMetas to use Algolia-specific metadata
-function SearchMetadata({ locale, version, tag, }) {
+// Override default/agnostic SearchMetadata to use Algolia-specific metadata
+function SearchMetadata({ locale, version, tag }) {
     // Seems safe to consider here the locale is the language,
     // as the existing docsearch:language filter is afaik a regular string-based filter
     const language = locale;

package/lib/theme/SearchPage/index.js

@@ -13,10 +13,9 @@ import clsx from 'clsx';
 import Head from '@docusaurus/Head';
 import Link from '@docusaurus/Link';
 import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
-import { useTitleFormatter, usePluralForm, isRegexpStringMatch, useDynamicCallback, } from '@docusaurus/theme-common';
+import { useTitleFormatter, usePluralForm, isRegexpStringMatch, useDynamicCallback, useSearchPage, } from '@docusaurus/theme-common';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import { useAllDocsData } from '@theme/hooks/useDocs';
-import useSearchQuery from '@theme/hooks/useSearchQuery';
+import { useAllDocsData } from '@docusaurus/plugin-content-docs/client';
 import Layout from '@theme/Layout';
 import Translate, { translate } from '@docusaurus/Translate';
 import styles from './styles.module.css';
@@ -67,7 +66,7 @@ function SearchPage() {
     algolia: { appId, apiKey, indexName, externalUrlRegex }, }, }, i18n: { currentLocale }, } = useDocusaurusContext();
     const documentsFoundPlural = useDocumentsFoundPlural();
     const docsSearchVersionsHelpers = useDocsSearchVersionsHelpers();
-    const { searchQuery, setSearchQuery } = useSearchQuery();
+    const { searchQuery, setSearchQuery } = useSearchPage();
     const initialSearchResultState = {
         items: [],
         query: null,

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

@@ -58,7 +58,7 @@
 }
 
 .searchResultItemSummary {
-  margin: 0.5rem 0 0 0;
+  margin: 0.5rem 0 0;
   font-style: italic;
 }
 
@@ -98,11 +98,11 @@
   border: 0.4em solid #eee;
   border-top-color: var(--ifm-color-primary);
   border-radius: 50%;
-  animation: loadingspin 1s linear infinite;
+  animation: loading-spin 1s linear infinite;
   margin: 0 auto;
 }
 
-@keyframes loadingspin {
+@keyframes loading-spin {
   100% {
     transform: rotate(360deg);
   }
@@ -114,6 +114,6 @@
 
 :global(.search-result-match) {
   color: var(--docsearch-hit-color);
-  background: rgba(255, 215, 142, 0.25);
+  background: rgb(255 215 142 / 25%);
   padding: 0.09em 0;
 }

package/lib/validateThemeConfig.d.ts

@@ -6,6 +6,11 @@
  */
 import { Joi } from '@docusaurus/utils-validation';
 import type { ThemeConfig, Validate, ValidationResult } from '@docusaurus/types';
+export declare const DEFAULT_CONFIG: {
+    contextualSearch: boolean;
+    appId: string;
+    searchParameters: {};
+};
 export declare const Schema: Joi.ObjectSchema<any>;
 export declare function validateThemeConfig({ validate, themeConfig, }: {
     validate: Validate<ThemeConfig>;

package/lib/validateThemeConfig.js

@@ -6,27 +6,28 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateThemeConfig = exports.Schema = void 0;
+exports.validateThemeConfig = exports.Schema = exports.DEFAULT_CONFIG = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
-const DEFAULT_CONFIG = {
-    contextualSearch: false,
+exports.DEFAULT_CONFIG = {
+    // enabled by default, as it makes sense in most cases
+    // see also https://github.com/facebook/docusaurus/issues/5880
+    contextualSearch: true,
     // By default, all Docusaurus sites are using the same AppId
     // This has been designed on purpose with Algolia.
     appId: 'BH4D9OD16A',
     searchParameters: {},
 };
-exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
 exports.Schema = utils_validation_1.Joi.object({
     algolia: utils_validation_1.Joi.object({
         // Docusaurus attributes
-        contextualSearch: utils_validation_1.Joi.boolean().default(DEFAULT_CONFIG.contextualSearch),
+        contextualSearch: utils_validation_1.Joi.boolean().default(exports.DEFAULT_CONFIG.contextualSearch),
         externalUrlRegex: utils_validation_1.Joi.string().optional(),
         // Algolia attributes
-        appId: utils_validation_1.Joi.string().default(DEFAULT_CONFIG.appId),
+        appId: utils_validation_1.Joi.string().default(exports.DEFAULT_CONFIG.appId),
         apiKey: utils_validation_1.Joi.string().required(),
         indexName: utils_validation_1.Joi.string().required(),
         searchParameters: utils_validation_1.Joi.object()
-            .default(DEFAULT_CONFIG.searchParameters)
+            .default(exports.DEFAULT_CONFIG.searchParameters)
             .unknown(),
     })
         .label('themeConfig.algolia')

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@docusaurus/theme-search-algolia",
-  "version": "2.0.0-beta.13",
+  "version": "2.0.0-beta.15",
   "description": "Algolia search component for Docusaurus.",
   "main": "lib/index.js",
+  "exports": {
+    "./client": "./lib/client/index.js",
+    ".": "./lib/index.js"
+  },
   "types": "src/theme-search-algolia.d.ts",
   "publishConfig": {
     "access": "public"
@@ -17,23 +21,26 @@
     "build": "yarn build:server && yarn build:browser && yarn build:copy",
     "build:server": "tsc --project tsconfig.server.json",
     "build:browser": "tsc --project tsconfig.browser.json",
-    "build:copy": "node copyUntypedFiles.js"
+    "build:copy": "node copyUntypedFiles.mjs"
   },
   "dependencies": {
     "@docsearch/react": "^3.0.0-alpha.39",
-    "@docusaurus/core": "2.0.0-beta.13",
-    "@docusaurus/theme-common": "2.0.0-beta.13",
-    "@docusaurus/theme-translations": "2.0.0-beta.13",
-    "@docusaurus/utils": "2.0.0-beta.13",
-    "@docusaurus/utils-validation": "2.0.0-beta.13",
+    "@docusaurus/core": "2.0.0-beta.15",
+    "@docusaurus/logger": "2.0.0-beta.15",
+    "@docusaurus/theme-common": "2.0.0-beta.15",
+    "@docusaurus/theme-translations": "2.0.0-beta.15",
+    "@docusaurus/utils": "2.0.0-beta.15",
+    "@docusaurus/utils-validation": "2.0.0-beta.15",
     "algoliasearch": "^4.10.5",
     "algoliasearch-helper": "^3.5.5",
     "clsx": "^1.1.1",
     "eta": "^1.12.3",
-    "lodash": "^4.17.20"
+    "lodash": "^4.17.20",
+    "tslib": "^2.3.1",
+    "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.13",
+    "@docusaurus/module-type-aliases": "2.0.0-beta.15",
     "fs-extra": "^10.0.0"
   },
   "peerDependencies": {
@@ -43,5 +50,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "b6ca12aedf10a10c2375f4f8b7e7380cfd7c7202"
+  "gitHead": "6cfad16436c07d8d11e5c2e1486dc59afd483e33"
 }

package/src/client/index.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.
+ */
+
+export {useAlgoliaContextualFacetFilters} from './useAlgoliaContextualFacetFilters';

package/src/{theme/hooks → client}/useAlgoliaContextualFacetFilters.ts

@@ -5,11 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {useAlgoliaContextualFacetFiltersReturns} from '@theme/hooks/useAlgoliaContextualFacetFilters';
 import {useContextualSearchFilters} from '@docusaurus/theme-common';
 
 // Translate search-engine agnostic search filters to Algolia search filters
-export default function useAlgoliaContextualFacetFilters(): useAlgoliaContextualFacetFiltersReturns {
+export function useAlgoliaContextualFacetFilters(): [string, string[]] {
   const {locale, tags} = useContextualSearchFilters();
 
   // seems safe to convert locale->language, see AlgoliaSearchMetadata comment

package/src/index.ts

@@ -8,12 +8,13 @@
 import path from 'path';
 import fs from 'fs';
 import {defaultConfig, compile} from 'eta';
-import {normalizeUrl, getSwizzledComponent} from '@docusaurus/utils';
+import {normalizeUrl} from '@docusaurus/utils';
 import {readDefaultCodeTranslationMessages} from '@docusaurus/theme-translations';
+import logger from '@docusaurus/logger';
 import openSearchTemplate from './templates/opensearch';
 import {memoize} from 'lodash';
 
-import type {DocusaurusContext, Plugin} from '@docusaurus/types';
+import type {LoadContext, Plugin} from '@docusaurus/types';
 
 const getCompiledOpenSearchTemplate = memoize(() =>
   compile(openSearchTemplate.trim()),
@@ -30,26 +31,16 @@ function renderOpenSearchTemplate(data: {
 
 const OPEN_SEARCH_FILENAME = 'opensearch.xml';
 
-export default function theme(
-  context: DocusaurusContext & {baseUrl: string},
-): Plugin<void> {
+export default function themeSearchAlgolia(context: LoadContext): Plugin<void> {
   const {
     baseUrl,
     siteConfig: {title, url, favicon},
     i18n: {currentLocale},
   } = context;
-  const pageComponent = './theme/SearchPage/index.js';
-  const pagePath =
-    getSwizzledComponent(pageComponent) ||
-    path.resolve(__dirname, pageComponent);
 
   return {
     name: 'docusaurus-theme-search-algolia',
 
-    getPathsToWatch() {
-      return [pagePath];
-    },
-
     getThemePath() {
       return path.resolve(__dirname, './theme');
     },
@@ -68,7 +59,7 @@ export default function theme(
     async contentLoaded({actions: {addRoute}}) {
       addRoute({
         path: normalizeUrl([baseUrl, 'search']),
-        component: pagePath,
+        component: '@theme/SearchPage',
         exact: true,
       });
     },
@@ -83,9 +74,9 @@ export default function theme(
             favicon: favicon ? normalizeUrl([url, baseUrl, favicon]) : null,
           }),
         );
-      } catch (err) {
-        console.error(err);
-        throw new Error(`Generating OpenSearch file failed: ${err}`);
+      } catch (e) {
+        logger.error('Generating OpenSearch file failed.');
+        throw e;
       }
     },
 

package/src/theme/SearchBar/index.tsx

@@ -13,10 +13,9 @@ import {useHistory} from '@docusaurus/router';
 import {useBaseUrlUtils} from '@docusaurus/useBaseUrl';
 import Link from '@docusaurus/Link';
 import Head from '@docusaurus/Head';
-import useSearchQuery from '@theme/hooks/useSearchQuery';
-import {isRegexpStringMatch} from '@docusaurus/theme-common';
+import {isRegexpStringMatch, useSearchPage} from '@docusaurus/theme-common';
 import {DocSearchButton, useDocSearchKeyboardEvents} from '@docsearch/react';
-import useAlgoliaContextualFacetFilters from '@theme/hooks/useAlgoliaContextualFacetFilters';
+import {useAlgoliaContextualFacetFilters} from '@docusaurus/theme-search-algolia/client';
 import {translate} from '@docusaurus/Translate';
 import styles from './styles.module.css';
 
@@ -56,7 +55,7 @@ type ResultsFooterProps = {
 };
 
 function ResultsFooter({state, onClose}: ResultsFooterProps) {
-  const {generateSearchPageLink} = useSearchQuery();
+  const {generateSearchPageLink} = useSearchPage();
 
   return (
     <Link to={generateSearchPageLink(state.query)} onClick={onClose}>
@@ -65,6 +64,18 @@ function ResultsFooter({state, onClose}: ResultsFooterProps) {
   );
 }
 
+type FacetFilters = Required<
+  Required<DocSearchProps>['searchParameters']
+>['facetFilters'];
+
+function mergeFacetFilters(f1: FacetFilters, f2: FacetFilters): FacetFilters {
+  const normalize = (
+    f: FacetFilters,
+  ): readonly string[] | ReadonlyArray<readonly string[]> =>
+    f instanceof Array ? f : [f];
+  return [...normalize(f1), ...normalize(f2)] as FacetFilters;
+}
+
 function DocSearch({
   contextualSearch,
   externalUrlRegex,
@@ -72,18 +83,20 @@ function DocSearch({
 }: DocSearchProps) {
   const {siteMetadata} = useDocusaurusContext();
 
-  const contextualSearchFacetFilters = useAlgoliaContextualFacetFilters();
+  const contextualSearchFacetFilters =
+    useAlgoliaContextualFacetFilters() as FacetFilters;
 
-  const configFacetFilters = props.searchParameters?.facetFilters ?? [];
+  const configFacetFilters: FacetFilters =
+    props.searchParameters?.facetFilters ?? [];
 
-  const facetFilters = contextualSearch
+  const facetFilters: FacetFilters = contextualSearch
     ? // Merge contextual search filters with config filters
-      [...contextualSearchFacetFilters, ...configFacetFilters]
+      mergeFacetFilters(contextualSearchFacetFilters, configFacetFilters)
     : // ... or use config facetFilters
       configFacetFilters;
 
   // we let user override default searchParameters if he wants to
-  const searchParameters = {
+  const searchParameters: DocSearchProps['searchParameters'] = {
     ...props.searchParameters,
     facetFilters,
   };
@@ -168,12 +181,14 @@ function DocSearch({
       }),
   ).current;
 
-  const resultsFooterComponent = useMemo(
-    // eslint-disable-next-line react/no-unstable-nested-components
-    () => (footerProps: ResultsFooterProps) =>
-      <ResultsFooter {...footerProps} onClose={onClose} />,
-    [onClose],
-  );
+  const resultsFooterComponent: DocSearchProps['resultsFooterComponent'] =
+    useMemo(
+      () =>
+        // eslint-disable-next-line react/no-unstable-nested-components
+        (footerProps: Omit<ResultsFooterProps, 'onClose'>): JSX.Element =>
+          <ResultsFooter {...footerProps} onClose={onClose} />,
+      [onClose],
+    );
 
   const transformSearchClient = useCallback(
     (searchClient) => {

package/src/theme/SearchMetadata/index.tsx

@@ -8,14 +8,10 @@
 import React from 'react';
 
 import Head from '@docusaurus/Head';
-import type {SearchMetadataProps} from '@theme/SearchMetadata';
+import type {Props} from '@theme/SearchMetadata';
 
-// Override default/agnostic SearchMetas to use Algolia-specific metadata
-function SearchMetadata({
-  locale,
-  version,
-  tag,
-}: SearchMetadataProps): JSX.Element {
+// Override default/agnostic SearchMetadata to use Algolia-specific metadata
+function SearchMetadata({locale, version, tag}: Props): JSX.Element {
   // Seems safe to consider here the locale is the language,
   // as the existing docsearch:language filter is afaik a regular string-based filter
   const language = locale;

package/src/theme/SearchPage/index.tsx

@@ -22,10 +22,10 @@ import {
   usePluralForm,
   isRegexpStringMatch,
   useDynamicCallback,
+  useSearchPage,
 } from '@docusaurus/theme-common';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import {useAllDocsData} from '@theme/hooks/useDocs';
-import useSearchQuery from '@theme/hooks/useSearchQuery';
+import {useAllDocsData} from '@docusaurus/plugin-content-docs/client';
 import Layout from '@theme/Layout';
 import Translate, {translate} from '@docusaurus/Translate';
 import styles from './styles.module.css';
@@ -162,7 +162,7 @@ function SearchPage(): JSX.Element {
   const documentsFoundPlural = useDocumentsFoundPlural();
 
   const docsSearchVersionsHelpers = useDocsSearchVersionsHelpers();
-  const {searchQuery, setSearchQuery} = useSearchQuery();
+  const {searchQuery, setSearchQuery} = useSearchPage();
   const initialSearchResultState: ResultDispatcherState = {
     items: [],
     query: null,

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

@@ -58,7 +58,7 @@
 }
 
 .searchResultItemSummary {
-  margin: 0.5rem 0 0 0;
+  margin: 0.5rem 0 0;
   font-style: italic;
 }
 
@@ -98,11 +98,11 @@
   border: 0.4em solid #eee;
   border-top-color: var(--ifm-color-primary);
   border-radius: 50%;
-  animation: loadingspin 1s linear infinite;
+  animation: loading-spin 1s linear infinite;
   margin: 0 auto;
 }
 
-@keyframes loadingspin {
+@keyframes loading-spin {
   100% {
     transform: rotate(360deg);
   }
@@ -114,6 +114,6 @@
 
 :global(.search-result-match) {
   color: var(--docsearch-hit-color);
-  background: rgba(255, 215, 142, 0.25);
+  background: rgb(255 215 142 / 25%);
   padding: 0.09em 0;
 }

package/src/theme-search-algolia.d.ts

@@ -6,23 +6,23 @@
  */
 
 declare module '@docusaurus/theme-search-algolia' {
-  export type Options = never;
-}
-
-declare module '@theme/hooks/useSearchQuery' {
-  export interface SearchQuery {
-    searchQuery: string;
-    setSearchQuery: (newSearchQuery: string) => void;
-    generateSearchPageLink: (targetSearchQuery: string) => string;
-  }
-
-  export default function useSearchQuery(): SearchQuery;
+  import type {DeepPartial} from 'utility-types';
+
+  export type ThemeConfig = {
+    algolia: {
+      contextualSearch: boolean;
+      externalUrlRegex?: string;
+      appId: string;
+      apiKey: string;
+      indexName: string;
+      searchParameters: Record<string, unknown>;
+    };
+  };
+  export type UserThemeConfig = DeepPartial<ThemeConfig>;
 }
 
-declare module '@theme/hooks/useAlgoliaContextualFacetFilters' {
-  export type useAlgoliaContextualFacetFiltersReturns = [string, string[]];
-
-  export default function useAlgoliaContextualFacetFilters(): useAlgoliaContextualFacetFiltersReturns;
+declare module '@docusaurus/theme-search-algolia/client' {
+  export function useAlgoliaContextualFacetFilters(): [string, string[]];
 }
 
 declare module '@theme/SearchPage' {
@@ -30,17 +30,6 @@ declare module '@theme/SearchPage' {
   export default SearchPage;
 }
 
-declare module '@theme/SearchMetadata' {
-  export type SearchMetadataProps = {
-    readonly locale?: string;
-    readonly version?: string;
-    readonly tag?: string;
-  };
-
-  const SearchMetadata: (props: SearchMetadataProps) => JSX.Element;
-  export default SearchMetadata;
-}
-
 declare module '@theme/SearchBar' {
   const SearchBar: () => JSX.Element;
   export default SearchBar;

package/src/types.d.ts

@@ -8,3 +8,7 @@
 /// <reference types="@docusaurus/module-type-aliases" />
 /// <reference types="@docusaurus/theme-common" />
 /// <reference types="@docusaurus/theme-classic" />
+
+export type FacetFilters = Required<
+  Required<DocSearchProps>['searchParameters']
+>['facetFilters'];

package/src/validateThemeConfig.ts

@@ -8,8 +8,10 @@
 import {Joi} from '@docusaurus/utils-validation';
 import type {ThemeConfig, Validate, ValidationResult} from '@docusaurus/types';
 
-const DEFAULT_CONFIG = {
-  contextualSearch: false, // future: maybe we want to enable this by default
+export const DEFAULT_CONFIG = {
+  // enabled by default, as it makes sense in most cases
+  // see also https://github.com/facebook/docusaurus/issues/5880
+  contextualSearch: true,
 
   // By default, all Docusaurus sites are using the same AppId
   // This has been designed on purpose with Algolia.
@@ -17,7 +19,6 @@ const DEFAULT_CONFIG = {
 
   searchParameters: {},
 };
-exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
 
 export const Schema = Joi.object({
   algolia: Joi.object({

package/copyUntypedFiles.js

@@ -1,20 +0,0 @@
-/**
- * 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.
- */
-
-const path = require('path');
-const fs = require('fs-extra');
-
-/**
- * Copy all untyped and static assets files to lib.
- */
-const srcDir = path.resolve(__dirname, 'src');
-const libDir = path.resolve(__dirname, 'lib');
-fs.copySync(srcDir, libDir, {
-  filter(filepath) {
-    return !/__tests__/.test(filepath) && !/\.tsx?$/.test(filepath);
-  },
-});

package/lib/theme/hooks/useAlgoliaContextualFacetFilters.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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 { useAlgoliaContextualFacetFiltersReturns } from '@theme/hooks/useAlgoliaContextualFacetFilters';
-export default function useAlgoliaContextualFacetFilters(): useAlgoliaContextualFacetFiltersReturns;

package/lib/theme/hooks/useSearchQuery.js

@@ -1,43 +0,0 @@
-/**
- * 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 { useHistory } from '@docusaurus/router';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import { useCallback, useEffect, useState } from 'react';
-const SEARCH_PARAM_QUERY = 'q';
-function useSearchQuery() {
-    const history = useHistory();
-    const { siteConfig: { baseUrl }, } = useDocusaurusContext();
-    const [searchQuery, setSearchQueryState] = useState('');
-    // Init search query just after React hydration
-    useEffect(() => {
-        var _a;
-        const searchQueryStringValue = (_a = new URLSearchParams(window.location.search).get(SEARCH_PARAM_QUERY)) !== null && _a !== void 0 ? _a : '';
-        setSearchQueryState(searchQueryStringValue);
-    }, []);
-    const setSearchQuery = useCallback((newSearchQuery) => {
-        const searchParams = new URLSearchParams(window.location.search);
-        if (newSearchQuery) {
-            searchParams.set(SEARCH_PARAM_QUERY, newSearchQuery);
-        }
-        else {
-            searchParams.delete(SEARCH_PARAM_QUERY);
-        }
-        history.replace({
-            search: searchParams.toString(),
-        });
-        setSearchQueryState(newSearchQuery);
-    }, [history]);
-    const generateSearchPageLink = useCallback((targetSearchQuery) => 
-    // Refer to https://github.com/facebook/docusaurus/pull/2838
-    `${baseUrl}search?q=${encodeURIComponent(targetSearchQuery)}`, [baseUrl]);
-    return {
-        searchQuery,
-        setSearchQuery,
-        generateSearchPageLink,
-    };
-}
-export default useSearchQuery;

package/src/__tests__/validateThemeConfig.test.js

@@ -1,135 +0,0 @@
-/**
- * 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.
- */
-
-const {validateThemeConfig, DEFAULT_CONFIG} = require('../validateThemeConfig');
-
-function testValidateThemeConfig(themeConfig) {
-  function validate(schema, cfg) {
-    const {value, error} = schema.validate(cfg, {
-      convert: false,
-    });
-    if (error) {
-      throw error;
-    }
-    return value;
-  }
-
-  return validateThemeConfig({themeConfig, validate});
-}
-
-describe('validateThemeConfig', () => {
-  test('minimal config', () => {
-    const algolia = {
-      indexName: 'index',
-      apiKey: 'apiKey',
-    };
-    expect(testValidateThemeConfig({algolia})).toEqual({
-      algolia: {
-        ...DEFAULT_CONFIG,
-        ...algolia,
-      },
-    });
-  });
-
-  test('unknown attributes', () => {
-    const algolia = {
-      indexName: 'index',
-      apiKey: 'apiKey',
-      unknownKey: 'unknownKey',
-    };
-    expect(testValidateThemeConfig({algolia})).toEqual({
-      algolia: {
-        ...DEFAULT_CONFIG,
-        ...algolia,
-      },
-    });
-  });
-
-  test('undefined config', () => {
-    const algolia = undefined;
-    expect(() =>
-      testValidateThemeConfig({algolia}),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"\\"themeConfig.algolia\\" is required"`,
-    );
-  });
-
-  test('undefined config 2', () => {
-    expect(() =>
-      testValidateThemeConfig({}),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"\\"themeConfig.algolia\\" is required"`,
-    );
-  });
-
-  test('empty config', () => {
-    const algolia = {};
-    expect(() =>
-      testValidateThemeConfig({algolia}),
-    ).toThrowErrorMatchingInlineSnapshot(`"\\"algolia.apiKey\\" is required"`);
-  });
-
-  test('missing indexName config', () => {
-    const algolia = {apiKey: 'apiKey'};
-    expect(() =>
-      testValidateThemeConfig({algolia}),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"\\"algolia.indexName\\" is required"`,
-    );
-  });
-
-  test('missing apiKey config', () => {
-    const algolia = {indexName: 'indexName'};
-    expect(() =>
-      testValidateThemeConfig({algolia}),
-    ).toThrowErrorMatchingInlineSnapshot(`"\\"algolia.apiKey\\" is required"`);
-  });
-
-  test('contextualSearch config', () => {
-    const algolia = {
-      indexName: 'index',
-      apiKey: 'apiKey',
-      contextualSearch: true,
-    };
-    expect(testValidateThemeConfig({algolia})).toEqual({
-      algolia: {
-        ...DEFAULT_CONFIG,
-        ...algolia,
-      },
-    });
-  });
-
-  test('externalUrlRegex config', () => {
-    const algolia = {
-      indexName: 'index',
-      apiKey: 'apiKey',
-      externalUrlRegex: 'http://external-domain.com',
-    };
-    expect(testValidateThemeConfig({algolia})).toEqual({
-      algolia: {
-        ...DEFAULT_CONFIG,
-        ...algolia,
-      },
-    });
-  });
-
-  test('searchParameters.facetFilters search config', () => {
-    const algolia = {
-      indexName: 'index',
-      apiKey: 'apiKey',
-      searchParameters: {
-        facetFilters: ['version:1.0'],
-      },
-    };
-    expect(testValidateThemeConfig({algolia})).toEqual({
-      algolia: {
-        ...DEFAULT_CONFIG,
-        ...algolia,
-      },
-    });
-  });
-});

package/src/theme/hooks/useSearchQuery.ts

@@ -1,63 +0,0 @@
-/**
- * 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 {useHistory} from '@docusaurus/router';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import {useCallback, useEffect, useState} from 'react';
-import type {SearchQuery} from '@theme/hooks/useSearchQuery';
-
-const SEARCH_PARAM_QUERY = 'q';
-
-function useSearchQuery(): SearchQuery {
-  const history = useHistory();
-  const {
-    siteConfig: {baseUrl},
-  } = useDocusaurusContext();
-
-  const [searchQuery, setSearchQueryState] = useState('');
-
-  // Init search query just after React hydration
-  useEffect(() => {
-    const searchQueryStringValue =
-      new URLSearchParams(window.location.search).get(SEARCH_PARAM_QUERY) ?? '';
-
-    setSearchQueryState(searchQueryStringValue);
-  }, []);
-
-  const setSearchQuery = useCallback(
-    (newSearchQuery: string) => {
-      const searchParams = new URLSearchParams(window.location.search);
-
-      if (newSearchQuery) {
-        searchParams.set(SEARCH_PARAM_QUERY, newSearchQuery);
-      } else {
-        searchParams.delete(SEARCH_PARAM_QUERY);
-      }
-
-      history.replace({
-        search: searchParams.toString(),
-      });
-      setSearchQueryState(newSearchQuery);
-    },
-    [history],
-  );
-
-  const generateSearchPageLink = useCallback(
-    (targetSearchQuery: string) =>
-      // Refer to https://github.com/facebook/docusaurus/pull/2838
-      `${baseUrl}search?q=${encodeURIComponent(targetSearchQuery)}`,
-    [baseUrl],
-  );
-
-  return {
-    searchQuery,
-    setSearchQuery,
-    generateSearchPageLink,
-  };
-}
-
-export default useSearchQuery;

package/tsconfig.browser.json

@@ -1,8 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "module": "esnext",
-    "jsx": "react-native"
-  },
-  "include": ["src/theme/", "src/*.d.ts"]
-}

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "lib": ["DOM", "ES2019"],
-    "rootDir": "src",
-    "baseUrl": "src",
-    "outDir": "lib"
-  }
-}

package/tsconfig.server.json

@@ -1,4 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "include": ["src/*.ts", "src/templates/*.ts"]
-}