instantsearch.js 4.41.1 → 4.43.0

package/CHANGELOG.md

@@ -1,3 +1,35 @@
+# [4.43.0](https://github.com/algolia/instantsearch.js/compare/v4.42.0...v4.43.0) (2022-06-28)
+
+
+### Features
+
+* **types:** support algoliasearch v5 ([#5066](https://github.com/algolia/instantsearch.js/issues/5066)) ([3eb4dc7](https://github.com/algolia/instantsearch.js/commit/3eb4dc75a5935f2ee4fead8787f39af0150b24c4))
+
+
+
+# [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)
 
 

package/cjs/lib/version.js

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

package/cjs/types/algoliasearch.js

@@ -1 +1,18 @@
-"use strict";
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _algoliasearch = require("algoliasearch-helper/types/algoliasearch.js");
+
+Object.keys(_algoliasearch).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _algoliasearch[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _algoliasearch[key];
+    }
+  });
+});

package/dist/instantsearch.development.d.ts

@@ -1,14 +1,14 @@
 /// <reference types="google.maps" />
 
-import type algoliasearch from 'algoliasearch/lite';
 import type { AlgoliaSearchHelper } from 'algoliasearch-helper';
-import type * as ClientSearch from '@algolia/client-search';
 import EventEmitter from '@algolia/events';
+import { FindAnswersOptions } from 'algoliasearch-helper/types/algoliasearch.js';
 import type { InsightsClient as InsightsClient_2 } from 'search-insights';
 import type { InsightsMethodMap } from 'search-insights';
 import type * as Places from 'places.js';
 import type { PlainSearchParameters } from 'algoliasearch-helper';
 import { default as qs_2 } from 'qs';
+import { SearchClient } from 'algoliasearch-helper/types/algoliasearch.js';
 import type { SearchParameters } from 'algoliasearch-helper';
 import type { SearchResults } from 'algoliasearch-helper';
 
@@ -1075,18 +1075,12 @@ declare type CustomSendEventForHits = (customPayload: any) => void;
 
 declare type CustomSendEventForToggle = (customPayload: any) => void;
 
-declare type DefaultSearchClient = ReturnType<typeof algoliasearch>;
-
 declare type DisposeOptions = {
     helper: AlgoliaSearchHelper;
     state: SearchParameters;
     parent: IndexWidget;
 };
 
-declare type DummySearchClientV4 = {
-    readonly transporter: any;
-};
-
 declare const dynamicWidgets: DynamicWidgetsWidget;
 
 declare type DynamicWidgetsConnector = Connector<DynamicWidgetsWidgetDescription, DynamicWidgetsConnectorParams>;
@@ -1175,8 +1169,6 @@ declare const EXPERIMENTAL_connectDynamicWidgets: DynamicWidgetsConnector;
 /** @deprecated use dynamicWidgets */
 declare const EXPERIMENTAL_dynamicWidgets: DynamicWidgetsWidget;
 
-declare type FindAnswersOptions = DefaultSearchClient extends DummySearchClientV4 ? ClientSearch.FindAnswersOptions : any;
-
 declare type GeoHit = Hit & Required<Pick<Hit, '_geoLoc'>>;
 
 declare type GeoLoc = {
@@ -4582,17 +4574,6 @@ declare type SearchBoxWidgetParams = {
     queryHook?: (query: string, hook: (value: string) => void) => void;
 };
 
-declare type SearchClient = {
-    search: DefaultSearchClient['search'];
-    searchForFacetValues: DefaultSearchClient['searchForFacetValues'];
-    addAlgoliaAgent?: DefaultSearchClient['addAlgoliaAgent'];
-    initIndex?: (indexName: string) => SearchIndex extends {
-        findAnswers: any;
-    } ? Partial<Pick<SearchIndex, 'findAnswers'>> : SearchIndex;
-};
-
-declare type SearchIndex = ReturnType<DefaultSearchClient['initIndex']>;
-
 declare type SendEvent = (...args: [InsightsEvent] | [string, string, string?]) => void;
 
 declare type SendEventForFacet = BuiltInSendEventForFacet & CustomSendEventForFacet;

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.41.1 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.43.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));
     },
 
     /**
@@ -3930,16 +3963,16 @@
       var numericFilters = requestBuilder._getNumericFilters(state, facet);
       var tagFilters = requestBuilder._getTagFilters(state);
       var additionalParams = {
-        hitsPerPage: 1,
+        hitsPerPage: 0,
         page: 0,
-        attributesToRetrieve: [],
-        attributesToHighlight: [],
-        attributesToSnippet: [],
-        tagFilters: tagFilters,
         analytics: false,
         clickAnalytics: false
       };
 
+      if (tagFilters.length > 0) {
+        additionalParams.tagFilters = tagFilters;
+      }
+
       var hierarchicalFacet = state.getHierarchicalFacetByName(facet);
 
       if (hierarchicalFacet) {
@@ -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.10.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');
@@ -8543,7 +8603,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.41.1';
+  var version$1 = '4.43.0';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {