@docusaurus/theme-search-algolia 2.0.0-beta.20 → 2.0.0-beta.21

package/lib/client/index.js

@@ -4,4 +4,4 @@
  * 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';
+export { useAlgoliaContextualFacetFilters } from './useAlgoliaContextualFacetFilters';

package/lib/client/useAlgoliaContextualFacetFilters.js

@@ -4,12 +4,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import {useContextualSearchFilters} from '@docusaurus/theme-common';
+import { useContextualSearchFilters } from '@docusaurus/theme-common';
 // Translate search-engine agnostic search filters to Algolia search filters
 export function useAlgoliaContextualFacetFilters() {
-  const {locale, tags} = useContextualSearchFilters();
-  // Seems safe to convert locale->language, see AlgoliaSearchMetadata comment
-  const languageFilter = `language:${locale}`;
-  const tagsFilter = tags.map((tag) => `docusaurus_tag:${tag}`);
-  return [languageFilter, tagsFilter];
+    const { locale, tags } = useContextualSearchFilters();
+    // Seems safe to convert locale->language, see AlgoliaSearchMetadata comment
+    const languageFilter = `language:${locale}`;
+    const tagsFilter = tags.map((tag) => `docusaurus_tag:${tag}`);
+    return [languageFilter, tagsFilter];
 }

package/lib/index.js

@@ -1,107 +1,90 @@
-'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 = void 0;
-const tslib_1 = require('tslib');
-const path_1 = tslib_1.__importDefault(require('path'));
-const fs_extra_1 = tslib_1.__importDefault(require('fs-extra'));
-const eta_1 = require('eta');
-const utils_1 = require('@docusaurus/utils');
-const theme_translations_1 = require('@docusaurus/theme-translations');
-const logger_1 = tslib_1.__importDefault(require('@docusaurus/logger'));
-const opensearch_1 = tslib_1.__importDefault(require('./templates/opensearch'));
-const lodash_1 = tslib_1.__importDefault(require('lodash'));
-const getCompiledOpenSearchTemplate = lodash_1.default.memoize(() =>
-  (0, eta_1.compile)(opensearch_1.default.trim()),
-);
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const eta_1 = require("eta");
+const utils_1 = require("@docusaurus/utils");
+const theme_translations_1 = require("@docusaurus/theme-translations");
+const opensearch_1 = tslib_1.__importDefault(require("./templates/opensearch"));
+const getCompiledOpenSearchTemplate = lodash_1.default.memoize(() => (0, eta_1.compile)(opensearch_1.default.trim()));
 function renderOpenSearchTemplate(data) {
-  const compiled = getCompiledOpenSearchTemplate();
-  return compiled(data, eta_1.defaultConfig);
+    const compiled = getCompiledOpenSearchTemplate();
+    return compiled(data, eta_1.defaultConfig);
 }
 const OPEN_SEARCH_FILENAME = 'opensearch.xml';
 function themeSearchAlgolia(context) {
-  const {
-    baseUrl,
-    siteConfig: {title, url, favicon, themeConfig},
-    i18n: {currentLocale},
-  } = context;
-  const {
-    algolia: {searchPagePath},
-  } = themeConfig;
-  return {
-    name: 'docusaurus-theme-search-algolia',
-    getThemePath() {
-      return '../lib/theme';
-    },
-    getTypeScriptThemePath() {
-      return '../src/theme';
-    },
-    getDefaultCodeTranslationMessages() {
-      return (0, theme_translations_1.readDefaultCodeTranslationMessages)({
-        locale: currentLocale,
-        name: 'theme-search-algolia',
-      });
-    },
-    async contentLoaded({actions: {addRoute}}) {
-      if (searchPagePath) {
-        addRoute({
-          path: (0, utils_1.normalizeUrl)([baseUrl, searchPagePath]),
-          component: '@theme/SearchPage',
-          exact: true,
-        });
-      }
-    },
-    async postBuild({outDir}) {
-      if (searchPagePath) {
-        const siteUrl = (0, utils_1.normalizeUrl)([url, baseUrl]);
-        try {
-          await fs_extra_1.default.writeFile(
-            path_1.default.join(outDir, OPEN_SEARCH_FILENAME),
-            renderOpenSearchTemplate({
-              title,
-              siteUrl,
-              searchUrl: (0, utils_1.normalizeUrl)([siteUrl, searchPagePath]),
-              faviconUrl: favicon
-                ? (0, utils_1.normalizeUrl)([siteUrl, favicon])
-                : null,
-            }),
-          );
-        } catch (err) {
-          logger_1.default.error('Generating OpenSearch file failed.');
-          throw err;
-        }
-      }
-    },
-    injectHtmlTags() {
-      if (!searchPagePath) {
-        return {};
-      }
-      return {
-        headTags: [
-          {
-            tagName: 'link',
-            attributes: {
-              rel: 'search',
-              type: 'application/opensearchdescription+xml',
-              title,
-              href: (0, utils_1.normalizeUrl)([baseUrl, OPEN_SEARCH_FILENAME]),
-            },
-          },
-        ],
-      };
-    },
-  };
+    const { baseUrl, siteConfig: { title, url, favicon, themeConfig }, i18n: { currentLocale }, } = context;
+    const { algolia: { searchPagePath }, } = themeConfig;
+    return {
+        name: 'docusaurus-theme-search-algolia',
+        getThemePath() {
+            return '../lib/theme';
+        },
+        getTypeScriptThemePath() {
+            return '../src/theme';
+        },
+        getDefaultCodeTranslationMessages() {
+            return (0, theme_translations_1.readDefaultCodeTranslationMessages)({
+                locale: currentLocale,
+                name: 'theme-search-algolia',
+            });
+        },
+        contentLoaded({ actions: { addRoute } }) {
+            if (searchPagePath) {
+                addRoute({
+                    path: (0, utils_1.normalizeUrl)([baseUrl, searchPagePath]),
+                    component: '@theme/SearchPage',
+                    exact: true,
+                });
+            }
+        },
+        async postBuild({ outDir }) {
+            if (searchPagePath) {
+                const siteUrl = (0, utils_1.normalizeUrl)([url, baseUrl]);
+                try {
+                    await fs_extra_1.default.writeFile(path_1.default.join(outDir, OPEN_SEARCH_FILENAME), renderOpenSearchTemplate({
+                        title,
+                        siteUrl,
+                        searchUrl: (0, utils_1.normalizeUrl)([siteUrl, searchPagePath]),
+                        faviconUrl: favicon ? (0, utils_1.normalizeUrl)([siteUrl, favicon]) : null,
+                    }));
+                }
+                catch (err) {
+                    logger_1.default.error('Generating OpenSearch file failed.');
+                    throw err;
+                }
+            }
+        },
+        injectHtmlTags() {
+            if (!searchPagePath) {
+                return {};
+            }
+            return {
+                headTags: [
+                    {
+                        tagName: 'link',
+                        attributes: {
+                            rel: 'search',
+                            type: 'application/opensearchdescription+xml',
+                            title,
+                            href: (0, utils_1.normalizeUrl)([baseUrl, OPEN_SEARCH_FILENAME]),
+                        },
+                    },
+                ],
+            };
+        },
+    };
 }
 exports.default = themeSearchAlgolia;
-var validateThemeConfig_1 = require('./validateThemeConfig');
-Object.defineProperty(exports, 'validateThemeConfig', {
-  enumerable: true,
-  get: function () {
-    return validateThemeConfig_1.validateThemeConfig;
-  },
-});
+var validateThemeConfig_1 = require("./validateThemeConfig");
+Object.defineProperty(exports, "validateThemeConfig", { enumerable: true, get: function () { return validateThemeConfig_1.validateThemeConfig; } });

package/lib/templates/opensearch.js

@@ -1,11 +1,11 @@
-'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.default = `
 <?xml version="1.0" encoding="UTF-8"?>
 <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"

package/lib/theme/SearchPage/index.js

@@ -6,9 +6,9 @@
  */
 /* eslint-disable jsx-a11y/no-autofocus */
 import React, {useEffect, useState, useReducer, useRef} from 'react';
+import clsx from 'clsx';
 import algoliaSearch from 'algoliasearch/lite';
 import algoliaSearchHelper from 'algoliasearch-helper';
-import clsx from 'clsx';
 import Head from '@docusaurus/Head';
 import Link from '@docusaurus/Link';
 import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
@@ -22,8 +22,8 @@ import {
 } from '@docusaurus/theme-common';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import {useAllDocsData} from '@docusaurus/plugin-content-docs/client';
-import Layout from '@theme/Layout';
 import Translate, {translate} from '@docusaurus/Translate';
+import Layout from '@theme/Layout';
 import styles from './styles.module.css';
 // Very simple pluralization: probably good enough for now
 function useDocumentsFoundPlural() {

package/lib/validateThemeConfig.d.ts

@@ -11,5 +11,5 @@ export declare const DEFAULT_CONFIG: {
     searchParameters: {};
     searchPagePath: string;
 };
-export declare const Schema: Joi.ObjectSchema<any>;
+export declare const Schema: Joi.ObjectSchema<ThemeConfig>;
 export declare function validateThemeConfig({ validate, themeConfig, }: ThemeConfigValidationContext<ThemeConfig>): ThemeConfig;

package/lib/validateThemeConfig.js

@@ -1,50 +1,44 @@
-'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,
-  searchParameters: {},
-  searchPagePath: 'search',
+    // 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
+    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.20",
+  "version": "2.0.0-beta.21",
   "description": "Algolia search component for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": [
@@ -21,22 +21,21 @@
   },
   "license": "MIT",
   "scripts": {
-    "build": "yarn build:server && yarn build:client && yarn build:copy && yarn build:format",
-    "build:server": "tsc --project tsconfig.server.json",
-    "build:client": "tsc --project tsconfig.client.json",
-    "build:copy": "node copyUntypedFiles.mjs",
-    "build:format": "prettier --config ../../.prettierrc --write \"lib/**/*.js\""
+    "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",
-    "@docusaurus/core": "2.0.0-beta.20",
-    "@docusaurus/logger": "2.0.0-beta.20",
-    "@docusaurus/plugin-content-docs": "2.0.0-beta.20",
-    "@docusaurus/theme-common": "2.0.0-beta.20",
-    "@docusaurus/theme-translations": "2.0.0-beta.20",
-    "@docusaurus/utils": "2.0.0-beta.20",
-    "@docusaurus/utils-validation": "2.0.0-beta.20",
-    "algoliasearch": "^4.13.0",
+    "@docsearch/react": "^3.1.0",
+    "@docusaurus/core": "2.0.0-beta.21",
+    "@docusaurus/logger": "2.0.0-beta.21",
+    "@docusaurus/plugin-content-docs": "2.0.0-beta.21",
+    "@docusaurus/theme-common": "2.0.0-beta.21",
+    "@docusaurus/theme-translations": "2.0.0-beta.21",
+    "@docusaurus/utils": "2.0.0-beta.21",
+    "@docusaurus/utils-validation": "2.0.0-beta.21",
+    "algoliasearch": "^4.13.1",
     "algoliasearch-helper": "^3.8.2",
     "clsx": "^1.1.1",
     "eta": "^1.12.3",
@@ -46,14 +45,14 @@
     "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.20"
+    "@docusaurus/module-type-aliases": "2.0.0-beta.21"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=16.14"
   },
-  "gitHead": "ed5cdba401a5948e187e927039b142a0decc702d"
+  "gitHead": "69ac49fc6909517f13615ee40290c4bd00c39df4"
 }

package/src/index.ts

@@ -7,12 +7,12 @@
 
 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 logger from '@docusaurus/logger';
 import openSearchTemplate from './templates/opensearch';
-import _ from 'lodash';
 
 import type {LoadContext, Plugin} from '@docusaurus/types';
 import type {ThemeConfig} from '@docusaurus/theme-search-algolia';
@@ -60,7 +60,7 @@ export default function themeSearchAlgolia(context: LoadContext): Plugin<void> {
       });
     },
 
-    async contentLoaded({actions: {addRoute}}) {
+    contentLoaded({actions: {addRoute}}) {
       if (searchPagePath) {
         addRoute({
           path: normalizeUrl([baseUrl, searchPagePath]),

package/src/theme/SearchBar/index.tsx

@@ -14,7 +14,6 @@ import Link from '@docusaurus/Link';
 import Head from '@docusaurus/Head';
 import {isRegexpStringMatch, useSearchPage} from '@docusaurus/theme-common';
 import {DocSearchButton, useDocSearchKeyboardEvents} from '@docsearch/react';
-import type {SearchClient} from 'algoliasearch/lite';
 import {useAlgoliaContextualFacetFilters} from '@docusaurus/theme-search-algolia/client';
 import Translate, {translate} from '@docusaurus/Translate';
 
@@ -26,6 +25,7 @@ import type {
   InternalDocSearchHit,
   StoredDocSearchHit,
 } from '@docsearch/react/dist/esm/types';
+import type {SearchClient} from 'algoliasearch/lite';
 import type {AutocompleteState} from '@algolia/autocomplete-core';
 
 type DocSearchProps = Omit<
@@ -75,7 +75,7 @@ type FacetFilters = Required<
 function mergeFacetFilters(f1: FacetFilters, f2: FacetFilters): FacetFilters {
   const normalize = (
     f: FacetFilters,
-  ): readonly string[] | ReadonlyArray<string | readonly string[]> =>
+  ): readonly string[] | readonly (string | readonly string[])[] =>
     typeof f === 'string' ? [f] : f;
   return [...normalize(f1), ...normalize(f2)] as FacetFilters;
 }
@@ -120,7 +120,9 @@ function DocSearch({
     }
 
     return Promise.all([
-      import('@docsearch/react/modal'),
+      import('@docsearch/react/modal') as Promise<
+        typeof import('@docsearch/react')
+      >,
       import('@docsearch/react/style'),
       import('./styles.css'),
     ]).then(([{DocSearchModal: Modal}]) => {

package/src/theme/SearchPage/index.tsx

@@ -8,10 +8,10 @@
 /* eslint-disable jsx-a11y/no-autofocus */
 
 import React, {useEffect, useState, useReducer, useRef} from 'react';
+import clsx from 'clsx';
 
 import algoliaSearch from 'algoliasearch/lite';
 import algoliaSearchHelper from 'algoliasearch-helper';
-import clsx from 'clsx';
 
 import Head from '@docusaurus/Head';
 import Link from '@docusaurus/Link';
@@ -26,8 +26,9 @@ import {
 } from '@docusaurus/theme-common';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import {useAllDocsData} from '@docusaurus/plugin-content-docs/client';
-import Layout from '@theme/Layout';
 import Translate, {translate} from '@docusaurus/Translate';
+import Layout from '@theme/Layout';
+
 import styles from './styles.module.css';
 import type {ThemeConfig} from '@docusaurus/theme-search-algolia';
 
@@ -236,10 +237,14 @@ function SearchPageContent(): JSX.Element {
           url,
           _highlightResult: {hierarchy},
           _snippetResult: snippet = {},
+        }: {
+          url: string;
+          _highlightResult: {hierarchy: {[key: string]: {value: string}}};
+          _snippetResult: {content?: {value: string}};
         }) => {
           const parsedURL = new URL(url);
           const titles = Object.keys(hierarchy).map((key) =>
-            sanitizeValue(hierarchy[key].value),
+            sanitizeValue(hierarchy[key]!.value),
           );
 
           return {

package/src/validateThemeConfig.ts

@@ -20,7 +20,7 @@ export const DEFAULT_CONFIG = {
   searchPagePath: 'search',
 };
 
-export const Schema = Joi.object({
+export const Schema = Joi.object<ThemeConfig>({
   algolia: Joi.object({
     // Docusaurus attributes
     contextualSearch: Joi.boolean().default(DEFAULT_CONFIG.contextualSearch),