react-instantsearch-core 7.0.2 → 7.1.0

package/README.md

@@ -1,6 +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 -->
-**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
 
 - [react-instantsearch-core](#react-instantsearch-core)
   - [Installation](#installation)
@@ -19,7 +19,7 @@ React InstantSearch Core is an open-source UI library for React that lets you qu
 InstantSearch’s goal is to help you implement awesome search experiences as smoothly as possible by providing a [complete search ecosystem](https://algolia.com/doc/guides/getting-started/how-algolia-works/#the-full-ecosystem). InstantSearch tackles an important part of this vast goal by providing front-end primitives that you can assemble into unique search interfaces.
 
 <p align="center">
-  <a href="https://codesandbox.io/s/github/algolia/instantsearch.js/tree/master/examples/react/default-themes" title="Edit on CodeSandbox">
+  <a href="https://codesandbox.io/s/github/algolia/instantsearch/tree/master/examples/react/default-themes" title="Edit on CodeSandbox">
     <img alt="Edit on CodeSandbox" src="https://codesandbox.io/static/img/play-codesandbox.svg">
   </a>
 </p>
@@ -65,7 +65,7 @@ To start contributing to code, you need to:
 1.  [Clone the repository](https://help.github.com/articles/cloning-a-repository/)
 1.  Install the dependencies: `yarn`
 
-Please read [our contribution process](https://github.com/algolia/instantsearch.js/blob/master/CONTRIBUTING.md) to learn more.
+Please read [our contribution process](https://github.com/algolia/instantsearch/blob/master/CONTRIBUTING.md) to learn more.
 
 ## License
 
@@ -73,9 +73,9 @@ React InstantSearch is [MIT licensed](../../LICENSE).
 
 <!-- Links -->
 
-[contributing-bugreport]: https://github.com/algolia/instantsearch.js/issues/new?template=BUG_REPORT.yml&labels=triage,Library%3A%20React+InstantSearch
-[contributing-featurerequest]: https://github.com/algolia/instantsearch.js/discussions/new?category=ideas&labels=triage,Library%3A%20React+InstantSearch&title=Feature%20request%3A%20
-[contributing-newissue]: https://github.com/algolia/instantsearch.js/issues/new?labels=triage,Library%3A%20React+InstantSearch
-[contributing-label-easy]: https://github.com/algolia/instantsearch.js/issues?q=is%3Aopen+is%3Aissue+label%3A%22Difficulty%3A+Easy%22+label%3A%22Library%3A%20React+InstantSearch%22
-[contributing-label-bug]: https://github.com/algolia/instantsearch.js/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Bug%22+label%3A%22Library%3A%20React+InstantSearch%22
-[contributing-label-chore]: https://github.com/algolia/instantsearch.js/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Chore%22+label%3A%22Library%3A%20React+InstantSearch%22
+[contributing-bugreport]: https://github.com/algolia/instantsearch/issues/new?template=BUG_REPORT.yml&labels=triage,Library%3A%20React+InstantSearch
+[contributing-featurerequest]: https://github.com/algolia/instantsearch/discussions/new?category=ideas&labels=triage,Library%3A%20React+InstantSearch&title=Feature%20request%3A%20
+[contributing-newissue]: https://github.com/algolia/instantsearch/issues/new?labels=triage,Library%3A%20React+InstantSearch
+[contributing-label-easy]: https://github.com/algolia/instantsearch/issues?q=is%3Aopen+is%3Aissue+label%3A%22Difficulty%3A+Easy%22+label%3A%22Library%3A%20React+InstantSearch%22
+[contributing-label-bug]: https://github.com/algolia/instantsearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Bug%22+label%3A%22Library%3A%20React+InstantSearch%22
+[contributing-label-chore]: https://github.com/algolia/instantsearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Chore%22+label%3A%22Library%3A%20React+InstantSearch%22

package/dist/cjs/hooks/useConnector.js

@@ -100,7 +100,7 @@ function useConnector(connector) {
 
         // 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,

package/dist/cjs/index.js

@@ -361,6 +361,54 @@ Object.keys(_useInstantSearch).forEach(function (key) {
     }
   });
 });
+var _wrapPromiseWithState = require("./lib/wrapPromiseWithState");
+Object.keys(_wrapPromiseWithState).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _wrapPromiseWithState[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _wrapPromiseWithState[key];
+    }
+  });
+});
+var _useInstantSearchContext = require("./lib/useInstantSearchContext");
+Object.keys(_useInstantSearchContext).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _useInstantSearchContext[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _useInstantSearchContext[key];
+    }
+  });
+});
+var _useRSCContext = require("./lib/useRSCContext");
+Object.keys(_useRSCContext).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _useRSCContext[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _useRSCContext[key];
+    }
+  });
+});
+var _InstantSearchRSCContext = require("./lib/InstantSearchRSCContext");
+Object.keys(_InstantSearchRSCContext).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _InstantSearchRSCContext[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _InstantSearchRSCContext[key];
+    }
+  });
+});
 var _server = require("./server");
 Object.keys(_server).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/dist/cjs/lib/InstantSearchRSCContext.js

@@ -0,0 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.InstantSearchRSCContext = void 0;
+var _react = require("react");
+var InstantSearchRSCContext = /*#__PURE__*/(0, _react.createContext)(null);
+exports.InstantSearchRSCContext = InstantSearchRSCContext;

package/dist/cjs/lib/use.js

@@ -0,0 +1,15 @@
+"use strict";
+
+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); }
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.use = void 0;
+var React = _interopRequireWildcard(require("react"));
+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; }
+var useKey = 'use';
+
+// @TODO: Remove this file and import directly from React when available.
+var use = React[useKey];
+exports.use = use;

package/dist/cjs/lib/useInstantSearchApi.js

@@ -7,10 +7,11 @@ exports.useInstantSearchApi = useInstantSearchApi;
 var _InstantSearch = _interopRequireDefault(require("instantsearch.js/cjs/lib/InstantSearch"));
 var _react = require("react");
 var _shim = require("use-sync-external-store/shim");
-var _useInstantSearchServerContext = require("../lib/useInstantSearchServerContext");
-var _useInstantSearchSSRContext = require("../lib/useInstantSearchSSRContext");
 var _version = _interopRequireDefault(require("../version"));
 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 }; }
 var defaultUserAgents = ["react (".concat(_react.version, ")"), "react-instantsearch (".concat(_version.default, ")"), "react-instantsearch-core (".concat(_version.default, ")")];
@@ -22,8 +23,10 @@ function useInstantSearchApi(props) {
   var forceUpdate = (0, _useForceUpdate.useForceUpdate)();
   var serverContext = (0, _useInstantSearchServerContext.useInstantSearchServerContext)();
   var serverState = (0, _useInstantSearchSSRContext.useInstantSearchSSRContext)();
+  var waitingForResultsRef = (0, _useRSCContext.useRSCContext)();
   var initialResults = serverState === null || serverState === void 0 ? void 0 : serverState.initialResults;
   var prevPropsRef = (0, _react.useRef)(props);
+  var shouldRenderAtOnce = serverContext || initialResults || waitingForResultsRef;
   var searchRef = (0, _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
@@ -34,7 +37,7 @@ function useInstantSearchApi(props) {
   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.default(props);
     search._schedule = function _schedule(cb) {
       search._schedule.queue.push(cb);
@@ -47,7 +50,7 @@ function useInstantSearchApi(props) {
       }, 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
@@ -61,7 +64,7 @@ function useInstantSearchApi(props) {
     // 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) {
@@ -72,6 +75,7 @@ function useInstantSearchApi(props) {
       });
     }
     warnNextRouter(props.routing);
+    warnNextAppDir(Boolean(waitingForResultsRef));
     searchRef.current = search;
   }
   {
@@ -179,6 +183,13 @@ function warnNextRouter(routing) {
     process.env.NODE_ENV === 'development' ? (0, _warn.warn)(isUsingNextRouter, "\nYou are using Next.js with InstantSearch without the \"react-instantsearch-router-nextjs\" package.\nThis package is recommended to make the routing work correctly with Next.js.\nPlease check its usage instructions: https://github.com/algolia/instantsearch/tree/master/packages/react-instantsearch-router-nextjs\n\nYou can ignore this warning if you are using a custom router that suits your needs, it won't be outputted in production builds.") : void 0;
   }
 }
+function warnNextAppDir(isRscContextDefined) {
+  var _next;
+  if (!(process.env.NODE_ENV === 'development') || typeof window === 'undefined' || isRscContextDefined) {
+    return;
+  }
+  process.env.NODE_ENV === 'development' ? (0, _warn.warn)(Boolean((_next = window.next) === null || _next === void 0 ? void 0 : _next.appDir) === false, "\nWe've detected you are using Next.js with the App Router.\nWe released an **experimental** package called \"react-instantsearch-nextjs\" that makes SSR work with the App Router.\nPlease check its usage instructions: https://www.algolia.com/doc/guides/building-search-ui/going-further/server-side-rendering/react/#with-nextjs\n\nThis warning will not be outputted in production builds.") : void 0;
+}
 
 /**
  * Gets the version of Next.js if it is available in the `window` object,
@@ -186,6 +197,6 @@ function warnNextRouter(routing) {
  * 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);
 }

package/dist/cjs/lib/useRSCContext.js

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useRSCContext = useRSCContext;
+var _react = require("react");
+var _InstantSearchRSCContext = require("./InstantSearchRSCContext");
+function useRSCContext() {
+  return (0, _react.useContext)(_InstantSearchRSCContext.InstantSearchRSCContext);
+}

package/dist/cjs/lib/useSearchResults.js

@@ -29,7 +29,7 @@ function useSearchResults() {
 
       // 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,

package/dist/cjs/lib/useWidget.js

@@ -6,13 +6,17 @@ Object.defineProperty(exports, "__esModule", {
 exports.useWidget = useWidget;
 var _react = require("react");
 var _dequal = require("./dequal");
+var _use = require("./use");
 var _useInstantSearchContext = require("./useInstantSearchContext");
 var _useIsomorphicLayoutEffect = require("./useIsomorphicLayoutEffect");
+var _useRSCContext = require("./useRSCContext");
 function useWidget(_ref) {
+  var _waitingForResultsRef;
   var widget = _ref.widget,
     parentIndex = _ref.parentIndex,
     props = _ref.props,
     shouldSsr = _ref.shouldSsr;
+  var waitingForResultsRef = (0, _useRSCContext.useRSCContext)();
   var prevPropsRef = (0, _react.useRef)(props);
   (0, _react.useEffect)(function () {
     prevPropsRef.current = props;
@@ -72,7 +76,18 @@ function useWidget(_ref) {
       });
     };
   }, [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;
+    (0, _use.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) {
+      (0, _use.use)(waitingForResultsRef.current);
+    }
+  }
 }

package/dist/cjs/lib/wrapPromiseWithState.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.wrapPromiseWithState = wrapPromiseWithState;
+// 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;
+}

package/dist/cjs/version.js

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

package/dist/es/hooks/useConnector.js

@@ -94,7 +94,7 @@ export function useConnector(connector) {
 
         // 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,

package/dist/es/index.d.ts

@@ -28,4 +28,8 @@ export * from './connectors/useStats';
 export * from './connectors/useToggleRefinement';
 export * from './hooks/useConnector';
 export * from './hooks/useInstantSearch';
+export * from './lib/wrapPromiseWithState';
+export * from './lib/useInstantSearchContext';
+export * from './lib/useRSCContext';
+export * from './lib/InstantSearchRSCContext';
 export * from './server';

package/dist/es/index.js

@@ -28,4 +28,8 @@ export * from "./connectors/useStats.js";
 export * from "./connectors/useToggleRefinement.js";
 export * from "./hooks/useConnector.js";
 export * from "./hooks/useInstantSearch.js";
+export * from "./lib/wrapPromiseWithState.js";
+export * from "./lib/useInstantSearchContext.js";
+export * from "./lib/useRSCContext.js";
+export * from "./lib/InstantSearchRSCContext.js";
 export * from "./server/index.js";

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

@@ -0,0 +1,4 @@
+import type { PromiseWithState } from './wrapPromiseWithState';
+import type { MutableRefObject } from 'react';
+export type InstantSearchRSCContextApi = MutableRefObject<PromiseWithState<void> | null> | null;
+export declare const InstantSearchRSCContext: import("react").Context<InstantSearchRSCContextApi>;

package/dist/es/lib/InstantSearchRSCContext.js

@@ -0,0 +1,2 @@
+import { createContext } from 'react';
+export var InstantSearchRSCContext = /*#__PURE__*/createContext(null);

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

@@ -0,0 +1,3 @@
+type Use = <T>(promise: Promise<T>) => T;
+export declare const use: Use;
+export {};

package/dist/es/lib/use.js

@@ -0,0 +1,5 @@
+import * as React from 'react';
+var useKey = 'use';
+
+// @TODO: Remove this file and import directly from React when available.
+export var use = React[useKey];

package/dist/es/lib/useInstantSearchApi.js

@@ -1,10 +1,11 @@
 import InstantSearch 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 { useInstantSearchServerContext } from "./useInstantSearchServerContext.js";
-import { useInstantSearchSSRContext } from "./useInstantSearchSSRContext.js";
 import version from "../version.js";
 import { useForceUpdate } from "./useForceUpdate.js";
+import { useInstantSearchServerContext } from "./useInstantSearchServerContext.js";
+import { useInstantSearchSSRContext } from "./useInstantSearchSSRContext.js";
+import { useRSCContext } from "./useRSCContext.js";
 import { warn } from "./warn.js";
 var defaultUserAgents = ["react (".concat(ReactVersion, ")"), "react-instantsearch (".concat(version, ")"), "react-instantsearch-core (".concat(version, ")")];
 var serverUserAgent = "react-instantsearch-server (".concat(version, ")");
@@ -15,8 +16,10 @@ export function useInstantSearchApi(props) {
   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 = useRef(props);
+  var shouldRenderAtOnce = serverContext || initialResults || waitingForResultsRef;
   var searchRef = 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
@@ -27,7 +30,7 @@ export function useInstantSearchApi(props) {
   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);
@@ -40,7 +43,7 @@ export function useInstantSearchApi(props) {
       }, 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
@@ -54,7 +57,7 @@ export function useInstantSearchApi(props) {
     // 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) {
@@ -65,6 +68,7 @@ export function useInstantSearchApi(props) {
       });
     }
     warnNextRouter(props.routing);
+    warnNextAppDir(Boolean(waitingForResultsRef));
     searchRef.current = search;
   }
   {
@@ -172,6 +176,13 @@ function warnNextRouter(routing) {
     process.env.NODE_ENV === 'development' ? warn(isUsingNextRouter, "\nYou are using Next.js with InstantSearch without the \"react-instantsearch-router-nextjs\" package.\nThis package is recommended to make the routing work correctly with Next.js.\nPlease check its usage instructions: https://github.com/algolia/instantsearch/tree/master/packages/react-instantsearch-router-nextjs\n\nYou can ignore this warning if you are using a custom router that suits your needs, it won't be outputted in production builds.") : void 0;
   }
 }
+function warnNextAppDir(isRscContextDefined) {
+  var _next;
+  if (!(process.env.NODE_ENV === 'development') || typeof window === 'undefined' || isRscContextDefined) {
+    return;
+  }
+  process.env.NODE_ENV === 'development' ? warn(Boolean((_next = window.next) === null || _next === void 0 ? void 0 : _next.appDir) === false, "\nWe've detected you are using Next.js with the App Router.\nWe released an **experimental** package called \"react-instantsearch-nextjs\" that makes SSR work with the App Router.\nPlease check its usage instructions: https://www.algolia.com/doc/guides/building-search-ui/going-further/server-side-rendering/react/#with-nextjs\n\nThis warning will not be outputted in production builds.") : void 0;
+}
 
 /**
  * Gets the version of Next.js if it is available in the `window` object,
@@ -179,6 +190,6 @@ function warnNextRouter(routing) {
  * 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);
 }

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

@@ -0,0 +1 @@
+export declare function useRSCContext(): import("./InstantSearchRSCContext").InstantSearchRSCContextApi;

package/dist/es/lib/useRSCContext.js

@@ -0,0 +1,5 @@
+import { useContext } from 'react';
+import { InstantSearchRSCContext } from "./InstantSearchRSCContext.js";
+export function useRSCContext() {
+  return useContext(InstantSearchRSCContext);
+}

package/dist/es/lib/useSearchResults.js

@@ -23,7 +23,7 @@ export function useSearchResults() {
 
       // 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,

package/dist/es/lib/useWidget.js

@@ -1,12 +1,16 @@
 import { useEffect, useRef } from 'react';
 import { dequal } from "./dequal.js";
+import { use } from "./use.js";
 import { useInstantSearchContext } from "./useInstantSearchContext.js";
 import { useIsomorphicLayoutEffect } from "./useIsomorphicLayoutEffect.js";
+import { useRSCContext } from "./useRSCContext.js";
 export function useWidget(_ref) {
+  var _waitingForResultsRef;
   var widget = _ref.widget,
     parentIndex = _ref.parentIndex,
     props = _ref.props,
     shouldSsr = _ref.shouldSsr;
+  var waitingForResultsRef = useRSCContext();
   var prevPropsRef = useRef(props);
   useEffect(function () {
     prevPropsRef.current = props;
@@ -66,7 +70,18 @@ export function useWidget(_ref) {
       });
     };
   }, [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);
+    }
+  }
 }

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

@@ -0,0 +1,14 @@
+interface PendingPromise<TValue> extends Promise<TValue> {
+    status: 'pending';
+}
+interface FulfilledPromise<TValue> extends Promise<TValue> {
+    status: 'fulfilled';
+    value: TValue;
+}
+interface RejectedPromise<TValue> extends Promise<TValue> {
+    status: 'rejected';
+    reason: unknown;
+}
+export type PromiseWithState<TValue> = PendingPromise<TValue> | FulfilledPromise<TValue> | RejectedPromise<TValue>;
+export declare function wrapPromiseWithState<TValue>(promise: Promise<TValue>): PromiseWithState<TValue>;
+export {};

package/dist/es/lib/wrapPromiseWithState.js

@@ -0,0 +1,26 @@
+// This is needed in order to work with RSC Suspense, perhaps they will later provide a wrapper.
+
+function isStatefulPromise(promise) {
+  return 'status' in promise;
+}
+export 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;
+}

package/dist/es/version.d.ts

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

package/dist/es/version.js

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