@docusaurus/theme-search-algolia 3.8.1-canary-6401 → 3.8.1-canary-6402

package/lib/client/useAlgoliaAskAi.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { type DocSearchModalProps, type DocSearchTranslations } from '@docsearch/react';
 import type { AskAiConfig } from '@docusaurus/theme-search-algolia';
+import type { DocSearchModalProps, DocSearchTranslations } from '@docsearch/react';
 interface DocSearchV4PropsLite {
     indexName: string;
     apiKey: string;

package/lib/client/useAlgoliaAskAi.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { useCallback, useMemo, useState } from 'react';
-import { version as docsearchVersion, } from '@docsearch/react';
+import { version as docsearchVersion } from '@docsearch/react/version';
 import translations from '@theme/SearchTranslations';
 import { useAlgoliaContextualFacetFiltersIfEnabled } from './useAlgoliaContextualFacetFilters';
 import { mergeFacetFilters } from './utils';

package/lib/docSearchVersion.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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 declare const docSearchV3: boolean;

package/lib/docSearchVersion.js

@@ -0,0 +1,13 @@
+"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.docSearchV3 = void 0;
+const react_1 = require("@docsearch/react");
+// TODO Docusaurus v4: upgrade to DocSearch v4
+//  drop v3 compat, remove this file?
+exports.docSearchV3 = react_1.version.startsWith('3.');

package/lib/index.js

@@ -11,6 +11,7 @@ exports.default = themeSearchAlgolia;
 const utils_1 = require("@docusaurus/utils");
 const theme_translations_1 = require("@docusaurus/theme-translations");
 const opensearch_1 = require("./opensearch");
+const docSearchVersion_1 = require("./docSearchVersion");
 function themeSearchAlgolia(context) {
     const { baseUrl, siteConfig: { themeConfig }, i18n: { currentLocale }, } = context;
     const { algolia: { searchPagePath }, } = themeConfig;
@@ -48,6 +49,25 @@ function themeSearchAlgolia(context) {
             }
             return {};
         },
+        configureWebpack() {
+            // TODO Docusaurus v4: remove after dropping DocSearch v3 support
+            if (docSearchVersion_1.docSearchV3) {
+                // These aliases ensure DocSearch v3 imports are compatible with
+                // the newly added DocSearch v4 entry points
+                // See https://github.com/algolia/docsearch/pull/2764
+                const docSearchV3Entry = require.resolve('@docsearch/react');
+                return {
+                    resolve: {
+                        alias: {
+                            '@docsearch/react/version': docSearchV3Entry,
+                            '@docsearch/react/useDocSearchKeyboardEvents': docSearchV3Entry,
+                            '@docsearch/react/useTheme': docSearchV3Entry,
+                        },
+                    },
+                };
+            }
+            return undefined;
+        },
     };
 }
 var validateThemeConfig_1 = require("./validateThemeConfig");

package/lib/theme/SearchBar/index.js

@@ -6,7 +6,8 @@
  */
 import React, {useCallback, useMemo, useRef, useState} from 'react';
 import {createPortal} from 'react-dom';
-import {DocSearchButton, useDocSearchKeyboardEvents} from '@docsearch/react';
+import {DocSearchButton} from '@docsearch/react/button';
+import {useDocSearchKeyboardEvents} from '@docsearch/react/useDocSearchKeyboardEvents';
 import Head from '@docusaurus/Head';
 import Link from '@docusaurus/Link';
 import {useHistory} from '@docusaurus/router';

package/lib/validateThemeConfig.js

@@ -10,7 +10,7 @@ exports.Schema = exports.DEFAULT_CONFIG = void 0;
 exports.validateThemeConfig = validateThemeConfig;
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
-const react_1 = require("@docsearch/react");
+const docSearchVersion_1 = require("./docSearchVersion");
 exports.DEFAULT_CONFIG = {
     // Enabled by default, as it makes sense in most cases
     // see also https://github.com/facebook/docusaurus/issues/5880
@@ -103,9 +103,10 @@ exports.Schema = utils_validation_1.Joi.object({
         .required()
         .unknown(),
 });
+// TODO Docusaurus v4: remove this check when we drop DocSearch v3
 function ensureAskAISupported(themeConfig) {
     // enforce DocsSearch v4 requirement when AskAI is configured
-    if (themeConfig.algolia.askAi && !react_1.version.startsWith('4.')) {
+    if (themeConfig.algolia.askAi && docSearchVersion_1.docSearchV3) {
         throw new Error('The askAi feature is only supported in DocSearch v4. ' +
             'Please upgrade to DocSearch v4 by installing "@docsearch/react": "^4.0.0" ' +
             'or remove the askAi configuration from your theme config.');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-search-algolia",
-  "version": "3.8.1-canary-6401",
+  "version": "3.8.1-canary-6402",
   "description": "Algolia search component for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": [
@@ -33,14 +33,14 @@
     "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch"
   },
   "dependencies": {
-    "@docsearch/react": "^3.9.0",
-    "@docusaurus/core": "3.8.1-canary-6401",
-    "@docusaurus/logger": "3.8.1-canary-6401",
-    "@docusaurus/plugin-content-docs": "3.8.1-canary-6401",
-    "@docusaurus/theme-common": "3.8.1-canary-6401",
-    "@docusaurus/theme-translations": "3.8.1-canary-6401",
-    "@docusaurus/utils": "3.8.1-canary-6401",
-    "@docusaurus/utils-validation": "3.8.1-canary-6401",
+    "@docsearch/react": "^3.9.0 || ^4.1.0",
+    "@docusaurus/core": "3.8.1-canary-6402",
+    "@docusaurus/logger": "3.8.1-canary-6402",
+    "@docusaurus/plugin-content-docs": "3.8.1-canary-6402",
+    "@docusaurus/theme-common": "3.8.1-canary-6402",
+    "@docusaurus/theme-translations": "3.8.1-canary-6402",
+    "@docusaurus/utils": "3.8.1-canary-6402",
+    "@docusaurus/utils-validation": "3.8.1-canary-6402",
     "algoliasearch": "^5.37.0",
     "algoliasearch-helper": "^3.26.0",
     "clsx": "^2.0.0",
@@ -51,7 +51,7 @@
     "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.8.1-canary-6401"
+    "@docusaurus/module-type-aliases": "3.8.1-canary-6402"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=20.0"
   },
-  "gitHead": "920d28b24f99406ebadf02a68010c2d998b44ff3"
+  "gitHead": "d8576f8e307990a7f8350e753b3034d5e6de53d1"
 }

package/src/client/useAlgoliaAskAi.ts

@@ -6,15 +6,15 @@
  */
 
 import {useCallback, useMemo, useState} from 'react';
-import {
-  version as docsearchVersion,
-  type DocSearchModalProps,
-  type DocSearchTranslations,
-} from '@docsearch/react';
+import {version as docsearchVersion} from '@docsearch/react/version';
 import translations from '@theme/SearchTranslations';
 import {useAlgoliaContextualFacetFiltersIfEnabled} from './useAlgoliaContextualFacetFilters';
 import {mergeFacetFilters} from './utils';
 import type {AskAiConfig} from '@docusaurus/theme-search-algolia';
+import type {
+  DocSearchModalProps,
+  DocSearchTranslations,
+} from '@docsearch/react';
 import type {FacetFilters} from 'algoliasearch/lite';
 
 // The minimal props the hook needs from DocSearch v4 props

package/src/docSearchVersion.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 {version as docSearchVersion} from '@docsearch/react';
+
+// TODO Docusaurus v4: upgrade to DocSearch v4
+//  drop v3 compat, remove this file?
+export const docSearchV3: boolean = docSearchVersion.startsWith('3.');

package/src/index.ts

@@ -12,6 +12,7 @@ import {
   createOpenSearchHeadTags,
   shouldCreateOpenSearchFile,
 } from './opensearch';
+import {docSearchV3} from './docSearchVersion';
 
 import type {LoadContext, Plugin} from '@docusaurus/types';
 import type {ThemeConfig} from '@docusaurus/theme-search-algolia';
@@ -65,6 +66,26 @@ export default function themeSearchAlgolia(context: LoadContext): Plugin<void> {
       }
       return {};
     },
+
+    configureWebpack() {
+      // TODO Docusaurus v4: remove after dropping DocSearch v3 support
+      if (docSearchV3) {
+        // These aliases ensure DocSearch v3 imports are compatible with
+        // the newly added DocSearch v4 entry points
+        // See https://github.com/algolia/docsearch/pull/2764
+        const docSearchV3Entry = require.resolve('@docsearch/react');
+        return {
+          resolve: {
+            alias: {
+              '@docsearch/react/version': docSearchV3Entry,
+              '@docsearch/react/useDocSearchKeyboardEvents': docSearchV3Entry,
+              '@docsearch/react/useTheme': docSearchV3Entry,
+            },
+          },
+        };
+      }
+      return undefined;
+    },
   };
 }
 

package/src/theme/SearchBar/index.tsx

@@ -13,7 +13,8 @@ import React, {
   type ReactNode,
 } from 'react';
 import {createPortal} from 'react-dom';
-import {DocSearchButton, useDocSearchKeyboardEvents} from '@docsearch/react';
+import {DocSearchButton} from '@docsearch/react/button';
+import {useDocSearchKeyboardEvents} from '@docsearch/react/useDocSearchKeyboardEvents';
 import Head from '@docusaurus/Head';
 import Link from '@docusaurus/Link';
 import {useHistory} from '@docusaurus/router';
@@ -73,9 +74,7 @@ function importDocSearchModalIfNeeded() {
     return Promise.resolve();
   }
   return Promise.all([
-    import('@docsearch/react/modal') as Promise<
-      typeof import('@docsearch/react')
-    >,
+    import('@docsearch/react/modal'),
     import('@docsearch/react/style'),
     import('./styles.css'),
   ]).then(([{DocSearchModal: Modal}]) => {

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

@@ -5,6 +5,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+// TODO Docusaurus v4: remove after we drop support for DocSearch v3
+declare module '@docsearch/react/button';
+declare module '@docsearch/react/useDocSearchKeyboardEvents';
+declare module '@docsearch/react/version';
+
 declare module '@docusaurus/theme-search-algolia' {
   import type {DeepPartial, Overwrite} from 'utility-types';
 

package/src/validateThemeConfig.ts

@@ -7,7 +7,7 @@
 
 import {escapeRegexp} from '@docusaurus/utils';
 import {Joi} from '@docusaurus/utils-validation';
-import {version as docsearchVersion} from '@docsearch/react';
+import {docSearchV3} from './docSearchVersion';
 import type {ThemeConfigValidationContext} from '@docusaurus/types';
 import type {
   ThemeConfig,
@@ -123,9 +123,10 @@ export const Schema = Joi.object<ThemeConfig>({
     .unknown(),
 });
 
+// TODO Docusaurus v4: remove this check when we drop DocSearch v3
 function ensureAskAISupported(themeConfig: ThemeConfig) {
   // enforce DocsSearch v4 requirement when AskAI is configured
-  if (themeConfig.algolia.askAi && !docsearchVersion.startsWith('4.')) {
+  if (themeConfig.algolia.askAi && docSearchV3) {
     throw new Error(
       'The askAi feature is only supported in DocSearch v4. ' +
         'Please upgrade to DocSearch v4 by installing "@docsearch/react": "^4.0.0" ' +