instantsearch.js 4.41.0 → 4.42.0

package/CHANGELOG.md

@@ -1,3 +1,37 @@
+# [4.42.0](https://github.com/algolia/instantsearch.js/compare/v4.41.2...v4.42.0) (2022-06-21)
+
+
+### Bug Fixes
+
+* **es:** update import path for `infiniteHitsCache` in depreciation message ([#5068](https://github.com/algolia/instantsearch.js/issues/5068)) ([545cbaf](https://github.com/algolia/instantsearch.js/commit/545cbafd748bb8be32bff66ac60b5f3f9133a5b4))
+
+
+### Features
+
+* **core:** sort parameters & support client.search for sffv ([#5069](https://github.com/algolia/instantsearch.js/issues/5069)) ([34e2b00](https://github.com/algolia/instantsearch.js/commit/34e2b00cbc93f1bc86ee0abaec6b6e132bd18354))
+
+
+
+## [4.41.2](https://github.com/algolia/instantsearch.js/compare/v4.41.1...v4.41.2) (2022-06-15)
+
+
+### Bug Fixes
+
+* **hierarchicalMenu:** show full hierarchical parent values ([#5063](https://github.com/algolia/instantsearch.js/issues/5063)) ([cd1db34](https://github.com/algolia/instantsearch.js/commit/cd1db34815f92acb3d2d0cec6c1ae7865d14fb13))
+
+
+
+## [4.41.1](https://github.com/algolia/instantsearch.js/compare/v4.41.0...v4.41.1) (2022-06-14)
+
+
+### Bug Fixes
+
+* **insights:** don't send view event if search is stalled ([#5058](https://github.com/algolia/instantsearch.js/issues/5058)) ([1686dfb](https://github.com/algolia/instantsearch.js/commit/1686dfb096cfce062e268feda7956e3b160bf2da)), closes [/github.com/algolia/instantsearch.js/blob/99f6fe1dc51e4815e5b9efcfb30e3e2f3127e763/src/lib/utils/createSendEventForHits.ts#L168](https://github.com//github.com/algolia/instantsearch.js/blob/99f6fe1dc51e4815e5b9efcfb30e3e2f3127e763/src/lib/utils/createSendEventForHits.ts/issues/L168) [/github.com/algolia/instantsearch.js/blob/55313e4ea4105b777f3f102e9f48a7e440496d25/src/middlewares/createInsightsMiddleware.ts#L144](https://github.com//github.com/algolia/instantsearch.js/blob/55313e4ea4105b777f3f102e9f48a7e440496d25/src/middlewares/createInsightsMiddleware.ts/issues/L144)
+* **types:** avoid inferring UiState type from initialUiState ([#5061](https://github.com/algolia/instantsearch.js/issues/5061)) ([80ca07e](https://github.com/algolia/instantsearch.js/commit/80ca07e29064357343ee997be94ef10beadba637)), closes [/github.com/Microsoft/TypeScript/issues/14829#issuecomment-504042546](https://github.com//github.com/Microsoft/TypeScript/issues/14829/issues/issuecomment-504042546) [#5060](https://github.com/algolia/instantsearch.js/issues/5060)
+* **types:** make all usages of UiState in InstantSearch generic ([#5060](https://github.com/algolia/instantsearch.js/issues/5060)) ([2b9e76b](https://github.com/algolia/instantsearch.js/commit/2b9e76b568fb4d4cc5bd49c384ee583d84d6f39a))
+
+
+
 # [4.41.0](https://github.com/algolia/instantsearch.js/compare/v4.40.6...v4.41.0) (2022-06-01)
 
 

package/cjs/lib/InstantSearch.js

@@ -61,10 +61,9 @@ var withUsage = (0, _index2.createDocumentationMessageGenerator)({
 
 function defaultCreateURL() {
   return '#';
-}
-/**
- * Global options for an InstantSearch instance.
- */
+} // this purposely breaks typescript's type inference to ensure it's not used
+// as it's used for a default parameter for example
+// source: https://github.com/Microsoft/TypeScript/issues/14829#issuecomment-504042546
 
 
 /**

package/cjs/lib/utils/createSendEventForHits.js

@@ -25,7 +25,8 @@ var buildPayloads = function buildPayloads(_ref) {
   var index = _ref.index,
       widgetType = _ref.widgetType,
       methodName = _ref.methodName,
-      args = _ref.args;
+      args = _ref.args,
+      isSearchStalled = _ref.isSearchStalled;
 
   // when there's only one argument, that means it's custom
   if (args.length === 1 && _typeof(args[0]) === 'object') {
@@ -72,6 +73,10 @@ var buildPayloads = function buildPayloads(_ref) {
   });
 
   if (eventType === 'view') {
+    if (isSearchStalled) {
+      return [];
+    }
+
     return hitsChunks.map(function (batch, i) {
       return {
         insightsMethod: 'viewedObjectIDs',
@@ -142,7 +147,8 @@ function createSendEventForHits(_ref2) {
       widgetType: widgetType,
       index: index,
       methodName: 'sendEvent',
-      args: args
+      args: args,
+      isSearchStalled: instantSearchInstance._isSearchStalled
     });
     payloads.forEach(function (payload) {
       return instantSearchInstance.sendEventToInsights(payload);
@@ -165,7 +171,8 @@ function createBindEventForHits(_ref3) {
       widgetType: widgetType,
       index: index,
       methodName: 'bindEvent',
-      args: args
+      args: args,
+      isSearchStalled: false
     });
     return payloads.length ? "data-insights-event=".concat((0, _serializer.serializePayload)(payloads)) : '';
   };

package/cjs/lib/version.js

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

package/dist/instantsearch.development.d.ts

@@ -2286,7 +2286,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     client: InstantSearchOptions['searchClient'];
     indexName: string;
     insightsClient: InsightsClient | null;
-    onStateChange: InstantSearchOptions['onStateChange'] | null;
+    onStateChange: InstantSearchOptions<TUiState>['onStateChange'] | null;
     helper: AlgoliaSearchHelper | null;
     mainHelper: AlgoliaSearchHelper | null;
     mainIndex: IndexWidget;
@@ -2296,9 +2296,9 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     _stalledSearchDelay: number;
     _searchStalledTimer: any;
     _isSearchStalled: boolean;
-    _initialUiState: UiState;
+    _initialUiState: TUiState;
     _initialResults: InitialResults | null;
-    _createURL: CreateURL<UiState>;
+    _createURL: CreateURL<TUiState>;
     _searchFunction?: InstantSearchOptions['searchFunction'];
     _mainHelperSearch?: AlgoliaSearchHelper['search'];
     middleware: Array<{
@@ -2368,13 +2368,13 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
         cancel(): void;
     };
     scheduleStalledRender(): void;
-    setUiState(uiState: UiState | ((previousUiState: UiState) => UiState)): void;
-    getUiState(): UiState;
+    setUiState(uiState: TUiState | ((previousUiState: TUiState) => TUiState)): void;
+    getUiState(): TUiState;
     onInternalStateChange: ((...args: any[]) => void) & {
         wait(): Promise<void>;
         cancel(): void;
     };
-    createURL(nextState?: UiState): string;
+    createURL(nextState?: TUiState): string;
     refresh(): void;
 }
 
@@ -2466,8 +2466,8 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * become in charge of updating the UI state with the `setUiState` function.
      */
     onStateChange?: (params: {
-        uiState: UiState;
-        setUiState(uiState: UiState | ((previousUiState: UiState) => UiState)): void;
+        uiState: TUiState;
+        setUiState(uiState: TUiState | ((previousUiState: TUiState) => TUiState)): void;
     }) => void;
     /**
      * Injects a `uiState` to the `instantsearch` instance. You can use this option
@@ -2475,7 +2475,7 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * for the first search. To unconditionally pass additional parameters to the
      * Algolia API, take a look at the `configure` widget.
      */
-    initialUiState?: TUiState;
+    initialUiState?: NoInfer<TUiState>;
     /**
      * Time before a search is considered stalled. The default is 200ms
      */
@@ -2779,6 +2779,8 @@ declare namespace middlewares {
     }
 }
 
+declare type NoInfer<T> = [T][T extends any ? 0 : never];
+
 declare const numericMenu: NumericMenuWidget;
 
 declare type NumericMenuComponentCSSClasses = ComponentCSSClasses<NumericMenuCSSClasses>;

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.41.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.42.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) :
@@ -2989,7 +2989,7 @@
       nextDisjunctiveResult++;
     });
 
-    // if we have some root level values for hierarchical facets, merge them
+    // if we have some parent level values for hierarchical facets, merge them
     state.getRefinedHierarchicalFacets().forEach(function(refinedFacet) {
       var hierarchicalFacet = state.getHierarchicalFacetByName(refinedFacet);
       var separator = state._getHierarchicalFacetSeparator(hierarchicalFacet);
@@ -3001,47 +3001,49 @@
         return;
       }
 
-      var result = results[nextDisjunctiveResult];
-      var facets = result && result.facets
-        ? result.facets
-        : {};
-      Object.keys(facets).forEach(function(dfacet) {
-        var facetResults = facets[dfacet];
-        var position = findIndex(state.hierarchicalFacets, function(f) {
-          return f.name === hierarchicalFacet.name;
-        });
-        var attributeIndex = findIndex(self.hierarchicalFacets[position], function(f) {
-          return f.attribute === dfacet;
-        });
+      results.slice(nextDisjunctiveResult).forEach(function(result) {
+        var facets = result && result.facets
+          ? result.facets
+          : {};
 
-        // previous refinements and no results so not able to find it
-        if (attributeIndex === -1) {
-          return;
-        }
+        Object.keys(facets).forEach(function(dfacet) {
+          var facetResults = facets[dfacet];
+          var position = findIndex(state.hierarchicalFacets, function(f) {
+            return f.name === hierarchicalFacet.name;
+          });
+          var attributeIndex = findIndex(self.hierarchicalFacets[position], function(f) {
+            return f.attribute === dfacet;
+          });
 
-        // when we always get root levels, if the hits refinement is `beers > IPA` (count: 5),
-        // then the disjunctive values will be `beers` (count: 100),
-        // but we do not want to display
-        //   | beers (100)
-        //     > IPA (5)
-        // We want
-        //   | beers (5)
-        //     > IPA (5)
-        var defaultData = {};
-
-        if (currentRefinement.length > 0) {
-          var root = currentRefinement[0].split(separator)[0];
-          defaultData[root] = self.hierarchicalFacets[position][attributeIndex].data[root];
-        }
+          // previous refinements and no results so not able to find it
+          if (attributeIndex === -1) {
+            return;
+          }
 
-        self.hierarchicalFacets[position][attributeIndex].data = defaultsPure(
-          defaultData,
-          facetResults,
-          self.hierarchicalFacets[position][attributeIndex].data
-        );
-      });
+          // when we always get root levels, if the hits refinement is `beers > IPA` (count: 5),
+          // then the disjunctive values will be `beers` (count: 100),
+          // but we do not want to display
+          //   | beers (100)
+          //     > IPA (5)
+          // We want
+          //   | beers (5)
+          //     > IPA (5)
+          var defaultData = {};
+
+          if (currentRefinement.length > 0) {
+            var root = currentRefinement[0].split(separator)[0];
+            defaultData[root] = self.hierarchicalFacets[position][attributeIndex].data[root];
+          }
 
-      nextDisjunctiveResult++;
+          self.hierarchicalFacets[position][attributeIndex].data = defaultsPure(
+            defaultData,
+            facetResults,
+            self.hierarchicalFacets[position][attributeIndex].data
+          );
+        });
+
+        nextDisjunctiveResult++;
+      });
     });
 
     // add the excludes
@@ -3845,6 +3847,17 @@
 
   var DerivedHelper_1 = DerivedHelper;
 
+  function sortObject(obj) {
+    return Object.keys(obj)
+      .sort(function(a, b) {
+        return a.localeCompare(b);
+      })
+      .reduce(function(acc, curr) {
+        acc[curr] = obj[curr];
+        return acc;
+      }, {});
+  }
+
   var requestBuilder = {
     /**
      * Get all the queries to send to the client, those queries can used directly
@@ -3869,18 +3882,38 @@
         });
       });
 
-      // maybe more to get the root level of hierarchical facets when activated
+      // More to get the parent levels of the hierarchical facets when refined
       state.getRefinedHierarchicalFacets().forEach(function(refinedFacet) {
         var hierarchicalFacet = state.getHierarchicalFacetByName(refinedFacet);
-
         var currentRefinement = state.getHierarchicalRefinement(refinedFacet);
-        // if we are deeper than level 0 (starting from `beer > IPA`)
-        // we want to get the root values
         var separator = state._getHierarchicalFacetSeparator(hierarchicalFacet);
+
+        // If we are deeper than level 0 (starting from `beer > IPA`)
+        // we want to get all parent values
         if (currentRefinement.length > 0 && currentRefinement[0].split(separator).length > 1) {
-          queries.push({
-            indexName: index,
-            params: requestBuilder._getDisjunctiveFacetSearchParams(state, refinedFacet, true)
+          // We generate a map of the filters we will use for our facet values queries
+          var filtersMap = currentRefinement[0].split(separator).slice(0, -1).reduce(
+            function createFiltersMap(map, segment, level) {
+              return map.concat({
+                attribute: hierarchicalFacet.attributes[level],
+                value: level === 0
+                  ? segment
+                  : [map[map.length - 1].value, segment].join(separator)
+              });
+            }
+          , []);
+
+          filtersMap.forEach(function(filter, level) {
+            var params = requestBuilder._getDisjunctiveFacetSearchParams(
+              state,
+              filter.attribute,
+              level === 0
+            );
+
+            var parent = filtersMap[level - 1];
+            params.facetFilters = level > 0 ? [parent.attribute + ':' + parent.value] : undefined;
+
+            queries.push({indexName: index, params: params});
           });
         }
       });
@@ -3915,7 +3948,7 @@
         additionalParams.numericFilters = numericFilters;
       }
 
-      return merge_1({}, state.getQueryParams(), additionalParams);
+      return sortObject(merge_1({}, state.getQueryParams(), additionalParams));
     },
 
     /**
@@ -3960,7 +3993,7 @@
         additionalParams.facetFilters = facetFilters;
       }
 
-      return merge_1({}, state.getQueryParams(), additionalParams);
+      return sortObject(merge_1({}, state.getQueryParams(), additionalParams));
     },
 
     /**
@@ -4153,17 +4186,17 @@
       if (typeof maxFacetHits === 'number') {
         searchForFacetSearchParameters.maxFacetHits = maxFacetHits;
       }
-      return merge_1(
+      return sortObject(merge_1(
         {},
         requestBuilder._getHitsSearchParams(stateForSearchForFacetValues),
         searchForFacetSearchParameters
-      );
+      ));
     }
   };
 
   var requestBuilder_1 = requestBuilder;
 
-  var version = '3.8.2';
+  var version = '3.9.0';
 
   var escapeFacetValue$3 = escapeFacetValue_1.escapeFacetValue;
 
@@ -4483,20 +4516,51 @@
    */
   AlgoliaSearchHelper.prototype.searchForFacetValues = function(facet, query, maxFacetHits, userState) {
     var clientHasSFFV = typeof this.client.searchForFacetValues === 'function';
+    var clientHasInitIndex = typeof this.client.initIndex === 'function';
     if (
       !clientHasSFFV &&
-      typeof this.client.initIndex !== 'function'
+      !clientHasInitIndex &&
+      typeof this.client.search !== 'function'
     ) {
       throw new Error(
         'search for facet values (searchable) was called, but this client does not have a function client.searchForFacetValues or client.initIndex(index).searchForFacetValues'
       );
     }
+
     var state = this.state.setQueryParameters(userState || {});
     var isDisjunctive = state.isDisjunctiveFacet(facet);
     var algoliaQuery = requestBuilder_1.getSearchForFacetQuery(facet, query, maxFacetHits, state);
 
     this._currentNbQueries++;
     var self = this;
+    var searchForFacetValuesPromise;
+    // newer algoliasearch ^3.27.1 - ~4.0.0
+    if (clientHasSFFV) {
+      searchForFacetValuesPromise = this.client.searchForFacetValues([
+        {indexName: state.index, params: algoliaQuery}
+      ]);
+      // algoliasearch < 3.27.1
+    } else if (clientHasInitIndex) {
+      searchForFacetValuesPromise = this.client
+        .initIndex(state.index)
+        .searchForFacetValues(algoliaQuery);
+      // algoliasearch ~5.0.0
+    } else {
+      // @MAJOR only use client.search
+      delete algoliaQuery.facetName;
+      searchForFacetValuesPromise = this.client
+        .search([
+          {
+            type: 'facet',
+            facet: facet,
+            indexName: state.index,
+            params: algoliaQuery
+          }
+        ])
+        .then(function processResponse(response) {
+          return response.results[0];
+        });
+    }
 
     this.emit('searchForFacetValues', {
       state: state,
@@ -4504,10 +4568,6 @@
       query: query
     });
 
-    var searchForFacetValuesPromise = clientHasSFFV
-      ? this.client.searchForFacetValues([{indexName: state.index, params: algoliaQuery}])
-      : this.client.initIndex(state.index).searchForFacetValues(algoliaQuery);
-
     return searchForFacetValuesPromise.then(function addIsRefined(content) {
       self._currentNbQueries--;
       if (self._currentNbQueries === 0) self.emit('searchQueueEmpty');
@@ -7692,7 +7752,8 @@
     var index = _ref.index,
         widgetType = _ref.widgetType,
         methodName = _ref.methodName,
-        args = _ref.args;
+        args = _ref.args,
+        isSearchStalled = _ref.isSearchStalled;
 
     // when there's only one argument, that means it's custom
     if (args.length === 1 && _typeof(args[0]) === 'object') {
@@ -7735,6 +7796,10 @@
     });
 
     if (eventType === 'view') {
+      if (isSearchStalled) {
+        return [];
+      }
+
       return hitsChunks.map(function (batch, i) {
         return {
           insightsMethod: 'viewedObjectIDs',
@@ -7803,7 +7868,8 @@
         widgetType: widgetType,
         index: index,
         methodName: 'sendEvent',
-        args: args
+        args: args,
+        isSearchStalled: instantSearchInstance._isSearchStalled
       });
       payloads.forEach(function (payload) {
         return instantSearchInstance.sendEventToInsights(payload);
@@ -7825,7 +7891,8 @@
         widgetType: widgetType,
         index: index,
         methodName: 'bindEvent',
-        args: args
+        args: args,
+        isSearchStalled: false
       });
       return payloads.length ? "data-insights-event=".concat(serializePayload(payloads)) : '';
     };
@@ -8536,7 +8603,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.41.0';
+  var version$1 = '4.42.0';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -10026,10 +10093,9 @@
 
   function defaultCreateURL() {
     return '#';
-  }
-  /**
-   * Global options for an InstantSearch instance.
-   */
+  } // this purposely breaks typescript's type inference to ensure it's not used
+  // as it's used for a default parameter for example
+  // source: https://github.com/Microsoft/TypeScript/issues/14829#issuecomment-504042546
 
 
   /**