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

package/lib/validateThemeConfig.d.ts

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

package/lib/validateThemeConfig.js

@@ -1,40 +1,50 @@
-"use strict";
+'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 });
+Object.defineProperty(exports, '__esModule', {value: true});
 exports.validateThemeConfig = exports.Schema = exports.DEFAULT_CONFIG = void 0;
-const utils_validation_1 = require("@docusaurus/utils-validation");
+const utils_validation_1 = require('@docusaurus/utils-validation');
 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: {},
+  // enabled by default, as it makes sense in most cases
+  // see also https://github.com/facebook/docusaurus/issues/5880
+  contextualSearch: true,
+  searchParameters: {},
+  searchPagePath: 'search',
 };
 exports.Schema = utils_validation_1.Joi.object({
-    algolia: utils_validation_1.Joi.object({
-        // Docusaurus attributes
-        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(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(exports.DEFAULT_CONFIG.searchParameters)
-            .unknown(),
-    })
-        .label('themeConfig.algolia')
-        .required()
-        .unknown(), // DocSearch 3 is still alpha: don't validate the rest for now
+  algolia: utils_validation_1.Joi.object({
+    // Docusaurus attributes
+    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().required().messages({
+      'any.required':
+        '"algolia.appId" is required. If you haven\'t migrated to the new DocSearch infra, please refer to the blog post for instructions: https://docusaurus.io/blog/2021/11/21/algolia-docsearch-migration',
+    }),
+    apiKey: utils_validation_1.Joi.string().required(),
+    indexName: utils_validation_1.Joi.string().required(),
+    searchParameters: utils_validation_1.Joi.object()
+      .default(exports.DEFAULT_CONFIG.searchParameters)
+      .unknown(),
+    searchPagePath: utils_validation_1.Joi.alternatives()
+      .try(
+        utils_validation_1.Joi.boolean().invalid(true),
+        utils_validation_1.Joi.string(),
+      )
+      .allow(null)
+      .default(exports.DEFAULT_CONFIG.searchPagePath),
+  })
+    .label('themeConfig.algolia')
+    .required()
+    .unknown(), // DocSearch 3 is still alpha: don't validate the rest for now
 });
-function validateThemeConfig({ validate, themeConfig, }) {
-    return validate(exports.Schema, themeConfig);
+function validateThemeConfig({validate, themeConfig}) {
+  return validate(exports.Schema, themeConfig);
 }
 exports.validateThemeConfig = validateThemeConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-search-algolia",
-  "version": "2.0.0-beta.15",
+  "version": "2.0.0-beta.16",
   "description": "Algolia search component for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -18,30 +18,31 @@
   },
   "license": "MIT",
   "scripts": {
-    "build": "yarn build:server && yarn build:browser && yarn build:copy",
+    "build": "yarn build:server && yarn build:client && yarn build:copy && yarn build:format",
     "build:server": "tsc --project tsconfig.server.json",
-    "build:browser": "tsc --project tsconfig.browser.json",
-    "build:copy": "node copyUntypedFiles.mjs"
+    "build:client": "tsc --project tsconfig.client.json",
+    "build:copy": "node copyUntypedFiles.mjs",
+    "build:format": "prettier --config ../../.prettierrc --write \"lib/**/*.js\""
   },
   "dependencies": {
-    "@docsearch/react": "^3.0.0-alpha.39",
-    "@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",
+    "@docsearch/react": "^3.0.0",
+    "@docusaurus/core": "2.0.0-beta.16",
+    "@docusaurus/logger": "2.0.0-beta.16",
+    "@docusaurus/theme-common": "2.0.0-beta.16",
+    "@docusaurus/theme-translations": "2.0.0-beta.16",
+    "@docusaurus/utils": "2.0.0-beta.16",
+    "@docusaurus/utils-validation": "2.0.0-beta.16",
+    "algoliasearch": "^4.12.1",
+    "algoliasearch-helper": "^3.7.0",
     "clsx": "^1.1.1",
     "eta": "^1.12.3",
-    "lodash": "^4.17.20",
+    "fs-extra": "^10.0.1",
+    "lodash": "^4.17.21",
     "tslib": "^2.3.1",
     "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.15",
-    "fs-extra": "^10.0.0"
+    "@docusaurus/module-type-aliases": "2.0.0-beta.16"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -50,5 +51,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "6cfad16436c07d8d11e5c2e1486dc59afd483e33"
+  "gitHead": "eb43c4d4f95a4fb97dc9bb9dc615413e0dc2e1e7"
 }

package/src/deps.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 module '@docsearch/react/modal';
+
+declare module '@docsearch/react/style';

package/src/index.ts

@@ -6,24 +6,26 @@
  */
 
 import path from 'path';
-import fs from 'fs';
+import fs from 'fs-extra';
 import {defaultConfig, compile} from 'eta';
 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 _ from 'lodash';
 
 import type {LoadContext, Plugin} from '@docusaurus/types';
+import type {ThemeConfig} from '@docusaurus/theme-search-algolia';
 
-const getCompiledOpenSearchTemplate = memoize(() =>
+const getCompiledOpenSearchTemplate = _.memoize(() =>
   compile(openSearchTemplate.trim()),
 );
 
 function renderOpenSearchTemplate(data: {
   title: string;
-  url: string;
-  favicon: string | null;
+  siteUrl: string;
+  searchUrl: string;
+  faviconUrl: string | null;
 }) {
   const compiled = getCompiledOpenSearchTemplate();
   return compiled(data, defaultConfig);
@@ -34,19 +36,21 @@ const OPEN_SEARCH_FILENAME = 'opensearch.xml';
 export default function themeSearchAlgolia(context: LoadContext): Plugin<void> {
   const {
     baseUrl,
-    siteConfig: {title, url, favicon},
+    siteConfig: {title, url, favicon, themeConfig},
     i18n: {currentLocale},
   } = context;
+  const {
+    algolia: {searchPagePath},
+  } = themeConfig as ThemeConfig;
 
   return {
     name: 'docusaurus-theme-search-algolia',
 
     getThemePath() {
-      return path.resolve(__dirname, './theme');
+      return path.resolve(__dirname, '../lib/theme');
     },
-
     getTypeScriptThemePath() {
-      return path.resolve(__dirname, '..', 'src', 'theme');
+      return path.resolve(__dirname, '../src/theme');
     },
 
     getDefaultCodeTranslationMessages() {
@@ -57,30 +61,41 @@ export default function themeSearchAlgolia(context: LoadContext): Plugin<void> {
     },
 
     async contentLoaded({actions: {addRoute}}) {
-      addRoute({
-        path: normalizeUrl([baseUrl, 'search']),
-        component: '@theme/SearchPage',
-        exact: true,
-      });
+      if (searchPagePath) {
+        addRoute({
+          path: normalizeUrl([baseUrl, searchPagePath]),
+          component: '@theme/SearchPage',
+          exact: true,
+        });
+      }
     },
 
     async postBuild({outDir}) {
-      try {
-        fs.writeFileSync(
-          path.join(outDir, OPEN_SEARCH_FILENAME),
-          renderOpenSearchTemplate({
-            title,
-            url: url + baseUrl,
-            favicon: favicon ? normalizeUrl([url, baseUrl, favicon]) : null,
-          }),
-        );
-      } catch (e) {
-        logger.error('Generating OpenSearch file failed.');
-        throw e;
+      if (searchPagePath) {
+        const siteUrl = normalizeUrl([url, baseUrl]);
+
+        try {
+          await fs.writeFile(
+            path.join(outDir, OPEN_SEARCH_FILENAME),
+            renderOpenSearchTemplate({
+              title,
+              siteUrl,
+              searchUrl: normalizeUrl([siteUrl, searchPagePath]),
+              faviconUrl: favicon ? normalizeUrl([siteUrl, favicon]) : null,
+            }),
+          );
+        } catch (err) {
+          logger.error('Generating OpenSearch file failed.');
+          throw err;
+        }
       }
     },
 
     injectHtmlTags() {
+      if (!searchPagePath) {
+        return {};
+      }
+
       return {
         headTags: [
           {

package/src/templates/opensearch.ts

@@ -12,11 +12,11 @@ export default `
   <ShortName><%= it.title %></ShortName>
   <Description>Search <%= it.title %></Description>
   <InputEncoding>UTF-8</InputEncoding>
-  <% if (it.favicon) { _%>
-    <Image width="16" height="16" type="image/x-icon"><%= it.favicon %></Image>
+  <% if (it.faviconUrl) { _%>
+    <Image width="16" height="16" type="image/x-icon"><%= it.faviconUrl %></Image>
   <% } _%>
-  <Url type="text/html" method="get" template="<%= it.url %>search?q={searchTerms}"/>
-  <Url type="application/opensearchdescription+xml" rel="self" template="<%= it.url %>opensearch.xml" />
-  <moz:SearchForm><%= it.url %></moz:SearchForm>
+  <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/src/theme/SearchBar/index.tsx

@@ -4,7 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/* eslint-disable @typescript-eslint/ban-ts-comment */
 
 import React, {useState, useRef, useCallback, useMemo} from 'react';
 import {createPortal} from 'react-dom';
@@ -16,7 +15,7 @@ import Head from '@docusaurus/Head';
 import {isRegexpStringMatch, useSearchPage} from '@docusaurus/theme-common';
 import {DocSearchButton, useDocSearchKeyboardEvents} from '@docsearch/react';
 import {useAlgoliaContextualFacetFilters} from '@docusaurus/theme-search-algolia/client';
-import {translate} from '@docusaurus/Translate';
+import Translate, {translate} from '@docusaurus/Translate';
 import styles from './styles.module.css';
 
 import type {
@@ -35,6 +34,7 @@ type DocSearchProps = Omit<
 > & {
   contextualSearch?: string;
   externalUrlRegex?: string;
+  searchPagePath: boolean | string;
 };
 
 let DocSearchModal: typeof DocSearchModalType | null = null;
@@ -59,7 +59,11 @@ function ResultsFooter({state, onClose}: ResultsFooterProps) {
 
   return (
     <Link to={generateSearchPageLink(state.query)} onClick={onClose}>
-      See all {state.context.nbHits} results
+      <Translate
+        id="theme.SearchBar.seeAll"
+        values={{count: state.context.nbHits}}>
+        {'See all {count} results'}
+      </Translate>
     </Link>
   );
 }
@@ -71,8 +75,8 @@ type FacetFilters = Required<
 function mergeFacetFilters(f1: FacetFilters, f2: FacetFilters): FacetFilters {
   const normalize = (
     f: FacetFilters,
-  ): readonly string[] | ReadonlyArray<readonly string[]> =>
-    f instanceof Array ? f : [f];
+  ): readonly string[] | ReadonlyArray<string | readonly string[]> =>
+    typeof f === 'string' ? [f] : f;
   return [...normalize(f1), ...normalize(f2)] as FacetFilters;
 }
 
@@ -116,9 +120,7 @@ function DocSearch({
     }
 
     return Promise.all([
-      // @ts-ignore
       import('@docsearch/react/modal'),
-      // @ts-ignore
       import('@docsearch/react/style'),
       import('./styles.css'),
     ]).then(([{DocSearchModal: Modal}]) => {
@@ -167,7 +169,8 @@ function DocSearch({
   const transformItems = useRef<DocSearchModalProps['transformItems']>(
     (items) =>
       items.map((item) => {
-        // If Algolia contains a external domain, we should navigate without relative URL
+        // If Algolia contains a external domain, we should navigate without
+        // relative URL
         if (isRegexpStringMatch(externalUrlRegex, item.url)) {
           return item;
         }
@@ -254,8 +257,10 @@ function DocSearch({
             navigator={navigator}
             transformItems={transformItems}
             hitComponent={Hit}
-            resultsFooterComponent={resultsFooterComponent}
             transformSearchClient={transformSearchClient}
+            {...(props.searchPagePath && {
+              resultsFooterComponent,
+            })}
             {...props}
             searchParameters={searchParameters}
           />,
@@ -265,10 +270,7 @@ function DocSearch({
   );
 }
 
-function SearchBar(): JSX.Element {
+export default function SearchBar(): JSX.Element {
   const {siteConfig} = useDocusaurusContext();
-  // @ts-ignore
-  return <DocSearch {...siteConfig.themeConfig.algolia} />;
+  return <DocSearch {...(siteConfig.themeConfig.algolia as DocSearchProps)} />;
 }
-
-export default SearchBar;

package/src/theme/SearchPage/index.tsx

@@ -6,7 +6,6 @@
  */
 
 /* eslint-disable jsx-a11y/no-autofocus */
-/* eslint-disable @typescript-eslint/ban-ts-comment */
 
 import React, {useEffect, useState, useReducer, useRef} from 'react';
 
@@ -29,6 +28,7 @@ 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';
+import type {ThemeConfig} from '@docusaurus/theme-search-algolia';
 
 // Very simple pluralization: probably good enough for now
 function useDocumentsFoundPlural() {
@@ -149,16 +149,14 @@ type ResultDispatcher =
   | {type: 'update'; value: ResultDispatcherState}
   | {type: 'advance'; value?: undefined};
 
-function SearchPage(): JSX.Element {
+export default function SearchPage(): JSX.Element {
   const {
-    siteConfig: {
-      themeConfig: {
-        // @ts-ignore
-        algolia: {appId, apiKey, indexName, externalUrlRegex},
-      },
-    },
+    siteConfig: {themeConfig},
     i18n: {currentLocale},
   } = useDocusaurusContext();
+  const {
+    algolia: {appId, apiKey, indexName, externalUrlRegex},
+  } = themeConfig as ThemeConfig;
   const documentsFoundPlural = useDocumentsFoundPlural();
 
   const docsSearchVersionsHelpers = useDocsSearchVersionsHelpers();
@@ -518,5 +516,3 @@ function SearchPage(): JSX.Element {
     </Layout>
   );
 }
-
-export default SearchPage;

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

@@ -16,6 +16,7 @@ declare module '@docusaurus/theme-search-algolia' {
       apiKey: string;
       indexName: string;
       searchParameters: Record<string, unknown>;
+      searchPagePath: string | false | null;
     };
   };
   export type UserThemeConfig = DeepPartial<ThemeConfig>;
@@ -26,11 +27,9 @@ declare module '@docusaurus/theme-search-algolia/client' {
 }
 
 declare module '@theme/SearchPage' {
-  const SearchPage: () => JSX.Element;
-  export default SearchPage;
+  export default function SearchPage(): JSX.Element;
 }
 
 declare module '@theme/SearchBar' {
-  const SearchBar: () => JSX.Element;
-  export default SearchBar;
+  export default function SearchBar(): JSX.Element;
 }

package/src/types.d.ts

@@ -8,7 +8,3 @@
 /// <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

@@ -13,11 +13,8 @@ export const DEFAULT_CONFIG = {
   // 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: {},
+  searchPagePath: 'search',
 };
 
 export const Schema = Joi.object({
@@ -26,12 +23,19 @@ export const Schema = Joi.object({
     contextualSearch: Joi.boolean().default(DEFAULT_CONFIG.contextualSearch),
     externalUrlRegex: Joi.string().optional(),
     // Algolia attributes
-    appId: Joi.string().default(DEFAULT_CONFIG.appId),
+    appId: Joi.string().required().messages({
+      'any.required':
+        '"algolia.appId" is required. If you haven\'t migrated to the new DocSearch infra, please refer to the blog post for instructions: https://docusaurus.io/blog/2021/11/21/algolia-docsearch-migration',
+    }),
     apiKey: Joi.string().required(),
     indexName: Joi.string().required(),
     searchParameters: Joi.object()
       .default(DEFAULT_CONFIG.searchParameters)
       .unknown(),
+    searchPagePath: Joi.alternatives()
+      .try(Joi.boolean().invalid(true), Joi.string())
+      .allow(null)
+      .default(DEFAULT_CONFIG.searchPagePath),
   })
     .label('themeConfig.algolia')
     .required()

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

@@ -1,11 +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.
- */
-/// <reference types="@docusaurus/theme-classic" />
-/// <reference types="react" />
-import type { Props } from '@theme/SearchMetadata';
-declare function SearchMetadata({ locale, version, tag }: Props): JSX.Element;
-export default SearchMetadata;

package/lib/theme/SearchMetadata/index.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.
- */
-import React from 'react';
-import Head from '@docusaurus/Head';
-// 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;
-    return (<Head>
-      {language && <meta name="docsearch:language" content={language}/>}
-      {version && <meta name="docsearch:version" content={version}/>}
-      {tag && <meta name="docsearch:docusaurus_tag" content={tag}/>}
-    </Head>);
-}
-export default SearchMetadata;

package/src/theme/SearchMetadata/index.tsx

@@ -1,28 +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 React from 'react';
-
-import Head from '@docusaurus/Head';
-import type {Props} from '@theme/SearchMetadata';
-
-// 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;
-
-  return (
-    <Head>
-      {language && <meta name="docsearch:language" content={language} />}
-      {version && <meta name="docsearch:version" content={version} />}
-      {tag && <meta name="docsearch:docusaurus_tag" content={tag} />}
-    </Head>
-  );
-}
-
-export default SearchMetadata;