react-instantsearch-core 7.0.2 → 7.1.0

package/dist/umd/ReactInstantSearchCore.js

@@ -1,4 +1,4 @@
-/*! React InstantSearchCore UNRELEASED | © Algolia, inc. | https://github.com/algolia/instantsearch.js */
+/*! React InstantSearchCore UNRELEASED | © Algolia, inc. | https://github.com/algolia/instantsearch */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('react')) :
   typeof define === 'function' && define.amd ? define(['exports', 'react'], factory) :
@@ -7,7 +7,7 @@
 
   var React__default = 'default' in React ? React['default'] : React;
 
-  var version = '7.0.2';
+  var version = '7.1.0';
 
   // Copyright Joyent, Inc. and other Node contributors.
   //
@@ -4327,7 +4327,7 @@
 
   var SearchResults_1 = SearchResults;
 
-  var version$1 = '3.14.0';
+  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"],
@@ -8195,7 +8219,7 @@
 
           // We get the widget render state by providing the same parameters as
           // InstantSearch provides to the widget's `render` method.
-          // See https://github.com/algolia/instantsearch.js/blob/019cd18d0de6dd320284aa4890541b7fe2198c65/src/widgets/index/index.ts#L604-L617
+          // See https://github.com/algolia/instantsearch/blob/019cd18d0de6dd320284aa4890541b7fe2198c65/src/widgets/index/index.ts#L604-L617
           var _widget$getWidgetRend = widget.getWidgetRenderState({
               helper: helper,
               parent: parentIndex,
@@ -8948,7 +8972,7 @@
         // configuration step. This is mainly for backward compatibility with custom
         // widgets. When the subscription happens before the `init` step, the (static)
         // configuration of the widget is pushed in the URL. That's what we want to avoid.
-        // https://github.com/algolia/instantsearch.js/pull/994/commits/4a672ae3fd78809e213de0368549ef12e9dc9454
+        // https://github.com/algolia/instantsearch/pull/994/commits/4a672ae3fd78809e213de0368549ef12e9dc9454
         helper.on('change', function (event) {
           var state = event.state;
           var _uiState = event._uiState;
@@ -10773,7 +10797,7 @@
        *
        * It always generates the full URL, not a relative one.
        * This allows to handle cases like using a <base href>.
-       * See: https://github.com/algolia/instantsearch.js/issues/790
+       * See: https://github.com/algolia/instantsearch/issues/790
        */
     }, {
       key: "createURL",
@@ -11262,7 +11286,7 @@
     };
   }
 
-  var version$2 = '4.56.10';
+  var version$2 = '4.57.0';
 
   function _typeof$j(obj) {
     "@babel/helpers - typeof";
@@ -11852,7 +11876,7 @@
       /**
        * Removes all widgets without triggering a search afterwards. This is an **EXPERIMENTAL** feature,
        * if you find an issue with it, please
-       * [open an issue](https://github.com/algolia/instantsearch.js/issues/new?title=Problem%20with%20dispose).
+       * [open an issue](https://github.com/algolia/instantsearch/issues/new?title=Problem%20with%20dispose).
        * @return {undefined} This method does not return anything
        */
     }, {
@@ -11988,8 +12012,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
@@ -12000,7 +12026,7 @@
     if (searchRef.current === null) {
       // We don't use the `instantsearch()` function because it comes with other
       // top-level APIs that we don't need.
-      // See https://github.com/algolia/instantsearch.js/blob/5b529f43d8acc680f85837eaaa41f7fd03a3f833/src/index.es.ts#L63-L86
+      // See https://github.com/algolia/instantsearch/blob/5b529f43d8acc680f85837eaaa41f7fd03a3f833/src/index.es.ts#L63-L86
       var search = new InstantSearch(props);
       search._schedule = function _schedule(cb) {
         search._schedule.queue.push(cb);
@@ -12013,7 +12039,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 +12053,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) {
@@ -12141,8 +12167,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"];
@@ -17206,7 +17232,7 @@
 
         // Results can be `null` when the first search is stalled.
         // In this case, we skip the update.
-        // See: https://github.com/algolia/instantsearch.js/blob/20996c7a159988c58e00ff24d2d2dc98af8b980f/src/widgets/index/index.ts#L652-L657
+        // See: https://github.com/algolia/instantsearch/blob/20996c7a159988c58e00ff24d2d2dc98af8b980f/src/widgets/index/index.ts#L652-L657
         if (results !== null) {
           setSearchResults({
             results: results,
@@ -17304,6 +17330,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 +17554,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 +17570,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 +17584,7 @@
   exports.useStats = useStats;
   exports.useToggleRefinement = useToggleRefinement;
   exports.version = version;
+  exports.wrapPromiseWithState = wrapPromiseWithState;
 
   Object.defineProperty(exports, '__esModule', { value: true });