instantsearch.js 4.57.0 → 4.58.0

package/README.md

@@ -20,7 +20,6 @@ InstantSearch.js is a vanilla JavaScript library that lets you create an instant
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-
 - [Why](#why)
 - [Getting started](#getting-started)
 - [Installation](#installation)

package/cjs/lib/InstantSearch.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = exports.INSTANTSEARCH_FUTURE_DEFAULTS = void 0;
 var _events = _interopRequireDefault(require("@algolia/events"));
 var _algoliasearchHelper = _interopRequireDefault(require("algoliasearch-helper"));
 var _createInsightsMiddleware = require("../middlewares/createInsightsMiddleware");
@@ -43,15 +43,21 @@ function defaultCreateURL() {
 /**
  * Global options for an InstantSearch instance.
  */
+var INSTANTSEARCH_FUTURE_DEFAULTS = {
+  preserveSharedStateOnUnmount: false
+};
+
 /**
  * The actual implementation of the InstantSearch. This is
  * created using the `instantsearch` factory function.
  * It emits the 'render' event every time a search is done
  */
+exports.INSTANTSEARCH_FUTURE_DEFAULTS = INSTANTSEARCH_FUTURE_DEFAULTS;
 var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
   _inherits(InstantSearch, _EventEmitter);
   var _super = _createSuper(InstantSearch);
   function InstantSearch(options) {
+    var _options$future2;
     var _this;
     _classCallCheck(this, InstantSearch);
     _this = _super.call(this);
@@ -61,6 +67,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     _defineProperty(_assertThisInitialized(_this), "indexName", void 0);
     _defineProperty(_assertThisInitialized(_this), "insightsClient", void 0);
     _defineProperty(_assertThisInitialized(_this), "onStateChange", null);
+    _defineProperty(_assertThisInitialized(_this), "future", void 0);
     _defineProperty(_assertThisInitialized(_this), "helper", void 0);
     _defineProperty(_assertThisInitialized(_this), "mainHelper", void 0);
     _defineProperty(_assertThisInitialized(_this), "mainIndex", void 0);
@@ -133,7 +140,9 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       _options$insightsClie = options.insightsClient,
       insightsClient = _options$insightsClie === void 0 ? null : _options$insightsClie,
       _options$onStateChang = options.onStateChange,
-      onStateChange = _options$onStateChang === void 0 ? null : _options$onStateChang;
+      onStateChange = _options$onStateChang === void 0 ? null : _options$onStateChang,
+      _options$future = options.future,
+      future = _options$future === void 0 ? _objectSpread(_objectSpread({}, INSTANTSEARCH_FUTURE_DEFAULTS), options.future || {}) : _options$future;
     if (searchClient === null) {
       throw new Error(withUsage('The `searchClient` option is required.'));
     }
@@ -150,7 +159,14 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     process.env.NODE_ENV === 'development' ? (0, _utils.warning)(!options.searchParameters, "The `searchParameters` option is deprecated and will not be supported in InstantSearch.js 4.x.\n\nYou can replace it with the `configure` widget:\n\n```\nsearch.addWidgets([\n  configure(".concat(JSON.stringify(options.searchParameters, null, 2), ")\n]);\n```\n\nSee ").concat((0, _utils.createDocumentationLink)({
       name: 'configure'
     }))) : void 0;
+    if (process.env.NODE_ENV === 'development' && ((_options$future2 = options.future) === null || _options$future2 === void 0 ? void 0 : _options$future2.preserveSharedStateOnUnmount) === undefined) {
+      // eslint-disable-next-line no-console
+      console.info("Starting from the next major version, InstantSearch will change how widgets state is preserved when they are removed. InstantSearch will keep the state of unmounted widgets to be usable by other widgets with the same attribute.\n\nWe recommend setting `future.preserveSharedStateOnUnmount` to true to adopt this change today.\nTo stay with the current behaviour and remove this warning, set the option to false.\n\nSee documentation: ".concat((0, _utils.createDocumentationLink)({
+        name: 'instantsearch'
+      }), "#widget-param-future\n          "));
+    }
     _this.client = searchClient;
+    _this.future = future;
     _this.insightsClient = insightsClient;
     _this.indexName = indexName;
     _this.helper = null;

package/cjs/lib/version.js

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

package/cjs/middlewares/createInsightsMiddleware.js

@@ -141,7 +141,7 @@ function createInsightsMiddleware() {
       },
       started: function started() {
         insightsClient('addAlgoliaAgent', 'insights-middleware');
-        helper = instantSearchInstance.helper;
+        helper = instantSearchInstance.mainHelper;
         initialParameters = {
           userToken: helper.state.userToken,
           clickAnalytics: helper.state.clickAnalytics

package/cjs/widgets/index/index.js

@@ -214,7 +214,7 @@ var index = function index(widgetParams) {
         return widgets.indexOf(widget) === -1;
       });
       if (localInstantSearchInstance && Boolean(widgets.length)) {
-        var _nextState = widgets.reduce(function (state, widget) {
+        var cleanedState = widgets.reduce(function (state, widget) {
           // the `dispose` method exists at this point we already assert it
           var next = widget.dispose({
             helper: helper,
@@ -223,14 +223,23 @@ var index = function index(widgetParams) {
           });
           return next || state;
         }, helper.state);
+        var newState = localInstantSearchInstance.future.preserveSharedStateOnUnmount ? getLocalWidgetsSearchParameters(localWidgets, {
+          uiState: localUiState,
+          initialSearchParameters: new _algoliasearchHelper.default.SearchParameters({
+            index: this.getIndexName()
+          })
+        }) : getLocalWidgetsSearchParameters(localWidgets, {
+          uiState: getLocalWidgetsUiState(localWidgets, {
+            searchParameters: cleanedState,
+            helper: helper
+          }),
+          initialSearchParameters: cleanedState
+        });
         localUiState = getLocalWidgetsUiState(localWidgets, {
-          searchParameters: _nextState,
+          searchParameters: newState,
           helper: helper
         });
-        helper.setState(getLocalWidgetsSearchParameters(localWidgets, {
-          uiState: localUiState,
-          initialSearchParameters: _nextState
-        }));
+        helper.setState(newState);
         if (localWidgets.length) {
           localInstantSearchInstance.scheduleSearch();
         }
@@ -296,7 +305,7 @@ var index = function index(widgetParams) {
         return mainHelper.searchForFacetValues(facetName, facetValue, maxFacetHits, state);
       };
       derivedHelper = mainHelper.derive(function () {
-        return _utils.mergeSearchParameters.apply(void 0, _toConsumableArray((0, _utils.resolveSearchParameters)(_this3)));
+        return _utils.mergeSearchParameters.apply(void 0, [mainHelper.state].concat(_toConsumableArray((0, _utils.resolveSearchParameters)(_this3))));
       });
       var indexInitialResults = (_instantSearchInstanc = instantSearchInstance._initialResults) === null || _instantSearchInstanc === void 0 ? void 0 : _instantSearchInstanc[this.getIndexId()];
       if (indexInitialResults) {

package/dist/instantsearch.development.d.ts

@@ -2363,6 +2363,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     indexName: string;
     insightsClient: InsightsClient | null;
     onStateChange: InstantSearchOptions<TUiState>['onStateChange'] | null;
+    future: NonNullable<InstantSearchOptions<TUiState>['future']>;
     helper: AlgoliaSearchHelper | null;
     mainHelper: AlgoliaSearchHelper | null;
     mainIndex: IndexWidget;
@@ -2604,6 +2605,18 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * @deprecated This property will be still supported in 4.x releases, but not further. It is replaced by the `insights` middleware. For more information, visit https://www.algolia.com/doc/guides/getting-insights-and-analytics/search-analytics/click-through-and-conversions/how-to/send-click-and-conversion-events-with-instantsearch/js/
      */
     insightsClient?: InsightsClient;
+    future?: {
+        /**
+         * Changes the way `dispose` is used in InstantSearch lifecycle.
+         *
+         * If `false` (by default), each widget unmounting will remove its state as well, even if there are multiple widgets reading that UI State.
+         *
+         * If `true`, each widget unmounting will only remove its own state if it's the last of its type. This allows for dynamically adding and removing widgets without losing their state.
+         *
+         * @default false
+         */
+        preserveSharedStateOnUnmount?: boolean;
+    };
 };
 
 declare type InstantSearchStatus = 'idle' | 'loading' | 'stalled' | 'error';

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.57.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! InstantSearch.js 4.58.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) :
@@ -12665,7 +12665,7 @@
         },
         started: function started() {
           insightsClient('addAlgoliaAgent', 'insights-middleware');
-          helper = instantSearchInstance.helper;
+          helper = instantSearchInstance.mainHelper;
           initialParameters = {
             userToken: helper.state.userToken,
             clickAnalytics: helper.state.clickAnalytics
@@ -14272,7 +14272,7 @@
           return widgets.indexOf(widget) === -1;
         });
         if (localInstantSearchInstance && Boolean(widgets.length)) {
-          var _nextState = widgets.reduce(function (state, widget) {
+          var cleanedState = widgets.reduce(function (state, widget) {
             // the `dispose` method exists at this point we already assert it
             var next = widget.dispose({
               helper: helper,
@@ -14281,14 +14281,23 @@
             });
             return next || state;
           }, helper.state);
+          var newState = localInstantSearchInstance.future.preserveSharedStateOnUnmount ? getLocalWidgetsSearchParameters(localWidgets, {
+            uiState: localUiState,
+            initialSearchParameters: new algoliasearchHelper_1.SearchParameters({
+              index: this.getIndexName()
+            })
+          }) : getLocalWidgetsSearchParameters(localWidgets, {
+            uiState: getLocalWidgetsUiState(localWidgets, {
+              searchParameters: cleanedState,
+              helper: helper
+            }),
+            initialSearchParameters: cleanedState
+          });
           localUiState = getLocalWidgetsUiState(localWidgets, {
-            searchParameters: _nextState,
+            searchParameters: newState,
             helper: helper
           });
-          helper.setState(getLocalWidgetsSearchParameters(localWidgets, {
-            uiState: localUiState,
-            initialSearchParameters: _nextState
-          }));
+          helper.setState(newState);
           if (localWidgets.length) {
             localInstantSearchInstance.scheduleSearch();
           }
@@ -14354,7 +14363,7 @@
           return mainHelper.searchForFacetValues(facetName, facetValue, maxFacetHits, state);
         };
         derivedHelper = mainHelper.derive(function () {
-          return mergeSearchParameters.apply(void 0, _toConsumableArray(resolveSearchParameters(_this3)));
+          return mergeSearchParameters.apply(void 0, [mainHelper.state].concat(_toConsumableArray(resolveSearchParameters(_this3))));
         });
         var indexInitialResults = (_instantSearchInstanc = instantSearchInstance._initialResults) === null || _instantSearchInstanc === void 0 ? void 0 : _instantSearchInstanc[this.getIndexId()];
         if (indexInitialResults) {
@@ -14617,7 +14626,7 @@
     };
   }
 
-  var version$1 = '4.57.0';
+  var version$1 = '4.58.0';
 
   var withUsage$r = createDocumentationMessageGenerator({
     name: 'instantsearch'
@@ -14632,6 +14641,10 @@
   /**
    * Global options for an InstantSearch instance.
    */
+  var INSTANTSEARCH_FUTURE_DEFAULTS = {
+    preserveSharedStateOnUnmount: false
+  };
+
   /**
    * The actual implementation of the InstantSearch. This is
    * created using the `instantsearch` factory function.
@@ -14641,6 +14654,7 @@
     _inherits(InstantSearch, _EventEmitter);
     var _super = _createSuper(InstantSearch);
     function InstantSearch(options) {
+      var _options$future2;
       var _this;
       _classCallCheck(this, InstantSearch);
       _this = _super.call(this);
@@ -14650,6 +14664,7 @@
       _defineProperty(_assertThisInitialized(_this), "indexName", void 0);
       _defineProperty(_assertThisInitialized(_this), "insightsClient", void 0);
       _defineProperty(_assertThisInitialized(_this), "onStateChange", null);
+      _defineProperty(_assertThisInitialized(_this), "future", void 0);
       _defineProperty(_assertThisInitialized(_this), "helper", void 0);
       _defineProperty(_assertThisInitialized(_this), "mainHelper", void 0);
       _defineProperty(_assertThisInitialized(_this), "mainIndex", void 0);
@@ -14722,7 +14737,9 @@
         _options$insightsClie = options.insightsClient,
         insightsClient = _options$insightsClie === void 0 ? null : _options$insightsClie,
         _options$onStateChang = options.onStateChange,
-        onStateChange = _options$onStateChang === void 0 ? null : _options$onStateChang;
+        onStateChange = _options$onStateChang === void 0 ? null : _options$onStateChang,
+        _options$future = options.future,
+        future = _options$future === void 0 ? _objectSpread2(_objectSpread2({}, INSTANTSEARCH_FUTURE_DEFAULTS), options.future || {}) : _options$future;
       if (searchClient === null) {
         throw new Error(withUsage$r('The `searchClient` option is required.'));
       }
@@ -14739,7 +14756,14 @@
        _warning(!options.searchParameters, "The `searchParameters` option is deprecated and will not be supported in InstantSearch.js 4.x.\n\nYou can replace it with the `configure` widget:\n\n```\nsearch.addWidgets([\n  configure(".concat(JSON.stringify(options.searchParameters, null, 2), ")\n]);\n```\n\nSee ").concat(createDocumentationLink({
         name: 'configure'
       }))) ;
+      if ( ((_options$future2 = options.future) === null || _options$future2 === void 0 ? void 0 : _options$future2.preserveSharedStateOnUnmount) === undefined) {
+        // eslint-disable-next-line no-console
+        console.info("Starting from the next major version, InstantSearch will change how widgets state is preserved when they are removed. InstantSearch will keep the state of unmounted widgets to be usable by other widgets with the same attribute.\n\nWe recommend setting `future.preserveSharedStateOnUnmount` to true to adopt this change today.\nTo stay with the current behaviour and remove this warning, set the option to false.\n\nSee documentation: ".concat(createDocumentationLink({
+          name: 'instantsearch'
+        }), "#widget-param-future\n          "));
+      }
       _this.client = searchClient;
+      _this.future = future;
       _this.insightsClient = insightsClient;
       _this.indexName = indexName;
       _this.helper = null;
@@ -16110,7 +16134,6 @@
   var _objectWithoutProperties$1 = unwrapExports(objectWithoutProperties);
 
   var _excluded$9 = ["parts", "highlightedTagName", "nonHighlightedTagName", "separator", "className", "classNames"];
-  // This is a minimal subset of the actual types from the `JSX` namespace.
 
   function createHighlightPartComponent(_ref) {
     var createElement = _ref.createElement;
@@ -16134,18 +16157,20 @@
       createElement: createElement,
       Fragment: Fragment
     });
-    return function Highlight(_ref4) {
-      var parts = _ref4.parts,
-          _ref4$highlightedTagN = _ref4.highlightedTagName,
-          highlightedTagName = _ref4$highlightedTagN === void 0 ? 'mark' : _ref4$highlightedTagN,
-          _ref4$nonHighlightedT = _ref4.nonHighlightedTagName,
-          nonHighlightedTagName = _ref4$nonHighlightedT === void 0 ? 'span' : _ref4$nonHighlightedT,
-          _ref4$separator = _ref4.separator,
-          separator = _ref4$separator === void 0 ? ', ' : _ref4$separator,
-          className = _ref4.className,
-          _ref4$classNames = _ref4.classNames,
-          classNames = _ref4$classNames === void 0 ? {} : _ref4$classNames,
-          props = _objectWithoutProperties$1(_ref4, _excluded$9);
+    return function Highlight(userProps) {
+      // Not destructured in function signature, to make sure it's not exposed in
+      // the type definition.
+      var parts = userProps.parts,
+          _userProps$highlighte = userProps.highlightedTagName,
+          highlightedTagName = _userProps$highlighte === void 0 ? 'mark' : _userProps$highlighte,
+          _userProps$nonHighlig = userProps.nonHighlightedTagName,
+          nonHighlightedTagName = _userProps$nonHighlig === void 0 ? 'span' : _userProps$nonHighlig,
+          _userProps$separator = userProps.separator,
+          separator = _userProps$separator === void 0 ? ', ' : _userProps$separator,
+          className = userProps.className,
+          _userProps$classNames = userProps.classNames,
+          classNames = _userProps$classNames === void 0 ? {} : _userProps$classNames,
+          props = _objectWithoutProperties$1(userProps, _excluded$9);
 
       return createElement("span", _extends$1({}, props, {
         className: cx(classNames.root, className)