instantsearch.js 4.37.3 → 4.38.0

package/es/connectors/breadcrumb/connectBreadcrumb.js

@@ -98,7 +98,9 @@ var connectBreadcrumb = function connectBreadcrumb(renderFn) {
 
           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;
         }
 

package/es/connectors/clear-refinements/connectClearRefinements.js

@@ -80,13 +80,15 @@ var connectClearRefinements = function connectClearRefinements(renderFn) {
       },
       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
           }));
         }, []);
 
@@ -131,7 +133,8 @@ function getAttributesToClear(_ref5) {
   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,
@@ -147,7 +150,9 @@ function getAttributesToClear(_ref5) {
         attribute === 'query' && includesQuery || // Otherwise, ignore the excluded attributes
         excludedAttributes.indexOf(attribute) === -1
       );
-    })))
+    })), {
+      results: results
+    })
   };
 }
 

package/es/connectors/current-refinements/connectCurrentRefinements.js

@@ -74,7 +74,9 @@ var connectCurrentRefinements = function connectCurrentRefinements(renderFn) {
               helper: helper,
               includedAttributes: includedAttributes,
               excludedAttributes: excludedAttributes
-            }));
+            }), {
+              results: results
+            });
           }
 
           return scopedResults.reduce(function (accResults, scopedResult) {
@@ -83,7 +85,9 @@ var connectCurrentRefinements = function connectCurrentRefinements(renderFn) {
               helper: scopedResult.helper,
               includedAttributes: includedAttributes,
               excludedAttributes: excludedAttributes
-            })));
+            }), {
+              results: results
+            }));
           }, []);
         }
 

package/es/connectors/dynamic-widgets/connectDynamicWidgets.d.ts

@@ -1,5 +1,4 @@
-import type { SearchResults } from 'algoliasearch-helper';
-import type { Connector, Widget } from '../../types';
+import type { Connector, TransformItems, TransformItemsMetadata, Widget } from '../../types';
 export declare type DynamicWidgetsRenderState = {
     attributesToRender: string[];
 };
@@ -20,9 +19,9 @@ export 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.

package/es/connectors/geo-search/connectGeoSearch.js

@@ -161,7 +161,9 @@ var connectGeoSearch = function connectGeoSearch(renderFn) {
         var state = helper.state;
         var items = results ? transformItems(results.hits.filter(function (hit) {
           return hit._geoloc;
-        })) : [];
+        }), {
+          results: results
+        }) : [];
 
         if (!sendEvent) {
           sendEvent = createSendEventForHits({

package/es/connectors/hierarchical-menu/connectHierarchicalMenu.js

@@ -192,7 +192,9 @@ var connectHierarchicalMenu = function connectHierarchicalMenu(renderFn) {
 
           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 {

package/es/connectors/hits/connectHits.js

@@ -79,7 +79,9 @@ var connectHits = function connectHits(renderFn) {
 
         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,

package/es/connectors/hits-per-page/connectHitsPerPage.js

@@ -120,7 +120,9 @@ var connectHitsPerPage = function connectHitsPerPage(renderFn) {
             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,

package/es/connectors/infinite-hits/connectInfiniteHits.js

@@ -176,7 +176,9 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
 
           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;

package/es/connectors/menu/connectMenu.js

@@ -168,7 +168,9 @@ var connectMenu = function connectMenu(renderFn) {
               label: label,
               value: value
             });
-          }));
+          }), {
+            results: results
+          });
         }
 
         return {

package/es/connectors/numeric-menu/connectNumericMenu.js

@@ -78,8 +78,8 @@ var connectNumericMenu = function connectNumericMenu(renderFn) {
         _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 === '') {
@@ -216,7 +216,9 @@ var connectNumericMenu = function connectNumericMenu(renderFn) {
 
         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,

package/es/connectors/query-rules/connectQueryRules.d.ts

@@ -4,11 +4,10 @@ export declare type ParamTrackedFilters = {
     [facetName: string]: (facetValues: TrackedFilterRefinement[]) => TrackedFilterRefinement[];
 };
 export declare type ParamTransformRuleContexts = (ruleContexts: string[]) => string[];
-declare type ParamTransformItems = TransformItems<any>;
 export declare type QueryRulesConnectorParams = {
     trackedFilters?: ParamTrackedFilters;
     transformRuleContexts?: ParamTransformRuleContexts;
-    transformItems?: ParamTransformItems;
+    transformItems?: TransformItems<any>;
 };
 export declare type QueryRulesRenderState = {
     items: any[];

package/es/connectors/query-rules/connectQueryRules.js

@@ -152,7 +152,9 @@ var connectQueryRules = function connectQueryRules(_render) {
             _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

package/es/connectors/refinement-list/connectRefinementList.js

@@ -105,7 +105,8 @@ var connectRefinementList = function connectRefinementList(renderFn) {
     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.
@@ -132,7 +133,9 @@ var connectRefinementList = function connectRefinementList(renderFn) {
                   value: value,
                   label: value
                 });
-              }));
+              }), {
+                results: searchResults
+              });
               renderFn(_objectSpread(_objectSpread({}, widget.getWidgetRenderState(_objectSpread(_objectSpread({}, renderOptions), {}, {
                 results: lastResultsFromMainSearch
               }))), {}, {
@@ -196,7 +199,9 @@ var connectRefinementList = function connectRefinementList(renderFn) {
             facetOrdering: sortBy === DEFAULT_SORT
           });
           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

package/es/connectors/sort-by/connectSortBy.js

@@ -79,7 +79,9 @@ var connectSortBy = function connectSortBy(renderFn) {
 
         return {
           currentRefinement: state.index,
-          options: transformItems(items),
+          options: transformItems(items, {
+            results: results
+          }),
           refine: connectorState.setIndex,
           hasNoResults: results ? results.nbHits === 0 : true,
           widgetParams: widgetParams

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.37.3";
+declare const _default: "4.38.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.37.3';
+export default '4.38.0';

package/es/types/widget.d.ts

@@ -129,10 +129,13 @@ declare type RenderStateLifeCycle<TWidgetDescription extends WidgetDescription &
 export declare type Widget<TWidgetDescription extends WidgetDescription & WidgetParams = {
     $$type: string;
 }> = Expand<RequiredWidgetLifeCycle<TWidgetDescription> & WidgetType<TWidgetDescription> & UiStateLifeCycle<TWidgetDescription> & RenderStateLifeCycle<TWidgetDescription>>;
+export declare type TransformItemsMetadata = {
+    results?: SearchResults;
+};
 /**
  * Transforms the given items.
  */
-export declare type TransformItems<TItem> = (items: TItem[]) => TItem[];
+export declare type TransformItems<TItem, TMetadata = TransformItemsMetadata> = (items: TItem[], metadata: TMetadata) => TItem[];
 /**
  * Transforms the given items.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.37.3",
+  "version": "4.38.0",
   "description": "InstantSearch.js is a JavaScript library for building performant and instant search experiences with Algolia.",
   "homepage": "https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/",
   "types": "es/index.d.ts",