@docsearch/react 4.0.1 → 4.2.0

package/dist/esm/index.d.ts

@@ -119,7 +119,9 @@ interface SearchIndexTool {
         hits?: any[];
     };
 }
-type AIMessage = UIMessage<unknown, UIDataTypes, {
+type AIMessage = UIMessage<{
+    stopped?: boolean;
+}, UIDataTypes, {
     searchIndex: SearchIndexTool;
 }>;
 
@@ -128,7 +130,8 @@ 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[];
 };
 
@@ -141,6 +144,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 +174,7 @@ type DocSearchAskAi = {
     /**
      * The search parameters to use for the ask AI feature.
      */
-    searchParameters?: {
-        facetFilters?: SearchParamsObject['facetFilters'];
-    };
+    searchParameters?: AskAiSearchParameters;
 };
 interface DocSearchIndex {
     name: string;
@@ -309,6 +317,11 @@ type FooterTranslations = Partial<{
     poweredByText: string;
 }>;
 
+type NewConversationTranslations = Partial<{
+    newConversationTitle: string;
+    newConversationDescription: string;
+}>;
+
 type AskAiScreenTranslations = Partial<{
     disclaimerText: string;
     relatedSourcesText: string;
@@ -338,6 +351,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 +371,7 @@ type NoResultsScreenTranslations = Partial<{
 
 type ResultsScreenTranslations = Partial<{
     askAiPlaceholder: string;
+    noResultsAskAiPlaceholder: string;
 }>;
 
 type StartScreenTranslations = Partial<{
@@ -373,6 +391,7 @@ type ScreenStateTranslations = Partial<{
     noResultsScreen: NoResultsScreenTranslations;
     resultsScreen: ResultsScreenTranslations;
     askAiScreen: AskAiScreenTranslations;
+    newConversation: NewConversationTranslations;
 }>;
 
 type SearchBoxTranslations = Partial<{
@@ -388,10 +407,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 & {
@@ -416,7 +440,7 @@ interface UseDocSearchKeyboardEventsProps {
 }
 declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, onInput, isAskAiActive, onAskAiToggle, searchButtonRef, keyboardShortcuts, }: UseDocSearchKeyboardEventsProps): void;
 
-declare const version = "4.0.1";
+declare const version = "4.2.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 type { AskAiSearchParameters, ButtonTranslations, DocSearchAskAi, DocSearchButtonProps, DocSearchHit, DocSearchIndex, DocSearchModalProps, DocSearchProps, DocSearchState, DocSearchTheme, DocSearchTransformClient, DocSearchTranslations, InternalDocSearchHit, KeyboardShortcuts, ModalTranslations, StoredAskAiMessage, StoredAskAiState, StoredDocSearchHit, UseDocSearchKeyboardEventsProps };