instantsearch.js 4.79.2 → 4.81.0

package/dist/instantsearch.development.d.ts

@@ -1,3 +1,4 @@
+import { AbstractChat } from 'ai';
 import { AlgoliaSearchHelper } from 'algoliasearch-helper';
 import { Banner } from 'algoliasearch-helper';
 import type { CarouselProps } from 'instantsearch-ui-components';
@@ -28,6 +29,7 @@ import { SearchOptions } from 'algoliasearch-helper/types/algoliasearch.js';
 import { SearchParameters } from 'algoliasearch-helper';
 import { SearchResults } from 'algoliasearch-helper';
 import type { TrendingItemsProps } from 'instantsearch-ui-components';
+import type { UIMessage } from 'ai';
 import { VNode } from 'preact';
 import type { VNode as VNode_2 } from 'instantsearch-ui-components';
 
@@ -563,7 +565,7 @@ declare type BuiltInSendEventForHits = (eventType: string, hits: Hit | Hit[], ev
 
 declare type BuiltInSendEventForToggle = (eventType: string, isRefined: boolean, eventName?: string) => void;
 
-declare function carousel<TObject extends Record<string, unknown>>({ cssClasses, templates, }?: CreateCarouselTemplateProps<TObject>): ({ items, templates: widgetTemplates, cssClasses: widgetCssClasses, sendEvent, }: CarouselTemplateProps<TObject>) => h.JSX.Element;
+declare function carousel<TObject extends Record<string, unknown>>({ cssClasses, templates, showNavigation, }?: CreateCarouselTemplateProps<TObject>): ({ items, templates: widgetTemplates, cssClasses: widgetCssClasses, sendEvent, }: CarouselTemplateProps<TObject>) => h.JSX.Element;
 
 declare type CarouselTemplateProps<TObject extends Record<string, unknown>> = Pick<CarouselProps<TObject>, 'items'> & {
     templates: {
@@ -574,6 +576,33 @@ declare type CarouselTemplateProps<TObject extends Record<string, unknown>> = Pi
     sendEvent?: CarouselProps<TObject>['sendEvent'];
 };
 
+declare const chat: () => never;
+
+declare type ChatRenderState<TUiMessage extends UIMessage = UIMessage> = {
+    indexUiState: IndexUiState;
+    input: string;
+    open: boolean;
+    /**
+     * Sends an event to the Insights middleware.
+     */
+    sendEvent: SendEventForHits;
+    setIndexUiState: IndexWidget['setIndexUiState'];
+    setInput: (input: string) => void;
+    setOpen: (open: boolean) => void;
+    /**
+     * Updates the `messages` state locally. This is useful when you want to
+     * edit the messages on the client, and then trigger the `reload` method
+     * manually to regenerate the AI response.
+     */
+    setMessages: (messages: TUiMessage[] | ((m: TUiMessage[]) => TUiMessage[])) => void;
+} & Pick<AbstractChat<TUiMessage>, 'addToolResult' | 'clearError' | 'error' | 'id' | 'messages' | 'regenerate' | 'resumeStream' | 'sendMessage' | 'status' | 'stop'>;
+
+declare type ChatWidgetDescription<TUiMessage extends UIMessage = UIMessage> = {
+    $$type: 'ais.chat';
+    renderState: ChatRenderState<TUiMessage>;
+    indexRenderState: Record<string, unknown>;
+};
+
 declare const clearRefinements: ClearRefinementsWidget;
 
 declare type ClearRefinementsConnector = Connector<ClearRefinementsWidgetDescription, ClearRefinementsConnectorParams>;
@@ -741,6 +770,8 @@ declare const connectAutocomplete: AutocompleteConnector;
 
 declare const connectBreadcrumb: BreadcrumbConnector;
 
+declare const connectChat: () => never;
+
 declare const connectClearRefinements: ClearRefinementsConnector;
 
 declare const connectConfigure: ConfigureConnector;
@@ -771,6 +802,7 @@ declare const connectHitsWithInsights: <TWidgetParams>(renderFn: Renderer<HitsRe
     init(initOptions: InitOptions): void;
     render(renderOptions: RenderOptions): void;
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -878,6 +910,7 @@ declare const connectInfiniteHitsWithInsights: <TWidgetParams extends UnknownWid
     init(initOptions: InitOptions): void;
     render(renderOptions: RenderOptions): void;
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -1080,7 +1113,7 @@ unmountFn?: Unmounter) => (widgetParams: TConnectorParams & TWidgetParams) => Wi
     widgetParams: typeof widgetParams;
 }>;
 
-declare type ConnectorRenderStates = AnswersWidgetDescription['indexRenderState'] & AutocompleteWidgetDescription['indexRenderState'] & BreadcrumbWidgetDescription['indexRenderState'] & ClearRefinementsWidgetDescription['indexRenderState'] & ConfigureWidgetDescription['indexRenderState'] & CurrentRefinementsWidgetDescription['indexRenderState'] & GeoSearchWidgetDescription['indexRenderState'] & HierarchicalMenuWidgetDescription['indexRenderState'] & HitsWidgetDescription['indexRenderState'] & HitsPerPageWidgetDescription['indexRenderState'] & InfiniteHitsWidgetDescription['indexRenderState'] & MenuWidgetDescription['indexRenderState'] & NumericMenuWidgetDescription['indexRenderState'] & PaginationWidgetDescription['indexRenderState'] & PoweredByWidgetDescription['indexRenderState'] & QueryRulesWidgetDescription['indexRenderState'] & RangeWidgetDescription['indexRenderState'] & RatingMenuWidgetDescription['indexRenderState'] & RefinementListWidgetDescription['indexRenderState'] & RelevantSortWidgetDescription['indexRenderState'] & SearchBoxWidgetDescription['indexRenderState'] & SortByWidgetDescription['indexRenderState'] & StatsWidgetDescription['indexRenderState'] & ToggleRefinementWidgetDescription['indexRenderState'] & VoiceSearchWidgetDescription['indexRenderState'];
+declare type ConnectorRenderStates = AnswersWidgetDescription['indexRenderState'] & AutocompleteWidgetDescription['indexRenderState'] & BreadcrumbWidgetDescription['indexRenderState'] & ChatWidgetDescription['indexRenderState'] & ClearRefinementsWidgetDescription['indexRenderState'] & ConfigureWidgetDescription['indexRenderState'] & CurrentRefinementsWidgetDescription['indexRenderState'] & GeoSearchWidgetDescription['indexRenderState'] & HierarchicalMenuWidgetDescription['indexRenderState'] & HitsWidgetDescription['indexRenderState'] & HitsPerPageWidgetDescription['indexRenderState'] & InfiniteHitsWidgetDescription['indexRenderState'] & MenuWidgetDescription['indexRenderState'] & NumericMenuWidgetDescription['indexRenderState'] & PaginationWidgetDescription['indexRenderState'] & PoweredByWidgetDescription['indexRenderState'] & QueryRulesWidgetDescription['indexRenderState'] & RangeWidgetDescription['indexRenderState'] & RatingMenuWidgetDescription['indexRenderState'] & RefinementListWidgetDescription['indexRenderState'] & RelevantSortWidgetDescription['indexRenderState'] & SearchBoxWidgetDescription['indexRenderState'] & SortByWidgetDescription['indexRenderState'] & StatsWidgetDescription['indexRenderState'] & ToggleRefinementWidgetDescription['indexRenderState'] & VoiceSearchWidgetDescription['indexRenderState'];
 
 declare namespace connectors {
     export {
@@ -1117,7 +1150,8 @@ declare namespace connectors {
         connectVoiceSearch,
         connectRelevantSort,
         _default_6 as connectFrequentlyBoughtTogether,
-        _default_7 as connectLookingSimilar
+        _default_7 as connectLookingSimilar,
+        connectChat
     }
 }
 
@@ -1203,8 +1237,15 @@ declare type CreateCarouselTemplateProps<TObject extends Record<string, unknown>
     templates?: Partial<{
         previous: Exclude<Template_2, string>;
         next: Exclude<Template_2, string>;
+        header: Exclude<Template_2<{
+            canScrollLeft: boolean;
+            canScrollRight: boolean;
+            scrollLeft: () => void;
+            scrollRight: () => void;
+        }>, string>;
     }>;
     cssClasses?: Partial<CarouselProps<TObject>['classNames']>;
+    showNavigation?: boolean;
 };
 
 declare function createInfiniteHitsSessionStorageCache({ key, }?: {
@@ -1423,6 +1464,7 @@ declare const _default: <TWidgetParams>(renderFn: Renderer<HitsRenderState, TWid
     init(initOptions: InitOptions): void;
     render(renderOptions: RenderOptions): void;
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -1531,6 +1573,7 @@ declare const _default_10: <THit extends NonNullable<object> = BaseHit>(widgetPa
     init(initOptions: InitOptions): void;
     render(renderOptions: RenderOptions): void;
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -1713,6 +1756,7 @@ declare const _default_12: <THit extends NonNullable<object> = BaseHit>(widgetPa
     init(initOptions: InitOptions): void;
     render(renderOptions: RenderOptions): void;
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -1757,6 +1801,7 @@ declare const _default_12: <THit extends NonNullable<object> = BaseHit>(widgetPa
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     }): {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -1815,7 +1860,7 @@ declare const _default_12: <THit extends NonNullable<object> = BaseHit>(widgetPa
             breadcrumb: {
                 [rootAttribute: string]: WidgetRenderState<BreadcrumbRenderState, BreadcrumbConnectorParams>;
             };
-        } & {
+        } & Record<string, unknown> & {
             clearRefinements: WidgetRenderState<ClearRefinementsRenderState, ClearRefinementsConnectorParams>;
         } & {
             configure: WidgetRenderState<ConfigureRenderState, ConfigureConnectorParams>;
@@ -1903,6 +1948,7 @@ declare const _default_13: <THit extends NonNullable<object> = BaseHit>(widgetPa
     init(initOptions: InitOptions): void;
     render(renderOptions: RenderOptions): void;
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -1947,6 +1993,7 @@ declare const _default_13: <THit extends NonNullable<object> = BaseHit>(widgetPa
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     }): {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -2005,7 +2052,7 @@ declare const _default_13: <THit extends NonNullable<object> = BaseHit>(widgetPa
             breadcrumb: {
                 [rootAttribute: string]: WidgetRenderState<BreadcrumbRenderState, BreadcrumbConnectorParams>;
             };
-        } & {
+        } & Record<string, unknown> & {
             clearRefinements: WidgetRenderState<ClearRefinementsRenderState, ClearRefinementsConnectorParams>;
         } & {
             configure: WidgetRenderState<ConfigureRenderState, ConfigureConnectorParams>;
@@ -2093,6 +2140,7 @@ declare const _default_14: <THit extends NonNullable<object> = BaseHit>(widgetPa
     init(initOptions: InitOptions): void;
     render(renderOptions: RenderOptions): void;
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -2137,6 +2185,7 @@ declare const _default_14: <THit extends NonNullable<object> = BaseHit>(widgetPa
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     }): {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -2195,7 +2244,7 @@ declare const _default_14: <THit extends NonNullable<object> = BaseHit>(widgetPa
             breadcrumb: {
                 [rootAttribute: string]: WidgetRenderState<BreadcrumbRenderState, BreadcrumbConnectorParams>;
             };
-        } & {
+        } & Record<string, unknown> & {
             clearRefinements: WidgetRenderState<ClearRefinementsRenderState, ClearRefinementsConnectorParams>;
         } & {
             configure: WidgetRenderState<ConfigureRenderState, ConfigureConnectorParams>;
@@ -2283,6 +2332,7 @@ declare const _default_15: <THit extends NonNullable<object> = BaseHit>(widgetPa
     init(initOptions: InitOptions): void;
     render(renderOptions: RenderOptions): void;
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -2327,6 +2377,7 @@ declare const _default_15: <THit extends NonNullable<object> = BaseHit>(widgetPa
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     }): {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -2385,7 +2436,7 @@ declare const _default_15: <THit extends NonNullable<object> = BaseHit>(widgetPa
             breadcrumb: {
                 [rootAttribute: string]: WidgetRenderState<BreadcrumbRenderState, BreadcrumbConnectorParams>;
             };
-        } & {
+        } & Record<string, unknown> & {
             clearRefinements: WidgetRenderState<ClearRefinementsRenderState, ClearRefinementsConnectorParams>;
         } & {
             configure: WidgetRenderState<ConfigureRenderState, ConfigureConnectorParams>;
@@ -2471,6 +2522,7 @@ declare const _default_2: <TWidgetParams extends UnknownWidgetParams>(renderFn:
     init(initOptions: InitOptions): void;
     render(renderOptions: RenderOptions): void;
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -2650,6 +2702,7 @@ declare const _default_3: <TWidgetParams extends UnknownWidgetParams>(renderFn:
     init(initOptions: InitOptions): void;
     render(renderOptions: RenderOptions): void;
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -2694,6 +2747,7 @@ declare const _default_3: <TWidgetParams extends UnknownWidgetParams>(renderFn:
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     }): {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -2769,6 +2823,7 @@ declare const _default_4: <TWidgetParams extends UnknownWidgetParams>(renderFn:
     init(initOptions: InitOptions): void;
     render(renderOptions: RenderOptions): void;
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -2813,6 +2868,7 @@ declare const _default_4: <TWidgetParams extends UnknownWidgetParams>(renderFn:
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     }): {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -2922,6 +2978,7 @@ declare const _default_5: <TWidgetParams extends UnknownWidgetParams>(renderFn:
         widgetParams: TWidgetParams & GeoSearchConnectorParams<THit>;
     };
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -3108,6 +3165,7 @@ declare const _default_6: <TWidgetParams extends UnknownWidgetParams>(renderFn:
     init(initOptions: InitOptions): void;
     render(renderOptions: RenderOptions): void;
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -3152,6 +3210,7 @@ declare const _default_6: <TWidgetParams extends UnknownWidgetParams>(renderFn:
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     }): {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -3227,6 +3286,7 @@ declare const _default_7: <TWidgetParams extends UnknownWidgetParams>(renderFn:
     init(initOptions: InitOptions): void;
     render(renderOptions: RenderOptions): void;
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -3271,6 +3331,7 @@ declare const _default_7: <TWidgetParams extends UnknownWidgetParams>(renderFn:
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     }): {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -3434,6 +3495,7 @@ declare const _default_8: <THit extends GeoHit = GeoHit>(widgetParams: GeoSearch
         } & GeoSearchConnectorParams<THit>;
     };
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -3599,6 +3661,7 @@ declare const _default_9: <THit extends NonNullable<object> = BaseHit>(widgetPar
     init(initOptions: InitOptions): void;
     render(renderOptions: RenderOptions): void;
     getRenderState(renderState: {
+        [x: string]: unknown;
         answers?: WidgetRenderState<AnswersRenderState, AnswersConnectorParams> | undefined;
         autocomplete?: WidgetRenderState<AutocompleteRenderState, AutocompleteConnectorParams> | undefined;
         breadcrumb?: {
@@ -4758,8 +4821,8 @@ 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>) => IndexWidget;
-    removeWidgets: (widgets: Array<Widget | IndexWidget>) => IndexWidget;
+    addWidgets: (widgets: Array<Widget | IndexWidget | Widget[]>) => IndexWidget;
+    removeWidgets: (widgets: Array<Widget | IndexWidget | Widget[]>) => IndexWidget;
     init: (options: IndexInitOptions) => void;
     render: (options: IndexRenderOptions) => void;
     dispose: () => void;
@@ -4782,6 +4845,12 @@ declare type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<Index
      * Can only be called after `init`.
      */
     setIndexUiState: (indexUiState: TUiState[string] | ((previousIndexUiState: TUiState[string]) => TUiState[string])) => void;
+    /**
+     * This index is isolated, meaning it will not be merged with the main
+     * helper's state.
+     * @private
+     */
+    _isolated: boolean;
 };
 
 declare type IndexWidgetDescription = {
@@ -4790,7 +4859,45 @@ declare type IndexWidgetDescription = {
 };
 
 declare type IndexWidgetParams = {
+    /**
+     * The index or composition id to target.
+     */
     indexName: string;
+    /**
+     * Id to use for the index if there are multiple indices with the same name.
+     * This will be used to create the URL and the render state.
+     */
+    indexId?: string;
+    /**
+     * If `true`, the index will not be merged with the main helper's state.
+     * This means that the index will not be part of the main search request.
+     *
+     * @default false
+     */
+    EXPERIMENTAL_isolated?: false;
+} | {
+    /**
+     * If `true`, the index will not be merged with the main helper's state.
+     * This means that the index will not be part of the main search request.
+     *
+     * This option is EXPERIMENTAL, and implementation details may change in the future.
+     * Things that could change are:
+     * - which widgets get rendered when a change happens
+     * - whether the index searches automatically
+     * - whether the index is included in the URL / UiState
+     * - whether the index is included in server-side rendering
+     *
+     * @default false
+     */
+    EXPERIMENTAL_isolated: true;
+    /**
+     * The index or composition id to target.
+     */
+    indexName?: string;
+    /**
+     * Id to use for the index if there are multiple indices with the same name.
+     * This will be used to create the URL and the render state.
+     */
     indexId?: string;
 };
 
@@ -5125,7 +5232,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>): this;
+    addWidgets(widgets: Array<Widget | 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])`
@@ -5140,7 +5247,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
      *
      * The widgets must implement a `dispose()` method to clear their states.
      */
-    removeWidgets(widgets: Array<Widget | IndexWidget>): this;
+    removeWidgets(widgets: Array<Widget | IndexWidget | Widget[]>): this;
     /**
      * Ends the initialization of InstantSearch.js and triggers the
      * first search.
@@ -8116,9 +8223,9 @@ declare type Status = 'initial' | 'askingPermission' | 'waiting' | 'recognizing'
 
 declare type Template<TTemplateData = void> = string | ((data: TTemplateData, params: TemplateParams) => VNode | VNode[] | string | null);
 
-declare type Template_2 = (params: {
+declare type Template_2<TData = Record<string, unknown>> = (params: {
     html: typeof html;
-}) => VNode_2 | VNode_2[] | null;
+} & TData) => VNode_2 | VNode_2[] | null;
 
 declare type TemplateParams = {
     html: typeof html;
@@ -8132,7 +8239,7 @@ declare type TemplateParams = {
 };
 
 declare type Templates = {
-    [key: string]: Template<any> | TemplateWithBindEvent<any> | undefined;
+    [key: string]: Template<any> | TemplateWithBindEvent<any> | Templates | undefined;
 };
 
 declare namespace templates {
@@ -8598,7 +8705,8 @@ declare namespace widgets {
         _default_13 as trendingItems,
         voiceSearch,
         _default_14 as frequentlyBoughtTogether,
-        _default_15 as lookingSimilar
+        _default_15 as lookingSimilar,
+        chat
     }
 }