react-instantsearch-core 7.9.0 → 7.11.0

package/dist/cjs/components/InstantSearchSSRProvider.js

@@ -27,6 +27,9 @@ function InstantSearchSSRProvider(_ref) {
   // `InstantSearch` on mount.
   var ssrSearchRef = _react.default.useRef(null);
 
+  // This is used to re-map the result index to the requesting widget
+  var recommendIdx = _react.default.useRef(0);
+
   // When <DynamicWidgets> is mounted, a second provider is used above the user-land
   // <InstantSearchSSRProvider> in `getServerState()`.
   // To avoid the user's provider overriding the context value with an empty object,
@@ -36,7 +39,8 @@ function InstantSearchSSRProvider(_ref) {
   }
   return /*#__PURE__*/_react.default.createElement(_InstantSearchSSRContext.InstantSearchSSRContext.Provider, {
     value: _objectSpread(_objectSpread({}, props), {}, {
-      ssrSearchRef: ssrSearchRef
+      ssrSearchRef: ssrSearchRef,
+      recommendIdx: recommendIdx
     })
   }, children);
 }

package/dist/cjs/hooks/useConnector.js

@@ -11,6 +11,7 @@ var _getIndexSearchResults = require("../lib/getIndexSearchResults");
 var _useIndexContext = require("../lib/useIndexContext");
 var _useInstantSearchContext = require("../lib/useInstantSearchContext");
 var _useInstantSearchServerContext = require("../lib/useInstantSearchServerContext");
+var _useInstantSearchSSRContext = require("../lib/useInstantSearchSSRContext");
 var _useStableValue = require("../lib/useStableValue");
 var _useWidget = require("../lib/useWidget");
 var _excluded = ["instantSearchInstance", "widgetParams"],
@@ -32,6 +33,7 @@ function useConnector(connector) {
   var props = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   var additionalWidgetProperties = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   var serverContext = (0, _useInstantSearchServerContext.useInstantSearchServerContext)();
+  var ssrContext = (0, _useInstantSearchSSRContext.useInstantSearchSSRContext)();
   var search = (0, _useInstantSearchContext.useInstantSearchContext)();
   var parentIndex = (0, _useIndexContext.useIndexContext)();
   var stableProps = (0, _useStableValue.useStableValue)(props);
@@ -96,7 +98,8 @@ function useConnector(connector) {
         })) || helper.state;
         var _getIndexSearchResult = (0, _getIndexSearchResults.getIndexSearchResults)(parentIndex),
           results = _getIndexSearchResult.results,
-          scopedResults = _getIndexSearchResult.scopedResults;
+          scopedResults = _getIndexSearchResult.scopedResults,
+          recommendResults = _getIndexSearchResult.recommendResults;
 
         // We get the widget render state by providing the same parameters as
         // InstantSearch provides to the widget's `render` method.
@@ -105,10 +108,7 @@ function useConnector(connector) {
             helper: helper,
             parent: parentIndex,
             instantSearchInstance: search,
-            results: widget.dependsOn === 'recommend' ?
-            // @TODO: this is to avoid using wrong hits in SSR,
-            // will be replace with SSR support for recommend
-            null : results,
+            results: widget.dependsOn === 'recommend' && recommendResults && ssrContext ? recommendResults[ssrContext.recommendIdx.current++] : results,
             scopedResults: scopedResults,
             state: helper.state,
             renderState: search.renderState,

package/dist/cjs/lib/getIndexSearchResults.js

@@ -27,6 +27,7 @@ function getIndexSearchResults(indexWidget) {
   });
   return {
     results: results,
-    scopedResults: scopedResults
+    scopedResults: scopedResults,
+    recommendResults: helper.lastRecommendResults
   };
 }

package/dist/cjs/lib/useSearchResults.js

@@ -19,7 +19,12 @@ function useSearchResults() {
   var search = (0, _useInstantSearchContext.useInstantSearchContext)();
   var searchIndex = (0, _useIndexContext.useIndexContext)();
   var _useState = (0, _react.useState)(function () {
-      return (0, _getIndexSearchResults.getIndexSearchResults)(searchIndex);
+      var indexSearchResults = (0, _getIndexSearchResults.getIndexSearchResults)(searchIndex);
+      // We do this not to leak `recommendResults` in the API.
+      return {
+        results: indexSearchResults.results,
+        scopedResults: indexSearchResults.scopedResults
+      };
     }),
     _useState2 = _slicedToArray(_useState, 2),
     searchResults = _useState2[0],

package/dist/cjs/server/getServerState.js

@@ -17,6 +17,7 @@ function getServerState(children, _ref) {
   var searchRef = {
     current: undefined
   };
+  (0, _utils.resetWidgetId)();
   var createNotifyServer = function createNotifyServer() {
     var hasBeenNotified = false;
     var notifyServer = function notifyServer(_ref2) {
@@ -45,11 +46,13 @@ function getServerState(children, _ref) {
       });
     });
     if (shouldRefetch) {
+      (0, _utils.resetWidgetId)();
       return execute({
         children: /*#__PURE__*/_react.default.createElement(_.InstantSearchSSRProvider, serverState, children),
         renderToString: renderToString,
         searchRef: searchRef,
-        notifyServer: createNotifyServer()
+        notifyServer: createNotifyServer(),
+        skipRecommend: true
       });
     }
     return serverState;
@@ -59,7 +62,8 @@ function execute(_ref3) {
   var children = _ref3.children,
     renderToString = _ref3.renderToString,
     notifyServer = _ref3.notifyServer,
-    searchRef = _ref3.searchRef;
+    searchRef = _ref3.searchRef,
+    skipRecommend = _ref3.skipRecommend;
   return Promise.resolve().then(function () {
     renderToString( /*#__PURE__*/_react.default.createElement(_.InstantSearchServerContext.Provider, {
       value: {
@@ -84,7 +88,7 @@ function execute(_ref3) {
     if (!searchRef.current) {
       throw new Error("Unable to retrieve InstantSearch's server state in `getServerState()`. Did you mount the <InstantSearch> component?");
     }
-    return (0, _server.waitForResults)(searchRef.current);
+    return (0, _server.waitForResults)(searchRef.current, skipRecommend);
   }).then(function (requestParamsList) {
     return {
       initialResults: (0, _server.getInitialResults)(searchRef.current.mainIndex, requestParamsList)

package/dist/cjs/version.js

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

package/dist/es/components/InstantSearchSSRProvider.js

@@ -20,6 +20,9 @@ export function InstantSearchSSRProvider(_ref) {
   // `InstantSearch` on mount.
   var ssrSearchRef = React.useRef(null);
 
+  // This is used to re-map the result index to the requesting widget
+  var recommendIdx = React.useRef(0);
+
   // When <DynamicWidgets> is mounted, a second provider is used above the user-land
   // <InstantSearchSSRProvider> in `getServerState()`.
   // To avoid the user's provider overriding the context value with an empty object,
@@ -29,7 +32,8 @@ export function InstantSearchSSRProvider(_ref) {
   }
   return /*#__PURE__*/React.createElement(InstantSearchSSRContext.Provider, {
     value: _objectSpread(_objectSpread({}, props), {}, {
-      ssrSearchRef: ssrSearchRef
+      ssrSearchRef: ssrSearchRef,
+      recommendIdx: recommendIdx
     })
   }, children);
 }

package/dist/es/connectors/useGeoSearch.d.ts

@@ -1,6 +1,5 @@
 import type { AdditionalWidgetProperties } from '../hooks/useConnector';
-import type { BaseHit } from 'instantsearch.js';
+import type { GeoHit } from 'instantsearch.js';
 import type { GeoSearchConnectorParams } from 'instantsearch.js/es/connectors/geo-search/connectGeoSearch';
-export type { GeoHit } from 'instantsearch.js/es/connectors/geo-search/connectGeoSearch';
-export type UseGeoSearchProps<THit extends BaseHit = BaseHit> = GeoSearchConnectorParams<THit>;
-export declare function useGeoSearch<THit extends BaseHit>(props?: UseGeoSearchProps<THit>, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/geo-search/connectGeoSearch").GeoSearchRenderState<THit>;
+export type UseGeoSearchProps<THit extends GeoHit = GeoHit> = GeoSearchConnectorParams<THit>;
+export declare function useGeoSearch<THit extends GeoHit>(props?: UseGeoSearchProps<THit>, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/geo-search/connectGeoSearch").GeoSearchRenderState<THit>;

package/dist/es/hooks/useConnector.js

@@ -20,12 +20,14 @@ import { getIndexSearchResults } from "../lib/getIndexSearchResults.js";
 import { useIndexContext } from "../lib/useIndexContext.js";
 import { useInstantSearchContext } from "../lib/useInstantSearchContext.js";
 import { useInstantSearchServerContext } from "../lib/useInstantSearchServerContext.js";
+import { useInstantSearchSSRContext } from "../lib/useInstantSearchSSRContext.js";
 import { useStableValue } from "../lib/useStableValue.js";
 import { useWidget } from "../lib/useWidget.js";
 export function useConnector(connector) {
   var props = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   var additionalWidgetProperties = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   var serverContext = useInstantSearchServerContext();
+  var ssrContext = useInstantSearchSSRContext();
   var search = useInstantSearchContext();
   var parentIndex = useIndexContext();
   var stableProps = useStableValue(props);
@@ -90,7 +92,8 @@ export function useConnector(connector) {
         })) || helper.state;
         var _getIndexSearchResult = getIndexSearchResults(parentIndex),
           results = _getIndexSearchResult.results,
-          scopedResults = _getIndexSearchResult.scopedResults;
+          scopedResults = _getIndexSearchResult.scopedResults,
+          recommendResults = _getIndexSearchResult.recommendResults;
 
         // We get the widget render state by providing the same parameters as
         // InstantSearch provides to the widget's `render` method.
@@ -99,10 +102,7 @@ export function useConnector(connector) {
             helper: helper,
             parent: parentIndex,
             instantSearchInstance: search,
-            results: widget.dependsOn === 'recommend' ?
-            // @TODO: this is to avoid using wrong hits in SSR,
-            // will be replace with SSR support for recommend
-            null : results,
+            results: widget.dependsOn === 'recommend' && recommendResults && ssrContext ? recommendResults[ssrContext.recommendIdx.current++] : results,
             scopedResults: scopedResults,
             state: helper.state,
             renderState: search.renderState,

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

@@ -4,5 +4,6 @@ import type { UiState } from 'instantsearch.js';
 import type { MutableRefObject } from 'react';
 export type InstantSearchSSRContextApi<TUiState extends UiState, TRouteState = TUiState> = InstantSearchServerState & {
     ssrSearchRef: MutableRefObject<InternalInstantSearch<TUiState, TRouteState> | null>;
+    recommendIdx: MutableRefObject<number>;
 };
 export declare const InstantSearchSSRContext: import("react").Context<Partial<InstantSearchSSRContextApi<UiState, UiState>> | null>;

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

@@ -6,4 +6,5 @@ export declare function getIndexSearchResults(indexWidget: IndexWidget): {
         indexId: string;
         helper: import("algoliasearch-helper").AlgoliaSearchHelper;
     }[];
+    recommendResults: import("algoliasearch-helper").RecommendResults<any> | null;
 };

package/dist/es/lib/getIndexSearchResults.js

@@ -21,6 +21,7 @@ export function getIndexSearchResults(indexWidget) {
   });
   return {
     results: results,
-    scopedResults: scopedResults
+    scopedResults: scopedResults,
+    recommendResults: helper.lastRecommendResults
   };
 }

package/dist/es/lib/useSearchResults.js

@@ -13,7 +13,12 @@ export function useSearchResults() {
   var search = useInstantSearchContext();
   var searchIndex = useIndexContext();
   var _useState = useState(function () {
-      return getIndexSearchResults(searchIndex);
+      var indexSearchResults = getIndexSearchResults(searchIndex);
+      // We do this not to leak `recommendResults` in the API.
+      return {
+        results: indexSearchResults.results,
+        scopedResults: indexSearchResults.scopedResults
+      };
     }),
     _useState2 = _slicedToArray(_useState, 2),
     searchResults = _useState2[0],

package/dist/es/server/getServerState.js

@@ -1,5 +1,5 @@
 import { getInitialResults, waitForResults } from "instantsearch.js/es/lib/server.js";
-import { walkIndex } from "instantsearch.js/es/lib/utils/index.js";
+import { walkIndex, resetWidgetId } from "instantsearch.js/es/lib/utils/index.js";
 import React from 'react';
 import { InstantSearchServerContext, InstantSearchSSRProvider } from "../index.js";
 /**
@@ -10,6 +10,7 @@ export function getServerState(children, _ref) {
   var searchRef = {
     current: undefined
   };
+  resetWidgetId();
   var createNotifyServer = function createNotifyServer() {
     var hasBeenNotified = false;
     var notifyServer = function notifyServer(_ref2) {
@@ -38,11 +39,13 @@ export function getServerState(children, _ref) {
       });
     });
     if (shouldRefetch) {
+      resetWidgetId();
       return execute({
         children: /*#__PURE__*/React.createElement(InstantSearchSSRProvider, serverState, children),
         renderToString: renderToString,
         searchRef: searchRef,
-        notifyServer: createNotifyServer()
+        notifyServer: createNotifyServer(),
+        skipRecommend: true
       });
     }
     return serverState;
@@ -52,7 +55,8 @@ function execute(_ref3) {
   var children = _ref3.children,
     renderToString = _ref3.renderToString,
     notifyServer = _ref3.notifyServer,
-    searchRef = _ref3.searchRef;
+    searchRef = _ref3.searchRef,
+    skipRecommend = _ref3.skipRecommend;
   return Promise.resolve().then(function () {
     renderToString( /*#__PURE__*/React.createElement(InstantSearchServerContext.Provider, {
       value: {
@@ -77,7 +81,7 @@ function execute(_ref3) {
     if (!searchRef.current) {
       throw new Error("Unable to retrieve InstantSearch's server state in `getServerState()`. Did you mount the <InstantSearch> component?");
     }
-    return waitForResults(searchRef.current);
+    return waitForResults(searchRef.current, skipRecommend);
   }).then(function (requestParamsList) {
     return {
       initialResults: getInitialResults(searchRef.current.mainIndex, requestParamsList)

package/dist/es/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "7.9.0";
+declare const _default: "7.11.0";
 export default _default;

package/dist/es/version.js

@@ -1 +1 @@
-export default '7.9.0';
+export default '7.11.0';