react-instantsearch-core 7.31.0 → 7.32.0

package/dist/cjs/components/Feeds.js

@@ -0,0 +1,116 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "Feeds", {
+    enumerable: true,
+    get: function() {
+        return Feeds;
+    }
+});
+var _interop_require_wildcard = require("@swc/helpers/_/_interop_require_wildcard");
+var _object_without_properties = require("@swc/helpers/_/_object_without_properties");
+var _sliced_to_array = require("@swc/helpers/_/_sliced_to_array");
+var _to_consumable_array = require("@swc/helpers/_/_to_consumable_array");
+var _FeedContainer = require("instantsearch.js/cjs/connectors/feeds/FeedContainer");
+var _react = /*#__PURE__*/ _interop_require_wildcard._(require("react"));
+var _useFeeds = require("../connectors/useFeeds");
+var _IndexContext = require("../lib/IndexContext");
+var _useIndexContext = require("../lib/useIndexContext");
+var _useInstantSearchContext = require("../lib/useInstantSearchContext");
+function Feeds(_0) {
+    var renderFeed = _0.renderFeed, props = _object_without_properties._(_0, [
+        "renderFeed"
+    ]);
+    var feedIDs = (0, _useFeeds.useFeeds)(props, {
+        $$widgetType: 'ais.feeds'
+    }).feedIDs;
+    var parentIndex = (0, _useIndexContext.useIndexContext)();
+    var instantSearchInstance = (0, _useInstantSearchContext.useInstantSearchContext)();
+    var feedContainersRef = (0, _react.useRef)(new Map());
+    var removalTimerRef = (0, _react.useRef)(null);
+    var pendingRemovalsRef = (0, _react.useRef)(new Map());
+    // Create and register new FeedContainers synchronously so SSR and the first
+    // client render can provide the matching feed index context to children.
+    var toAdd = [];
+    feedIDs.forEach(function(feedID) {
+        if (!feedContainersRef.current.has(feedID)) {
+            var pendingContainer = pendingRemovalsRef.current.get(feedID);
+            if (pendingContainer) {
+                pendingRemovalsRef.current.delete(feedID);
+                feedContainersRef.current.set(feedID, pendingContainer);
+                return;
+            }
+            var container = (0, _FeedContainer.createFeedContainer)(feedID, parentIndex, instantSearchInstance);
+            feedContainersRef.current.set(feedID, container);
+            toAdd.push(container);
+        }
+    });
+    if (toAdd.length > 0) {
+        parentIndex.addWidgets(toAdd);
+    }
+    // Remove containers that are no longer in feedIDs (deferred to match useWidget pattern).
+    (0, _react.useEffect)(function() {
+        var containers = feedContainersRef.current;
+        var activeSet = new Set(feedIDs);
+        var toRemove = [];
+        containers.forEach(function(container, id) {
+            if (!activeSet.has(id)) {
+                toRemove.push([
+                    id,
+                    container
+                ]);
+                containers.delete(id);
+            }
+        });
+        if (toRemove.length > 0) {
+            toRemove.forEach(function(param) {
+                var _param = _sliced_to_array._(param, 2), id = _param[0], container = _param[1];
+                pendingRemovalsRef.current.set(id, container);
+            });
+            if (removalTimerRef.current !== null) {
+                clearTimeout(removalTimerRef.current);
+            }
+            removalTimerRef.current = setTimeout(function() {
+                var widgetsToRemove = Array.from(pendingRemovalsRef.current.values());
+                pendingRemovalsRef.current.clear();
+                removalTimerRef.current = null;
+                if (widgetsToRemove.length > 0) {
+                    parentIndex.removeWidgets(widgetsToRemove);
+                }
+            }, 0);
+        }
+    }, [
+        feedIDs,
+        parentIndex
+    ]);
+    (0, _react.useEffect)(function() {
+        return function() {
+            if (removalTimerRef.current !== null) {
+                clearTimeout(removalTimerRef.current);
+                removalTimerRef.current = null;
+            }
+            var containers = feedContainersRef.current;
+            var toRemove = Array.from(new Set(_to_consumable_array._(containers.values()).concat(_to_consumable_array._(pendingRemovalsRef.current.values()))));
+            pendingRemovalsRef.current.clear();
+            containers.clear();
+            if (toRemove.length > 0) {
+                parentIndex.removeWidgets(toRemove);
+            }
+        };
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, []);
+    return /*#__PURE__*/ _react.default.createElement(_react.default.Fragment, null, feedIDs.map(function(feedID) {
+        var container = feedContainersRef.current.get(feedID);
+        if (!container) {
+            return null;
+        }
+        return /*#__PURE__*/ _react.default.createElement(_IndexContext.IndexContext.Provider, {
+            key: feedID,
+            value: container
+        }, renderFeed({
+            feedID: feedID
+        }));
+    }));
+}

package/dist/cjs/connectors/useFeeds.js

@@ -0,0 +1,17 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "useFeeds", {
+    enumerable: true,
+    get: function() {
+        return useFeeds;
+    }
+});
+var _interop_require_default = require("@swc/helpers/_/_interop_require_default");
+var _connectFeeds = /*#__PURE__*/ _interop_require_default._(require("instantsearch.js/cjs/connectors/feeds/connectFeeds"));
+var _useConnector = require("../hooks/useConnector");
+function useFeeds(props, additionalWidgetProperties) {
+    return (0, _useConnector.useConnector)(_connectFeeds.default, props, additionalWidgetProperties);
+}

package/dist/cjs/index.js

@@ -14,6 +14,7 @@ var _interop_require_default = require("@swc/helpers/_/_interop_require_default"
 var _version = /*#__PURE__*/ _interop_require_default._(require("./version"));
 _export_star._(require("./components/Configure"), exports);
 _export_star._(require("./components/DynamicWidgets"), exports);
+_export_star._(require("./components/Feeds"), exports);
 _export_star._(require("./components/Index"), exports);
 _export_star._(require("./components/InstantSearch"), exports);
 _export_star._(require("./components/InstantSearchServerContext"), exports);
@@ -25,6 +26,7 @@ _export_star._(require("./connectors/useClearRefinements"), exports);
 _export_star._(require("./connectors/useConfigure"), exports);
 _export_star._(require("./connectors/useCurrentRefinements"), exports);
 _export_star._(require("./connectors/useDynamicWidgets"), exports);
+_export_star._(require("./connectors/useFeeds"), exports);
 _export_star._(require("./connectors/useFrequentlyBoughtTogether"), exports);
 _export_star._(require("./connectors/useGeoSearch"), exports);
 _export_star._(require("./connectors/useHierarchicalMenu"), exports);

package/dist/cjs/lib/useWidget.js

@@ -9,6 +9,7 @@ Object.defineProperty(exports, "useWidget", {
         return useWidget;
     }
 });
+var _utils = require("instantsearch.js/cjs/lib/utils");
 var _react = require("react");
 var _dequal = require("./dequal");
 var _use = require("./use");
@@ -99,9 +100,10 @@ function useWidget(param) {
     if ((waitForResultsRef === null || waitForResultsRef === void 0 ? void 0 : waitForResultsRef.current) && !skipSuspense) {
         var _search_helper;
         (0, _use.use)(waitForResultsRef.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 ? void 0 : _search_helper.lastResults)) {
+        // If we made a second request because of two-pass widgets, we need to
+        // wait for the second result — except for the two-pass widgets themselves
+        // which need to render their children after the first result.
+        if (!(0, _utils.isTwoPassWidget)(widget) && ((_search_helper = search.helper) === null || _search_helper === void 0 ? void 0 : _search_helper.lastResults)) {
             (0, _use.use)(waitForResultsRef.current);
         }
     }

package/dist/cjs/server/getServerState.js

@@ -40,12 +40,9 @@ function getServerState(children, param) {
         notifyServer: createNotifyServer()
     }).then(function(serverState) {
         var shouldRefetch = false;
-        // <DynamicWidgets> requires another query to retrieve the dynamic widgets
-        // to render.
+        // Two-pass widgets require another query to discover and mount child widgets.
         (0, _utils.walkIndex)(searchRef.current.mainIndex, function(index) {
-            shouldRefetch = shouldRefetch || index.getWidgets().some(function(widget) {
-                return widget.$$type === 'ais.dynamicWidgets';
-            });
+            shouldRefetch = shouldRefetch || index.getWidgets().some(_utils.isTwoPassWidget);
         });
         if (shouldRefetch) {
             (0, _utils.resetWidgetId)();

package/dist/cjs/version.js

@@ -9,4 +9,4 @@ Object.defineProperty(exports, "default", {
         return _default;
     }
 });
-var _default = '7.31.0';
+var _default = '7.32.0';

package/dist/es/components/Feeds.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import type { FeedsConnectorParams } from 'instantsearch.js/es/connectors/feeds/connectFeeds';
+import type { ReactNode } from 'react';
+export type FeedsProps = FeedsConnectorParams & {
+    renderFeed: ({ feedID }: {
+        feedID: string;
+    }) => ReactNode;
+};
+export declare function Feeds({ renderFeed, ...props }: FeedsProps): React.JSX.Element;

package/dist/es/components/Feeds.js

@@ -0,0 +1,107 @@
+import { _ } from '@swc/helpers/esm/_object_without_properties.js';
+import { _ as _$1 } from '@swc/helpers/esm/_sliced_to_array.js';
+import { _ as _$2 } from '@swc/helpers/esm/_to_consumable_array.js';
+import { createFeedContainer } from 'instantsearch.js/es/connectors/feeds/FeedContainer.js';
+import React__default, { useRef, useEffect } from 'react';
+import { useFeeds } from '../connectors/useFeeds.js';
+import { IndexContext } from '../lib/IndexContext.js';
+import { useIndexContext } from '../lib/useIndexContext.js';
+import { useInstantSearchContext } from '../lib/useInstantSearchContext.js';
+
+function Feeds(_0) {
+    var renderFeed = _0.renderFeed, props = _(_0, [
+        "renderFeed"
+    ]);
+    var feedIDs = useFeeds(props, {
+        $$widgetType: 'ais.feeds'
+    }).feedIDs;
+    var parentIndex = useIndexContext();
+    var instantSearchInstance = useInstantSearchContext();
+    var feedContainersRef = useRef(new Map());
+    var removalTimerRef = useRef(null);
+    var pendingRemovalsRef = useRef(new Map());
+    // Create and register new FeedContainers synchronously so SSR and the first
+    // client render can provide the matching feed index context to children.
+    var toAdd = [];
+    feedIDs.forEach(function(feedID) {
+        if (!feedContainersRef.current.has(feedID)) {
+            var pendingContainer = pendingRemovalsRef.current.get(feedID);
+            if (pendingContainer) {
+                pendingRemovalsRef.current.delete(feedID);
+                feedContainersRef.current.set(feedID, pendingContainer);
+                return;
+            }
+            var container = createFeedContainer(feedID, parentIndex, instantSearchInstance);
+            feedContainersRef.current.set(feedID, container);
+            toAdd.push(container);
+        }
+    });
+    if (toAdd.length > 0) {
+        parentIndex.addWidgets(toAdd);
+    }
+    // Remove containers that are no longer in feedIDs (deferred to match useWidget pattern).
+    useEffect(function() {
+        var containers = feedContainersRef.current;
+        var activeSet = new Set(feedIDs);
+        var toRemove = [];
+        containers.forEach(function(container, id) {
+            if (!activeSet.has(id)) {
+                toRemove.push([
+                    id,
+                    container
+                ]);
+                containers.delete(id);
+            }
+        });
+        if (toRemove.length > 0) {
+            toRemove.forEach(function(param) {
+                var _param = _$1(param, 2), id = _param[0], container = _param[1];
+                pendingRemovalsRef.current.set(id, container);
+            });
+            if (removalTimerRef.current !== null) {
+                clearTimeout(removalTimerRef.current);
+            }
+            removalTimerRef.current = setTimeout(function() {
+                var widgetsToRemove = Array.from(pendingRemovalsRef.current.values());
+                pendingRemovalsRef.current.clear();
+                removalTimerRef.current = null;
+                if (widgetsToRemove.length > 0) {
+                    parentIndex.removeWidgets(widgetsToRemove);
+                }
+            }, 0);
+        }
+    }, [
+        feedIDs,
+        parentIndex
+    ]);
+    useEffect(function() {
+        return function() {
+            if (removalTimerRef.current !== null) {
+                clearTimeout(removalTimerRef.current);
+                removalTimerRef.current = null;
+            }
+            var containers = feedContainersRef.current;
+            var toRemove = Array.from(new Set(_$2(containers.values()).concat(_$2(pendingRemovalsRef.current.values()))));
+            pendingRemovalsRef.current.clear();
+            containers.clear();
+            if (toRemove.length > 0) {
+                parentIndex.removeWidgets(toRemove);
+            }
+        };
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, []);
+    return /*#__PURE__*/ React__default.createElement(React__default.Fragment, null, feedIDs.map(function(feedID) {
+        var container = feedContainersRef.current.get(feedID);
+        if (!container) {
+            return null;
+        }
+        return /*#__PURE__*/ React__default.createElement(IndexContext.Provider, {
+            key: feedID,
+            value: container
+        }, renderFeed({
+            feedID: feedID
+        }));
+    }));
+}
+
+export { Feeds };

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

@@ -0,0 +1,4 @@
+import type { AdditionalWidgetProperties } from '../hooks/useConnector';
+import type { FeedsConnectorParams } from 'instantsearch.js/es/connectors/feeds/connectFeeds';
+export type UseFeedsProps = FeedsConnectorParams;
+export declare function useFeeds(props: UseFeedsProps, additionalWidgetProperties?: AdditionalWidgetProperties): import("instantsearch.js/es/connectors/feeds/connectFeeds").FeedsRenderState;

package/dist/es/connectors/useFeeds.js

@@ -0,0 +1,8 @@
+import connectFeeds from 'instantsearch.js/es/connectors/feeds/connectFeeds.js';
+import { useConnector } from '../hooks/useConnector.js';
+
+function useFeeds(props, additionalWidgetProperties) {
+    return useConnector(connectFeeds, props, additionalWidgetProperties);
+}
+
+export { useFeeds };

package/dist/es/index.d.ts

@@ -1,6 +1,7 @@
 export { default as version } from './version';
 export * from './components/Configure';
 export * from './components/DynamicWidgets';
+export * from './components/Feeds';
 export * from './components/Index';
 export * from './components/InstantSearch';
 export * from './components/InstantSearchServerContext';
@@ -12,6 +13,7 @@ export * from './connectors/useClearRefinements';
 export * from './connectors/useConfigure';
 export * from './connectors/useCurrentRefinements';
 export * from './connectors/useDynamicWidgets';
+export * from './connectors/useFeeds';
 export * from './connectors/useFrequentlyBoughtTogether';
 export * from './connectors/useGeoSearch';
 export * from './connectors/useHierarchicalMenu';

package/dist/es/index.js

@@ -1,6 +1,7 @@
 export { default as version } from './version.js';
 export { Configure } from './components/Configure.js';
 export { DynamicWidgets } from './components/DynamicWidgets.js';
+export { Feeds } from './components/Feeds.js';
 export { Index } from './components/Index.js';
 export { InstantSearch } from './components/InstantSearch.js';
 export { InstantSearchServerContext } from './components/InstantSearchServerContext.js';
@@ -12,6 +13,7 @@ export { useClearRefinements } from './connectors/useClearRefinements.js';
 export { useConfigure } from './connectors/useConfigure.js';
 export { useCurrentRefinements } from './connectors/useCurrentRefinements.js';
 export { useDynamicWidgets } from './connectors/useDynamicWidgets.js';
+export { useFeeds } from './connectors/useFeeds.js';
 export { useFrequentlyBoughtTogether } from './connectors/useFrequentlyBoughtTogether.js';
 export { useGeoSearch } from './connectors/useGeoSearch.js';
 export { useHierarchicalMenu } from './connectors/useHierarchicalMenu.js';

package/dist/es/lib/useWidget.js

@@ -1,3 +1,4 @@
+import { isTwoPassWidget } from 'instantsearch.js/es/lib/utils/index.js';
 import { useRef, useEffect } from 'react';
 import { dequal } from './dequal.js';
 import { use } from './use.js';
@@ -88,9 +89,10 @@ function useWidget(param) {
     if ((waitForResultsRef === null || waitForResultsRef === void 0 ? void 0 : waitForResultsRef.current) && !skipSuspense) {
         var _search_helper;
         use(waitForResultsRef.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 ? void 0 : _search_helper.lastResults)) {
+        // If we made a second request because of two-pass widgets, we need to
+        // wait for the second result — except for the two-pass widgets themselves
+        // which need to render their children after the first result.
+        if (!isTwoPassWidget(widget) && ((_search_helper = search.helper) === null || _search_helper === void 0 ? void 0 : _search_helper.lastResults)) {
             use(waitForResultsRef.current);
         }
     }

package/dist/es/server/getServerState.js

@@ -1,5 +1,5 @@
 import { waitForResults, getInitialResults } from 'instantsearch.js/es/lib/server.js';
-import { resetWidgetId, walkIndex } from 'instantsearch.js/es/lib/utils/index.js';
+import { resetWidgetId, walkIndex, isTwoPassWidget } from 'instantsearch.js/es/lib/utils/index.js';
 import React__default from 'react';
 import { InstantSearchServerContext } from '../components/InstantSearchServerContext.js';
 import { InstantSearchSSRProvider } from '../components/InstantSearchSSRProvider.js';
@@ -31,12 +31,9 @@ import { InstantSearchSSRProvider } from '../components/InstantSearchSSRProvider
         notifyServer: createNotifyServer()
     }).then(function(serverState) {
         var shouldRefetch = false;
-        // <DynamicWidgets> requires another query to retrieve the dynamic widgets
-        // to render.
+        // Two-pass widgets require another query to discover and mount child widgets.
         walkIndex(searchRef.current.mainIndex, function(index) {
-            shouldRefetch = shouldRefetch || index.getWidgets().some(function(widget) {
-                return widget.$$type === 'ais.dynamicWidgets';
-            });
+            shouldRefetch = shouldRefetch || index.getWidgets().some(isTwoPassWidget);
         });
         if (shouldRefetch) {
             resetWidgetId();

package/dist/es/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "7.31.0";
+declare const _default: "7.32.0";
 export default _default;

package/dist/es/version.js

@@ -1,3 +1,3 @@
-var version = '7.31.0';
+var version = '7.32.0';
 
 export { version as default };