react-instantsearch 7.39.1 → 7.40.0

package/dist/cjs/widgets/Autocomplete.js

@@ -215,14 +215,15 @@ function EXPERIMENTAL_Autocomplete(props) {
     var indices = 'indices' in props ? props.indices : undefined;
     var feeds = 'feeds' in props ? props.feeds : undefined;
     var isFeedsMode = feeds !== undefined;
-    var showQuerySuggestions = props.showQuerySuggestions, showPromptSuggestions = props.showPromptSuggestions, showRecent = props.showRecent, userSearchParameters = props.searchParameters, detachedMediaQuery = props.detachedMediaQuery, tmp = props.translations, userTranslations = tmp === void 0 ? {} : tmp, transformItems = props.transformItems, restProps = _object_without_properties._(props, [
+    var showQuerySuggestions = props.showQuerySuggestions, showPromptSuggestions = props.showPromptSuggestions, showRecent = props.showRecent, userSearchParameters = props.searchParameters, detachedMediaQuery = props.detachedMediaQuery, tmp = props.translations, userTranslations = tmp === void 0 ? {} : tmp, transformItems = props.transformItems, _props_requiresSearch = props.requiresSearch, requiresSearch = _props_requiresSearch === void 0 ? true : _props_requiresSearch, restProps = _object_without_properties._(props, [
         "showQuerySuggestions",
         "showPromptSuggestions",
         "showRecent",
         "searchParameters",
         "detachedMediaQuery",
         "translations",
-        "transformItems"
+        "transformItems",
+        "requiresSearch"
     ]);
     var autoFocus = restProps.autoFocus, placeholder = restProps.placeholder, classNames = restProps.classNames;
     // Eager-mount only when `autoFocus` is set — otherwise wait for first focus
@@ -231,9 +232,11 @@ function EXPERIMENTAL_Autocomplete(props) {
     var translations = _object_spread._({}, DEFAULT_TRANSLATIONS, userTranslations);
     var _useInstantSearch = (0, _reactinstantsearchcore.useInstantSearch)(), indexUiState = _useInstantSearch.indexUiState, indexRenderState = _useInstantSearch.indexRenderState, status = _useInstantSearch.status;
     var compositionID = (0, _reactinstantsearchcore.useInstantSearchContext)().compositionID;
+    var dependsOn = requiresSearch ? 'search' : 'none';
     var refine = (0, _reactinstantsearchcore.useSearchBox)({}, _object_spread._({
         $$type: 'ais.autocomplete',
-        $$widgetType: 'ais.autocomplete'
+        $$widgetType: 'ais.autocomplete',
+        dependsOn: dependsOn
     }, props.aiMode ? {
         opensChat: true
     } : {})).refine;

package/dist/es/widgets/Autocomplete.d.ts

@@ -92,6 +92,13 @@ type AutocompleteCommonProps<TItem extends BaseHit> = ComponentProps<'div'> & {
     getSearchPageURL?: (nextUiState: IndexUiState) => string;
     onSelect?: AutocompleteIndexConfig<TItem>['onSelect'];
     transformItems?: (indices: TransformItemsIndicesConfig[]) => TransformItemsIndicesConfig[];
+    /**
+     * Whether this widget should make InstantSearch require a main search request.
+     * If this is the only widget, and you mark `requiresSearch: false`, no search request will happen.
+     *
+     * @default true
+     */
+    requiresSearch?: boolean;
     panelComponent?: (props: {
         elements: PanelElements;
         indices: ReturnType<typeof useAutocomplete>['indices'];

package/dist/es/widgets/Autocomplete.js

@@ -204,14 +204,15 @@ function EXPERIMENTAL_Autocomplete(props) {
     var indices = 'indices' in props ? props.indices : undefined;
     var feeds = 'feeds' in props ? props.feeds : undefined;
     var isFeedsMode = feeds !== undefined;
-    var showQuerySuggestions = props.showQuerySuggestions, showPromptSuggestions = props.showPromptSuggestions, showRecent = props.showRecent, userSearchParameters = props.searchParameters, detachedMediaQuery = props.detachedMediaQuery, tmp = props.translations, userTranslations = tmp === void 0 ? {} : tmp, transformItems = props.transformItems, restProps = _(props, [
+    var showQuerySuggestions = props.showQuerySuggestions, showPromptSuggestions = props.showPromptSuggestions, showRecent = props.showRecent, userSearchParameters = props.searchParameters, detachedMediaQuery = props.detachedMediaQuery, tmp = props.translations, userTranslations = tmp === void 0 ? {} : tmp, transformItems = props.transformItems, _props_requiresSearch = props.requiresSearch, requiresSearch = _props_requiresSearch === void 0 ? true : _props_requiresSearch, restProps = _(props, [
         "showQuerySuggestions",
         "showPromptSuggestions",
         "showRecent",
         "searchParameters",
         "detachedMediaQuery",
         "translations",
-        "transformItems"
+        "transformItems",
+        "requiresSearch"
     ]);
     var autoFocus = restProps.autoFocus, placeholder = restProps.placeholder, classNames = restProps.classNames;
     // Eager-mount only when `autoFocus` is set — otherwise wait for first focus
@@ -220,9 +221,11 @@ function EXPERIMENTAL_Autocomplete(props) {
     var translations = _$2({}, DEFAULT_TRANSLATIONS, userTranslations);
     var _useInstantSearch = useInstantSearch(), indexUiState = _useInstantSearch.indexUiState, indexRenderState = _useInstantSearch.indexRenderState, status = _useInstantSearch.status;
     var compositionID = useInstantSearchContext().compositionID;
+    var dependsOn = requiresSearch ? 'search' : 'none';
     var refine = useSearchBox({}, _$2({
         $$type: 'ais.autocomplete',
-        $$widgetType: 'ais.autocomplete'
+        $$widgetType: 'ais.autocomplete',
+        dependsOn: dependsOn
     }, props.aiMode ? {
         opensChat: true
     } : {})).refine;

package/dist/umd/ReactInstantSearch.js

@@ -1,4 +1,4 @@
-/*! React InstantSearch 7.39.1 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! React InstantSearch 7.40.0 | © Algolia, Inc. and contributors; MIT License | 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) :
@@ -24,7 +24,7 @@
 
     var React__namespace = /*#__PURE__*/_interopNamespaceDefault(React);
 
-    var version$2 = '7.39.1';
+    var version$2 = '7.40.0';
 
     function _define_property(obj, key, value) {
         if (key in obj) {
@@ -7520,6 +7520,9 @@
             current: 0
         },
         waitForResultsRef: null,
+        resolveWaitForResultsRef: {
+            current: null
+        },
         ignoreMultipleHooksWarning: false
     });
 
@@ -7731,7 +7734,10 @@
         useWidget({
             widget: widget,
             parentIndex: parentIndex,
-            props: stableProps,
+            props: [
+                stableProps,
+                stableAdditionalWidgetProperties
+            ],
             shouldSsr: Boolean(serverContext),
             skipSuspense: skipSuspense
         });
@@ -8467,6 +8473,39 @@
             ].concat(_to_consumable_array(resolveScopedResultsFromWidgets(current.getWidgets()))));
         }, []);
     }
+    function getWidgetsRequestDependencies(widgets) {
+        return widgets.reduce(function(dependencies, widget) {
+            if (isIndexWidget(widget)) {
+                if (widget._isolated) {
+                    return dependencies;
+                }
+                var childDependencies = getWidgetsRequestDependencies(widget.getWidgets());
+                return {
+                    hasSearchWidget: dependencies.hasSearchWidget || childDependencies.hasSearchWidget,
+                    hasRecommendWidget: dependencies.hasRecommendWidget || childDependencies.hasRecommendWidget
+                };
+            }
+            if (widget.dependsOn === 'recommend') {
+                return _object_spread_props(_object_spread({}, dependencies), {
+                    hasRecommendWidget: true
+                });
+            }
+            if (widget.dependsOn === 'none') {
+                return dependencies;
+            }
+            return _object_spread_props(_object_spread({}, dependencies), {
+                hasSearchWidget: true
+            });
+        }, {
+            hasSearchWidget: false,
+            hasRecommendWidget: false
+        });
+    }
+    function recomputeInstantSearchRequestDependencies(instantSearchInstance) {
+        var _getWidgetsRequestDependencies = getWidgetsRequestDependencies(instantSearchInstance.mainIndex.getWidgets()), hasSearchWidget = _getWidgetsRequestDependencies.hasSearchWidget, hasRecommendWidget = _getWidgetsRequestDependencies.hasRecommendWidget;
+        instantSearchInstance._hasSearchWidget = hasSearchWidget;
+        instantSearchInstance._hasRecommendWidget = hasRecommendWidget;
+    }
     var index = function index(widgetParams) {
         if (widgetParams === undefined || widgetParams.indexName === undefined && !widgetParams.EXPERIMENTAL_isolated) {
             throw new Error(withUsage$s('The `indexName` option is required.'));
@@ -8481,8 +8520,11 @@
         var helper = null;
         var derivedHelper = null;
         var lastValidSearchParameters = null;
-        var hasRecommendWidget = false;
-        var hasSearchWidget = false;
+        var recomputeLocalRequestDependencies = function recomputeLocalRequestDependencies() {
+            if (localInstantSearchInstance) {
+                recomputeInstantSearchRequestDependencies(localInstantSearchInstance);
+            }
+        };
         return {
             $$type: 'ais.index',
             $$widgetType: 'ais.index',
@@ -8573,21 +8615,12 @@
                 }
                 flatWidgets.forEach(function(widget) {
                     widget.parent = _this;
-                    if (isIndexWidget(widget)) {
-                        return;
-                    }
-                    if (localInstantSearchInstance && widget.dependsOn === 'recommend') {
-                        localInstantSearchInstance._hasRecommendWidget = true;
-                    } else if (localInstantSearchInstance) {
-                        localInstantSearchInstance._hasSearchWidget = true;
-                    } else if (widget.dependsOn === 'recommend') {
-                        hasRecommendWidget = true;
-                    } else {
-                        hasSearchWidget = true;
+                    if (!isIndexWidget(widget)) {
+                        addWidgetId(widget);
                     }
-                    addWidgetId(widget);
                 });
                 localWidgets = localWidgets.concat(flatWidgets);
+                recomputeLocalRequestDependencies();
                 if (localInstantSearchInstance && Boolean(flatWidgets.length)) {
                     privateHelperSetState(helper, {
                         state: getLocalWidgetsSearchParameters(localWidgets, {
@@ -8644,21 +8677,10 @@
                 localWidgets = localWidgets.filter(function(widget) {
                     return flatWidgets.indexOf(widget) === -1;
                 });
-                localWidgets.forEach(function(widget) {
+                flatWidgets.forEach(function(widget) {
                     widget.parent = undefined;
-                    if (isIndexWidget(widget)) {
-                        return;
-                    }
-                    if (localInstantSearchInstance && widget.dependsOn === 'recommend') {
-                        localInstantSearchInstance._hasRecommendWidget = true;
-                    } else if (localInstantSearchInstance) {
-                        localInstantSearchInstance._hasSearchWidget = true;
-                    } else if (widget.dependsOn === 'recommend') {
-                        hasRecommendWidget = true;
-                    } else {
-                        hasSearchWidget = true;
-                    }
                 });
+                recomputeLocalRequestDependencies();
                 if (localInstantSearchInstance && Boolean(flatWidgets.length)) {
                     var _flatWidgets_reduce = flatWidgets.reduce(function(states, widget) {
                         // the `dispose` method exists at this point we already assert it
@@ -8881,12 +8903,7 @@
                     // schedule a render that will render the results injected on the helper.
                     instantSearchInstance.scheduleRender();
                 }
-                if (hasRecommendWidget) {
-                    instantSearchInstance._hasRecommendWidget = true;
-                }
-                if (hasSearchWidget) {
-                    instantSearchInstance._hasSearchWidget = true;
-                }
+                recomputeLocalRequestDependencies();
             },
             render: function render(param) {
                 var _this = this;
@@ -9160,7 +9177,7 @@
         });
     }
 
-    var version = '4.106.0';
+    var version = '4.107.0';
 
     var ANONYMOUS_TOKEN_COOKIE_KEY = '_ALGOLIA';
     function getCookie(name) {
@@ -11301,8 +11318,11 @@
                         mainHelper.searchForFacetValues = mainHelper.searchForCompositionFacetValues.bind(mainHelper);
                     }
                     mainHelper.search = function() {
-                        _this.status = 'loading';
-                        _this.scheduleRender(false);
+                        var hasSearchOrRecommendWidget = _this._hasSearchWidget || _this._hasRecommendWidget;
+                        if (hasSearchOrRecommendWidget) {
+                            _this.status = 'loading';
+                        }
+                        _this.scheduleRender(!hasSearchOrRecommendWidget);
                         // This solution allows us to keep the exact same API for the users but
                         // under the hood, we have a different implementation. It should be
                         // completely transparent for the rest of the codebase. Only this module
@@ -11366,7 +11386,7 @@
                         error.error = error;
                         _this.error = error;
                         _this.status = 'error';
-                        _this.scheduleRender(false);
+                        _this.scheduleRender(!_this._hasSearchWidget && !_this._hasRecommendWidget);
                         // This needs to execute last because it throws the error.
                         _this.emit('error', error);
                     });
@@ -12055,10 +12075,14 @@
         return function(widgetParams) {
             var _ref = widgetParams || {}, _ref_escapeHTML = _ref.escapeHTML, escapeHTML = _ref_escapeHTML === void 0 ? true : _ref_escapeHTML, _ref_transformItems = _ref.transformItems, transformItems = _ref_transformItems === void 0 ? function(indices) {
                 return indices;
-            } : _ref_transformItems, tmp = _ref.future, _ref1 = tmp === void 0 ? {} : tmp, _ref_undefinedEmptyQuery = _ref1.undefinedEmptyQuery, undefinedEmptyQuery = _ref_undefinedEmptyQuery === void 0 ? false : _ref_undefinedEmptyQuery;
+            } : _ref_transformItems, _ref_requiresSearch = _ref.requiresSearch, requiresSearch = _ref_requiresSearch === void 0 ? true : _ref_requiresSearch, tmp = _ref.future, _ref1 = tmp === void 0 ? {} : tmp, _ref_undefinedEmptyQuery = _ref1.undefinedEmptyQuery, undefinedEmptyQuery = _ref_undefinedEmptyQuery === void 0 ? false : _ref_undefinedEmptyQuery;
             var connectorState = {};
             return {
                 $$type: 'ais.autocomplete',
+                dependsOn: requiresSearch ? 'search' : 'none',
+                shouldRender: requiresSearch ? undefined : function() {
+                    return true;
+                },
                 init: function init(initOptions) {
                     var instantSearchInstance = initOptions.instantSearchInstance;
                     renderFn(_object_spread_props(_object_spread({}, this.getWidgetRenderState(initOptions)), {
@@ -14097,14 +14121,16 @@
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
         checkRendering(renderFn, withUsage$o());
         return function(widgetParams) {
-            var _ref = widgetParams || {}, _ref_resume = _ref.resume, resume = _ref_resume === void 0 ? false : _ref_resume, _ref_tools = _ref.tools, tools = _ref_tools === void 0 ? {} : _ref_tools, _ref_type = _ref.type, type = _ref_type === void 0 ? 'chat' : _ref_type, context = _ref.context, initialUserMessage = _ref.initialUserMessage, initialMessages = _ref.initialMessages, _ref_disableTriggerValidation = _ref.disableTriggerValidation, disableTriggerValidation = _ref_disableTriggerValidation === void 0 ? false : _ref_disableTriggerValidation, options = _object_without_properties(_ref, [
+            var _ref = widgetParams || {}, _ref_resume = _ref.resume, resume = _ref_resume === void 0 ? false : _ref_resume, _ref_tools = _ref.tools, tools = _ref_tools === void 0 ? {} : _ref_tools, _ref_type = _ref.type, type = _ref_type === void 0 ? 'chat' : _ref_type, context = _ref.context, initialUserMessage = _ref.initialUserMessage, initialMessages = _ref.initialMessages, _ref_disableTriggerValidation = _ref.disableTriggerValidation, disableTriggerValidation = _ref_disableTriggerValidation === void 0 ? false : _ref_disableTriggerValidation, _ref_sendAutomaticallyWhen = _ref.sendAutomaticallyWhen, sendAutomaticallyWhen = _ref_sendAutomaticallyWhen === void 0 ? lastAssistantMessageIsCompleteWithToolCalls : _ref_sendAutomaticallyWhen, _ref_requiresSearch = _ref.requiresSearch, requiresSearch = _ref_requiresSearch === void 0 ? true : _ref_requiresSearch, options = _object_without_properties(_ref, [
                 "resume",
                 "tools",
                 "type",
                 "context",
                 "initialUserMessage",
                 "initialMessages",
-                "disableTriggerValidation"
+                "disableTriggerValidation",
+                "sendAutomaticallyWhen",
+                "requiresSearch"
             ]);
             var _chatInstance;
             var input = '';
@@ -14265,8 +14291,8 @@
                     return options.chat;
                 }
                 return new Chat$1(_object_spread_props(_object_spread({}, options), {
+                    sendAutomaticallyWhen: sendAutomaticallyWhen,
                     transport: transport,
-                    sendAutomaticallyWhen: lastAssistantMessageIsCompleteWithToolCalls,
                     shouldRepairToolInput: function shouldRepairToolInput(toolName) {
                         var tool = tools[toolName];
                         if (!tool && toolName.startsWith("".concat(SearchIndexToolType$2, "_"))) {
@@ -14308,6 +14334,7 @@
             };
             return {
                 $$type: 'ais.chat',
+                dependsOn: requiresSearch ? 'search' : 'none',
                 init: function init(initOptions) {
                     var _this = this;
                     var instantSearchInstance = initOptions.instantSearchInstance;
@@ -14520,6 +14547,7 @@
             return {
                 $$type: 'ais.chatTrigger',
                 opensChat: true,
+                dependsOn: 'none',
                 init: function init(initOptions) {
                     lastOptions = initOptions;
                     renderFn(_object_spread_props(_object_spread({}, this.getWidgetRenderState(initOptions)), {
@@ -14548,6 +14576,9 @@
                     return _object_spread_props(_object_spread({}, renderState), {
                         chatTrigger: this.getWidgetRenderState(renderOptions)
                     });
+                },
+                shouldRender: function shouldRender() {
+                    return true;
                 }
             };
         };
@@ -18488,6 +18519,8 @@
         // later during hydration.
         var requestParamsList;
         var client = helper.getClient();
+        var waitsForSearch = search._hasSearchWidget;
+        var waitsForRecommend = !skipRecommend && search._hasRecommendWidget;
         if (search.compositionID) {
             helper.setClient(_object_spread_props(_object_spread({}, client), {
                 search: function search(query) {
@@ -18508,17 +18541,22 @@
                 }
             }));
         }
-        if (search._hasSearchWidget) {
+        if (waitsForSearch) {
             if (search.compositionID) {
                 helper.searchWithComposition();
             } else {
                 helper.searchOnlyWithDerivedHelpers();
             }
         }
-        !skipRecommend && search._hasRecommendWidget && helper.recommend();
+        if (waitsForRecommend) {
+            helper.recommend();
+        }
+        if (!waitsForSearch && !waitsForRecommend) {
+            return Promise.resolve([]);
+        }
         return new Promise(function(resolve, reject) {
-            var searchResultsReceived = !search._hasSearchWidget;
-            var recommendResultsReceived = !search._hasRecommendWidget || skipRecommend;
+            var searchResultsReceived = !waitsForSearch;
+            var recommendResultsReceived = !waitsForRecommend;
             // All derived helpers resolve in the same tick so we're safe only relying
             // on the first one.
             helper.derivedHelpers[0].on('result', function() {
@@ -18558,6 +18596,13 @@
         var requestParamsIndex = 0;
         walkIndex(rootIndex, function(widget) {
             var _widget_getHelper;
+            var currentIndex = widget;
+            while(currentIndex){
+                if (currentIndex._isolated) {
+                    return;
+                }
+                currentIndex = currentIndex.getParent();
+            }
             var searchResults = widget.getResults();
             var recommendResults = (_widget_getHelper = widget.getHelper()) === null || _widget_getHelper === void 0 ? void 0 : _widget_getHelper.lastRecommendResults;
             if (searchResults || recommendResults) {
@@ -18588,7 +18633,7 @@
                 });
             }
         });
-        if (Object.keys(initialResults).length === 0) {
+        if (Object.keys(initialResults).length === 0 && (requestParamsList === null || requestParamsList === void 0 ? void 0 : requestParamsList.length) !== 0) {
             throw new Error('The root index does not have any results. Make sure you have at least one widget that provides results.');
         }
         return initialResults;
@@ -18623,6 +18668,13 @@
             var shouldRefetch = false;
             // Two-pass widgets require another query to discover and mount child widgets.
             walkIndex(searchRef.current.mainIndex, function(index) {
+                var current = index;
+                while(current){
+                    if (current._isolated) {
+                        return;
+                    }
+                    current = current.getParent();
+                }
                 shouldRefetch = shouldRefetch || index.getWidgets().some(isTwoPassWidget);
             });
             if (shouldRefetch) {
@@ -22719,14 +22771,15 @@
         var indices = 'indices' in props ? props.indices : undefined;
         var feeds = 'feeds' in props ? props.feeds : undefined;
         var isFeedsMode = feeds !== undefined;
-        var showQuerySuggestions = props.showQuerySuggestions, showPromptSuggestions = props.showPromptSuggestions, showRecent = props.showRecent, userSearchParameters = props.searchParameters, detachedMediaQuery = props.detachedMediaQuery, tmp = props.translations, userTranslations = tmp === void 0 ? {} : tmp, transformItems = props.transformItems, restProps = _object_without_properties(props, [
+        var showQuerySuggestions = props.showQuerySuggestions, showPromptSuggestions = props.showPromptSuggestions, showRecent = props.showRecent, userSearchParameters = props.searchParameters, detachedMediaQuery = props.detachedMediaQuery, tmp = props.translations, userTranslations = tmp === void 0 ? {} : tmp, transformItems = props.transformItems, _props_requiresSearch = props.requiresSearch, requiresSearch = _props_requiresSearch === void 0 ? true : _props_requiresSearch, restProps = _object_without_properties(props, [
             "showQuerySuggestions",
             "showPromptSuggestions",
             "showRecent",
             "searchParameters",
             "detachedMediaQuery",
             "translations",
-            "transformItems"
+            "transformItems",
+            "requiresSearch"
         ]);
         var autoFocus = restProps.autoFocus, placeholder = restProps.placeholder, classNames = restProps.classNames;
         // Eager-mount only when `autoFocus` is set — otherwise wait for first focus
@@ -22735,9 +22788,11 @@
         var translations = _object_spread({}, DEFAULT_TRANSLATIONS, userTranslations);
         var _useInstantSearch = useInstantSearch(), indexUiState = _useInstantSearch.indexUiState, indexRenderState = _useInstantSearch.indexRenderState, status = _useInstantSearch.status;
         var compositionID = useInstantSearchContext().compositionID;
+        var dependsOn = requiresSearch ? 'search' : 'none';
         var refine = useSearchBox({}, _object_spread({
             $$type: 'ais.autocomplete',
-            $$widgetType: 'ais.autocomplete'
+            $$widgetType: 'ais.autocomplete',
+            dependsOn: dependsOn
         }, props.aiMode ? {
             opensChat: true
         } : {})).refine;