react-instantsearch-core 7.1.0 → 7.2.0

package/README.md

@@ -1,7 +1,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-
 - [react-instantsearch-core](#react-instantsearch-core)
   - [Installation](#installation)
   - [Getting started](#getting-started)

package/dist/cjs/hooks/useInstantSearch.js

@@ -17,7 +17,9 @@ function useInstantSearch() {
     uiState = _useSearchState.uiState,
     setUiState = _useSearchState.setUiState,
     indexUiState = _useSearchState.indexUiState,
-    setIndexUiState = _useSearchState.setIndexUiState;
+    setIndexUiState = _useSearchState.setIndexUiState,
+    renderState = _useSearchState.renderState,
+    indexRenderState = _useSearchState.indexRenderState;
   var _useSearchResults = (0, _useSearchResults2.useSearchResults)(),
     results = _useSearchResults.results,
     scopedResults = _useSearchResults.scopedResults;
@@ -50,6 +52,8 @@ function useInstantSearch() {
     setUiState: setUiState,
     indexUiState: indexUiState,
     setIndexUiState: setIndexUiState,
+    renderState: renderState,
+    indexRenderState: indexRenderState,
     addMiddlewares: addMiddlewares,
     refresh: refresh,
     status: search.status,

package/dist/cjs/lib/useInstantSearchApi.js

@@ -4,16 +4,25 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.useInstantSearchApi = useInstantSearchApi;
-var _InstantSearch = _interopRequireDefault(require("instantsearch.js/cjs/lib/InstantSearch"));
+var _InstantSearch = _interopRequireWildcard(require("instantsearch.js/cjs/lib/InstantSearch"));
 var _react = require("react");
 var _shim = require("use-sync-external-store/shim");
 var _version = _interopRequireDefault(require("../version"));
+var _dequal = require("./dequal");
 var _useForceUpdate = require("./useForceUpdate");
 var _useInstantSearchServerContext = require("./useInstantSearchServerContext");
 var _useInstantSearchSSRContext = require("./useInstantSearchSSRContext");
 var _useRSCContext = require("./useRSCContext");
 var _warn = require("./warn");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 var defaultUserAgents = ["react (".concat(_react.version, ")"), "react-instantsearch (".concat(_version.default, ")"), "react-instantsearch-core (".concat(_version.default, ")")];
 var serverUserAgent = "react-instantsearch-server (".concat(_version.default, ")");
 var nextUserAgent = function nextUserAgent(nextVersion) {
@@ -109,6 +118,10 @@ function useInstantSearchApi(props) {
       _search._stalledSearchDelay = (_props$stalledSearchD = props.stalledSearchDelay) !== null && _props$stalledSearchD !== void 0 ? _props$stalledSearchD : 200;
       prevPropsRef.current = props;
     }
+    if (!(0, _dequal.dequal)(prevProps.future, props.future)) {
+      _search.future = _objectSpread(_objectSpread({}, _InstantSearch.INSTANTSEARCH_FUTURE_DEFAULTS), props.future);
+      prevPropsRef.current = props;
+    }
 
     // Updating the `routing` prop is not supported because InstantSearch.js
     // doesn't let us change it. This might not be a problem though, because `routing`

package/dist/cjs/lib/useSearchState.js

@@ -24,6 +24,13 @@ function useSearchState() {
     uiState = _useState2[0],
     setLocalUiState = _useState2[1];
   var indexUiState = uiState[indexId];
+  var _useState3 = (0, _react.useState)(function () {
+      return search.renderState;
+    }),
+    _useState4 = _slicedToArray(_useState3, 2),
+    renderState = _useState4[0],
+    setRenderState = _useState4[1];
+  var indexRenderState = renderState[indexId] || {};
   var setUiState = (0, _react.useCallback)(function (nextUiState) {
     search.setUiState(nextUiState);
   }, [search]);
@@ -33,6 +40,7 @@ function useSearchState() {
   (0, _react.useEffect)(function () {
     function handleRender() {
       setLocalUiState(search.getUiState());
+      setRenderState(search.renderState);
     }
     search.addListener('render', handleRender);
     return function () {
@@ -43,6 +51,8 @@ function useSearchState() {
     uiState: uiState,
     setUiState: setUiState,
     indexUiState: indexUiState,
-    setIndexUiState: setIndexUiState
+    setIndexUiState: setIndexUiState,
+    renderState: renderState,
+    indexRenderState: indexRenderState
   };
 }

package/dist/cjs/version.js

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

package/dist/es/hooks/useInstantSearch.js

@@ -11,7 +11,9 @@ export function useInstantSearch() {
     uiState = _useSearchState.uiState,
     setUiState = _useSearchState.setUiState,
     indexUiState = _useSearchState.indexUiState,
-    setIndexUiState = _useSearchState.setIndexUiState;
+    setIndexUiState = _useSearchState.setIndexUiState,
+    renderState = _useSearchState.renderState,
+    indexRenderState = _useSearchState.indexRenderState;
   var _useSearchResults = useSearchResults(),
     results = _useSearchResults.results,
     scopedResults = _useSearchResults.scopedResults;
@@ -44,6 +46,8 @@ export function useInstantSearch() {
     setUiState: setUiState,
     indexUiState: indexUiState,
     setIndexUiState: setIndexUiState,
+    renderState: renderState,
+    indexRenderState: indexRenderState,
     addMiddlewares: addMiddlewares,
     refresh: refresh,
     status: search.status,

package/dist/es/lib/useInstantSearchApi.js

@@ -1,7 +1,14 @@
-import InstantSearch from "instantsearch.js/es/lib/InstantSearch.js";
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+import InstantSearch, { INSTANTSEARCH_FUTURE_DEFAULTS } from "instantsearch.js/es/lib/InstantSearch.js";
 import { useCallback, useRef, version as ReactVersion } from 'react';
 import { useSyncExternalStore } from "use-sync-external-store/shim/index.js";
 import version from "../version.js";
+import { dequal } from "./dequal.js";
 import { useForceUpdate } from "./useForceUpdate.js";
 import { useInstantSearchServerContext } from "./useInstantSearchServerContext.js";
 import { useInstantSearchSSRContext } from "./useInstantSearchSSRContext.js";
@@ -102,6 +109,10 @@ export function useInstantSearchApi(props) {
       _search._stalledSearchDelay = (_props$stalledSearchD = props.stalledSearchDelay) !== null && _props$stalledSearchD !== void 0 ? _props$stalledSearchD : 200;
       prevPropsRef.current = props;
     }
+    if (!dequal(prevProps.future, props.future)) {
+      _search.future = _objectSpread(_objectSpread({}, INSTANTSEARCH_FUTURE_DEFAULTS), props.future);
+      prevPropsRef.current = props;
+    }
 
     // Updating the `routing` prop is not supported because InstantSearch.js
     // doesn't let us change it. This might not be a problem though, because `routing`

package/dist/es/lib/useSearchState.d.ts

@@ -4,5 +4,7 @@ export type SearchStateApi<TUiState extends UiState> = {
     setUiState: InstantSearch<TUiState>['setUiState'];
     indexUiState: TUiState[string];
     setIndexUiState: IndexWidget<TUiState>['setIndexUiState'];
+    renderState: InstantSearch<TUiState>['renderState'];
+    indexRenderState: InstantSearch<TUiState>['renderState'][string];
 };
 export declare function useSearchState<TUiState extends UiState>(): SearchStateApi<TUiState>;

package/dist/es/lib/useSearchState.js

@@ -18,6 +18,13 @@ export function useSearchState() {
     uiState = _useState2[0],
     setLocalUiState = _useState2[1];
   var indexUiState = uiState[indexId];
+  var _useState3 = useState(function () {
+      return search.renderState;
+    }),
+    _useState4 = _slicedToArray(_useState3, 2),
+    renderState = _useState4[0],
+    setRenderState = _useState4[1];
+  var indexRenderState = renderState[indexId] || {};
   var setUiState = useCallback(function (nextUiState) {
     search.setUiState(nextUiState);
   }, [search]);
@@ -27,6 +34,7 @@ export function useSearchState() {
   useEffect(function () {
     function handleRender() {
       setLocalUiState(search.getUiState());
+      setRenderState(search.renderState);
     }
     search.addListener('render', handleRender);
     return function () {
@@ -37,6 +45,8 @@ export function useSearchState() {
     uiState: uiState,
     setUiState: setUiState,
     indexUiState: indexUiState,
-    setIndexUiState: setIndexUiState
+    setIndexUiState: setIndexUiState,
+    renderState: renderState,
+    indexRenderState: indexRenderState
   };
 }

package/dist/es/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "7.1.0";
+declare const _default: "7.2.0";
 export default _default;

package/dist/es/version.js

@@ -1 +1 @@
-export default '7.1.0';
+export default '7.2.0';

package/dist/umd/ReactInstantSearchCore.js

@@ -7,7 +7,7 @@
 
   var React__default = 'default' in React ? React['default'] : React;
 
-  var version = '7.1.0';
+  var version = '7.2.0';
 
   // Copyright Joyent, Inc. and other Node contributors.
   //
@@ -8823,7 +8823,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,
@@ -8832,14 +8832,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();
           }
@@ -8905,7 +8914,7 @@
           return mainHelper.searchForFacetValues(facetName, facetValue, maxFacetHits, state);
         };
         derivedHelper = mainHelper.derive(function () {
-          return mergeSearchParameters.apply(void 0, _toConsumableArray$1(resolveSearchParameters(_this3)));
+          return mergeSearchParameters.apply(void 0, [mainHelper.state].concat(_toConsumableArray$1(resolveSearchParameters(_this3))));
         });
         var indexInitialResults = (_instantSearchInstanc = instantSearchInstance._initialResults) === null || _instantSearchInstanc === void 0 ? void 0 : _instantSearchInstanc[this.getIndexId()];
         if (indexInitialResults) {
@@ -9559,7 +9568,7 @@
         },
         started: function started() {
           insightsClient('addAlgoliaAgent', 'insights-middleware');
-          helper = instantSearchInstance.helper;
+          helper = instantSearchInstance.mainHelper;
           initialParameters = {
             userToken: helper.state.userToken,
             clickAnalytics: helper.state.clickAnalytics
@@ -11286,7 +11295,7 @@
     };
   }
 
-  var version$2 = '4.57.0';
+  var version$2 = '4.58.0';
 
   function _typeof$j(obj) {
     "@babel/helpers - typeof";
@@ -11449,6 +11458,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.
@@ -11467,6 +11480,7 @@
       _defineProperty$e(_assertThisInitialized(_this), "indexName", void 0);
       _defineProperty$e(_assertThisInitialized(_this), "insightsClient", void 0);
       _defineProperty$e(_assertThisInitialized(_this), "onStateChange", null);
+      _defineProperty$e(_assertThisInitialized(_this), "future", void 0);
       _defineProperty$e(_assertThisInitialized(_this), "helper", void 0);
       _defineProperty$e(_assertThisInitialized(_this), "mainHelper", void 0);
       _defineProperty$e(_assertThisInitialized(_this), "mainIndex", void 0);
@@ -11539,7 +11553,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 ? _objectSpread$c(_objectSpread$c({}, INSTANTSEARCH_FUTURE_DEFAULTS), options.future || {}) : _options$future;
       if (searchClient === null) {
         throw new Error(withUsage$3('The `searchClient` option is required.'));
       }
@@ -11553,6 +11569,7 @@
         throw new Error(withUsage$3('The `insightsClient` option should be a function.'));
       }
       _this.client = searchClient;
+      _this.future = future;
       _this.insightsClient = insightsClient;
       _this.indexName = indexName;
       _this.helper = null;
@@ -12096,6 +12113,10 @@
         _search._stalledSearchDelay = (_props$stalledSearchD = props.stalledSearchDelay) !== null && _props$stalledSearchD !== void 0 ? _props$stalledSearchD : 200;
         prevPropsRef.current = props;
       }
+      if (!dequal(prevProps.future, props.future)) {
+        _search.future = _objectSpread2(_objectSpread2({}, INSTANTSEARCH_FUTURE_DEFAULTS), props.future);
+        prevPropsRef.current = props;
+      }
 
       // Updating the `routing` prop is not supported because InstantSearch.js
       // doesn't let us change it. This might not be a problem though, because `routing`
@@ -17259,6 +17280,13 @@
       uiState = _useState2[0],
       setLocalUiState = _useState2[1];
     var indexUiState = uiState[indexId];
+    var _useState3 = React.useState(function () {
+        return search.renderState;
+      }),
+      _useState4 = _slicedToArray$3(_useState3, 2),
+      renderState = _useState4[0],
+      setRenderState = _useState4[1];
+    var indexRenderState = renderState[indexId] || {};
     var setUiState = React.useCallback(function (nextUiState) {
       search.setUiState(nextUiState);
     }, [search]);
@@ -17268,6 +17296,7 @@
     React.useEffect(function () {
       function handleRender() {
         setLocalUiState(search.getUiState());
+        setRenderState(search.renderState);
       }
       search.addListener('render', handleRender);
       return function () {
@@ -17278,7 +17307,9 @@
       uiState: uiState,
       setUiState: setUiState,
       indexUiState: indexUiState,
-      setIndexUiState: setIndexUiState
+      setIndexUiState: setIndexUiState,
+      renderState: renderState,
+      indexRenderState: indexRenderState
     };
   }
 
@@ -17290,7 +17321,9 @@
       uiState = _useSearchState.uiState,
       setUiState = _useSearchState.setUiState,
       indexUiState = _useSearchState.indexUiState,
-      setIndexUiState = _useSearchState.setIndexUiState;
+      setIndexUiState = _useSearchState.setIndexUiState,
+      renderState = _useSearchState.renderState,
+      indexRenderState = _useSearchState.indexRenderState;
     var _useSearchResults = useSearchResults(),
       results = _useSearchResults.results,
       scopedResults = _useSearchResults.scopedResults;
@@ -17323,6 +17356,8 @@
       setUiState: setUiState,
       indexUiState: indexUiState,
       setIndexUiState: setIndexUiState,
+      renderState: renderState,
+      indexRenderState: indexRenderState,
       addMiddlewares: addMiddlewares,
       refresh: refresh,
       status: search.status,