instantsearch.js 4.82.0 → 4.84.0

package/dist/instantsearch.development.d.ts

@@ -5,6 +5,7 @@ import type { AutocompleteIndexClassNames } from 'instantsearch-ui-components';
 import type { AutocompleteIndexConfig } from 'instantsearch-ui-components';
 import { Banner } from 'algoliasearch-helper';
 import type { CarouselProps } from 'instantsearch-ui-components';
+import type { ClientSideTools } from 'instantsearch-ui-components';
 import { CompositionClient } from 'algoliasearch-helper/types/algoliasearch.js';
 import EventEmitter from '@algolia/events';
 import { FindAnswersOptions } from 'algoliasearch-helper/types/algoliasearch.js';
@@ -33,7 +34,6 @@ import { SearchParameters } from 'algoliasearch-helper';
 import { SearchResults } from 'algoliasearch-helper';
 import type { TrendingItemsProps } from 'instantsearch-ui-components';
 import type { UIMessage } from 'ai';
-import type { UserClientSideTool } from 'instantsearch-ui-components';
 import { VNode } from 'preact';
 import type { VNode as VNode_2 } from 'instantsearch-ui-components';
 
@@ -309,7 +309,17 @@ declare type AutocompleteRenderState = {
     refine: (query: string) => void;
 };
 
-declare type AutocompleteTemplates<TItem extends BaseHit> = Partial<Record<string, TItem>>;
+declare type AutocompleteSearchParameters = Omit<PlainSearchParameters, 'index'>;
+
+declare type AutocompleteTemplates = {
+    /**
+     * Template to use for the panel.
+     */
+    panel?: Template<{
+        elements: PanelElements;
+        indices: AutocompleteRenderState['indices'];
+    }>;
+};
 
 declare type AutocompleteWidgetDescription = {
     $$type: 'ais.autocomplete';
@@ -337,12 +347,34 @@ declare type AutocompleteWidgetParams<TItem extends BaseHit> = {
     showSuggestions?: Partial<Pick<IndexConfig<{
         query: string;
     }>, 'indexName' | 'getURL' | 'templates' | 'cssClasses'>>;
+    showRecent?: boolean | {
+        /**
+         * Storage key to use in the local storage.
+         */
+        storageKey?: string;
+        templates?: Partial<{
+            /**
+             * Template to use for each result. This template will receive an object containing a single record.
+             */
+            item: Template<{
+                item: {
+                    query: string;
+                };
+                onSelect: () => void;
+                onRemoveRecentSearch: () => void;
+            }>;
+        }>;
+    };
+    /**
+     * Search parameters to apply to the autocomplete indices.
+     */
+    searchParameters?: AutocompleteSearchParameters;
     getSearchPageURL?: (nextUiState: IndexUiState) => string;
     onSelect?: AutocompleteIndexConfig<TItem>['onSelect'];
     /**
      * Templates to use for the widget.
      */
-    templates?: AutocompleteTemplates<TItem>;
+    templates?: AutocompleteTemplates;
     /**
      * CSS classes to add.
      */
@@ -643,9 +675,9 @@ declare type ChatRenderState<TUiMessage extends UIMessage = UIMessage> = {
      */
     onClearTransitionEnd: () => void;
     /**
-     * Tools configuration passed to the connector.
+     * Tools configuration with addToolResult bound, ready to be used by the UI.
      */
-    tools: Record<string, Omit<UserClientSideTool, 'layoutComponent'>>;
+    tools: ClientSideTools;
 } & Pick<AbstractChat<TUiMessage>, 'addToolResult' | 'clearError' | 'error' | 'id' | 'messages' | 'regenerate' | 'resumeStream' | 'sendMessage' | 'status' | 'stop'>;
 
 declare type ChatWidgetDescription<TUiMessage extends UIMessage = UIMessage> = {
@@ -4869,6 +4901,10 @@ declare type IndexConfig<TItem extends BaseHit> = AutocompleteIndexConfig<TItem>
             onSelect: () => void;
         }>;
     }>;
+    /**
+     * Search parameters to apply to this index.
+     */
+    searchParameters?: AutocompleteSearchParameters;
     cssClasses?: Partial<AutocompleteIndexClassNames>;
 };
 
@@ -4929,6 +4965,11 @@ declare type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<Index
      * @private
      */
     _isolated: boolean;
+    /**
+     * Schedules a search for this index only.
+     * @private
+     */
+    scheduleLocalSearch: () => void;
 };
 
 declare type IndexWidgetDescription = {
@@ -6332,6 +6373,8 @@ declare type PanelCSSClasses = Partial<{
     footer: string | string[];
 }>;
 
+declare type PanelElements = Partial<Record<'recent' | 'suggestions' | (string & {}), preact.JSX.Element>>;
+
 declare type PanelRenderOptions<TWidgetFactory extends AnyWidgetFactory> = RenderOptions & GetWidgetRenderState<TWidgetFactory>;
 
 declare type PanelTemplates<TWidget extends AnyWidgetFactory> = Partial<{