algoliasearch-helper 3.12.0 → 3.13.1

package/CHANGELOG

@@ -1,3 +1,13 @@
+3.13.1 - 2023-06-12
+ * docs(site): follow-up improvements  (#939) https://github.com/algolia/algoliasearch-helper-js/commit/6a36194d425b2446c6406e74df75c87bf5028454
+ * docs: upgrade and simplify tools (#937) https://github.com/algolia/algoliasearch-helper-js/commit/19ccf0b5e6ea00272223f998b05bd3c8f2d904d6
+ * docs: upgrade and simplify tools (#937) https://github.com/algolia/algoliasearch-helper-js/commit/d352cc46d506448b9802e3daa756ff1e9e873886
+ * fix(SearchResults): use empty facets object for exclusion when results are artificial (#940) https://github.com/algolia/algoliasearch-helper-js/commit/a51e8cb37e10c41ca816be1630bab2078980947b
+
+3.13.0 - 2023-05-03
+ * chore: delete renovate (#936) https://github.com/algolia/algoliasearch-helper-js/commit/0e3d8cff722d4a91a04251533636f0860ef3828c
+ * feat(DerivedHelper): skip request for empty index (#938) https://github.com/algolia/algoliasearch-helper-js/commit/79caa4b0ca2537c0f4431ee11556464031935436
+
 3.12.0 - 2023-03-03
  * feat(types): add `queryAfterRemoval` to `SearchResults` (#934) https://github.com/algolia/algoliasearch-helper-js/commit/4fb5a0345f0cf438fb026d8010faf843bd3b0a01
 

package/dist/algoliasearch.helper.js

@@ -2664,7 +2664,10 @@ function SearchResults(state, results, options) {
 
   /**
    * sum of the processing time of all the queries
+   * @name processingTimeMS
    * @member {number}
+   * @memberof SearchResults
+   * @instance
    */
   this.processingTimeMS = results.reduce(function(sum, result) {
     return result.processingTimeMS === undefined
@@ -2870,7 +2873,7 @@ function SearchResults(state, results, options) {
 
     self.facets[position] = {
       name: facetName,
-      data: mainSubResponse.facets[facetName],
+      data: mainFacets[facetName],
       exhaustive: mainSubResponse.exhaustiveFacetsCount
     };
     excludes.forEach(function(facetValue) {
@@ -2953,7 +2956,33 @@ function extractNormalizedFacetValues(results, attribute) {
       };
     });
   } else if (results._state.isHierarchicalFacet(attribute)) {
-    return find(results.hierarchicalFacets, predicate);
+    var hierarchicalFacetValues = find(results.hierarchicalFacets, predicate);
+    if (!hierarchicalFacetValues) return hierarchicalFacetValues;
+
+    var hierarchicalFacet = results._state.getHierarchicalFacetByName(attribute);
+    var currentRefinementSplit = unescapeFacetValue(
+      results._state.getHierarchicalRefinement(attribute)[0] || ''
+    ).split(results._state._getHierarchicalFacetSeparator(hierarchicalFacet));
+    currentRefinementSplit.unshift(attribute);
+
+    setIsRefined(hierarchicalFacetValues, currentRefinementSplit, 0);
+
+    return hierarchicalFacetValues;
+  }
+}
+
+/**
+ * Set the isRefined of a hierarchical facet result based on the current state.
+ * @param {SearchResults.HierarchicalFacet} item Hierarchical facet to fix
+ * @param {string[]} currentRefinementSplit array of parts of the current hierarchical refinement
+ * @param {number} depth recursion depth in the currentRefinement
+ */
+function setIsRefined(item, currentRefinement, depth) {
+  item.isRefined = item.name === currentRefinement[depth];
+  if (item.data) {
+    item.data.forEach(function(child) {
+      setIsRefined(child, currentRefinement, depth + 1);
+    });
   }
 }
 
@@ -3577,8 +3606,10 @@ AlgoliaSearchHelper.prototype.searchOnce = function(options, cb) {
  * @param {number} options.nbHits - Maximum number of answers to retrieve from the Answers Engine. Cannot be greater than 1000.
  *
  * @return {promise} the answer results
+ * @deprecated answers is deprecated and will be replaced with new initiatives
  */
 AlgoliaSearchHelper.prototype.findAnswers = function(options) {
+  console.warn('[algoliasearch-helper] answers is no longer supported');
   var state = this.state;
   var derivedHelper = this.derivedHelpers[0];
   if (!derivedHelper) {
@@ -4591,7 +4622,9 @@ AlgoliaSearchHelper.prototype._search = function(options) {
 
   var derivedQueries = this.derivedHelpers.map(function(derivedHelper) {
     var derivedState = derivedHelper.getModifiedState(state);
-    var derivedStateQueries = requestBuilder._getQueries(derivedState.index, derivedState);
+    var derivedStateQueries = derivedState.index
+      ? requestBuilder._getQueries(derivedState.index, derivedState)
+      : [];
 
     states.push({
       state: derivedState,
@@ -4608,10 +4641,16 @@ AlgoliaSearchHelper.prototype._search = function(options) {
   });
 
   var queries = Array.prototype.concat.apply(mainQueries, derivedQueries);
-  var queryId = this._queryId++;
 
+  var queryId = this._queryId++;
   this._currentNbQueries++;
 
+  if (!queries.length) {
+    return Promise.resolve({results: []}).then(
+      this._dispatchAlgoliaResponse.bind(this, states, queryId)
+    );
+  }
+
   try {
     this.client.search(queries)
       .then(this._dispatchAlgoliaResponse.bind(this, states, queryId))
@@ -4656,6 +4695,14 @@ AlgoliaSearchHelper.prototype._dispatchAlgoliaResponse = function(states, queryI
     var helper = s.helper;
     var specificResults = results.splice(0, queriesCount);
 
+    if (!state.index) {
+      helper.emit('result', {
+        results: null,
+        state: state
+      });
+      return;
+    }
+
     var formattedResponse = helper.lastResults = new SearchResults(state, specificResults);
 
     helper.emit('result', {
@@ -5007,7 +5054,8 @@ function _merge(target, source) {
   for (var key in source) {
     if (
       !Object.prototype.hasOwnProperty.call(source, key) ||
-      key === '__proto__'
+      key === '__proto__' ||
+      key === 'constructor'
     ) {
       continue;
     }
@@ -5587,7 +5635,7 @@ module.exports = function isValidUserToken(userToken) {
 },{}],24:[function(require,module,exports){
 'use strict';
 
-module.exports = '3.11.1';
+module.exports = '3.13.1';
 
 },{}]},{},[1])(1)
 });