@seekora-ai/docsearch-js 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,65 @@
+import { DocSearchHit, DocSearchSuggestion, DocSearchProps } from '@seekora/docsearch-react';
+export { DocSearchHit, DocSearchProps, DocSearchSuggestion } from '@seekora/docsearch-react';
+
+interface DocSearchOptions {
+    /** Container element or CSS selector */
+    container: string | HTMLElement;
+    /** API endpoint for search (e.g., "https://api.example.com/v1/docs") */
+    apiEndpoint: string;
+    /** Optional API key for authentication */
+    apiKey?: string;
+    /** Index name (optional) */
+    indexName?: string;
+    /** Placeholder text for the search input */
+    placeholder?: string;
+    /** Maximum number of results to show */
+    maxResults?: number;
+    /** Debounce delay in milliseconds */
+    debounceMs?: number;
+    /** Callback when a result is selected */
+    onSelect?: (hit: DocSearchHit | DocSearchSuggestion) => void;
+    /** Callback when the modal is closed */
+    onClose?: () => void;
+    /** Custom translations */
+    translations?: DocSearchProps['translations'];
+    /** Whether to render the button trigger (default: true) */
+    renderButton?: boolean;
+    /** Initial open state */
+    initialOpen?: boolean;
+    /** Disable keyboard shortcut (Cmd/Ctrl+K) */
+    disableShortcut?: boolean;
+    /** Custom keyboard shortcut key (default: 'k') */
+    shortcutKey?: string;
+}
+interface DocSearchInstance {
+    /** Destroy the DocSearch instance and cleanup */
+    destroy: () => void;
+    /** Open the search modal programmatically */
+    open: () => void;
+    /** Close the search modal programmatically */
+    close: () => void;
+    /** Update options */
+    update: (options: Partial<DocSearchOptions>) => void;
+}
+/**
+ * Initialize DocSearch on a container element.
+ *
+ * @example
+ * ```js
+ * import docsearch from '@seekora/docsearch-js';
+ * import '@seekora/docsearch-css';
+ *
+ * const search = docsearch({
+ *   container: '#docsearch',
+ *   apiEndpoint: 'https://api.example.com/v1/docs',
+ * });
+ *
+ * // Later, if needed:
+ * search.open();
+ * search.destroy();
+ * ```
+ */
+declare function docsearch(options: DocSearchOptions): DocSearchInstance;
+
+export { docsearch as default, docsearch };
+export type { DocSearchInstance, DocSearchOptions };