instantsearch.js 4.69.0 → 4.71.0

package/es/connectors/trending-items/connectTrendingItems.d.ts

@@ -1,12 +1,12 @@
-import type { Connector, TransformItems, Hit, BaseHit } from '../../types';
+import type { Connector, TransformItems, Hit, BaseHit, Renderer, Unmounter } from '../../types';
 import type { PlainSearchParameters, RecommendResultItem } from 'algoliasearch-helper';
-export type TrendingItemsRenderState<THit extends BaseHit = BaseHit> = {
+export type TrendingItemsRenderState<THit extends NonNullable<object> = BaseHit> = {
     /**
      * The matched recommendations from the Algolia API.
      */
     items: Array<Hit<THit>>;
 };
-export type TrendingItemsConnectorParams<THit extends BaseHit = BaseHit> = ({
+export type TrendingItemsConnectorParams<THit extends NonNullable<object> = BaseHit> = ({
     /**
      * The facet attribute to get recommendations for.
      */
@@ -16,8 +16,8 @@ export type TrendingItemsConnectorParams<THit extends BaseHit = BaseHit> = ({
      */
     facetValue: string;
 } | {
-    facetName?: never;
-    facetValue?: never;
+    facetName?: string;
+    facetValue?: string;
 }) & {
     /**
      * The number of recommendations to retrieve.
@@ -48,10 +48,311 @@ export type TrendingItemsConnectorParams<THit extends BaseHit = BaseHit> = ({
         results: RecommendResultItem;
     }>;
 };
-export type TrendingItemsWidgetDescription<THit extends BaseHit = BaseHit> = {
+export type TrendingItemsWidgetDescription<THit extends NonNullable<object> = BaseHit> = {
     $$type: 'ais.trendingItems';
     renderState: TrendingItemsRenderState<THit>;
 };
-export type TrendingItemsConnector<THit extends BaseHit = BaseHit> = Connector<TrendingItemsWidgetDescription<THit>, TrendingItemsConnectorParams<THit>>;
-declare const connectTrendingItems: TrendingItemsConnector;
-export default connectTrendingItems;
+export type TrendingItemsConnector<THit extends NonNullable<object> = BaseHit> = Connector<TrendingItemsWidgetDescription<THit>, TrendingItemsConnectorParams<THit>>;
+declare const _default: <TWidgetParams extends object>(renderFn: Renderer<TrendingItemsRenderState<BaseHit>, TWidgetParams & TrendingItemsConnectorParams<BaseHit>>, unmountFn?: Unmounter) => <THit extends object = BaseHit>(widgetParams: TWidgetParams & TrendingItemsConnectorParams<THit>) => {
+    dependsOn: "recommend";
+    $$type: "ais.trendingItems";
+    init(initOptions: import("../../types").InitOptions): void;
+    render(renderOptions: import("../../types").RenderOptions): void;
+    getRenderState(renderState: {
+        answers?: import("../../types").WidgetRenderState<import("../answers/connectAnswers").AnswersRenderState, import("../answers/connectAnswers").AnswersConnectorParams> | undefined;
+        autocomplete?: import("../../types").WidgetRenderState<import("../autocomplete/connectAutocomplete").AutocompleteRenderState, import("../autocomplete/connectAutocomplete").AutocompleteConnectorParams> | undefined;
+        breadcrumb?: {
+            [rootAttribute: string]: import("../../types").WidgetRenderState<import("../breadcrumb/connectBreadcrumb").BreadcrumbRenderState, import("../breadcrumb/connectBreadcrumb").BreadcrumbConnectorParams>;
+        } | undefined;
+        clearRefinements?: import("../../types").WidgetRenderState<import("../clear-refinements/connectClearRefinements").ClearRefinementsRenderState, import("../clear-refinements/connectClearRefinements").ClearRefinementsConnectorParams> | undefined;
+        configure?: import("../../types").WidgetRenderState<import("../configure/connectConfigure").ConfigureRenderState, import("../configure/connectConfigure").ConfigureConnectorParams> | undefined;
+        currentRefinements?: import("../../types").WidgetRenderState<import("../current-refinements/connectCurrentRefinements").CurrentRefinementsRenderState, import("../current-refinements/connectCurrentRefinements").CurrentRefinementsConnectorParams> | undefined;
+        geoSearch?: import("../../types").WidgetRenderState<import("../geo-search/connectGeoSearch").GeoSearchRenderState<import("../../types").GeoHit>, import("../geo-search/connectGeoSearch").GeoSearchConnectorParams<import("../../types").GeoHit>> | undefined;
+        hierarchicalMenu?: {
+            [rootAttribute: string]: import("../../types").WidgetRenderState<import("../hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuRenderState, import("../hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuConnectorParams>;
+        } | undefined;
+        hits?: import("../../types").WidgetRenderState<import("../hits/connectHits").HitsRenderState<BaseHit>, import("../hits/connectHits").HitsConnectorParams<BaseHit>> | undefined;
+        hitsPerPage?: import("../../types").WidgetRenderState<import("../hits-per-page/connectHitsPerPage").HitsPerPageRenderState, import("../hits-per-page/connectHitsPerPage").HitsPerPageConnectorParams> | undefined;
+        infiniteHits?: import("../../types").WidgetRenderState<import("../infinite-hits/connectInfiniteHits").InfiniteHitsRenderState<BaseHit>, import("../infinite-hits/connectInfiniteHits").InfiniteHitsConnectorParams<BaseHit>> | undefined;
+        menu?: {
+            [attribute: string]: import("../../types").WidgetRenderState<import("../menu/connectMenu").MenuRenderState, import("../menu/connectMenu").MenuConnectorParams>;
+        } | undefined;
+        numericMenu?: {
+            [attribute: string]: import("../../types").WidgetRenderState<import("../numeric-menu/connectNumericMenu").NumericMenuRenderState, import("../numeric-menu/connectNumericMenu").NumericMenuConnectorParams>;
+        } | undefined;
+        pagination?: import("../../types").WidgetRenderState<import("../pagination/connectPagination").PaginationRenderState, import("../pagination/connectPagination").PaginationConnectorParams> | undefined;
+        poweredBy?: import("../../types").WidgetRenderState<import("../powered-by/connectPoweredBy").PoweredByRenderState, import("../powered-by/connectPoweredBy").PoweredByConnectorParams> | undefined;
+        queryRules?: import("../../types").WidgetRenderState<import("../query-rules/connectQueryRules").QueryRulesRenderState, import("../query-rules/connectQueryRules").QueryRulesConnectorParams> | undefined;
+        range?: {
+            [attribute: string]: import("../../types").WidgetRenderState<import("../range/connectRange").RangeRenderState, import("../range/connectRange").RangeConnectorParams>;
+        } | undefined;
+        ratingMenu?: {
+            [attribute: string]: import("../../types").WidgetRenderState<import("../rating-menu/connectRatingMenu").RatingMenuRenderState, import("../rating-menu/connectRatingMenu").RatingMenuConnectorParams>;
+        } | undefined;
+        refinementList?: {
+            [attribute: string]: import("../../types").WidgetRenderState<import("../refinement-list/connectRefinementList").RefinementListRenderState, import("../refinement-list/connectRefinementList").RefinementListConnectorParams>;
+        } | undefined;
+        relevantSort?: import("../../types").WidgetRenderState<import("../relevant-sort/connectRelevantSort").RelevantSortRenderState, import("../relevant-sort/connectRelevantSort").RelevantSortConnectorParams> | undefined;
+        searchBox?: import("../../types").WidgetRenderState<import("../search-box/connectSearchBox").SearchBoxRenderState, import("../search-box/connectSearchBox").SearchBoxConnectorParams> | undefined;
+        sortBy?: import("../../types").WidgetRenderState<import("../sort-by/connectSortBy").SortByRenderState, import("../sort-by/connectSortBy").SortByConnectorParams> | undefined;
+        stats?: import("../../types").WidgetRenderState<import("../stats/connectStats").StatsRenderState, import("../stats/connectStats").StatsConnectorParams> | undefined;
+        toggleRefinement?: {
+            [attribute: string]: import("../../types").WidgetRenderState<import("../toggle-refinement/connectToggleRefinement").ToggleRefinementRenderState, import("../toggle-refinement/connectToggleRefinement").ToggleRefinementConnectorParams>;
+        } | undefined;
+        voiceSearch?: import("../../types").WidgetRenderState<import("../voice-search/connectVoiceSearch").VoiceSearchRenderState, import("../voice-search/connectVoiceSearch").VoiceSearchConnectorParams> | undefined;
+        analytics?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../../widgets/analytics/analytics").AnalyticsWidgetParams> | undefined;
+        places?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../../widgets/places/places").PlacesWidgetParams> | undefined;
+    }): {
+        answers?: import("../../types").WidgetRenderState<import("../answers/connectAnswers").AnswersRenderState, import("../answers/connectAnswers").AnswersConnectorParams> | undefined;
+        autocomplete?: import("../../types").WidgetRenderState<import("../autocomplete/connectAutocomplete").AutocompleteRenderState, import("../autocomplete/connectAutocomplete").AutocompleteConnectorParams> | undefined;
+        breadcrumb?: {
+            [rootAttribute: string]: import("../../types").WidgetRenderState<import("../breadcrumb/connectBreadcrumb").BreadcrumbRenderState, import("../breadcrumb/connectBreadcrumb").BreadcrumbConnectorParams>;
+        } | undefined;
+        clearRefinements?: import("../../types").WidgetRenderState<import("../clear-refinements/connectClearRefinements").ClearRefinementsRenderState, import("../clear-refinements/connectClearRefinements").ClearRefinementsConnectorParams> | undefined;
+        configure?: import("../../types").WidgetRenderState<import("../configure/connectConfigure").ConfigureRenderState, import("../configure/connectConfigure").ConfigureConnectorParams> | undefined;
+        currentRefinements?: import("../../types").WidgetRenderState<import("../current-refinements/connectCurrentRefinements").CurrentRefinementsRenderState, import("../current-refinements/connectCurrentRefinements").CurrentRefinementsConnectorParams> | undefined;
+        geoSearch?: import("../../types").WidgetRenderState<import("../geo-search/connectGeoSearch").GeoSearchRenderState<import("../../types").GeoHit>, import("../geo-search/connectGeoSearch").GeoSearchConnectorParams<import("../../types").GeoHit>> | undefined;
+        hierarchicalMenu?: {
+            [rootAttribute: string]: import("../../types").WidgetRenderState<import("../hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuRenderState, import("../hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuConnectorParams>;
+        } | undefined;
+        hits?: import("../../types").WidgetRenderState<import("../hits/connectHits").HitsRenderState<BaseHit>, import("../hits/connectHits").HitsConnectorParams<BaseHit>> | undefined;
+        hitsPerPage?: import("../../types").WidgetRenderState<import("../hits-per-page/connectHitsPerPage").HitsPerPageRenderState, import("../hits-per-page/connectHitsPerPage").HitsPerPageConnectorParams> | undefined;
+        infiniteHits?: import("../../types").WidgetRenderState<import("../infinite-hits/connectInfiniteHits").InfiniteHitsRenderState<BaseHit>, import("../infinite-hits/connectInfiniteHits").InfiniteHitsConnectorParams<BaseHit>> | undefined;
+        menu?: {
+            [attribute: string]: import("../../types").WidgetRenderState<import("../menu/connectMenu").MenuRenderState, import("../menu/connectMenu").MenuConnectorParams>;
+        } | undefined;
+        numericMenu?: {
+            [attribute: string]: import("../../types").WidgetRenderState<import("../numeric-menu/connectNumericMenu").NumericMenuRenderState, import("../numeric-menu/connectNumericMenu").NumericMenuConnectorParams>;
+        } | undefined;
+        pagination?: import("../../types").WidgetRenderState<import("../pagination/connectPagination").PaginationRenderState, import("../pagination/connectPagination").PaginationConnectorParams> | undefined;
+        poweredBy?: import("../../types").WidgetRenderState<import("../powered-by/connectPoweredBy").PoweredByRenderState, import("../powered-by/connectPoweredBy").PoweredByConnectorParams> | undefined;
+        queryRules?: import("../../types").WidgetRenderState<import("../query-rules/connectQueryRules").QueryRulesRenderState, import("../query-rules/connectQueryRules").QueryRulesConnectorParams> | undefined;
+        range?: {
+            [attribute: string]: import("../../types").WidgetRenderState<import("../range/connectRange").RangeRenderState, import("../range/connectRange").RangeConnectorParams>;
+        } | undefined;
+        ratingMenu?: {
+            [attribute: string]: import("../../types").WidgetRenderState<import("../rating-menu/connectRatingMenu").RatingMenuRenderState, import("../rating-menu/connectRatingMenu").RatingMenuConnectorParams>;
+        } | undefined;
+        refinementList?: {
+            [attribute: string]: import("../../types").WidgetRenderState<import("../refinement-list/connectRefinementList").RefinementListRenderState, import("../refinement-list/connectRefinementList").RefinementListConnectorParams>;
+        } | undefined;
+        relevantSort?: import("../../types").WidgetRenderState<import("../relevant-sort/connectRelevantSort").RelevantSortRenderState, import("../relevant-sort/connectRelevantSort").RelevantSortConnectorParams> | undefined;
+        searchBox?: import("../../types").WidgetRenderState<import("../search-box/connectSearchBox").SearchBoxRenderState, import("../search-box/connectSearchBox").SearchBoxConnectorParams> | undefined;
+        sortBy?: import("../../types").WidgetRenderState<import("../sort-by/connectSortBy").SortByRenderState, import("../sort-by/connectSortBy").SortByConnectorParams> | undefined;
+        stats?: import("../../types").WidgetRenderState<import("../stats/connectStats").StatsRenderState, import("../stats/connectStats").StatsConnectorParams> | undefined;
+        toggleRefinement?: {
+            [attribute: string]: import("../../types").WidgetRenderState<import("../toggle-refinement/connectToggleRefinement").ToggleRefinementRenderState, import("../toggle-refinement/connectToggleRefinement").ToggleRefinementConnectorParams>;
+        } | undefined;
+        voiceSearch?: import("../../types").WidgetRenderState<import("../voice-search/connectVoiceSearch").VoiceSearchRenderState, import("../voice-search/connectVoiceSearch").VoiceSearchConnectorParams> | undefined;
+        analytics?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../../widgets/analytics/analytics").AnalyticsWidgetParams> | undefined;
+        places?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../../widgets/places/places").PlacesWidgetParams> | undefined;
+    };
+    getWidgetRenderState({ results }: import("../../types").InitOptions | import("../../types").RenderOptions | ({
+        /**
+         * The matched recommendations from the Algolia API.
+         */
+        instantSearchInstance: import("../../lib/InstantSearch").default<import("../../types").UiState, import("../../types").UiState>;
+        parent: import("../../types").IndexWidget;
+        templatesConfig: Record<string, unknown>;
+        scopedResults: import("../../types").ScopedResult[];
+        state: import("algoliasearch-helper").SearchParameters;
+        renderState: Partial<{
+            answers: import("../../types").WidgetRenderState<import("../answers/connectAnswers").AnswersRenderState, import("../answers/connectAnswers").AnswersConnectorParams>;
+        } & {
+            autocomplete: import("../../types").WidgetRenderState<import("../autocomplete/connectAutocomplete").AutocompleteRenderState, import("../autocomplete/connectAutocomplete").AutocompleteConnectorParams>;
+        } & {
+            breadcrumb: {
+                [rootAttribute: string]: import("../../types").WidgetRenderState<import("../breadcrumb/connectBreadcrumb").BreadcrumbRenderState, import("../breadcrumb/connectBreadcrumb").BreadcrumbConnectorParams>;
+            };
+        } & {
+            clearRefinements: import("../../types").WidgetRenderState<import("../clear-refinements/connectClearRefinements").ClearRefinementsRenderState, import("../clear-refinements/connectClearRefinements").ClearRefinementsConnectorParams>;
+        } & {
+            configure: import("../../types").WidgetRenderState<import("../configure/connectConfigure").ConfigureRenderState, import("../configure/connectConfigure").ConfigureConnectorParams>;
+        } & {
+            currentRefinements: import("../../types").WidgetRenderState<import("../current-refinements/connectCurrentRefinements").CurrentRefinementsRenderState, import("../current-refinements/connectCurrentRefinements").CurrentRefinementsConnectorParams>;
+        } & {
+            geoSearch: import("../../types").WidgetRenderState<import("../geo-search/connectGeoSearch").GeoSearchRenderState<import("../../types").GeoHit>, import("../geo-search/connectGeoSearch").GeoSearchConnectorParams<import("../../types").GeoHit>>;
+        } & {
+            hierarchicalMenu: {
+                [rootAttribute: string]: import("../../types").WidgetRenderState<import("../hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuRenderState, import("../hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuConnectorParams>;
+            };
+        } & {
+            hits: import("../../types").WidgetRenderState<import("../hits/connectHits").HitsRenderState<BaseHit>, import("../hits/connectHits").HitsConnectorParams<BaseHit>>;
+        } & {
+            hitsPerPage: import("../../types").WidgetRenderState<import("../hits-per-page/connectHitsPerPage").HitsPerPageRenderState, import("../hits-per-page/connectHitsPerPage").HitsPerPageConnectorParams>;
+        } & {
+            infiniteHits: import("../../types").WidgetRenderState<import("../infinite-hits/connectInfiniteHits").InfiniteHitsRenderState<BaseHit>, import("../infinite-hits/connectInfiniteHits").InfiniteHitsConnectorParams<BaseHit>>;
+        } & {
+            menu: {
+                [attribute: string]: import("../../types").WidgetRenderState<import("../menu/connectMenu").MenuRenderState, import("../menu/connectMenu").MenuConnectorParams>;
+            };
+        } & {
+            numericMenu: {
+                [attribute: string]: import("../../types").WidgetRenderState<import("../numeric-menu/connectNumericMenu").NumericMenuRenderState, import("../numeric-menu/connectNumericMenu").NumericMenuConnectorParams>;
+            };
+        } & {
+            pagination: import("../../types").WidgetRenderState<import("../pagination/connectPagination").PaginationRenderState, import("../pagination/connectPagination").PaginationConnectorParams>;
+        } & {
+            poweredBy: import("../../types").WidgetRenderState<import("../powered-by/connectPoweredBy").PoweredByRenderState, import("../powered-by/connectPoweredBy").PoweredByConnectorParams>;
+        } & {
+            queryRules: import("../../types").WidgetRenderState<import("../query-rules/connectQueryRules").QueryRulesRenderState, import("../query-rules/connectQueryRules").QueryRulesConnectorParams>;
+        } & {
+            range: {
+                [attribute: string]: import("../../types").WidgetRenderState<import("../range/connectRange").RangeRenderState, import("../range/connectRange").RangeConnectorParams>;
+            };
+        } & {
+            ratingMenu: {
+                [attribute: string]: import("../../types").WidgetRenderState<import("../rating-menu/connectRatingMenu").RatingMenuRenderState, import("../rating-menu/connectRatingMenu").RatingMenuConnectorParams>;
+            };
+        } & {
+            refinementList: {
+                [attribute: string]: import("../../types").WidgetRenderState<import("../refinement-list/connectRefinementList").RefinementListRenderState, import("../refinement-list/connectRefinementList").RefinementListConnectorParams>;
+            };
+        } & {
+            relevantSort: import("../../types").WidgetRenderState<import("../relevant-sort/connectRelevantSort").RelevantSortRenderState, import("../relevant-sort/connectRelevantSort").RelevantSortConnectorParams>;
+        } & {
+            searchBox: import("../../types").WidgetRenderState<import("../search-box/connectSearchBox").SearchBoxRenderState, import("../search-box/connectSearchBox").SearchBoxConnectorParams>;
+        } & {
+            sortBy: import("../../types").WidgetRenderState<import("../sort-by/connectSortBy").SortByRenderState, import("../sort-by/connectSortBy").SortByConnectorParams>;
+        } & {
+            stats: import("../../types").WidgetRenderState<import("../stats/connectStats").StatsRenderState, import("../stats/connectStats").StatsConnectorParams>;
+        } & {
+            toggleRefinement: {
+                [attribute: string]: import("../../types").WidgetRenderState<import("../toggle-refinement/connectToggleRefinement").ToggleRefinementRenderState, import("../toggle-refinement/connectToggleRefinement").ToggleRefinementConnectorParams>;
+            };
+        } & {
+            voiceSearch: import("../../types").WidgetRenderState<import("../voice-search/connectVoiceSearch").VoiceSearchRenderState, import("../voice-search/connectVoiceSearch").VoiceSearchConnectorParams>;
+        } & {
+            analytics: import("../../types").WidgetRenderState<Record<string, unknown>, import("../../widgets/analytics/analytics").AnalyticsWidgetParams>;
+        } & {
+            places: import("../../types").WidgetRenderState<Record<string, unknown>, import("../../widgets/places/places").PlacesWidgetParams>;
+        }>; /**
+         * The facet attribute to get recommendations for.
+         */
+        helper: import("algoliasearch-helper").AlgoliaSearchHelper;
+        searchMetadata: {
+            isSearchStalled: boolean;
+        };
+        status: import("../../types").InstantSearchStatus;
+        error: Error | undefined;
+        createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: Partial<{
+            query: string;
+        } & {
+            configure: PlainSearchParameters;
+        } & {
+            geoSearch: {
+                boundingBox: string;
+            };
+        } & {
+            hierarchicalMenu: {
+                [rootAttribute: string]: string[];
+            };
+        } & {
+            hitsPerPage: number;
+        } & {
+            page: number;
+        } & {
+            menu: {
+                [attribute: string]: string;
+            };
+        } & {
+            numericMenu: {
+                [attribute: string]: string;
+            };
+        } & {
+            page: number;
+        } & {
+            range: {
+                [attribute: string]: string;
+            };
+        } & {
+            ratingMenu: {
+                [attribute: string]: number | undefined;
+            };
+        } & {
+            refinementList: {
+                [attribute: string]: string[];
+            };
+        } & {
+            relevantSort: number;
+        } & {
+            query: string;
+        } & {
+            sortBy: string;
+        } & {
+            toggle: {
+                [attribute: string]: boolean;
+            };
+        } & {
+            query: string;
+        } & {
+            places: {
+                query: string;
+                position: string;
+            };
+        }>) => Partial<{
+            query: string;
+        } & {
+            configure: PlainSearchParameters;
+        } & {
+            geoSearch: {
+                boundingBox: string;
+            };
+        } & {
+            hierarchicalMenu: {
+                [rootAttribute: string]: string[];
+            };
+        } & {
+            hitsPerPage: number;
+        } & {
+            page: number;
+        } & {
+            menu: {
+                [attribute: string]: string;
+            };
+        } & {
+            numericMenu: {
+                [attribute: string]: string;
+            };
+        } & {
+            page: number;
+        } & {
+            range: {
+                [attribute: string]: string;
+            };
+        } & {
+            ratingMenu: {
+                [attribute: string]: number | undefined;
+            };
+        } & {
+            refinementList: {
+                [attribute: string]: string[];
+            };
+        } & {
+            relevantSort: number;
+        } & {
+            query: string;
+        } & {
+            sortBy: string;
+        } & {
+            toggle: {
+                [attribute: string]: boolean;
+            };
+        } & {
+            query: string;
+        } & {
+            places: {
+                query: string;
+                position: string;
+            };
+        }>)) => string;
+    } & {
+        results: RecommendResultItem;
+    })): {
+        items: Hit<THit>[];
+        widgetParams: TWidgetParams & TrendingItemsConnectorParams<THit>;
+    };
+    dispose({ recommendState }: import("../../types").DisposeOptions): import("algoliasearch-helper").RecommendParameters;
+    getWidgetParameters(state: import("algoliasearch-helper").RecommendParameters): import("algoliasearch-helper").RecommendParameters;
+};
+export default _default;

package/es/connectors/trending-items/connectTrendingItems.js

@@ -4,15 +4,15 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
-import { createDocumentationMessageGenerator, checkRendering, noop, escapeHits, TAG_PLACEHOLDER } from "../../lib/utils/index.js";
+import { createDocumentationMessageGenerator, checkRendering, noop, escapeHits, TAG_PLACEHOLDER, getObjectType } from "../../lib/utils/index.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'trending-items',
   connector: true
 });
-var connectTrendingItems = function connectTrendingItems(renderFn) {
+export default (function connectTrendingItems(renderFn) {
   var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
   checkRendering(renderFn, withUsage());
-  return function trendingItems(widgetParams) {
+  return function (widgetParams) {
     var _ref = widgetParams || {},
       facetName = _ref.facetName,
       facetValue = _ref.facetValue,
@@ -26,6 +26,9 @@ var connectTrendingItems = function connectTrendingItems(renderFn) {
       transformItems = _ref$transformItems === void 0 ? function (items) {
         return items;
       } : _ref$transformItems;
+    if (facetName && !facetValue || !facetName && facetValue) {
+      throw new Error(withUsage("When you provide facetName (received type ".concat(getObjectType(facetName), "), you must also provide facetValue (received type ").concat(getObjectType(facetValue), ").")));
+    }
     return {
       dependsOn: 'recommend',
       $$type: 'ais.trendingItems',
@@ -79,5 +82,4 @@ var connectTrendingItems = function connectTrendingItems(renderFn) {
       }
     };
   };
-};
-export default connectTrendingItems;
+});

package/es/lib/InstantSearch.d.ts

@@ -1,8 +1,7 @@
 import EventEmitter from '@algolia/events';
 import type { InsightsEvent, InsightsProps } from '../middlewares/createInsightsMiddleware';
 import type { RouterProps } from '../middlewares/createRouterMiddleware';
-import type { InsightsClient as AlgoliaInsightsClient, SearchClient, Widget, UiState, CreateURL, Middleware, MiddlewareDefinition, RenderState, InitialResults } from '../types';
-import type { IndexWidget } from '../widgets/index/index';
+import type { InsightsClient as AlgoliaInsightsClient, SearchClient, Widget, IndexWidget, UiState, CreateURL, Middleware, MiddlewareDefinition, RenderState, InitialResults } from '../types';
 import type { AlgoliaSearchHelper } from 'algoliasearch-helper';
 type NoInfer<T> = T extends infer S ? S : never;
 /**

package/es/lib/InstantSearch.js

@@ -19,9 +19,9 @@ import algoliasearchHelper from 'algoliasearch-helper';
 import { createInsightsMiddleware } from "../middlewares/createInsightsMiddleware.js";
 import { createMetadataMiddleware, isMetadataEnabled } from "../middlewares/createMetadataMiddleware.js";
 import { createRouterMiddleware } from "../middlewares/createRouterMiddleware.js";
-import index from "../widgets/index/index.js";
+import { index } from "../widgets/index.js";
 import createHelpers from "./createHelpers.js";
-import { createDocumentationMessageGenerator, createDocumentationLink, defer, hydrateSearchClient, noop, warning, setIndexHelperState, isIndexWidget } from "./utils/index.js";
+import { createDocumentationMessageGenerator, createDocumentationLink, defer, hydrateRecommendCache, hydrateSearchClient, noop, warning, setIndexHelperState, isIndexWidget } from "./utils/index.js";
 import version from "./version.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'instantsearch'
@@ -459,6 +459,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       });
       if (this._initialResults) {
         hydrateSearchClient(this.client, this._initialResults);
+        hydrateRecommendCache(this.mainHelper, this._initialResults);
         var originalScheduleSearch = this.scheduleSearch;
         // We don't schedule a first search when initial results are provided
         // because we already have the results to render. This skips the initial

package/es/lib/server.d.ts

@@ -3,7 +3,7 @@ import type { IndexWidget, InitialResults, InstantSearch, SearchOptions } from '
  * Waits for the results from the search instance to coordinate the next steps
  * in `getServerState()`.
  */
-export declare function waitForResults(search: InstantSearch): Promise<SearchOptions[]>;
+export declare function waitForResults(search: InstantSearch, skipRecommend?: boolean): Promise<SearchOptions[]>;
 /**
  * Walks the InstantSearch root index to construct the initial results.
  */

package/es/lib/server.js

@@ -10,13 +10,14 @@ import { walkIndex } from "./utils/index.js";
  * in `getServerState()`.
  */
 export function waitForResults(search) {
+  var skipRecommend = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
   var helper = search.mainHelper;
 
   // Extract search parameters from the search client to use them
   // later during hydration.
   var requestParamsList;
   var client = helper.getClient();
-  helper.setClient({
+  helper.setClient(_objectSpread(_objectSpread({}, client), {}, {
     search: function search(queries) {
       requestParamsList = queries.map(function (_ref) {
         var params = _ref.params;
@@ -24,13 +25,25 @@ export function waitForResults(search) {
       });
       return client.search(queries);
     }
-  });
-  helper.searchOnlyWithDerivedHelpers();
+  }));
+  search._hasSearchWidget && helper.searchOnlyWithDerivedHelpers();
+  !skipRecommend && search._hasRecommendWidget && helper.recommend();
   return new Promise(function (resolve, reject) {
+    var searchResultsReceived = !search._hasSearchWidget;
+    var recommendResultsReceived = !search._hasRecommendWidget || skipRecommend;
     // All derived helpers resolve in the same tick so we're safe only relying
     // on the first one.
     helper.derivedHelpers[0].on('result', function () {
-      resolve(requestParamsList);
+      searchResultsReceived = true;
+      if (recommendResultsReceived) {
+        resolve(requestParamsList);
+      }
+    });
+    helper.derivedHelpers[0].on('recommend:result', function () {
+      recommendResultsReceived = true;
+      if (searchResultsReceived) {
+        resolve(requestParamsList);
+      }
     });
 
     // However, we listen to errors that can happen on any derived helper because
@@ -61,15 +74,21 @@ requestParamsList) {
   var initialResults = {};
   var requestParamsIndex = 0;
   walkIndex(rootIndex, function (widget) {
+    var _widget$getHelper;
     var searchResults = widget.getResults();
-    if (searchResults) {
+    var recommendResults = (_widget$getHelper = widget.getHelper()) === null || _widget$getHelper === void 0 ? void 0 : _widget$getHelper.lastRecommendResults;
+    if (searchResults || recommendResults) {
       var requestParams = requestParamsList === null || requestParamsList === void 0 ? void 0 : requestParamsList[requestParamsIndex++];
-      initialResults[widget.getIndexId()] = _objectSpread({
-        // We convert the Helper state to a plain object to pass parsable data
-        // structures from server to client.
+      initialResults[widget.getIndexId()] = _objectSpread(_objectSpread(_objectSpread({}, searchResults && {
         state: _objectSpread({}, searchResults._state),
         results: searchResults._rawResults
-      }, requestParams && {
+      }), recommendResults && {
+        recommendResults: {
+          // We have to stringify + parse because of some explicitly undefined values.
+          params: JSON.parse(JSON.stringify(recommendResults._state.params)),
+          results: recommendResults._rawResults
+        }
+      }), requestParams && {
         requestParams: requestParams
       });
     }

package/es/lib/utils/addWidgetId.d.ts

@@ -1,2 +1,3 @@
 import type { Widget } from '../../types';
 export declare function addWidgetId(widget: Widget): void;
+export declare function resetWidgetId(): void;

package/es/lib/utils/addWidgetId.js

@@ -4,4 +4,7 @@ export function addWidgetId(widget) {
     return;
   }
   widget.$$id = id++;
+}
+export function resetWidgetId() {
+  id = 0;
 }

package/es/lib/utils/checkIndexUiState.d.ts

@@ -1,5 +1,4 @@
-import type { IndexUiState } from '../../types';
-import type { IndexWidget } from '../../widgets/index/index';
+import type { IndexUiState, IndexWidget } from '../../types';
 type CheckIndexUiStateParams = {
     index: IndexWidget;
     indexUiState: IndexUiState;

package/es/lib/utils/checkRendering.d.ts

@@ -1,2 +1,2 @@
 import type { Renderer } from '../../types/connector';
-export declare function checkRendering<TRenderOptions, TWidgetParams>(rendering: Renderer<TRenderOptions, TWidgetParams>, usage: string): void;
+export declare function checkRendering(rendering: any, usage: string): asserts rendering is Renderer<any, any>;

package/es/lib/utils/getWidgetAttribute.d.ts

@@ -1,3 +1,2 @@
-import type { InitOptions, Widget } from '../../types';
-import type { IndexWidget } from '../../widgets/index/index';
+import type { InitOptions, Widget, IndexWidget } from '../../types';
 export declare function getWidgetAttribute(widget: Widget | IndexWidget, initOptions: InitOptions): string;

package/es/lib/utils/hydrateRecommendCache.d.ts

@@ -0,0 +1,3 @@
+import type { InitialResults } from '../../types';
+import type { AlgoliaSearchHelper } from 'algoliasearch-helper';
+export declare function hydrateRecommendCache(helper: AlgoliaSearchHelper, initialResults: InitialResults): void;

package/es/lib/utils/hydrateRecommendCache.js

@@ -0,0 +1,17 @@
+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); }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+export function hydrateRecommendCache(helper, initialResults) {
+  var recommendCache = Object.keys(initialResults).reduce(function (acc, indexName) {
+    var initialResult = initialResults[indexName];
+    if (initialResult.recommendResults) {
+      // @MAJOR: Use `Object.assign` instead of spread operator
+      return _objectSpread(_objectSpread({}, acc), initialResult.recommendResults.results);
+    }
+    return acc;
+  }, {});
+  helper._recommendCache = recommendCache;
+}

package/es/lib/utils/hydrateSearchClient.js

@@ -27,16 +27,20 @@ export function hydrateSearchClient(client, results) {
       state = _results$key.state,
       requestParams = _results$key.requestParams,
       serverResults = _results$key.results;
-    return serverResults.map(function (result) {
+    return serverResults && state ? serverResults.map(function (result) {
       return _objectSpread({
         indexName: state.index || result.index
       }, requestParams || result.params ? {
         params: serializeQueryParameters(requestParams || deserializeQueryParameters(result.params))
       } : {});
-    });
+    }) : [];
   });
   var cachedResults = Object.keys(results).reduce(function (acc, key) {
-    return acc.concat(results[key].results);
+    var res = results[key].results;
+    if (!res) {
+      return acc;
+    }
+    return acc.concat(res);
   }, []);
 
   // Algoliasearch API Client >= v4

package/es/lib/utils/index.d.ts

@@ -1,3 +1,4 @@
+export * from './addWidgetId';
 export * from './capitalize';
 export * from './checkIndexUiState';
 export * from './checkRendering';
@@ -27,6 +28,7 @@ export * from './getRefinements';
 export * from './getWidgetAttribute';
 export * from './hits-absolute-position';
 export * from './hits-query-id';
+export * from './hydrateRecommendCache';
 export * from './hydrateSearchClient';
 export * from './isDomElement';
 export * from './isEqual';

package/es/lib/utils/index.js

@@ -1,3 +1,4 @@
+export * from "./addWidgetId.js";
 export * from "./capitalize.js";
 export * from "./checkIndexUiState.js";
 export * from "./checkRendering.js";
@@ -27,6 +28,7 @@ export * from "./getRefinements.js";
 export * from "./getWidgetAttribute.js";
 export * from "./hits-absolute-position.js";
 export * from "./hits-query-id.js";
+export * from "./hydrateRecommendCache.js";
 export * from "./hydrateSearchClient.js";
 export * from "./isDomElement.js";
 export * from "./isEqual.js";

package/es/lib/utils/isIndexWidget.d.ts

@@ -1,3 +1,2 @@
-import type { Widget } from '../../types';
-import type { IndexWidget } from '../../widgets/index/index';
+import type { Widget, IndexWidget } from '../../types';
 export declare function isIndexWidget(widget: Widget | IndexWidget): widget is IndexWidget;

package/es/lib/utils/render-args.d.ts

@@ -1,5 +1,4 @@
-import type { InstantSearch, UiState, Widget } from '../../types';
-import type { IndexWidget } from '../../widgets/index/index';
+import type { InstantSearch, UiState, Widget, IndexWidget } from '../../types';
 export declare function createInitArgs(instantSearchInstance: InstantSearch, parent: IndexWidget, uiState: UiState): {
     uiState: UiState;
     helper: import("algoliasearch-helper").AlgoliaSearchHelper;