algoliasearch 3.25.0 → 3.27.1

package/dist/algoliasearch.parse.js

@@ -163,6 +163,9 @@ module.exports =
 	    _setTimeout(promise.resolve.bind(promise), ms);
 
 	    return promise;
+	  },
+	  all: function all(promises) {
+	    return Parse.Promise.all(promises);
 	  }
 	};
 
@@ -565,7 +568,7 @@ module.exports =
 	 *   content: the server answer with the added API key
 	 * @return {Promise|undefined} Returns a promise if no callback given
 	 * @example
-	 * client.addUserKey(['search'], {
+	 * client.addApiKey(['search'], {
 	 *   validity: 300,
 	 *   maxQueriesPerIPPerHour: 2000,
 	 *   maxHitsPerQuery: 3,
@@ -1763,6 +1766,7 @@ module.exports =
 	 * Retrieve all the query rules in an index
 	 * @param [number=100] hitsPerPage The amount of query rules to retrieve per batch
 	 * @param [function] callback will be called after all query rules are retrieved
+	 *  error: null or Error('message')
 	 */
 	Index.prototype.exportRules = function(hitsPerPage, callback) {
 	  return exportData(this.searchRules.bind(this), hitsPerPage, callback);
@@ -1776,6 +1780,10 @@ module.exports =
 	    opts = {};
 	  }
 
+	  if (!rule.objectID) {
+	    throw new errors.AlgoliaSearchError('Missing or empty objectID field for rule');
+	  }
+
 	  var forwardToReplicas = opts.forwardToReplicas === true ? 'true' : 'false';
 
 	  return this.as._jsonRequest({
@@ -1948,11 +1956,11 @@ module.exports =
 	};
 
 	/*
-	 @deprecated see index.listApiKeys
-	 */
+	* @deprecated see client.listApiKeys()
+	*/
 	Index.prototype.listUserKeys = deprecate(function(callback) {
 	  return this.listApiKeys(callback);
-	}, deprecatedMessage('index.listUserKeys()', 'index.listApiKeys()'));
+	}, deprecatedMessage('index.listUserKeys()', 'client.listApiKeys()'));
 
 	/*
 	* List all existing API keys to this index
@@ -1960,8 +1968,10 @@ module.exports =
 	* @param callback the result callback called with two arguments
 	*  error: null or Error('message')
 	*  content: the server answer with API keys belonging to the index
+	*
+	* @deprecated see client.listApiKeys()
 	*/
-	Index.prototype.listApiKeys = function(callback) {
+	Index.prototype.listApiKeys = deprecate(function(callback) {
 	  var indexObj = this;
 	  return this.as._jsonRequest({
 	    method: 'GET',
@@ -1969,14 +1979,14 @@ module.exports =
 	    hostType: 'read',
 	    callback: callback
 	  });
-	};
+	}, deprecatedMessage('index.listApiKeys()', 'client.listApiKeys()'));
 
 	/*
-	 @deprecated see index.getApiKey
-	 */
+	* @deprecated see client.getApiKey()
+	*/
 	Index.prototype.getUserKeyACL = deprecate(function(key, callback) {
 	  return this.getApiKey(key, callback);
-	}, deprecatedMessage('index.getUserKeyACL()', 'index.getApiKey()'));
+	}, deprecatedMessage('index.getUserKeyACL()', 'client.getApiKey()'));
 
 
 	/*
@@ -1986,8 +1996,10 @@ module.exports =
 	* @param callback the result callback called with two arguments
 	*  error: null or Error('message')
 	*  content: the server answer with the right API key
+	*
+	* @deprecated see client.getApiKey()
 	*/
-	Index.prototype.getApiKey = function(key, callback) {
+	Index.prototype.getApiKey = deprecate(function(key, callback) {
 	  var indexObj = this;
 	  return this.as._jsonRequest({
 	    method: 'GET',
@@ -1995,14 +2007,14 @@ module.exports =
 	    hostType: 'read',
 	    callback: callback
 	  });
-	};
+	}, deprecatedMessage('index.getApiKey()', 'client.getApiKey()'));
 
 	/*
-	 @deprecated see index.deleteApiKey
-	 */
+	* @deprecated see client.deleteApiKey()
+	*/
 	Index.prototype.deleteUserKey = deprecate(function(key, callback) {
 	  return this.deleteApiKey(key, callback);
-	}, deprecatedMessage('index.deleteUserKey()', 'index.deleteApiKey()'));
+	}, deprecatedMessage('index.deleteUserKey()', 'client.deleteApiKey()'));
 
 	/*
 	* Delete an existing API key associated to this index
@@ -2011,8 +2023,10 @@ module.exports =
 	* @param callback the result callback called with two arguments
 	*  error: null or Error('message')
 	*  content: the server answer with the deletion date
+	*
+	* @deprecated see client.deleteApiKey()
 	*/
-	Index.prototype.deleteApiKey = function(key, callback) {
+	Index.prototype.deleteApiKey = deprecate(function(key, callback) {
 	  var indexObj = this;
 	  return this.as._jsonRequest({
 	    method: 'DELETE',
@@ -2020,14 +2034,14 @@ module.exports =
 	    hostType: 'write',
 	    callback: callback
 	  });
-	};
+	}, deprecatedMessage('index.deleteApiKey()', 'client.deleteApiKey()'));
 
 	/*
-	 @deprecated see index.addApiKey
-	 */
+	* @deprecated see client.addApiKey()
+	*/
 	Index.prototype.addUserKey = deprecate(function(acls, params, callback) {
 	  return this.addApiKey(acls, params, callback);
-	}, deprecatedMessage('index.addUserKey()', 'index.addApiKey()'));
+	}, deprecatedMessage('index.addUserKey()', 'client.addApiKey()'));
 
 	/*
 	* Add a new API key to this index
@@ -2064,8 +2078,10 @@ module.exports =
 	*   }
 	* })
 	* @see {@link https://www.algolia.com/doc/rest_api#AddIndexKey|Algolia REST API Documentation}
+	*
+	* @deprecated see client.addApiKey()
 	*/
-	Index.prototype.addApiKey = function(acls, params, callback) {
+	Index.prototype.addApiKey = deprecate(function(acls, params, callback) {
 	  var isArray = __webpack_require__(16);
 	  var usage = 'Usage: index.addApiKey(arrayOfAcls[, params, callback])';
 
@@ -2102,21 +2118,21 @@ module.exports =
 	    hostType: 'write',
 	    callback: callback
 	  });
-	};
+	}, deprecatedMessage('index.addApiKey()', 'client.addApiKey()'));
 
 	/**
-	* @deprecated use index.addApiKey()
+	* @deprecated use client.addApiKey()
 	*/
 	Index.prototype.addUserKeyWithValidity = deprecate(function deprecatedAddUserKeyWithValidity(acls, params, callback) {
 	  return this.addApiKey(acls, params, callback);
-	}, deprecatedMessage('index.addUserKeyWithValidity()', 'index.addApiKey()'));
+	}, deprecatedMessage('index.addUserKeyWithValidity()', 'client.addApiKey()'));
 
 	/*
-	 @deprecated see index.updateApiKey
-	 */
+	* @deprecated see client.updateApiKey()
+	*/
 	Index.prototype.updateUserKey = deprecate(function(key, acls, params, callback) {
 	  return this.updateApiKey(key, acls, params, callback);
-	}, deprecatedMessage('index.updateUserKey()', 'index.updateApiKey()'));
+	}, deprecatedMessage('index.updateUserKey()', 'client.updateApiKey()'));
 
 	/**
 	* Update an existing API key of this index
@@ -2153,8 +2169,10 @@ module.exports =
 	*   }
 	* })
 	* @see {@link https://www.algolia.com/doc/rest_api#UpdateIndexKey|Algolia REST API Documentation}
+	*
+	* @deprecated see client.updateApiKey()
 	*/
-	Index.prototype.updateApiKey = function(key, acls, params, callback) {
+	Index.prototype.updateApiKey = deprecate(function(key, acls, params, callback) {
 	  var isArray = __webpack_require__(16);
 	  var usage = 'Usage: index.updateApiKey(key, arrayOfAcls[, params, callback])';
 
@@ -2191,7 +2209,7 @@ module.exports =
 	    hostType: 'write',
 	    callback: callback
 	  });
-	};
+	}, deprecatedMessage('index.updateApiKey()', 'client.updateApiKey()'));
 
 
 /***/ }),
@@ -3185,7 +3203,6 @@ module.exports =
 
 	  opts = opts || {};
 
-	  var protocol = opts.protocol || 'https:';
 	  this._timeouts = opts.timeouts || {
 	    connect: 1 * 1000, // 500ms connect is GPRS latency
 	    read: 2 * 1000,
@@ -3197,13 +3214,14 @@ module.exports =
 	    this._timeouts.connect = this._timeouts.read = this._timeouts.write = opts.timeout;
 	  }
 
+	  var protocol = opts.protocol || 'https:';
 	  // while we advocate for colon-at-the-end values: 'http:' for `opts.protocol`
 	  // we also accept `http` and `https`. It's a common error.
 	  if (!/:$/.test(protocol)) {
 	    protocol = protocol + ':';
 	  }
 
-	  if (opts.protocol !== 'http:' && opts.protocol !== 'https:') {
+	  if (protocol !== 'http:' && protocol !== 'https:') {
 	    throw new errors.AlgoliaSearchError('protocol must be `http:` or `https:` (was `' + opts.protocol + '`)');
 	  }
 
@@ -3215,7 +3233,8 @@ module.exports =
 	    });
 
 	    // no hosts given, compute defaults
-	    this.hosts.read = [this.applicationID + '-dsn.algolia.net'].concat(defaultHosts);
+	    var mainSuffix = (opts.dsn === false ? '' : '-dsn') + '.algolia.net';
+	    this.hosts.read = [this.applicationID + mainSuffix].concat(defaultHosts);
 	    this.hosts.write = [this.applicationID + '.algolia.net'].concat(defaultHosts);
 	  } else if (isArray(opts.hosts)) {
 	    // when passing custom hosts, we need to have a different host index if the number
@@ -3729,6 +3748,70 @@ module.exports =
 	  });
 	};
 
+	/**
+	* Search for facet values
+	* https://www.algolia.com/doc/rest-api/search#search-for-facet-values
+	* This is the top-level API for SFFV.
+	*
+	* @param {object[]} queries An array of queries to run.
+	* @param {string} queries[].indexName Index name, name of the index to search.
+	* @param {object} queries[].params Query parameters.
+	* @param {string} queries[].params.facetName Facet name, name of the attribute to search for values in.
+	* Must be declared as a facet
+	* @param {string} queries[].params.facetQuery Query for the facet search
+	* @param {string} [queries[].params.*] Any search parameter of Algolia,
+	* see https://www.algolia.com/doc/api-client/javascript/search#search-parameters
+	* Pagination is not supported. The page and hitsPerPage parameters will be ignored.
+	*/
+	AlgoliaSearchCore.prototype.searchForFacetValues = function(queries) {
+	  var isArray = __webpack_require__(16);
+	  var map = __webpack_require__(17);
+
+	  var usage = 'Usage: client.searchForFacetValues([{indexName, params: {facetName, facetQuery, ...params}}, ...queries])'; // eslint-disable-line max-len
+
+	  if (!isArray(queries)) {
+	    throw new Error(usage);
+	  }
+
+	  var client = this;
+
+	  return client._promise.all(map(queries, function performQuery(query) {
+	    if (
+	      !query ||
+	      query.indexName === undefined ||
+	      query.params.facetName === undefined ||
+	      query.params.facetQuery === undefined
+	    ) {
+	      throw new Error(usage);
+	    }
+
+	    var clone = __webpack_require__(12);
+	    var omit = __webpack_require__(13);
+
+	    var indexName = query.indexName;
+	    var params = query.params;
+
+	    var facetName = params.facetName;
+	    var filteredParams = omit(clone(params), function(keyName) {
+	      return keyName === 'facetName';
+	    });
+	    var searchParameters = client._getSearchParams(filteredParams, '');
+
+	    return client._jsonRequest({
+	      cache: client.cache,
+	      method: 'POST',
+	      url:
+	        '/1/indexes/' +
+	        encodeURIComponent(indexName) +
+	        '/facets/' +
+	        encodeURIComponent(facetName) +
+	        '/query',
+	      hostType: 'read',
+	      body: {params: searchParameters}
+	    });
+	  }));
+	};
+
 	/**
 	 * Set the extra security tagFilters header
 	 * @param {string|array} tags The list of tags defining the current security filters
@@ -4047,7 +4130,7 @@ module.exports =
 
 	
 
-	module.exports = '3.25.0';
+	module.exports = '3.27.1';
 
 
 /***/ })

package/dist/algoliasearchLite.js

@@ -1,4 +1,4 @@
-/*! algoliasearch 3.25.0 | © 2014, 2015 Algolia SAS | github.com/algolia/algoliasearch-client-js */
+/*! algoliasearch 3.27.1 | © 2014, 2015 Algolia SAS | github.com/algolia/algoliasearch-client-js */
 (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.algoliasearch = 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){
 (function (process){
 /**
@@ -2278,7 +2278,6 @@ function AlgoliaSearchCore(applicationID, apiKey, opts) {
 
   opts = opts || {};
 
-  var protocol = opts.protocol || 'https:';
   this._timeouts = opts.timeouts || {
     connect: 1 * 1000, // 500ms connect is GPRS latency
     read: 2 * 1000,
@@ -2290,13 +2289,14 @@ function AlgoliaSearchCore(applicationID, apiKey, opts) {
     this._timeouts.connect = this._timeouts.read = this._timeouts.write = opts.timeout;
   }
 
+  var protocol = opts.protocol || 'https:';
   // while we advocate for colon-at-the-end values: 'http:' for `opts.protocol`
   // we also accept `http` and `https`. It's a common error.
   if (!/:$/.test(protocol)) {
     protocol = protocol + ':';
   }
 
-  if (opts.protocol !== 'http:' && opts.protocol !== 'https:') {
+  if (protocol !== 'http:' && protocol !== 'https:') {
     throw new errors.AlgoliaSearchError('protocol must be `http:` or `https:` (was `' + opts.protocol + '`)');
   }
 
@@ -2308,7 +2308,8 @@ function AlgoliaSearchCore(applicationID, apiKey, opts) {
     });
 
     // no hosts given, compute defaults
-    this.hosts.read = [this.applicationID + '-dsn.algolia.net'].concat(defaultHosts);
+    var mainSuffix = (opts.dsn === false ? '' : '-dsn') + '.algolia.net';
+    this.hosts.read = [this.applicationID + mainSuffix].concat(defaultHosts);
     this.hosts.write = [this.applicationID + '.algolia.net'].concat(defaultHosts);
   } else if (isArray(opts.hosts)) {
     // when passing custom hosts, we need to have a different host index if the number
@@ -2822,6 +2823,70 @@ AlgoliaSearchCore.prototype.search = function(queries, opts, callback) {
   });
 };
 
+/**
+* Search for facet values
+* https://www.algolia.com/doc/rest-api/search#search-for-facet-values
+* This is the top-level API for SFFV.
+*
+* @param {object[]} queries An array of queries to run.
+* @param {string} queries[].indexName Index name, name of the index to search.
+* @param {object} queries[].params Query parameters.
+* @param {string} queries[].params.facetName Facet name, name of the attribute to search for values in.
+* Must be declared as a facet
+* @param {string} queries[].params.facetQuery Query for the facet search
+* @param {string} [queries[].params.*] Any search parameter of Algolia,
+* see https://www.algolia.com/doc/api-client/javascript/search#search-parameters
+* Pagination is not supported. The page and hitsPerPage parameters will be ignored.
+*/
+AlgoliaSearchCore.prototype.searchForFacetValues = function(queries) {
+  var isArray = require(7);
+  var map = require(25);
+
+  var usage = 'Usage: client.searchForFacetValues([{indexName, params: {facetName, facetQuery, ...params}}, ...queries])'; // eslint-disable-line max-len
+
+  if (!isArray(queries)) {
+    throw new Error(usage);
+  }
+
+  var client = this;
+
+  return client._promise.all(map(queries, function performQuery(query) {
+    if (
+      !query ||
+      query.indexName === undefined ||
+      query.params.facetName === undefined ||
+      query.params.facetQuery === undefined
+    ) {
+      throw new Error(usage);
+    }
+
+    var clone = require(20);
+    var omit = require(27);
+
+    var indexName = query.indexName;
+    var params = query.params;
+
+    var facetName = params.facetName;
+    var filteredParams = omit(clone(params), function(keyName) {
+      return keyName === 'facetName';
+    });
+    var searchParameters = client._getSearchParams(filteredParams, '');
+
+    return client._jsonRequest({
+      cache: client.cache,
+      method: 'POST',
+      url:
+        '/1/indexes/' +
+        encodeURIComponent(indexName) +
+        '/facets/' +
+        encodeURIComponent(facetName) +
+        '/query',
+      hostType: 'read',
+      body: {params: searchParameters}
+    });
+  }));
+};
+
 /**
  * Set the extra security tagFilters header
  * @param {string|array} tags The list of tags defining the current security filters
@@ -3042,7 +3107,7 @@ function removeCredentials(headers) {
 }
 
 }).call(this,require(11))
-},{"1":1,"11":11,"14":14,"20":20,"23":23,"24":24,"25":25,"29":29,"4":4,"7":7}],14:[function(require,module,exports){
+},{"1":1,"11":11,"14":14,"20":20,"23":23,"24":24,"25":25,"27":27,"29":29,"4":4,"7":7}],14:[function(require,module,exports){
 var buildSearchMethod = require(19);
 var deprecate = require(21);
 var deprecatedMessage = require(22);
@@ -3645,6 +3710,9 @@ module.exports = function createAlgoliasearch(AlgoliaSearch, uaSuffix) {
       return new Promise(function resolveOnTimeout(resolve/* , reject*/) {
         setTimeout(resolve, ms);
       });
+    },
+    all: function all(promises) {
+      return Promise.all(promises);
     }
   };
 
@@ -4165,7 +4233,7 @@ function cleanup() {
 },{"1":1}],30:[function(require,module,exports){
 'use strict';
 
-module.exports = '3.25.0';
+module.exports = '3.27.1';
 
 },{}]},{},[15])(15)
 });