@docsearch/js 4.2.0 → 4.3.1

package/dist/esm/index.d.ts

@@ -1,5 +1,6 @@
 import { InsightsMethodMap as InsightsMethodMap$1, InsightsClient as InsightsClient$1 } from 'search-insights';
 import React, { JSX } from 'react';
+import { JSX as JSX$1 } from 'preact';
 
 type Cache = {
     /**
@@ -8418,6 +8419,12 @@ type DocSearchAskAi = {
      * The search parameters to use for the ask AI feature.
      */
     searchParameters?: AskAiSearchParameters;
+    /**
+     * Enables displaying suggested questions on Ask AI's new conversation screen.
+     *
+     * @default false
+     */
+    suggestedQuestions?: boolean;
 };
 interface DocSearchIndex {
     name: string;
@@ -8472,16 +8479,28 @@ interface DocSearchProps$1 {
     transformItems?: (items: DocSearchHit[]) => DocSearchHit[];
     /**
      * Custom component to render an individual hit.
+     * Supports template patterns:
+     * - HTML strings with html helper: (props, { html }) => html`<div>...</div>`
+     * - JSX templates: (props) => <div>...</div>
+     * - Function-based templates: (props) => string | JSX.Element | Function.
      */
     hitComponent?: (props: {
         hit: InternalDocSearchHit | StoredDocSearchHit;
         children: React.ReactNode;
+    }, helpers?: {
+        html: (template: TemplateStringsArray, ...values: any[]) => any;
     }) => JSX.Element;
     /**
      * Custom component rendered at the bottom of the results panel.
+     * Supports template patterns:
+     * - HTML strings with html helper: (props, { html }) => html`<div>...</div>`
+     * - JSX templates: (props) => <div>...</div>
+     * - Function-based templates: (props) => string | JSX.Element | Function.
      */
     resultsFooterComponent?: (props: {
         state: AutocompleteState$1<InternalDocSearchHit>;
+    }, helpers?: {
+        html: (template: TemplateStringsArray, ...values: any[]) => any;
     }) => JSX.Element | null;
     /**
      * Hook to wrap or modify the algolia search client.
@@ -8655,10 +8674,15 @@ type ModalTranslations = Partial<{
     footer: FooterTranslations;
 }> & ScreenStateTranslations;
 
-interface DocSearchProps extends DocSearchProps$1 {
+type DocSearchProps = DocSearchProps$1 & {
     container: HTMLElement | string;
     environment?: typeof window;
-}
-declare function docsearch(props: DocSearchProps): () => void;
+};
+declare const html: (strings: TemplateStringsArray, ...values: unknown[]) => JSX$1.Element;
+type TemplateHelpers = Record<string, unknown> & {
+    html: typeof html;
+};
+declare function docsearch(allProps: DocSearchProps): () => void;
 
 export { docsearch as default };
+export type { DocSearchProps, TemplateHelpers };