algoliasearch-helper 3.18.0 → 3.20.0

package/dist/algoliasearch.helper.js

@@ -383,7 +383,7 @@ algoliasearchHelper.SearchResults = SearchResults;
 
 module.exports = algoliasearchHelper;
 
-},{"./src/RecommendParameters":4,"./src/SearchParameters":6,"./src/SearchResults":8,"./src/algoliasearch.helper":9,"./src/version":25}],3:[function(require,module,exports){
+},{"./src/RecommendParameters":4,"./src/SearchParameters":7,"./src/SearchResults":9,"./src/algoliasearch.helper":10,"./src/version":28}],3:[function(require,module,exports){
 'use strict';
 
 var EventEmitter = require('@algolia/events');
@@ -433,7 +433,7 @@ DerivedHelper.prototype.getModifiedRecommendState = function (parameters) {
 
 module.exports = DerivedHelper;
 
-},{"../functions/inherits":16,"@algolia/events":1}],4:[function(require,module,exports){
+},{"../functions/inherits":18,"@algolia/events":1}],4:[function(require,module,exports){
 'use strict';
 
 /**
@@ -459,15 +459,8 @@ RecommendParameters.prototype = {
 
   addParams: function (params) {
     var newParams = this.params.slice();
-    var existingParamsIndex = this.params.findIndex(function (currentParams) {
-      return currentParams.$$id === params.$$id;
-    });
 
-    if (existingParamsIndex !== -1) {
-      newParams.splice(existingParamsIndex, 1, params);
-    } else {
-      newParams.push(params);
-    }
+    newParams.push(params);
 
     return new RecommendParameters({ params: newParams });
   },
@@ -510,13 +503,17 @@ RecommendParameters.prototype = {
     );
   },
 
-  _buildQueries: function (indexName) {
-    return this.params.map(function (params) {
-      var query = Object.assign({}, params, { indexName: indexName });
-      delete query.$$id;
+  _buildQueries: function (indexName, cache) {
+    return this.params
+      .filter(function (params) {
+        return cache[params.$$id] === undefined;
+      })
+      .map(function (params) {
+        var query = Object.assign({}, params, { indexName: indexName });
+        delete query.$$id;
 
-      return query;
-    });
+        return query;
+      });
   },
 };
 
@@ -525,6 +522,36 @@ module.exports = RecommendParameters;
 },{}],5:[function(require,module,exports){
 'use strict';
 
+/**
+ * Constructor for SearchResults
+ * @class
+ * @classdesc SearchResults contains the results of a query to Algolia using the
+ * {@link AlgoliaSearchHelper}.
+ * @param {RecommendParameters} state state that led to the response
+ * @param {Record<string,RecommendResultItem>} results the results from algolia client
+ **/
+function RecommendResults(state, results) {
+  this._state = state;
+  this._rawResults = results;
+
+  // eslint-disable-next-line consistent-this
+  var self = this;
+
+  state.params.forEach(function (param) {
+    var id = param.$$id;
+    self[id] = results[id];
+  });
+}
+
+RecommendResults.prototype = {
+  constructor: RecommendResults,
+};
+
+module.exports = RecommendResults;
+
+},{}],6:[function(require,module,exports){
+'use strict';
+
 /**
  * Functions to manipulate refinement lists
  *
@@ -696,7 +723,7 @@ var lib = {
 
 module.exports = lib;
 
-},{"../functions/defaultsPure":11,"../functions/objectHasKeys":19,"../functions/omit":20}],6:[function(require,module,exports){
+},{"../functions/defaultsPure":12,"../functions/objectHasKeys":21,"../functions/omit":22}],7:[function(require,module,exports){
 'use strict';
 
 var defaultsPure = require('../functions/defaultsPure');
@@ -2385,7 +2412,7 @@ SearchParameters.prototype = {
  */
 module.exports = SearchParameters;
 
-},{"../functions/defaultsPure":11,"../functions/find":13,"../functions/intersection":17,"../functions/merge":18,"../functions/objectHasKeys":19,"../functions/omit":20,"../functions/valToNumber":22,"../utils/isValidUserToken":24,"./RefinementList":5}],7:[function(require,module,exports){
+},{"../functions/defaultsPure":12,"../functions/find":14,"../functions/intersection":19,"../functions/merge":20,"../functions/objectHasKeys":21,"../functions/omit":22,"../functions/valToNumber":24,"../utils/isValidUserToken":26,"./RefinementList":6}],8:[function(require,module,exports){
 'use strict';
 
 module.exports = generateTrees;
@@ -2589,7 +2616,7 @@ function format(
   };
 }
 
-},{"../functions/escapeFacetValue":12,"../functions/find":13,"../functions/formatSort":15,"../functions/orderBy":21}],8:[function(require,module,exports){
+},{"../functions/escapeFacetValue":13,"../functions/find":14,"../functions/formatSort":17,"../functions/orderBy":23}],9:[function(require,module,exports){
 'use strict';
 
 var compact = require('../functions/compact');
@@ -3749,7 +3776,7 @@ function getHierarchicalRefinement(state, attributeName, name, resultsFacets) {
 
 module.exports = SearchResults;
 
-},{"../functions/compact":10,"../functions/defaultsPure":11,"../functions/escapeFacetValue":12,"../functions/find":13,"../functions/findIndex":14,"../functions/formatSort":15,"../functions/merge":18,"../functions/orderBy":21,"./generate-hierarchical-tree":7}],9:[function(require,module,exports){
+},{"../functions/compact":11,"../functions/defaultsPure":12,"../functions/escapeFacetValue":13,"../functions/find":14,"../functions/findIndex":15,"../functions/formatSort":17,"../functions/merge":20,"../functions/orderBy":23,"./generate-hierarchical-tree":8}],10:[function(require,module,exports){
 'use strict';
 
 var EventEmitter = require('@algolia/events');
@@ -3761,9 +3788,11 @@ var merge = require('./functions/merge');
 var objectHasKeys = require('./functions/objectHasKeys');
 var omit = require('./functions/omit');
 var RecommendParameters = require('./RecommendParameters');
+var RecommendResults = require('./RecommendResults');
 var requestBuilder = require('./requestBuilder');
 var SearchParameters = require('./SearchParameters');
 var SearchResults = require('./SearchResults');
+var sortAndMergeRecommendations = require('./utils/sortAndMergeRecommendations');
 var version = require('./version');
 
 /**
@@ -3892,6 +3921,7 @@ function AlgoliaSearchHelper(client, index, options, searchResultsOptions) {
   this._currentNbQueries = 0;
   this._currentNbRecommendQueries = 0;
   this._searchResultsOptions = searchResultsOptions;
+  this.recommendCache = {};
 }
 
 inherits(AlgoliaSearchHelper, EventEmitter);
@@ -4680,7 +4710,7 @@ AlgoliaSearchHelper.prototype.removeTag = function (tag) {
 /**
  * Removes a "frequently bought together" recommendation query.
  *
- * @param {string} id identifier of the recommendation widget
+ * @param {number} id identifier of the recommendation widget
  * @returns {AlgoliaSearchHelper} Method is chainable, it returns itself
  * @fires change
  * @chainable
@@ -4696,7 +4726,7 @@ AlgoliaSearchHelper.prototype.removeFrequentlyBoughtTogether = function (id) {
 /**
  * Removes a "related products" recommendation query.
  *
- * @param {string} id identifier of the recommendation widget
+ * @param {number} id identifier of the recommendation widget
  * @returns {AlgoliaSearchHelper} Method is chainable, it returns itself
  * @fires change
  * @chainable
@@ -4712,7 +4742,7 @@ AlgoliaSearchHelper.prototype.removeRelatedProducts = function (id) {
 /**
  * Removes a "trending items" recommendation query.
  *
- * @param {string} id identifier of the recommendation widget
+ * @param {number} id identifier of the recommendation widget
  * @returns {AlgoliaSearchHelper} Method is chainable, it returns itself
  * @fires change
  * @chainable
@@ -4728,7 +4758,7 @@ AlgoliaSearchHelper.prototype.removeTrendingItems = function (id) {
 /**
  * Removes a "trending facets" recommendation query.
  *
- * @param {string} id identifier of the recommendation widget
+ * @param {number} id identifier of the recommendation widget
  * @returns {AlgoliaSearchHelper} Method is chainable, it returns itself
  * @fires change
  * @chainable
@@ -4744,7 +4774,7 @@ AlgoliaSearchHelper.prototype.removeTrendingFacets = function (id) {
 /**
  * Removes a "looking similar" recommendation query.
  *
- * @param {string} id identifier of the recommendation widget
+ * @param {number} id identifier of the recommendation widget
  * @returns {AlgoliaSearchHelper} Method is chainable, it returns itself
  * @fires change
  * @chainable
@@ -5329,6 +5359,9 @@ AlgoliaSearchHelper.prototype._recommend = function () {
   var recommendState = this.recommendState;
   var index = this.getIndex();
   var states = [{ state: recommendState, index: index, helper: this }];
+  var ids = recommendState.params.map(function (param) {
+    return param.$$id;
+  });
 
   this.emit('fetch', {
     recommend: {
@@ -5337,6 +5370,8 @@ AlgoliaSearchHelper.prototype._recommend = function () {
     },
   });
 
+  var cache = this.recommendCache;
+
   var derivedQueries = this.derivedHelpers.map(function (derivedHelper) {
     var derivedIndex = derivedHelper.getModifiedState(searchState).index;
     if (!derivedIndex) {
@@ -5355,6 +5390,13 @@ AlgoliaSearchHelper.prototype._recommend = function () {
       helper: derivedHelper,
     });
 
+    ids = Array.prototype.concat.apply(
+      ids,
+      derivedState.params.map(function (param) {
+        return param.$$id;
+      })
+    );
+
     derivedHelper.emit('fetch', {
       recommend: {
         state: derivedState,
@@ -5362,11 +5404,11 @@ AlgoliaSearchHelper.prototype._recommend = function () {
       },
     });
 
-    return derivedState._buildQueries(derivedIndex);
+    return derivedState._buildQueries(derivedIndex, cache);
   });
 
   var queries = Array.prototype.concat.apply(
-    this.recommendState._buildQueries(index),
+    this.recommendState._buildQueries(index, cache),
     derivedQueries
   );
 
@@ -5380,7 +5422,7 @@ AlgoliaSearchHelper.prototype._recommend = function () {
   ) {
     // eslint-disable-next-line no-console
     console.warn(
-      'Please update algoliasearch/lite to the latest version in order to use recommendations widgets.'
+      'Please update algoliasearch/lite to the latest version in order to use recommend widgets.'
     );
     return;
   }
@@ -5391,7 +5433,7 @@ AlgoliaSearchHelper.prototype._recommend = function () {
   try {
     this.client
       .getRecommendations(queries)
-      .then(this._dispatchRecommendResponse.bind(this, queryId, states))
+      .then(this._dispatchRecommendResponse.bind(this, queryId, states, ids))
       .catch(this._dispatchRecommendError.bind(this, queryId));
   } catch (error) {
     // If we reach this part, we're in an internal error state
@@ -5465,6 +5507,7 @@ AlgoliaSearchHelper.prototype._dispatchAlgoliaResponse = function (
 AlgoliaSearchHelper.prototype._dispatchRecommendResponse = function (
   queryId,
   states,
+  ids,
   content
 ) {
   // @TODO remove the number of outdated queries discarded instead of just one
@@ -5480,7 +5523,39 @@ AlgoliaSearchHelper.prototype._dispatchRecommendResponse = function (
 
   if (this._currentNbRecommendQueries === 0) this.emit('recommendQueueEmpty');
 
-  var results = content.results.slice();
+  var cache = this.recommendCache;
+
+  var idsMap = {};
+  ids
+    .filter(function (id) {
+      return cache[id] === undefined;
+    })
+    .forEach(function (id, index) {
+      if (!idsMap[id]) idsMap[id] = [];
+
+      idsMap[id].push(index);
+    });
+
+  Object.keys(idsMap).forEach(function (id) {
+    var indices = idsMap[id];
+    var firstResult = content.results[indices[0]];
+    if (indices.length === 1) {
+      cache[id] = firstResult;
+      return;
+    }
+    cache[id] = Object.assign({}, firstResult, {
+      hits: sortAndMergeRecommendations(
+        indices.map(function (idx) {
+          return content.results[idx].hits;
+        })
+      ),
+    });
+  });
+
+  var results = {};
+  ids.forEach(function (id) {
+    results[id] = cache[id];
+  });
 
   states.forEach(function (s) {
     var state = s.state;
@@ -5496,7 +5571,7 @@ AlgoliaSearchHelper.prototype._dispatchRecommendResponse = function (
       return;
     }
 
-    helper.lastRecommendResults = results;
+    helper.lastRecommendResults = new RecommendResults(state, results);
 
     // eslint-disable-next-line no-warning-comments
     // TODO: emit "result" event when events for Recommend are implemented
@@ -5711,7 +5786,7 @@ AlgoliaSearchHelper.prototype.hasPendingRequests = function () {
 
 module.exports = AlgoliaSearchHelper;
 
-},{"./DerivedHelper":3,"./RecommendParameters":4,"./SearchParameters":6,"./SearchResults":8,"./functions/escapeFacetValue":12,"./functions/inherits":16,"./functions/merge":18,"./functions/objectHasKeys":19,"./functions/omit":20,"./requestBuilder":23,"./version":25,"@algolia/events":1}],10:[function(require,module,exports){
+},{"./DerivedHelper":3,"./RecommendParameters":4,"./RecommendResults":5,"./SearchParameters":7,"./SearchResults":9,"./functions/escapeFacetValue":13,"./functions/inherits":18,"./functions/merge":20,"./functions/objectHasKeys":21,"./functions/omit":22,"./requestBuilder":25,"./utils/sortAndMergeRecommendations":27,"./version":28,"@algolia/events":1}],11:[function(require,module,exports){
 'use strict';
 
 module.exports = function compact(array) {
@@ -5722,7 +5797,7 @@ module.exports = function compact(array) {
   return array.filter(Boolean);
 };
 
-},{}],11:[function(require,module,exports){
+},{}],12:[function(require,module,exports){
 'use strict';
 
 // NOTE: this behaves like lodash/defaults, but doesn't mutate the target
@@ -5745,7 +5820,7 @@ module.exports = function defaultsPure() {
   }, {});
 };
 
-},{}],12:[function(require,module,exports){
+},{}],13:[function(require,module,exports){
 'use strict';
 
 /**
@@ -5777,7 +5852,7 @@ module.exports = {
   unescapeFacetValue: unescapeFacetValue,
 };
 
-},{}],13:[function(require,module,exports){
+},{}],14:[function(require,module,exports){
 'use strict';
 
 // @MAJOR can be replaced by native Array#find when we change support
@@ -5795,7 +5870,7 @@ module.exports = function find(array, comparator) {
   return undefined;
 };
 
-},{}],14:[function(require,module,exports){
+},{}],15:[function(require,module,exports){
 'use strict';
 
 // @MAJOR can be replaced by native Array#findIndex when we change support
@@ -5812,7 +5887,15 @@ module.exports = function find(array, comparator) {
   return -1;
 };
 
-},{}],15:[function(require,module,exports){
+},{}],16:[function(require,module,exports){
+// @MAJOR: remove this function and use Array.prototype.flat
+module.exports = function flat(arr) {
+  return arr.reduce(function (acc, val) {
+    return acc.concat(val);
+  }, []);
+};
+
+},{}],17:[function(require,module,exports){
 'use strict';
 
 var find = require('./find');
@@ -5853,7 +5936,7 @@ module.exports = function formatSort(sortBy, defaults) {
   );
 };
 
-},{"./find":13}],16:[function(require,module,exports){
+},{"./find":14}],18:[function(require,module,exports){
 'use strict';
 
 function inherits(ctor, superCtor) {
@@ -5869,7 +5952,7 @@ function inherits(ctor, superCtor) {
 
 module.exports = inherits;
 
-},{}],17:[function(require,module,exports){
+},{}],19:[function(require,module,exports){
 'use strict';
 
 function intersection(arr1, arr2) {
@@ -5883,7 +5966,7 @@ function intersection(arr1, arr2) {
 
 module.exports = intersection;
 
-},{}],18:[function(require,module,exports){
+},{}],20:[function(require,module,exports){
 'use strict';
 
 function clone(value) {
@@ -5969,7 +6052,7 @@ function merge(target) {
 
 module.exports = merge;
 
-},{}],19:[function(require,module,exports){
+},{}],21:[function(require,module,exports){
 'use strict';
 
 function objectHasKeys(obj) {
@@ -5978,7 +6061,7 @@ function objectHasKeys(obj) {
 
 module.exports = objectHasKeys;
 
-},{}],20:[function(require,module,exports){
+},{}],22:[function(require,module,exports){
 'use strict';
 
 // https://github.com/babel/babel/blob/3aaafae053fa75febb3aa45d45b6f00646e30ba4/packages/babel-helpers/src/helpers.js#L604-L620
@@ -5999,7 +6082,7 @@ function _objectWithoutPropertiesLoose(source, excluded) {
 
 module.exports = _objectWithoutPropertiesLoose;
 
-},{}],21:[function(require,module,exports){
+},{}],23:[function(require,module,exports){
 'use strict';
 
 function compareAscending(value, other) {
@@ -6081,7 +6164,7 @@ function orderBy(collection, iteratees, orders) {
 
 module.exports = orderBy;
 
-},{}],22:[function(require,module,exports){
+},{}],24:[function(require,module,exports){
 'use strict';
 
 function valToNumber(v) {
@@ -6100,7 +6183,7 @@ function valToNumber(v) {
 
 module.exports = valToNumber;
 
-},{}],23:[function(require,module,exports){
+},{}],25:[function(require,module,exports){
 'use strict';
 
 var merge = require('./functions/merge');
@@ -6550,7 +6633,7 @@ var requestBuilder = {
 
 module.exports = requestBuilder;
 
-},{"./functions/merge":18}],24:[function(require,module,exports){
+},{"./functions/merge":20}],26:[function(require,module,exports){
 'use strict';
 
 module.exports = function isValidUserToken(userToken) {
@@ -6560,10 +6643,68 @@ module.exports = function isValidUserToken(userToken) {
   return /^[a-zA-Z0-9_-]{1,64}$/.test(userToken);
 };
 
-},{}],25:[function(require,module,exports){
+},{}],27:[function(require,module,exports){
+'use strict';
+
+var find = require('../functions/find');
+var flat = require('../functions/flat');
+
+function getAverageIndices(indexTracker, nrOfObjs) {
+  var avgIndices = [];
+
+  Object.keys(indexTracker).forEach(function (key) {
+    if (indexTracker[key].count < 2) {
+      indexTracker[key].indexSum += 100;
+    }
+    avgIndices.push({
+      objectID: key,
+      avgOfIndices: indexTracker[key].indexSum / nrOfObjs,
+    });
+  });
+
+  return avgIndices.sort(function (a, b) {
+    return a.avgOfIndices > b.avgOfIndices ? 1 : -1;
+  });
+}
+
+function sortAndMergeRecommendations(results) {
+  var indexTracker = {};
+
+  results.forEach(function (hits) {
+    hits.forEach(function (hit, index) {
+      if (!indexTracker[hit.objectID]) {
+        indexTracker[hit.objectID] = { indexSum: index, count: 1 };
+      } else {
+        indexTracker[hit.objectID] = {
+          indexSum: indexTracker[hit.objectID].indexSum + index,
+          count: indexTracker[hit.objectID].count + 1,
+        };
+      }
+    });
+  });
+
+  var sortedAverageIndices = getAverageIndices(indexTracker, results.length);
+
+  var finalOrder = sortedAverageIndices.reduce(function (
+    orderedHits,
+    avgIndexRef
+  ) {
+    var result = find(flat(results), function (hit) {
+      return hit.objectID === avgIndexRef.objectID;
+    });
+    return result ? orderedHits.concat(result) : orderedHits;
+  },
+  []);
+
+  return finalOrder;
+}
+
+module.exports = sortAndMergeRecommendations;
+
+},{"../functions/find":14,"../functions/flat":16}],28:[function(require,module,exports){
 'use strict';
 
-module.exports = '3.18.0';
+module.exports = '3.20.0';
 
 },{}]},{},[2])(2)
 });