@docusaurus/theme-search-algolia 2.0.0-beta.ff31de0ff → 2.0.1

package/src/theme/SearchTranslations/index.ts

@@ -0,0 +1,172 @@
+/**
+ * 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 {translate} from '@docusaurus/Translate';
+
+import type {DocSearchTranslations} from '@docsearch/react';
+
+const translations: DocSearchTranslations & {placeholder: string} = {
+  button: {
+    buttonText: translate({
+      id: 'theme.SearchBar.label',
+      message: 'Search',
+      description: 'The ARIA label and placeholder for search button',
+    }),
+    buttonAriaLabel: translate({
+      id: 'theme.SearchBar.label',
+      message: 'Search',
+      description: 'The ARIA label and placeholder for search button',
+    }),
+  },
+  modal: {
+    searchBox: {
+      resetButtonTitle: translate({
+        id: 'theme.SearchModal.searchBox.resetButtonTitle',
+        message: 'Clear the query',
+        description: 'The label and ARIA label for search box reset button',
+      }),
+      resetButtonAriaLabel: translate({
+        id: 'theme.SearchModal.searchBox.resetButtonTitle',
+        message: 'Clear the query',
+        description: 'The label and ARIA label for search box reset button',
+      }),
+      cancelButtonText: translate({
+        id: 'theme.SearchModal.searchBox.cancelButtonText',
+        message: 'Cancel',
+        description: 'The label and ARIA label for search box cancel button',
+      }),
+      cancelButtonAriaLabel: translate({
+        id: 'theme.SearchModal.searchBox.cancelButtonText',
+        message: 'Cancel',
+        description: 'The label and ARIA label for search box cancel button',
+      }),
+    },
+    startScreen: {
+      recentSearchesTitle: translate({
+        id: 'theme.SearchModal.startScreen.recentSearchesTitle',
+        message: 'Recent',
+        description: 'The title for recent searches',
+      }),
+      noRecentSearchesText: translate({
+        id: 'theme.SearchModal.startScreen.noRecentSearchesText',
+        message: 'No recent searches',
+        description: 'The text when no recent searches',
+      }),
+      saveRecentSearchButtonTitle: translate({
+        id: 'theme.SearchModal.startScreen.saveRecentSearchButtonTitle',
+        message: 'Save this search',
+        description: 'The label for save recent search button',
+      }),
+      removeRecentSearchButtonTitle: translate({
+        id: 'theme.SearchModal.startScreen.removeRecentSearchButtonTitle',
+        message: 'Remove this search from history',
+        description: 'The label for remove recent search button',
+      }),
+      favoriteSearchesTitle: translate({
+        id: 'theme.SearchModal.startScreen.favoriteSearchesTitle',
+        message: 'Favorite',
+        description: 'The title for favorite searches',
+      }),
+      removeFavoriteSearchButtonTitle: translate({
+        id: 'theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle',
+        message: 'Remove this search from favorites',
+        description: 'The label for remove favorite search button',
+      }),
+    },
+    errorScreen: {
+      titleText: translate({
+        id: 'theme.SearchModal.errorScreen.titleText',
+        message: 'Unable to fetch results',
+        description: 'The title for error screen of search modal',
+      }),
+      helpText: translate({
+        id: 'theme.SearchModal.errorScreen.helpText',
+        message: 'You might want to check your network connection.',
+        description: 'The help text for error screen of search modal',
+      }),
+    },
+    footer: {
+      selectText: translate({
+        id: 'theme.SearchModal.footer.selectText',
+        message: 'to select',
+        description: 'The explanatory text of the action for the enter key',
+      }),
+      selectKeyAriaLabel: translate({
+        id: 'theme.SearchModal.footer.selectKeyAriaLabel',
+        message: 'Enter key',
+        description:
+          'The ARIA label for the Enter key button that makes the selection',
+      }),
+      navigateText: translate({
+        id: 'theme.SearchModal.footer.navigateText',
+        message: 'to navigate',
+        description:
+          'The explanatory text of the action for the Arrow up and Arrow down key',
+      }),
+      navigateUpKeyAriaLabel: translate({
+        id: 'theme.SearchModal.footer.navigateUpKeyAriaLabel',
+        message: 'Arrow up',
+        description:
+          'The ARIA label for the Arrow up key button that makes the navigation',
+      }),
+      navigateDownKeyAriaLabel: translate({
+        id: 'theme.SearchModal.footer.navigateDownKeyAriaLabel',
+        message: 'Arrow down',
+        description:
+          'The ARIA label for the Arrow down key button that makes the navigation',
+      }),
+      closeText: translate({
+        id: 'theme.SearchModal.footer.closeText',
+        message: 'to close',
+        description: 'The explanatory text of the action for Escape key',
+      }),
+      closeKeyAriaLabel: translate({
+        id: 'theme.SearchModal.footer.closeKeyAriaLabel',
+        message: 'Escape key',
+        description:
+          'The ARIA label for the Escape key button that close the modal',
+      }),
+      searchByText: translate({
+        id: 'theme.SearchModal.footer.searchByText',
+        message: 'Search by',
+        description: 'The text explain that the search is making by Algolia',
+      }),
+    },
+    noResultsScreen: {
+      noResultsText: translate({
+        id: 'theme.SearchModal.noResultsScreen.noResultsText',
+        message: 'No results for',
+        description:
+          'The text explains that there are no results for the following search',
+      }),
+      suggestedQueryText: translate({
+        id: 'theme.SearchModal.noResultsScreen.suggestedQueryText',
+        message: 'Try searching for',
+        description:
+          'The text for the suggested query when no results are found for the following search',
+      }),
+      reportMissingResultsText: translate({
+        id: 'theme.SearchModal.noResultsScreen.reportMissingResultsText',
+        message: 'Believe this query should return results?',
+        description:
+          'The text for the question where the user thinks there are missing results',
+      }),
+      reportMissingResultsLinkText: translate({
+        id: 'theme.SearchModal.noResultsScreen.reportMissingResultsLinkText',
+        message: 'Let us know.',
+        description: 'The text for the link to report missing results',
+      }),
+    },
+  },
+  placeholder: translate({
+    id: 'theme.SearchModal.placeholder',
+    message: 'Search docs',
+    description: 'The placeholder of the input of the DocSearch pop-up modal',
+  }),
+};
+
+export default translations;

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

@@ -0,0 +1,42 @@
+/**
+ * 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 '@docusaurus/theme-search-algolia' {
+  import type {DeepPartial} from 'utility-types';
+
+  export type ThemeConfig = {
+    algolia: {
+      contextualSearch: boolean;
+      externalUrlRegex?: string;
+      appId: string;
+      apiKey: string;
+      indexName: string;
+      searchParameters: {[key: string]: unknown};
+      searchPagePath: string | false | null;
+    };
+  };
+  export type UserThemeConfig = DeepPartial<ThemeConfig>;
+}
+
+declare module '@docusaurus/theme-search-algolia/client' {
+  export function useAlgoliaContextualFacetFilters(): [string, string[]];
+}
+
+declare module '@theme/SearchPage' {
+  export default function SearchPage(): JSX.Element;
+}
+
+declare module '@theme/SearchBar' {
+  export default function SearchBar(): JSX.Element;
+}
+
+declare module '@theme/SearchTranslations' {
+  import type {DocSearchTranslations} from '@docsearch/react';
+
+  const translations: DocSearchTranslations & {placeholder: string};
+  export default translations;
+}

package/src/types.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.
+ */
+
+/// <reference types="@docusaurus/module-type-aliases" />
+/// <reference types="@docusaurus/theme-common" />
+/// <reference types="@docusaurus/theme-classic" />

package/src/validateThemeConfig.ts

@@ -0,0 +1,53 @@
+/**
+ * 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 {Joi} from '@docusaurus/utils-validation';
+import type {
+  ThemeConfig,
+  ThemeConfigValidationContext,
+} from '@docusaurus/types';
+
+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,
+
+  searchParameters: {},
+  searchPagePath: 'search',
+};
+
+export const Schema = Joi.object<ThemeConfig>({
+  algolia: Joi.object({
+    // Docusaurus attributes
+    contextualSearch: Joi.boolean().default(DEFAULT_CONFIG.contextualSearch),
+    externalUrlRegex: Joi.string().optional(),
+    // Algolia attributes
+    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()
+    .unknown(), // DocSearch 3 is still alpha: don't validate the rest for now
+});
+
+export function validateThemeConfig({
+  validate,
+  themeConfig,
+}: ThemeConfigValidationContext<ThemeConfig>): ThemeConfig {
+  return validate(Schema, themeConfig);
+}

package/src/__tests__/validateThemeConfig.test.js

@@ -1,121 +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('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/index.js

@@ -1,92 +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');
-const eta = require('eta');
-const {normalizeUrl, getSwizzledComponent} = require('@docusaurus/utils');
-const openSearchTemplate = require('./templates/opensearch');
-const {validateThemeConfig} = require('./validateThemeConfig');
-const {memoize} = require('lodash');
-
-const getCompiledOpenSearchTemplate = memoize(() => {
-  return eta.compile(openSearchTemplate.trim());
-});
-
-function renderOpenSearchTemplate(data) {
-  const compiled = getCompiledOpenSearchTemplate();
-  return compiled(data, eta.defaultConfig);
-}
-
-const OPEN_SEARCH_FILENAME = 'opensearch.xml';
-
-function theme(context) {
-  const {
-    baseUrl,
-    siteConfig: {title, url, favicon},
-  } = context;
-  const pageComponent = './theme/SearchPage/index.js';
-  const pagePath =
-    getSwizzledComponent(pageComponent) ||
-    path.resolve(__dirname, pageComponent);
-
-  return {
-    name: 'docusaurus-theme-search-algolia',
-
-    getThemePath() {
-      return path.resolve(__dirname, './theme');
-    },
-
-    getPathsToWatch() {
-      return [pagePath];
-    },
-
-    async contentLoaded({actions: {addRoute}}) {
-      addRoute({
-        path: normalizeUrl([baseUrl, 'search']),
-        component: pagePath,
-        exact: true,
-      });
-    },
-
-    async postBuild({outDir}) {
-      try {
-        fs.writeFileSync(
-          path.join(outDir, OPEN_SEARCH_FILENAME),
-          renderOpenSearchTemplate({
-            title,
-            url: url + baseUrl,
-            favicon: normalizeUrl([url, baseUrl, favicon]),
-          }),
-        );
-      } catch (err) {
-        console.error(err);
-        throw new Error(`Generating OpenSearch file failed: ${err}`);
-      }
-    },
-
-    injectHtmlTags() {
-      return {
-        headTags: [
-          {
-            tagName: 'link',
-            attributes: {
-              rel: 'search',
-              type: 'application/opensearchdescription+xml',
-              title,
-              href: normalizeUrl([baseUrl, OPEN_SEARCH_FILENAME]),
-            },
-          },
-        ],
-      };
-    },
-  };
-}
-
-module.exports = theme;
-
-theme.validateThemeConfig = validateThemeConfig;

package/src/theme/SearchMetadatas/index.js

@@ -1,25 +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 SearchMetas to use Algolia-specific metadatas
-export default function AlgoliaSearchMetadatas({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>
-  );
-}

package/src/theme/hooks/useSearchQuery.js

@@ -1,44 +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, useLocation} from '@docusaurus/router';
-import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-
-const SEARCH_PARAM_QUERY = 'q';
-
-function useSearchQuery() {
-  const history = useHistory();
-  const location = useLocation();
-  const {siteConfig: {baseUrl} = {}} = useDocusaurusContext();
-
-  return {
-    searchValue:
-      (ExecutionEnvironment.canUseDOM &&
-        new URLSearchParams(location.search).get(SEARCH_PARAM_QUERY)) ||
-      '',
-    updateSearchPath: (searchValue) => {
-      const searchParams = new URLSearchParams(location.search);
-
-      if (searchValue) {
-        searchParams.set(SEARCH_PARAM_QUERY, searchValue);
-      } else {
-        searchParams.delete(SEARCH_PARAM_QUERY);
-      }
-
-      history.replace({
-        search: searchParams.toString(),
-      });
-    },
-    generateSearchPageLink: (searchValue) => {
-      // Refer to https://github.com/facebook/docusaurus/pull/2838
-      return `${baseUrl}search?q=${encodeURIComponent(searchValue)}`;
-    },
-  };
-}
-
-export default useSearchQuery;

package/src/validateThemeConfig.js

@@ -1,45 +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 {Joi} = require('@docusaurus/utils-validation');
-
-const DEFAULT_CONFIG = {
-  contextualSearch: false, // future: maybe we want to enable this by default
-
-  // 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;
-
-const Schema = Joi.object({
-  algolia: Joi.object({
-    // Docusaurus attributes
-    contextualSearch: Joi.boolean().default(DEFAULT_CONFIG.contextualSearch),
-
-    // Algolia attributes
-    appId: Joi.string().default(DEFAULT_CONFIG.appId),
-    apiKey: Joi.string().required(),
-    indexName: Joi.string().required(),
-    searchParameters: Joi.object()
-      .default(DEFAULT_CONFIG.searchParameters)
-      .unknown(),
-  })
-    .label('themeConfig.algolia')
-    .required()
-    .unknown(), // DocSearch 3 is still alpha: don't validate the rest for now
-});
-exports.Schema = Schema;
-
-exports.validateThemeConfig = function validateThemeConfig({
-  validate,
-  themeConfig,
-}) {
-  return validate(Schema, themeConfig);
-};