@docsearch/react 4.6.2 → 5.0.0-beta.0

package/dist/esm/sidepanel.d.ts

@@ -0,0 +1,395 @@
+import { o as ToolCalls } from "./index-Dl8FMlR5.js";
+import "./DocSearch-Dq5Utfyb.js";
+import { AgentStudioIndices, AgentStudioSearchParameters, Memory } from "./docsearchAi.js";
+import { r as ToolCallTranslations } from "./AskAiScreenState-D0IZsCMJ.js";
+import { DocSearchCallbacks, DocSearchCallbacks as DocSearchCallbacks$1, DocSearchRef, DocSearchRef as DocSearchRef$1, DocSearchTheme, InitialAskAiMessage, SidepanelShortcuts } from "@docsearch/core";
+import React, { JSX } from "react";
+import "@ai-sdk/react";
+//#region src/AlgoliaLogo.d.ts
+type AlgoliaLogoTranslations = Partial<{
+  poweredByText: string;
+}>;
+//#endregion
+//#region src/Sidepanel/ConversationScreen.d.ts
+type ConversationScreenTranslations = Partial<ToolCallTranslations & {
+  /** Text shown as an LLM disclaimer. */
+  conversationDisclaimer: string;
+  /** Text shown while assistant is reasoning. */
+  reasoningText: string;
+  /** Text show while assistant is thinking. */
+  thinkingText: string;
+  /** Text shown describing related sources. */
+  relatedSourcesText: string;
+  /** Message that's shown when user has stopped the streaming of a message. */
+  stoppedStreamingText: string;
+  /** Text shown for copy button on code snippets. */
+  copyButtonText: string;
+  /** Message shown after clicking copy. */
+  copyButtonCopiedText: string;
+  /** Title for thumbs up feedback icon. */
+  likeButtonTitle: string;
+  /** Title for thumbs down feedback icon. */
+  dislikeButtonTitle: string;
+  /** Message displayed after feedback action. */
+  thanksForFeedbackText: string;
+  /** Title shown at the top of the negative feedback note panel. */
+  feedbackPanelTitle: string;
+  /** Placeholder for the negative feedback details textarea. */
+  feedbackDetailsPlaceholder: string;
+  /** Disclaimer shown inside the negative feedback note panel. */
+  feedbackDisclaimerText: string;
+  /** Submit button text for the negative feedback note panel. */
+  feedbackSubmitButtonText: string;
+  /** Accessible title for the negative feedback note panel close button. */
+  feedbackCloseButtonTitle: string;
+  /** Reason chip labels for the negative feedback note panel. */
+  feedbackTagIncorrect: string;
+  feedbackTagNotWhatIAsked: string;
+  feedbackTagSlowOrBuggy: string;
+  feedbackTagStyleOrTone: string;
+  feedbackTagSafetyOrLegal: string;
+  feedbackTagOther: string;
+  /** Error title shown if there is an error while chatting. */
+  errorTitleText: any;
+  suggestedPromptsTitleText: string;
+}>;
+//#endregion
+//#region src/Sidepanel/NewConversationScreen.d.ts
+type NewConversationScreenTranslations = Partial<{
+  /** Title to be shown on the new conversation/starting screen. */
+  titleText: string;
+  /** Introduction text displayed on the new conversation/starting screen. */
+  introductionText: string;
+}>;
+//#endregion
+//#region src/Sidepanel/PromptForm.d.ts
+type PromptFormTranslations = Partial<{
+  /** Initial placeholder for the prompt input. */
+  promptPlaceholderText: string;
+  /** Placeholder text for wile a conversation is streaming. */
+  promptAnsweringText: string;
+  /** Placeholder text for after a question has already been asked. */
+  promptAskAnotherQuestionText: string;
+  /** Disclaimer text displayed beneath the prompt form. */
+  promptDisclaimerText: string;
+  promptLabelText: string;
+  promptAriaLabelText: string;
+}>;
+//#endregion
+//#region src/Sidepanel/types.d.ts
+type PanelVariant = 'floating' | 'inline';
+type PanelSide = 'left' | 'right';
+//#endregion
+//#region src/Sidepanel/SidepanelHeader.d.ts
+type HeaderTranslations = Partial<{
+  /** The main title text shown on the header. */
+  title: string;
+  /** The title text shown on the conversation history screen. */
+  conversationHistoryTitle: string;
+  /** The text shown on the start a conversation button. */
+  newConversationText: string;
+  /** The text shown on the view conversation history button. */
+  viewConversationHistoryText: string;
+}>;
+//#endregion
+//#region src/Sidepanel/Sidepanel.d.ts
+/**
+ * Imperative handle exposed by the Sidepanel component for programmatic
+ * control.
+ */
+interface SidepanelRef {
+  /** Opens the sidepanel. */
+  open: () => void;
+  /** Closes the sidepanel. */
+  close: () => void;
+  /** Returns true once the component is mounted and ready. */
+  readonly isReady: boolean;
+  /** Returns true if the sidepanel is currently open. */
+  readonly isOpen: boolean;
+}
+type SidepanelTranslations = Partial<{
+  /** Translation texts for the Sidepanel header. */
+  header: HeaderTranslations;
+  /** Translation texts for the prompt form. */
+  promptForm: PromptFormTranslations;
+  /** Translation texts for the conversation screen. */
+  conversationScreen: ConversationScreenTranslations;
+  /** Translation texts for the new conversation/starting screen. */
+  newConversationScreen: NewConversationScreenTranslations;
+  /** Translation text for the Algolia logo. */
+  logo: AlgoliaLogoTranslations;
+}>;
+type SidepanelProps = Pick<DocSearchSidepanelProps, 'indices' | 'memory' | 'tools'> & {
+  /**
+   * Variant of the Sidepanel positioning.
+   *
+   * - `inline` pushes page content when opened
+   * - `floating` is positioned above all other content on page.
+   *
+   * @default 'floating'
+   */
+  variant?: PanelVariant;
+  /**
+   * Side of the page which the panel will originate from.
+   *
+   * @default 'right'
+   */
+  side?: PanelSide;
+  /**
+   * The selector of the element to push when Sidepanel opens with `inline`
+   * variant.
+   *
+   * @default `'#root, main, .app, body'`
+   */
+  pushSelector?: string;
+  /**
+   * Width of the Sidepanel (px or any CSS width).
+   *
+   * @default `360px`
+   */
+  width?: number | string;
+  /**
+   * Width when expanded (px or any CSS width).
+   *
+   * @default `580px`
+   */
+  expandedWidth?: number | string;
+  /**
+   * The container element where the panel should be portaled to.
+   *
+   * @default `document.body`
+   */
+  portalContainer?: DocumentFragment | Element | null;
+  /**
+   * Enables displaying suggested questions on new conversation screen.
+   *
+   * @default false
+   */
+  suggestedQuestions?: boolean;
+  /** Translations specific to the Sidepanel panel. */
+  translations?: SidepanelTranslations;
+  /**
+   * Configuration for keyboard shortcuts. Allows enabling/disabling specific
+   * shortcuts.
+   *
+   * @default `{ 'Ctrl/Cmd+I': true }`
+   */
+  keyboardShortcuts?: SidepanelShortcuts;
+};
+declare const Sidepanel: React.ForwardRefExoticComponent<Omit<DocSearchSidepanelProps, "indices" | "button" | "panel" | "tools" | "memory"> & Pick<DocSearchSidepanelProps, "indices" | "tools" | "memory"> & {
+  /**
+   * Variant of the Sidepanel positioning.
+   *
+   * - `inline` pushes page content when opened
+   * - `floating` is positioned above all other content on page.
+   *
+   * @default 'floating'
+   */
+  variant?: PanelVariant;
+  /**
+   * Side of the page which the panel will originate from.
+   *
+   * @default 'right'
+   */
+  side?: PanelSide;
+  /**
+   * The selector of the element to push when Sidepanel opens with `inline`
+   * variant.
+   *
+   * @default `'#root, main, .app, body'`
+   */
+  pushSelector?: string;
+  /**
+   * Width of the Sidepanel (px or any CSS width).
+   *
+   * @default `360px`
+   */
+  width?: number | string;
+  /**
+   * Width when expanded (px or any CSS width).
+   *
+   * @default `580px`
+   */
+  expandedWidth?: number | string;
+  /**
+   * The container element where the panel should be portaled to.
+   *
+   * @default `document.body`
+   */
+  portalContainer?: DocumentFragment | Element | null;
+  /**
+   * Enables displaying suggested questions on new conversation screen.
+   *
+   * @default false
+   */
+  suggestedQuestions?: boolean;
+  /** Translations specific to the Sidepanel panel. */
+  translations?: SidepanelTranslations;
+  /**
+   * Configuration for keyboard shortcuts. Allows enabling/disabling specific
+   * shortcuts.
+   *
+   * @default `{ 'Ctrl/Cmd+I': true }`
+   */
+  keyboardShortcuts?: SidepanelShortcuts;
+} & SidepanelSearchParameters & {
+  isOpen?: boolean;
+  onOpen: () => void;
+  onClose: () => void;
+  initialMessage?: InitialAskAiMessage;
+} & React.RefAttributes<SidepanelRef>>;
+//#endregion
+//#region src/Sidepanel/SidepanelButton.d.ts
+type SidepanelButtonTranslations = Partial<{
+  /**
+   * Text to be displayed when button has variant: `inline`.
+   *
+   * @default 'Ask AI'
+   */
+  buttonText: string;
+  /**
+   * Aria label text for the button.
+   *
+   * @default 'Ask AI'
+   */
+  buttonAriaLabel: string;
+}>;
+type ButtonVariant = 'floating' | 'inline';
+type SidepanelButtonProps = {
+  /**
+   * Variant of the button positioning and styling.
+   *
+   * - `inline` displays the button inline where rendered, with extra text
+   * - `floating` displays the button floating in bottom right of screen with just
+   *   icon.
+   *
+   * @default 'floating'
+   */
+  variant?: ButtonVariant;
+  /** Translations specific to the Sidepanel button. */
+  translations?: SidepanelButtonTranslations;
+  /**
+   * Configuration for keyboard shortcuts. Allows enabling/disabling specific
+   * shortcuts.
+   *
+   * @default `{ 'Ctrl/Cmd+I': true }`
+   */
+  keyboardShortcuts?: SidepanelShortcuts;
+};
+type Props = React.ComponentProps<'button'> & SidepanelButtonProps;
+declare const SidepanelButton: ({ variant, keyboardShortcuts, translations, ...props }: Props) => JSX.Element;
+//#endregion
+//#region src/Sidepanel.d.ts
+type SidepanelSearchParameters = {
+  /**
+   * The search parameters to use for the ask AI feature. Keyed by the index
+   * name.
+   *
+   * @example
+   *   {
+   *   "INDEX_NAME": { distinct: false }
+   *   }
+   */
+  searchParameters?: AgentStudioSearchParameters;
+};
+type DocSearchSidepanelProps = DocSearchCallbacks$1 & {
+  /** 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;
+  /**
+   * Configuration for keyboard shortcuts. Allows enabling/disabling specific
+   * shortcuts.
+   *
+   * @default `{ 'Ctrl/Cmd+I': true }`
+   */
+  keyboardShortcuts?: SidepanelShortcuts;
+  /**
+   * Theme overrides applied to the Sidepanel button and panel.
+   *
+   * @default 'light'
+   */
+  theme?: DocSearchTheme;
+  /** Props specific to the Sidepanel button. */
+  button?: Omit<SidepanelButtonProps, 'keyboardShortcuts'>;
+  /** Props specific to the Sidepanel panel. */
+  panel?: Omit<SidepanelProps, 'keyboardShortcuts'>;
+  /**
+   * 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;
+  /** List of dynamic indices for the Agent Studio search tool to use. */
+  indices?: AgentStudioIndices[];
+};
+declare const DocSearchSidepanel: React.ForwardRefExoticComponent<DocSearchCallbacks$1 & {
+  /** 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;
+  /**
+   * Configuration for keyboard shortcuts. Allows enabling/disabling specific
+   * shortcuts.
+   *
+   * @default `{ 'Ctrl/Cmd+I': true }`
+   */
+  keyboardShortcuts?: SidepanelShortcuts;
+  /**
+   * Theme overrides applied to the Sidepanel button and panel.
+   *
+   * @default 'light'
+   */
+  theme?: DocSearchTheme;
+  /** Props specific to the Sidepanel button. */
+  button?: Omit<SidepanelButtonProps, "keyboardShortcuts">;
+  /** Props specific to the Sidepanel panel. */
+  panel?: Omit<SidepanelProps, "keyboardShortcuts">;
+  /**
+   * 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;
+  /** List of dynamic indices for the Agent Studio search tool to use. */
+  indices?: AgentStudioIndices[];
+} & SidepanelSearchParameters & React.RefAttributes<DocSearchRef$1>>;
+//#endregion
+export { ButtonVariant, type DocSearchCallbacks, type DocSearchRef, DocSearchSidepanel, DocSearchSidepanelProps, Sidepanel, SidepanelButton, SidepanelButtonProps, SidepanelButtonTranslations, SidepanelProps, SidepanelRef, SidepanelSearchParameters, SidepanelTranslations };
+//# sourceMappingURL=sidepanel.d.ts.map