@docusaurus/theme-search-algolia 3.9.1 → 3.9.2-alpha.0

package/lib/client/useAlgoliaAskAi.js

@@ -43,7 +43,7 @@ export function useAlgoliaAskAi(props) {
         setIsAskAiActive(askAiToggle);
     }, []);
     const extraAskAiProps = {
-        askAi,
+        askAi: askAi,
         canHandleAskAi,
         isAskAiActive,
         onAskAiToggle,

package/lib/client/useSearchResultUrlProcessor.js

@@ -27,7 +27,7 @@ export function useSearchResultUrlProcessor() {
             return url;
         }
         // Otherwise => transform to relative URL for SPA navigation
-        const relativeUrl = `${parsedURL.pathname + parsedURL.hash}`;
+        const relativeUrl = `${parsedURL.pathname}${parsedURL.search}${parsedURL.hash}`;
         return withBaseUrl(replacePathname(relativeUrl, replaceSearchResultPathname));
     }, [withBaseUrl, externalUrlRegex, replaceSearchResultPathname]);
 }

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

@@ -5,4 +5,20 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { type ReactNode } from 'react';
-export default function SearchBar(): ReactNode;
+import type { DocSearchModalProps, DocSearchTranslations } from '@docsearch/react';
+import type { ThemeConfigAlgolia } from '@docusaurus/theme-search-algolia';
+type DocSearchProps = Omit<DocSearchModalProps, 'onClose' | 'initialScrollY'> & {
+    contextualSearch?: string;
+    externalUrlRegex?: string;
+    searchPagePath: boolean | string;
+    askAi?: Exclude<(DocSearchModalProps & {
+        askAi: unknown;
+    })['askAi'], string | undefined>;
+};
+interface DocSearchV4Props extends Omit<DocSearchProps, 'askAi'> {
+    indexName: string;
+    askAi?: ThemeConfigAlgolia['askAi'];
+    translations?: DocSearchTranslations;
+}
+export default function SearchBar(props: Partial<DocSearchV4Props>): ReactNode;
+export {};

package/lib/theme/SearchBar/index.js

@@ -217,7 +217,13 @@ function DocSearch({externalUrlRegex, ...props}) {
     </>
   );
 }
-export default function SearchBar() {
+export default function SearchBar(props) {
   const {siteConfig} = useDocusaurusContext();
-  return <DocSearch {...siteConfig.themeConfig.algolia} />;
+  const docSearchProps = {
+    ...siteConfig.themeConfig.algolia,
+    // Let props override theme config
+    // See https://github.com/facebook/docusaurus/pull/11581
+    ...props,
+  };
+  return <DocSearch {...docSearchProps} />;
 }

package/lib/validateThemeConfig.js

@@ -58,13 +58,15 @@ exports.Schema = utils_validation_1.Joi.object({
         utils_validation_1.Joi.string(), 
         // Full configuration object
         utils_validation_1.Joi.object({
-            indexName: utils_validation_1.Joi.string().required(),
-            apiKey: utils_validation_1.Joi.string().required(),
-            appId: utils_validation_1.Joi.string().required(),
             assistantId: utils_validation_1.Joi.string().required(),
+            // Optional Ask AI configuration
+            indexName: utils_validation_1.Joi.string().optional(),
+            apiKey: utils_validation_1.Joi.string().optional(),
+            appId: utils_validation_1.Joi.string().optional(),
             searchParameters: utils_validation_1.Joi.object({
                 facetFilters: FacetFiltersSchema.optional(),
             }).optional(),
+            suggestedQuestions: utils_validation_1.Joi.boolean().optional(),
         }))
             .custom((askAiInput, helpers) => {
             if (!askAiInput) {
@@ -87,6 +89,10 @@ exports.Schema = utils_validation_1.Joi.object({
                         : {}),
                 };
             }
+            // Fill in missing fields with the top-level Algolia config
+            askAiInput.indexName = askAiInput.indexName ?? algolia.indexName;
+            askAiInput.apiKey = askAiInput.apiKey ?? algolia.apiKey;
+            askAiInput.appId = askAiInput.appId ?? algolia.appId;
             if (askAiInput.searchParameters?.facetFilters === undefined &&
                 algoliaFacetFilters) {
                 askAiInput.searchParameters = askAiInput.searchParameters ?? {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-search-algolia",
-  "version": "3.9.1",
+  "version": "3.9.2-alpha.0",
   "description": "Algolia search component for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": [
@@ -33,14 +33,15 @@
     "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch"
   },
   "dependencies": {
-    "@docsearch/react": "^3.9.0 || ^4.1.0",
-    "@docusaurus/core": "3.9.1",
-    "@docusaurus/logger": "3.9.1",
-    "@docusaurus/plugin-content-docs": "3.9.1",
-    "@docusaurus/theme-common": "3.9.1",
-    "@docusaurus/theme-translations": "3.9.1",
-    "@docusaurus/utils": "3.9.1",
-    "@docusaurus/utils-validation": "3.9.1",
+    "@algolia/autocomplete-core": "^1.19.2",
+    "@docsearch/react": "^3.9.0 || ^4.3.2",
+    "@docusaurus/core": "3.9.2-alpha.0",
+    "@docusaurus/logger": "3.9.2-alpha.0",
+    "@docusaurus/plugin-content-docs": "3.9.2-alpha.0",
+    "@docusaurus/theme-common": "3.9.2-alpha.0",
+    "@docusaurus/theme-translations": "3.9.2-alpha.0",
+    "@docusaurus/utils": "3.9.2-alpha.0",
+    "@docusaurus/utils-validation": "3.9.2-alpha.0",
     "algoliasearch": "^5.37.0",
     "algoliasearch-helper": "^3.26.0",
     "clsx": "^2.0.0",
@@ -51,7 +52,7 @@
     "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.9.1"
+    "@docusaurus/module-type-aliases": "3.9.2-alpha.0"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",
@@ -60,5 +61,5 @@
   "engines": {
     "node": ">=20.0"
   },
-  "gitHead": "c0dd59f0e712f85b6053c59e46b0514b5d2d1414"
+  "gitHead": "27626cdd7a102277935f10cc4d8d3f93e211eafe"
 }

package/src/client/useAlgoliaAskAi.ts

@@ -91,7 +91,7 @@ export function useAlgoliaAskAi(props: DocSearchV4PropsLite): UseAskAiResult {
   }, []);
 
   const extraAskAiProps: UseAskAiResult['extraAskAiProps'] = {
-    askAi,
+    askAi: askAi as any,
     canHandleAskAi,
     isAskAiActive,
     onAskAiToggle,

package/src/client/useSearchResultUrlProcessor.ts

@@ -43,7 +43,7 @@ export function useSearchResultUrlProcessor(): (url: string) => string {
       }
 
       // Otherwise => transform to relative URL for SPA navigation
-      const relativeUrl = `${parsedURL.pathname + parsedURL.hash}`;
+      const relativeUrl = `${parsedURL.pathname}${parsedURL.search}${parsedURL.hash}`;
 
       return withBaseUrl(
         replacePathname(relativeUrl, replaceSearchResultPathname),

package/src/theme/SearchBar/index.tsx

@@ -61,7 +61,7 @@ type DocSearchProps = Omit<
 
 // extend DocSearchProps for v4 features
 // TODO Docusaurus v4: cleanup after we drop support for DocSearch v3
-interface DocSearchV4Props extends DocSearchProps {
+interface DocSearchV4Props extends Omit<DocSearchProps, 'askAi'> {
   indexName: string;
   askAi?: ThemeConfigAlgolia['askAi'];
   translations?: DocSearchTranslations;
@@ -199,7 +199,7 @@ function useSearchParameters({
 
 function DocSearch({externalUrlRegex, ...props}: DocSearchV4Props) {
   const navigator = useNavigator({externalUrlRegex});
-  const searchParameters = useSearchParameters({...props});
+  const searchParameters = useSearchParameters({...props} as DocSearchProps);
   const transformItems = useTransformItems(props);
   const transformSearchClient = useTransformSearchClient();
 
@@ -301,7 +301,7 @@ function DocSearch({externalUrlRegex, ...props}: DocSearchV4Props) {
               resultsFooterComponent,
             })}
             placeholder={currentPlaceholder}
-            {...props}
+            {...(props as any)}
             translations={props.translations?.modal ?? translations.modal}
             searchParameters={searchParameters}
             {...extraAskAiProps}
@@ -312,9 +312,15 @@ function DocSearch({externalUrlRegex, ...props}: DocSearchV4Props) {
   );
 }
 
-export default function SearchBar(): ReactNode {
+export default function SearchBar(props: Partial<DocSearchV4Props>): ReactNode {
   const {siteConfig} = useDocusaurusContext();
-  return (
-    <DocSearch {...(siteConfig.themeConfig.algolia as DocSearchV4Props)} />
-  );
+
+  const docSearchProps: DocSearchV4Props = {
+    ...(siteConfig.themeConfig.algolia as DocSearchV4Props),
+    // Let props override theme config
+    // See https://github.com/facebook/docusaurus/pull/11581
+    ...props,
+  };
+
+  return <DocSearch {...docSearchProps} />;
 }

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

@@ -11,12 +11,13 @@ declare module '@docsearch/react/useDocSearchKeyboardEvents';
 declare module '@docsearch/react/version';
 
 declare module '@docusaurus/theme-search-algolia' {
-  import type {DeepPartial, Overwrite} from 'utility-types';
+  import type {DeepPartial, Overwrite, Optional} from 'utility-types';
 
   import type {DocSearchProps} from '@docsearch/react';
   import type {FacetFilters} from 'algoliasearch/lite';
 
   // The config after normalization (e.g. AskAI string -> object)
+  // This matches DocSearch v4.3+ AskAi configuration
   export type AskAiConfig = {
     indexName: string;
     apiKey: string;
@@ -25,6 +26,7 @@ declare module '@docusaurus/theme-search-algolia' {
     searchParameters?: {
       facetFilters?: FacetFilters;
     };
+    suggestedQuestions?: boolean;
   };
 
   // DocSearch props that Docusaurus exposes directly through props forwarding
@@ -70,7 +72,9 @@ declare module '@docusaurus/theme-search-algolia' {
         apiKey: ThemeConfigAlgolia['apiKey'];
         indexName: ThemeConfigAlgolia['indexName'];
         // askAi also accepts a shorter string form
-        askAi?: string | AskAiConfig;
+        askAi?:
+          | string
+          | Optional<AskAiConfig, 'indexName' | 'appId' | 'apiKey'>;
       }
     >;
   };

package/src/validateThemeConfig.ts

@@ -67,13 +67,15 @@ export const Schema = Joi.object<ThemeConfig>({
         Joi.string(),
         // Full configuration object
         Joi.object({
-          indexName: Joi.string().required(),
-          apiKey: Joi.string().required(),
-          appId: Joi.string().required(),
           assistantId: Joi.string().required(),
+          // Optional Ask AI configuration
+          indexName: Joi.string().optional(),
+          apiKey: Joi.string().optional(),
+          appId: Joi.string().optional(),
           searchParameters: Joi.object({
             facetFilters: FacetFiltersSchema.optional(),
           }).optional(),
+          suggestedQuestions: Joi.boolean().optional(),
         }),
       )
       .custom(
@@ -102,6 +104,10 @@ export const Schema = Joi.object<ThemeConfig>({
             } satisfies ThemeConfigAlgolia['askAi'];
           }
 
+          // Fill in missing fields with the top-level Algolia config
+          askAiInput.indexName = askAiInput.indexName ?? algolia.indexName;
+          askAiInput.apiKey = askAiInput.apiKey ?? algolia.apiKey;
+          askAiInput.appId = askAiInput.appId ?? algolia.appId;
           if (
             askAiInput.searchParameters?.facetFilters === undefined &&
             algoliaFacetFilters
@@ -109,6 +115,7 @@ export const Schema = Joi.object<ThemeConfig>({
             askAiInput.searchParameters = askAiInput.searchParameters ?? {};
             askAiInput.searchParameters.facetFilters = algoliaFacetFilters;
           }
+
           return askAiInput;
         },
       )