@docsearch/react 4.7.0 → 5.0.0-beta.1

package/README.md

@@ -5,8 +5,6 @@ React package for [DocSearch](http://docsearch.algolia.com/), the best search ex
 ## Installation
 
 ```bash
-yarn add @docsearch/react@4
-# or
 npm install @docsearch/react@4
 ```
 

package/dist/esm/AskAiScreenState-CRHicWbN.d.ts

@@ -0,0 +1,106 @@
+import "./index-Bqqv4HmN.js";
+import { f as ResultsScreenTranslations, h as StoredSearchesSectionsTranslations, m as ErrorScreenTranslations, p as NoResultsScreenTranslations } from "./DocSearch-HJsNvtZr.js";
+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;
+  relatedSourcesText: 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
+export { NewConversationTranslations as n, ToolCallTranslations as r, AskAiScreenStateTranslations as t };
+//# sourceMappingURL=AskAiScreenState-CRHicWbN.d.ts.map

package/dist/esm/DocSearch-HJsNvtZr.d.ts

@@ -0,0 +1,295 @@
+import { a as StoredDocSearchHit, d as DocSearchHit } from "./index-Bqqv4HmN.js";
+import { t as DocSearchTheme$1 } from "./DocSearchTheme-DvL4mf0D.js";
+import { t as ButtonTranslations } from "./DocSearchButton-CZM_jACU.js";
+import { DocSearchModalShortcuts, DocSearchRef, DocSearchRef as DocSearchRef$1 } from "@docsearch/core";
+import React, { JSX } from "react";
+import { AutocompleteOptions, AutocompleteState, BaseItem } from "@algolia/autocomplete-core";
+import { LiteClient, SearchParamsObject } from "algoliasearch/lite";
+//#region src/types/InternalDocSearchHit.d.ts
+type InternalDocSearchHit = DocSearchHit & {
+  __docsearch_parent: InternalDocSearchHit | null;
+};
+//#endregion
+//#region src/components/FacetBar.d.ts
+type FacetBarTranslations = Partial<{
+  /**
+   * Label displayed as the default (all) facet option.
+   *
+   * @default 'All'
+   */
+  defaultValueLabel: string;
+  /**
+   * Facet menu trigger aria label when a facet is selected.
+   *
+   * @default 'selected'
+   */
+  facetMenuTriggerAriaLabel: string;
+  /**
+   * Label displayed for clearing all facets action.
+   *
+   * @default 'Clear all'
+   */
+  clearAllLabel: string;
+  /**
+   * Aria label for the list of possible facets.
+   *
+   * @default 'Search filters'
+   */
+  facetsAriaLabel: string;
+  /**
+   * Aria label for the list of selected facets.
+   *
+   * @default 'Selected search filters'
+   */
+  selectedFacetsAriaLabel: string;
+  /**
+   * Aria label indicating to clear a selected facet.
+   *
+   * @default 'Clear filter:'
+   */
+  clearFacetAriaLabel: string;
+}>;
+//#endregion
+//#region src/components/KeywordSearchBox.d.ts
+type KeywordSearchBoxTranslations = Partial<{
+  clearButtonTitle: string;
+  clearButtonAriaLabel: string;
+  closeButtonText: string;
+  closeButtonAriaLabel: string;
+  placeholderText: string;
+  enterKeyHint: string;
+  searchInputLabel: string;
+}>;
+//#endregion
+//#region src/Footer.d.ts
+type FooterTranslations = Partial<{
+  selectText: string;
+  submitQuestionText: string;
+  selectKeyAriaLabel: string;
+  navigateText: string;
+  navigateUpKeyAriaLabel: string;
+  navigateDownKeyAriaLabel: string;
+  closeText: string;
+  backToSearchText: string;
+  closeKeyAriaLabel: string;
+  poweredByText: string;
+}>;
+//#endregion
+//#region src/components/ui/StoredSearchesSections.d.ts
+type StoredSearchesSectionsTranslations = Partial<{
+  recentSearchesTitle: string;
+  noRecentSearchesText: string;
+  saveRecentSearchButtonTitle: string;
+  removeRecentSearchButtonTitle: string;
+  favoriteSearchesTitle: string;
+  removeFavoriteSearchButtonTitle: string;
+}>;
+//#endregion
+//#region src/components/KeywordStartScreen.d.ts
+type KeywordStartScreenTranslations = StoredSearchesSectionsTranslations;
+//#endregion
+//#region src/ErrorScreen.d.ts
+type ErrorScreenTranslations = Partial<{
+  titleText: string;
+  helpText: string;
+}>;
+//#endregion
+//#region src/NoResultsScreen.d.ts
+type NoResultsScreenTranslations = Partial<{
+  noResultsText: string;
+  suggestedQueryText: string;
+  reportMissingResultsText: string;
+  reportMissingResultsLinkText: string;
+}>;
+//#endregion
+//#region src/components/HitResultBadge.d.ts
+type HitResultBadgeTranslations = Partial<{
+  /**
+   * Label text used for screen readers to announce the result badge. Should
+   * reflect the key of `resultBadgeKey`.
+   *
+   * @default 'Category'
+   */
+  resultBadgeLabelText: string;
+}>;
+//#endregion
+//#region src/Results.d.ts
+type ResultsTranslations = HitResultBadgeTranslations & Partial<{
+  askAiPlaceholder: string;
+  noResultsAskAiPlaceholder: string;
+  recentConversationTimestampFallback: string;
+  askAiResultsTitle: string;
+}>;
+//#endregion
+//#region src/ResultsScreen.d.ts
+type ResultsScreenTranslations = Partial<{
+  askAiPlaceholder: string;
+  noResultsAskAiPlaceholder: string;
+  resultsSectionTitle: string;
+  askAiResultsTitle: string;
+}> & ResultsTranslations;
+//#endregion
+//#region src/ScreenState.d.ts
+type ScreenStateTranslations = Partial<{
+  errorScreen: ErrorScreenTranslations;
+  startScreen: KeywordStartScreenTranslations;
+  noResultsScreen: NoResultsScreenTranslations;
+  resultsScreen: ResultsScreenTranslations;
+}>;
+//#endregion
+//#region src/DocSearchModal.d.ts
+type ModalTranslations = Partial<{
+  searchBox: KeywordSearchBoxTranslations;
+  footer: FooterTranslations;
+  facets: FacetBarTranslations;
+}> & ScreenStateTranslations;
+type DocSearchModalProps = DocSearchProps & {
+  initialScrollY: number;
+  onClose?: () => void;
+  translations?: ModalTranslations;
+};
+declare function DocSearchModal({ appId, apiKey, maxResultsPerGroup, theme, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, insights, recentSearchesLimit, recentSearchesWithFavoritesLimit, indices, indexName, searchParameters, facets, ...props }: DocSearchModalProps): JSX.Element;
+//#endregion
+//#region src/DocSearch.d.ts
+type DocSearchTranslations = Partial<{
+  button: ButtonTranslations;
+  modal: ModalTranslations;
+}>;
+type DocSearchTransformClient = {
+  search: LiteClient['search'];
+  addAlgoliaAgent: LiteClient['addAlgoliaAgent'];
+  transporter: Pick<LiteClient['transporter'], 'algoliaAgent'>;
+};
+interface DocSearchIndex {
+  name: string;
+  searchParameters?: SearchParamsObject;
+}
+interface DocSearchFacet {
+  key: string;
+  label?: string;
+}
+interface DocSearchProps {
+  /** Algolia application id used by the search client. */
+  appId: string;
+  /** Public api key with search permissions for the index. */
+  apiKey: string;
+  /**
+   * Name of the algolia index to query.
+   *
+   * @deprecated `indexName` will be removed in a future version. Please use
+   *   `indices` property going forward.
+   */
+  indexName?: string;
+  /**
+   * List of indices and _optional_ searchParameters to be used for search.
+   *
+   * @see {@link https://docsearch.algolia.com/docs/api#indices}
+   */
+  indices?: Array<DocSearchIndex | string>;
+  /**
+   * Facets to display as keyword-search filter controls. Values are read
+   * dynamically from the configured Algolia indices.
+   *
+   * @default [ ]
+   */
+  facets?: DocSearchFacet[];
+  /** Theme overrides applied to the modal and related components. */
+  theme?: DocSearchTheme$1;
+  /** Placeholder text for the search input. */
+  placeholder?: string;
+  /**
+   * Additional algolia search parameters to merge into each query.
+   *
+   * @deprecated `searchParameters` will be removed in a future version. Please
+   *   use `indices` property going forward.
+   */
+  searchParameters?: SearchParamsObject;
+  /** Maximum number of hits to display per source/group. */
+  maxResultsPerGroup?: number;
+  /** Hook to post-process hits before rendering. */
+  transformItems?: (items: DocSearchHit[]) => DocSearchHit[];
+  /**
+   * Custom component to render an individual hit. Supports template patterns:
+   *
+   * - HTML strings with html helper: (props, { html }) => html`<div>...</div>`
+   * - JSX templates: (props) => <div>...</div>
+   * - Function-based templates: (props) => string | JSX.Element | Function.
+   */
+  hitComponent?: (props: {
+    hit: InternalDocSearchHit | StoredDocSearchHit;
+    children: React.ReactNode;
+  }, helpers?: {
+    html: (template: TemplateStringsArray, ...values: any[]) => any;
+  }) => JSX.Element;
+  /**
+   * Custom component rendered at the bottom of the results panel. Supports
+   * template patterns:
+   *
+   * - HTML strings with html helper: (props, { html }) => html`<div>...</div>`
+   * - JSX templates: (props) => <div>...</div>
+   * - Function-based templates: (props) => string | JSX.Element | Function.
+   */
+  resultsFooterComponent?: (props: {
+    state: AutocompleteState<InternalDocSearchHit>;
+  }, helpers?: {
+    html: (template: TemplateStringsArray, ...values: any[]) => any;
+  }) => JSX.Element | null;
+  /** Hook to wrap or modify the algolia search client. */
+  transformSearchClient?: (searchClient: DocSearchTransformClient) => DocSearchTransformClient;
+  /** Disable storage and usage of recent and favorite searches. */
+  disableUserPersonalization?: boolean;
+  /** Query string to prefill when opening the modal. */
+  initialQuery?: string;
+  /** Custom navigator for controlling link navigation. */
+  navigator?: AutocompleteOptions<InternalDocSearchHit>['navigator'];
+  /** Localized strings for the button and modal ui. */
+  translations?: DocSearchTranslations;
+  /** Builds a url to report missing results for a given query. */
+  getMissingResultsUrl?: ({ query }: {
+    query: string;
+  }) => string;
+  /** Insights client integration options to send analytics events. */
+  insights?: AutocompleteOptions<InternalDocSearchHit>['insights'];
+  /**
+   * The container element where the modal should be portaled to. Defaults to
+   * document.body.
+   */
+  portalContainer?: DocumentFragment | Element;
+  /**
+   * Limit of how many recent searches should be saved/displayed..
+   *
+   * @default 7
+   */
+  recentSearchesLimit?: number;
+  /**
+   * Limit of how many recent searches should be saved/displayed when there are
+   * favorited searches..
+   *
+   * @default 4
+   */
+  recentSearchesWithFavoritesLimit?: number;
+  /**
+   * Configuration for keyboard shortcuts. Allows enabling/disabling specific
+   * shortcuts.
+   *
+   * @default `{ 'Ctrl/Cmd+K': true, '/': true }`
+   */
+  keyboardShortcuts?: DocSearchModalShortcuts;
+  /**
+   * The key used to render a custom badge for each hit. Key must match a
+   * property returned in `searchParameters.attributesToRetrieve`.
+   *
+   * @example
+   *   'version';
+   *   'hierarchy.lvl1';
+   *   'tags[2]';
+   *
+   * @default undefined
+   */
+  resultBadgeKey?: string;
+}
+declare const DocSearch$1: React.ForwardRefExoticComponent<DocSearchProps & React.RefAttributes<DocSearchRef>>;
+declare function DocSearchInner(props: DocSearchProps): JSX.Element;
+//#endregion
+export { FacetBarTranslations as _, DocSearchProps as a, DocSearchTranslations as c, ModalTranslations as d, ResultsScreenTranslations as f, FooterTranslations as g, StoredSearchesSectionsTranslations as h, DocSearchInner as i, DocSearchModal as l, ErrorScreenTranslations as m, DocSearchFacet as n, DocSearchRef$1 as o, NoResultsScreenTranslations as p, DocSearchIndex as r, DocSearchTransformClient as s, DocSearch$1 as t, DocSearchModalProps as u, InternalDocSearchHit as v };
+//# sourceMappingURL=DocSearch-HJsNvtZr.d.ts.map

package/dist/esm/DocSearchAskAiModal-B7vpLudE.d.ts

@@ -0,0 +1,48 @@
+import "./index-Bqqv4HmN.js";
+import { _ as FacetBarTranslations, g as FooterTranslations } from "./DocSearch-HJsNvtZr.js";
+import { DocSearchAIProps } from "./docsearchAi.js";
+import { n as NewConversationTranslations, t as AskAiScreenStateTranslations } from "./AskAiScreenState-CRHicWbN.js";
+import { OnAskAiToggle } from "@docsearch/core";
+import React, { JSX } from "react";
+import { AutocompleteState } from "@algolia/autocomplete-core";
+import "@ai-sdk/react";
+//#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, indexName, searchParameters, facets, isHybridModeSupported, ...props }: DocSearchAskAiModalProps): JSX.Element;
+//#endregion
+export { DocSearchAskAiModalProps as n, DocSearchAskAiModalTranslations as r, DocSearchAskAiModal as t };
+//# sourceMappingURL=DocSearchAskAiModal-B7vpLudE.d.ts.map