@docsearch/react 4.5.0-beta.2 → 4.5.0

package/dist/esm/Sidepanel.d.ts

@@ -7,8 +7,9 @@ type AskAiSearchParameters = {
     filters?: string;
     attributesToRetrieve?: string[];
     restrictSearchableAttributes?: string[];
-    distinct?: boolean;
+    distinct?: boolean | number | string;
 };
+type AgentStudioSearchParameters = Record<string, Omit<AskAiSearchParameters, 'facetFilters'>>;
 
 type AlgoliaLogoTranslations = Partial<{
     poweredByText: string;
@@ -70,6 +71,10 @@ type ConversationScreenTranslations = Partial<ToolCallTranslations & {
      * Message displayed after feedback action.
      **/
     thanksForFeedbackText: string;
+    /**
+     * Error title shown if there is an error while chatting.
+     */
+    errorTitleText: any;
 }>;
 
 type NewConversationScreenTranslations = Partial<{
@@ -161,7 +166,7 @@ type SidepanelTranslations = Partial<{
      **/
     logo: AlgoliaLogoTranslations;
 }>;
-type SidepanelProps = {
+type SidepanelProps$1 = {
     /**
      * Variant of the Sidepanel positioning.
      *
@@ -219,12 +224,13 @@ type SidepanelProps = {
     keyboardShortcuts?: SidepanelShortcuts;
     useStagingEnv?: boolean;
 };
-declare const Sidepanel: React.ForwardRefExoticComponent<Omit<DocSearchSidepanelProps, "button" | "panel"> & SidepanelProps & {
+type Props$1 = Omit<DocSearchSidepanelProps, 'button' | 'panel'> & SidepanelProps$1 & SidepanelSearchParameters & {
     isOpen?: boolean;
     onOpen: () => void;
     onClose: () => void;
     initialMessage?: InitialAskAiMessage;
-} & React.RefAttributes<SidepanelRef>>;
+};
+declare const Sidepanel: React.ForwardRefExoticComponent<Props$1 & React.RefAttributes<SidepanelRef>>;
 
 type SidepanelButtonTranslations = Partial<{
     /**
@@ -265,58 +271,40 @@ type SidepanelButtonProps = {
 type Props = React.ComponentProps<'button'> & SidepanelButtonProps;
 declare const SidepanelButton: ({ variant, keyboardShortcuts, translations, ...props }: Props) => JSX.Element;
 
-type DocSearchSidepanelProps = DocSearchCallbacks & {
+type SidepanelSearchParameters = {
     /**
-     * The assistant ID to use for the ask AI feature.
-     */
-    assistantId: string;
-    /**
-     * Public api key with search permissions for the index.
-     */
-    apiKey: string;
-    /**
-     * Algolia application id used by the search client.
-     */
-    appId: string;
-    /**
-     * The index name to use for the ask AI feature. Your assistant will search this index for relevant documents.
-     */
-    indexName: string;
-    /**
-     * The search parameters to use for the ask AI feature.
-     */
-    searchParameters?: AskAiSearchParameters;
-    /**
-     * Configuration for keyboard shortcuts. Allows enabling/disabling specific shortcuts.
+     * **Experimental:** Whether to use Agent Studio as the chat backend.
      *
-     * @default `{ 'Ctrl/Cmd+I': true }`
-     */
-    keyboardShortcuts?: SidepanelShortcuts;
-    /**
-     * Theme overrides applied to the Sidepanel button and panel.
+     * This is an experimental feature and its API may change without notice in future releases.
+     * Use with caution in production environments.
      *
-     * @default 'light'
-     */
-    theme?: DocSearchTheme;
-    /**
-     * Props specific to the Sidepanel button.
+     * @default false
      */
-    button?: Omit<SidepanelButtonProps, 'keyboardShortcuts'>;
+    agentStudio?: never;
     /**
-     * Props specific to the Sidepanel panel.
+     * The search parameters to use for the ask AI feature.
+     *
+     * **NOTE**: If using `agentStudio = true`, the `searchParameters` object is
+     * keyed by the index name.
      */
-    panel?: Omit<SidepanelProps, 'keyboardShortcuts'>;
+    searchParameters?: AskAiSearchParameters;
+} | {
+    agentStudio: false;
+    searchParameters?: AskAiSearchParameters;
+} | {
+    agentStudio: true;
     /**
-     * **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.
+     * The search parameters to use for the ask AI feature.
+     * Keyed by the index name.
      *
-     * @default false
+     * @example
+     * {
+     *   "INDEX_NAME": { distinct: false }
+     * }
      */
-    agentStudio?: boolean;
+    searchParameters?: AgentStudioSearchParameters;
 };
-declare const DocSearchSidepanel: React.ForwardRefExoticComponent<DocSearchCallbacks & {
+type DocSearchSidepanelProps = DocSearchCallbacks & {
     /**
      * The assistant ID to use for the ask AI feature.
      */
@@ -333,10 +321,6 @@ declare const DocSearchSidepanel: React.ForwardRefExoticComponent<DocSearchCallb
      * The index name to use for the ask AI feature. Your assistant will search this index for relevant documents.
      */
     indexName: string;
-    /**
-     * The search parameters to use for the ask AI feature.
-     */
-    searchParameters?: AskAiSearchParameters;
     /**
      * Configuration for keyboard shortcuts. Allows enabling/disabling specific shortcuts.
      *
@@ -352,21 +336,14 @@ declare const DocSearchSidepanel: React.ForwardRefExoticComponent<DocSearchCallb
     /**
      * Props specific to the Sidepanel button.
      */
-    button?: Omit<SidepanelButtonProps, "keyboardShortcuts">;
+    button?: Omit<SidepanelButtonProps, 'keyboardShortcuts'>;
     /**
      * Props specific to the Sidepanel panel.
      */
-    panel?: Omit<SidepanelProps, "keyboardShortcuts">;
-    /**
-     * **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;
-} & React.RefAttributes<DocSearchRef>>;
+    panel?: Omit<SidepanelProps$1, 'keyboardShortcuts'>;
+};
+type SidepanelProps = DocSearchSidepanelProps & SidepanelSearchParameters;
+declare const DocSearchSidepanel: React.ForwardRefExoticComponent<SidepanelProps & React.RefAttributes<DocSearchRef>>;
 
 export { DocSearchSidepanel, Sidepanel, SidepanelButton };
-export type { ButtonVariant, DocSearchSidepanelProps, SidepanelButtonProps, SidepanelButtonTranslations, SidepanelProps, SidepanelRef, SidepanelTranslations };
+export type { ButtonVariant, DocSearchSidepanelProps, SidepanelButtonProps, SidepanelButtonTranslations, SidepanelProps$1 as SidepanelProps, SidepanelRef, SidepanelSearchParameters, SidepanelTranslations };