@docsearch/react 4.2.0 → 4.3.1

package/dist/esm/index.d.ts

@@ -1,5 +1,5 @@
 import { BaseItem, AutocompleteState, AutocompleteContext, AutocompleteInsightsApi, AutocompleteOptions } from '@algolia/autocomplete-core';
-import { LiteClient, SearchParamsObject } from 'algoliasearch/lite';
+import { Hit, LiteClient, SearchParamsObject } from 'algoliasearch/lite';
 import React, { JSX } from 'react';
 import { UIMessage } from '@ai-sdk/react';
 import { UIDataTypes } from 'ai';
@@ -135,6 +135,17 @@ type StoredAskAiState = StoredDocSearchHit & {
     messages?: StoredAskAiMessage[];
 };
 
+type SuggestedQuestion = {
+    appId: string;
+    assistantId: string;
+    question: string;
+    locale?: string;
+    state: 'published';
+    source: string;
+    order: number;
+};
+type SuggestedQuestionHit = Hit<SuggestedQuestion>;
+
 type DocSearchTranslations = Partial<{
     button: ButtonTranslations;
     modal: ModalTranslations;
@@ -175,6 +186,12 @@ type DocSearchAskAi = {
      * The search parameters to use for the ask AI feature.
      */
     searchParameters?: AskAiSearchParameters;
+    /**
+     * Enables displaying suggested questions on Ask AI's new conversation screen.
+     *
+     * @default false
+     */
+    suggestedQuestions?: boolean;
 };
 interface DocSearchIndex {
     name: string;
@@ -229,16 +246,28 @@ interface DocSearchProps {
     transformItems?: (items: DocSearchHit[]) => DocSearchHit[];
     /**
      * Custom component to render an individual hit.
+     * Supports template patterns:
+     * - HTML strings with html helper: (props, { html }) => html`<div>...</div>`
+     * - JSX templates: (props) => <div>...</div>
+     * - Function-based templates: (props) => string | JSX.Element | Function.
      */
     hitComponent?: (props: {
         hit: InternalDocSearchHit | StoredDocSearchHit;
         children: React.ReactNode;
+    }, helpers?: {
+        html: (template: TemplateStringsArray, ...values: any[]) => any;
     }) => JSX.Element;
     /**
      * Custom component rendered at the bottom of the results panel.
+     * Supports template patterns:
+     * - HTML strings with html helper: (props, { html }) => html`<div>...</div>`
+     * - JSX templates: (props) => <div>...</div>
+     * - Function-based templates: (props) => string | JSX.Element | Function.
      */
     resultsFooterComponent?: (props: {
         state: AutocompleteState<InternalDocSearchHit>;
+    }, helpers?: {
+        html: (template: TemplateStringsArray, ...values: any[]) => any;
     }) => JSX.Element | null;
     /**
      * Hook to wrap or modify the algolia search client.
@@ -292,6 +321,7 @@ interface DocSearchProps {
     keyboardShortcuts?: KeyboardShortcuts;
 }
 declare function DocSearch(props: DocSearchProps): JSX.Element;
+declare function DocSearchInner(props: DocSearchProps): JSX.Element;
 
 type ButtonTranslations = Partial<{
     buttonText: string;
@@ -423,10 +453,9 @@ type DocSearchModalProps = DocSearchProps & {
     onAskAiToggle: (toggle: boolean) => void;
     onClose?: () => void;
     isAskAiActive?: boolean;
-    canHandleAskAi?: boolean;
     translations?: ModalTranslations;
 };
-declare function DocSearchModal({ appId, apiKey, placeholder, askAi, maxResultsPerGroup, theme, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, insights, onAskAiToggle, isAskAiActive, canHandleAskAi, recentSearchesLimit, recentSearchesWithFavoritesLimit, indices, indexName, searchParameters, }: DocSearchModalProps): JSX.Element;
+declare function DocSearchModal({ appId, apiKey, askAi, maxResultsPerGroup, theme, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, insights, onAskAiToggle, isAskAiActive, recentSearchesLimit, recentSearchesWithFavoritesLimit, indices, indexName, searchParameters, ...props }: DocSearchModalProps): JSX.Element;
 
 interface UseDocSearchKeyboardEventsProps {
     isOpen: boolean;
@@ -440,7 +469,7 @@ interface UseDocSearchKeyboardEventsProps {
 }
 declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, onInput, isAskAiActive, onAskAiToggle, searchButtonRef, keyboardShortcuts, }: UseDocSearchKeyboardEventsProps): void;
 
-declare const version = "4.2.0";
+declare const version = "4.3.1";
 
-export { DocSearch, DocSearchButton, DocSearchModal, useDocSearchKeyboardEvents, version };
-export type { AskAiSearchParameters, ButtonTranslations, DocSearchAskAi, DocSearchButtonProps, DocSearchHit, DocSearchIndex, DocSearchModalProps, DocSearchProps, DocSearchState, DocSearchTheme, DocSearchTransformClient, DocSearchTranslations, InternalDocSearchHit, KeyboardShortcuts, ModalTranslations, StoredAskAiMessage, StoredAskAiState, StoredDocSearchHit, UseDocSearchKeyboardEventsProps };
+export { DocSearch, DocSearchButton, DocSearchInner, DocSearchModal, useDocSearchKeyboardEvents, version };
+export type { AskAiSearchParameters, ButtonTranslations, DocSearchAskAi, DocSearchButtonProps, DocSearchHit, DocSearchIndex, DocSearchModalProps, DocSearchProps, DocSearchState, DocSearchTheme, DocSearchTransformClient, DocSearchTranslations, InternalDocSearchHit, KeyboardShortcuts, ModalTranslations, StoredAskAiMessage, StoredAskAiState, StoredDocSearchHit, SuggestedQuestion, SuggestedQuestionHit, UseDocSearchKeyboardEventsProps };