instantsearch.js 4.81.0 → 4.82.0

package/dist/instantsearch.production.d.ts

@@ -1,5 +1,8 @@
 import { AbstractChat } from 'ai';
 import { AlgoliaSearchHelper } from 'algoliasearch-helper';
+import type { AutocompleteClassNames } from 'instantsearch-ui-components';
+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 { CompositionClient } from 'algoliasearch-helper/types/algoliasearch.js';
@@ -30,6 +33,7 @@ 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';
 
@@ -267,6 +271,8 @@ declare type AutocompleteConnectorParams = {
     escapeHTML?: boolean;
 };
 
+declare type AutocompleteCSSClasses = Partial<AutocompleteClassNames>;
+
 declare type AutocompleteRenderState = {
     /**
      * The current value of the query.
@@ -303,6 +309,8 @@ declare type AutocompleteRenderState = {
     refine: (query: string) => void;
 };
 
+declare type AutocompleteTemplates<TItem extends BaseHit> = Partial<Record<string, TItem>>;
+
 declare type AutocompleteWidgetDescription = {
     $$type: 'ais.autocomplete';
     renderState: AutocompleteRenderState;
@@ -314,6 +322,33 @@ declare type AutocompleteWidgetDescription = {
     };
 };
 
+declare type AutocompleteWidgetParams<TItem extends BaseHit> = {
+    /**
+     * CSS Selector or HTMLElement to insert the widget.
+     */
+    container: string | HTMLElement;
+    /**
+     * Indices to use in the Autocomplete.
+     */
+    indices?: Array<IndexConfig<TItem>>;
+    /**
+     * Index to use for retrieving and showing query suggestions.
+     */
+    showSuggestions?: Partial<Pick<IndexConfig<{
+        query: string;
+    }>, 'indexName' | 'getURL' | 'templates' | 'cssClasses'>>;
+    getSearchPageURL?: (nextUiState: IndexUiState) => string;
+    onSelect?: AutocompleteIndexConfig<TItem>['onSelect'];
+    /**
+     * Templates to use for the widget.
+     */
+    templates?: AutocompleteTemplates<TItem>;
+    /**
+     * CSS classes to add.
+     */
+    cssClasses?: AutocompleteCSSClasses;
+};
+
 declare type BaseHit = Record<string, any>;
 
 declare type BindEventForHits = BuiltInBindEventForHits & CustomBindEventForHits;
@@ -595,6 +630,22 @@ declare type ChatRenderState<TUiMessage extends UIMessage = UIMessage> = {
      * manually to regenerate the AI response.
      */
     setMessages: (messages: TUiMessage[] | ((m: TUiMessage[]) => TUiMessage[])) => void;
+    /**
+     * Whether the chat is in the process of clearing messages.
+     */
+    isClearing: boolean;
+    /**
+     * Clear all messages.
+     */
+    clearMessages: () => void;
+    /**
+     * Callback to be called when the clear transition ends.
+     */
+    onClearTransitionEnd: () => void;
+    /**
+     * Tools configuration passed to the connector.
+     */
+    tools: Record<string, Omit<UserClientSideTool, 'layoutComponent'>>;
 } & Pick<AbstractChat<TUiMessage>, 'addToolResult' | 'clearError' | 'error' | 'id' | 'messages' | 'regenerate' | 'resumeStream' | 'sendMessage' | 'status' | 'stop'>;
 
 declare type ChatWidgetDescription<TUiMessage extends UIMessage = UIMessage> = {
@@ -3866,6 +3917,10 @@ declare type Expand<T> = T extends infer O ? {
 /** @deprecated answers is no longer supported */
 declare const EXPERIMENTAL_answers: AnswersWidget;
 
+declare function EXPERIMENTAL_autocomplete<TItem extends BaseHit = BaseHit>(widgetParams: AutocompleteWidgetParams<TItem> & AutocompleteConnectorParams): (IndexWidget<UiState> | Widget<SearchBoxWidgetDescription & {
+widgetParams: SearchBoxConnectorParams & object;
+}>)[];
+
 /** @deprecated use relatedItems instead */
 declare const EXPERIMENTAL_configureRelatedItems: ConfigureRelatedItemsWidget;
 
@@ -3892,6 +3947,10 @@ declare type FrequentlyBoughtTogetherConnectorParams<THit extends NonNullable<ob
      * Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned.
      */
     threshold?: number;
+    /**
+     * List of search parameters to send.
+     */
+    fallbackParameters?: Omit<PlainSearchParameters, 'page' | 'hitsPerPage' | 'offset' | 'length'>;
     /**
      * The maximum number of recommendations to return.
      */
@@ -4794,6 +4853,25 @@ declare type HTMLMarkerArguments = {
 
 declare const index: (widgetParams: IndexWidgetParams) => IndexWidget;
 
+declare type IndexConfig<TItem extends BaseHit> = AutocompleteIndexConfig<TItem> & {
+    templates?: Partial<{
+        /**
+         * Template to use for the header, before the list of items.
+         */
+        header: Template<{
+            items: TItem[];
+        }>;
+        /**
+         * Template to use for each result. This template will receive an object containing a single record.
+         */
+        item: Template<{
+            item: TItem;
+            onSelect: () => void;
+        }>;
+    }>;
+    cssClasses?: Partial<AutocompleteIndexClassNames>;
+};
+
 declare type IndexInitOptions = {
     instantSearchInstance: InstantSearch;
     parent: IndexWidget | null;
@@ -4821,7 +4899,7 @@ declare type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<Index
     getParent: () => IndexWidget | null;
     getWidgets: () => Array<Widget | IndexWidget>;
     createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
-    addWidgets: (widgets: Array<Widget | IndexWidget | Widget[]>) => IndexWidget;
+    addWidgets: (widgets: Array<Widget | IndexWidget | Array<IndexWidget | Widget>>) => IndexWidget;
     removeWidgets: (widgets: Array<Widget | IndexWidget | Widget[]>) => IndexWidget;
     init: (options: IndexInitOptions) => void;
     render: (options: IndexRenderOptions) => void;
@@ -5232,7 +5310,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
      * Widgets can be added either before or after InstantSearch has started.
      * @param widgets The array of widgets to add to InstantSearch.
      */
-    addWidgets(widgets: Array<Widget | IndexWidget | Widget[]>): this;
+    addWidgets(widgets: Array<Widget | IndexWidget | Array<IndexWidget | Widget>>): this;
     /**
      * Removes a widget from the search instance.
      * @deprecated This method will still be supported in 4.x releases, but not further. It is replaced by `removeWidgets([widget])`
@@ -6302,6 +6380,14 @@ declare type ParamTrackedFilters = {
 
 declare type ParamTransformRuleContexts = (ruleContexts: string[]) => string[];
 
+declare type Parent = {
+    /**
+     * This gets dynamically added by the `index` widget.
+     * If the widget has gone through `addWidget`, it will have a parent.
+     */
+    parent?: IndexWidget;
+};
+
 declare type ParseURL<TRouteState> = (args: {
     qsModule: typeof qs_2;
     location: Location;
@@ -8634,7 +8720,7 @@ declare type VoiceSearchWidgetParams = {
 
 declare type Widget<TWidgetDescription extends WidgetDescription & WidgetParams = {
     $$type: string;
-}> = Expand<RequiredWidgetLifeCycle<TWidgetDescription> & WidgetType<TWidgetDescription> & UiStateLifeCycle<TWidgetDescription> & RenderStateLifeCycle<TWidgetDescription>> & (SearchWidget<TWidgetDescription> | RecommendWidget<TWidgetDescription>);
+}> = Expand<Parent & RequiredWidgetLifeCycle<TWidgetDescription> & WidgetType<TWidgetDescription> & UiStateLifeCycle<TWidgetDescription> & RenderStateLifeCycle<TWidgetDescription>> & (SearchWidget<TWidgetDescription> | RecommendWidget<TWidgetDescription>);
 
 declare type WidgetDescription = {
     $$type: string;
@@ -8672,6 +8758,7 @@ declare namespace widgets {
         EXPERIMENTAL_dynamicWidgets,
         dynamicWidgets,
         analytics,
+        EXPERIMENTAL_autocomplete,
         breadcrumb,
         clearRefinements,
         configure,

package/dist/instantsearch.production.min.d.ts

@@ -1,5 +1,8 @@
 import { AbstractChat } from 'ai';
 import { AlgoliaSearchHelper } from 'algoliasearch-helper';
+import type { AutocompleteClassNames } from 'instantsearch-ui-components';
+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 { CompositionClient } from 'algoliasearch-helper/types/algoliasearch.js';
@@ -30,6 +33,7 @@ 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';
 
@@ -267,6 +271,8 @@ declare type AutocompleteConnectorParams = {
     escapeHTML?: boolean;
 };
 
+declare type AutocompleteCSSClasses = Partial<AutocompleteClassNames>;
+
 declare type AutocompleteRenderState = {
     /**
      * The current value of the query.
@@ -303,6 +309,8 @@ declare type AutocompleteRenderState = {
     refine: (query: string) => void;
 };
 
+declare type AutocompleteTemplates<TItem extends BaseHit> = Partial<Record<string, TItem>>;
+
 declare type AutocompleteWidgetDescription = {
     $$type: 'ais.autocomplete';
     renderState: AutocompleteRenderState;
@@ -314,6 +322,33 @@ declare type AutocompleteWidgetDescription = {
     };
 };
 
+declare type AutocompleteWidgetParams<TItem extends BaseHit> = {
+    /**
+     * CSS Selector or HTMLElement to insert the widget.
+     */
+    container: string | HTMLElement;
+    /**
+     * Indices to use in the Autocomplete.
+     */
+    indices?: Array<IndexConfig<TItem>>;
+    /**
+     * Index to use for retrieving and showing query suggestions.
+     */
+    showSuggestions?: Partial<Pick<IndexConfig<{
+        query: string;
+    }>, 'indexName' | 'getURL' | 'templates' | 'cssClasses'>>;
+    getSearchPageURL?: (nextUiState: IndexUiState) => string;
+    onSelect?: AutocompleteIndexConfig<TItem>['onSelect'];
+    /**
+     * Templates to use for the widget.
+     */
+    templates?: AutocompleteTemplates<TItem>;
+    /**
+     * CSS classes to add.
+     */
+    cssClasses?: AutocompleteCSSClasses;
+};
+
 declare type BaseHit = Record<string, any>;
 
 declare type BindEventForHits = BuiltInBindEventForHits & CustomBindEventForHits;
@@ -595,6 +630,22 @@ declare type ChatRenderState<TUiMessage extends UIMessage = UIMessage> = {
      * manually to regenerate the AI response.
      */
     setMessages: (messages: TUiMessage[] | ((m: TUiMessage[]) => TUiMessage[])) => void;
+    /**
+     * Whether the chat is in the process of clearing messages.
+     */
+    isClearing: boolean;
+    /**
+     * Clear all messages.
+     */
+    clearMessages: () => void;
+    /**
+     * Callback to be called when the clear transition ends.
+     */
+    onClearTransitionEnd: () => void;
+    /**
+     * Tools configuration passed to the connector.
+     */
+    tools: Record<string, Omit<UserClientSideTool, 'layoutComponent'>>;
 } & Pick<AbstractChat<TUiMessage>, 'addToolResult' | 'clearError' | 'error' | 'id' | 'messages' | 'regenerate' | 'resumeStream' | 'sendMessage' | 'status' | 'stop'>;
 
 declare type ChatWidgetDescription<TUiMessage extends UIMessage = UIMessage> = {
@@ -3866,6 +3917,10 @@ declare type Expand<T> = T extends infer O ? {
 /** @deprecated answers is no longer supported */
 declare const EXPERIMENTAL_answers: AnswersWidget;
 
+declare function EXPERIMENTAL_autocomplete<TItem extends BaseHit = BaseHit>(widgetParams: AutocompleteWidgetParams<TItem> & AutocompleteConnectorParams): (IndexWidget<UiState> | Widget<SearchBoxWidgetDescription & {
+widgetParams: SearchBoxConnectorParams & object;
+}>)[];
+
 /** @deprecated use relatedItems instead */
 declare const EXPERIMENTAL_configureRelatedItems: ConfigureRelatedItemsWidget;
 
@@ -3892,6 +3947,10 @@ declare type FrequentlyBoughtTogetherConnectorParams<THit extends NonNullable<ob
      * Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned.
      */
     threshold?: number;
+    /**
+     * List of search parameters to send.
+     */
+    fallbackParameters?: Omit<PlainSearchParameters, 'page' | 'hitsPerPage' | 'offset' | 'length'>;
     /**
      * The maximum number of recommendations to return.
      */
@@ -4794,6 +4853,25 @@ declare type HTMLMarkerArguments = {
 
 declare const index: (widgetParams: IndexWidgetParams) => IndexWidget;
 
+declare type IndexConfig<TItem extends BaseHit> = AutocompleteIndexConfig<TItem> & {
+    templates?: Partial<{
+        /**
+         * Template to use for the header, before the list of items.
+         */
+        header: Template<{
+            items: TItem[];
+        }>;
+        /**
+         * Template to use for each result. This template will receive an object containing a single record.
+         */
+        item: Template<{
+            item: TItem;
+            onSelect: () => void;
+        }>;
+    }>;
+    cssClasses?: Partial<AutocompleteIndexClassNames>;
+};
+
 declare type IndexInitOptions = {
     instantSearchInstance: InstantSearch;
     parent: IndexWidget | null;
@@ -4821,7 +4899,7 @@ declare type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<Index
     getParent: () => IndexWidget | null;
     getWidgets: () => Array<Widget | IndexWidget>;
     createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
-    addWidgets: (widgets: Array<Widget | IndexWidget | Widget[]>) => IndexWidget;
+    addWidgets: (widgets: Array<Widget | IndexWidget | Array<IndexWidget | Widget>>) => IndexWidget;
     removeWidgets: (widgets: Array<Widget | IndexWidget | Widget[]>) => IndexWidget;
     init: (options: IndexInitOptions) => void;
     render: (options: IndexRenderOptions) => void;
@@ -5232,7 +5310,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
      * Widgets can be added either before or after InstantSearch has started.
      * @param widgets The array of widgets to add to InstantSearch.
      */
-    addWidgets(widgets: Array<Widget | IndexWidget | Widget[]>): this;
+    addWidgets(widgets: Array<Widget | IndexWidget | Array<IndexWidget | Widget>>): this;
     /**
      * Removes a widget from the search instance.
      * @deprecated This method will still be supported in 4.x releases, but not further. It is replaced by `removeWidgets([widget])`
@@ -6302,6 +6380,14 @@ declare type ParamTrackedFilters = {
 
 declare type ParamTransformRuleContexts = (ruleContexts: string[]) => string[];
 
+declare type Parent = {
+    /**
+     * This gets dynamically added by the `index` widget.
+     * If the widget has gone through `addWidget`, it will have a parent.
+     */
+    parent?: IndexWidget;
+};
+
 declare type ParseURL<TRouteState> = (args: {
     qsModule: typeof qs_2;
     location: Location;
@@ -8634,7 +8720,7 @@ declare type VoiceSearchWidgetParams = {
 
 declare type Widget<TWidgetDescription extends WidgetDescription & WidgetParams = {
     $$type: string;
-}> = Expand<RequiredWidgetLifeCycle<TWidgetDescription> & WidgetType<TWidgetDescription> & UiStateLifeCycle<TWidgetDescription> & RenderStateLifeCycle<TWidgetDescription>> & (SearchWidget<TWidgetDescription> | RecommendWidget<TWidgetDescription>);
+}> = Expand<Parent & RequiredWidgetLifeCycle<TWidgetDescription> & WidgetType<TWidgetDescription> & UiStateLifeCycle<TWidgetDescription> & RenderStateLifeCycle<TWidgetDescription>> & (SearchWidget<TWidgetDescription> | RecommendWidget<TWidgetDescription>);
 
 declare type WidgetDescription = {
     $$type: string;
@@ -8672,6 +8758,7 @@ declare namespace widgets {
         EXPERIMENTAL_dynamicWidgets,
         dynamicWidgets,
         analytics,
+        EXPERIMENTAL_autocomplete,
         breadcrumb,
         clearRefinements,
         configure,