@docsearch/react 4.0.0-beta.7 → 4.0.0

package/README.md

@@ -5,15 +5,15 @@ React package for [DocSearch](http://docsearch.algolia.com/), the best search ex
 ## Installation
 
 ```bash
-yarn add @docsearch/react@beta
+yarn add @docsearch/react@4
 # or
-npm install @docsearch/react@beta
+npm install @docsearch/react@4
 ```
 
 If you don’t want to use a package manager, you can use a standalone endpoint:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@beta"></script>
+<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@4"></script>
 ```
 
 ## Get started

package/dist/esm/index.d.ts

@@ -1,7 +1,8 @@
 import { BaseItem, AutocompleteState, AutocompleteContext, AutocompleteInsightsApi, AutocompleteOptions } from '@algolia/autocomplete-core';
 import { LiteClient, SearchParamsObject } from 'algoliasearch/lite';
 import React, { JSX } from 'react';
-import { Message } from '@ai-sdk/react';
+import { UIMessage } from '@ai-sdk/react';
+import { UIDataTypes } from 'ai';
 
 type ContentType = 'askAI' | 'content' | 'lvl0' | 'lvl1' | 'lvl2' | 'lvl3' | 'lvl4' | 'lvl5' | 'lvl6';
 interface DocSearchHitAttributeHighlightResult {
@@ -94,8 +95,36 @@ type InternalDocSearchHit = DocSearchHit & {
     __docsearch_parent: InternalDocSearchHit | null;
 };
 
+interface KeyboardShortcuts {
+    /**
+     * Enable/disable the Ctrl/Cmd+K shortcut to toggle the search modal.
+     *
+     * @default true
+     */
+    'Ctrl/Cmd+K'?: boolean;
+    /**
+     * Enable/disable the / shortcut to open the search modal.
+     *
+     * @default true
+     */
+    '/'?: boolean;
+}
+
+interface SearchIndexTool {
+    input: {
+        query: string;
+    };
+    output: {
+        query?: string;
+        hits?: any[];
+    };
+}
+type AIMessage = UIMessage<unknown, UIDataTypes, {
+    searchIndex: SearchIndexTool;
+}>;
+
 type StoredDocSearchHit = Omit<DocSearchHit, '_highlightResult' | '_snippetResult'>;
-type StoredAskAiMessage = Message & {
+type StoredAskAiMessage = AIMessage & {
     /** Optional user feedback on this assistant message. */
     feedback?: 'dislike' | 'like';
 };
@@ -139,6 +168,10 @@ type DocSearchAskAi = {
         facetFilters?: SearchParamsObject['facetFilters'];
     };
 };
+interface DocSearchIndex {
+    name: string;
+    searchParameters?: SearchParamsObject;
+}
 interface DocSearchProps {
     /**
      * Algolia application id used by the search client.
@@ -150,8 +183,16 @@ interface DocSearchProps {
     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}
      */
-    indexName: string;
+    indices?: Array<DocSearchIndex | string>;
     /**
      * Configuration or assistant id to enable ask ai mode. Pass a string assistant id or a full config object.
      */
@@ -166,6 +207,8 @@ interface DocSearchProps {
     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;
     /**
@@ -235,8 +278,12 @@ interface DocSearchProps {
      * @default 4
      */
     recentSearchesWithFavoritesLimit?: number;
+    /**
+     * Configuration for keyboard shortcuts. Allows enabling/disabling specific shortcuts.
+     */
+    keyboardShortcuts?: KeyboardShortcuts;
 }
-declare function DocSearch({ ...props }: DocSearchProps): JSX.Element;
+declare function DocSearch({ indexName, searchParameters, indices, ...props }: DocSearchProps): JSX.Element;
 
 type ButtonTranslations = Partial<{
     buttonText: string;
@@ -245,6 +292,7 @@ type ButtonTranslations = Partial<{
 type DocSearchButtonProps = React.ComponentProps<'button'> & {
     theme?: DocSearchTheme;
     translations?: ButtonTranslations;
+    keyboardShortcuts?: KeyboardShortcuts;
 };
 declare const DocSearchButton: React.ForwardRefExoticComponent<Omit<DocSearchButtonProps, "ref"> & React.RefAttributes<HTMLButtonElement>>;
 
@@ -353,8 +401,9 @@ type DocSearchModalProps = DocSearchProps & {
     isAskAiActive?: boolean;
     canHandleAskAi?: boolean;
     translations?: ModalTranslations;
+    indexes: DocSearchIndex[];
 };
-declare function DocSearchModal({ appId, apiKey, indexName, placeholder, askAi, searchParameters, maxResultsPerGroup, theme, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, insights, onAskAiToggle, isAskAiActive, canHandleAskAi, recentSearchesLimit, recentSearchesWithFavoritesLimit, }: DocSearchModalProps): JSX.Element;
+declare function DocSearchModal({ appId, apiKey, placeholder, askAi, maxResultsPerGroup, theme, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, insights, onAskAiToggle, isAskAiActive, canHandleAskAi, recentSearchesLimit, recentSearchesWithFavoritesLimit, indexes, }: DocSearchModalProps): JSX.Element;
 
 interface UseDocSearchKeyboardEventsProps {
     isOpen: boolean;
@@ -364,10 +413,11 @@ interface UseDocSearchKeyboardEventsProps {
     searchButtonRef: React.RefObject<HTMLButtonElement | null>;
     isAskAiActive: boolean;
     onAskAiToggle: (toggle: boolean) => void;
+    keyboardShortcuts?: KeyboardShortcuts;
 }
-declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, onInput, isAskAiActive, onAskAiToggle, searchButtonRef, }: UseDocSearchKeyboardEventsProps): void;
+declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, onInput, isAskAiActive, onAskAiToggle, searchButtonRef, keyboardShortcuts, }: UseDocSearchKeyboardEventsProps): void;
 
-declare const version = "4.0.0-beta.7";
+declare const version = "4.0.0";
 
 export { DocSearch, DocSearchButton, DocSearchModal, useDocSearchKeyboardEvents, version };
-export type { ButtonTranslations, DocSearchAskAi, DocSearchButtonProps, DocSearchHit, DocSearchModalProps, DocSearchProps, DocSearchState, DocSearchTheme, DocSearchTransformClient, DocSearchTranslations, InternalDocSearchHit, ModalTranslations, StoredAskAiMessage, StoredAskAiState, StoredDocSearchHit, UseDocSearchKeyboardEventsProps };
+export type { ButtonTranslations, DocSearchAskAi, DocSearchButtonProps, DocSearchHit, DocSearchIndex, DocSearchModalProps, DocSearchProps, DocSearchState, DocSearchTheme, DocSearchTransformClient, DocSearchTranslations, InternalDocSearchHit, KeyboardShortcuts, ModalTranslations, StoredAskAiMessage, StoredAskAiState, StoredDocSearchHit, UseDocSearchKeyboardEventsProps };