instantsearch.js 4.83.0 → 4.84.0

package/cjs/lib/version.js

@@ -4,4 +4,4 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _default = exports.default = '4.83.0';
+var _default = exports.default = '4.84.0';

package/cjs/widgets/autocomplete/autocomplete.js

@@ -9,6 +9,7 @@ var _preact = require("preact");
 var _hooks = require("preact/hooks");
 var _Template = _interopRequireDefault(require("../../components/Template/Template"));
 var _index = require("../../connectors/index.umd");
+var _components = require("../../helpers/components");
 var _suit = require("../../lib/suit");
 var _templating = require("../../lib/templating");
 var _utils = require("../../lib/utils");
@@ -90,7 +91,12 @@ var createRenderer = function createRenderer(params) {
       rendererParams.renderState = {
         indexTemplateProps: [],
         isolatedIndex: isolatedIndex,
-        targetIndex: targetIndex
+        targetIndex: targetIndex,
+        templateProps: (0, _templating.prepareTemplateProps)({
+          defaultTemplates: {},
+          templatesConfig: connectorParams.instantSearchInstance.templatesConfig,
+          templates: rendererParams.templates
+        })
       };
       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;
@@ -108,7 +114,9 @@ function AutocompleteWrapper(_ref) {
     cssClasses = _ref.cssClasses,
     renderState = _ref.renderState,
     instantSearchInstance = _ref.instantSearchInstance,
-    showRecent = _ref.showRecent;
+    showRecent = _ref.showRecent,
+    showSuggestions = _ref.showSuggestions,
+    templates = _ref.templates;
   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;
@@ -163,17 +171,28 @@ function AutocompleteWrapper(_ref) {
     getItemProps = _usePropGetters.getItemProps,
     getPanelProps = _usePropGetters.getPanelProps,
     getRootProps = _usePropGetters.getRootProps;
-  var AutocompleteRecentSearchComponent = AutocompleteRecentSearch;
+  var AutocompleteRecentSearchComponent = function AutocompleteRecentSearchComponent(_ref4) {
+    var item = _ref4.item,
+      onSelect = _ref4.onSelect,
+      onRemoveRecentSearch = _ref4.onRemoveRecentSearch;
+    return (0, _preact.h)(AutocompleteRecentSearch, {
+      item: item,
+      onSelect: onSelect,
+      onRemoveRecentSearch: onRemoveRecentSearch
+    }, (0, _preact.h)(ConditionalReverseHighlight, {
+      item: item
+    }));
+  };
   if (_typeof(showRecent) === 'object' && (_showRecent$templates = showRecent.templates) !== null && _showRecent$templates !== void 0 && _showRecent$templates.item) {
     var props = (0, _templating.prepareTemplateProps)({
       defaultTemplates: {},
       templatesConfig: instantSearchInstance.templatesConfig,
       templates: showRecent.templates
     });
-    AutocompleteRecentSearchComponent = function AutocompleteRecentSearchComponent(_ref4) {
-      var item = _ref4.item,
-        onSelect = _ref4.onSelect,
-        onRemoveRecentSearch = _ref4.onRemoveRecentSearch;
+    AutocompleteRecentSearchComponent = function AutocompleteRecentSearchComponent(_ref5) {
+      var item = _ref5.item,
+        onSelect = _ref5.onSelect,
+        onRemoveRecentSearch = _ref5.onRemoveRecentSearch;
       return (0, _preact.h)(_Template.default, _extends({}, props, {
         templateKey: "item",
         rootTagName: "fragment",
@@ -185,45 +204,36 @@ function AutocompleteWrapper(_ref) {
       }));
     };
   }
-  return (0, _preact.h)(Autocomplete, _extends({}, getRootProps(), {
-    classNames: cssClasses
-  }), (0, _preact.h)(AutocompleteSearchBox, {
-    query: searchboxQuery || '',
-    inputProps: _objectSpread(_objectSpread({}, getInputProps()), {}, {
-      // @ts-ignore - This clashes with some ambient React JSX declarations.
-      onInput: function onInput(evt) {
-        return refine(evt.currentTarget.value);
-      }
-    }),
-    onClear: function onClear() {
-      return onRefine('');
-    },
-    isSearchStalled: instantSearchInstance.status === 'stalled'
-  }), (0, _preact.h)(AutocompletePanel, getPanelProps(), showRecent && (0, _preact.h)(AutocompleteIndex
-  // @ts-ignore - there seems to be problems with React.ComponentType and this, but it's actually correct
-  , {
-    ItemComponent: function ItemComponent(_ref5) {
-      var item = _ref5.item,
-        onSelect = _ref5.onSelect;
-      return (0, _preact.h)(AutocompleteRecentSearchComponent, {
-        item: item,
-        onSelect: onSelect,
-        onRemoveRecentSearch: function onRemoveRecentSearch() {
-          return storage.onRemove(item.query);
-        }
-      });
-    },
-    classNames: {
-      root: 'ais-AutocompleteRecentSearches',
-      list: 'ais-AutocompleteRecentSearchesList',
-      item: 'ais-AutocompleteRecentSearchesItem'
-    },
-    items: storageHits,
-    getItemProps: getItemProps
-  }), indices.map(function (_ref6, i) {
+  var elements = {};
+  if (showRecent) {
+    elements.recent = (0, _preact.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 (0, _preact.h)(AutocompleteRecentSearchComponent, {
+          item: item,
+          onSelect: onSelect,
+          onRemoveRecentSearch: function onRemoveRecentSearch() {
+            return storage.onRemove(item.query);
+          }
+        });
+      },
+      classNames: {
+        root: 'ais-AutocompleteRecentSearches',
+        list: 'ais-AutocompleteRecentSearchesList',
+        item: 'ais-AutocompleteRecentSearchesItem'
+      },
+      items: storageHits,
+      getItemProps: getItemProps
+    });
+  }
+  indices.forEach(function (_ref7, i) {
     var _indicesConfig$i$temp;
-    var indexId = _ref6.indexId,
-      hits = _ref6.hits;
+    var indexId = _ref7.indexId,
+      indexName = _ref7.indexName,
+      hits = _ref7.hits;
     if (!renderState.indexTemplateProps[i]) {
       renderState.indexTemplateProps[i] = (0, _templating.prepareTemplateProps)({
         defaultTemplates: {},
@@ -231,8 +241,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 (_ref7) {
-      var items = _ref7.items;
+    var headerComponent = (_indicesConfig$i$temp = indicesConfig[i].templates) !== null && _indicesConfig$i$temp !== void 0 && _indicesConfig$i$temp.header ? function (_ref8) {
+      var items = _ref8.items;
       return (0, _preact.h)(_Template.default, _extends({}, renderState.indexTemplateProps[i], {
         templateKey: "header",
         rootTagName: "fragment",
@@ -241,9 +251,9 @@ function AutocompleteWrapper(_ref) {
         }
       }));
     } : undefined;
-    var itemComponent = function itemComponent(_ref8) {
-      var item = _ref8.item,
-        onSelect = _ref8.onSelect;
+    var itemComponent = function itemComponent(_ref9) {
+      var item = _ref9.item,
+        onSelect = _ref9.onSelect;
       return (0, _preact.h)(_Template.default, _extends({}, renderState.indexTemplateProps[i], {
         templateKey: "item",
         rootTagName: "fragment",
@@ -253,7 +263,8 @@ function AutocompleteWrapper(_ref) {
         }
       }));
     };
-    return (0, _preact.h)(AutocompleteIndex, {
+    var elementId = indexName === (showSuggestions === null || showSuggestions === void 0 ? void 0 : showSuggestions.indexName) ? 'suggestions' : indexName;
+    elements[elementId] = (0, _preact.h)(AutocompleteIndex, {
       key: indexId,
       HeaderComponent: headerComponent,
       ItemComponent: itemComponent,
@@ -265,26 +276,54 @@ function AutocompleteWrapper(_ref) {
       getItemProps: getItemProps,
       classNames: indicesConfig[i].cssClasses
     });
+  });
+  return (0, _preact.h)(Autocomplete, _extends({}, getRootProps(), {
+    classNames: cssClasses
+  }), (0, _preact.h)(AutocompleteSearchBox, {
+    query: searchboxQuery || '',
+    inputProps: _objectSpread(_objectSpread({}, getInputProps()), {}, {
+      // @ts-ignore - This clashes with some ambient React JSX declarations.
+      onInput: function onInput(evt) {
+        return refine(evt.currentTarget.value);
+      }
+    }),
+    onClear: function onClear() {
+      return onRefine('');
+    },
+    isSearchStalled: instantSearchInstance.status === 'stalled'
+  }), (0, _preact.h)(AutocompletePanel, getPanelProps(), templates.panel ? (0, _preact.h)(_Template.default, _extends({}, renderState.templateProps, {
+    templateKey: "panel",
+    rootTagName: "fragment",
+    data: {
+      elements: elements,
+      indices: indices
+    }
+  })) : Object.keys(elements).map(function (elementId) {
+    return elements[elementId];
   })));
 }
 function EXPERIMENTAL_autocomplete(widgetParams) {
-  var _ref9 = widgetParams || {},
-    container = _ref9.container,
-    escapeHTML = _ref9.escapeHTML,
-    _ref9$indices = _ref9.indices,
-    indices = _ref9$indices === void 0 ? [] : _ref9$indices,
-    showSuggestions = _ref9.showSuggestions,
-    showRecent = _ref9.showRecent,
-    getSearchPageURL = _ref9.getSearchPageURL,
-    onSelect = _ref9.onSelect,
-    _ref9$templates = _ref9.templates,
-    templates = _ref9$templates === void 0 ? {} : _ref9$templates,
-    _ref9$cssClasses = _ref9.cssClasses,
-    userCssClasses = _ref9$cssClasses === void 0 ? {} : _ref9$cssClasses;
+  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;
   if (!container) {
     throw new Error(withUsage('The `container` option is required.'));
   }
   var containerNode = (0, _utils.getContainerNode)(container);
+  var searchParameters = _objectSpread({
+    hitsPerPage: 5
+  }, userSearchParameters);
   var cssClasses = {
     root: (0, _instantsearchUiComponents.cx)(suit(), userCssClasses.root)
   };
@@ -295,7 +334,16 @@ function EXPERIMENTAL_autocomplete(widgetParams) {
       indexName: showSuggestions.indexName,
       templates: _objectSpread({
         // @ts-expect-error
-        item: AutocompleteSuggestion
+        item: function item(_ref1) {
+          var _item = _ref1.item,
+            onSelectItem = _ref1.onSelect;
+          return (0, _preact.h)(AutocompleteSuggestion, {
+            item: _item,
+            onSelect: onSelectItem
+          }, (0, _preact.h)(ConditionalReverseHighlight, {
+            item: _item
+          }));
+        }
       }, showSuggestions.templates),
       cssClasses: {
         root: (0, _instantsearchUiComponents.cx)('ais-AutocompleteSuggestions', (_showSuggestions$cssC = showSuggestions.cssClasses) === null || _showSuggestions$cssC === void 0 ? void 0 : _showSuggestions$cssC.root),
@@ -318,10 +366,12 @@ function EXPERIMENTAL_autocomplete(widgetParams) {
     onSelect: onSelect,
     cssClasses: cssClasses,
     showRecent: showRecent,
+    showSuggestions: showSuggestions,
     renderState: {
       indexTemplateProps: [],
       isolatedIndex: undefined,
-      targetIndex: undefined
+      targetIndex: undefined,
+      templateProps: undefined
     },
     templates: templates
   });
@@ -333,17 +383,29 @@ function EXPERIMENTAL_autocomplete(widgetParams) {
   })({}), (0, _index2.default)({
     indexId: "ais-autocomplete-".concat(instanceId),
     EXPERIMENTAL_isolated: true
-  }).addWidgets([].concat(_toConsumableArray(indicesConfig.map(function (_ref0) {
-    var indexName = _ref0.indexName;
+  }).addWidgets([(0, _configure.default)(searchParameters)].concat(_toConsumableArray(indicesConfig.map(function (_ref10) {
+    var indexName = _ref10.indexName,
+      indexSearchParameters = _ref10.searchParameters;
     return (0, _index2.default)({
       indexName: indexName,
       indexId: indexName
-    }).addWidgets([(0, _configure.default)({
-      hitsPerPage: 5
-    })]);
+    }).addWidgets([(0, _configure.default)(indexSearchParameters || {})]);
   })), [_objectSpread(_objectSpread({}, makeWidget({
     escapeHTML: escapeHTML
   })), {}, {
     $$widgetType: 'ais.autocomplete'
   })]))];
+}
+function ConditionalReverseHighlight(_ref11) {
+  var _item$_highlightResul;
+  var item = _ref11.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') {
+    return item.query;
+  }
+  return (0, _preact.h)(_components.ReverseHighlight, {
+    attribute: "query",
+    hit: item
+  });
 }

package/cjs/widgets/index/index.js

@@ -204,6 +204,12 @@ var index = function index(widgetParams) {
         helper: helper
       })));
     },
+    scheduleLocalSearch: (0, _utils.defer)(function () {
+      if (isolated) {
+        var _helper2;
+        (_helper2 = helper) === null || _helper2 === void 0 ? void 0 : _helper2.search();
+      }
+    }),
     getWidgets: function getWidgets() {
       return localWidgets;
     },
@@ -269,8 +275,7 @@ var index = function index(widgetParams) {
           }
         });
         if (isolated) {
-          var _helper2;
-          (_helper2 = helper) === null || _helper2 === void 0 ? void 0 : _helper2.search();
+          this.scheduleLocalSearch();
         } else {
           localInstantSearchInstance.scheduleSearch();
         }
@@ -349,8 +354,7 @@ var index = function index(widgetParams) {
         helper.recommendState = cleanedRecommendState;
         if (localWidgets.length) {
           if (isolated) {
-            var _helper3;
-            (_helper3 = helper) === null || _helper3 === void 0 ? void 0 : _helper3.search();
+            this.scheduleLocalSearch();
           } else {
             localInstantSearchInstance.scheduleSearch();
           }
@@ -604,7 +608,7 @@ var index = function index(widgetParams) {
     },
     dispose: function dispose() {
       var _this5 = this,
-        _helper4,
+        _helper3,
         _derivedHelper3;
       localWidgets.forEach(function (widget) {
         if (widget.dispose && helper) {
@@ -624,7 +628,7 @@ var index = function index(widgetParams) {
       });
       localInstantSearchInstance = null;
       localParent = null;
-      (_helper4 = helper) === null || _helper4 === void 0 ? void 0 : _helper4.removeAllListeners();
+      (_helper3 = helper) === null || _helper3 === void 0 ? void 0 : _helper3.removeAllListeners();
       helper = null;
       (_derivedHelper3 = derivedHelper) === null || _derivedHelper3 === void 0 ? void 0 : _derivedHelper3.detach();
       derivedHelper = null;

package/dist/instantsearch.development.d.ts

@@ -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';
@@ -355,12 +365,16 @@ declare type AutocompleteWidgetParams<TItem extends BaseHit> = {
             }>;
         }>;
     };
+    /**
+     * 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.
      */
@@ -4887,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>;
 };
 
@@ -4947,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 = {
@@ -6350,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<{