instantsearch.js 4.83.0 → 4.84.0

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.83.0";
+declare const _default: "4.84.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.83.0';
+export default '4.84.0';

package/es/widgets/autocomplete/autocomplete.d.ts

@@ -1,9 +1,19 @@
 
-import type { AutocompleteConnectorParams, AutocompleteWidgetDescription } from '../../connectors/autocomplete/connectAutocomplete';
+import type { AutocompleteConnectorParams, AutocompleteRenderState, AutocompleteWidgetDescription } from '../../connectors/autocomplete/connectAutocomplete';
 import type { BaseHit, IndexUiState, IndexWidget, Template, WidgetFactory } from '../../types';
+import type { PlainSearchParameters } from 'algoliasearch-helper';
 import type { AutocompleteClassNames, AutocompleteIndexClassNames, AutocompleteIndexConfig } from 'instantsearch-ui-components';
 export type AutocompleteCSSClasses = Partial<AutocompleteClassNames>;
-export type AutocompleteTemplates<TItem extends BaseHit> = Partial<Record<string, TItem>>;
+export type AutocompleteSearchParameters = Omit<PlainSearchParameters, 'index'>;
+export type AutocompleteTemplates = {
+    /**
+     * Template to use for the panel.
+     */
+    panel?: Template<{
+        elements: PanelElements;
+        indices: AutocompleteRenderState['indices'];
+    }>;
+};
 type IndexConfig<TItem extends BaseHit> = AutocompleteIndexConfig<TItem> & {
     templates?: Partial<{
         /**
@@ -20,8 +30,13 @@ type IndexConfig<TItem extends BaseHit> = AutocompleteIndexConfig<TItem> & {
             onSelect: () => void;
         }>;
     }>;
+    /**
+     * Search parameters to apply to this index.
+     */
+    searchParameters?: AutocompleteSearchParameters;
     cssClasses?: Partial<AutocompleteIndexClassNames>;
 };
+type PanelElements = Partial<Record<'recent' | 'suggestions' | (string & {}), preact.JSX.Element>>;
 type AutocompleteWidgetParams<TItem extends BaseHit> = {
     /**
      * CSS Selector or HTMLElement to insert the widget.
@@ -55,12 +70,16 @@ 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.
      */

package/es/widgets/autocomplete/autocomplete.js

@@ -19,6 +19,7 @@ import { Fragment, h, render } from 'preact';
 import { useEffect, useId, useMemo, useRef, useState } from 'preact/hooks';
 import TemplateComponent from "../../components/Template/Template.js";
 import { connectAutocomplete, connectSearchBox } from "../../connectors/index.umd.js";
+import { ReverseHighlight } from "../../helpers/components/index.js";
 import { component } from "../../lib/suit.js";
 import { prepareTemplateProps } from "../../lib/templating/index.js";
 import { createDocumentationMessageGenerator, getContainerNode, walkIndex } from "../../lib/utils/index.js";
@@ -83,7 +84,12 @@ var createRenderer = function createRenderer(params) {
       rendererParams.renderState = {
         indexTemplateProps: [],
         isolatedIndex: isolatedIndex,
-        targetIndex: targetIndex
+        targetIndex: targetIndex,
+        templateProps: 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;
@@ -101,7 +107,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;
@@ -156,17 +164,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 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(_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 h(TemplateComponent, _extends({}, props, {
         templateKey: "item",
         rootTagName: "fragment",
@@ -178,45 +197,36 @@ function AutocompleteWrapper(_ref) {
       }));
     };
   }
-  return h(Autocomplete, _extends({}, getRootProps(), {
-    classNames: cssClasses
-  }), 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'
-  }), h(AutocompletePanel, getPanelProps(), showRecent && 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 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 = 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, {
+          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] = prepareTemplateProps({
         defaultTemplates: {},
@@ -224,8 +234,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 h(TemplateComponent, _extends({}, renderState.indexTemplateProps[i], {
         templateKey: "header",
         rootTagName: "fragment",
@@ -234,9 +244,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 h(TemplateComponent, _extends({}, renderState.indexTemplateProps[i], {
         templateKey: "item",
         rootTagName: "fragment",
@@ -246,7 +256,8 @@ function AutocompleteWrapper(_ref) {
         }
       }));
     };
-    return h(AutocompleteIndex, {
+    var elementId = indexName === (showSuggestions === null || showSuggestions === void 0 ? void 0 : showSuggestions.indexName) ? 'suggestions' : indexName;
+    elements[elementId] = h(AutocompleteIndex, {
       key: indexId,
       HeaderComponent: headerComponent,
       ItemComponent: itemComponent,
@@ -258,26 +269,54 @@ function AutocompleteWrapper(_ref) {
       getItemProps: getItemProps,
       classNames: indicesConfig[i].cssClasses
     });
+  });
+  return h(Autocomplete, _extends({}, getRootProps(), {
+    classNames: cssClasses
+  }), 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'
+  }), h(AutocompletePanel, getPanelProps(), templates.panel ? h(TemplateComponent, _extends({}, renderState.templateProps, {
+    templateKey: "panel",
+    rootTagName: "fragment",
+    data: {
+      elements: elements,
+      indices: indices
+    }
+  })) : Object.keys(elements).map(function (elementId) {
+    return elements[elementId];
   })));
 }
 export 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 = getContainerNode(container);
+  var searchParameters = _objectSpread({
+    hitsPerPage: 5
+  }, userSearchParameters);
   var cssClasses = {
     root: cx(suit(), userCssClasses.root)
   };
@@ -288,7 +327,16 @@ export 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 h(AutocompleteSuggestion, {
+            item: _item,
+            onSelect: onSelectItem
+          }, h(ConditionalReverseHighlight, {
+            item: _item
+          }));
+        }
       }, showSuggestions.templates),
       cssClasses: {
         root: cx('ais-AutocompleteSuggestions', (_showSuggestions$cssC = showSuggestions.cssClasses) === null || _showSuggestions$cssC === void 0 ? void 0 : _showSuggestions$cssC.root),
@@ -311,10 +359,12 @@ export function EXPERIMENTAL_autocomplete(widgetParams) {
     onSelect: onSelect,
     cssClasses: cssClasses,
     showRecent: showRecent,
+    showSuggestions: showSuggestions,
     renderState: {
       indexTemplateProps: [],
       isolatedIndex: undefined,
-      targetIndex: undefined
+      targetIndex: undefined,
+      templateProps: undefined
     },
     templates: templates
   });
@@ -326,17 +376,29 @@ export function EXPERIMENTAL_autocomplete(widgetParams) {
   })({}), index({
     indexId: "ais-autocomplete-".concat(instanceId),
     EXPERIMENTAL_isolated: true
-  }).addWidgets([].concat(_toConsumableArray(indicesConfig.map(function (_ref0) {
-    var indexName = _ref0.indexName;
+  }).addWidgets([configure(searchParameters)].concat(_toConsumableArray(indicesConfig.map(function (_ref10) {
+    var indexName = _ref10.indexName,
+      indexSearchParameters = _ref10.searchParameters;
     return index({
       indexName: indexName,
       indexId: indexName
-    }).addWidgets([configure({
-      hitsPerPage: 5
-    })]);
+    }).addWidgets([configure(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 h(ReverseHighlight, {
+    attribute: "query",
+    hit: item
+  });
 }

package/es/widgets/index/index.d.ts

@@ -97,6 +97,11 @@ export type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<IndexW
      * @private
      */
     _isolated: boolean;
+    /**
+     * Schedules a search for this index only.
+     * @private
+     */
+    scheduleLocalSearch: () => void;
 };
 declare const index: (widgetParams: IndexWidgetParams) => IndexWidget;
 export default index;

package/es/widgets/index/index.js

@@ -15,7 +15,7 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
 function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
 function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
 import algoliasearchHelper from 'algoliasearch-helper';
-import { checkIndexUiState, createDocumentationMessageGenerator, resolveSearchParameters, mergeSearchParameters, warning, isIndexWidget, createInitArgs, createRenderArgs } from "../../lib/utils/index.js";
+import { checkIndexUiState, createDocumentationMessageGenerator, resolveSearchParameters, mergeSearchParameters, warning, isIndexWidget, createInitArgs, createRenderArgs, defer } from "../../lib/utils/index.js";
 import { addWidgetId } from "../../lib/utils/addWidgetId.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'index-widget'
@@ -197,6 +197,12 @@ var index = function index(widgetParams) {
         helper: helper
       })));
     },
+    scheduleLocalSearch: defer(function () {
+      if (isolated) {
+        var _helper2;
+        (_helper2 = helper) === null || _helper2 === void 0 ? void 0 : _helper2.search();
+      }
+    }),
     getWidgets: function getWidgets() {
       return localWidgets;
     },
@@ -262,8 +268,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();
         }
@@ -342,8 +347,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();
           }
@@ -597,7 +601,7 @@ var index = function index(widgetParams) {
     },
     dispose: function dispose() {
       var _this5 = this,
-        _helper4,
+        _helper3,
         _derivedHelper3;
       localWidgets.forEach(function (widget) {
         if (widget.dispose && helper) {
@@ -617,7 +621,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.83.0",
+  "version": "4.84.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",
@@ -35,7 +35,7 @@
     "algoliasearch-helper": "3.26.1",
     "hogan.js": "^3.0.2",
     "htm": "^3.0.0",
-    "instantsearch-ui-components": "0.14.0",
+    "instantsearch-ui-components": "0.15.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.81.0",
-    "@instantsearch/tests": "1.81.0",
-    "@instantsearch/testutils": "1.70.0",
+    "@instantsearch/mocks": "1.82.0",
+    "@instantsearch/tests": "1.82.0",
+    "@instantsearch/testutils": "1.71.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": "6e4bcd74b92f96761f514bee14824537ba36adf2"
+  "gitHead": "b4cb69c8cfaa9dc22dfe8fe695568cf5200f3893"
 }