@docsearch/react 4.1.0 → 4.3.0

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';
@@ -119,7 +119,9 @@ interface SearchIndexTool {
         hits?: any[];
     };
 }
-type AIMessage = UIMessage<unknown, UIDataTypes, {
+type AIMessage = UIMessage<{
+    stopped?: boolean;
+}, UIDataTypes, {
     searchIndex: SearchIndexTool;
 }>;
 
@@ -128,10 +130,22 @@ type StoredAskAiMessage = AIMessage & {
     /** Optional user feedback on this assistant message. */
     feedback?: 'dislike' | 'like';
 };
-type StoredAskAiState = Omit<DocSearchHit, '_highlightResult' | '_snippetResult'> & {
+type StoredAskAiState = StoredDocSearchHit & {
+    stopped?: boolean;
     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;
@@ -141,6 +155,13 @@ type DocSearchTransformClient = {
     addAlgoliaAgent: LiteClient['addAlgoliaAgent'];
     transporter: Pick<LiteClient['transporter'], 'algoliaAgent'>;
 };
+type AskAiSearchParameters = {
+    facetFilters?: string[];
+    filters?: string;
+    attributesToRetrieve?: string[];
+    restrictSearchableAttributes?: string[];
+    distinct?: boolean;
+};
 type DocSearchAskAi = {
     /**
      * The index name to use for the ask AI feature. Your assistant will search this index for relevant documents.
@@ -164,9 +185,13 @@ type DocSearchAskAi = {
     /**
      * The search parameters to use for the ask AI feature.
      */
-    searchParameters?: {
-        facetFilters?: SearchParamsObject['facetFilters'];
-    };
+    searchParameters?: AskAiSearchParameters;
+    /**
+     * Enables displaying suggested questions on Ask AI's new conversation screen.
+     *
+     * @default false
+     */
+    suggestedQuestions?: boolean;
 };
 interface DocSearchIndex {
     name: string;
@@ -221,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.
@@ -284,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;
@@ -309,6 +347,11 @@ type FooterTranslations = Partial<{
     poweredByText: string;
 }>;
 
+type NewConversationTranslations = Partial<{
+    newConversationTitle: string;
+    newConversationDescription: string;
+}>;
+
 type AskAiScreenTranslations = Partial<{
     disclaimerText: string;
     relatedSourcesText: string;
@@ -338,6 +381,10 @@ type AskAiScreenTranslations = Partial<{
         lastSeparator?: string;
         after?: string;
     };
+    /**
+     * Message that's shown when user has stopped the streaming of a message.
+     */
+    stoppedStreamingText: string;
 }>;
 
 type ErrorScreenTranslations = Partial<{
@@ -354,6 +401,7 @@ type NoResultsScreenTranslations = Partial<{
 
 type ResultsScreenTranslations = Partial<{
     askAiPlaceholder: string;
+    noResultsAskAiPlaceholder: string;
 }>;
 
 type StartScreenTranslations = Partial<{
@@ -373,6 +421,7 @@ type ScreenStateTranslations = Partial<{
     noResultsScreen: NoResultsScreenTranslations;
     resultsScreen: ResultsScreenTranslations;
     askAiScreen: AskAiScreenTranslations;
+    newConversation: NewConversationTranslations;
 }>;
 
 type SearchBoxTranslations = Partial<{
@@ -388,10 +437,15 @@ type SearchBoxTranslations = Partial<{
     searchInputLabel: string;
     backToKeywordSearchButtonText: string;
     backToKeywordSearchButtonAriaLabel: string;
+    newConversationPlaceholder: string;
+    conversationHistoryTitle: string;
+    startNewConversationText: string;
+    viewConversationHistoryText: string;
 }>;
 
 type ModalTranslations = Partial<{
     searchBox: SearchBoxTranslations;
+    newConversation: NewConversationTranslations;
     footer: FooterTranslations;
 }> & ScreenStateTranslations;
 type DocSearchModalProps = DocSearchProps & {
@@ -399,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;
@@ -416,7 +469,7 @@ interface UseDocSearchKeyboardEventsProps {
 }
 declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, onInput, isAskAiActive, onAskAiToggle, searchButtonRef, keyboardShortcuts, }: UseDocSearchKeyboardEventsProps): void;
 
-declare const version = "4.1.0";
+declare const version = "4.3.0";
 
-export { DocSearch, DocSearchButton, DocSearchModal, useDocSearchKeyboardEvents, version };
-export type { 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 };