instantsearch.js 4.49.3 → 4.50.0

package/cjs/components/Pagination/Pagination.js

@@ -44,7 +44,7 @@ function Pagination(props) {
   }), props.pages.map(function (pageNumber) {
     return (0, _preact.h)(PaginationLink, {
       key: pageNumber,
-      ariaLabel: "".concat(pageNumber + 1),
+      ariaLabel: "Page ".concat(pageNumber + 1),
       className: props.cssClasses.pageItem,
       isSelected: pageNumber === props.currentPage,
       label: "".concat(pageNumber + 1),

package/cjs/connectors/hits/connectHits.js

@@ -61,7 +61,8 @@ var connectHits = function connectHits(renderFn) {
         if (!bindEvent) {
           bindEvent = (0, _utils.createBindEventForHits)({
             index: helper.getIndex(),
-            widgetType: this.$$type
+            widgetType: this.$$type,
+            instantSearchInstance: instantSearchInstance
           });
         }
         if (!results) {

package/cjs/connectors/infinite-hits/connectInfiniteHits.js

@@ -151,7 +151,8 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           });
           bindEvent = (0, _utils.createBindEventForHits)({
             index: helper.getIndex(),
-            widgetType: this.$$type
+            widgetType: this.$$type,
+            instantSearchInstance: instantSearchInstance
           });
           isFirstPage = state.page === undefined || getFirstReceivedPage(state, cachedHits) === 0;
         } else {
@@ -165,7 +166,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID, {
             results: results
           });
-          if (cachedHits[_page] === undefined && !results.__isArtificial) {
+          if (cachedHits[_page] === undefined && !results.__isArtificial && instantSearchInstance.status === 'idle') {
             cachedHits[_page] = transformedHits;
             cache.write({
               state: state,

package/cjs/lib/InstantSearch.js

@@ -80,8 +80,9 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       }
     }));
     _defineProperty(_assertThisInitialized(_this), "scheduleRender", (0, _utils.defer)(function () {
+      var _this$mainHelper;
       var shouldResetStatus = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
-      if (!_this.mainHelper.hasPendingRequests()) {
+      if (!((_this$mainHelper = _this.mainHelper) !== null && _this$mainHelper !== void 0 && _this$mainHelper.hasPendingRequests())) {
         clearTimeout(_this._searchStalledTimer);
         _this._searchStalledTimer = null;
         if (shouldResetStatus) {
@@ -349,12 +350,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       var mainHelper = this.mainHelper || (0, _algoliasearchHelper.default)(this.client, this.indexName);
       mainHelper.search = function () {
         _this3.status = 'loading';
-        // @MAJOR: use scheduleRender here
-        // For now, widgets don't expect to be rendered at the start of `loading`,
-        // so it would be a breaking change to add an extra render. We don't have
-        // these guarantees about the render event, thus emitting it once more
-        // isn't a breaking change.
-        _this3.emit('render');
+        _this3.scheduleRender(false);
 
         // This solution allows us to keep the exact same API for the users but
         // under the hood, we have a different implementation. It should be

package/cjs/lib/templating/renderTemplate.js

@@ -57,6 +57,9 @@ function renderTemplate(_ref) {
       Snippet: _components.Snippet,
       ReverseSnippet: _components.ReverseSnippet
     };
+
+    // @MAJOR remove the `as any` when string templates are removed
+    // needed because not every template receives sendEvent
     return template(data, params);
   }
   var transformedHelpers = transformHelpersToHogan(helpers, compileOptions, data);

package/cjs/lib/utils/createSendEventForHits.js

@@ -20,7 +20,7 @@ var buildPayloads = function buildPayloads(_ref) {
     widgetType = _ref.widgetType,
     methodName = _ref.methodName,
     args = _ref.args,
-    isSearchStalled = _ref.isSearchStalled;
+    instantSearchInstance = _ref.instantSearchInstance;
   // when there's only one argument, that means it's custom
   if (args.length === 1 && _typeof(args[0]) === 'object') {
     return [args[0]];
@@ -59,7 +59,7 @@ var buildPayloads = function buildPayloads(_ref) {
     });
   });
   if (eventType === 'view') {
-    if (isSearchStalled) {
+    if (instantSearchInstance.status !== 'idle') {
       return [];
     }
     return hitsChunks.map(function (batch, i) {
@@ -129,7 +129,7 @@ function createSendEventForHits(_ref2) {
       index: index,
       methodName: 'sendEvent',
       args: args,
-      isSearchStalled: instantSearchInstance.status === 'stalled'
+      instantSearchInstance: instantSearchInstance
     });
     payloads.forEach(function (payload) {
       return instantSearchInstance.sendEventToInsights(payload);
@@ -139,7 +139,8 @@ function createSendEventForHits(_ref2) {
 }
 function createBindEventForHits(_ref3) {
   var index = _ref3.index,
-    widgetType = _ref3.widgetType;
+    widgetType = _ref3.widgetType,
+    instantSearchInstance = _ref3.instantSearchInstance;
   var bindEventForHits = function bindEventForHits() {
     for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
       args[_key2] = arguments[_key2];
@@ -149,7 +150,7 @@ function createBindEventForHits(_ref3) {
       index: index,
       methodName: 'bindEvent',
       args: args,
-      isSearchStalled: false
+      instantSearchInstance: instantSearchInstance
     });
     return payloads.length ? "data-insights-event=".concat((0, _serializer.serializePayload)(payloads)) : '';
   };

package/cjs/lib/version.js

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

package/cjs/widgets/index/index.js

@@ -108,6 +108,7 @@ var index = function index(widgetParams) {
   var localParent = null;
   var helper = null;
   var derivedHelper = null;
+  var lastValidSearchParameters = null;
   return {
     $$type: 'ais.index',
     $$widgetType: 'ais.index',
@@ -121,7 +122,16 @@ var index = function index(widgetParams) {
       return helper;
     },
     getResults: function getResults() {
-      return derivedHelper && derivedHelper.lastResults;
+      var _derivedHelper;
+      if (!((_derivedHelper = derivedHelper) !== null && _derivedHelper !== void 0 && _derivedHelper.lastResults)) return null;
+
+      // To make the UI optimistic, we patch the state to display to the current
+      // one instead of the one associated with the latest results.
+      // This means user-driven UI changes (e.g., checked checkbox) are reflected
+      // immediately instead of waiting for Algolia to respond, regardless of
+      // the status of the network request.
+      derivedHelper.lastResults._state = helper.state;
+      return derivedHelper.lastResults;
     },
     getScopedResults: function getScopedResults() {
       var widgetParent = this.getParent();
@@ -326,6 +336,7 @@ var index = function index(widgetParams) {
         // does not have access to lastResults, which it used to in pre-federated
         // search behavior.
         helper.lastResults = results;
+        lastValidSearchParameters = results._state;
       });
 
       // We compute the render state before calling `init` in a separate loop
@@ -384,6 +395,12 @@ var index = function index(widgetParams) {
       if (!this.getResults()) {
         return;
       }
+
+      // we can't attach a listener to the error event of search, as the error
+      // then would no longer be thrown for global handlers.
+      if (instantSearchInstance.status === 'error' && !instantSearchInstance.mainHelper.hasPendingRequests()) {
+        helper.setState(lastValidSearchParameters);
+      }
       localWidgets.forEach(function (widget) {
         if (widget.getRenderState) {
           var renderState = widget.getRenderState(instantSearchInstance.renderState[_this4.getIndexId()] || {}, (0, _utils.createRenderArgs)(instantSearchInstance, _this4));

package/dist/instantsearch.development.d.ts

@@ -5052,7 +5052,7 @@ declare type Status = 'initial' | 'askingPermission' | 'waiting' | 'recognizing'
 
 declare type Template<TTemplateData = void> = string | ((data: TTemplateData, params: TemplateParams) => VNode | VNode[] | string);
 
-declare type TemplateParams = BindEventForHits & {
+declare type TemplateParams = {
     html: typeof html;
     components: {
         Highlight: typeof Highlight;
@@ -5067,7 +5067,15 @@ declare type Templates = {
     [key: string]: Template<any> | TemplateWithBindEvent<any> | undefined;
 };
 
-declare type TemplateWithBindEvent<TTemplateData = void> = string | ((data: TTemplateData, params: TemplateParams) => VNode | VNode[] | string);
+declare type TemplateWithBindEvent<TTemplateData = void> = string | ((data: TTemplateData, params: TemplateWithBindEventParams) => VNode | VNode[] | string);
+
+declare interface TemplateWithBindEventParams extends TemplateParams {
+    /** @deprecated use sendEvent instead */
+    (...args: Parameters<BuiltInBindEventForHits>): ReturnType<BuiltInBindEventForHits>;
+    /** @deprecated use sendEvent instead */
+    (...args: Parameters<CustomBindEventForHits>): ReturnType<CustomBindEventForHits>;
+    sendEvent: SendEventForHits;
+}
 
 declare type TextTemplateProps = {
     hasManyResults: boolean;

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.49.3 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.50.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -333,7 +333,8 @@
     for (var key in source) {
       if (
         !Object.prototype.hasOwnProperty.call(source, key) ||
-        key === '__proto__'
+        key === '__proto__' ||
+        key === 'constructor'
       ) {
         continue;
       }
@@ -3149,7 +3150,33 @@
         };
       });
     } else if (results._state.isHierarchicalFacet(attribute)) {
-      return find(results.hierarchicalFacets, predicate);
+      var hierarchicalFacetValues = find(results.hierarchicalFacets, predicate);
+      if (!hierarchicalFacetValues) return hierarchicalFacetValues;
+
+      var hierarchicalFacet = results._state.getHierarchicalFacetByName(attribute);
+      var currentRefinementSplit = unescapeFacetValue$2(
+        results._state.getHierarchicalRefinement(attribute)[0] || ''
+      ).split(results._state._getHierarchicalFacetSeparator(hierarchicalFacet));
+      currentRefinementSplit.unshift(attribute);
+
+      setIsRefined(hierarchicalFacetValues, currentRefinementSplit, 0);
+
+      return hierarchicalFacetValues;
+    }
+  }
+
+  /**
+   * Set the isRefined of a hierarchical facet result based on the current state.
+   * @param {SearchResults.HierarchicalFacet} item Hierarchical facet to fix
+   * @param {string[]} currentRefinementSplit array of parts of the current hierarchical refinement
+   * @param {number} depth recursion depth in the currentRefinement
+   */
+  function setIsRefined(item, currentRefinement, depth) {
+    item.isRefined = item.name === currentRefinement[depth];
+    if (item.data) {
+      item.data.forEach(function(child) {
+        setIsRefined(child, currentRefinement, depth + 1);
+      });
     }
   }
 
@@ -4238,7 +4265,7 @@
 
   var requestBuilder_1 = requestBuilder;
 
-  var version = '3.11.1';
+  var version = '3.11.3';
 
   var escapeFacetValue$3 = escapeFacetValue_1.escapeFacetValue;
 
@@ -4488,8 +4515,10 @@
    * @param {number} options.nbHits - Maximum number of answers to retrieve from the Answers Engine. Cannot be greater than 1000.
    *
    * @return {promise} the answer results
+   * @deprecated answers is deprecated and will be replaced with new initiatives
    */
   AlgoliaSearchHelper.prototype.findAnswers = function(options) {
+    console.warn('[algoliasearch-helper] answers is no longer supported');
     var state = this.state;
     var derivedHelper = this.derivedHelpers[0];
     if (!derivedHelper) {
@@ -6275,7 +6304,7 @@
       widgetType = _ref.widgetType,
       methodName = _ref.methodName,
       args = _ref.args,
-      isSearchStalled = _ref.isSearchStalled;
+      instantSearchInstance = _ref.instantSearchInstance;
     // when there's only one argument, that means it's custom
     if (args.length === 1 && _typeof(args[0]) === 'object') {
       return [args[0]];
@@ -6310,7 +6339,7 @@
       });
     });
     if (eventType === 'view') {
-      if (isSearchStalled) {
+      if (instantSearchInstance.status !== 'idle') {
         return [];
       }
       return hitsChunks.map(function (batch, i) {
@@ -6378,7 +6407,7 @@
         index: index,
         methodName: 'sendEvent',
         args: args,
-        isSearchStalled: instantSearchInstance.status === 'stalled'
+        instantSearchInstance: instantSearchInstance
       });
       payloads.forEach(function (payload) {
         return instantSearchInstance.sendEventToInsights(payload);
@@ -6388,7 +6417,8 @@
   }
   function createBindEventForHits(_ref3) {
     var index = _ref3.index,
-      widgetType = _ref3.widgetType;
+      widgetType = _ref3.widgetType,
+      instantSearchInstance = _ref3.instantSearchInstance;
     var bindEventForHits = function bindEventForHits() {
       for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
         args[_key2] = arguments[_key2];
@@ -6398,7 +6428,7 @@
         index: index,
         methodName: 'bindEvent',
         args: args,
-        isSearchStalled: false
+        instantSearchInstance: instantSearchInstance
       });
       return payloads.length ? "data-insights-event=".concat(serializePayload(payloads)) : '';
     };
@@ -7215,6 +7245,7 @@
     var localParent = null;
     var helper = null;
     var derivedHelper = null;
+    var lastValidSearchParameters = null;
     return {
       $$type: 'ais.index',
       $$widgetType: 'ais.index',
@@ -7228,7 +7259,16 @@
         return helper;
       },
       getResults: function getResults() {
-        return derivedHelper && derivedHelper.lastResults;
+        var _derivedHelper;
+        if (!((_derivedHelper = derivedHelper) !== null && _derivedHelper !== void 0 && _derivedHelper.lastResults)) return null;
+
+        // To make the UI optimistic, we patch the state to display to the current
+        // one instead of the one associated with the latest results.
+        // This means user-driven UI changes (e.g., checked checkbox) are reflected
+        // immediately instead of waiting for Algolia to respond, regardless of
+        // the status of the network request.
+        derivedHelper.lastResults._state = helper.state;
+        return derivedHelper.lastResults;
       },
       getScopedResults: function getScopedResults() {
         var widgetParent = this.getParent();
@@ -7433,6 +7473,7 @@
           // does not have access to lastResults, which it used to in pre-federated
           // search behavior.
           helper.lastResults = results;
+          lastValidSearchParameters = results._state;
         });
 
         // We compute the render state before calling `init` in a separate loop
@@ -7491,6 +7532,12 @@
         if (!this.getResults()) {
           return;
         }
+
+        // we can't attach a listener to the error event of search, as the error
+        // then would no longer be thrown for global handlers.
+        if (instantSearchInstance.status === 'error' && !instantSearchInstance.mainHelper.hasPendingRequests()) {
+          helper.setState(lastValidSearchParameters);
+        }
         localWidgets.forEach(function (widget) {
           if (widget.getRenderState) {
             var renderState = widget.getRenderState(instantSearchInstance.renderState[_this4.getIndexId()] || {}, createRenderArgs(instantSearchInstance, _this4));
@@ -7570,7 +7617,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.49.3';
+  var version$1 = '4.50.0';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -9042,8 +9089,9 @@
         }
       }));
       _defineProperty(_assertThisInitialized(_this), "scheduleRender", defer(function () {
+        var _this$mainHelper;
         var shouldResetStatus = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
-        if (!_this.mainHelper.hasPendingRequests()) {
+        if (!((_this$mainHelper = _this.mainHelper) !== null && _this$mainHelper !== void 0 && _this$mainHelper.hasPendingRequests())) {
           clearTimeout(_this._searchStalledTimer);
           _this._searchStalledTimer = null;
           if (shouldResetStatus) {
@@ -9311,12 +9359,7 @@
         var mainHelper = this.mainHelper || algoliasearchHelper_1(this.client, this.indexName);
         mainHelper.search = function () {
           _this3.status = 'loading';
-          // @MAJOR: use scheduleRender here
-          // For now, widgets don't expect to be rendered at the start of `loading`,
-          // so it would be a breaking change to add an extra render. We don't have
-          // these guarantees about the render event, thus emitting it once more
-          // isn't a breaking change.
-          _this3.emit('render');
+          _this3.scheduleRender(false);
 
           // This solution allows us to keep the exact same API for the users but
           // under the hood, we have a different implementation. It should be
@@ -10112,7 +10155,8 @@
           if (!bindEvent) {
             bindEvent = createBindEventForHits({
               index: helper.getIndex(),
-              widgetType: this.$$type
+              widgetType: this.$$type,
+              instantSearchInstance: instantSearchInstance
             });
           }
           if (!results) {
@@ -10584,7 +10628,8 @@
             });
             bindEvent = createBindEventForHits({
               index: helper.getIndex(),
-              widgetType: this.$$type
+              widgetType: this.$$type,
+              instantSearchInstance: instantSearchInstance
             });
             isFirstPage = state.page === undefined || getFirstReceivedPage(state, cachedHits) === 0;
           } else {
@@ -10598,7 +10643,7 @@
             var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID, {
               results: results
             });
-            if (cachedHits[_page] === undefined && !results.__isArtificial) {
+            if (cachedHits[_page] === undefined && !results.__isArtificial && instantSearchInstance.status === 'idle') {
               cachedHits[_page] = transformedHits;
               cache.write({
                 state: state,
@@ -15276,6 +15321,9 @@
         Snippet: Snippet$1,
         ReverseSnippet: ReverseSnippet$1
       };
+
+      // @MAJOR remove the `as any` when string templates are removed
+      // needed because not every template receives sendEvent
       return template(data, params);
     }
     var transformedHelpers = transformHelpersToHogan(helpers, compileOptions, data);
@@ -17899,7 +17947,7 @@
     }), props.pages.map(function (pageNumber) {
       return h(PaginationLink, {
         key: pageNumber,
-        ariaLabel: "".concat(pageNumber + 1),
+        ariaLabel: "Page ".concat(pageNumber + 1),
         className: props.cssClasses.pageItem,
         isSelected: pageNumber === props.currentPage,
         label: "".concat(pageNumber + 1),