instantsearch.js 4.37.3 → 4.38.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [4.38.0](https://github.com/algolia/instantsearch.js/compare/v4.37.3...v4.38.0) (2022-01-28)
+
+
+### Bug Fixes
+
+* **typescript:** remove non-existing UMD type definition ([#5001](https://github.com/algolia/instantsearch.js/issues/5001)) ([c234374](https://github.com/algolia/instantsearch.js/commit/c234374a1f5333f6625980c45fa0833a8c130257))
+
+
+### Features
+
+* **connectors:** expose search results to `transformItems` when available ([#5000](https://github.com/algolia/instantsearch.js/issues/5000)) ([58c2651](https://github.com/algolia/instantsearch.js/commit/58c26517aad916ce49b474458e3411ff7ef5497a))
+
+
+
 ## [4.37.3](https://github.com/algolia/instantsearch.js/compare/v4.37.2...v4.37.3) (2022-01-25)
 
 

package/cjs/connectors/breadcrumb/connectBreadcrumb.js

@@ -106,7 +106,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/cjs/connectors/clear-refinements/connectClearRefinements.js

@@ -88,13 +88,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
           }));
         }, []);
 
@@ -139,7 +141,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,
@@ -155,7 +158,9 @@ function getAttributesToClear(_ref5) {
         attribute === 'query' && includesQuery || // Otherwise, ignore the excluded attributes
         excludedAttributes.indexOf(attribute) === -1
       );
-    })))
+    })), {
+      results: results
+    })
   };
 }
 

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

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

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

@@ -169,7 +169,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 = (0, _index.createSendEventForHits)({

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

@@ -200,7 +200,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/cjs/connectors/hits/connectHits.js

@@ -87,7 +87,9 @@ var connectHits = function connectHits(renderFn) {
 
         var hitsWithAbsolutePosition = (0, _index.addAbsolutePosition)(results.hits, results.page, results.hitsPerPage);
         var hitsWithAbsolutePositionAndQueryID = (0, _index.addQueryID)(hitsWithAbsolutePosition, results.queryID);
-        var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID);
+        var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID, {
+          results: results
+        });
         return {
           hits: transformedHits,
           results: results,

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

@@ -128,7 +128,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/cjs/connectors/infinite-hits/connectInfiniteHits.js

@@ -184,7 +184,9 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
 
           var hitsWithAbsolutePosition = (0, _index.addAbsolutePosition)(results.hits, results.page, results.hitsPerPage);
           var hitsWithAbsolutePositionAndQueryID = (0, _index.addQueryID)(hitsWithAbsolutePosition, results.queryID);
-          var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID);
+          var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID, {
+            results: results
+          });
 
           if (cachedHits[_page] === undefined) {
             cachedHits[_page] = transformedHits;

package/cjs/connectors/menu/connectMenu.js

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

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

@@ -86,8 +86,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 === '') {
@@ -224,7 +224,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/cjs/connectors/query-rules/connectQueryRules.js

@@ -160,7 +160,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/cjs/connectors/refinement-list/connectRefinementList.js

@@ -113,7 +113,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.
@@ -140,7 +141,9 @@ var connectRefinementList = function connectRefinementList(renderFn) {
                   value: value,
                   label: value
                 });
-              }));
+              }), {
+                results: searchResults
+              });
               renderFn(_objectSpread(_objectSpread({}, widget.getWidgetRenderState(_objectSpread(_objectSpread({}, renderOptions), {}, {
                 results: lastResultsFromMainSearch
               }))), {}, {
@@ -204,7 +207,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/cjs/connectors/sort-by/connectSortBy.js

@@ -87,7 +87,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/cjs/lib/version.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _default = '4.37.3';
+var _default = '4.38.0';
 exports.default = _default;

package/dist/instantsearch.development.d.ts

@@ -1098,9 +1098,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.
@@ -3203,8 +3203,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 +3343,7 @@ declare type QueryRulesConnector = Connector<QueryRulesWidgetDescription, QueryR
 declare type QueryRulesConnectorParams = {
     trackedFilters?: ParamTrackedFilters;
     transformRuleContexts?: ParamTransformRuleContexts;
-    transformItems?: ParamTransformItems;
+    transformItems?: TransformItems<any>;
 };
 
 declare type QueryRulesRenderState = {
@@ -5050,7 +5048,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;
 

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.38.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.38.0';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -10545,13 +10545,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 +10598,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 +10615,9 @@
           attribute === 'query' && includesQuery || // Otherwise, ignore the excluded attributes
           excludedAttributes.indexOf(attribute) === -1
         );
-      })))
+      })), {
+        results: results
+      })
     };
   }
 
@@ -10673,7 +10678,9 @@
                 helper: helper,
                 includedAttributes: includedAttributes,
                 excludedAttributes: excludedAttributes
-              }));
+              }), {
+                results: results
+              });
             }
 
             return scopedResults.reduce(function (accResults, scopedResult) {
@@ -10682,7 +10689,9 @@
                 helper: scopedResult.helper,
                 includedAttributes: includedAttributes,
                 excludedAttributes: excludedAttributes
-              })));
+              }), {
+                results: results
+              }));
             }, []);
           }
 
@@ -10977,7 +10986,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 +11121,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 +11456,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,
@@ -11630,7 +11645,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 +11871,9 @@
                 label: label,
                 value: value
               });
-            }));
+            }), {
+              results: results
+            });
           }
 
           return {
@@ -11968,8 +11987,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 +12125,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 +12869,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 +12897,9 @@
                     value: value,
                     label: value
                   });
-                }));
+                }), {
+                  results: searchResults
+                });
                 renderFn(_objectSpread2(_objectSpread2({}, widget.getWidgetRenderState(_objectSpread2(_objectSpread2({}, renderOptions), {}, {
                   results: lastResultsFromMainSearch
                 }))), {}, {
@@ -12939,7 +12963,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 +13223,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 +13983,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 +14211,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 +14759,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