auth0 2.37.0 → 2.38.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change Log
 
+## [v2.38.0](https://github.com/auth0/node-auth0/tree/v2.38.0) (2022-01-26)
+
+[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.37.0...v2.38.0)
+
+**Added**
+
+- [CAUTH-1274]: feat(attack protection): add breached password detection endpoints [\#676](https://github.com/auth0/node-auth0/pull/676) ([sdwvit](https://github.com/sdwvit))
+- [CAUTH-1272]: feat(attack protection): add suspicious IP throttling endpoints support [\#672](https://github.com/auth0/node-auth0/pull/672) ([sdwvit](https://github.com/sdwvit))
+- [CAUTH-1270]: feat(attack protection): add brute-force-protection endpoints support [\#666](https://github.com/auth0/node-auth0/pull/666) ([sdwvit](https://github.com/sdwvit))
+
+**Changed**
+
+- refactor to es6 syntax with classes [\#665](https://github.com/auth0/node-auth0/pull/665) ([hornta](https://github.com/hornta))
+
+**Fixed**
+
+- [SDK-3030] Wrong url when doing assign users with a callback [\#686](https://github.com/auth0/node-auth0/pull/686) ([adamjmcgrath](https://github.com/adamjmcgrath))
+
 ## [v2.37.0](https://github.com/auth0/node-auth0/tree/v2.37.0) (2021-10-14)
 
 [Full Changelog](https://github.com/auth0/node-auth0/compare/v2.36.2...v2.37.0)

package/README.md

@@ -21,6 +21,10 @@ You can find this library documentation in this [page](https://auth0.github.io/n
 
 For more information about [auth0](https://auth0.com) check our [documentation page](https://auth0.com/docs).
 
+## Node version support
+
+This SDK is tested on the latest Node versions 8, 10, 12 and 14.
+
 ## Authentication API Client
 
 This client must be used to access Auth0's [Authentication API](https://auth0.com/docs/api/authentication).
@@ -32,7 +36,7 @@ var AuthenticationClient = require('auth0').AuthenticationClient;
 
 var auth0 = new AuthenticationClient({
   domain: '{YOUR_ACCOUNT}.auth0.com',
-  clientId: '{OPTIONAL_CLIENT_ID}'
+  clientId: '{OPTIONAL_CLIENT_ID}',
 });
 ```
 
@@ -47,7 +51,7 @@ var ManagementClient = require('auth0').ManagementClient;
 
 var management = new ManagementClient({
   token: '{YOUR_API_V2_TOKEN}',
-  domain: '{YOUR_ACCOUNT}.auth0.com'
+  domain: '{YOUR_ACCOUNT}.auth0.com',
 });
 ```
 
@@ -62,7 +66,7 @@ var auth0 = new ManagementClient({
   domain: '{YOUR_ACCOUNT}.auth0.com',
   clientId: '{YOUR_NON_INTERACTIVE_CLIENT_ID}',
   clientSecret: '{YOUR_NON_INTERACTIVE_CLIENT_SECRET}',
-  scope: 'read:users update:users'
+  scope: 'read:users update:users',
 });
 ```
 
@@ -76,15 +80,15 @@ var AuthenticationClient = require('auth0').AuthenticationClient;
 var auth0 = new AuthenticationClient({
   domain: '{YOUR_ACCOUNT}.auth0.com',
   clientId: '{CLIENT_ID}',
-  clientSecret: '{CLIENT_SECRET}'
+  clientSecret: '{CLIENT_SECRET}',
 });
 
 auth0.clientCredentialsGrant(
   {
     audience: 'https://{YOUR_ACCOUNT}.auth0.com/api/v2/',
-    scope: '{MANAGEMENT_API_SCOPES}'
+    scope: '{MANAGEMENT_API_SCOPES}',
   },
-  function(err, response) {
+  function (err, response) {
     if (err) {
       // Handle error.
     }
@@ -101,7 +105,7 @@ Be aware that all methods can be used with promises or callbacks. However, when
 
 ```js
 // Using callbacks.
-management.getUsers(function(err, users) {
+management.getUsers(function (err, users) {
   if (err) {
     // handle error.
   }
@@ -111,15 +115,34 @@ management.getUsers(function(err, users) {
 // Using promises.
 management
   .getUsers()
-  .then(function(users) {
+  .then(function (users) {
     console.log(users);
   })
-  .catch(function(err) {
+  .catch(function (err) {
     // Handle error.
   });
 ```
+
 ## Typescript
-The types for this library are currently maintained by the community at [Definitely Typed](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/auth0).  The team is planning taking ownership of this library as discussed in https://github.com/auth0/node-auth0/issues/572. After the team has taken ownership we will remove this net from the Readme.
+
+The types for this library are currently maintained by the community at [Definitely Typed](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/auth0). The team is planning taking ownership of this library as discussed in https://github.com/auth0/node-auth0/issues/572. After the team has taken ownership we will remove this net from the Readme.
+
+## Troubleshooting
+
+### Getting `Error: Can't resolve 'superagent-proxy'` when bundling with Webpack
+
+We have a dependency on `rest-facade` which `require`s but doesn't include `superagent-proxy`. This SDK doesn't support proxies, so this dependency is not required. To workaround this you can add the following to your `webpack.config.js`:
+
+```
+resolve: {
+  alias: {
+    'superagent-proxy': false
+  }
+}
+```
+
+Or install `superagent-proxy` yourself.
+
 
 ## What is Auth0?
 
@@ -162,5 +185,4 @@ This project is licensed under the MIT license. See the [LICENSE](LICENSE) file
 [downloads-image]: https://img.shields.io/npm/dm/auth0.svg?style=flat-square
 [downloads-url]: https://npmjs.org/package/auth0
 
-
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fauth0%2Fnode-auth0.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fauth0%2Fnode-auth0?ref=badge_large)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0",
-  "version": "2.37.0",
+  "version": "2.38.0",
   "description": "SDK for Auth0 API v2",
   "main": "src/index.js",
   "sideEffects": false,
@@ -8,17 +8,21 @@
     "src"
   ],
   "scripts": {
-    "test": "mocha --reporter spec ./test/**/*.tests.js ./test/*.tests.js",
+    "test": "mocha --reporter spec './test/**/*.tests.js'",
     "test:ci": "nyc npm run test -- --forbid-only --reporter mocha-junit-reporter",
     "test:coverage": "codecov",
-    "test:watch": "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
+    "test:watch": "cross-env NODE_ENV=test mocha --timeout 5000 './test/**/*.tests.js' './test/*.tests.js' --watch",
     "jsdoc:generate": "jsdoc --configure .jsdoc.json --verbose",
-    "precommit": "pretty-quick --staged"
+    "precommit": "pretty-quick --staged",
+    "lint": "eslint ."
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/auth0/node-auth0"
   },
+  "engines": {
+    "node": ">=8.3.0"
+  },
   "keywords": [
     "auth0",
     "api"
@@ -30,34 +34,38 @@
   },
   "homepage": "https://github.com/auth0/node-auth0",
   "dependencies": {
-    "axios": "^0.21.4",
-    "es6-promisify": "^6.1.1",
+    "axios": "^0.24.0",
     "form-data": "^3.0.1",
     "jsonwebtoken": "^8.5.1",
     "jwks-rsa": "^1.12.1",
     "lru-memoizer": "^2.1.4",
-    "rest-facade": "^1.13.1",
+    "rest-facade": "^1.16.3",
     "retry": "^0.13.1"
   },
   "devDependencies": {
     "chai": "^4.2.0",
     "codecov": "^3.7.2",
     "cross-env": "^5.2.0",
+    "eslint": "^8.1.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-jsdoc": "^37.0.3",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-promise": "^5.1.1",
     "husky": "^3.0.1",
-    "jsdoc": "^3.6.3",
+    "jsdoc": "^3.6.7",
     "json-loader": "^0.5.7",
     "jws": "^3.2.2",
     "minami": "^1.2.3",
-    "mocha": "^6.2.0",
-    "mocha-junit-reporter": "^1.23.1",
-    "moment": "^2.24.0",
+    "mocha": "^8.4.0",
+    "mocha-junit-reporter": "^2.0.0",
     "nock": "^10.0.6",
     "nyc": "^14.1.1",
     "pem": "^1.14.2",
-    "prettier": "^1.18.2",
+    "prettier": "2.4.1",
     "pretty-quick": "^1.11.1",
-    "proxyquire": "^2.1.1",
-    "sinon": "^9.0.3",
+    "proxyquire": "^2.1.3",
+    "sinon": "^11.1.2",
     "string-replace-webpack-plugin": "0.1.3",
     "webpack": "^4.36.1"
   }

package/src/Auth0RestClient.js

@@ -1,89 +1,90 @@
-var RestClient = require('rest-facade').Client;
-var ArgumentError = require('rest-facade').ArgumentError;
+const RestClient = require('rest-facade').Client;
+const { ArgumentError } = require('rest-facade');
 
-var utils = require('./utils');
-var SanitizedError = require('./errors').SanitizedError;
+const utils = require('./utils');
+const { SanitizedError } = require('./errors');
 
-var Auth0RestClient = function(resourceUrl, options, provider) {
-  if (resourceUrl === null || resourceUrl === undefined) {
-    throw new ArgumentError('Must provide a Resource Url');
-  }
-
-  if ('string' !== typeof resourceUrl || resourceUrl.length === 0) {
-    throw new ArgumentError('The provided Resource Url is invalid');
-  }
+class Auth0RestClient {
+  constructor(resourceUrl, options, provider) {
+    if (resourceUrl === null || resourceUrl === undefined) {
+      throw new ArgumentError('Must provide a Resource Url');
+    }
 
-  if (options === null || typeof options !== 'object') {
-    throw new ArgumentError('Must provide options');
-  }
+    if ('string' !== typeof resourceUrl || resourceUrl.length === 0) {
+      throw new ArgumentError('The provided Resource Url is invalid');
+    }
 
-  options.errorCustomizer = options.errorCustomizer || SanitizedError;
-  options.errorFormatter = options.errorFormatter || { message: 'message', name: 'error' };
+    if (options === null || typeof options !== 'object') {
+      throw new ArgumentError('Must provide options');
+    }
 
-  this.options = options;
-  this.provider = provider;
-  this.restClient = new RestClient(resourceUrl, options);
+    options.errorCustomizer = options.errorCustomizer || SanitizedError;
+    options.errorFormatter = options.errorFormatter || { message: 'message', name: 'error' };
+
+    this.options = options;
+    this.provider = provider;
+    this.restClient = new RestClient(resourceUrl, options);
+
+    this.wrappedProvider = function (method, args) {
+      if (!this.provider) {
+        return this.restClient[method](...args);
+      }
+
+      let callback;
+      if (args && args[args.length - 1] instanceof Function) {
+        callback = args[args.length - 1];
+      }
+
+      return this.provider
+        .getAccessToken()
+        .then((access_token) => {
+          this.restClient.options.headers['Authorization'] = `Bearer ${access_token}`;
+          return this.restClient[method](...args);
+        })
+        .catch((err) => {
+          if (callback) {
+            return callback(err);
+          }
+          throw err;
+        });
+    };
+  }
 
-  this.wrappedProvider = function(method, args) {
-    if (!this.provider) {
-      return this.restClient[method].apply(this.restClient, args);
-    }
+  getAll(...args) {
+    return this.wrappedProvider('getAll', args);
+  }
 
-    var callback;
-    if (args && args[args.length - 1] instanceof Function) {
-      callback = args[args.length - 1];
+  get(params, callback) {
+    if (typeof params === 'object' && params.id) {
+      params.id = utils.maybeDecode(`${params.id}`);
     }
-
-    var self = this;
-    return this.provider
-      .getAccessToken()
-      .then(function(access_token) {
-        self.restClient.options.headers['Authorization'] = 'Bearer ' + access_token;
-        return self.restClient[method].apply(self.restClient, args);
-      })
-      .catch(function(err) {
-        if (callback) {
-          return callback(err);
-        }
-        return Promise.reject(err);
-      });
-  };
-};
-
-Auth0RestClient.prototype.getAll = function(params, callback) {
-  return this.wrappedProvider('getAll', arguments);
-};
-
-Auth0RestClient.prototype.get = function(params, callback) {
-  if (typeof params === 'object' && params.id) {
-    params.id = utils.maybeDecode(`${params.id}`);
+    return this.wrappedProvider('get', [...[params, callback].filter(Boolean)]);
   }
-  return this.wrappedProvider('get', [...[params, callback].filter(Boolean)]);
-};
 
-Auth0RestClient.prototype.create = function(/* [params], [callback] */) {
-  return this.wrappedProvider('create', arguments);
-};
+  create(...args) {
+    return this.wrappedProvider('create', args);
+  }
 
-Auth0RestClient.prototype.patch = function(params, callback) {
-  if (typeof params === 'object' && params.id) {
-    params.id = utils.maybeDecode(`${params.id}`);
+  patch(params, ...restOfArgs) {
+    if (typeof params === 'object' && params.id) {
+      params.id = utils.maybeDecode(`${params.id}`);
+    }
+    return this.wrappedProvider('patch', [params, ...restOfArgs]);
   }
-  return this.wrappedProvider('patch', arguments);
-};
 
-Auth0RestClient.prototype.update = function(params, callback) {
-  if (typeof params === 'object' && params.id) {
-    params.id = utils.maybeDecode(`${params.id}`);
+  update(params, ...restOfArgs) {
+    if (typeof params === 'object' && params.id) {
+      params.id = utils.maybeDecode(`${params.id}`);
+    }
+    return this.wrappedProvider('update', [params, ...restOfArgs]);
   }
-  return this.wrappedProvider('update', arguments);
-};
 
-Auth0RestClient.prototype.delete = function(params, callback) {
-  if (typeof params === 'object' && params.id) {
-    params.id = utils.maybeDecode(`${params.id}`);
+  delete(params, ...restOfArgs) {
+    if (typeof params === 'object' && params.id) {
+      params.id = utils.maybeDecode(`${params.id}`);
+    }
+    return this.wrappedProvider('delete', [params, ...restOfArgs]);
   }
-  return this.wrappedProvider('delete', arguments);
-};
+}
 
 module.exports = Auth0RestClient;

package/src/RetryRestClient.js

@@ -1,108 +1,105 @@
-var retry = require('retry');
-var ArgumentError = require('rest-facade').ArgumentError;
+const retry = require('retry');
+const { ArgumentError } = require('rest-facade');
 
-var DEFAULT_OPTIONS = {
+const DEFAULT_OPTIONS = {
   maxRetries: 3,
   enabled: true,
-  randomize: true
+  randomize: true,
 };
 
 /**
- * @class RetryRestClient
  * Wrapper Rest Client that adds Retry functionality when requests are failing due to rate limiting (status code 429).
- * @constructor
- * @memberOf module:management
- * @param {Object}  restClient                   RestClient.
- * @param {Object}  [options]                    Options for the RetryRestClient.
- * @param {Object}  [options.enabled:true]       Enabled or Disable Retry Policy functionality.
- * @param {Number}  [options.maxRetries=3]       The maximum amount of times to retry the operation. Default is 3.
- * @param {*}       [options.*]                  Any options that are available in https://github.com/tim-kos/node-retry#retryoperationoptions
  */
-var RetryRestClient = function(restClient, options) {
-  if (restClient === null || typeof restClient !== 'object') {
-    throw new ArgumentError('Must provide RestClient');
+class RetryRestClient {
+  /**
+   * @param {object}  restClient                   RestClient.
+   * @param {object}  [options]                    Options for the RetryRestClient. It includes all properties from https://github.com/tim-kos/node-retry#retryoperationoptions
+   * @param {object}  [options.enabled=true]       Enabled or Disable Retry Policy functionality.
+   * @param {number}  [options.maxRetries=3]       The maximum amount of times to retry the operation.
+   */
+  constructor(restClient, options) {
+    if (restClient === null || typeof restClient !== 'object') {
+      throw new ArgumentError('Must provide RestClient');
+    }
+
+    const params = Object.assign({}, DEFAULT_OPTIONS, options);
+
+    if (typeof params.enabled !== 'boolean') {
+      throw new ArgumentError('Must provide enabled boolean value');
+    }
+
+    if (typeof params.maxRetries !== 'number' || params.maxRetries <= 0) {
+      throw new ArgumentError('Must provide maxRetries as a positive number');
+    }
+
+    this.restClient = restClient;
+    this.enabled = params.enabled;
+    this.retryOptions = Object.assign({ retries: params.maxRetries }, params);
   }
 
-  var params = Object.assign({}, DEFAULT_OPTIONS, options);
-
-  if (typeof params.enabled !== 'boolean') {
-    throw new ArgumentError('Must provide enabled boolean value');
+  getAll(...args) {
+    return this.invoke('getAll', args);
   }
 
-  if (typeof params.maxRetries !== 'number' || params.maxRetries <= 0) {
-    throw new ArgumentError('Must provide maxRetries as a positive number');
+  get(...args) {
+    return this.invoke('get', args);
   }
 
-  this.restClient = restClient;
-  this.enabled = params.enabled;
-  this.retryOptions = Object.assign({ retries: params.maxRetries }, params);
-};
-
-RetryRestClient.prototype.getAll = function(/* [params], [callback] */) {
-  return this.invoke('getAll', arguments);
-};
-
-RetryRestClient.prototype.get = function(/* [params], [callback] */) {
-  return this.invoke('get', arguments);
-};
-
-RetryRestClient.prototype.create = function(/* [params], [callback] */) {
-  return this.invoke('create', arguments);
-};
-
-RetryRestClient.prototype.patch = function(/* [params], [callback] */) {
-  return this.invoke('patch', arguments);
-};
+  create(...args) {
+    return this.invoke('create', args);
+  }
 
-RetryRestClient.prototype.update = function(/* [params], [callback] */) {
-  return this.invoke('update', arguments);
-};
+  patch(...args) {
+    return this.invoke('patch', args);
+  }
 
-RetryRestClient.prototype.delete = function(/* [params], [callback] */) {
-  return this.invoke('delete', arguments);
-};
+  update(...args) {
+    return this.invoke('update', args);
+  }
 
-RetryRestClient.prototype.invoke = function(method, args) {
-  var cb;
-  args = Array.prototype.slice.call(args); // convert array-like object to array.
-  if (args && args[args.length - 1] instanceof Function) {
-    cb = args[args.length - 1];
-    args.pop(); // Remove the callback
+  delete(...args) {
+    return this.invoke('delete', args);
   }
 
-  var promise = this.handleRetry(method, args);
+  invoke(method, args) {
+    let cb;
+    if (args && args[args.length - 1] instanceof Function) {
+      cb = args[args.length - 1];
+      args.pop(); // Remove the callback
+    }
 
-  if (cb instanceof Function) {
-    promise.then(cb.bind(null, null)).catch(cb);
-    return;
-  }
+    const promise = this.handleRetry(method, args);
 
-  return promise;
-};
+    if (cb instanceof Function) {
+      promise.then(cb.bind(null, null)).catch(cb);
+      return;
+    }
 
-RetryRestClient.prototype.handleRetry = function(method, args) {
-  if (!this.enabled) {
-    return this.restClient[method].apply(this.restClient, args);
+    return promise;
   }
 
-  var self = this;
-  return new Promise(function(resolve, reject) {
-    var operation = retry.operation(self.retryOptions);
-
-    operation.attempt(function() {
-      self.restClient[method]
-        .apply(self.restClient, args)
-        .then(function(body) {
-          resolve(body);
-        })
-        .catch(function(err) {
-          if (err && err.statusCode === 429 && operation.retry(err)) {
-            return;
-          }
-          reject(err);
-        });
+  handleRetry(method, args) {
+    if (!this.enabled) {
+      return this.restClient[method](...args);
+    }
+
+    return new Promise((resolve, reject) => {
+      const operation = retry.operation(this.retryOptions);
+
+      operation.attempt(() => {
+        this.restClient[method](...args)
+          .then((body) => {
+            resolve(body);
+          })
+          .catch((err) => {
+            if (err && err.statusCode === 429 && operation.retry(err)) {
+              return;
+            }
+            reject(err);
+          });
+      });
     });
-  });
-};
+  }
+}
 
 module.exports = RetryRestClient;