algoliasearch-helper 3.13.3 → 3.13.5

package/README.md

@@ -2,18 +2,16 @@ _Coming from V1 (or js client v2)?_ Read the [migration guide](https://github.co
 
 _Coming from V2?_ Read the [migration guide](https://github.com/algolia/algoliasearch-helper-js/wiki/Migration-guide-:-V2-to-V3) to the new version of the Helper.
 
-**The JavaScript helper is an advanced library we provide to our users. If you are looking to build a complete search interface, we recommend you to use [instantsearch.js](https://community.algolia.com/instantsearch.js/). If you want to build an autocomplete menu, see [autocomplete.js](https://github.com/algolia/autocomplete.js).**
+**The JavaScript helper is an advanced library we provide to our users. If you are looking to build a complete search interface, we recommend you to use [InstantSearch](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/). If you want to build an autocomplete menu, see [Autocomplete](https://github.com/algolia/autocomplete).**
 
-# algoliasearch-helper-js
+# algoliasearch-helper
 
-This module is the companion of the [algolia/algoliasearch-client-js](https://github.com/algolia/algoliasearch-client-js). It helps you keep track of the search parameters and provides a higher level API.
+This module is the companion of the [algolia/algoliasearch-client-javascript](https://github.com/algolia/algoliasearch-client-javascript). It helps you keep track of the search parameters and provides a higher level API.
 
 [See the helper in action](https://community.algolia.com/algoliasearch-helper-js/)
 
-[![Version][version-svg]][package-url] [![Build Status][travis-svg]][travis-url] [![License][license-image]][license-url] [![Downloads][downloads-image]][downloads-url] [![jsDelivr Hits][jsdelivr-badge]][jsdelivr-hits]
+[![Version][version-svg]][package-url] [![License][license-image]][license-url] [![Downloads][downloads-image]][downloads-url] [![jsDelivr Hits][jsdelivr-badge]][jsdelivr-hits]
 
-[travis-svg]: https://img.shields.io/travis/algolia/algoliasearch-helper-js/develop.svg?style=flat-square
-[travis-url]: https://travis-ci.org/algolia/algoliasearch-helper-js
 [license-image]: http://img.shields.io/badge/license-MIT-green.svg?style=flat-square
 [license-url]: LICENSE
 [downloads-image]: https://img.shields.io/npm/dm/algoliasearch-helper.svg?style=flat-square
@@ -26,6 +24,7 @@ This module is the companion of the [algolia/algoliasearch-client-js](https://gi
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
+
 - [Features](#features)
 - [Examples](#examples)
   - [Vanilla JavaScript](#vanilla-javascript)
@@ -1328,6 +1327,6 @@ Here is an example of a result object you get with the `result` event.
 }
 ```
 
-# Browser support
+## Browser support
 
 This project works on any [ES5](https://en.wikipedia.org/wiki/ECMAScript#5th_Edition) browser, basically >= IE9+.

package/dist/algoliasearch.helper.js

@@ -1,77 +1,4 @@
-(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.algoliasearchHelper = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(require,module,exports){
-'use strict';
-
-var AlgoliaSearchHelper = require('./src/algoliasearch.helper');
-
-var SearchParameters = require('./src/SearchParameters');
-var SearchResults = require('./src/SearchResults');
-
-/**
- * The algoliasearchHelper module is the function that will let its
- * contains everything needed to use the Algoliasearch
- * Helper. It is a also a function that instanciate the helper.
- * To use the helper, you also need the Algolia JS client v3.
- * @example
- * //using the UMD build
- * var client = algoliasearch('latency', '6be0576ff61c053d5f9a3225e2a90f76');
- * var helper = algoliasearchHelper(client, 'bestbuy', {
- *   facets: ['shipping'],
- *   disjunctiveFacets: ['category']
- * });
- * helper.on('result', function(event) {
- *   console.log(event.results);
- * });
- * helper
- *   .toggleFacetRefinement('category', 'Movies & TV Shows')
- *   .toggleFacetRefinement('shipping', 'Free shipping')
- *   .search();
- * @example
- * // The helper is an event emitter using the node API
- * helper.on('result', updateTheResults);
- * helper.once('result', updateTheResults);
- * helper.removeListener('result', updateTheResults);
- * helper.removeAllListeners('result');
- * @module algoliasearchHelper
- * @param  {AlgoliaSearch} client an AlgoliaSearch client
- * @param  {string} index the name of the index to query
- * @param  {SearchParameters|object} opts an object defining the initial config of the search. It doesn't have to be a {SearchParameters}, just an object containing the properties you need from it.
- * @return {AlgoliaSearchHelper} The helper instance
- */
-function algoliasearchHelper(client, index, opts) {
-  return new AlgoliaSearchHelper(client, index, opts);
-}
-
-/**
- * The version currently used
- * @member module:algoliasearchHelper.version
- * @type {number}
- */
-algoliasearchHelper.version = require('./src/version');
-
-/**
- * Constructor for the Helper.
- * @member module:algoliasearchHelper.AlgoliaSearchHelper
- * @type {AlgoliaSearchHelper}
- */
-algoliasearchHelper.AlgoliaSearchHelper = AlgoliaSearchHelper;
-
-/**
- * Constructor for the object containing all the parameters of the search.
- * @member module:algoliasearchHelper.SearchParameters
- * @type {SearchParameters}
- */
-algoliasearchHelper.SearchParameters = SearchParameters;
-
-/**
- * Constructor for the object containing the results of the search.
- * @member module:algoliasearchHelper.SearchResults
- * @type {SearchResults}
- */
-algoliasearchHelper.SearchResults = SearchResults;
-
-module.exports = algoliasearchHelper;
-
-},{"./src/SearchParameters":5,"./src/SearchResults":7,"./src/algoliasearch.helper":8,"./src/version":24}],2:[function(require,module,exports){
+(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.algoliasearchHelper = f()}})(function(){var define,module,exports;return (function(){function r(e,n,t){function o(i,f){if(!n[i]){if(!e[i]){var c="function"==typeof require&&require;if(!f&&c)return c(i,!0);if(u)return u(i,!0);var a=new Error("Cannot find module '"+i+"'");throw a.code="MODULE_NOT_FOUND",a}var p=n[i]={exports:{}};e[i][0].call(p.exports,function(r){var n=e[i][1][r];return o(n||r)},p,p.exports,r,e,n,t)}return n[i].exports}for(var u="function"==typeof require&&require,i=0;i<t.length;i++)o(t[i]);return o}return r})()({1:[function(require,module,exports){
 // Copyright Joyent, Inc. and other Node contributors.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a
@@ -375,7 +302,80 @@ function isUndefined(arg) {
   return arg === void 0;
 }
 
-},{}],3:[function(require,module,exports){
+},{}],2:[function(require,module,exports){
+'use strict';
+
+var AlgoliaSearchHelper = require('./src/algoliasearch.helper');
+
+var SearchParameters = require('./src/SearchParameters');
+var SearchResults = require('./src/SearchResults');
+
+/**
+ * The algoliasearchHelper module is the function that will let its
+ * contains everything needed to use the Algoliasearch
+ * Helper. It is a also a function that instanciate the helper.
+ * To use the helper, you also need the Algolia JS client v3.
+ * @example
+ * //using the UMD build
+ * var client = algoliasearch('latency', '6be0576ff61c053d5f9a3225e2a90f76');
+ * var helper = algoliasearchHelper(client, 'bestbuy', {
+ *   facets: ['shipping'],
+ *   disjunctiveFacets: ['category']
+ * });
+ * helper.on('result', function(event) {
+ *   console.log(event.results);
+ * });
+ * helper
+ *   .toggleFacetRefinement('category', 'Movies & TV Shows')
+ *   .toggleFacetRefinement('shipping', 'Free shipping')
+ *   .search();
+ * @example
+ * // The helper is an event emitter using the node API
+ * helper.on('result', updateTheResults);
+ * helper.once('result', updateTheResults);
+ * helper.removeListener('result', updateTheResults);
+ * helper.removeAllListeners('result');
+ * @module algoliasearchHelper
+ * @param  {AlgoliaSearch} client an AlgoliaSearch client
+ * @param  {string} index the name of the index to query
+ * @param  {SearchParameters|object} opts an object defining the initial config of the search. It doesn't have to be a {SearchParameters}, just an object containing the properties you need from it.
+ * @return {AlgoliaSearchHelper} The helper instance
+ */
+function algoliasearchHelper(client, index, opts) {
+  return new AlgoliaSearchHelper(client, index, opts);
+}
+
+/**
+ * The version currently used
+ * @member module:algoliasearchHelper.version
+ * @type {number}
+ */
+algoliasearchHelper.version = require('./src/version');
+
+/**
+ * Constructor for the Helper.
+ * @member module:algoliasearchHelper.AlgoliaSearchHelper
+ * @type {AlgoliaSearchHelper}
+ */
+algoliasearchHelper.AlgoliaSearchHelper = AlgoliaSearchHelper;
+
+/**
+ * Constructor for the object containing all the parameters of the search.
+ * @member module:algoliasearchHelper.SearchParameters
+ * @type {SearchParameters}
+ */
+algoliasearchHelper.SearchParameters = SearchParameters;
+
+/**
+ * Constructor for the object containing the results of the search.
+ * @member module:algoliasearchHelper.SearchResults
+ * @type {SearchResults}
+ */
+algoliasearchHelper.SearchResults = SearchResults;
+
+module.exports = algoliasearchHelper;
+
+},{"./src/SearchParameters":5,"./src/SearchResults":7,"./src/algoliasearch.helper":8,"./src/version":24}],3:[function(require,module,exports){
 'use strict';
 
 var EventEmitter = require('@algolia/events');
@@ -417,7 +417,7 @@ DerivedHelper.prototype.getModifiedState = function (parameters) {
 
 module.exports = DerivedHelper;
 
-},{"../functions/inherits":15,"@algolia/events":2}],4:[function(require,module,exports){
+},{"../functions/inherits":15,"@algolia/events":1}],4:[function(require,module,exports){
 'use strict';
 
 /**
@@ -550,7 +550,7 @@ var lib = {
         if (facetList.length !== values.length) {
           hasChanged = true;
         }
-        // eslint-disable-next-line no-param-reassign
+
         memo[key] = facetList;
 
         return memo;
@@ -1327,7 +1327,6 @@ SearchParameters.prototype = {
             operatorList[operator] = outValues;
           });
 
-          // eslint-disable-next-line no-param-reassign
           memo[key] = operatorList;
 
           return memo;
@@ -2149,7 +2148,6 @@ SearchParameters.prototype = {
     var self = this;
     var nextWithNumbers = SearchParameters._parseNumbers(params);
     var previousPlainObject = Object.keys(this).reduce(function (acc, key) {
-      // eslint-disable-next-line no-param-reassign
       acc[key] = self[key];
       return acc;
     }, {});
@@ -2166,7 +2164,6 @@ SearchParameters.prototype = {
       }
 
       if (isNextValueDefined) {
-        // eslint-disable-next-line no-param-reassign
         previous[key] = nextWithNumbers[key];
       }
 
@@ -2560,7 +2557,6 @@ function getIndices(attributes) {
 
 function assignFacetStats(dest, facetStats, key) {
   if (facetStats && facetStats[key]) {
-    // eslint-disable-next-line no-param-reassign
     dest.stats = facetStats[key];
   }
 }
@@ -3235,7 +3231,6 @@ function extractNormalizedFacetValues(results, attribute) {
  * @return {undefined} function mutates the item
  */
 function setIsRefined(item, currentRefinement, depth) {
-  // eslint-disable-next-line no-param-reassign
   item.isRefined = item.name === currentRefinement[depth];
   if (item.data) {
     item.data.forEach(function (child) {
@@ -3254,7 +3249,6 @@ function setIsRefined(item, currentRefinement, depth) {
  * @return {HierarchicalFacet|Array} sorted node
  */
 function recSort(sortFn, node, names, level) {
-  // eslint-disable-next-line no-param-reassign
   level = level || 0;
 
   if (Array.isArray(node)) {
@@ -3302,7 +3296,6 @@ function sortViaFacetOrdering(facetValues, facetOrdering) {
    * ['one', 'two'] -> { one: 0, two: 1 }
    */
   var reverseOrder = order.reduce(function (acc, name, i) {
-    // eslint-disable-next-line no-param-reassign
     acc[name] = i;
     return acc;
   }, {});
@@ -4050,13 +4043,10 @@ AlgoliaSearchHelper.prototype.searchForFacetValues = function (
       self._currentNbQueries--;
       if (self._currentNbQueries === 0) self.emit('searchQueueEmpty');
 
-      // eslint-disable-next-line no-param-reassign
       content = Array.isArray(content) ? content[0] : content;
 
       content.facetHits.forEach(function (f) {
-        // eslint-disable-next-line no-param-reassign
         f.escapedValue = escapeFacetValue(f.value);
-        // eslint-disable-next-line no-param-reassign
         f.isRefined = isDisjunctive
           ? state.isDisjunctiveFacetRefined(facet, f.escapedValue)
           : state.isFacetRefined(facet, f.escapedValue);
@@ -5245,7 +5235,7 @@ AlgoliaSearchHelper.prototype.hasPendingRequests = function () {
 
 module.exports = AlgoliaSearchHelper;
 
-},{"./DerivedHelper":3,"./SearchParameters":5,"./SearchResults":7,"./functions/escapeFacetValue":11,"./functions/inherits":15,"./functions/merge":17,"./functions/objectHasKeys":18,"./functions/omit":19,"./requestBuilder":22,"./version":24,"@algolia/events":2}],9:[function(require,module,exports){
+},{"./DerivedHelper":3,"./SearchParameters":5,"./SearchResults":7,"./functions/escapeFacetValue":11,"./functions/inherits":15,"./functions/merge":17,"./functions/objectHasKeys":18,"./functions/omit":19,"./requestBuilder":22,"./version":24,"@algolia/events":1}],9:[function(require,module,exports){
 'use strict';
 
 module.exports = function compact(array) {
@@ -5271,10 +5261,8 @@ module.exports = function defaultsPure() {
       }
       if (acc[key] !== undefined) {
         // remove if already added, so that we can add it in correct order
-        // eslint-disable-next-line no-param-reassign
         delete acc[key];
       }
-      // eslint-disable-next-line no-param-reassign
       acc[key] = source[key];
     });
     return acc;
@@ -5393,7 +5381,6 @@ module.exports = function formatSort(sortBy, defaults) {
 'use strict';
 
 function inherits(ctor, superCtor) {
-  // eslint-disable-next-line no-param-reassign
   ctor.prototype = Object.create(superCtor.prototype, {
     constructor: {
       value: ctor,
@@ -5443,6 +5430,7 @@ function _merge(target, source) {
     return target;
   }
 
+  // eslint-disable-next-line no-restricted-syntax
   for (var key in source) {
     if (
       !Object.prototype.hasOwnProperty.call(source, key) ||
@@ -5465,10 +5453,8 @@ function _merge(target, source) {
       isObjectOrArrayOrFunction(targetVal) &&
       isObjectOrArrayOrFunction(sourceVal)
     ) {
-      // eslint-disable-next-line no-param-reassign
       target[key] = _merge(targetVal, sourceVal);
     } else {
-      // eslint-disable-next-line no-param-reassign
       target[key] = clone(sourceVal);
     }
   }
@@ -5492,7 +5478,6 @@ function _merge(target, source) {
  */
 function merge(target) {
   if (!isObjectOrArrayOrFunction(target)) {
-    // eslint-disable-next-line no-param-reassign
     target = {};
   }
 
@@ -5579,7 +5564,6 @@ function orderBy(collection, iteratees, orders) {
   }
 
   if (!Array.isArray(orders)) {
-    // eslint-disable-next-line no-param-reassign
     orders = [];
   }
 
@@ -5651,7 +5635,6 @@ function sortObject(obj) {
       return a.localeCompare(b);
     })
     .reduce(function (acc, curr) {
-      // eslint-disable-next-line no-param-reassign
       acc[curr] = obj[curr];
       return acc;
     }, {});
@@ -6091,8 +6074,8 @@ module.exports = function isValidUserToken(userToken) {
 },{}],24:[function(require,module,exports){
 'use strict';
 
-module.exports = '3.13.3';
+module.exports = '3.13.5';
 
-},{}]},{},[1])(1)
+},{}]},{},[2])(2)
 });
 //# sourceMappingURL=algoliasearch.helper.js.map