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

package/lib/theme/SearchTranslations/index.js

@@ -0,0 +1,167 @@
+/**
+ * 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';
+const translations = {
+  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/lib/validateThemeConfig.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 declare const DEFAULT_CONFIG: {
+    contextualSearch: boolean;
+    searchParameters: {};
+    searchPagePath: string;
+};
+export declare const Schema: Joi.ObjectSchema<ThemeConfig>;
+export declare function validateThemeConfig({ validate, themeConfig, }: ThemeConfigValidationContext<ThemeConfig>): ThemeConfig;

package/lib/validateThemeConfig.js

@@ -0,0 +1,44 @@
+"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 });
+exports.validateThemeConfig = exports.Schema = exports.DEFAULT_CONFIG = void 0;
+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,
+    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().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);
+}
+exports.validateThemeConfig = validateThemeConfig;

package/package.json

@@ -1,8 +1,22 @@
 {
   "name": "@docusaurus/theme-search-algolia",
-  "version": "2.0.0-beta.ff31de0ff",
+  "version": "2.0.1",
   "description": "Algolia search component for Docusaurus.",
-  "main": "src/index.js",
+  "main": "lib/index.js",
+  "sideEffects": [
+    "*.css"
+  ],
+  "exports": {
+    "./client": {
+      "types": "./lib/client/index.d.ts",
+      "default": "./lib/client/index.js"
+    },
+    ".": {
+      "types": "./src/theme-search-algolia.d.ts",
+      "default": "./lib/index.js"
+    }
+  },
+  "types": "src/theme-search-algolia.d.ts",
   "publishConfig": {
     "access": "public"
   },
@@ -12,24 +26,39 @@
     "directory": "packages/docusaurus-theme-search-algolia"
   },
   "license": "MIT",
+  "scripts": {
+    "build": "tsc --build && node ../../admin/scripts/copyUntypedFiles.js && prettier --config ../../.prettierrc --write \"lib/theme/**/*.js\"",
+    "watch": "run-p -c copy:watch build:watch",
+    "build:watch": "tsc --build --watch",
+    "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch"
+  },
   "dependencies": {
-    "@docsearch/react": "^3.0.0-alpha.33",
-    "@docusaurus/core": "2.0.0-beta.ff31de0ff",
-    "@docusaurus/theme-common": "2.0.0-beta.ff31de0ff",
-    "@docusaurus/utils": "2.0.0-beta.ff31de0ff",
-    "@docusaurus/utils-validation": "2.0.0-beta.ff31de0ff",
-    "algoliasearch": "^4.8.4",
-    "algoliasearch-helper": "^3.3.4",
-    "clsx": "^1.1.1",
-    "eta": "^1.12.1",
-    "lodash": "^4.17.20"
+    "@docsearch/react": "^3.1.1",
+    "@docusaurus/core": "2.0.1",
+    "@docusaurus/logger": "2.0.1",
+    "@docusaurus/plugin-content-docs": "2.0.1",
+    "@docusaurus/theme-common": "2.0.1",
+    "@docusaurus/theme-translations": "2.0.1",
+    "@docusaurus/utils": "2.0.1",
+    "@docusaurus/utils-validation": "2.0.1",
+    "algoliasearch": "^4.13.1",
+    "algoliasearch-helper": "^3.10.0",
+    "clsx": "^1.2.1",
+    "eta": "^1.12.3",
+    "fs-extra": "^10.1.0",
+    "lodash": "^4.17.21",
+    "tslib": "^2.4.0",
+    "utility-types": "^3.10.0"
+  },
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "2.0.1"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=16.14"
   },
-  "gitHead": "6cacb313da4a21283fe08176097df89df836ee23"
+  "gitHead": "1ddee1c29cabf9bb52e4d78af6ebfaaabb1bc1f9"
 }

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/useAlgoliaContextualFacetFilters.js → client/useAlgoliaContextualFacetFilters.ts}

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

package/src/deps.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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';
+
+// TODO incompatible declaration file
+declare module 'eta' {
+  export const defaultConfig: object;
+
+  export function compile(
+    template: string,
+    options?: object,
+  ): (data: object, config: object) => string;
+}

package/src/index.ts

@@ -0,0 +1,116 @@
+/**
+ * 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 path from 'path';
+import fs from 'fs-extra';
+import _ from 'lodash';
+import logger from '@docusaurus/logger';
+import {defaultConfig, compile} from 'eta';
+import {normalizeUrl} from '@docusaurus/utils';
+import {readDefaultCodeTranslationMessages} from '@docusaurus/theme-translations';
+import openSearchTemplate from './templates/opensearch';
+
+import type {LoadContext, Plugin} from '@docusaurus/types';
+import type {ThemeConfig} from '@docusaurus/theme-search-algolia';
+
+const getCompiledOpenSearchTemplate = _.memoize(() =>
+  compile(openSearchTemplate.trim()),
+);
+
+function renderOpenSearchTemplate(data: {
+  title: string;
+  siteUrl: string;
+  searchUrl: string;
+  faviconUrl: string | null;
+}) {
+  const compiled = getCompiledOpenSearchTemplate();
+  return compiled(data, defaultConfig);
+}
+
+const OPEN_SEARCH_FILENAME = 'opensearch.xml';
+
+export default function themeSearchAlgolia(context: LoadContext): Plugin<void> {
+  const {
+    baseUrl,
+    siteConfig: {title, url, favicon, themeConfig},
+    i18n: {currentLocale},
+  } = context;
+  const {
+    algolia: {searchPagePath},
+  } = themeConfig as ThemeConfig;
+
+  return {
+    name: 'docusaurus-theme-search-algolia',
+
+    getThemePath() {
+      return '../lib/theme';
+    },
+    getTypeScriptThemePath() {
+      return '../src/theme';
+    },
+
+    getDefaultCodeTranslationMessages() {
+      return readDefaultCodeTranslationMessages({
+        locale: currentLocale,
+        name: 'theme-search-algolia',
+      });
+    },
+
+    contentLoaded({actions: {addRoute}}) {
+      if (searchPagePath) {
+        addRoute({
+          path: normalizeUrl([baseUrl, searchPagePath]),
+          component: '@theme/SearchPage',
+          exact: true,
+        });
+      }
+    },
+
+    async postBuild({outDir}) {
+      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: [
+          {
+            tagName: 'link',
+            attributes: {
+              rel: 'search',
+              type: 'application/opensearchdescription+xml',
+              title,
+              href: normalizeUrl([baseUrl, OPEN_SEARCH_FILENAME]),
+            },
+          },
+        ],
+      };
+    },
+  };
+}
+
+export {validateThemeConfig} from './validateThemeConfig';

package/src/templates/{opensearch.js → opensearch.ts}

@@ -5,16 +5,18 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-module.exports = `
+export default `
 <?xml version="1.0" encoding="UTF-8"?>
 <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"
                        xmlns:moz="http://www.mozilla.org/2006/browser/search/">
   <ShortName><%= it.title %></ShortName>
   <Description>Search <%= it.title %></Description>
   <InputEncoding>UTF-8</InputEncoding>
-  <Image width="16" height="16" type="image/x-icon"><%= it.favicon %></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>
+  <% if (it.faviconUrl) { _%>
+    <Image width="16" height="16" type="image/x-icon"><%= it.faviconUrl %></Image>
+  <% } _%>
+  <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>
 `;