@docusaurus/theme-search-algolia 0.0.0-4376 → 0.0.0-4383

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/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,7 +22,7 @@ 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>);

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

@@ -7,7 +7,7 @@
 import React from 'react';
 import Head from '@docusaurus/Head';
 // Override default/agnostic SearchMetas to use Algolia-specific metadata
-function SearchMetadata({ locale, version, tag, }) {
+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 '@docusaurus/plugin-content-docs/client';
-import useSearchQuery from '@theme/hooks/useSearchQuery';
 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/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,26 @@
  * 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 = {
+exports.DEFAULT_CONFIG = {
     contextualSearch: false,
     // 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": "0.0.0-4376",
+  "version": "0.0.0-4383",
   "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,25 +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": "0.0.0-4376",
-    "@docusaurus/logger": "0.0.0-4376",
-    "@docusaurus/theme-common": "0.0.0-4376",
-    "@docusaurus/theme-translations": "0.0.0-4376",
-    "@docusaurus/utils": "0.0.0-4376",
-    "@docusaurus/utils-validation": "0.0.0-4376",
+    "@docusaurus/core": "0.0.0-4383",
+    "@docusaurus/logger": "0.0.0-4383",
+    "@docusaurus/theme-common": "0.0.0-4383",
+    "@docusaurus/theme-translations": "0.0.0-4383",
+    "@docusaurus/utils": "0.0.0-4383",
+    "@docusaurus/utils-validation": "0.0.0-4383",
     "algoliasearch": "^4.10.5",
     "algoliasearch-helper": "^3.5.5",
     "clsx": "^1.1.1",
     "eta": "^1.12.3",
     "lodash": "^4.17.20",
-    "tslib": "^2.3.1"
+    "tslib": "^2.3.1",
+    "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4376",
+    "@docusaurus/module-type-aliases": "0.0.0-4383",
     "fs-extra": "^10.0.0"
   },
   "peerDependencies": {
@@ -45,5 +50,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "d95874b8c1ad60ed595d2088f23284df72903c29"
+  "gitHead": "6ccc0daea1a7b1413cd32f515a9e661c4007a355"
 }

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() {
   const {locale, tags} = useContextualSearchFilters();
 
   // seems safe to convert locale->language, see AlgoliaSearchMetadata comment

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}>

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 {
+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 '@docusaurus/plugin-content-docs/client';
-import useSearchQuery from '@theme/hooks/useSearchQuery';
 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-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/validateThemeConfig.ts

@@ -8,7 +8,7 @@
 import {Joi} from '@docusaurus/utils-validation';
 import type {ThemeConfig, Validate, ValidationResult} from '@docusaurus/types';
 
-const DEFAULT_CONFIG = {
+export const DEFAULT_CONFIG = {
   contextualSearch: false, // future: maybe we want to enable this by default
 
   // By default, all Docusaurus sites are using the same AppId
@@ -17,7 +17,6 @@ const DEFAULT_CONFIG = {
 
   searchParameters: {},
 };
-exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
 
 export const Schema = Joi.object({
   algolia: Joi.object({

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/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;