3.22.0

  * feat(API): rename all *userKey[s] methods to *apiKey[s]
    * client/index.listUserKeys() => client/index.listApiKeys()
    * client/index.getUserKeyACL() => client/index.getApiKey()
    * client/index.deleteUserKey() => client/index.deleteApiKey()
    * client/index.addUserKey() => client/index.addApiKey()
    * client/index.udpateUserKey() => client/index.updateApiKey()
  * fix(packaging): remove useless files for packaging (reduce package file size)

Author: vvo

CHANGELOG.md

@@ -1,11 +1,23 @@
 CHANGELOG
 
+2017-03-13 3.22.0
+
+  * feat(API): rename all *userKey[s] methods to *apiKey[s]
+    * client/index.listUserKeys() => client/index.listApiKeys()
+    * client/index.getUserKeyACL() => client/index.getApiKey()
+    * client/index.deleteUserKey() => client/index.deleteApiKey()
+    * client/index.addUserKey() => client/index.addApiKey()
+    * client/index.udpateUserKey() => client/index.updateApiKey()
+  * fix(packaging): remove useless files for packaging (reduce package file size)
+
 2017-02-08 3.21.1
- * fix(browse*): use POST instead of GET to avoid limits (#503)
+
+  * fix(browse*): use POST instead of GET to avoid limits (#503)
 
 2017-02-06 3.21.0
- * feat(x-algolia-agent): specify x-algolia-agent at search time
- * fix(parse): check for `global` existence before erasing
+
+  * feat(x-algolia-agent): specify x-algolia-agent at search time
+  * fix(parse): check for `global` existence before erasing
 
 2017-01-16 3.20.4
 

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "algoliasearch",
-  "version": "3.21.1",
+  "version": "3.22.0",
   "homepage": "https://github.com/algolia/algoliasearch-client-js",
   "authors": [
     "Algolia Team <[email protected]>"

dist/algoliasearch.angular.js

@@ -1,4 +1,4 @@
-/*! algoliasearch 3.21.1 | © 2014, 2015 Algolia SAS | github.com/algolia/algoliasearch-client-js */
+/*! algoliasearch 3.22.0 | © 2014, 2015 Algolia SAS | github.com/algolia/algoliasearch-client-js */
 (function(f){var g;if(typeof window!=='undefined'){g=window}else if(typeof self!=='undefined'){g=self}g.ALGOLIA_MIGRATION_LAYER=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){
 
 module.exports = function load (src, opts, cb) {
@@ -2851,13 +2851,20 @@ AlgoliaSearch.prototype.initIndex = function(indexName) {
 };
 
 /*
- * List all existing user keys with their associated ACLs
+ * @deprecated use client.listApiKeys
+ */
+AlgoliaSearch.prototype.listUserKeys = deprecate(function(callback) {
+  return this.listApiKeys(callback);
+}, deprecatedMessage('client.listUserKeys()', 'client.listApiKeys()'));
+
+/*
+ * List all existing api keys with their associated ACLs
  *
  * @param callback the result callback called with two arguments
  *  error: null or Error('message')
- *  content: the server answer with user keys list
+ *  content: the server answer with api keys list
  */
-AlgoliaSearch.prototype.listUserKeys = function(callback) {
+AlgoliaSearch.prototype.listApiKeys = function(callback) {
   return this._jsonRequest({
     method: 'GET',
     url: '/1/keys',
@@ -2867,14 +2874,21 @@ AlgoliaSearch.prototype.listUserKeys = function(callback) {
 };
 
 /*
- * Get ACL of a user key
+ * @deprecated see client.getApiKey
+ */
+AlgoliaSearch.prototype.getUserKeyACL = deprecate(function(key, callback) {
+  return this.getApiKey(key, callback);
+}, deprecatedMessage('client.getUserKeyACL()', 'client.getApiKey()'));
+
+/*
+ * Get an API key
  *
  * @param key
  * @param callback the result callback called with two arguments
  *  error: null or Error('message')
- *  content: the server answer with user keys list
+ *  content: the server answer with the right API key
  */
-AlgoliaSearch.prototype.getUserKeyACL = function(key, callback) {
+AlgoliaSearch.prototype.getApiKey = function(key, callback) {
   return this._jsonRequest({
     method: 'GET',
     url: '/1/keys/' + key,
@@ -2884,13 +2898,20 @@ AlgoliaSearch.prototype.getUserKeyACL = function(key, callback) {
 };
 
 /*
- * Delete an existing user key
+ * @deprecated see client.deleteApiKey
+ */
+AlgoliaSearch.prototype.deleteUserKey = deprecate(function(key, callback) {
+  return this.deleteApiKey(key, callback);
+}, deprecatedMessage('client.deleteUserKey()', 'client.deleteApiKey()'));
+
+/*
+ * Delete an existing API key
  * @param key
  * @param callback the result callback called with two arguments
  *  error: null or Error('message')
- *  content: the server answer with user keys list
+ *  content: the server answer with the date of deletion
  */
-AlgoliaSearch.prototype.deleteUserKey = function(key, callback) {
+AlgoliaSearch.prototype.deleteApiKey = function(key, callback) {
   return this._jsonRequest({
     method: 'DELETE',
     url: '/1/keys/' + key,
@@ -2899,6 +2920,13 @@ AlgoliaSearch.prototype.deleteUserKey = function(key, callback) {
   });
 };
 
+/*
+ @deprecated see client.addApiKey
+ */
+AlgoliaSearch.prototype.addUserKey = deprecate(function(acls, params, callback) {
+  return this.addApiKey(acls, params, callback);
+}, deprecatedMessage('client.addUserKey()', 'client.addApiKey()'));
+
 /*
  * Add a new global API key
  *
@@ -2920,7 +2948,7 @@ AlgoliaSearch.prototype.deleteUserKey = function(key, callback) {
  * @param {Object} params.queryParameters - Force the key to use specific query parameters
  * @param {Function} callback - The result callback called with two arguments
  *   error: null or Error('message')
- *   content: the server answer with user keys list
+ *   content: the server answer with the added API key
  * @return {Promise|undefined} Returns a promise if no callback given
  * @example
  * client.addUserKey(['search'], {
@@ -2936,9 +2964,9 @@ AlgoliaSearch.prototype.deleteUserKey = function(key, callback) {
  * })
  * @see {@link https://www.algolia.com/doc/rest_api#AddKey|Algolia REST API Documentation}
  */
-AlgoliaSearch.prototype.addUserKey = function(acls, params, callback) {
+AlgoliaSearch.prototype.addApiKey = function(acls, params, callback) {
   var isArray = require(8);
-  var usage = 'Usage: client.addUserKey(arrayOfAcls[, params, callback])';
+  var usage = 'Usage: client.addApiKey(arrayOfAcls[, params, callback])';
 
   if (!isArray(acls)) {
     throw new Error(usage);
@@ -2977,12 +3005,18 @@ AlgoliaSearch.prototype.addUserKey = function(acls, params, callback) {
 };
 
 /**
- * Add a new global API key
- * @deprecated Please use client.addUserKey()
+ * @deprecated Please use client.addApiKey()
  */
 AlgoliaSearch.prototype.addUserKeyWithValidity = deprecate(function(acls, params, callback) {
-  return this.addUserKey(acls, params, callback);
-}, deprecatedMessage('client.addUserKeyWithValidity()', 'client.addUserKey()'));
+  return this.addApiKey(acls, params, callback);
+}, deprecatedMessage('client.addUserKeyWithValidity()', 'client.addApiKey()'));
+
+/**
+ * @deprecated Please use client.updateApiKey()
+ */
+AlgoliaSearch.prototype.updateUserKey = deprecate(function(key, acls, params, callback) {
+  return this.updateApiKey(key, acls, params, callback);
+}, deprecatedMessage('client.updateUserKey()', 'client.updateApiKey()'));
 
 /**
  * Update an existing API key
@@ -3005,10 +3039,10 @@ AlgoliaSearch.prototype.addUserKeyWithValidity = deprecate(function(acls, params
  * @param {Object} params.queryParameters - Force the key to use specific query parameters
  * @param {Function} callback - The result callback called with two arguments
  *   error: null or Error('message')
- *   content: the server answer with user keys list
+ *   content: the server answer with the modified API key
  * @return {Promise|undefined} Returns a promise if no callback given
  * @example
- * client.updateUserKey('APIKEY', ['search'], {
+ * client.updateApiKey('APIKEY', ['search'], {
  *   validity: 300,
  *   maxQueriesPerIPPerHour: 2000,
  *   maxHitsPerQuery: 3,
@@ -3021,9 +3055,9 @@ AlgoliaSearch.prototype.addUserKeyWithValidity = deprecate(function(acls, params
  * })
  * @see {@link https://www.algolia.com/doc/rest_api#UpdateIndexKey|Algolia REST API Documentation}
  */
-AlgoliaSearch.prototype.updateUserKey = function(key, acls, params, callback) {
+AlgoliaSearch.prototype.updateApiKey = function(key, acls, params, callback) {
   var isArray = require(8);
-  var usage = 'Usage: client.updateUserKey(key, arrayOfAcls[, params, callback])';
+  var usage = 'Usage: client.updateApiKey(key, arrayOfAcls[, params, callback])';
 
   if (!isArray(acls)) {
     throw new Error(usage);
@@ -4742,13 +4776,20 @@ Index.prototype.setSettings = function(settings, opts, callback) {
 };
 
 /*
-* List all existing user keys associated to this index
+ @deprecated see index.listApiKeys
+ */
+Index.prototype.listUserKeys = deprecate(function(callback) {
+  return this.listApiKeys(callback);
+}, deprecatedMessage('index.listUserKeys()', 'index.listApiKeys()'));
+
+/*
+* List all existing API keys to this index
 *
 * @param callback the result callback called with two arguments
 *  error: null or Error('message')
-*  content: the server answer with user keys list
+*  content: the server answer with API keys belonging to the index
 */
-Index.prototype.listUserKeys = function(callback) {
+Index.prototype.listApiKeys = function(callback) {
   var indexObj = this;
   return this.as._jsonRequest({
     method: 'GET',
@@ -4759,14 +4800,22 @@ Index.prototype.listUserKeys = function(callback) {
 };
 
 /*
-* Get ACL of a user key associated to this index
+ @deprecated see index.getApiKey
+ */
+Index.prototype.getUserKeyACL = deprecate(function(key, callback) {
+  return this.getApiKey(key, callback);
+}, deprecatedMessage('index.getUserKeyACL()', 'index.getApiKey()'));
+
+
+/*
+* Get an API key from this index
 *
 * @param key
 * @param callback the result callback called with two arguments
 *  error: null or Error('message')
-*  content: the server answer with user keys list
+*  content: the server answer with the right API key
 */
-Index.prototype.getUserKeyACL = function(key, callback) {
+Index.prototype.getApiKey = function(key, callback) {
   var indexObj = this;
   return this.as._jsonRequest({
     method: 'GET',
@@ -4777,14 +4826,21 @@ Index.prototype.getUserKeyACL = function(key, callback) {
 };
 
 /*
-* Delete an existing user key associated to this index
+ @deprecated see index.deleteApiKey
+ */
+Index.prototype.deleteUserKey = deprecate(function(key, callback) {
+  return this.deleteApiKey(key, callback);
+}, deprecatedMessage('index.deleteUserKey()', 'index.deleteApiKey()'));
+
+/*
+* Delete an existing API key associated to this index
 *
 * @param key
 * @param callback the result callback called with two arguments
 *  error: null or Error('message')
-*  content: the server answer with user keys list
+*  content: the server answer with the deletion date
 */
-Index.prototype.deleteUserKey = function(key, callback) {
+Index.prototype.deleteApiKey = function(key, callback) {
   var indexObj = this;
   return this.as._jsonRequest({
     method: 'DELETE',
@@ -4794,6 +4850,13 @@ Index.prototype.deleteUserKey = function(key, callback) {
   });
 };
 
+/*
+ @deprecated see index.addApiKey
+ */
+Index.prototype.addUserKey = deprecate(function(acls, params, callback) {
+  return this.addApiKey(acls, params, callback);
+}, deprecatedMessage('index.addUserKey()', 'index.addApiKey()'));
+
 /*
 * Add a new API key to this index
 *
@@ -4815,7 +4878,7 @@ Index.prototype.deleteUserKey = function(key, callback) {
 * @param {Object} params.queryParameters - Force the key to use specific query parameters
 * @param {Function} callback - The result callback called with two arguments
 *   error: null or Error('message')
-*   content: the server answer with user keys list
+*   content: the server answer with the added API key
 * @return {Promise|undefined} Returns a promise if no callback given
 * @example
 * index.addUserKey(['search'], {
@@ -4830,9 +4893,9 @@ Index.prototype.deleteUserKey = function(key, callback) {
 * })
 * @see {@link https://www.algolia.com/doc/rest_api#AddIndexKey|Algolia REST API Documentation}
 */
-Index.prototype.addUserKey = function(acls, params, callback) {
+Index.prototype.addApiKey = function(acls, params, callback) {
   var isArray = require(8);
-  var usage = 'Usage: index.addUserKey(arrayOfAcls[, params, callback])';
+  var usage = 'Usage: index.addApiKey(arrayOfAcls[, params, callback])';
 
   if (!isArray(acls)) {
     throw new Error(usage);
@@ -4870,12 +4933,18 @@ Index.prototype.addUserKey = function(acls, params, callback) {
 };
 
 /**
-* Add an existing user key associated to this index
-* @deprecated use index.addUserKey()
+* @deprecated use index.addApiKey()
 */
 Index.prototype.addUserKeyWithValidity = deprecate(function deprecatedAddUserKeyWithValidity(acls, params, callback) {
-  return this.addUserKey(acls, params, callback);
-}, deprecatedMessage('index.addUserKeyWithValidity()', 'index.addUserKey()'));
+  return this.addApiKey(acls, params, callback);
+}, deprecatedMessage('index.addUserKeyWithValidity()', 'index.addApiKey()'));
+
+/*
+ @deprecated see index.updateApiKey
+ */
+Index.prototype.updateUserKey = deprecate(function(key, acls, params, callback) {
+  return this.updateApiKey(key, acls, params, callback);
+}, deprecatedMessage('index.updateUserKey()', 'index.updateApiKey()'));
 
 /**
 * Update an existing API key of this index
@@ -4901,7 +4970,7 @@ Index.prototype.addUserKeyWithValidity = deprecate(function deprecatedAddUserKey
 *   content: the server answer with user keys list
 * @return {Promise|undefined} Returns a promise if no callback given
 * @example
-* index.updateUserKey('APIKEY', ['search'], {
+* index.updateApiKey('APIKEY', ['search'], {
 *   validity: 300,
 *   maxQueriesPerIPPerHour: 2000,
 *   maxHitsPerQuery: 3,
@@ -4913,9 +4982,9 @@ Index.prototype.addUserKeyWithValidity = deprecate(function deprecatedAddUserKey
 * })
 * @see {@link https://www.algolia.com/doc/rest_api#UpdateIndexKey|Algolia REST API Documentation}
 */
-Index.prototype.updateUserKey = function(key, acls, params, callback) {
+Index.prototype.updateApiKey = function(key, acls, params, callback) {
   var isArray = require(8);
-  var usage = 'Usage: index.updateUserKey(key, arrayOfAcls[, params, callback])';
+  var usage = 'Usage: index.updateApiKey(key, arrayOfAcls[, params, callback])';
 
   if (!isArray(acls)) {
     throw new Error(usage);
@@ -6339,6 +6408,6 @@ function cleanup() {
 },{"1":1}],36:[function(require,module,exports){
 'use strict';
 
-module.exports = '3.21.1';
+module.exports = '3.22.0';
 
 },{}]},{},[19]);