instantsearch.js 4.53.0 → 4.54.1

package/es/components/Pagination/Pagination.js

@@ -1,6 +1,7 @@
 import { cx } from '@algolia/ui-components-shared';
 import { h } from 'preact';
 import { isSpecialClick } from "../../lib/utils/index.js";
+import Template from "../Template/Template.js";
 function Pagination(props) {
   function createClickHandler(pageNumber) {
     return function (event) {
@@ -21,7 +22,8 @@ function Pagination(props) {
     ariaLabel: "First",
     className: props.cssClasses.firstPageItem,
     isDisabled: props.isFirstPage,
-    label: props.templates.first,
+    templates: props.templates,
+    templateKey: "first",
     pageNumber: 0,
     createURL: props.createURL,
     cssClasses: props.cssClasses,
@@ -30,7 +32,8 @@ function Pagination(props) {
     ariaLabel: "Previous",
     className: props.cssClasses.previousPageItem,
     isDisabled: props.isFirstPage,
-    label: props.templates.previous,
+    templates: props.templates,
+    templateKey: "previous",
     pageNumber: props.currentPage - 1,
     createURL: props.createURL,
     cssClasses: props.cssClasses,
@@ -41,7 +44,8 @@ function Pagination(props) {
       ariaLabel: "Page ".concat(pageNumber + 1),
       className: props.cssClasses.pageItem,
       isSelected: pageNumber === props.currentPage,
-      label: "".concat(pageNumber + 1),
+      templates: props.templates,
+      templateKey: "page",
       pageNumber: pageNumber,
       createURL: props.createURL,
       cssClasses: props.cssClasses,
@@ -51,7 +55,8 @@ function Pagination(props) {
     ariaLabel: "Next",
     className: props.cssClasses.nextPageItem,
     isDisabled: props.isLastPage,
-    label: props.templates.next,
+    templates: props.templates,
+    templateKey: "next",
     pageNumber: props.currentPage + 1,
     createURL: props.createURL,
     cssClasses: props.cssClasses,
@@ -60,7 +65,8 @@ function Pagination(props) {
     ariaLabel: "Last",
     className: props.cssClasses.lastPageItem,
     isDisabled: props.isLastPage,
-    label: props.templates.last,
+    templates: props.templates,
+    templateKey: "last",
     pageNumber: props.nbPages - 1,
     createURL: props.createURL,
     cssClasses: props.cssClasses,
@@ -68,7 +74,8 @@ function Pagination(props) {
   })));
 }
 function PaginationLink(_ref) {
-  var label = _ref.label,
+  var templates = _ref.templates,
+    templateKey = _ref.templateKey,
     ariaLabel = _ref.ariaLabel,
     pageNumber = _ref.pageNumber,
     className = _ref.className,
@@ -81,18 +88,28 @@ function PaginationLink(_ref) {
     createClickHandler = _ref.createClickHandler;
   return h("li", {
     className: cx(cssClasses.item, className, isDisabled && cssClasses.disabledItem, isSelected && cssClasses.selectedItem)
-  }, isDisabled ? h("span", {
-    className: cssClasses.link,
-    dangerouslySetInnerHTML: {
-      __html: label
+  }, isDisabled ? h(Template, {
+    rootTagName: "span",
+    rootProps: {
+      className: cssClasses.link
+    },
+    templateKey: templateKey,
+    templates: templates,
+    data: {
+      page: pageNumber + 1
     }
-  }) : h("a", {
-    className: cssClasses.link,
-    "aria-label": ariaLabel,
-    href: createURL(pageNumber),
-    onClick: createClickHandler(pageNumber),
-    dangerouslySetInnerHTML: {
-      __html: label
+  }) : h(Template, {
+    rootTagName: "a",
+    rootProps: {
+      className: cssClasses.link,
+      'aria-label': ariaLabel,
+      href: createURL(pageNumber),
+      onClick: createClickHandler(pageNumber)
+    },
+    templateKey: templateKey,
+    templates: templates,
+    data: {
+      page: pageNumber + 1
     }
   }));
 }

package/es/components/Panel/Panel.d.ts

@@ -3,7 +3,7 @@ import { h } from 'preact';
 import type { ComponentCSSClasses, UnknownWidgetFactory } from '../../types';
 import type { PanelCSSClasses, PanelSharedOptions, PanelTemplates } from '../../widgets/panel/panel';
 export type PanelComponentCSSClasses = ComponentCSSClasses<Omit<PanelCSSClasses, 'collapseIcon'>>;
-export type PanelComponentTemplates<TWidget extends UnknownWidgetFactory> = Required<PanelTemplates<TWidget>>;
+export type PanelComponentTemplates<TWidget extends UnknownWidgetFactory> = PanelTemplates<TWidget>;
 export type PanelProps<TWidget extends UnknownWidgetFactory> = {
     hidden: boolean;
     collapsible: boolean;

package/es/components/Template/Template.js

@@ -40,9 +40,12 @@ var Template = /*#__PURE__*/function (_Component) {
     key: "render",
     value: function render() {
       var _this = this;
-      process.env.NODE_ENV === 'development' ? warning(Object.keys(this.props.templates).every(function (key) {
-        return typeof _this.props.templates[key] === 'function';
-      }), "Hogan.js and string-based templates are deprecated and will not be supported in InstantSearch.js 5.x.\n\nYou can replace them with function-form templates and use either the provided `html` function or JSX templates.\n\nSee: https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/#upgrade-templates") : void 0;
+      if (process.env.NODE_ENV === 'development') {
+        var nonFunctionTemplates = Object.keys(this.props.templates).filter(function (key) {
+          return typeof _this.props.templates[key] !== 'function';
+        });
+        process.env.NODE_ENV === 'development' ? warning(nonFunctionTemplates.length === 0, "Hogan.js and string-based templates are deprecated and will not be supported in InstantSearch.js 5.x.\n\nYou can replace them with function-form templates and use either the provided `html` function or JSX templates.\n\nString-based templates: ".concat(nonFunctionTemplates.join(', '), ".\n\nSee: https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/#upgrade-templates")) : void 0;
+      }
       var RootTagName = this.props.rootTagName;
       var useCustomCompileOptions = this.props.useCustomCompileOptions[this.props.templateKey];
       var compileOptions = useCustomCompileOptions ? this.props.templatesConfig.compileOptions : {};

package/es/connectors/hierarchical-menu/connectHierarchicalMenu.js

@@ -203,6 +203,10 @@ var connectHierarchicalMenu = function connectHierarchicalMenu(renderFn) {
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
         var uiState = _ref6.uiState;
         var values = uiState.hierarchicalMenu && uiState.hierarchicalMenu[hierarchicalFacetName];
+        if (searchParameters.isConjunctiveFacet(hierarchicalFacetName) || searchParameters.isDisjunctiveFacet(hierarchicalFacetName)) {
+          process.env.NODE_ENV === 'development' ? warning(false, "HierarchicalMenu: Attribute \"".concat(hierarchicalFacetName, "\" is already used by another widget applying conjunctive or disjunctive faceting.\nAs this is not supported, please make sure to remove this other widget or this HierarchicalMenu widget will not work at all.")) : void 0;
+          return searchParameters;
+        }
         if (searchParameters.isHierarchicalFacet(hierarchicalFacetName)) {
           var facet = searchParameters.getHierarchicalFacetByName(hierarchicalFacetName);
           process.env.NODE_ENV === 'development' ? warning(isEqual(facet.attributes, attributes) && facet.separator === separator && facet.rootPath === rootPath, 'Using Breadcrumb and HierarchicalMenu on the same facet with different options overrides the configuration of the HierarchicalMenu.') : void 0;

package/es/connectors/menu/connectMenu.js

@@ -13,7 +13,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
-import { checkRendering, createDocumentationMessageGenerator, createSendEventForFacet, noop } from "../../lib/utils/index.js";
+import { checkRendering, createDocumentationMessageGenerator, createSendEventForFacet, noop, warning } from "../../lib/utils/index.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'menu',
   connector: true
@@ -175,6 +175,10 @@ var connectMenu = function connectMenu(renderFn) {
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref5) {
         var uiState = _ref5.uiState;
         var value = uiState.menu && uiState.menu[attribute];
+        if (searchParameters.isConjunctiveFacet(attribute) || searchParameters.isDisjunctiveFacet(attribute)) {
+          process.env.NODE_ENV === 'development' ? warning(false, "Menu: Attribute \"".concat(attribute, "\" is already used by another widget applying conjunctive or disjunctive faceting.\nAs this is not supported, please make sure to remove this other widget or this Menu widget will not work at all.")) : void 0;
+          return searchParameters;
+        }
         var withFacetConfiguration = searchParameters.removeHierarchicalFacet(attribute).addHierarchicalFacet({
           name: attribute,
           attributes: [attribute]

package/es/connectors/refinement-list/connectRefinementList.js

@@ -8,7 +8,7 @@ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _ty
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
-import { escapeFacets, TAG_PLACEHOLDER, TAG_REPLACEMENT, checkRendering, createDocumentationMessageGenerator, createSendEventForFacet, noop } from "../../lib/utils/index.js";
+import { escapeFacets, TAG_PLACEHOLDER, TAG_REPLACEMENT, checkRendering, createDocumentationMessageGenerator, createSendEventForFacet, noop, warning } from "../../lib/utils/index.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'refinement-list',
   connector: true
@@ -247,6 +247,14 @@ var connectRefinementList = function connectRefinementList(renderFn) {
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
         var uiState = _ref6.uiState;
         var isDisjunctive = operator === 'or';
+        if (searchParameters.isHierarchicalFacet(attribute)) {
+          process.env.NODE_ENV === 'development' ? warning(false, "RefinementList: Attribute \"".concat(attribute, "\" is already used by another widget applying hierarchical faceting.\nAs this is not supported, please make sure to remove this other widget or this RefinementList widget will not work at all.")) : void 0;
+          return searchParameters;
+        }
+        if (isDisjunctive && searchParameters.isConjunctiveFacet(attribute) || !isDisjunctive && searchParameters.isDisjunctiveFacet(attribute)) {
+          process.env.NODE_ENV === 'development' ? warning(false, "RefinementList: Attribute \"".concat(attribute, "\" is used by another refinement list with a different operator.\nAs this is not supported, please make sure to only use this attribute with one of the two operators.")) : void 0;
+          return searchParameters;
+        }
         var values = uiState.refinementList && uiState.refinementList[attribute];
         var withoutRefinements = searchParameters.clearRefinements(attribute);
         var withFacetConfiguration = isDisjunctive ? withoutRefinements.addDisjunctiveFacet(attribute) : withoutRefinements.addFacet(attribute);

package/es/connectors/toggle-refinement/connectToggleRefinement.js

@@ -4,7 +4,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
-import { checkRendering, escapeFacetValue, createDocumentationMessageGenerator, find, noop, toArray } from "../../lib/utils/index.js";
+import { checkRendering, escapeFacetValue, createDocumentationMessageGenerator, find, noop, toArray, warning } from "../../lib/utils/index.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'toggle-refinement',
   connector: true
@@ -251,6 +251,10 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
       },
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref11) {
         var uiState = _ref11.uiState;
+        if (searchParameters.isHierarchicalFacet(attribute) || searchParameters.isConjunctiveFacet(attribute)) {
+          process.env.NODE_ENV === 'development' ? warning(false, "ToggleRefinement: Attribute \"".concat(attribute, "\" is already used by another widget of a different type.\nAs this is not supported, please make sure to remove this other widget or this ToggleRefinement widget will not work at all.")) : void 0;
+          return searchParameters;
+        }
         var withFacetConfiguration = searchParameters.clearRefinements(attribute).addDisjunctiveFacet(attribute);
         var isRefined = Boolean(uiState.toggle && uiState.toggle[attribute]);
         if (isRefined) {

package/es/helpers/highlight.d.ts

@@ -7,4 +7,7 @@ export type HighlightOptions = {
         highlighted: string;
     }>;
 };
+/**
+ * @deprecated use html tagged templates and the Highlight component instead
+ */
 export default function highlight({ attribute, highlightedTagName, hit, cssClasses, }: HighlightOptions): string;

package/es/helpers/highlight.js

@@ -1,6 +1,10 @@
 import { component } from "../lib/suit.js";
 import { getPropertyByPath, TAG_REPLACEMENT, warning } from "../lib/utils/index.js";
 var suit = component('Highlight');
+
+/**
+ * @deprecated use html tagged templates and the Highlight component instead
+ */
 export default function highlight(_ref) {
   var attribute = _ref.attribute,
     _ref$highlightedTagNa = _ref.highlightedTagName,
@@ -8,6 +12,7 @@ export default function highlight(_ref) {
     hit = _ref.hit,
     _ref$cssClasses = _ref.cssClasses,
     cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  process.env.NODE_ENV === 'development' ? warning(false, "`instantsearch.highlight` function has been deprecated. It is still supported in 4.x releases, but not further. It is replaced by the `Highlight` component.\n\nFor more information, visit https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/?client=html+tagged+templates#upgrade-templates") : void 0;
   var highlightAttributeResult = getPropertyByPath(hit._highlightResult, attribute);
 
   // @MAJOR fallback to attribute value if highlight is not found

package/es/helpers/reverseHighlight.d.ts

@@ -7,4 +7,7 @@ export type ReverseHighlightOptions = {
         highlighted: string;
     }>;
 };
+/**
+ * @deprecated use html tagged templates and the ReverseHighlight component instead
+ */
 export default function reverseHighlight({ attribute, highlightedTagName, hit, cssClasses, }: ReverseHighlightOptions): string;

package/es/helpers/reverseHighlight.js

@@ -1,6 +1,10 @@
 import { component } from "../lib/suit.js";
 import { TAG_REPLACEMENT, getPropertyByPath, getHighlightedParts, reverseHighlightedParts, concatHighlightedParts, warning } from "../lib/utils/index.js";
 var suit = component('ReverseHighlight');
+
+/**
+ * @deprecated use html tagged templates and the ReverseHighlight component instead
+ */
 export default function reverseHighlight(_ref) {
   var attribute = _ref.attribute,
     _ref$highlightedTagNa = _ref.highlightedTagName,
@@ -8,6 +12,7 @@ export default function reverseHighlight(_ref) {
     hit = _ref.hit,
     _ref$cssClasses = _ref.cssClasses,
     cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  process.env.NODE_ENV === 'development' ? warning(false, "`instantsearch.reverseHighlight` function has been deprecated. It is still supported in 4.x releases, but not further. It is replaced by the `ReverseHighlight` component.\n\nFor more information, visit https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/?client=html+tagged+templates#upgrade-templates") : void 0;
   var highlightAttributeResult = getPropertyByPath(hit._highlightResult, attribute);
 
   // @MAJOR fallback to attribute value if highlight is not found

package/es/helpers/reverseSnippet.d.ts

@@ -7,4 +7,7 @@ export type ReverseSnippetOptions = {
         highlighted: string;
     }>;
 };
+/**
+ * @deprecated use html tagged templates and the ReverseSnippet component instead
+ */
 export default function reverseSnippet({ attribute, highlightedTagName, hit, cssClasses, }: ReverseSnippetOptions): string;

package/es/helpers/reverseSnippet.js

@@ -1,6 +1,10 @@
 import { component } from "../lib/suit.js";
 import { TAG_REPLACEMENT, getPropertyByPath, getHighlightedParts, reverseHighlightedParts, concatHighlightedParts, warning } from "../lib/utils/index.js";
 var suit = component('ReverseSnippet');
+
+/**
+ * @deprecated use html tagged templates and the ReverseSnippet component instead
+ */
 export default function reverseSnippet(_ref) {
   var attribute = _ref.attribute,
     _ref$highlightedTagNa = _ref.highlightedTagName,
@@ -8,6 +12,7 @@ export default function reverseSnippet(_ref) {
     hit = _ref.hit,
     _ref$cssClasses = _ref.cssClasses,
     cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  process.env.NODE_ENV === 'development' ? warning(false, "`instantsearch.reverseSnippet` function has been deprecated. It is still supported in 4.x releases, but not further. It is replaced by the `ReverseSnippet` component.\n\nFor more information, visit https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/?client=html+tagged+templates#upgrade-templates") : void 0;
   var snippetAttributeResult = getPropertyByPath(hit._snippetResult, attribute);
 
   // @MAJOR fallback to attribute value if snippet is not found

package/es/helpers/snippet.d.ts

@@ -7,4 +7,7 @@ export type SnippetOptions = {
         highlighted?: string;
     };
 };
+/**
+ * @deprecated use html tagged templates and the Snippet component instead
+ */
 export default function snippet({ attribute, highlightedTagName, hit, cssClasses, }: SnippetOptions): string;

package/es/helpers/snippet.js

@@ -1,6 +1,10 @@
 import { component } from "../lib/suit.js";
 import { TAG_REPLACEMENT, getPropertyByPath, warning } from "../lib/utils/index.js";
 var suit = component('Snippet');
+
+/**
+ * @deprecated use html tagged templates and the Snippet component instead
+ */
 export default function snippet(_ref) {
   var attribute = _ref.attribute,
     _ref$highlightedTagNa = _ref.highlightedTagName,
@@ -8,6 +12,7 @@ export default function snippet(_ref) {
     hit = _ref.hit,
     _ref$cssClasses = _ref.cssClasses,
     cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  process.env.NODE_ENV === 'development' ? warning(false, "`instantsearch.snippet` function has been deprecated. It is still supported in 4.x releases, but not further. It is replaced by the `Snippet` component.\n\nFor more information, visit https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/?client=html+tagged+templates#upgrade-templates") : void 0;
   var snippetAttributeResult = getPropertyByPath(hit._snippetResult, attribute);
 
   // @MAJOR fallback to attribute value if snippet is not found

package/es/lib/server.d.ts

@@ -0,0 +1,10 @@
+import type { IndexWidget, InitialResults, InstantSearch } from '../types';
+/**
+ * Waits for the results from the search instance to coordinate the next steps
+ * in `getServerState()`.
+ */
+export declare function waitForResults(search: InstantSearch): Promise<void>;
+/**
+ * Walks the InstantSearch root index to construct the initial results.
+ */
+export declare function getInitialResults(rootIndex: IndexWidget): InitialResults;

package/es/lib/server.js

@@ -0,0 +1,53 @@
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+import { walkIndex } from "./utils/index.js";
+/**
+ * Waits for the results from the search instance to coordinate the next steps
+ * in `getServerState()`.
+ */
+export function waitForResults(search) {
+  var helper = search.mainHelper;
+  helper.searchOnlyWithDerivedHelpers();
+  return new Promise(function (resolve, reject) {
+    // All derived helpers resolve in the same tick so we're safe only relying
+    // on the first one.
+    helper.derivedHelpers[0].on('result', function () {
+      resolve();
+    });
+
+    // However, we listen to errors that can happen on any derived helper because
+    // any error is critical.
+    helper.on('error', function (error) {
+      reject(error);
+    });
+    search.on('error', function (error) {
+      reject(error);
+    });
+    helper.derivedHelpers.forEach(function (derivedHelper) {
+      return derivedHelper.on('error', function (error) {
+        reject(error);
+      });
+    });
+  });
+}
+
+/**
+ * Walks the InstantSearch root index to construct the initial results.
+ */
+export function getInitialResults(rootIndex) {
+  var initialResults = {};
+  walkIndex(rootIndex, function (widget) {
+    var searchResults = widget.getResults();
+    initialResults[widget.getIndexId()] = {
+      // We convert the Helper state to a plain object to pass parsable data
+      // structures from server to client.
+      state: _objectSpread({}, searchResults._state),
+      results: searchResults._rawResults
+    };
+  });
+  return initialResults;
+}

package/es/lib/utils/index.d.ts

@@ -33,6 +33,7 @@ export * from './isFacetRefined';
 export * from './isFiniteNumber';
 export * from './isPlainObject';
 export * from './isSpecialClick';
+export * from './walkIndex';
 export * from './logger';
 export * from './mergeSearchParameters';
 export * from './omit';

package/es/lib/utils/index.js

@@ -33,6 +33,7 @@ export * from "./isFacetRefined.js";
 export * from "./isFiniteNumber.js";
 export * from "./isPlainObject.js";
 export * from "./isSpecialClick.js";
+export * from "./walkIndex.js";
 export * from "./logger.js";
 export * from "./mergeSearchParameters.js";
 export * from "./omit.js";

package/es/lib/utils/walkIndex.d.ts

@@ -0,0 +1,5 @@
+import type { IndexWidget } from '../../types';
+/**
+ * Recurse over all child indices
+ */
+export declare function walkIndex(indexWidget: IndexWidget, callback: (widget: IndexWidget) => void): void;

package/es/lib/utils/walkIndex.js

@@ -0,0 +1,12 @@
+import { isIndexWidget } from "./isIndexWidget.js";
+/**
+ * Recurse over all child indices
+ */
+export function walkIndex(indexWidget, callback) {
+  callback(indexWidget);
+  indexWidget.getWidgets().forEach(function (widget) {
+    if (isIndexWidget(widget)) {
+      walkIndex(widget, callback);
+    }
+  });
+}

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.53.0";
+declare const _default: "4.54.1";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.53.0';
+export default '4.54.1';

package/es/widgets/pagination/pagination.d.ts

@@ -1,6 +1,6 @@
 
 import type { PaginationConnectorParams, PaginationWidgetDescription } from '../../connectors/pagination/connectPagination';
-import type { WidgetFactory } from '../../types';
+import type { Template, WidgetFactory } from '../../types';
 export type PaginationCSSClasses = Partial<{
     /**
      * CSS classes added to the root element of the widget.
@@ -55,19 +55,26 @@ export type PaginationTemplates = Partial<{
     /**
      * Label for the Previous link.
      */
-    previous: string;
+    previous: Template;
     /**
      * Label for the Next link.
      */
-    next: string;
+    next: Template;
+    /**
+     * Label for the link of a certain page
+     * Page is one-based, so `page` will be `1` for the first page.
+     */
+    page: Template<{
+        page: number;
+    }>;
     /**
      * Label for the First link.
      */
-    first: string;
+    first: Template;
     /**
      * Label for the Last link.
      */
-    last: string;
+    last: Template;
 }>;
 export type PaginationWidgetParams = {
     /**

package/es/widgets/pagination/pagination.js

@@ -15,28 +15,40 @@ var withUsage = createDocumentationMessageGenerator({
   name: 'pagination'
 });
 var defaultTemplates = {
-  previous: '‹',
-  next: '›',
-  first: '«',
-  last: '»'
+  previous: function previous() {
+    return '‹';
+  },
+  next: function next() {
+    return '›';
+  },
+  page: function page(_ref) {
+    var _page = _ref.page;
+    return "".concat(_page);
+  },
+  first: function first() {
+    return '«';
+  },
+  last: function last() {
+    return '»';
+  }
 };
-var renderer = function renderer(_ref) {
-  var containerNode = _ref.containerNode,
-    cssClasses = _ref.cssClasses,
-    templates = _ref.templates,
-    showFirst = _ref.showFirst,
-    showLast = _ref.showLast,
-    showPrevious = _ref.showPrevious,
-    showNext = _ref.showNext,
-    scrollToNode = _ref.scrollToNode;
-  return function (_ref2, isFirstRendering) {
-    var createURL = _ref2.createURL,
-      currentRefinement = _ref2.currentRefinement,
-      nbPages = _ref2.nbPages,
-      pages = _ref2.pages,
-      isFirstPage = _ref2.isFirstPage,
-      isLastPage = _ref2.isLastPage,
-      refine = _ref2.refine;
+var renderer = function renderer(_ref2) {
+  var containerNode = _ref2.containerNode,
+    cssClasses = _ref2.cssClasses,
+    templates = _ref2.templates,
+    showFirst = _ref2.showFirst,
+    showLast = _ref2.showLast,
+    showPrevious = _ref2.showPrevious,
+    showNext = _ref2.showNext,
+    scrollToNode = _ref2.scrollToNode;
+  return function (_ref3, isFirstRendering) {
+    var createURL = _ref3.createURL,
+      currentRefinement = _ref3.currentRefinement,
+      nbPages = _ref3.nbPages,
+      pages = _ref3.pages,
+      isFirstPage = _ref3.isFirstPage,
+      isLastPage = _ref3.isLastPage,
+      refine = _ref3.refine;
     if (isFirstRendering) return;
     var setCurrentPage = function setCurrentPage(pageNumber) {
       refine(pageNumber);
@@ -62,24 +74,24 @@ var renderer = function renderer(_ref) {
   };
 };
 var pagination = function pagination(widgetParams) {
-  var _ref3 = widgetParams || {},
-    container = _ref3.container,
-    _ref3$templates = _ref3.templates,
-    userTemplates = _ref3$templates === void 0 ? {} : _ref3$templates,
-    _ref3$cssClasses = _ref3.cssClasses,
-    userCssClasses = _ref3$cssClasses === void 0 ? {} : _ref3$cssClasses,
-    totalPages = _ref3.totalPages,
-    padding = _ref3.padding,
-    _ref3$showFirst = _ref3.showFirst,
-    showFirst = _ref3$showFirst === void 0 ? true : _ref3$showFirst,
-    _ref3$showLast = _ref3.showLast,
-    showLast = _ref3$showLast === void 0 ? true : _ref3$showLast,
-    _ref3$showPrevious = _ref3.showPrevious,
-    showPrevious = _ref3$showPrevious === void 0 ? true : _ref3$showPrevious,
-    _ref3$showNext = _ref3.showNext,
-    showNext = _ref3$showNext === void 0 ? true : _ref3$showNext,
-    _ref3$scrollTo = _ref3.scrollTo,
-    userScrollTo = _ref3$scrollTo === void 0 ? 'body' : _ref3$scrollTo;
+  var _ref4 = widgetParams || {},
+    container = _ref4.container,
+    _ref4$templates = _ref4.templates,
+    userTemplates = _ref4$templates === void 0 ? {} : _ref4$templates,
+    _ref4$cssClasses = _ref4.cssClasses,
+    userCssClasses = _ref4$cssClasses === void 0 ? {} : _ref4$cssClasses,
+    totalPages = _ref4.totalPages,
+    padding = _ref4.padding,
+    _ref4$showFirst = _ref4.showFirst,
+    showFirst = _ref4$showFirst === void 0 ? true : _ref4$showFirst,
+    _ref4$showLast = _ref4.showLast,
+    showLast = _ref4$showLast === void 0 ? true : _ref4$showLast,
+    _ref4$showPrevious = _ref4.showPrevious,
+    showPrevious = _ref4$showPrevious === void 0 ? true : _ref4$showPrevious,
+    _ref4$showNext = _ref4.showNext,
+    showNext = _ref4$showNext === void 0 ? true : _ref4$showNext,
+    _ref4$scrollTo = _ref4.scrollTo,
+    userScrollTo = _ref4$scrollTo === void 0 ? 'body' : _ref4$scrollTo;
   if (!container) {
     throw new Error(withUsage('The `container` option is required.'));
   }

package/es/widgets/panel/panel.js

@@ -90,8 +90,6 @@ var panel = function panel(panelWidgetParams) {
       }
       var containerNode = getContainerNode(widgetParams.container);
       var defaultTemplates = {
-        header: '',
-        footer: '',
         collapseButtonText: function collapseButtonText(_ref4) {
           var isCollapsed = _ref4.collapsed;
           return "<svg\n          class=\"".concat(cssClasses.collapseIcon, "\"\n          style=\"width: 1em; height: 1em;\"\n          viewBox=\"0 0 500 500\"\n        >\n        <path d=\"").concat(isCollapsed ? 'M100 250l300-150v300z' : 'M250 400l150-300H100z', "\" fill=\"currentColor\" />\n        </svg>");

package/es/widgets/places/places.d.ts

@@ -1,5 +1,5 @@
-// @ts-ignore
 import type { WidgetFactory, WidgetRenderState } from '../../types';
+// @ts-ignore
 import type * as Places from 'places.js';
 type StaticOptions = Places.StaticOptions;
 type PlacesInstance = Places.PlacesInstance;

package/es/widgets/places/places.js

@@ -8,6 +8,7 @@ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _ty
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+/* Places.js is an optional dependency, no error should be reported if the package is missing */
 /** @ts-ignore */
 
 // using the type like this requires only one ts-ignore