@docsearch/react 4.4.0 → 4.5.0-beta.1

package/dist/esm/index.d.ts

@@ -1,5 +1,6 @@
 import { BaseItem, AutocompleteState, AutocompleteContext, AutocompleteInsightsApi, AutocompleteOptions } from '@algolia/autocomplete-core';
-import { DocSearchModalShortcuts, OnAskAiToggle } from '@docsearch/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';
@@ -120,11 +121,26 @@ interface SearchIndexTool {
         hits?: any[];
     };
 }
+interface AgentStudioSearchTool {
+    input: {
+        index: string;
+        query: string;
+        number_of_results: number;
+        facet_filters: any | null;
+    };
+    output: {
+        hits?: any[];
+        nbHits?: number;
+        queryID?: string;
+    };
+}
+type Tools = {
+    searchIndex: SearchIndexTool;
+    algolia_search_index: AgentStudioSearchTool;
+};
 type AIMessage = UIMessage<{
     stopped?: boolean;
-}, UIDataTypes, {
-    searchIndex: SearchIndexTool;
-}>;
+}, UIDataTypes, Tools>;
 
 type StoredDocSearchHit = Omit<DocSearchHit, '_highlightResult' | '_snippetResult'>;
 type StoredAskAiMessage = AIMessage & {
@@ -182,7 +198,7 @@ type DocSearchAskAi = {
     /**
      * The assistant ID to use for the ask AI feature.
      */
-    assistantId: string | null;
+    assistantId: string;
     /**
      * The search parameters to use for the ask AI feature.
      */
@@ -193,6 +209,7 @@ type DocSearchAskAi = {
      * @default false
      */
     suggestedQuestions?: boolean;
+    useStagingEnv?: boolean;
 };
 interface DocSearchIndex {
     name: string;
@@ -223,6 +240,22 @@ 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.
+     */
+    interceptAskAiEvent?: (initialMessage: InitialAskAiMessage) => boolean | void;
+    /**
+     * **Experimental:** Whether to use Agent Studio as the chat backend.
+     *
+     * This is an experimental feature and its API may change without notice in future releases.
+     * Use with caution in production environments.
+     *
+     * @default false
+     */
+    agentStudio?: boolean;
     /**
      * Theme overrides applied to the modal and related components.
      */
@@ -323,7 +356,7 @@ interface DocSearchProps {
      */
     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<{
@@ -467,26 +500,37 @@ type ModalTranslations = Partial<{
 type DocSearchModalProps = DocSearchProps & {
     initialScrollY: number;
     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, isHybridModeSupported, ...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, agentStudio, ...props }: DocSearchModalProps): JSX.Element;
 
 interface UseDocSearchKeyboardEventsProps {
     isOpen: boolean;
     onOpen: () => void;
     onClose: () => void;
+    /**
+     * Deprecated: Still here for backwards compat.
+     *
+     * @deprecated
+     */
     onInput?: (event: KeyboardEvent) => void;
-    searchButtonRef: React.RefObject<HTMLButtonElement | null>;
+    /**
+     * Deprecated: Still here for backwards compat.
+     *
+     * @deprecated
+     */
+    searchButtonRef?: React.RefObject<HTMLButtonElement | null>;
     isAskAiActive: boolean;
     onAskAiToggle: (toggle: boolean) => void;
     keyboardShortcuts?: KeyboardShortcuts;
 }
-declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, onInput, isAskAiActive, onAskAiToggle, searchButtonRef, keyboardShortcuts, }: UseDocSearchKeyboardEventsProps): void;
+declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, isAskAiActive, onAskAiToggle, keyboardShortcuts, }: UseDocSearchKeyboardEventsProps): void;
 
-declare const version = "4.4.0";
+declare const version = "4.5.0-beta.1";
 
 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 };