instantsearch.js 4.79.2 → 4.81.0

package/cjs/widgets/index/index.js

@@ -117,12 +117,18 @@ function resolveScopedResultsFromWidgets(widgets) {
   }, []);
 }
 var index = function index(widgetParams) {
-  if (widgetParams === undefined || widgetParams.indexName === undefined) {
+  if (widgetParams === undefined || widgetParams.indexName === undefined && !widgetParams.EXPERIMENTAL_isolated) {
     throw new Error(withUsage('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;
@@ -135,6 +141,7 @@ var index = function index(widgetParams) {
   return {
     $$type: 'ais.index',
     $$widgetType: 'ais.index',
+    _isolated: isolated,
     getIndexName: function getIndexName() {
       return indexName;
     },
@@ -186,7 +193,7 @@ var index = function index(widgetParams) {
       return resolveScopedResultsFromWidgets(widgetSiblings);
     },
     getParent: function getParent() {
-      return localParent;
+      return isolated ? null : localParent;
     },
     createURL: function createURL(nextState) {
       if (typeof nextState === 'function') {
@@ -205,12 +212,15 @@ var index = function index(widgetParams) {
       if (!Array.isArray(widgets)) {
         throw new Error(withUsage('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('The widget definition expects a `render` and/or an `init` method.'));
       }
-      widgets.forEach(function (widget) {
+      flatWidgets.forEach(function (widget) {
         if ((0, _utils.isIndexWidget)(widget)) {
           return;
         }
@@ -225,8 +235,8 @@ var index = function index(widgetParams) {
         }
         (0, _addWidgetId.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,
@@ -242,7 +252,7 @@ var index = function index(widgetParams) {
         // 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()] || {}, (0, _utils.createInitArgs)(localInstantSearchInstance, _this, localInstantSearchInstance._initialUiState));
             storeRenderState({
@@ -252,12 +262,17 @@ var index = function index(widgetParams) {
             });
           }
         });
-        widgets.forEach(function (widget) {
+        flatWidgets.forEach(function (widget) {
           if (widget.init) {
             widget.init((0, _utils.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;
     },
@@ -266,13 +281,16 @@ var index = function index(widgetParams) {
       if (!Array.isArray(widgets)) {
         throw new Error(withUsage('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('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 ((0, _utils.isIndexWidget)(widget)) {
@@ -288,8 +306,8 @@ var index = function index(widgetParams) {
           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,
@@ -307,8 +325,8 @@ var index = function index(widgetParams) {
             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.default.SearchParameters({
@@ -328,7 +346,12 @@ var index = function index(widgetParams) {
         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;
@@ -366,13 +389,20 @@ var index = function index(widgetParams) {
       // 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 = (0, _algoliasearchHelper.default)({}, parameters.index, parameters);
+      helper = (0, _algoliasearchHelper.default)(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({}),
@@ -396,7 +426,9 @@ var index = function index(widgetParams) {
         var state = helper.state.setQueryParameters(userState);
         return mainHelper.searchForFacetValues(facetName, facetValue, maxFacetHits, state);
       };
-      derivedHelper = mainHelper.derive(function () {
+      var isolatedHelper = indexName ? helper : (0, _algoliasearchHelper.default)({}, '__empty_index__', {});
+      var derivingHelper = isolated ? isolatedHelper : nearestIsolatedHelper(parent, mainHelper);
+      derivedHelper = derivingHelper.derive(function () {
         return _utils.mergeSearchParameters.apply(void 0, [mainHelper.state].concat(_toConsumableArray((0, _utils.resolveSearchParameters)(_this3))));
       }, function () {
         return _this3.getHelper().recommendState;
@@ -538,7 +570,11 @@ var index = function index(widgetParams) {
 
       // 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(_utils.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(function (widget) {
+        return widget.shouldRender;
+      });
       widgetsToRender = widgetsToRender.filter(function (widget) {
         if (!widget.shouldRender) {
           return true;
@@ -572,7 +608,7 @@ var index = function index(widgetParams) {
     },
     dispose: function dispose() {
       var _this5 = this,
-        _helper2,
+        _helper4,
         _derivedHelper3;
       localWidgets.forEach(function (widget) {
         if (widget.dispose && helper) {
@@ -592,13 +628,15 @@ var index = function index(widgetParams) {
       });
       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(_utils.isIndexWidget).reduce(function (previousUiState, innerIndex) {
+      return localWidgets.filter(_utils.isIndexWidget).filter(function (w) {
+        return !w._isolated;
+      }).reduce(function (previousUiState, innerIndex) {
         return innerIndex.getWidgetUiState(previousUiState);
       }, _objectSpread(_objectSpread({}, uiState), {}, _defineProperty({}, indexId, _objectSpread(_objectSpread({}, uiState[indexId]), localUiState))));
     },
@@ -613,6 +651,9 @@ var index = function index(widgetParams) {
         initialSearchParameters: searchParameters
       });
     },
+    shouldRender: function shouldRender() {
+      return true;
+    },
     refreshUiState: function refreshUiState() {
       localUiState = getLocalWidgetsUiState(localWidgets, {
         searchParameters: this.getHelper().state,
@@ -634,4 +675,17 @@ function storeRenderState(_ref8) {
     parent = _ref8.parent;
   var parentIndexName = parent ? parent.getIndexId() : instantSearchInstance.mainIndex.getIndexId();
   instantSearchInstance.renderState = _objectSpread(_objectSpread({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread(_objectSpread({}, 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;
 }

package/cjs/widgets/index.js

@@ -16,6 +16,12 @@ Object.defineProperty(exports, "breadcrumb", {
     return _breadcrumb.default;
   }
 });
+Object.defineProperty(exports, "chat", {
+  enumerable: true,
+  get: function get() {
+    return _chat.default;
+  }
+});
 Object.defineProperty(exports, "clearRefinements", {
   enumerable: true,
   get: function get() {
@@ -252,6 +258,7 @@ var _trendingItems = _interopRequireDefault(require("./trending-items/trending-i
 var _voiceSearch = _interopRequireDefault(require("./voice-search/voice-search"));
 var _frequentlyBoughtTogether = _interopRequireDefault(require("./frequently-bought-together/frequently-bought-together"));
 var _lookingSimilar = _interopRequireDefault(require("./looking-similar/looking-similar"));
+var _chat = _interopRequireDefault(require("./chat/chat"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /** @deprecated answers is no longer supported */
 var EXPERIMENTAL_answers = exports.EXPERIMENTAL_answers = (0, _utils.deprecate)(_answers.default, 'answers is no longer supported');

package/cjs/widgets/index.umd.js

@@ -0,0 +1,267 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EXPERIMENTAL_dynamicWidgets = exports.EXPERIMENTAL_configureRelatedItems = exports.EXPERIMENTAL_answers = void 0;
+Object.defineProperty(exports, "analytics", {
+  enumerable: true,
+  get: function get() {
+    return _analytics.default;
+  }
+});
+Object.defineProperty(exports, "breadcrumb", {
+  enumerable: true,
+  get: function get() {
+    return _breadcrumb.default;
+  }
+});
+exports.chat = void 0;
+Object.defineProperty(exports, "clearRefinements", {
+  enumerable: true,
+  get: function get() {
+    return _clearRefinements.default;
+  }
+});
+Object.defineProperty(exports, "configure", {
+  enumerable: true,
+  get: function get() {
+    return _configure.default;
+  }
+});
+Object.defineProperty(exports, "currentRefinements", {
+  enumerable: true,
+  get: function get() {
+    return _currentRefinements.default;
+  }
+});
+Object.defineProperty(exports, "dynamicWidgets", {
+  enumerable: true,
+  get: function get() {
+    return _dynamicWidgets.default;
+  }
+});
+Object.defineProperty(exports, "frequentlyBoughtTogether", {
+  enumerable: true,
+  get: function get() {
+    return _frequentlyBoughtTogether.default;
+  }
+});
+Object.defineProperty(exports, "geoSearch", {
+  enumerable: true,
+  get: function get() {
+    return _geoSearch.default;
+  }
+});
+Object.defineProperty(exports, "hierarchicalMenu", {
+  enumerable: true,
+  get: function get() {
+    return _hierarchicalMenu.default;
+  }
+});
+Object.defineProperty(exports, "hits", {
+  enumerable: true,
+  get: function get() {
+    return _hits.default;
+  }
+});
+Object.defineProperty(exports, "hitsPerPage", {
+  enumerable: true,
+  get: function get() {
+    return _hitsPerPage.default;
+  }
+});
+Object.defineProperty(exports, "index", {
+  enumerable: true,
+  get: function get() {
+    return _index.default;
+  }
+});
+Object.defineProperty(exports, "infiniteHits", {
+  enumerable: true,
+  get: function get() {
+    return _infiniteHits.default;
+  }
+});
+Object.defineProperty(exports, "lookingSimilar", {
+  enumerable: true,
+  get: function get() {
+    return _lookingSimilar.default;
+  }
+});
+Object.defineProperty(exports, "menu", {
+  enumerable: true,
+  get: function get() {
+    return _menu.default;
+  }
+});
+Object.defineProperty(exports, "menuSelect", {
+  enumerable: true,
+  get: function get() {
+    return _menuSelect.default;
+  }
+});
+Object.defineProperty(exports, "numericMenu", {
+  enumerable: true,
+  get: function get() {
+    return _numericMenu.default;
+  }
+});
+Object.defineProperty(exports, "pagination", {
+  enumerable: true,
+  get: function get() {
+    return _pagination.default;
+  }
+});
+Object.defineProperty(exports, "panel", {
+  enumerable: true,
+  get: function get() {
+    return _panel.default;
+  }
+});
+Object.defineProperty(exports, "places", {
+  enumerable: true,
+  get: function get() {
+    return _places.default;
+  }
+});
+Object.defineProperty(exports, "poweredBy", {
+  enumerable: true,
+  get: function get() {
+    return _poweredBy.default;
+  }
+});
+Object.defineProperty(exports, "queryRuleContext", {
+  enumerable: true,
+  get: function get() {
+    return _queryRuleContext.default;
+  }
+});
+Object.defineProperty(exports, "queryRuleCustomData", {
+  enumerable: true,
+  get: function get() {
+    return _queryRuleCustomData.default;
+  }
+});
+Object.defineProperty(exports, "rangeInput", {
+  enumerable: true,
+  get: function get() {
+    return _rangeInput.default;
+  }
+});
+Object.defineProperty(exports, "rangeSlider", {
+  enumerable: true,
+  get: function get() {
+    return _rangeSlider.default;
+  }
+});
+Object.defineProperty(exports, "ratingMenu", {
+  enumerable: true,
+  get: function get() {
+    return _ratingMenu.default;
+  }
+});
+Object.defineProperty(exports, "refinementList", {
+  enumerable: true,
+  get: function get() {
+    return _refinementList.default;
+  }
+});
+Object.defineProperty(exports, "relatedProducts", {
+  enumerable: true,
+  get: function get() {
+    return _relatedProducts.default;
+  }
+});
+Object.defineProperty(exports, "relevantSort", {
+  enumerable: true,
+  get: function get() {
+    return _relevantSort.default;
+  }
+});
+Object.defineProperty(exports, "searchBox", {
+  enumerable: true,
+  get: function get() {
+    return _searchBox.default;
+  }
+});
+Object.defineProperty(exports, "sortBy", {
+  enumerable: true,
+  get: function get() {
+    return _sortBy.default;
+  }
+});
+Object.defineProperty(exports, "stats", {
+  enumerable: true,
+  get: function get() {
+    return _stats.default;
+  }
+});
+Object.defineProperty(exports, "toggleRefinement", {
+  enumerable: true,
+  get: function get() {
+    return _toggleRefinement.default;
+  }
+});
+Object.defineProperty(exports, "trendingItems", {
+  enumerable: true,
+  get: function get() {
+    return _trendingItems.default;
+  }
+});
+Object.defineProperty(exports, "voiceSearch", {
+  enumerable: true,
+  get: function get() {
+    return _voiceSearch.default;
+  }
+});
+var _utils = require("../lib/utils");
+var _answers = _interopRequireDefault(require("./answers/answers"));
+var _configureRelatedItems = _interopRequireDefault(require("./configure-related-items/configure-related-items"));
+var _dynamicWidgets = _interopRequireDefault(require("./dynamic-widgets/dynamic-widgets"));
+var _analytics = _interopRequireDefault(require("./analytics/analytics"));
+var _breadcrumb = _interopRequireDefault(require("./breadcrumb/breadcrumb"));
+var _clearRefinements = _interopRequireDefault(require("./clear-refinements/clear-refinements"));
+var _configure = _interopRequireDefault(require("./configure/configure"));
+var _currentRefinements = _interopRequireDefault(require("./current-refinements/current-refinements"));
+var _geoSearch = _interopRequireDefault(require("./geo-search/geo-search"));
+var _hierarchicalMenu = _interopRequireDefault(require("./hierarchical-menu/hierarchical-menu"));
+var _hits = _interopRequireDefault(require("./hits/hits"));
+var _hitsPerPage = _interopRequireDefault(require("./hits-per-page/hits-per-page"));
+var _index = _interopRequireDefault(require("./index/index"));
+var _infiniteHits = _interopRequireDefault(require("./infinite-hits/infinite-hits"));
+var _menu = _interopRequireDefault(require("./menu/menu"));
+var _menuSelect = _interopRequireDefault(require("./menu-select/menu-select"));
+var _numericMenu = _interopRequireDefault(require("./numeric-menu/numeric-menu"));
+var _pagination = _interopRequireDefault(require("./pagination/pagination"));
+var _panel = _interopRequireDefault(require("./panel/panel"));
+var _places = _interopRequireDefault(require("./places/places"));
+var _poweredBy = _interopRequireDefault(require("./powered-by/powered-by"));
+var _queryRuleContext = _interopRequireDefault(require("./query-rule-context/query-rule-context"));
+var _queryRuleCustomData = _interopRequireDefault(require("./query-rule-custom-data/query-rule-custom-data"));
+var _relatedProducts = _interopRequireDefault(require("./related-products/related-products"));
+var _rangeInput = _interopRequireDefault(require("./range-input/range-input"));
+var _rangeSlider = _interopRequireDefault(require("./range-slider/range-slider"));
+var _ratingMenu = _interopRequireDefault(require("./rating-menu/rating-menu"));
+var _refinementList = _interopRequireDefault(require("./refinement-list/refinement-list"));
+var _relevantSort = _interopRequireDefault(require("./relevant-sort/relevant-sort"));
+var _searchBox = _interopRequireDefault(require("./search-box/search-box"));
+var _sortBy = _interopRequireDefault(require("./sort-by/sort-by"));
+var _stats = _interopRequireDefault(require("./stats/stats"));
+var _toggleRefinement = _interopRequireDefault(require("./toggle-refinement/toggle-refinement"));
+var _trendingItems = _interopRequireDefault(require("./trending-items/trending-items"));
+var _voiceSearch = _interopRequireDefault(require("./voice-search/voice-search"));
+var _frequentlyBoughtTogether = _interopRequireDefault(require("./frequently-bought-together/frequently-bought-together"));
+var _lookingSimilar = _interopRequireDefault(require("./looking-similar/looking-similar"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/** @deprecated answers is no longer supported */
+var EXPERIMENTAL_answers = exports.EXPERIMENTAL_answers = (0, _utils.deprecate)(_answers.default, 'answers is no longer supported');
+
+/** @deprecated use relatedItems instead */
+var EXPERIMENTAL_configureRelatedItems = exports.EXPERIMENTAL_configureRelatedItems = (0, _utils.deprecate)(_configureRelatedItems.default, 'EXPERIMENTAL_configureRelatedItems is deprecated and will be removed in a next minor version of InstantSearch. Please use relatedItems instead.');
+
+/** @deprecated use dynamicWidgets */
+var EXPERIMENTAL_dynamicWidgets = exports.EXPERIMENTAL_dynamicWidgets = (0, _utils.deprecate)(_dynamicWidgets.default, 'use dynamicWidgets');
+var chat = exports.chat = function chat() {
+  throw new Error("\"chat\" is not available from the UMD build.\n\nPlease use InstantSearch.js with a packaging system:\nhttps://www.algolia.com/doc/guides/building-search-ui/installation/js/#with-a-packaging-system");
+};