instantsearch.js 4.79.1 → 4.80.0

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.79.1 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! InstantSearch.js 4.80.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -10235,22 +10235,20 @@
           return Math.max.apply(Math, [page].concat(_toConsumableArray(pages)));
         }
       };
-      var getShowPrevious = function getShowPrevious(helper) {
+      var getShowPrevious = function getShowPrevious(helper, getCachedHits) {
         return function () {
+          var cachedHits = getCachedHits();
           // Using the helper's `overrideStateWithoutTriggeringChangeEvent` method
           // avoid updating the browser URL when the user displays the previous page.
           helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread2(_objectSpread2({}, helper.state), {}, {
-            page: getFirstReceivedPage(helper.state, cache.read({
-              state: normalizeState(helper.state)
-            }) || {}) - 1
+            page: getFirstReceivedPage(helper.state, cachedHits) - 1
           })).searchWithoutTriggeringOnStateChange();
         };
       };
-      var getShowMore = function getShowMore(helper) {
+      var getShowMore = function getShowMore(helper, getCachedHits) {
         return function () {
-          helper.setPage(getLastReceivedPage(helper.state, cache.read({
-            state: normalizeState(helper.state)
-          }) || {}) + 1).search();
+          var cachedHits = getCachedHits();
+          helper.setPage(getLastReceivedPage(helper.state, cachedHits) + 1).search();
         };
       };
       return {
@@ -10282,6 +10280,12 @@
             parent = _ref6.parent,
             existingState = _ref6.state,
             instantSearchInstance = _ref6.instantSearchInstance;
+          var getCacheHits = function getCacheHits() {
+            var state = parent.getPreviousState() || existingState;
+            return cache.read({
+              state: normalizeState(state)
+            }) || {};
+          };
           var isFirstPage;
           var currentPageHits = [];
           /**
@@ -10290,13 +10294,15 @@
            * is loading.
            */
           var state = parent.getPreviousState() || existingState;
-          var cachedHits = cache.read({
-            state: normalizeState(state)
-          }) || {};
+          var cachedHits = getCacheHits();
           var banner = results === null || results === void 0 ? void 0 : (_results$renderingCon = results.renderingContent) === null || _results$renderingCon === void 0 ? void 0 : (_results$renderingCon2 = _results$renderingCon.widgets) === null || _results$renderingCon2 === void 0 ? void 0 : (_results$renderingCon3 = _results$renderingCon2.banners) === null || _results$renderingCon3 === void 0 ? void 0 : _results$renderingCon3[0];
           if (!showPrevious) {
-            showPrevious = getShowPrevious(helper);
-            showMore = getShowMore(helper);
+            showPrevious = function showPrevious() {
+              return getShowPrevious(helper, getCacheHits)();
+            };
+            showMore = function showMore() {
+              return getShowMore(helper, getCacheHits)();
+            };
           }
           if (!sendEvent) {
             sendEvent = createSendEventForHits({
@@ -15851,12 +15857,18 @@
     }, []);
   }
   var index = function index(widgetParams) {
-    if (widgetParams === undefined || widgetParams.indexName === undefined) {
+    if (widgetParams === undefined || widgetParams.indexName === undefined && !widgetParams.EXPERIMENTAL_isolated) {
       throw new Error(withUsage$u('The `indexName` option is required.'));
     }
-    var indexName = widgetParams.indexName,
+
+    // When isolated=true, we use an empty string as the default indexName.
+    // This is intentional: isolated indices do not require a real index name.
+    var _widgetParams$indexNa = widgetParams.indexName,
+      indexName = _widgetParams$indexNa === void 0 ? '' : _widgetParams$indexNa,
       _widgetParams$indexId = widgetParams.indexId,
-      indexId = _widgetParams$indexId === void 0 ? indexName : _widgetParams$indexId;
+      indexId = _widgetParams$indexId === void 0 ? indexName : _widgetParams$indexId,
+      _widgetParams$EXPERIM = widgetParams.EXPERIMENTAL_isolated,
+      isolated = _widgetParams$EXPERIM === void 0 ? false : _widgetParams$EXPERIM;
     var localWidgets = [];
     var localUiState = {};
     var localInstantSearchInstance = null;
@@ -15869,6 +15881,7 @@
     return {
       $$type: 'ais.index',
       $$widgetType: 'ais.index',
+      _isolated: isolated,
       getIndexName: function getIndexName() {
         return indexName;
       },
@@ -15920,7 +15933,7 @@
         return resolveScopedResultsFromWidgets(widgetSiblings);
       },
       getParent: function getParent() {
-        return localParent;
+        return isolated ? null : localParent;
       },
       createURL: function createURL(nextState) {
         if (typeof nextState === 'function') {
@@ -15939,12 +15952,15 @@
         if (!Array.isArray(widgets)) {
           throw new Error(withUsage$u('The `addWidgets` method expects an array of widgets.'));
         }
-        if (widgets.some(function (widget) {
+        var flatWidgets = widgets.reduce(function (acc, w) {
+          return acc.concat(Array.isArray(w) ? w : [w]);
+        }, []);
+        if (flatWidgets.some(function (widget) {
           return typeof widget.init !== 'function' && typeof widget.render !== 'function';
         })) {
           throw new Error(withUsage$u('The widget definition expects a `render` and/or an `init` method.'));
         }
-        widgets.forEach(function (widget) {
+        flatWidgets.forEach(function (widget) {
           if (isIndexWidget(widget)) {
             return;
           }
@@ -15959,8 +15975,8 @@
           }
           addWidgetId(widget);
         });
-        localWidgets = localWidgets.concat(widgets);
-        if (localInstantSearchInstance && Boolean(widgets.length)) {
+        localWidgets = localWidgets.concat(flatWidgets);
+        if (localInstantSearchInstance && Boolean(flatWidgets.length)) {
           privateHelperSetState(helper, {
             state: getLocalWidgetsSearchParameters(localWidgets, {
               uiState: localUiState,
@@ -15976,7 +15992,7 @@
           // We compute the render state before calling `init` in a separate loop
           // to construct the whole render state object that is then passed to
           // `init`.
-          widgets.forEach(function (widget) {
+          flatWidgets.forEach(function (widget) {
             if (widget.getRenderState) {
               var renderState = widget.getRenderState(localInstantSearchInstance.renderState[_this.getIndexId()] || {}, createInitArgs(localInstantSearchInstance, _this, localInstantSearchInstance._initialUiState));
               storeRenderState({
@@ -15986,12 +16002,17 @@
               });
             }
           });
-          widgets.forEach(function (widget) {
+          flatWidgets.forEach(function (widget) {
             if (widget.init) {
               widget.init(createInitArgs(localInstantSearchInstance, _this, localInstantSearchInstance._initialUiState));
             }
           });
-          localInstantSearchInstance.scheduleSearch();
+          if (isolated) {
+            var _helper2;
+            (_helper2 = helper) === null || _helper2 === void 0 ? void 0 : _helper2.search();
+          } else {
+            localInstantSearchInstance.scheduleSearch();
+          }
         }
         return this;
       },
@@ -16000,13 +16021,16 @@
         if (!Array.isArray(widgets)) {
           throw new Error(withUsage$u('The `removeWidgets` method expects an array of widgets.'));
         }
-        if (widgets.some(function (widget) {
+        var flatWidgets = widgets.reduce(function (acc, w) {
+          return acc.concat(Array.isArray(w) ? w : [w]);
+        }, []);
+        if (flatWidgets.some(function (widget) {
           return typeof widget.dispose !== 'function';
         })) {
           throw new Error(withUsage$u('The widget definition expects a `dispose` method.'));
         }
         localWidgets = localWidgets.filter(function (widget) {
-          return widgets.indexOf(widget) === -1;
+          return flatWidgets.indexOf(widget) === -1;
         });
         localWidgets.forEach(function (widget) {
           if (isIndexWidget(widget)) {
@@ -16022,8 +16046,8 @@
             hasSearchWidget = true;
           }
         });
-        if (localInstantSearchInstance && Boolean(widgets.length)) {
-          var _widgets$reduce = widgets.reduce(function (states, widget) {
+        if (localInstantSearchInstance && Boolean(flatWidgets.length)) {
+          var _flatWidgets$reduce = flatWidgets.reduce(function (states, widget) {
               // the `dispose` method exists at this point we already assert it
               var next = widget.dispose({
                 helper: helper,
@@ -16041,8 +16065,8 @@
               cleanedSearchState: helper.state,
               cleanedRecommendState: helper.recommendState
             }),
-            cleanedSearchState = _widgets$reduce.cleanedSearchState,
-            cleanedRecommendState = _widgets$reduce.cleanedRecommendState;
+            cleanedSearchState = _flatWidgets$reduce.cleanedSearchState,
+            cleanedRecommendState = _flatWidgets$reduce.cleanedRecommendState;
           var newState = localInstantSearchInstance.future.preserveSharedStateOnUnmount ? getLocalWidgetsSearchParameters(localWidgets, {
             uiState: localUiState,
             initialSearchParameters: new algoliasearchHelper_1.SearchParameters({
@@ -16062,7 +16086,12 @@
           helper.setState(newState);
           helper.recommendState = cleanedRecommendState;
           if (localWidgets.length) {
-            localInstantSearchInstance.scheduleSearch();
+            if (isolated) {
+              var _helper3;
+              (_helper3 = helper) === null || _helper3 === void 0 ? void 0 : _helper3.search();
+            } else {
+              localInstantSearchInstance.scheduleSearch();
+            }
           }
         }
         return this;
@@ -16100,13 +16129,20 @@
         // This Helper is only used for state management we do not care about the
         // `searchClient`. Only the "main" Helper created at the `InstantSearch`
         // level is aware of the client.
-        helper = algoliasearchHelper_1({}, parameters.index, parameters);
+        helper = algoliasearchHelper_1(mainHelper.getClient(), parameters.index, parameters);
         helper.recommendState = recommendParameters;
 
         // We forward the call to `search` to the "main" instance of the Helper
         // which is responsible for managing the queries (it's the only one that is
         // aware of the `searchClient`).
         helper.search = function () {
+          if (isolated) {
+            instantSearchInstance.status = 'loading';
+            _this3.render({
+              instantSearchInstance: instantSearchInstance
+            });
+            return instantSearchInstance.compositionID ? helper.searchWithComposition() : helper.searchOnlyWithDerivedHelpers();
+          }
           if (instantSearchInstance.onStateChange) {
             instantSearchInstance.onStateChange({
               uiState: instantSearchInstance.mainIndex.getWidgetUiState({}),
@@ -16130,7 +16166,9 @@
           var state = helper.state.setQueryParameters(userState);
           return mainHelper.searchForFacetValues(facetName, facetValue, maxFacetHits, state);
         };
-        derivedHelper = mainHelper.derive(function () {
+        var isolatedHelper = indexName ? helper : algoliasearchHelper_1({}, '__empty_index__', {});
+        var derivingHelper = isolated ? isolatedHelper : nearestIsolatedHelper(parent, mainHelper);
+        derivedHelper = derivingHelper.derive(function () {
           return mergeSearchParameters.apply(void 0, [mainHelper.state].concat(_toConsumableArray(resolveSearchParameters(_this3))));
         }, function () {
           return _this3.getHelper().recommendState;
@@ -16272,7 +16310,9 @@
 
         // We only render index widgets if there are no results.
         // This makes sure `render` is never called with `results` being `null`.
-        var widgetsToRender = this.getResults() || (_derivedHelper2 = derivedHelper) !== null && _derivedHelper2 !== void 0 && _derivedHelper2.lastRecommendResults ? localWidgets : localWidgets.filter(isIndexWidget);
+        // If it's an isolated index without an index name, we render all widgets,
+        // as there are no results to display for the isolated index itself.
+        var widgetsToRender = this.getResults() || (_derivedHelper2 = derivedHelper) !== null && _derivedHelper2 !== void 0 && _derivedHelper2.lastRecommendResults || isolated && !indexName ? localWidgets : localWidgets.filter(isIndexWidget);
         widgetsToRender = widgetsToRender.filter(function (widget) {
           if (!widget.shouldRender) {
             return true;
@@ -16306,7 +16346,7 @@
       },
       dispose: function dispose() {
         var _this5 = this,
-          _helper2,
+          _helper4,
           _derivedHelper3;
         localWidgets.forEach(function (widget) {
           if (widget.dispose && helper) {
@@ -16326,13 +16366,15 @@
         });
         localInstantSearchInstance = null;
         localParent = null;
-        (_helper2 = helper) === null || _helper2 === void 0 ? void 0 : _helper2.removeAllListeners();
+        (_helper4 = helper) === null || _helper4 === void 0 ? void 0 : _helper4.removeAllListeners();
         helper = null;
         (_derivedHelper3 = derivedHelper) === null || _derivedHelper3 === void 0 ? void 0 : _derivedHelper3.detach();
         derivedHelper = null;
       },
       getWidgetUiState: function getWidgetUiState(uiState) {
-        return localWidgets.filter(isIndexWidget).reduce(function (previousUiState, innerIndex) {
+        return localWidgets.filter(isIndexWidget).filter(function (w) {
+          return !w._isolated;
+        }).reduce(function (previousUiState, innerIndex) {
           return innerIndex.getWidgetUiState(previousUiState);
         }, _objectSpread2(_objectSpread2({}, uiState), {}, _defineProperty({}, indexId, _objectSpread2(_objectSpread2({}, uiState[indexId]), localUiState))));
       },
@@ -16369,6 +16411,19 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
+  /**
+   * Walk up the parent chain to find the closest isolated index, or fall back to mainHelper
+   */
+  function nearestIsolatedHelper(current, mainHelper) {
+    while (current) {
+      if (current._isolated) {
+        return current.getHelper();
+      }
+      current = current.getParent();
+    }
+    return mainHelper;
+  }
+
   function formatNumber(value, numberLocale) {
     return value.toLocaleString(numberLocale);
   }
@@ -16434,7 +16489,7 @@
     };
   }
 
-  var version$1 = '4.79.1';
+  var version$1 = '4.80.0';
 
   var withUsage$v = createDocumentationMessageGenerator({
     name: 'instantsearch'
@@ -16735,12 +16790,9 @@
         if (!Array.isArray(widgets)) {
           throw new Error(withUsage$v('The `addWidgets` method expects an array of widgets. Please use `addWidget`.'));
         }
-        if (widgets.some(function (widget) {
-          return typeof widget.init !== 'function' && typeof widget.render !== 'function';
+        if (this.compositionID && widgets.some(function (w) {
+          return !Array.isArray(w) && isIndexWidget(w) && !w._isolated;
         })) {
-          throw new Error(withUsage$v('The widget definition expects a `render` and/or an `init` method.'));
-        }
-        if (this.compositionID && widgets.some(isIndexWidget)) {
           throw new Error(withUsage$v('The `index` widget cannot be used with a composition-based InstantSearch implementation.'));
         }
         this.mainIndex.addWidgets(widgets);
@@ -16773,11 +16825,6 @@
         if (!Array.isArray(widgets)) {
           throw new Error(withUsage$v('The `removeWidgets` method expects an array of widgets. Please use `removeWidget`.'));
         }
-        if (widgets.some(function (widget) {
-          return typeof widget.dispose !== 'function';
-        })) {
-          throw new Error(withUsage$v('The widget definition expects a `dispose` method.'));
-        }
         this.mainIndex.removeWidgets(widgets);
         return this;
       }
@@ -19062,7 +19109,7 @@
         });
         // if there is one TextNode first and one TextNode last, the
         // last one's nodeValue will be assigned to the first.
-        if (this.nodes[0].nodeValue) {
+        if (this.nodes[0] && this.nodes[0].nodeValue) {
           this.nodes[0].nodeValue = '';
         }
       }