@docsearch/sidepanel-js 4.4.0 → 4.5.0-beta.1

package/dist/esm/index.d.ts

@@ -8,6 +8,26 @@ interface SidepanelShortcuts {
 }
 
 type DocSearchTheme = 'dark' | 'light';
+type InitialAskAiMessage = {
+    query: string;
+    messageId?: string;
+    suggestedQuestionId?: string;
+};
+/**
+ * Lifecycle callbacks for DocSearch.
+ */
+interface DocSearchCallbacks {
+    /** Called once DocSearch is mounted and ready for interaction. */
+    onReady?: () => void;
+    /** Called when the modal opens. */
+    onOpen?: () => void;
+    /** Called when the modal closes. */
+    onClose?: () => void;
+    /** Called when the sidepanel opens. */
+    onSidepanelOpen?: () => void;
+    /** Called when the sidepanel closes. */
+    onSidepanelClose?: () => void;
+}
 
 type AskAiSearchParameters = {
     facetFilters?: string[];
@@ -21,19 +41,7 @@ type AlgoliaLogoTranslations = Partial<{
     poweredByText: string;
 }>;
 
-type ConversationScreenTranslations = Partial<{
-    /**
-     * Text shown as an LLM disclaimer.
-     */
-    conversationDisclaimer: string;
-    /**
-     * Text shown while assistant is reasoning.
-     */
-    reasoningText: string;
-    /**
-     * Text show while assistant is thinking.
-     */
-    thinkingText: string;
+type ToolCallTranslations = {
     /**
      * Text shown while assistant is preparing tool call.
      */
@@ -46,6 +54,21 @@ type ConversationScreenTranslations = Partial<{
      * Text shown while assistant is finished performing tool call.
      */
     toolCallResultText: string;
+};
+
+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.
      */
@@ -129,7 +152,6 @@ type HeaderTranslations = Partial<{
      **/
     viewConversationHistoryText: string;
 }>;
-
 type SidepanelTranslations = Partial<{
     /**
      * Translation texts for the Sidepanel header.
@@ -208,6 +230,7 @@ type SidepanelProps$1 = {
      * @default `{ 'Ctrl/Cmd+I': true }`
      */
     keyboardShortcuts?: SidepanelShortcuts;
+    useStagingEnv?: boolean;
 };
 
 type SidepanelButtonTranslations = Partial<{
@@ -247,7 +270,7 @@ type SidepanelButtonProps = {
     keyboardShortcuts?: SidepanelShortcuts;
 };
 
-type DocSearchSidepanelProps = {
+type DocSearchSidepanelProps = DocSearchCallbacks & {
     /**
      * The assistant ID to use for the ask AI feature.
      */
@@ -288,13 +311,48 @@ type DocSearchSidepanelProps = {
      * Props specific to the Sidepanel panel.
      */
     panel?: Omit<SidepanelProps$1, '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;
 };
 
-type SidepanelProps = DocSearchSidepanelProps & {
+/**
+ * Instance returned by sidepanel() for programmatic control.
+ */
+interface SidepanelInstance {
+    /** Returns true once the component is mounted and ready. */
+    readonly isReady: boolean;
+    /** Returns true if the sidepanel is currently open. */
+    readonly isOpen: boolean;
+    /** Opens the sidepanel, optionally with an initial message. */
+    open(initialMessage?: InitialAskAiMessage): void;
+    /** Closes the sidepanel. */
+    close(): void;
+    /** Unmounts the Sidepanel component and cleans up. */
+    destroy(): void;
+}
+/**
+ * Lifecycle callbacks for the Sidepanel instance.
+ */
+interface SidepanelCallbacks {
+    /** Called once Sidepanel is mounted and ready for interaction. */
+    onReady?: () => void;
+    /** Called when the sidepanel opens. */
+    onOpen?: () => void;
+    /** Called when the sidepanel closes. */
+    onClose?: () => void;
+}
+type SidepanelProps = DocSearchSidepanelProps & SidepanelCallbacks & {
     container: HTMLElement | string;
     environment?: typeof window;
 };
-declare function sidepanel(props: SidepanelProps): () => void;
+declare function sidepanel(props: SidepanelProps): SidepanelInstance;
 
 export { sidepanel as default };
-export type { SidepanelProps };
+export type { SidepanelCallbacks, SidepanelInstance, SidepanelProps };