@docusaurus/theme-search-algolia 3.4.0 → 3.5.1

package/lib/client/useAlgoliaContextualFacetFilters.js

@@ -4,10 +4,18 @@
  * 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';
-// Translate search-engine agnostic search filters to Algolia search filters
+import { DEFAULT_SEARCH_TAG } from '@docusaurus/theme-common/internal';
+import { useDocsContextualSearchTags } from '@docusaurus/plugin-content-docs/client';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+function useSearchTags() {
+    // only docs have custom search tags per version
+    const docsTags = useDocsContextualSearchTags();
+    return [DEFAULT_SEARCH_TAG, ...docsTags];
+}
+// Translate search-engine agnostic search tags to Algolia search filters
 export function useAlgoliaContextualFacetFilters() {
-    const { locale, tags } = useContextualSearchFilters();
+    const locale = useDocusaurusContext().i18n.currentLocale;
+    const tags = useSearchTags();
     // Seems safe to convert locale->language, see AlgoliaSearchMetadata comment
     const languageFilter = `language:${locale}`;
     const tagsFilter = tags.map((tag) => `docusaurus_tag:${tag}`);

package/lib/client/useAlgoliaThemeConfig.d.ts

@@ -1,3 +1,2 @@
-/// <reference path="../../src/theme-search-algolia.d.ts" />
 import type { ThemeConfig } from '@docusaurus/theme-search-algolia';
 export declare function useAlgoliaThemeConfig(): ThemeConfig;

package/lib/index.js

@@ -7,6 +7,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateThemeConfig = void 0;
+exports.default = themeSearchAlgolia;
 const utils_1 = require("@docusaurus/utils");
 const theme_translations_1 = require("@docusaurus/theme-translations");
 const opensearch_1 = require("./opensearch");
@@ -49,6 +50,5 @@ function themeSearchAlgolia(context) {
         },
     };
 }
-exports.default = themeSearchAlgolia;
 var validateThemeConfig_1 = require("./validateThemeConfig");
 Object.defineProperty(exports, "validateThemeConfig", { enumerable: true, get: function () { return validateThemeConfig_1.validateThemeConfig; } });

package/lib/opensearch.js

@@ -6,7 +6,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createOpenSearchHeadTags = exports.createOpenSearchFile = exports.shouldCreateOpenSearchFile = void 0;
+exports.shouldCreateOpenSearchFile = shouldCreateOpenSearchFile;
+exports.createOpenSearchFile = createOpenSearchFile;
+exports.createOpenSearchHeadTags = createOpenSearchHeadTags;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
@@ -25,7 +27,6 @@ function shouldCreateOpenSearchFile({ context, }) {
     const { algolia: { searchPagePath }, } = themeConfig;
     return !!searchPagePath && router !== 'hash';
 }
-exports.shouldCreateOpenSearchFile = shouldCreateOpenSearchFile;
 function createOpenSearchFileContent({ context, searchPagePath, }) {
     const { baseUrl, siteConfig: { title, url, favicon }, } = context;
     const siteUrl = (0, utils_1.normalizeUrl)([url, baseUrl]);
@@ -50,7 +51,6 @@ async function createOpenSearchFile({ context, }) {
         throw new Error('Generating OpenSearch file failed.', { cause: err });
     }
 }
-exports.createOpenSearchFile = createOpenSearchFile;
 function createOpenSearchHeadTags({ context, }) {
     const { baseUrl, siteConfig: { title }, } = context;
     return {
@@ -63,4 +63,3 @@ function createOpenSearchHeadTags({ context, }) {
         },
     };
 }
-exports.createOpenSearchHeadTags = createOpenSearchHeadTags;

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

@@ -4,5 +4,4 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference types="react" />
 export default function SearchBar(): JSX.Element;

package/lib/theme/SearchBar/index.js

@@ -90,6 +90,10 @@ function DocSearch({contextualSearch, externalUrlRegex, ...props}) {
   }, []);
   const handleInput = useCallback(
     (event) => {
+      if (event.key === 'f' && (event.metaKey || event.ctrlKey)) {
+        // ignore browser's ctrl+f
+        return;
+      }
       // prevents duplicate key insertion in the modal input
       event.preventDefault();
       setInitialQuery(event.key);

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

@@ -4,5 +4,4 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference types="react" />
 export default function SearchPage(): JSX.Element;

package/lib/theme/SearchPage/index.js

@@ -175,6 +175,8 @@ function SearchPageContent() {
     : [];
   const algoliaClient = algoliaSearch(appId, apiKey);
   const algoliaHelper = algoliaSearchHelper(algoliaClient, indexName, {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore: why errors happens after upgrading to TS 5.5 ?
     hitsPerPage: 15,
     advancedSyntax: true,
     disjunctiveFacets,

package/lib/validateThemeConfig.js

@@ -6,7 +6,8 @@
  * 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;
+exports.Schema = exports.DEFAULT_CONFIG = void 0;
+exports.validateThemeConfig = validateThemeConfig;
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
 exports.DEFAULT_CONFIG = {
@@ -54,4 +55,3 @@ exports.Schema = utils_validation_1.Joi.object({
 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": "3.4.0",
+  "version": "3.5.1",
   "description": "Algolia search component for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": [
@@ -34,13 +34,13 @@
   },
   "dependencies": {
     "@docsearch/react": "^3.5.2",
-    "@docusaurus/core": "3.4.0",
-    "@docusaurus/logger": "3.4.0",
-    "@docusaurus/plugin-content-docs": "3.4.0",
-    "@docusaurus/theme-common": "3.4.0",
-    "@docusaurus/theme-translations": "3.4.0",
-    "@docusaurus/utils": "3.4.0",
-    "@docusaurus/utils-validation": "3.4.0",
+    "@docusaurus/core": "3.5.1",
+    "@docusaurus/logger": "3.5.1",
+    "@docusaurus/plugin-content-docs": "3.5.1",
+    "@docusaurus/theme-common": "3.5.1",
+    "@docusaurus/theme-translations": "3.5.1",
+    "@docusaurus/utils": "3.5.1",
+    "@docusaurus/utils-validation": "3.5.1",
     "algoliasearch": "^4.18.0",
     "algoliasearch-helper": "^3.13.3",
     "clsx": "^2.0.0",
@@ -51,7 +51,7 @@
     "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.4.0"
+    "@docusaurus/module-type-aliases": "3.5.1"
   },
   "peerDependencies": {
     "react": "^18.0.0",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "49e9a2143274a8dd795659b417b470bc42abbd6e"
+  "gitHead": "5acbc57bd62f3f808ef72007cd67d4c410d13829"
 }

package/src/client/useAlgoliaContextualFacetFilters.ts

@@ -5,11 +5,20 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {useContextualSearchFilters} from '@docusaurus/theme-common';
+import {DEFAULT_SEARCH_TAG} from '@docusaurus/theme-common/internal';
+import {useDocsContextualSearchTags} from '@docusaurus/plugin-content-docs/client';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 
-// Translate search-engine agnostic search filters to Algolia search filters
+function useSearchTags() {
+  // only docs have custom search tags per version
+  const docsTags = useDocsContextualSearchTags();
+  return [DEFAULT_SEARCH_TAG, ...docsTags];
+}
+
+// Translate search-engine agnostic search tags to Algolia search filters
 export function useAlgoliaContextualFacetFilters(): [string, string[]] {
-  const {locale, tags} = useContextualSearchFilters();
+  const locale = useDocusaurusContext().i18n.currentLocale;
+  const tags = useSearchTags();
 
   // Seems safe to convert locale->language, see AlgoliaSearchMetadata comment
   const languageFilter = `language:${locale}`;

package/src/theme/SearchBar/index.tsx

@@ -156,6 +156,10 @@ function DocSearch({
 
   const handleInput = useCallback(
     (event: KeyboardEvent) => {
+      if (event.key === 'f' && (event.metaKey || event.ctrlKey)) {
+        // ignore browser's ctrl+f
+        return;
+      }
       // prevents duplicate key insertion in the modal input
       event.preventDefault();
       setInitialQuery(event.key);

package/src/theme/SearchPage/index.tsx

@@ -221,6 +221,8 @@ function SearchPageContent(): JSX.Element {
 
   const algoliaClient = algoliaSearch(appId, apiKey);
   const algoliaHelper = algoliaSearchHelper(algoliaClient, indexName, {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore: why errors happens after upgrading to TS 5.5 ?
     hitsPerPage: 15,
     advancedSyntax: true,
     disjunctiveFacets,