instantsearch.js 4.78.2 → 4.79.0

package/cjs/components/RefinementList/RefinementList.js

@@ -181,6 +181,9 @@ var RefinementList = /*#__PURE__*/function (_Component) {
   }, {
     key: "refineFirstValue",
     value: function refineFirstValue() {
+      if (this.props.searchableSelectOnSubmit === false) {
+        return;
+      }
       var firstValue = this.props.facetValues && this.props.facetValues[0];
       if (firstValue) {
         var actualValue = firstValue.value;

package/cjs/connectors/breadcrumb/connectBreadcrumb.js

@@ -85,9 +85,7 @@ var connectBreadcrumb = function connectBreadcrumb(renderFn) {
           if (!results || state.hierarchicalFacets.length === 0) {
             return [];
           }
-          var _state$hierarchicalFa = _slicedToArray(state.hierarchicalFacets, 1),
-            facetName = _state$hierarchicalFa[0].name;
-          var facetValues = results.getFacetValues(facetName, {});
+          var facetValues = results.getFacetValues(hierarchicalFacetName, {});
           var facetItems = facetValues && !Array.isArray(facetValues) && facetValues.data ? facetValues.data : [];
           var items = transformItems(shiftItemsValues(prepareItems(facetItems)), {
             results: results

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

@@ -157,9 +157,11 @@ var connectInfiniteHits = exports.default = function connectInfiniteHits(renderF
           state: normalizeState(state)
         }) || {};
         var banner = results === null || results === void 0 ? void 0 : (_results$renderingCon = results.renderingContent) === null || _results$renderingCon === void 0 ? void 0 : (_results$renderingCon2 = _results$renderingCon.widgets) === null || _results$renderingCon2 === void 0 ? void 0 : (_results$renderingCon3 = _results$renderingCon2.banners) === null || _results$renderingCon3 === void 0 ? void 0 : _results$renderingCon3[0];
-        if (!results) {
+        if (!showPrevious) {
           showPrevious = getShowPrevious(helper);
           showMore = getShowMore(helper);
+        }
+        if (!sendEvent) {
           sendEvent = (0, _utils.createSendEventForHits)({
             instantSearchInstance: instantSearchInstance,
             helper: helper,
@@ -170,6 +172,8 @@ var connectInfiniteHits = exports.default = function connectInfiniteHits(renderF
             widgetType: this.$$type,
             instantSearchInstance: instantSearchInstance
           });
+        }
+        if (!results) {
           isFirstPage = state.page === undefined || getFirstReceivedPage(state, cachedHits) === 0;
         } else {
           var _state$disjunctiveFac, _state$hierarchicalFa;

package/cjs/lib/InstantSearch.js

@@ -81,6 +81,8 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     _defineProperty(_assertThisInitialized(_this), "_searchStalledTimer", void 0);
     _defineProperty(_assertThisInitialized(_this), "_initialUiState", void 0);
     _defineProperty(_assertThisInitialized(_this), "_initialResults", void 0);
+    _defineProperty(_assertThisInitialized(_this), "_manuallyResetScheduleSearch", false);
+    _defineProperty(_assertThisInitialized(_this), "_resetScheduleSearch", void 0);
     _defineProperty(_assertThisInitialized(_this), "_createURL", void 0);
     _defineProperty(_assertThisInitialized(_this), "_searchFunction", void 0);
     _defineProperty(_assertThisInitialized(_this), "_mainHelperSearch", void 0);
@@ -489,14 +491,25 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
         // because we already have the results to render. This skips the initial
         // network request on the browser on `start`.
         this.scheduleSearch = (0, _utils.defer)(_utils.noop);
-        // We also skip the initial network request when widgets are dynamically
-        // added in the first tick (that's the case in all the framework-based flavors).
-        // When we add a widget to `index`, it calls `scheduleSearch`. We can rely
-        // on our `defer` util to restore the original `scheduleSearch` value once
-        // widgets are added to hook back to the regular lifecycle.
-        (0, _utils.defer)(function () {
-          _this3.scheduleSearch = originalScheduleSearch;
-        })();
+        if (this._manuallyResetScheduleSearch) {
+          // If `_manuallyResetScheduleSearch` is passed, it means that we don't
+          // want to rely on a single `defer` to reset the `scheduleSearch`.
+          // Instead, the consumer will call `_resetScheduleSearch` to restore
+          // the original `scheduleSearch` function.
+          // This happens in the React flavour after rendering.
+          this._resetScheduleSearch = function () {
+            _this3.scheduleSearch = originalScheduleSearch;
+          };
+        } else {
+          // We also skip the initial network request when widgets are dynamically
+          // added in the first tick (that's the case in all the framework-based flavors).
+          // When we add a widget to `index`, it calls `scheduleSearch`. We can rely
+          // on our `defer` util to restore the original `scheduleSearch` value once
+          // widgets are added to hook back to the regular lifecycle.
+          (0, _utils.defer)(function () {
+            _this3.scheduleSearch = originalScheduleSearch;
+          })();
+        }
       }
       // We only schedule a search when widgets have been added before `start()`
       // because there are listeners that can use these results.

package/cjs/lib/version.js

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

package/cjs/middlewares/createInsightsMiddleware.js

@@ -262,10 +262,14 @@ function createInsightsMiddleware() {
         var insightsClientWithLocalCredentials = insightsClient;
         if (isModernInsightsClient(insightsClient)) {
           insightsClientWithLocalCredentials = function insightsClientWithLocalCredentials(method, payload) {
+            var _getAppIdAndApiKey3 = (0, _utils.getAppIdAndApiKey)(instantSearchInstance.client),
+              _getAppIdAndApiKey4 = _slicedToArray(_getAppIdAndApiKey3, 2),
+              latestAppId = _getAppIdAndApiKey4[0],
+              latestApiKey = _getAppIdAndApiKey4[1];
             var extraParams = {
               headers: {
-                'X-Algolia-Application-Id': appId,
-                'X-Algolia-API-Key': apiKey
+                'X-Algolia-Application-Id': latestAppId,
+                'X-Algolia-API-Key': latestApiKey
               }
             };
 

package/cjs/widgets/refinement-list/refinement-list.js

@@ -34,7 +34,8 @@ var renderer = function renderer(_ref) {
     showMore = _ref.showMore,
     searchable = _ref.searchable,
     searchablePlaceholder = _ref.searchablePlaceholder,
-    searchableIsAlwaysActive = _ref.searchableIsAlwaysActive;
+    searchableIsAlwaysActive = _ref.searchableIsAlwaysActive,
+    searchableSelectOnSubmit = _ref.searchableSelectOnSubmit;
   return function (_ref2, isFirstRendering) {
     var refine = _ref2.refine,
       items = _ref2.items,
@@ -74,7 +75,8 @@ var renderer = function renderer(_ref) {
       toggleShowMore: toggleShowMore,
       isShowingMore: isShowingMore,
       hasExhaustiveItems: hasExhaustiveItems,
-      canToggleShowMore: canToggleShowMore
+      canToggleShowMore: canToggleShowMore,
+      searchableSelectOnSubmit: searchableSelectOnSubmit
     }), containerNode);
   };
 };
@@ -114,6 +116,8 @@ var refinementList = function refinementList(widgetParams) {
     searchableEscapeFacetValues = _ref3$searchableEscap === void 0 ? true : _ref3$searchableEscap,
     _ref3$searchableIsAlw = _ref3.searchableIsAlwaysActive,
     searchableIsAlwaysActive = _ref3$searchableIsAlw === void 0 ? true : _ref3$searchableIsAlw,
+    _ref3$searchableSelec = _ref3.searchableSelectOnSubmit,
+    searchableSelectOnSubmit = _ref3$searchableSelec === void 0 ? true : _ref3$searchableSelec,
     _ref3$cssClasses = _ref3.cssClasses,
     userCssClasses = _ref3$cssClasses === void 0 ? {} : _ref3$cssClasses,
     _ref3$templates = _ref3.templates,
@@ -205,6 +209,7 @@ var refinementList = function refinementList(widgetParams) {
     searchable: searchable,
     searchablePlaceholder: searchablePlaceholder,
     searchableIsAlwaysActive: searchableIsAlwaysActive,
+    searchableSelectOnSubmit: searchableSelectOnSubmit,
     showMore: showMore
   });
   var makeWidget = (0, _connectRefinementList.default)(specializedRenderer, function () {

package/dist/instantsearch.development.d.ts

@@ -5076,6 +5076,8 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     _searchStalledTimer: any;
     _initialUiState: TUiState;
     _initialResults: InitialResults | null;
+    _manuallyResetScheduleSearch: boolean;
+    _resetScheduleSearch?: () => void;
     _createURL: CreateURL<TUiState>;
     _searchFunction?: InstantSearchOptions['searchFunction'];
     _mainHelperSearch?: AlgoliaSearchHelper['search'];
@@ -7148,6 +7150,11 @@ declare type RefinementListWidgetParams = {
      * In this case, the surrounding tags will always be `<mark></mark>`.
      */
     searchableEscapeFacetValues?: boolean;
+    /**
+     * When activated, submitting the search box will select the first item in the list.
+     * @default true
+     */
+    searchableSelectOnSubmit?: boolean;
     /**
      * Templates to use for the widget.
      */

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.78.2 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! InstantSearch.js 4.79.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -6598,7 +6598,7 @@
 
   var sortAndMergeRecommendations_1 = sortAndMergeRecommendations;
 
-  var version = '3.25.0';
+  var version = '3.26.0';
 
   var escapeFacetValue$4 = escapeFacetValue_1.escapeFacetValue;
 
@@ -7034,6 +7034,16 @@
       query: query,
     });
 
+    var hide =
+      (this.lastResults &&
+        this.lastResults.index === state.index &&
+        this.lastResults.renderingContent &&
+        this.lastResults.renderingContent.facetOrdering &&
+        this.lastResults.renderingContent.facetOrdering.values &&
+        this.lastResults.renderingContent.facetOrdering.values[facet] &&
+        this.lastResults.renderingContent.facetOrdering.values[facet].hide) ||
+      [];
+
     return searchForFacetValuesPromise.then(
       function addIsRefined(content) {
         self._currentNbQueries--;
@@ -7041,7 +7051,11 @@
 
         content = Array.isArray(content) ? content[0] : content;
 
-        content.facetHits.forEach(function (f) {
+        content.facetHits.forEach(function (f, i) {
+          if (hide.indexOf(f.value) > -1) {
+            content.facetHits.splice(i, 1);
+            return;
+          }
           f.escapedValue = escapeFacetValue$4(f.value);
           f.isRefined = isDisjunctive
             ? state.isDisjunctiveFacetRefined(facet, f.escapedValue)
@@ -10280,9 +10294,11 @@
             state: normalizeState(state)
           }) || {};
           var banner = results === null || results === void 0 ? void 0 : (_results$renderingCon = results.renderingContent) === null || _results$renderingCon === void 0 ? void 0 : (_results$renderingCon2 = _results$renderingCon.widgets) === null || _results$renderingCon2 === void 0 ? void 0 : (_results$renderingCon3 = _results$renderingCon2.banners) === null || _results$renderingCon3 === void 0 ? void 0 : _results$renderingCon3[0];
-          if (!results) {
+          if (!showPrevious) {
             showPrevious = getShowPrevious(helper);
             showMore = getShowMore(helper);
+          }
+          if (!sendEvent) {
             sendEvent = createSendEventForHits({
               instantSearchInstance: instantSearchInstance,
               helper: helper,
@@ -10293,6 +10309,8 @@
               widgetType: this.$$type,
               instantSearchInstance: instantSearchInstance
             });
+          }
+          if (!results) {
             isFirstPage = state.page === undefined || getFirstReceivedPage(state, cachedHits) === 0;
           } else {
             var _state$disjunctiveFac, _state$hierarchicalFa;
@@ -12674,9 +12692,7 @@
             if (!results || state.hierarchicalFacets.length === 0) {
               return [];
             }
-            var _state$hierarchicalFa = _slicedToArray(state.hierarchicalFacets, 1),
-              facetName = _state$hierarchicalFa[0].name;
-            var facetValues = results.getFacetValues(facetName, {});
+            var facetValues = results.getFacetValues(hierarchicalFacetName, {});
             var facetItems = facetValues && !Array.isArray(facetValues) && facetValues.data ? facetValues.data : [];
             var items = transformItems(shiftItemsValues(prepareItems(facetItems)), {
               results: results
@@ -14306,10 +14322,14 @@
           var insightsClientWithLocalCredentials = insightsClient;
           if (isModernInsightsClient(insightsClient)) {
             insightsClientWithLocalCredentials = function insightsClientWithLocalCredentials(method, payload) {
+              var _getAppIdAndApiKey3 = getAppIdAndApiKey(instantSearchInstance.client),
+                _getAppIdAndApiKey4 = _slicedToArray(_getAppIdAndApiKey3, 2),
+                latestAppId = _getAppIdAndApiKey4[0],
+                latestApiKey = _getAppIdAndApiKey4[1];
               var extraParams = {
                 headers: {
-                  'X-Algolia-Application-Id': appId,
-                  'X-Algolia-API-Key': apiKey
+                  'X-Algolia-Application-Id': latestAppId,
+                  'X-Algolia-API-Key': latestApiKey
                 }
               };
 
@@ -16414,7 +16434,7 @@
     };
   }
 
-  var version$1 = '4.78.2';
+  var version$1 = '4.79.0';
 
   var withUsage$v = createDocumentationMessageGenerator({
     name: 'instantsearch'
@@ -16467,6 +16487,8 @@
       _defineProperty(_assertThisInitialized(_this), "_searchStalledTimer", void 0);
       _defineProperty(_assertThisInitialized(_this), "_initialUiState", void 0);
       _defineProperty(_assertThisInitialized(_this), "_initialResults", void 0);
+      _defineProperty(_assertThisInitialized(_this), "_manuallyResetScheduleSearch", false);
+      _defineProperty(_assertThisInitialized(_this), "_resetScheduleSearch", void 0);
       _defineProperty(_assertThisInitialized(_this), "_createURL", void 0);
       _defineProperty(_assertThisInitialized(_this), "_searchFunction", void 0);
       _defineProperty(_assertThisInitialized(_this), "_mainHelperSearch", void 0);
@@ -16875,14 +16897,25 @@
           // because we already have the results to render. This skips the initial
           // network request on the browser on `start`.
           this.scheduleSearch = defer(noop);
-          // We also skip the initial network request when widgets are dynamically
-          // added in the first tick (that's the case in all the framework-based flavors).
-          // When we add a widget to `index`, it calls `scheduleSearch`. We can rely
-          // on our `defer` util to restore the original `scheduleSearch` value once
-          // widgets are added to hook back to the regular lifecycle.
-          defer(function () {
-            _this3.scheduleSearch = originalScheduleSearch;
-          })();
+          if (this._manuallyResetScheduleSearch) {
+            // If `_manuallyResetScheduleSearch` is passed, it means that we don't
+            // want to rely on a single `defer` to reset the `scheduleSearch`.
+            // Instead, the consumer will call `_resetScheduleSearch` to restore
+            // the original `scheduleSearch` function.
+            // This happens in the React flavour after rendering.
+            this._resetScheduleSearch = function () {
+              _this3.scheduleSearch = originalScheduleSearch;
+            };
+          } else {
+            // We also skip the initial network request when widgets are dynamically
+            // added in the first tick (that's the case in all the framework-based flavors).
+            // When we add a widget to `index`, it calls `scheduleSearch`. We can rely
+            // on our `defer` util to restore the original `scheduleSearch` value once
+            // widgets are added to hook back to the regular lifecycle.
+            defer(function () {
+              _this3.scheduleSearch = originalScheduleSearch;
+            })();
+          }
         }
         // We only schedule a search when widgets have been added before `start()`
         // because there are listeners that can use these results.
@@ -20810,6 +20843,9 @@
     }, {
       key: "refineFirstValue",
       value: function refineFirstValue() {
+        if (this.props.searchableSelectOnSubmit === false) {
+          return;
+        }
         var firstValue = this.props.facetValues && this.props.facetValues[0];
         if (firstValue) {
           var actualValue = firstValue.value;
@@ -24119,7 +24155,8 @@
       showMore = _ref.showMore,
       searchable = _ref.searchable,
       searchablePlaceholder = _ref.searchablePlaceholder,
-      searchableIsAlwaysActive = _ref.searchableIsAlwaysActive;
+      searchableIsAlwaysActive = _ref.searchableIsAlwaysActive,
+      searchableSelectOnSubmit = _ref.searchableSelectOnSubmit;
     return function (_ref2, isFirstRendering) {
       var refine = _ref2.refine,
         items = _ref2.items,
@@ -24159,7 +24196,8 @@
         toggleShowMore: toggleShowMore,
         isShowingMore: isShowingMore,
         hasExhaustiveItems: hasExhaustiveItems,
-        canToggleShowMore: canToggleShowMore
+        canToggleShowMore: canToggleShowMore,
+        searchableSelectOnSubmit: searchableSelectOnSubmit
       }), containerNode);
     };
   };
@@ -24199,6 +24237,8 @@
       searchableEscapeFacetValues = _ref3$searchableEscap === void 0 ? true : _ref3$searchableEscap,
       _ref3$searchableIsAlw = _ref3.searchableIsAlwaysActive,
       searchableIsAlwaysActive = _ref3$searchableIsAlw === void 0 ? true : _ref3$searchableIsAlw,
+      _ref3$searchableSelec = _ref3.searchableSelectOnSubmit,
+      searchableSelectOnSubmit = _ref3$searchableSelec === void 0 ? true : _ref3$searchableSelec,
       _ref3$cssClasses = _ref3.cssClasses,
       userCssClasses = _ref3$cssClasses === void 0 ? {} : _ref3$cssClasses,
       _ref3$templates = _ref3.templates,
@@ -24290,6 +24330,7 @@
       searchable: searchable,
       searchablePlaceholder: searchablePlaceholder,
       searchableIsAlwaysActive: searchableIsAlwaysActive,
+      searchableSelectOnSubmit: searchableSelectOnSubmit,
       showMore: showMore
     });
     var makeWidget = connectRefinementList(specializedRenderer, function () {