instantsearch.js 4.37.3 → 4.39.0

package/dist/instantsearch.development.d.ts

@@ -12,8 +12,7 @@ import { default as qs_2 } from 'qs';
 import type { SearchParameters } from 'algoliasearch-helper';
 import type { SearchResults } from 'algoliasearch-helper';
 
-declare type AlgoliaHit = {
-    [attribute: string]: any;
+declare type AlgoliaHit<THit extends BaseHit = Record<string, any>> = {
     objectID: string;
     _highlightResult?: HitHighlightResult;
     _snippetResult?: HitSnippetResult;
@@ -36,7 +35,7 @@ declare type AlgoliaHit = {
     };
     _distinctSeqID?: number;
     _geoLoc?: GeoLoc;
-};
+} & THit;
 
 declare const analytics: AnalyticsWidget;
 
@@ -292,6 +291,8 @@ declare type AutocompleteWidgetDescription = {
     };
 };
 
+declare type BaseHit = Record<string, unknown>;
+
 declare type BindEventForHits = BuiltInBindEventForHits & CustomBindEventForHits;
 
 declare type Bounds = {
@@ -466,6 +467,17 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
      * It needs to avoid pushing state to history in case of back/forward in browser
      */
     private shouldPushState;
+    /**
+     * Indicates whether the history router is disposed or not.
+     */
+    private isDisposed;
+    /**
+     * Indicates the window.history.length before the last call to
+     * window.history.pushState (called in `write`).
+     * It allows to determine if a `pushState` has been triggered elsewhere,
+     * and thus to prevent the `write` method from calling `pushState`.
+     */
+    private latestAcknowledgedHistory;
     /**
      * Initializes a new storage provider that syncs the search state to the URL
      * using web APIs (`window.location.pushState` and `onpopstate` event).
@@ -723,11 +735,11 @@ declare const connectHits: HitsConnector;
 
 declare const connectHitsPerPage: HitsPerPageConnector;
 
-declare const connectHitsWithInsights: HitsConnector;
+declare const connectHitsWithInsights: HitsConnector<BaseHit>;
 
 declare const connectInfiniteHits: InfiniteHitsConnector;
 
-declare const connectInfiniteHitsWithInsights: InfiniteHitsConnector;
+declare const connectInfiniteHitsWithInsights: InfiniteHitsConnector<BaseHit>;
 
 /**
  * **Menu** connector provides the logic to build a widget that will give the user the ability to choose a single value for a specific facet. The typical usage of menu is for navigation in categories.
@@ -1098,9 +1110,9 @@ declare type DynamicWidgetsConnectorParams = {
      * Function to transform the items to render.
      * The function also exposes the full search response.
      */
-    transformItems?(items: string[], metadata: {
-        results: SearchResults;
-    }): string[];
+    transformItems?: TransformItems<string, Omit<TransformItemsMetadata, 'results'> & {
+        results: NonNullable<TransformItemsMetadata['results']>;
+    }>;
     /**
      * To prevent unneeded extra network requests when widgets mount or unmount,
      * we request all facet values.
@@ -1749,10 +1761,10 @@ declare type HighlightOptions = {
 
 declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
 
-declare type Hit = {
+declare type Hit<THit extends BaseHit = Record<string, any>> = {
     __position: number;
     __queryID?: string;
-} & AlgoliaHit;
+} & AlgoliaHit<THit>;
 
 declare type HitAttributeHighlightResult = {
     value: string;
@@ -1767,13 +1779,16 @@ declare type HitHighlightResult = {
     [attribute: string]: HitAttributeHighlightResult | HitAttributeHighlightResult[] | HitHighlightResult[] | HitHighlightResult;
 };
 
+/**
+ * @deprecated use Hit[] directly instead
+ */
 declare type Hits = Hit[];
 
 declare const hits: HitsWidget;
 
-declare type HitsConnector = Connector<HitsWidgetDescription, HitsConnectorParams>;
+declare type HitsConnector<THit extends BaseHit = BaseHit> = Connector<HitsWidgetDescription<THit>, HitsConnectorParams<THit>>;
 
-declare type HitsConnectorParams = {
+declare type HitsConnectorParams<THit extends BaseHit = BaseHit> = {
     /**
      * Whether to escape HTML tags from hits string values.
      *
@@ -1783,7 +1798,7 @@ declare type HitsConnectorParams = {
     /**
      * Function to transform the items passed to the templates.
      */
-    transformItems?: TransformItems<Hit>;
+    transformItems?: TransformItems<Hit<THit>>;
 };
 
 declare type HitsCSSClasses = Partial<{
@@ -1912,15 +1927,15 @@ declare type HitsPerPageWidgetParams = {
     cssClasses?: HitsPerPageCSSClasses;
 };
 
-declare type HitsRenderState = {
+declare type HitsRenderState<THit extends BaseHit = BaseHit> = {
     /**
      * The matched hits from Algolia API.
      */
-    hits: Hits;
+    hits: Array<Hit<THit>>;
     /**
      * The response from the Algolia API.
      */
-    results?: SearchResults<Hit>;
+    results?: SearchResults<Hit<THit>>;
     /**
      * Sends an event to the Insights middleware.
      */
@@ -1952,11 +1967,11 @@ declare type HitsWidget = WidgetFactory<HitsWidgetDescription & {
     $$widgetType: 'ais.hits';
 }, HitsConnectorParams, HitsWidgetParams>;
 
-declare type HitsWidgetDescription = {
+declare type HitsWidgetDescription<THit extends BaseHit = BaseHit> = {
     $$type: 'ais.hits';
-    renderState: HitsRenderState;
+    renderState: HitsRenderState<THit>;
     indexRenderState: {
-        hits: WidgetRenderState<HitsRenderState, HitsConnectorParams>;
+        hits: WidgetRenderState<HitsRenderState<THit>, HitsConnectorParams<THit>>;
     };
 };
 
@@ -2037,18 +2052,18 @@ declare type IndexWidgetParams = {
 
 declare const infiniteHits: InfiniteHitsWidget;
 
-declare type InfiniteHitsCache = {
-    read: Read;
-    write: Write;
+declare type InfiniteHitsCache<THit extends BaseHit = BaseHit> = {
+    read: Read<THit>;
+    write: Write<THit>;
 };
 
-declare type InfiniteHitsCachedHits = {
-    [page: number]: Hits;
+declare type InfiniteHitsCachedHits<THit extends BaseHit> = {
+    [page: number]: Array<Hit<THit>>;
 };
 
-declare type InfiniteHitsConnector = Connector<InfiniteHitsWidgetDescription, InfiniteHitsConnectorParams>;
+declare type InfiniteHitsConnector<THit extends BaseHit = BaseHit> = Connector<InfiniteHitsWidgetDescription<THit>, InfiniteHitsConnectorParams<THit>>;
 
-declare type InfiniteHitsConnectorParams = {
+declare type InfiniteHitsConnectorParams<THit extends BaseHit = BaseHit> = {
     /**
      * Escapes HTML entities from hits string values.
      *
@@ -2065,13 +2080,13 @@ declare type InfiniteHitsConnectorParams = {
      * Receives the items, and is called before displaying them.
      * Useful for mapping over the items to transform, and remove or reorder them.
      */
-    transformItems?: TransformItems<Hit>;
+    transformItems?: TransformItems<Hit<THit>>;
     /**
      * Reads and writes hits from/to cache.
      * When user comes back to the search page after leaving for product page,
      * this helps restore InfiniteHits and its scroll position.
      */
-    cache?: InfiniteHitsCache;
+    cache?: InfiniteHitsCache<THit>;
 };
 
 declare type InfiniteHitsCSSClasses = Partial<{
@@ -2109,7 +2124,7 @@ declare type InfiniteHitsCSSClasses = Partial<{
     disabledLoadMore: string | string[];
 }>;
 
-declare type InfiniteHitsRenderState = {
+declare type InfiniteHitsRenderState<THit extends BaseHit = BaseHit> = {
     /**
      * Loads the previous results.
      */
@@ -2137,15 +2152,15 @@ declare type InfiniteHitsRenderState = {
     /**
      * Hits for the current page
      */
-    currentPageHits: Hits;
+    currentPageHits: Array<Hit<THit>>;
     /**
      * Hits for current and cached pages
      */
-    hits: Hits;
+    hits: Array<Hit<THit>>;
     /**
      * The response from the Algolia API.
      */
-    results?: SearchResults<Hit>;
+    results?: SearchResults<Hit<THit>>;
 };
 
 declare type InfiniteHitsTemplates = Partial<{
@@ -2175,11 +2190,11 @@ declare type InfiniteHitsWidget = WidgetFactory<InfiniteHitsWidgetDescription &
     $$widgetType: 'ais.infiniteHits';
 }, InfiniteHitsConnectorParams, InfiniteHitsWidgetParams>;
 
-declare type InfiniteHitsWidgetDescription = {
+declare type InfiniteHitsWidgetDescription<THit extends BaseHit = BaseHit> = {
     $$type: 'ais.infiniteHits';
-    renderState: InfiniteHitsRenderState;
+    renderState: InfiniteHitsRenderState<THit>;
     indexRenderState: {
-        infiniteHits: WidgetRenderState<InfiniteHitsRenderState, InfiniteHitsConnectorParams>;
+        infiniteHits: WidgetRenderState<InfiniteHitsRenderState<THit>, InfiniteHitsConnectorParams<THit>>;
     };
     indexUiState: {
         page: number;
@@ -3203,8 +3218,6 @@ declare type ParamTrackedFilters = {
     [facetName: string]: (facetValues: TrackedFilterRefinement[]) => TrackedFilterRefinement[];
 };
 
-declare type ParamTransformItems = TransformItems<any>;
-
 declare type ParamTransformRuleContexts = (ruleContexts: string[]) => string[];
 
 declare type ParseURL<TRouteState> = (args: {
@@ -3345,7 +3358,7 @@ declare type QueryRulesConnector = Connector<QueryRulesWidgetDescription, QueryR
 declare type QueryRulesConnectorParams = {
     trackedFilters?: ParamTrackedFilters;
     transformRuleContexts?: ParamTransformRuleContexts;
-    transformItems?: ParamTransformItems;
+    transformItems?: TransformItems<any>;
 };
 
 declare type QueryRulesRenderState = {
@@ -3798,9 +3811,9 @@ declare type RatingMenuWidgetParams = {
     cssClasses?: RatingMenuCSSClasses;
 };
 
-declare type Read = ({ state, }: {
+declare type Read<THit extends BaseHit> = ({ state, }: {
     state: PlainSearchParameters;
-}) => InfiniteHitsCachedHits | null;
+}) => InfiniteHitsCachedHits<THit> | null;
 
 declare type ReconfigurableOptions = Places.ReconfigurableOptions;
 
@@ -5050,7 +5063,11 @@ declare type TrackedFilterRefinement = string | number | boolean;
 /**
  * Transforms the given items.
  */
-declare type TransformItems<TItem> = (items: TItem[]) => TItem[];
+declare type TransformItems<TItem, TMetadata = TransformItemsMetadata> = (items: TItem[], metadata: TMetadata) => TItem[];
+
+declare type TransformItemsMetadata = {
+    results?: SearchResults;
+};
 
 declare type TransformSearchParameters = (searchParameters: SearchParameters) => PlainSearchParameters;
 
@@ -5238,9 +5255,9 @@ declare type WidgetType<TWidgetDescription extends WidgetDescription> = TWidgetD
 
 declare type WidgetUiStates = PlacesWidgetDescription['indexUiState'];
 
-declare type Write = ({ state, hits, }: {
+declare type Write<THit extends BaseHit> = ({ state, hits, }: {
     state: PlainSearchParameters;
-    hits: InfiniteHitsCachedHits;
+    hits: InfiniteHitsCachedHits<THit>;
 }) => void;
 
 export { }

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.37.3 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.39.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -8483,7 +8483,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.37.3';
+  var version$1 = '4.39.0';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -9600,16 +9600,23 @@
 
       _defineProperty(this, "shouldPushState", true);
 
+      _defineProperty(this, "isDisposed", false);
+
+      _defineProperty(this, "latestAcknowledgedHistory", 0);
+
       this.windowTitle = windowTitle;
       this.writeTimer = undefined;
       this.writeDelay = writeDelay;
       this._createURL = createURL;
       this.parseURL = parseURL;
       this.getLocation = getLocation;
-      safelyRunOnBrowser(function () {
+      safelyRunOnBrowser(function (_ref2) {
+        var window = _ref2.window;
+
         var title = _this.windowTitle && _this.windowTitle(_this.read());
 
         setWindowTitle(title);
+        _this.latestAcknowledgedHistory = window.history.length;
       });
     }
     /**
@@ -9634,8 +9641,8 @@
       value: function write(routeState) {
         var _this2 = this;
 
-        safelyRunOnBrowser(function (_ref2) {
-          var window = _ref2.window;
+        safelyRunOnBrowser(function (_ref3) {
+          var window = _ref3.window;
 
           var url = _this2.createURL(routeState);
 
@@ -9646,10 +9653,17 @@
           }
 
           _this2.writeTimer = setTimeout(function () {
-            setWindowTitle(title);
+            setWindowTitle(title); // We do want to `pushState` if:
+            // - the router is not disposed, IS.js needs to update the URL
+            // OR
+            // - the last write was from InstantSearch.js
+            // (unlike a SPA, where it would have last written)
+
+            var lastPushWasByISAfterDispose = !_this2.isDisposed || _this2.latestAcknowledgedHistory === window.history.length;
 
-            if (_this2.shouldPushState) {
+            if (_this2.shouldPushState && lastPushWasByISAfterDispose) {
               window.history.pushState(routeState, title || '', url);
+              _this2.latestAcknowledgedHistory = window.history.length;
             }
 
             _this2.shouldPushState = true;
@@ -9685,8 +9699,8 @@
           }
         };
 
-        safelyRunOnBrowser(function (_ref3) {
-          var window = _ref3.window;
+        safelyRunOnBrowser(function (_ref4) {
+          var window = _ref4.window;
           window.addEventListener('popstate', _this3._onPopState);
         });
       }
@@ -9716,8 +9730,9 @@
       value: function dispose() {
         var _this4 = this;
 
-        safelyRunOnBrowser(function (_ref4) {
-          var window = _ref4.window;
+        this.isDisposed = true;
+        safelyRunOnBrowser(function (_ref5) {
+          var window = _ref5.window;
 
           if (_this4._onPopState) {
             window.removeEventListener('popstate', _this4._onPopState);
@@ -9736,12 +9751,12 @@
   }();
 
   function historyRouter() {
-    var _ref5 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-        _ref5$createURL = _ref5.createURL,
-        createURL = _ref5$createURL === void 0 ? function (_ref6) {
-      var qsModule = _ref6.qsModule,
-          routeState = _ref6.routeState,
-          location = _ref6.location;
+    var _ref6 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+        _ref6$createURL = _ref6.createURL,
+        createURL = _ref6$createURL === void 0 ? function (_ref7) {
+      var qsModule = _ref7.qsModule,
+          routeState = _ref7.routeState,
+          location = _ref7.location;
       var protocol = location.protocol,
           hostname = location.hostname,
           _location$port = location.port,
@@ -9757,11 +9772,11 @@
       }
 
       return "".concat(protocol, "//").concat(hostname).concat(portWithPrefix).concat(pathname, "?").concat(queryString).concat(hash);
-    } : _ref5$createURL,
-        _ref5$parseURL = _ref5.parseURL,
-        parseURL = _ref5$parseURL === void 0 ? function (_ref7) {
-      var qsModule = _ref7.qsModule,
-          location = _ref7.location;
+    } : _ref6$createURL,
+        _ref6$parseURL = _ref6.parseURL,
+        parseURL = _ref6$parseURL === void 0 ? function (_ref8) {
+      var qsModule = _ref8.qsModule,
+          location = _ref8.location;
       // `qs` by default converts arrays with more than 20 items to an object.
       // We want to avoid this because the data structure manipulated can therefore vary.
       // Setting the limit to `100` seems a good number because the engine's default is 100
@@ -9775,21 +9790,21 @@
       return qsModule.parse(location.search.slice(1), {
         arrayLimit: 99
       });
-    } : _ref5$parseURL,
-        _ref5$writeDelay = _ref5.writeDelay,
-        writeDelay = _ref5$writeDelay === void 0 ? 400 : _ref5$writeDelay,
-        windowTitle = _ref5.windowTitle,
-        _ref5$getLocation = _ref5.getLocation,
-        getLocation = _ref5$getLocation === void 0 ? function () {
-      return safelyRunOnBrowser(function (_ref8) {
-        var window = _ref8.window;
+    } : _ref6$parseURL,
+        _ref6$writeDelay = _ref6.writeDelay,
+        writeDelay = _ref6$writeDelay === void 0 ? 400 : _ref6$writeDelay,
+        windowTitle = _ref6.windowTitle,
+        _ref6$getLocation = _ref6.getLocation,
+        getLocation = _ref6$getLocation === void 0 ? function () {
+      return safelyRunOnBrowser(function (_ref9) {
+        var window = _ref9.window;
         return window.location;
       }, {
         fallback: function fallback() {
           throw new Error('You need to provide `getLocation` to the `history` router in environments where `window` does not exist.');
         }
       });
-    } : _ref5$getLocation;
+    } : _ref6$getLocation;
 
     return new BrowserHistory({
       createURL: createURL,
@@ -9891,8 +9906,10 @@
 
   function isMetadataEnabled() {
     return safelyRunOnBrowser(function (_ref) {
+      var _window$navigator, _window$navigator$use;
+
       var window = _ref.window;
-      return window.navigator.userAgent.indexOf('Algolia Crawler') > -1;
+      return ((_window$navigator = window.navigator) === null || _window$navigator === void 0 ? void 0 : (_window$navigator$use = _window$navigator.userAgent) === null || _window$navigator$use === void 0 ? void 0 : _window$navigator$use.indexOf('Algolia Crawler')) > -1;
     }, {
       fallback: function fallback() {
         return false;
@@ -10545,13 +10562,15 @@
         },
         getWidgetRenderState: function getWidgetRenderState(_ref2) {
           var createURL = _ref2.createURL,
-              scopedResults = _ref2.scopedResults;
-          connectorState.attributesToClear = scopedResults.reduce(function (results, scopedResult) {
-            return results.concat(getAttributesToClear({
+              scopedResults = _ref2.scopedResults,
+              results = _ref2.results;
+          connectorState.attributesToClear = scopedResults.reduce(function (attributesToClear, scopedResult) {
+            return attributesToClear.concat(getAttributesToClear({
               scopedResult: scopedResult,
               includedAttributes: includedAttributes,
               excludedAttributes: excludedAttributes,
-              transformItems: transformItems
+              transformItems: transformItems,
+              results: results
             }));
           }, []);
 
@@ -10596,7 +10615,8 @@
     var scopedResult = _ref5.scopedResult,
         includedAttributes = _ref5.includedAttributes,
         excludedAttributes = _ref5.excludedAttributes,
-        transformItems = _ref5.transformItems;
+        transformItems = _ref5.transformItems,
+        results = _ref5.results;
     var includesQuery = includedAttributes.indexOf('query') !== -1 || excludedAttributes.indexOf('query') === -1;
     return {
       helper: scopedResult.helper,
@@ -10612,7 +10632,9 @@
           attribute === 'query' && includesQuery || // Otherwise, ignore the excluded attributes
           excludedAttributes.indexOf(attribute) === -1
         );
-      })))
+      })), {
+        results: results
+      })
     };
   }
 
@@ -10673,7 +10695,9 @@
                 helper: helper,
                 includedAttributes: includedAttributes,
                 excludedAttributes: excludedAttributes
-              }));
+              }), {
+                results: results
+              });
             }
 
             return scopedResults.reduce(function (accResults, scopedResult) {
@@ -10682,7 +10706,9 @@
                 helper: scopedResult.helper,
                 includedAttributes: includedAttributes,
                 excludedAttributes: excludedAttributes
-              })));
+              }), {
+                results: results
+              }));
             }, []);
           }
 
@@ -10977,7 +11003,9 @@
 
             var hasExhaustiveItems = (state.maxValuesPerFacet || 0) > getLimit() ? facetItems.length <= getLimit() : facetItems.length < getLimit();
             canToggleShowMore = showMore && (isShowingMore || !hasExhaustiveItems);
-            items = transformItems(_prepareFacetValues(facetItems));
+            items = transformItems(_prepareFacetValues(facetItems), {
+              results: results
+            });
           }
 
           return {
@@ -11110,7 +11138,9 @@
 
           var hitsWithAbsolutePosition = addAbsolutePosition(results.hits, results.page, results.hitsPerPage);
           var hitsWithAbsolutePositionAndQueryID = addQueryID(hitsWithAbsolutePosition, results.queryID);
-          var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID);
+          var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID, {
+            results: results
+          });
           return {
             hits: transformedHits,
             results: results,
@@ -11443,7 +11473,9 @@
               createURL = _ref5.createURL,
               helper = _ref5.helper;
           return {
-            items: transformItems(normalizeItems(state)),
+            items: transformItems(normalizeItems(state), {
+              results: results
+            }),
             refine: connectorState.getRefine(helper),
             createURL: connectorState.createURLFactory({
               state: state,
@@ -11515,7 +11547,8 @@
 
   var connectInfiniteHits = function connectInfiniteHits(renderFn) {
     var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
-    checkRendering(renderFn, withUsage$7());
+    checkRendering(renderFn, withUsage$7()); // @TODO: this should be a generic, but a Connector can not yet be generic itself
+
     return function (widgetParams) {
       var _ref4 = widgetParams || {},
           _ref4$escapeHTML = _ref4.escapeHTML,
@@ -11630,7 +11663,9 @@
 
             var hitsWithAbsolutePosition = addAbsolutePosition(results.hits, results.page, results.hitsPerPage);
             var hitsWithAbsolutePositionAndQueryID = addQueryID(hitsWithAbsolutePosition, results.queryID);
-            var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID);
+            var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID, {
+              results: results
+            });
 
             if (cachedHits[_page] === undefined) {
               cachedHits[_page] = transformedHits;
@@ -11854,7 +11889,9 @@
                 label: label,
                 value: value
               });
-            }));
+            }), {
+              results: results
+            });
           }
 
           return {
@@ -11968,8 +12005,8 @@
           _ref2$items = _ref2.items,
           items = _ref2$items === void 0 ? [] : _ref2$items,
           _ref2$transformItems = _ref2.transformItems,
-          transformItems = _ref2$transformItems === void 0 ? function (x) {
-        return x;
+          transformItems = _ref2$transformItems === void 0 ? function (item) {
+        return item;
       } : _ref2$transformItems;
 
       if (attribute === '') {
@@ -12106,7 +12143,9 @@
 
           return {
             createURL: connectorState.createURL(state),
-            items: transformItems(prepareItems(state)),
+            items: transformItems(prepareItems(state), {
+              results: results
+            }),
             hasNoResults: results ? results.nbHits === 0 : true,
             refine: connectorState.refine,
             sendEvent: connectorState.sendEvent,
@@ -12848,7 +12887,8 @@
       var createSearchForFacetValues = function createSearchForFacetValues(helper, widget) {
         return function (renderOptions) {
           return function (query) {
-            var instantSearchInstance = renderOptions.instantSearchInstance;
+            var instantSearchInstance = renderOptions.instantSearchInstance,
+                searchResults = renderOptions.results;
 
             if (query === '' && lastItemsFromMainSearch) {
               // render with previous data from the helper.
@@ -12875,7 +12915,9 @@
                     value: value,
                     label: value
                   });
-                }));
+                }), {
+                  results: searchResults
+                });
                 renderFn(_objectSpread2(_objectSpread2({}, widget.getWidgetRenderState(_objectSpread2(_objectSpread2({}, renderOptions), {}, {
                   results: lastResultsFromMainSearch
                 }))), {}, {
@@ -12939,7 +12981,9 @@
               facetOrdering: sortBy === DEFAULT_SORT$2
             });
             facetValues = values && Array.isArray(values) ? values : [];
-            items = transformItems(facetValues.slice(0, getLimit()).map(formatItems));
+            items = transformItems(facetValues.slice(0, getLimit()).map(formatItems), {
+              results: results
+            });
             var maxValuesPerFacetConfig = state.maxValuesPerFacet;
             var currentLimit = getLimit(); // If the limit is the max number of facet retrieved it is impossible to know
             // if the facets are exhaustive. The only moment we are sure it is exhaustive
@@ -13197,7 +13241,9 @@
 
           return {
             currentRefinement: state.index,
-            options: transformItems(items),
+            options: transformItems(items, {
+              results: results
+            }),
             refine: connectorState.setIndex,
             hasNoResults: results ? results.nbHits === 0 : true,
             widgetParams: widgetParams
@@ -13955,7 +14001,9 @@
 
             var facetValues = results.getFacetValues(facetName, {});
             var data = Array.isArray(facetValues.data) ? facetValues.data : [];
-            var items = transformItems(shiftItemsValues(prepareItems(data)));
+            var items = transformItems(shiftItemsValues(prepareItems(data)), {
+              results: results
+            });
             return items;
           }
 
@@ -14181,7 +14229,9 @@
           var state = helper.state;
           var items = results ? transformItems(results.hits.filter(function (hit) {
             return hit._geoloc;
-          })) : [];
+          }), {
+            results: results
+          }) : [];
 
           if (!sendEvent) {
             sendEvent = createSendEventForHits({
@@ -14727,7 +14777,9 @@
               _ref4$userData = _ref4.userData,
               userData = _ref4$userData === void 0 ? [] : _ref4$userData;
 
-          var items = transformItems(userData);
+          var items = transformItems(userData, {
+            results: results
+          });
           return {
             items: items,
             widgetParams: widgetParams