react-instantsearch-core 7.0.3 → 7.2.0

package/dist/umd/ReactInstantSearchCore.js

@@ -7,7 +7,7 @@
 
   var React__default = 'default' in React ? React['default'] : React;
 
-  var version = '7.0.3';
+  var version = '7.2.0';
 
   // Copyright Joyent, Inc. and other Node contributors.
   //
@@ -4327,7 +4327,7 @@
 
   var SearchResults_1 = SearchResults;
 
-  var version$1 = '3.14.1';
+  var version$1 = '3.14.2';
 
   var escapeFacetValue$3 = escapeFacetValue_1.escapeFacetValue;
 
@@ -8045,6 +8045,11 @@
     return stableValue;
   }
 
+  var useKey = 'use';
+
+  // @TODO: Remove this file and import directly from React when available.
+  var use = React[useKey];
+
   /**
    * `useLayoutEffect` that doesn't show a warning when server-side rendering.
    *
@@ -8052,11 +8057,19 @@
    */
   var useIsomorphicLayoutEffect = typeof window !== 'undefined' ? React.useLayoutEffect : React.useEffect;
 
+  var InstantSearchRSCContext = /*#__PURE__*/React.createContext(null);
+
+  function useRSCContext() {
+    return React.useContext(InstantSearchRSCContext);
+  }
+
   function useWidget(_ref) {
+    var _waitingForResultsRef;
     var widget = _ref.widget,
       parentIndex = _ref.parentIndex,
       props = _ref.props,
       shouldSsr = _ref.shouldSsr;
+    var waitingForResultsRef = useRSCContext();
     var prevPropsRef = React.useRef(props);
     React.useEffect(function () {
       prevPropsRef.current = props;
@@ -8116,9 +8129,20 @@
         });
       };
     }, [parentIndex, widget, shouldAddWidgetEarly, search, props]);
-    if (shouldAddWidgetEarly) {
+    if (shouldAddWidgetEarly || (waitingForResultsRef === null || waitingForResultsRef === void 0 ? void 0 : (_waitingForResultsRef = waitingForResultsRef.current) === null || _waitingForResultsRef === void 0 ? void 0 : _waitingForResultsRef.status) === 'pending') {
       parentIndex.addWidgets([widget]);
     }
+    if (typeof window === 'undefined' && waitingForResultsRef !== null && waitingForResultsRef !== void 0 && waitingForResultsRef.current &&
+    // We need the widgets contained in the index to be added before we trigger the search request.
+    widget.$$type !== 'ais.index') {
+      var _search$helper;
+      use(waitingForResultsRef.current);
+      // If we made a second request because of DynamicWidgets, we need to wait for the second result,
+      // except for DynamicWidgets itself which needs to render its children after the first result.
+      if (widget.$$type !== 'ais.dynamicWidgets' && (_search$helper = search.helper) !== null && _search$helper !== void 0 && _search$helper.lastResults) {
+        use(waitingForResultsRef.current);
+      }
+    }
   }
 
   var _excluded$1 = ["instantSearchInstance", "widgetParams"],
@@ -8799,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,
@@ -8808,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();
           }
@@ -8881,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) {
@@ -9535,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
@@ -11262,7 +11295,7 @@
     };
   }
 
-  var version$2 = '4.56.11';
+  var version$2 = '4.58.0';
 
   function _typeof$j(obj) {
     "@babel/helpers - typeof";
@@ -11425,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.
@@ -11443,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);
@@ -11515,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.'));
       }
@@ -11529,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;
@@ -11988,8 +12029,10 @@
     var forceUpdate = useForceUpdate();
     var serverContext = useInstantSearchServerContext();
     var serverState = useInstantSearchSSRContext();
+    var waitingForResultsRef = useRSCContext();
     var initialResults = serverState === null || serverState === void 0 ? void 0 : serverState.initialResults;
     var prevPropsRef = React.useRef(props);
+    var shouldRenderAtOnce = serverContext || initialResults || waitingForResultsRef;
     var searchRef = React.useRef(null);
     // As we need to render on mount with SSR, using the local ref above in `StrictMode` will
     // create and start two instances of InstantSearch. To avoid this, we instead discard it and use
@@ -12013,7 +12056,7 @@
         }, 0);
       };
       search._schedule.queue = [];
-      if (serverContext || initialResults) {
+      if (shouldRenderAtOnce) {
         // InstantSearch.js has a private Initial Results API that lets us inject
         // results on the search instance.
         // On the server, we default the initial results to an empty object so that
@@ -12027,7 +12070,7 @@
       // On the server, we start the search early to compute the search parameters.
       // On SSR, we start the search early to directly catch up with the lifecycle
       // and render.
-      if (serverContext || initialResults) {
+      if (shouldRenderAtOnce) {
         search.start();
       }
       if (serverContext) {
@@ -12070,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`
@@ -12141,8 +12188,8 @@
    * which is either `nodejs` or `edge`.
    */
   function getNextVersion() {
-    var _next, _process$env;
-    return typeof window !== 'undefined' && ((_next = window.next) === null || _next === void 0 ? void 0 : _next.version) || (typeof process !== 'undefined' ? (_process$env = process.env) === null || _process$env === void 0 ? void 0 : _process$env.NEXT_RUNTIME : undefined);
+    var _next2, _process$env;
+    return typeof window !== 'undefined' && ((_next2 = window.next) === null || _next2 === void 0 ? void 0 : _next2.version) || (typeof process !== 'undefined' ? (_process$env = process.env) === null || _process$env === void 0 ? void 0 : _process$env.NEXT_RUNTIME : undefined);
   }
 
   var _excluded$6 = ["children"];
@@ -17233,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]);
@@ -17242,6 +17296,7 @@
     React.useEffect(function () {
       function handleRender() {
         setLocalUiState(search.getUiState());
+        setRenderState(search.renderState);
       }
       search.addListener('render', handleRender);
       return function () {
@@ -17252,7 +17307,9 @@
       uiState: uiState,
       setUiState: setUiState,
       indexUiState: indexUiState,
-      setIndexUiState: setIndexUiState
+      setIndexUiState: setIndexUiState,
+      renderState: renderState,
+      indexRenderState: indexRenderState
     };
   }
 
@@ -17264,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;
@@ -17297,6 +17356,8 @@
       setUiState: setUiState,
       indexUiState: indexUiState,
       setIndexUiState: setIndexUiState,
+      renderState: renderState,
+      indexRenderState: indexRenderState,
       addMiddlewares: addMiddlewares,
       refresh: refresh,
       status: search.status,
@@ -17304,6 +17365,33 @@
     };
   }
 
+  // This is needed in order to work with RSC Suspense, perhaps they will later provide a wrapper.
+
+  function isStatefulPromise(promise) {
+    return 'status' in promise;
+  }
+  function wrapPromiseWithState(promise) {
+    if (isStatefulPromise(promise)) {
+      return promise;
+    }
+    var pendingPromise = promise;
+    pendingPromise.status = 'pending';
+    pendingPromise.then(function (value) {
+      if (pendingPromise.status === 'pending') {
+        var fulfilledPromise = pendingPromise;
+        fulfilledPromise.status = 'fulfilled';
+        fulfilledPromise.value = value;
+      }
+    }, function (reason) {
+      if (pendingPromise.status === 'pending') {
+        var rejectedPromise = pendingPromise;
+        rejectedPromise.status = 'rejected';
+        rejectedPromise.reason = reason;
+      }
+    });
+    return promise;
+  }
+
   function _typeof$D(obj) {
     "@babel/helpers - typeof";
 
@@ -17501,6 +17589,7 @@
   exports.DynamicWidgets = DynamicWidgets;
   exports.Index = Index;
   exports.InstantSearch = InstantSearch$1;
+  exports.InstantSearchRSCContext = InstantSearchRSCContext;
   exports.InstantSearchSSRProvider = InstantSearchSSRProvider;
   exports.InstantSearchServerContext = InstantSearchServerContext;
   exports.getServerState = getServerState;
@@ -17516,11 +17605,13 @@
   exports.useHitsPerPage = useHitsPerPage;
   exports.useInfiniteHits = useInfiniteHits;
   exports.useInstantSearch = useInstantSearch;
+  exports.useInstantSearchContext = useInstantSearchContext;
   exports.useMenu = useMenu;
   exports.useNumericMenu = useNumericMenu;
   exports.usePagination = usePagination;
   exports.usePoweredBy = usePoweredBy;
   exports.useQueryRules = useQueryRules;
+  exports.useRSCContext = useRSCContext;
   exports.useRange = useRange;
   exports.useRefinementList = useRefinementList;
   exports.useSearchBox = useSearchBox;
@@ -17528,6 +17619,7 @@
   exports.useStats = useStats;
   exports.useToggleRefinement = useToggleRefinement;
   exports.version = version;
+  exports.wrapPromiseWithState = wrapPromiseWithState;
 
   Object.defineProperty(exports, '__esModule', { value: true });