instantsearch.js 4.79.2 → 4.80.0

package/es/components/Template/Template.js

@@ -60,7 +60,7 @@ var RawHtml = /*#__PURE__*/function (_Component) {
       });
       // 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 = '';
       }
     }

package/es/lib/InstantSearch.d.ts

@@ -197,7 +197,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
      * Widgets can be added either before or after InstantSearch has started.
      * @param widgets The array of widgets to add to InstantSearch.
      */
-    addWidgets(widgets: Array<Widget | IndexWidget>): this;
+    addWidgets(widgets: Array<Widget | IndexWidget | Widget[]>): this;
     /**
      * Removes a widget from the search instance.
      * @deprecated This method will still be supported in 4.x releases, but not further. It is replaced by `removeWidgets([widget])`
@@ -212,7 +212,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
      *
      * The widgets must implement a `dispose()` method to clear their states.
      */
-    removeWidgets(widgets: Array<Widget | IndexWidget>): this;
+    removeWidgets(widgets: Array<Widget | IndexWidget | Widget[]>): this;
     /**
      * Ends the initialization of InstantSearch.js and triggers the
      * first search.

package/es/lib/InstantSearch.js

@@ -322,12 +322,9 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       if (!Array.isArray(widgets)) {
         throw new Error(withUsage('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('The widget definition expects a `render` and/or an `init` method.'));
-      }
-      if (this.compositionID && widgets.some(isIndexWidget)) {
         throw new Error(withUsage('The `index` widget cannot be used with a composition-based InstantSearch implementation.'));
       }
       this.mainIndex.addWidgets(widgets);
@@ -360,11 +357,6 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       if (!Array.isArray(widgets)) {
         throw new Error(withUsage('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('The widget definition expects a `dispose` method.'));
-      }
       this.mainIndex.removeWidgets(widgets);
       return this;
     }

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.79.2";
+declare const _default: "4.80.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.79.2';
+export default '4.80.0';

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

@@ -1,7 +1,45 @@
 import type { InstantSearch, UiState, IndexUiState, Widget, ScopedResult, RecommendResponse } from '../../types';
 import type { AlgoliaSearchHelper as Helper, SearchParameters, SearchResults } from 'algoliasearch-helper';
 export type IndexWidgetParams = {
+    /**
+     * The index or composition id to target.
+     */
     indexName: string;
+    /**
+     * Id to use for the index if there are multiple indices with the same name.
+     * This will be used to create the URL and the render state.
+     */
+    indexId?: string;
+    /**
+     * If `true`, the index will not be merged with the main helper's state.
+     * This means that the index will not be part of the main search request.
+     *
+     * @default false
+     */
+    EXPERIMENTAL_isolated?: false;
+} | {
+    /**
+     * If `true`, the index will not be merged with the main helper's state.
+     * This means that the index will not be part of the main search request.
+     *
+     * This option is EXPERIMENTAL, and implementation details may change in the future.
+     * Things that could change are:
+     * - which widgets get rendered when a change happens
+     * - whether the index searches automatically
+     * - whether the index is included in the URL / UiState
+     * - whether the index is included in server-side rendering
+     *
+     * @default false
+     */
+    EXPERIMENTAL_isolated: true;
+    /**
+     * The index or composition id to target.
+     */
+    indexName?: string;
+    /**
+     * Id to use for the index if there are multiple indices with the same name.
+     * This will be used to create the URL and the render state.
+     */
     indexId?: string;
 };
 export type IndexInitOptions = {
@@ -29,8 +67,8 @@ export type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<IndexW
     getParent: () => IndexWidget | null;
     getWidgets: () => Array<Widget | IndexWidget>;
     createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
-    addWidgets: (widgets: Array<Widget | IndexWidget>) => IndexWidget;
-    removeWidgets: (widgets: Array<Widget | IndexWidget>) => IndexWidget;
+    addWidgets: (widgets: Array<Widget | IndexWidget | Widget[]>) => IndexWidget;
+    removeWidgets: (widgets: Array<Widget | IndexWidget | Widget[]>) => IndexWidget;
     init: (options: IndexInitOptions) => void;
     render: (options: IndexRenderOptions) => void;
     dispose: () => void;
@@ -53,6 +91,12 @@ export type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<IndexW
      * Can only be called after `init`.
      */
     setIndexUiState: (indexUiState: TUiState[string] | ((previousIndexUiState: TUiState[string]) => TUiState[string])) => void;
+    /**
+     * This index is isolated, meaning it will not be merged with the main
+     * helper's state.
+     * @private
+     */
+    _isolated: boolean;
 };
 declare const index: (widgetParams: IndexWidgetParams) => IndexWidget;
 export default index;

package/es/widgets/index/index.js

@@ -110,12 +110,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;
@@ -128,6 +134,7 @@ var index = function index(widgetParams) {
   return {
     $$type: 'ais.index',
     $$widgetType: 'ais.index',
+    _isolated: isolated,
     getIndexName: function getIndexName() {
       return indexName;
     },
@@ -179,7 +186,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') {
@@ -198,12 +205,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 (isIndexWidget(widget)) {
           return;
         }
@@ -218,8 +228,8 @@ var index = function index(widgetParams) {
         }
         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,
@@ -235,7 +245,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()] || {}, createInitArgs(localInstantSearchInstance, _this, localInstantSearchInstance._initialUiState));
             storeRenderState({
@@ -245,12 +255,17 @@ var index = function index(widgetParams) {
             });
           }
         });
-        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;
     },
@@ -259,13 +274,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 (isIndexWidget(widget)) {
@@ -281,8 +299,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,
@@ -300,8 +318,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.SearchParameters({
@@ -321,7 +339,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;
@@ -359,13 +382,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 = algoliasearchHelper({}, parameters.index, parameters);
+      helper = algoliasearchHelper(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({}),
@@ -389,7 +419,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 : algoliasearchHelper({}, '__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;
@@ -531,7 +563,9 @@ 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(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;
@@ -565,7 +599,7 @@ var index = function index(widgetParams) {
     },
     dispose: function dispose() {
       var _this5 = this,
-        _helper2,
+        _helper4,
         _derivedHelper3;
       localWidgets.forEach(function (widget) {
         if (widget.dispose && helper) {
@@ -585,13 +619,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(isIndexWidget).reduce(function (previousUiState, innerIndex) {
+      return localWidgets.filter(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))));
     },
@@ -627,4 +663,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.79.2",
+  "version": "4.80.0",
   "description": "InstantSearch.js is a JavaScript library for building performant and instant search experiences with Algolia.",
   "homepage": "https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/",
   "types": "es/index.d.ts",
@@ -56,9 +56,9 @@
     "watch:es": "yarn --silent build:es:base --watch"
   },
   "devDependencies": {
-    "@instantsearch/mocks": "1.77.0",
-    "@instantsearch/tests": "1.77.0",
-    "@instantsearch/testutils": "1.66.0",
+    "@instantsearch/mocks": "*",
+    "@instantsearch/tests": "*",
+    "@instantsearch/testutils": "*",
     "@storybook/html": "5.3.9",
     "@types/scriptjs": "0.0.2",
     "algoliasearch": "5.1.1",
@@ -66,5 +66,5 @@
     "scriptjs": "2.5.9",
     "webpack": "4.47.0"
   },
-  "gitHead": "4170d7c9a3ee4adc729330a7cba90527aca2dbc5"
+  "gitHead": "6e5bbe12332befe4f609b1540ab997827fd88f88"
 }