@docsearch/js 4.1.0 → 4.3.0

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 = {
     /**
@@ -8387,6 +8388,13 @@ type DocSearchTransformClient = {
     addAlgoliaAgent: LiteClient['addAlgoliaAgent'];
     transporter: Pick<LiteClient['transporter'], 'algoliaAgent'>;
 };
+type AskAiSearchParameters = {
+    facetFilters?: string[];
+    filters?: string;
+    attributesToRetrieve?: string[];
+    restrictSearchableAttributes?: string[];
+    distinct?: boolean;
+};
 type DocSearchAskAi = {
     /**
      * The index name to use for the ask AI feature. Your assistant will search this index for relevant documents.
@@ -8410,9 +8418,13 @@ type DocSearchAskAi = {
     /**
      * The search parameters to use for the ask AI feature.
      */
-    searchParameters?: {
-        facetFilters?: SearchParamsObject['facetFilters'];
-    };
+    searchParameters?: AskAiSearchParameters;
+    /**
+     * Enables displaying suggested questions on Ask AI's new conversation screen.
+     *
+     * @default false
+     */
+    suggestedQuestions?: boolean;
 };
 interface DocSearchIndex {
     name: string;
@@ -8467,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.
@@ -8548,6 +8572,11 @@ type FooterTranslations = Partial<{
     poweredByText: string;
 }>;
 
+type NewConversationTranslations = Partial<{
+    newConversationTitle: string;
+    newConversationDescription: string;
+}>;
+
 type AskAiScreenTranslations = Partial<{
     disclaimerText: string;
     relatedSourcesText: string;
@@ -8577,6 +8606,10 @@ type AskAiScreenTranslations = Partial<{
         lastSeparator?: string;
         after?: string;
     };
+    /**
+     * Message that's shown when user has stopped the streaming of a message.
+     */
+    stoppedStreamingText: string;
 }>;
 
 type ErrorScreenTranslations = Partial<{
@@ -8593,6 +8626,7 @@ type NoResultsScreenTranslations = Partial<{
 
 type ResultsScreenTranslations = Partial<{
     askAiPlaceholder: string;
+    noResultsAskAiPlaceholder: string;
 }>;
 
 type StartScreenTranslations = Partial<{
@@ -8612,6 +8646,7 @@ type ScreenStateTranslations = Partial<{
     noResultsScreen: NoResultsScreenTranslations;
     resultsScreen: ResultsScreenTranslations;
     askAiScreen: AskAiScreenTranslations;
+    newConversation: NewConversationTranslations;
 }>;
 
 type SearchBoxTranslations = Partial<{
@@ -8627,17 +8662,27 @@ type SearchBoxTranslations = Partial<{
     searchInputLabel: string;
     backToKeywordSearchButtonText: string;
     backToKeywordSearchButtonAriaLabel: string;
+    newConversationPlaceholder: string;
+    conversationHistoryTitle: string;
+    startNewConversationText: string;
+    viewConversationHistoryText: string;
 }>;
 
 type ModalTranslations = Partial<{
     searchBox: SearchBoxTranslations;
+    newConversation: NewConversationTranslations;
     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 };