instantsearch.js 4.85.1 → 4.86.0

package/es/widgets/autocomplete/autocomplete.js

@@ -1,3 +1,4 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 var _excluded = ["instanceId", "containerNode"];
 function _toConsumableArray(r) { return _arrayWithoutHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableSpread(); }
 function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
@@ -5,7 +6,6 @@ function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r)
 function _iterableToArray(r) { if ("undefined" != typeof Symbol && null != r[Symbol.iterator] || null != r["@@iterator"]) return Array.from(r); }
 function _arrayWithoutHoles(r) { if (Array.isArray(r)) return _arrayLikeToArray(r); }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
-function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
@@ -73,6 +73,7 @@ var createRenderer = function createRenderer(params) {
   return function (connectorParams, isFirstRendering) {
     if (isFirstRendering) {
       var _targetIndex$getHelpe, _targetIndex$getHelpe2;
+      var showRecentObj = rendererParams.showRecent;
       var isolatedIndex = connectorParams.instantSearchInstance.mainIndex;
       var targetIndex = connectorParams.instantSearchInstance.mainIndex;
       walkIndex(targetIndex, function (childIndex) {
@@ -81,6 +82,56 @@ var createRenderer = function createRenderer(params) {
           targetIndex = childIndex.parent;
         }
       });
+      var RecentSearchComponent = function RecentSearchComponent(_ref) {
+        var item = _ref.item,
+          onSelect = _ref.onSelect,
+          onApply = _ref.onApply,
+          onRemoveRecentSearch = _ref.onRemoveRecentSearch;
+        return h(AutocompleteRecentSearch, {
+          item: item,
+          onSelect: onSelect,
+          onApply: onApply,
+          onRemoveRecentSearch: onRemoveRecentSearch
+        }, h(ConditionalReverseHighlight, {
+          item: item
+        }));
+      };
+      var recentSearchHeaderComponent = undefined;
+      if (showRecentObj && showRecentObj.templates) {
+        var recentTemplateProps = prepareTemplateProps({
+          defaultTemplates: {},
+          templatesConfig: connectorParams.instantSearchInstance.templatesConfig,
+          templates: showRecentObj.templates
+        });
+        if (showRecentObj.templates.item) {
+          RecentSearchComponent = function RecentSearchComponent(_ref2) {
+            var item = _ref2.item,
+              onSelect = _ref2.onSelect,
+              onRemoveRecentSearch = _ref2.onRemoveRecentSearch;
+            return h(TemplateComponent, _extends({}, recentTemplateProps, {
+              templateKey: "item",
+              rootTagName: "fragment",
+              data: {
+                item: item,
+                onSelect: onSelect,
+                onRemoveRecentSearch: onRemoveRecentSearch
+              }
+            }));
+          };
+        }
+        if (showRecentObj.templates.header) {
+          recentSearchHeaderComponent = function recentSearchHeaderComponent(_ref3) {
+            var items = _ref3.items;
+            return h(TemplateComponent, _extends({}, recentTemplateProps, {
+              templateKey: "header",
+              rootTagName: "fragment",
+              data: {
+                items: items
+              }
+            }));
+          };
+        }
+      }
       rendererParams.renderState = {
         indexTemplateProps: [],
         isolatedIndex: isolatedIndex,
@@ -89,7 +140,9 @@ var createRenderer = function createRenderer(params) {
           defaultTemplates: {},
           templatesConfig: connectorParams.instantSearchInstance.templatesConfig,
           templates: rendererParams.templates
-        })
+        }),
+        RecentSearchComponent: RecentSearchComponent,
+        recentSearchHeaderComponent: recentSearchHeaderComponent
       };
       connectorParams.refine((_targetIndex$getHelpe = (_targetIndex$getHelpe2 = targetIndex.getHelper()) === null || _targetIndex$getHelpe2 === void 0 ? void 0 : _targetIndex$getHelpe2.state.query) !== null && _targetIndex$getHelpe !== void 0 ? _targetIndex$getHelpe : '');
       return;
@@ -97,20 +150,20 @@ var createRenderer = function createRenderer(params) {
     render(h(AutocompleteWrapper, _extends({}, rendererParams, connectorParams)), containerNode);
   };
 };
-function AutocompleteWrapper(_ref) {
-  var _isolatedIndex$getHel, _targetIndex$getWidge, _showRecent$templates;
-  var indicesConfig = _ref.indicesConfig,
-    indices = _ref.indices,
-    getSearchPageURL = _ref.getSearchPageURL,
-    userOnSelect = _ref.onSelect,
-    refineAutocomplete = _ref.refine,
-    cssClasses = _ref.cssClasses,
-    renderState = _ref.renderState,
-    instantSearchInstance = _ref.instantSearchInstance,
-    showRecent = _ref.showRecent,
-    showSuggestions = _ref.showSuggestions,
-    templates = _ref.templates,
-    placeholder = _ref.placeholder;
+function AutocompleteWrapper(_ref4) {
+  var _isolatedIndex$getHel, _showRecentObj$cssCla, _showRecentObj$cssCla2, _showRecentObj$cssCla3, _showRecentObj$cssCla4, _targetIndex$getWidge;
+  var indicesConfig = _ref4.indicesConfig,
+    indices = _ref4.indices,
+    getSearchPageURL = _ref4.getSearchPageURL,
+    userOnSelect = _ref4.onSelect,
+    refineAutocomplete = _ref4.refine,
+    cssClasses = _ref4.cssClasses,
+    renderState = _ref4.renderState,
+    instantSearchInstance = _ref4.instantSearchInstance,
+    showRecent = _ref4.showRecent,
+    showSuggestions = _ref4.showSuggestions,
+    templates = _ref4.templates,
+    placeholder = _ref4.placeholder;
   var isolatedIndex = renderState.isolatedIndex,
     targetIndex = renderState.targetIndex;
   var searchboxQuery = isolatedIndex === null || isolatedIndex === void 0 ? void 0 : (_isolatedIndex$getHel = isolatedIndex.getHelper()) === null || _isolatedIndex$getHel === void 0 ? void 0 : _isolatedIndex$getHel.state.query;
@@ -124,8 +177,15 @@ function AutocompleteWrapper(_ref) {
     storageHits = _useStorage.storageHits,
     indicesConfigForPropGetters = _useStorage.indicesConfigForPropGetters,
     indicesForPropGetters = _useStorage.indicesForPropGetters;
-  var isSearchPage = (_targetIndex$getWidge = targetIndex === null || targetIndex === void 0 ? void 0 : targetIndex.getWidgets().some(function (_ref2) {
-    var $$type = _ref2.$$type;
+  var showRecentObj = showRecent;
+  var recentSearchCssClasses = {
+    root: cx('ais-AutocompleteRecentSearches', showRecentObj === null || showRecentObj === void 0 ? void 0 : (_showRecentObj$cssCla = showRecentObj.cssClasses) === null || _showRecentObj$cssCla === void 0 ? void 0 : _showRecentObj$cssCla.root),
+    list: cx('ais-AutocompleteRecentSearchesList', showRecentObj === null || showRecentObj === void 0 ? void 0 : (_showRecentObj$cssCla2 = showRecentObj.cssClasses) === null || _showRecentObj$cssCla2 === void 0 ? void 0 : _showRecentObj$cssCla2.list),
+    header: cx('ais-AutocompleteRecentSearchesHeader', showRecentObj === null || showRecentObj === void 0 ? void 0 : (_showRecentObj$cssCla3 = showRecentObj.cssClasses) === null || _showRecentObj$cssCla3 === void 0 ? void 0 : _showRecentObj$cssCla3.header),
+    item: cx('ais-AutocompleteRecentSearchesItem', showRecentObj === null || showRecentObj === void 0 ? void 0 : (_showRecentObj$cssCla4 = showRecentObj.cssClasses) === null || _showRecentObj$cssCla4 === void 0 ? void 0 : _showRecentObj$cssCla4.item)
+  };
+  var isSearchPage = (_targetIndex$getWidge = targetIndex === null || targetIndex === void 0 ? void 0 : targetIndex.getWidgets().some(function (_ref5) {
+    var $$type = _ref5.$$type;
     return ['ais.hits', 'ais.infiniteHits'].includes($$type);
   })) !== null && _targetIndex$getWidge !== void 0 ? _targetIndex$getWidge : false;
   var onRefine = function onRefine(query) {
@@ -144,10 +204,10 @@ function AutocompleteWrapper(_ref) {
       indices: indicesForPropGetters,
       indicesConfig: indicesConfigForPropGetters,
       onRefine: onRefine,
-      onSelect: userOnSelect !== null && userOnSelect !== void 0 ? userOnSelect : function (_ref3) {
-        var query = _ref3.query,
-          setQuery = _ref3.setQuery,
-          url = _ref3.url;
+      onSelect: userOnSelect !== null && userOnSelect !== void 0 ? userOnSelect : function (_ref6) {
+        var query = _ref6.query,
+          setQuery = _ref6.setQuery,
+          url = _ref6.url;
         if (url) {
           window.location.href = url;
           return;
@@ -161,75 +221,44 @@ function AutocompleteWrapper(_ref) {
         }
         setQuery(query);
       },
+      onApply: function onApply(query) {
+        refineAutocomplete(query);
+      },
       placeholder: placeholder
     }),
     getInputProps = _usePropGetters.getInputProps,
     getItemProps = _usePropGetters.getItemProps,
     getPanelProps = _usePropGetters.getPanelProps,
     getRootProps = _usePropGetters.getRootProps;
-  var AutocompleteRecentSearchComponent = function AutocompleteRecentSearchComponent(_ref4) {
-    var item = _ref4.item,
-      onSelect = _ref4.onSelect,
-      onRemoveRecentSearch = _ref4.onRemoveRecentSearch;
-    return h(AutocompleteRecentSearch, {
-      item: item,
-      onSelect: onSelect,
-      onRemoveRecentSearch: onRemoveRecentSearch
-    }, h(ConditionalReverseHighlight, {
-      item: item
-    }));
-  };
-  if (_typeof(showRecent) === 'object' && (_showRecent$templates = showRecent.templates) !== null && _showRecent$templates !== void 0 && _showRecent$templates.item) {
-    var props = prepareTemplateProps({
-      defaultTemplates: {},
-      templatesConfig: instantSearchInstance.templatesConfig,
-      templates: showRecent.templates
-    });
-    AutocompleteRecentSearchComponent = function AutocompleteRecentSearchComponent(_ref5) {
-      var item = _ref5.item,
-        onSelect = _ref5.onSelect,
-        onRemoveRecentSearch = _ref5.onRemoveRecentSearch;
-      return h(TemplateComponent, _extends({}, props, {
-        templateKey: "item",
-        rootTagName: "fragment",
-        data: {
-          item: item,
-          onSelect: onSelect,
-          onRemoveRecentSearch: onRemoveRecentSearch
-        }
-      }));
-    };
-  }
   var elements = {};
   if (showRecent) {
-    elements.recent = h(AutocompleteIndex
-    // @ts-ignore - there seems to be problems with React.ComponentType and this, but it's actually correct
-    , {
-      ItemComponent: function ItemComponent(_ref6) {
-        var item = _ref6.item,
-          onSelect = _ref6.onSelect;
-        return h(AutocompleteRecentSearchComponent, {
+    elements.recent = h(AutocompleteIndex, {
+      HeaderComponent: renderState.recentSearchHeaderComponent
+      // @ts-ignore - there seems to be problems with React.ComponentType and this, but it's actually correct
+      ,
+      ItemComponent: function ItemComponent(_ref7) {
+        var item = _ref7.item,
+          onSelect = _ref7.onSelect,
+          onApply = _ref7.onApply;
+        return h(renderState.RecentSearchComponent, {
           item: item,
           onSelect: onSelect,
+          onApply: onApply,
           onRemoveRecentSearch: function onRemoveRecentSearch() {
             return storage.onRemove(item.query);
           }
         });
       },
-      classNames: {
-        root: 'ais-AutocompleteRecentSearches',
-        list: 'ais-AutocompleteRecentSearchesList',
-        item: 'ais-AutocompleteRecentSearchesItem'
-      },
+      classNames: recentSearchCssClasses,
       items: storageHits,
       getItemProps: getItemProps
     });
   }
-  indices.forEach(function (_ref7, i) {
+  indices.forEach(function (_ref8, i) {
     var _indicesConfig$i$temp;
-    var indexId = _ref7.indexId,
-      indexName = _ref7.indexName,
-      hits = _ref7.hits;
+    var indexId = _ref8.indexId,
+      indexName = _ref8.indexName,
+      hits = _ref8.hits;
     if (!renderState.indexTemplateProps[i]) {
       renderState.indexTemplateProps[i] = prepareTemplateProps({
         defaultTemplates: {},
@@ -237,8 +266,8 @@ function AutocompleteWrapper(_ref) {
         templates: indicesConfig[i].templates
       });
     }
-    var headerComponent = (_indicesConfig$i$temp = indicesConfig[i].templates) !== null && _indicesConfig$i$temp !== void 0 && _indicesConfig$i$temp.header ? function (_ref8) {
-      var items = _ref8.items;
+    var headerComponent = (_indicesConfig$i$temp = indicesConfig[i].templates) !== null && _indicesConfig$i$temp !== void 0 && _indicesConfig$i$temp.header ? function (_ref9) {
+      var items = _ref9.items;
       return h(TemplateComponent, _extends({}, renderState.indexTemplateProps[i], {
         templateKey: "header",
         rootTagName: "fragment",
@@ -247,15 +276,17 @@ function AutocompleteWrapper(_ref) {
         }
       }));
     } : undefined;
-    var itemComponent = function itemComponent(_ref9) {
-      var item = _ref9.item,
-        onSelect = _ref9.onSelect;
+    var itemComponent = function itemComponent(_ref0) {
+      var item = _ref0.item,
+        onSelect = _ref0.onSelect,
+        onApply = _ref0.onApply;
       return h(TemplateComponent, _extends({}, renderState.indexTemplateProps[i], {
         templateKey: "item",
         rootTagName: "fragment",
         data: {
           item: item,
-          onSelect: onSelect
+          onSelect: onSelect,
+          onApply: onApply
         }
       }));
     };
@@ -303,21 +334,21 @@ function AutocompleteWrapper(_ref) {
   })));
 }
 export function EXPERIMENTAL_autocomplete(widgetParams) {
-  var _ref0 = widgetParams || {},
-    container = _ref0.container,
-    escapeHTML = _ref0.escapeHTML,
-    _ref0$indices = _ref0.indices,
-    indices = _ref0$indices === void 0 ? [] : _ref0$indices,
-    showSuggestions = _ref0.showSuggestions,
-    showRecent = _ref0.showRecent,
-    userSearchParameters = _ref0.searchParameters,
-    getSearchPageURL = _ref0.getSearchPageURL,
-    onSelect = _ref0.onSelect,
-    _ref0$templates = _ref0.templates,
-    templates = _ref0$templates === void 0 ? {} : _ref0$templates,
-    _ref0$cssClasses = _ref0.cssClasses,
-    userCssClasses = _ref0$cssClasses === void 0 ? {} : _ref0$cssClasses,
-    placeholder = _ref0.placeholder;
+  var _ref1 = widgetParams || {},
+    container = _ref1.container,
+    escapeHTML = _ref1.escapeHTML,
+    _ref1$indices = _ref1.indices,
+    indices = _ref1$indices === void 0 ? [] : _ref1$indices,
+    showSuggestions = _ref1.showSuggestions,
+    showRecent = _ref1.showRecent,
+    userSearchParameters = _ref1.searchParameters,
+    getSearchPageURL = _ref1.getSearchPageURL,
+    onSelect = _ref1.onSelect,
+    _ref1$templates = _ref1.templates,
+    templates = _ref1$templates === void 0 ? {} : _ref1$templates,
+    _ref1$cssClasses = _ref1.cssClasses,
+    userCssClasses = _ref1$cssClasses === void 0 ? {} : _ref1$cssClasses,
+    placeholder = _ref1.placeholder;
   if (!container) {
     throw new Error(withUsage('The `container` option is required.'));
   }
@@ -335,12 +366,14 @@ export function EXPERIMENTAL_autocomplete(widgetParams) {
       indexName: showSuggestions.indexName,
       templates: _objectSpread({
         // @ts-expect-error
-        item: function item(_ref1) {
-          var _item = _ref1.item,
-            onSelectItem = _ref1.onSelect;
+        item: function item(_ref10) {
+          var _item = _ref10.item,
+            onSelectItem = _ref10.onSelect,
+            onApply = _ref10.onApply;
           return h(AutocompleteSuggestion, {
             item: _item,
-            onSelect: onSelectItem
+            onSelect: onSelectItem,
+            onApply: onApply
           }, h(ConditionalReverseHighlight, {
             item: _item
           }));
@@ -359,6 +392,8 @@ export function EXPERIMENTAL_autocomplete(widgetParams) {
     });
   }
   var instanceId = ++autocompleteInstanceId;
+  var shouldShowRecent = showRecent || undefined;
+  var showRecentOptions = typeof shouldShowRecent === 'boolean' ? {} : shouldShowRecent;
   var specializedRenderer = createRenderer({
     instanceId: instanceId,
     containerNode: containerNode,
@@ -366,14 +401,16 @@ export function EXPERIMENTAL_autocomplete(widgetParams) {
     getSearchPageURL: getSearchPageURL,
     onSelect: onSelect,
     cssClasses: cssClasses,
-    showRecent: showRecent,
+    showRecent: showRecentOptions,
     showSuggestions: showSuggestions,
     placeholder: placeholder,
     renderState: {
       indexTemplateProps: [],
       isolatedIndex: undefined,
       targetIndex: undefined,
-      templateProps: undefined
+      templateProps: undefined,
+      RecentSearchComponent: AutocompleteRecentSearch,
+      recentSearchHeaderComponent: undefined
     },
     templates: templates
   });
@@ -385,9 +422,9 @@ export function EXPERIMENTAL_autocomplete(widgetParams) {
   })({}), index({
     indexId: "ais-autocomplete-".concat(instanceId),
     EXPERIMENTAL_isolated: true
-  }).addWidgets([configure(searchParameters)].concat(_toConsumableArray(indicesConfig.map(function (_ref10) {
-    var indexName = _ref10.indexName,
-      indexSearchParameters = _ref10.searchParameters;
+  }).addWidgets([configure(searchParameters)].concat(_toConsumableArray(indicesConfig.map(function (_ref11) {
+    var indexName = _ref11.indexName,
+      indexSearchParameters = _ref11.searchParameters;
     return index({
       indexName: indexName,
       indexId: indexName
@@ -398,9 +435,9 @@ export function EXPERIMENTAL_autocomplete(widgetParams) {
     $$widgetType: 'ais.autocomplete'
   })]))];
 }
-function ConditionalReverseHighlight(_ref11) {
+function ConditionalReverseHighlight(_ref12) {
   var _item$_highlightResul;
-  var item = _ref11.item;
+  var item = _ref12.item;
   if (!((_item$_highlightResul = item._highlightResult) !== null && _item$_highlightResul !== void 0 && _item$_highlightResul.query) ||
   // @ts-expect-error - we should not have matchLevel as arrays here
   item._highlightResult.query.matchLevel === 'none') {

package/es/widgets/chat/chat.d.ts

@@ -1,7 +1,7 @@
 
 import { SearchIndexToolType, RecommendToolType } from '../../lib/chat';
 import type { ChatRenderState, ChatConnectorParams, ChatWidgetDescription } from '../../connectors/chat/connectChat';
-import type { WidgetFactory, Hit, TemplateWithBindEvent, BaseHit, Template, IndexUiState, IndexWidget } from '../../types';
+import type { WidgetFactory, Hit, TemplateWithBindEvent, BaseHit, Template, IndexUiState } from '../../types';
 import type { ChatClassNames, ChatHeaderProps, ChatMessageActionProps, ChatMessageBase, ChatMessageErrorProps, ChatMessageLoaderProps, ChatPromptProps, ChatToggleButtonProps, ClientSideToolComponentProps, ClientSideTools, RecordWithObjectID, UserClientSideTool } from 'instantsearch-ui-components';
 export { SearchIndexToolType, RecommendToolType };
 export type UserClientSideToolTemplates = Partial<{
@@ -276,155 +276,7 @@ declare const _default: <THit extends RecordWithObjectID = RecordWithObjectID>(w
         voiceSearch?: import("../../types").WidgetRenderState<import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchRenderState, import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchConnectorParams> | undefined;
         analytics?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../analytics/analytics").AnalyticsWidgetParams> | undefined;
         places?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../places/places").PlacesWidgetParams> | undefined;
-    }, renderOptions: import("../../types").InitOptions | import("../../types").RenderOptions): {
-        chat: {
-            indexUiState: Partial<{
-                query: string;
-            } & {
-                configure: import("algoliasearch-helper").PlainSearchParameters;
-            } & {
-                geoSearch: {
-                    boundingBox: string;
-                };
-            } & {
-                hierarchicalMenu: {
-                    [rootAttribute: string]: string[];
-                };
-            } & {
-                hitsPerPage: number;
-            } & {
-                page: number;
-            } & {
-                menu: {
-                    [attribute: string]: string;
-                };
-            } & {
-                numericMenu: {
-                    [attribute: string]: string;
-                };
-            } & {
-                page: number;
-            } & {
-                range: {
-                    [attribute: string]: string;
-                };
-            } & {
-                ratingMenu: {
-                    [attribute: string]: number | undefined;
-                };
-            } & {
-                refinementList: {
-                    [attribute: string]: string[];
-                };
-            } & {
-                relevantSort: number;
-            } & {
-                query: string;
-            } & {
-                sortBy: string;
-            } & {
-                toggle: {
-                    [attribute: string]: boolean;
-                };
-            } & {
-                query: string;
-            } & {
-                places: {
-                    query: string;
-                    position: string;
-                };
-            }>;
-            input: string;
-            open: boolean;
-            sendEvent: import("../../lib/utils").SendEventForHits;
-            setIndexUiState: IndexWidget["setIndexUiState"];
-            setInput: (input: string) => void;
-            setOpen: (open: boolean) => void;
-            setMessages: (messages: import("ai").UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>[] | ((m: import("ai").UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>[]) => import("ai").UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>[])) => void;
-            isClearing: boolean;
-            clearMessages: () => void;
-            onClearTransitionEnd: () => void;
-            tools: ClientSideTools;
-            readonly id: string;
-            readonly error: Error | undefined;
-            readonly status: import("ai").ChatStatus;
-            addToolResult: <TOOL extends string>({ tool, toolCallId, output, }: {
-                tool: TOOL;
-                toolCallId: string;
-                output: unknown;
-            }) => Promise<void>;
-            clearError: () => void;
-            messages: import("ai").UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>[];
-            regenerate: ({ messageId, ...options }?: {
-                messageId?: string;
-            } & import("ai").ChatRequestOptions) => Promise<void>;
-            resumeStream: (options?: import("ai").ChatRequestOptions) => Promise<void>;
-            sendMessage: (message?: (Omit<import("ai").UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>, "id" | "role"> & {
-                id?: string | undefined;
-                role?: "system" | "user" | "assistant" | undefined;
-            } & {
-                text?: never;
-                files?: never;
-                messageId?: string;
-            }) | {
-                text: string;
-                files?: FileList | import("ai").FileUIPart[];
-                metadata?: unknown;
-                parts?: never;
-                messageId?: string;
-            } | {
-                files: FileList | import("ai").FileUIPart[];
-                metadata?: unknown;
-                parts?: never;
-                messageId?: string;
-            } | undefined, options?: import("ai").ChatRequestOptions) => Promise<void>;
-            stop: () => Promise<void>;
-            widgetParams: ChatConnectorParams<import("ai").UIMessage<unknown, import("ai").UIDataTypes, import("ai").UITools>> & TWidgetParams;
-        };
-        answers?: import("../../types").WidgetRenderState<import("../../connectors/answers/connectAnswers").AnswersRenderState, import("../../connectors/answers/connectAnswers").AnswersConnectorParams> | undefined;
-        autocomplete?: import("../../types").WidgetRenderState<import("../../connectors/autocomplete/connectAutocomplete").AutocompleteRenderState, import("../../connectors/autocomplete/connectAutocomplete").AutocompleteConnectorParams> | undefined;
-        breadcrumb?: {
-            [rootAttribute: string]: import("../../types").WidgetRenderState<import("../../connectors/breadcrumb/connectBreadcrumb").BreadcrumbRenderState, import("../../connectors/breadcrumb/connectBreadcrumb").BreadcrumbConnectorParams>;
-        } | undefined;
-        clearRefinements?: import("../../types").WidgetRenderState<import("../../connectors/clear-refinements/connectClearRefinements").ClearRefinementsRenderState, import("../../connectors/clear-refinements/connectClearRefinements").ClearRefinementsConnectorParams> | undefined;
-        configure?: import("../../types").WidgetRenderState<import("../../connectors/configure/connectConfigure").ConfigureRenderState, import("../../connectors/configure/connectConfigure").ConfigureConnectorParams> | undefined;
-        currentRefinements?: import("../../types").WidgetRenderState<import("../../connectors/current-refinements/connectCurrentRefinements").CurrentRefinementsRenderState, import("../../connectors/current-refinements/connectCurrentRefinements").CurrentRefinementsConnectorParams> | undefined;
-        geoSearch?: import("../../types").WidgetRenderState<import("../../connectors/geo-search/connectGeoSearch").GeoSearchRenderState<import("../../types").GeoHit>, import("../../connectors/geo-search/connectGeoSearch").GeoSearchConnectorParams<import("../../types").GeoHit>> | undefined;
-        hierarchicalMenu?: {
-            [rootAttribute: string]: import("../../types").WidgetRenderState<import("../../connectors/hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuRenderState, import("../../connectors/hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuConnectorParams>;
-        } | undefined;
-        hits?: import("../../types").WidgetRenderState<import("../../connectors/hits/connectHits").HitsRenderState<BaseHit>, import("../../connectors/hits/connectHits").HitsConnectorParams<BaseHit>> | undefined;
-        hitsPerPage?: import("../../types").WidgetRenderState<import("../../connectors/hits-per-page/connectHitsPerPage").HitsPerPageRenderState, import("../../connectors/hits-per-page/connectHitsPerPage").HitsPerPageConnectorParams> | undefined;
-        infiniteHits?: import("../../types").WidgetRenderState<import("../../connectors/infinite-hits/connectInfiniteHits").InfiniteHitsRenderState<BaseHit>, import("../../connectors/infinite-hits/connectInfiniteHits").InfiniteHitsConnectorParams<BaseHit>> | undefined;
-        menu?: {
-            [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/menu/connectMenu").MenuRenderState, import("../../connectors/menu/connectMenu").MenuConnectorParams>;
-        } | undefined;
-        numericMenu?: {
-            [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/numeric-menu/connectNumericMenu").NumericMenuRenderState, import("../../connectors/numeric-menu/connectNumericMenu").NumericMenuConnectorParams>;
-        } | undefined;
-        pagination?: import("../../types").WidgetRenderState<import("../../connectors/pagination/connectPagination").PaginationRenderState, import("../../connectors/pagination/connectPagination").PaginationConnectorParams> | undefined;
-        poweredBy?: import("../../types").WidgetRenderState<import("../../connectors/powered-by/connectPoweredBy").PoweredByRenderState, import("../../connectors/powered-by/connectPoweredBy").PoweredByConnectorParams> | undefined;
-        queryRules?: import("../../types").WidgetRenderState<import("../../connectors/query-rules/connectQueryRules").QueryRulesRenderState, import("../../connectors/query-rules/connectQueryRules").QueryRulesConnectorParams> | undefined;
-        range?: {
-            [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/range/connectRange").RangeRenderState, import("../../connectors/range/connectRange").RangeConnectorParams>;
-        } | undefined;
-        ratingMenu?: {
-            [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/rating-menu/connectRatingMenu").RatingMenuRenderState, import("../../connectors/rating-menu/connectRatingMenu").RatingMenuConnectorParams>;
-        } | undefined;
-        refinementList?: {
-            [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/refinement-list/connectRefinementList").RefinementListRenderState, import("../../connectors/refinement-list/connectRefinementList").RefinementListConnectorParams>;
-        } | undefined;
-        relevantSort?: import("../../types").WidgetRenderState<import("../../connectors/relevant-sort/connectRelevantSort").RelevantSortRenderState, import("../../connectors/relevant-sort/connectRelevantSort").RelevantSortConnectorParams> | undefined;
-        searchBox?: import("../../types").WidgetRenderState<import("../../connectors/search-box/connectSearchBox").SearchBoxRenderState, import("../../connectors/search-box/connectSearchBox").SearchBoxConnectorParams> | undefined;
-        sortBy?: import("../../types").WidgetRenderState<import("../../connectors/sort-by/connectSortBy").SortByRenderState, import("../../connectors/sort-by/connectSortBy").SortByConnectorParams> | undefined;
-        stats?: import("../../types").WidgetRenderState<import("../../connectors/stats/connectStats").StatsRenderState, import("../../connectors/stats/connectStats").StatsConnectorParams> | undefined;
-        toggleRefinement?: {
-            [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/toggle-refinement/connectToggleRefinement").ToggleRefinementRenderState, import("../../connectors/toggle-refinement/connectToggleRefinement").ToggleRefinementConnectorParams>;
-        } | undefined;
-        voiceSearch?: import("../../types").WidgetRenderState<import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchRenderState, import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchConnectorParams> | undefined;
-        analytics?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../analytics/analytics").AnalyticsWidgetParams> | undefined;
-        places?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../places/places").PlacesWidgetParams> | undefined;
-    };
+    }, renderOptions: import("../../types").InitOptions | import("../../types").RenderOptions): import("../../types").IndexRenderState & ChatWidgetDescription["indexRenderState"];
     getWidgetRenderState(renderOptions: import("../../types").InitOptions | import("../../types").RenderOptions): {
         indexUiState: Partial<{
             query: string;

package/es/widgets/sort-by/sort-by.d.ts

@@ -24,16 +24,36 @@ export type SortByIndexDefinition = {
      * The label of the index to display.
      */
     label: string;
+    /**
+     * Ensures mutual exclusivity with strategy.
+     */
+    strategy?: never;
+};
+export type SortByStrategyDefinition = {
+    /**
+     * The name of the sorting strategy to use.
+     * Only available in composition mode.
+     */
+    strategy: string;
+    /**
+     * The label of the strategy to display.
+     */
+    label: string;
+    /**
+     * Ensures mutual exclusivity with value.
+     */
+    value?: never;
 };
+export type SortByDefinition = SortByIndexDefinition | SortByStrategyDefinition;
 export type SortByWidgetParams = {
     /**
      * CSS Selector or HTMLElement to insert the widget.
      */
     container: string | HTMLElement;
     /**
-     * Array of objects defining the different indices to choose from.
+     * Array of objects defining the different indices or strategies to choose from.
      */
-    items: SortByIndexDefinition[];
+    items: SortByDefinition[];
     /**
      * CSS classes to be added.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.85.1",
+  "version": "4.86.0",
   "description": "InstantSearch.js is a JavaScript library for building performant and instant search experiences with Algolia.",
   "homepage": "https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/",
   "types": "es/index.d.ts",
@@ -32,10 +32,10 @@
     "@types/hogan.js": "^3.0.0",
     "@types/qs": "^6.5.3",
     "ai": "^5.0.18",
-    "algoliasearch-helper": "3.26.1",
+    "algoliasearch-helper": "3.27.0",
     "hogan.js": "^3.0.2",
     "htm": "^3.0.0",
-    "instantsearch-ui-components": "0.15.2",
+    "instantsearch-ui-components": "0.16.0",
     "preact": "^10.10.0",
     "qs": "^6.5.1 < 6.10",
     "react": ">= 0.14.0",
@@ -60,9 +60,9 @@
     "watch:es": "yarn --silent build:es:base --watch"
   },
   "devDependencies": {
-    "@instantsearch/mocks": "1.84.0",
-    "@instantsearch/tests": "1.84.0",
-    "@instantsearch/testutils": "1.73.0",
+    "@instantsearch/mocks": "1.86.0",
+    "@instantsearch/tests": "1.86.0",
+    "@instantsearch/testutils": "1.75.0",
     "@storybook/html": "5.3.9",
     "@types/scriptjs": "0.0.2",
     "algoliasearch": "5.1.1",
@@ -70,5 +70,5 @@
     "scriptjs": "2.5.9",
     "webpack": "4.47.0"
   },
-  "gitHead": "00ba8af52fcf72388a8da9c1ab22079b5de9ca63"
+  "gitHead": "13c7c916b870f34f5f6dde9bd7b16850990dc7ea"
 }