@docsearch/react 4.3.2 → 4.5.0-beta.0

package/dist/esm/index.d.ts

@@ -1,4 +1,6 @@
 import { BaseItem, AutocompleteState, AutocompleteContext, AutocompleteInsightsApi, AutocompleteOptions } from '@algolia/autocomplete-core';
+import { InitialAskAiMessage, DocSearchModalShortcuts, DocSearchRef, OnAskAiToggle } from '@docsearch/core';
+export { DocSearchRef } from '@docsearch/core';
 import { Hit, LiteClient, SearchParamsObject } from 'algoliasearch/lite';
 import React, { JSX } from 'react';
 import { UIMessage } from '@ai-sdk/react';
@@ -192,6 +194,7 @@ type DocSearchAskAi = {
      * @default false
      */
     suggestedQuestions?: boolean;
+    useStagingEnv?: boolean;
 };
 interface DocSearchIndex {
     name: string;
@@ -222,6 +225,19 @@ interface DocSearchProps {
      * Configuration or assistant id to enable ask ai mode. Pass a string assistant id or a full config object.
      */
     askAi?: DocSearchAskAi | string;
+    /**
+     * Intercept Ask AI requests (e.g. Submitting a prompt or selecting a suggested question).
+     *
+     * Return `true` to prevent the default modal Ask AI flow (no toggle, no sendMessage).
+     * Useful to route Ask AI into a different UI (e.g. `@docsearch/sidepanel-js`) without flicker.
+     */
+    /**
+     * Intercept Ask AI events (prompt submit, suggested question selection, etc).
+     *
+     * Return `true` to prevent *all* default Ask AI behavior that would normally follow
+     * (no toggle, no sendMessage, no internal Ask AI state updates).
+     */
+    interceptAskAiEvent?: (initialMessage: InitialAskAiMessage) => boolean | void;
     /**
      * Theme overrides applied to the modal and related components.
      */
@@ -317,10 +333,12 @@ 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 const DocSearch: React.ForwardRefExoticComponent<DocSearchProps & React.RefAttributes<DocSearchRef>>;
 declare function DocSearchInner(props: DocSearchProps): JSX.Element;
 
 type ButtonTranslations = Partial<{
@@ -330,7 +348,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 +403,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 +471,7 @@ type SearchBoxTranslations = Partial<{
     conversationHistoryTitle: string;
     startNewConversationText: string;
     viewConversationHistoryText: string;
+    threadDepthErrorPlaceholder: string;
 }>;
 
 type ModalTranslations = Partial<{
@@ -450,12 +481,14 @@ type ModalTranslations = Partial<{
 }> & ScreenStateTranslations;
 type DocSearchModalProps = DocSearchProps & {
     initialScrollY: number;
-    onAskAiToggle: (toggle: boolean) => void;
+    onAskAiToggle: OnAskAiToggle;
+    interceptAskAiEvent?: (initialMessage: InitialAskAiMessage) => boolean | void;
     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, interceptAskAiEvent, isAskAiActive, recentSearchesLimit, recentSearchesWithFavoritesLimit, indices, indexName, searchParameters, isHybridModeSupported, ...props }: DocSearchModalProps): JSX.Element;
 
 interface UseDocSearchKeyboardEventsProps {
     isOpen: boolean;
@@ -469,7 +502,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.5.0-beta.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 };