@docsearch/js 4.4.0 → 4.5.0-beta.0

package/dist/esm/index.d.ts

@@ -2,6 +2,12 @@ import { InsightsMethodMap as InsightsMethodMap$1, InsightsClient as InsightsCli
 import React, { JSX } from 'react';
 import { JSX as JSX$1 } from 'preact';
 
+type InitialAskAiMessage = {
+    query: string;
+    messageId?: string;
+    suggestedQuestionId?: string;
+};
+
 type Cache = {
     /**
      * Gets the value of the given `key`.
@@ -8696,7 +8702,36 @@ type ModalTranslations = Partial<{
     footer: FooterTranslations;
 }> & ScreenStateTranslations;
 
-type DocSearchProps = DocSearchProps$1 & {
+/**
+ * Instance returned by docsearch() for programmatic control.
+ */
+interface DocSearchInstance {
+    /** Returns true once the component is mounted and ready. */
+    readonly isReady: boolean;
+    /** Returns true if the modal is currently open. */
+    readonly isOpen: boolean;
+    /** Opens the search modal. */
+    open(): void;
+    /** Closes the search modal. */
+    close(): void;
+    /** Opens Ask AI mode (modal). */
+    openAskAi(initialMessage?: InitialAskAiMessage): void;
+    /** Unmounts the DocSearch component and cleans up. */
+    destroy(): void;
+}
+/**
+ * Lifecycle callbacks for the DocSearch instance.
+ */
+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;
+    interceptAskAiEvent?: (initialMessage: InitialAskAiMessage) => boolean | void;
+}
+type DocSearchProps = DocSearchCallbacks & Omit<DocSearchProps$1, 'onSidepanelClose' | 'onSidepanelOpen'> & {
     container: HTMLElement | string;
     environment?: typeof window;
 };
@@ -8704,7 +8739,7 @@ declare const html: (strings: TemplateStringsArray, ...values: unknown[]) => JSX
 type TemplateHelpers = Record<string, unknown> & {
     html: typeof html;
 };
-declare function docsearch(allProps: DocSearchProps): () => void;
+declare function docsearch(allProps: DocSearchProps): DocSearchInstance;
 
 export { docsearch as default };
-export type { DocSearchProps, TemplateHelpers };
+export type { DocSearchCallbacks, DocSearchInstance, DocSearchProps, TemplateHelpers };