@docsearch/react 4.3.2 → 4.4.0

package/dist/esm/index.d.ts

@@ -1,4 +1,5 @@
 import { BaseItem, AutocompleteState, AutocompleteContext, AutocompleteInsightsApi, AutocompleteOptions } from '@algolia/autocomplete-core';
+import { DocSearchModalShortcuts, OnAskAiToggle } from '@docsearch/core';
 import { Hit, LiteClient, SearchParamsObject } from 'algoliasearch/lite';
 import React, { JSX } from 'react';
 import { UIMessage } from '@ai-sdk/react';
@@ -317,8 +318,10 @@ interface DocSearchProps {
     recentSearchesWithFavoritesLimit?: number;
     /**
      * Configuration for keyboard shortcuts. Allows enabling/disabling specific shortcuts.
+     *
+     * @default `{ 'Ctrl/Cmd+K': true, '/': true }`
      */
-    keyboardShortcuts?: KeyboardShortcuts;
+    keyboardShortcuts?: DocSearchModalShortcuts;
 }
 declare function DocSearch(props: DocSearchProps): JSX.Element;
 declare function DocSearchInner(props: DocSearchProps): JSX.Element;
@@ -330,7 +333,7 @@ type ButtonTranslations = Partial<{
 type DocSearchButtonProps = React.ComponentProps<'button'> & {
     theme?: DocSearchTheme;
     translations?: ButtonTranslations;
-    keyboardShortcuts?: KeyboardShortcuts;
+    keyboardShortcuts?: DocSearchModalShortcuts;
 };
 declare const DocSearchButton: React.ForwardRefExoticComponent<Omit<DocSearchButtonProps, "ref"> & React.RefAttributes<HTMLButtonElement>>;
 
@@ -385,6 +388,18 @@ type AskAiScreenTranslations = Partial<{
      * Message that's shown when user has stopped the streaming of a message.
      */
     stoppedStreamingText: string;
+    /**
+     * Error title shown if there is an error while chatting.
+     */
+    errorTitleText: string;
+    /**
+     * Message shown when thread depth limit is exceeded (AI-217 error).
+     */
+    threadDepthExceededMessage: string;
+    /**
+     * Button text for starting a new conversation after thread depth error.
+     */
+    startNewConversationButtonText: string;
 }>;
 
 type ErrorScreenTranslations = Partial<{
@@ -441,6 +456,7 @@ type SearchBoxTranslations = Partial<{
     conversationHistoryTitle: string;
     startNewConversationText: string;
     viewConversationHistoryText: string;
+    threadDepthErrorPlaceholder: string;
 }>;
 
 type ModalTranslations = Partial<{
@@ -450,12 +466,13 @@ type ModalTranslations = Partial<{
 }> & ScreenStateTranslations;
 type DocSearchModalProps = DocSearchProps & {
     initialScrollY: number;
-    onAskAiToggle: (toggle: boolean) => void;
+    onAskAiToggle: OnAskAiToggle;
     onClose?: () => void;
     isAskAiActive?: boolean;
     translations?: ModalTranslations;
+    isHybridModeSupported?: boolean;
 };
-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;
+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, isHybridModeSupported, ...props }: DocSearchModalProps): JSX.Element;
 
 interface UseDocSearchKeyboardEventsProps {
     isOpen: boolean;
@@ -469,7 +486,7 @@ interface UseDocSearchKeyboardEventsProps {
 }
 declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, onInput, isAskAiActive, onAskAiToggle, searchButtonRef, keyboardShortcuts, }: UseDocSearchKeyboardEventsProps): void;
 
-declare const version = "4.3.2";
+declare const version = "4.4.0";
 
 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 };