@docsearch/react 5.0.2 → 5.0.4

package/dist/esm/DocSearchAI-DKtAqje2.d.ts

@@ -0,0 +1,270 @@
+import { o as ToolCalls } from "./index-BijiN4hK.js";
+import { _ as StoredSearchesSectionsTranslations, a as DocSearchProps, c as DocSearchTranslations, g as ErrorScreenTranslations, h as NoResultsScreenTranslations, m as ResultsScreenTranslations, v as FooterTranslations, y as FacetBarTranslations } from "./DocSearch-2gNxdJcC.js";
+import { DocSearchRef, InitialAskAiMessage, OnAskAiToggle } from "@docsearch/core";
+import React, { JSX } from "react";
+import { AutocompleteState, BaseItem } from "@algolia/autocomplete-core";
+import "@ai-sdk/react";
+//#region src/components/ToolCall.d.ts
+type ToolCallTranslations = {
+  /** Text shown while assistant is preparing tool call. */
+  preToolCallText: string;
+  /** Text shown while assistant is performing search tool call. */
+  searchingText: string;
+  /** Text shown while assistant is finished performing tool call. */
+  toolCallResultText: string;
+  /** Text shown when the agent saved related information to memory. */
+  savedMemoryToolResultText: string;
+  /** Text shown when the agent used the memory tool to enhance results. */
+  memoryToolResultText: string;
+};
+//#endregion
+//#region src/AskAiScreen.d.ts
+type AskAiScreenTranslations = Partial<Omit<ToolCallTranslations, 'searchingText' | 'toolCallResultText'> & {
+  disclaimerText: string;
+  /** Text shown describing a singular related source. */
+  relatedSourcesText: string;
+  /** Text shown describing multiple related sources. */
+  relatedSourcesTextPlural: string;
+  thinkingText: string;
+  copyButtonText: string;
+  copyButtonCopiedText: string;
+  copyButtonTitle: string;
+  likeButtonTitle: string;
+  dislikeButtonTitle: string;
+  thanksForFeedbackText: string;
+  feedbackPanelTitle: string;
+  feedbackDetailsPlaceholder: string;
+  feedbackDisclaimerText: string;
+  feedbackSubmitButtonText: string;
+  feedbackCloseButtonTitle: string;
+  feedbackTagIncorrect: string;
+  feedbackTagNotWhatIAsked: string;
+  feedbackTagSlowOrBuggy: string;
+  feedbackTagStyleOrTone: string;
+  feedbackTagSafetyOrLegal: string;
+  feedbackTagOther: string;
+  /**
+   * Text shown while assistant is performing search tool call. Maps to
+   * `ToolCallTranslations.searchingText`.
+   */
+  duringToolCallText: string;
+  /**
+   * Text shown while assistant is finished performing tool call. Maps to
+   * `ToolCallTranslations.toolCallResultText`.
+   */
+  afterToolCallText: string;
+  /**
+   * Build the full jsx element for the aggregated search block. If provided,
+   * completely overrides the default english renderer.
+   */
+  aggregatedToolCallNode?: (queries: string[], onSearchQueryClick: (query: string) => void) => React.ReactNode;
+  /**
+   * Generate the list connective parts only (backwards compatibility).
+   * Receives full list of queries and should return translation parts for
+   * before/after/separators. Example: (qs) => ({ before: 'searched for ',
+   * separator: ', ', lastSeparator: ' and ', after: '' }).
+   */
+  aggregatedToolCallText?: (queries: string[]) => {
+    before?: string;
+    separator?: string;
+    lastSeparator?: string;
+    after?: string;
+  };
+  /** 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;
+  suggestedPromptsTitleText: string;
+}>;
+//#endregion
+//#region src/components/ui/RecentConversationsResults.d.ts
+type RecentConversationsResultsTranslations = Partial<{
+  recentConversationsTitle: string;
+  removeRecentConversationButtonTitle: string;
+}>;
+//#endregion
+//#region src/components/AskAiStartScreen.d.ts
+type AskAiStartScreenTranslations = RecentConversationsResultsTranslations & StoredSearchesSectionsTranslations;
+//#endregion
+//#region src/NewConversationScreen.d.ts
+type NewConversationTranslations = Partial<{
+  newConversationTitle: string;
+  newConversationDescription: string;
+}>;
+//#endregion
+//#region src/AskAiScreenState.d.ts
+type AskAiScreenStateTranslations = Partial<{
+  errorScreen: ErrorScreenTranslations;
+  startScreen: AskAiStartScreenTranslations;
+  noResultsScreen: NoResultsScreenTranslations;
+  resultsScreen: ResultsScreenTranslations;
+  askAiScreen: AskAiScreenTranslations;
+  newConversation: NewConversationTranslations;
+}>;
+//#endregion
+//#region src/components/AskAiSearchBox.d.ts
+type AskAiSearchBoxTranslations = Partial<{
+  clearButtonTitle: string;
+  clearButtonAriaLabel: string;
+  closeButtonText: string;
+  closeButtonAriaLabel: string;
+  placeholderText: string;
+  placeholderTextAskAi: string;
+  placeholderTextAskAiStreaming: string;
+  enterKeyHint: string;
+  enterKeyHintAskAi: string;
+  searchInputLabel: string;
+  backToKeywordSearchButtonText: string;
+  backToKeywordSearchButtonAriaLabel: string;
+  newConversationPlaceholder: string;
+  conversationHistoryTitle: string;
+  startNewConversationText: string;
+  viewConversationHistoryText: string;
+  threadDepthErrorPlaceholder: string;
+}>;
+//#endregion
+//#region src/DocSearchAskAiModal.d.ts
+type DocSearchAskAiModalTranslations = AskAiScreenStateTranslations & Partial<{
+  searchBox: AskAiSearchBoxTranslations;
+  newConversation: NewConversationTranslations;
+  footer: FooterTranslations;
+  facets: FacetBarTranslations;
+}>;
+type DocSearchAskAiModalProps = DocSearchAIProps & {
+  initialScrollY: number;
+  onAskAiToggle: OnAskAiToggle;
+  onClose?: () => void;
+  isAskAiActive?: boolean;
+  translations?: DocSearchAskAiModalTranslations;
+  isHybridModeSupported?: boolean;
+};
+declare function DocSearchAskAiModal({ appId, apiKey, askAi, maxResultsPerGroup, theme, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, insights, onAskAiToggle, interceptAskAiEvent, isAskAiActive, recentSearchesLimit, recentSearchesWithFavoritesLimit, indices, facets, isHybridModeSupported, footerAction, ...props }: DocSearchAskAiModalProps): JSX.Element;
+//#endregion
+//#region src/DocSearchAI.d.ts
+interface AskAiSearchParameters {
+  facetFilters?: string[];
+  filters?: string;
+  attributesToRetrieve?: string[];
+  restrictSearchableAttributes?: string[];
+  distinct?: boolean | number | string;
+}
+type AgentStudioSearchParameters = Record<string, Omit<AskAiSearchParameters, 'facetFilters'>>;
+interface Memory {
+  /**
+   * Determines whether or not to display the memory based tool calls.
+   *
+   * @default false
+   */
+  enabled?: boolean;
+  /**
+   * The JWT used by the agent to know which user's memory to read.
+   *
+   * @see https://www.algolia.com/doc/guides/algolia-ai/agent-studio/how-to/user-authentication
+   */
+  userToken?: string;
+}
+interface PromptSuggestions {
+  /** The name of the index where the prompt suggestions are stored. */
+  indexName: string;
+  /**
+   * The number of prompt suggestions that are retrieved and displayed.
+   *
+   * @default 3
+   */
+  hitsPerPage?: number;
+}
+interface DocSearchAskAi {
+  /**
+   * The API key to use for the ask AI feature. Your assistant will use this API
+   * key to search the index. If not provided, the API key will be used.
+   */
+  apiKey?: string;
+  /**
+   * The app ID to use for the ask AI feature. Your assistant will use this app
+   * ID to search the index. If not provided, the app ID will be used.
+   */
+  appId?: string;
+  /** The Agent Studio Agent ID to use for the Ask AI feature. */
+  agentId: string;
+  /**
+   * Enables displaying suggested questions on Ask AI's new conversation screen.
+   *
+   * @default false
+   */
+  suggestedQuestions?: boolean;
+  /**
+   * The search parameters to use for the ask AI feature. Keyed by the index
+   * name.
+   *
+   * @example
+   *   {
+   *   "INDEX_NAME": { distinct: false }
+   *   }
+   */
+  searchParameters?: AgentStudioSearchParameters;
+  /**
+   * Index names for the Agent Studio search tool on this request.
+   *
+   * Agent Studio expects names only. Put descriptions and tool defaults on the
+   * agent configuration. Put per-index runtime overrides in
+   * `searchParameters`.
+   */
+  indices?: string[];
+  /**
+   * Use custom tools driven by Agent Studio.
+   *
+   * For best performance, memoize this object with `useMemo` or define it
+   * outside the component. Inline object literals will be recreated every
+   * render but will not affect correctness.
+   */
+  tools?: ToolCalls;
+  /**
+   * Configuration for the Agent Studio memory feature.
+   *
+   * @example
+   *   { enabled: true, userToken: '{{SERVER_GENERATED_JWT_TOKEN}}' }
+   *
+   * @see https://www.algolia.com/doc/guides/algolia-ai/agent-studio/how-to/memory/overview
+   */
+  memory?: Memory;
+  /**
+   * Enables and configures prompt suggestions that are displayed during keyword
+   * search.
+   *
+   * @example
+   *   { indexName: 'docsearch-markdown_prompt_suggestions', hitsPerPage: 1 }
+   *
+   * @see https://www.algolia.com/doc/guides/algolia-ai/agent-studio/how-to/integration#prompt-suggestions
+   */
+  promptSuggestions?: PromptSuggestions;
+}
+type DocSearchAITranslations = Partial<{
+  button: DocSearchTranslations['button'];
+  modal: DocSearchAskAiModalTranslations;
+}>;
+interface DocSearchAIProps extends Omit<DocSearchProps, 'translations'> {
+  /**
+   * 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;
+  translations?: DocSearchAITranslations;
+}
+declare const DocSearchAI: React.ForwardRefExoticComponent<DocSearchAIProps & React.RefAttributes<DocSearchRef>>;
+declare function DocSearchAIInner(props: Omit<DocSearchAIProps, 'appId' | 'apiKey'>): JSX.Element;
+//#endregion
+export { DocSearchAIProps as a, Memory as c, DocSearchAskAiModalProps as d, DocSearchAskAiModalTranslations as f, DocSearchAIInner as i, PromptSuggestions as l, AskAiSearchParameters as n, DocSearchAITranslations as o, ToolCallTranslations as p, DocSearchAI as r, DocSearchAskAi as s, AgentStudioSearchParameters as t, DocSearchAskAiModal as u };
+//# sourceMappingURL=DocSearchAI-DKtAqje2.d.ts.map

package/dist/esm/{DocSearchAskAiModal-mjZ_EYK1.js → DocSearchAskAiModal-BzQZxvTY.js}

@@ -493,18 +493,16 @@ const EMPTY_SNIPPET_RESULT = {
 	hierarchy: EMPTY_HIERARCHY_HIGHLIGHT_RESULT,
 	hierarchy_camel: []
 };
-function buildRecentConversationSources({ conversations, disableUserPersonalization, setMessages, onAskAiToggle }) {
+function buildRecentConversationSources({ conversations, disableUserPersonalization, handleSelectStoredConversation }) {
 	return [{
 		sourceId: SOURCE_IDS.recentConversations,
 		getItems() {
 			if (disableUserPersonalization) return [];
 			return conversations.getAll().slice(0, MAX_RECENT_CONVERSATIONS_DISPLAYED);
 		},
-		onSelect({ item }) {
-			if (item.messages) {
-				setMessages(item.messages);
-				onAskAiToggle(true);
-			}
+		onSelect({ item, event }) {
+			if (item.type !== "askAI") return;
+			handleSelectStoredConversation(item, event);
 		}
 	}];
 }
@@ -661,7 +659,7 @@ function DocSearchAskAiModal(_ref) {
 		recentSearchesWithFavoritesLimit
 	});
 	const [stoppedStream, setStoppedStream] = React.useState(false);
-	const { chatId, messages, status, setMessages, sendMessage, stopAskAiStreaming, askAiError, sendFeedback, conversations, startNewConversation, restoreConversation } = useAskAi({
+	const { chatId, messages, status, sendMessage, stopAskAiStreaming, askAiError, sendFeedback, conversations, startNewConversation, restoreConversation } = useAskAi({
 		agentId: askAiConfigurationId,
 		apiKey: (askAiConfig === null || askAiConfig === void 0 ? void 0 : askAiConfig.apiKey) || apiKey,
 		appId: (askAiConfig === null || askAiConfig === void 0 ? void 0 : askAiConfig.appId) || appId,
@@ -755,6 +753,25 @@ function DocSearchAskAiModal(_ref) {
 		appId,
 		sendFeedback
 	]);
+	const handleSelectStoredConversation = React.useCallback((item, event) => {
+		if (isQueryEmpty(item.query) || !item.messages || item.messages.length < 1) return;
+		const hitMessages = item.messages;
+		const initialMessage = {
+			query: item.query,
+			messageId: hitMessages[0].id
+		};
+		restoreConversation(hitMessages, item.chatId);
+		if (interceptAskAiEvent === null || interceptAskAiEvent === void 0 ? void 0 : interceptAskAiEvent(initialMessage)) {
+			if (autocompleteRef.current) autocompleteRef.current.setQuery("");
+			event.preventDefault();
+			return;
+		}
+		onAskAiToggle(true, initialMessage);
+	}, [
+		interceptAskAiEvent,
+		restoreConversation,
+		onAskAiToggle
+	]);
 	if (!autocompleteRef.current) autocompleteRef.current = createAutocomplete({
 		id: "docsearch",
 		defaultActiveItemId: 0,
@@ -780,8 +797,7 @@ function DocSearchAskAiModal(_ref) {
 				return [...canHandleAskAi ? buildRecentConversationSources({
 					conversations,
 					disableUserPersonalization,
-					setMessages,
-					onAskAiToggle
+					handleSelectStoredConversation
 				}) : [], ...noQuerySources];
 			}
 			const algoliaSourcesPromise = buildQuerySources({
@@ -937,20 +953,8 @@ function DocSearchAskAiModal(_ref) {
 			onNewConversation: handleNewConversation,
 			onItemClick: (item, event) => {
 				if (item.type === "askAI" && item.query) {
-					if (item.anchor === "stored" && "messages" in item) {
-						const hitMessages = item.messages;
-						restoreConversation(hitMessages, item.chatId);
-						const initialMessage = {
-							query: item.query,
-							messageId: hitMessages[0].id
-						};
-						if (interceptAskAiEvent === null || interceptAskAiEvent === void 0 ? void 0 : interceptAskAiEvent(initialMessage)) {
-							if (autocompleteRef.current) autocompleteRef.current.setQuery("");
-							event.preventDefault();
-							return;
-						}
-						onAskAiToggle(true, initialMessage);
-					} else handleSelectAskAiQuestion(true, item.query);
+					if (item.anchor === "stored") handleSelectStoredConversation(item, event);
+					else handleSelectAskAiQuestion(true, item.query);
 					setAskAiState("initial");
 					event.preventDefault();
 					return;
@@ -972,4 +976,4 @@ function DocSearchAskAiModal(_ref) {
 
 //#endregion
 export { DocSearchAskAiModal as t };
-//# sourceMappingURL=DocSearchAskAiModal-mjZ_EYK1.js.map
+//# sourceMappingURL=DocSearchAskAiModal-BzQZxvTY.js.map