auth0 2.37.0 → 2.40.0

package/src/management/ManagementTokenProvider.js

@@ -1,143 +1,135 @@
-var ArgumentError = require('rest-facade').ArgumentError;
-var AuthenticationClient = require('../auth');
-var memoizer = require('lru-memoizer');
-var es6Promisify = require('es6-promisify');
-
-var DEFAULT_OPTIONS = { enableCache: true };
+const { ArgumentError } = require('rest-facade');
+const AuthenticationClient = require('../auth');
+const memoizer = require('lru-memoizer');
+const util = require('util');
 
 /**
- * @class ManagementTokenProvider
  * Auth0 Management API Token Provider.
- * @constructor
- * @memberOf module:management
- *
- * @param {Object}  options                         Options for the ManagementTokenProvider.
- * @param {String}  options.domain                  ManagementClient server domain.
- * @param {String}  options.clientId                Non Interactive Client Id.
- * @param {String}  options.clientSecret            Non Interactive Client Secret.
- * @param {String}  options.scope                   Non Interactive Client Scope.
- * @param {String}  options.audience                Audience of the Management API.
- * @param {Boolean} [options.enableCache=true]      Enabled or Disable Cache
- * @param {Number}  [options.cacheTTLInSeconds]     By default the `expires_in` value will be used to determine the cached time of the token, this can be overridden.
- * @param {Object}  [options.headers]               Additional headers that will be added to the outgoing requests.
- *
  */
-var ManagementTokenProvider = function(options) {
-  if (!options || typeof options !== 'object') {
-    throw new ArgumentError('Options must be an object');
-  }
+class ManagementTokenProvider {
+  /**
+   * @param {object}  options                         Options for the ManagementTokenProvider.
+   * @param {string}  options.domain                  ManagementClient server domain.
+   * @param {string}  options.clientId                Non Interactive Client Id.
+   * @param {string}  options.clientSecret            Non Interactive Client Secret.
+   * @param {string}  options.scope                   Non Interactive Client Scope.
+   * @param {string}  options.audience                Audience of the Management API.
+   * @param {boolean} [options.enableCache=true]      Enabled or Disable Cache
+   * @param {number}  [options.cacheTTLInSeconds]     By default the `expires_in` value will be used to determine the cached time of the token, this can be overridden.
+   * @param {object}  [options.headers]               Additional headers that will be added to the outgoing requests.
+   */
+  constructor(options) {
+    if (!options || typeof options !== 'object') {
+      throw new ArgumentError('Options must be an object');
+    }
 
-  var params = Object.assign({}, DEFAULT_OPTIONS, options);
+    const params = { enableCache: true, ...options };
 
-  if (!params.domain || params.domain.length === 0) {
-    throw new ArgumentError('Must provide a domain');
-  }
+    if (!params.domain || params.domain.length === 0) {
+      throw new ArgumentError('Must provide a domain');
+    }
 
-  if (!params.clientId || params.clientId.length === 0) {
-    throw new ArgumentError('Must provide a clientId');
-  }
+    if (!params.clientId || params.clientId.length === 0) {
+      throw new ArgumentError('Must provide a clientId');
+    }
 
-  if (!params.clientSecret || params.clientSecret.length === 0) {
-    throw new ArgumentError('Must provide a clientSecret');
-  }
+    if (!params.clientSecret || params.clientSecret.length === 0) {
+      throw new ArgumentError('Must provide a clientSecret');
+    }
 
-  if (!params.audience || params.audience.length === 0) {
-    throw new ArgumentError('Must provide a audience');
-  }
+    if (!params.audience || params.audience.length === 0) {
+      throw new ArgumentError('Must provide a audience');
+    }
 
-  if (typeof params.enableCache !== 'boolean') {
-    throw new ArgumentError('enableCache must be a boolean');
-  }
+    if (typeof params.enableCache !== 'boolean') {
+      throw new ArgumentError('enableCache must be a boolean');
+    }
+
+    if (params.enableCache && params.cacheTTLInSeconds) {
+      if (typeof params.cacheTTLInSeconds !== 'number') {
+        throw new ArgumentError('cacheTTLInSeconds must be a number');
+      }
 
-  if (params.enableCache && params.cacheTTLInSeconds) {
-    if (typeof params.cacheTTLInSeconds !== 'number') {
-      throw new ArgumentError('cacheTTLInSeconds must be a number');
+      if (params.cacheTTLInSeconds <= 0) {
+        throw new ArgumentError('cacheTTLInSeconds must be a greater than 0');
+      }
     }
 
-    if (params.cacheTTLInSeconds <= 0) {
-      throw new ArgumentError('cacheTTLInSeconds must be a greater than 0');
+    if (params.scope && typeof params.scope !== 'string') {
+      throw new ArgumentError('scope must be a string');
     }
-  }
 
-  if (params.scope && typeof params.scope !== 'string') {
-    throw new ArgumentError('scope must be a string');
+    this.options = params;
+    const authenticationClientOptions = {
+      domain: this.options.domain,
+      clientId: this.options.clientId,
+      clientSecret: this.options.clientSecret,
+      telemetry: this.options.telemetry,
+      clientInfo: this.options.clientInfo,
+      headers: this.options.headers,
+    };
+    this.authenticationClient = new AuthenticationClient(authenticationClientOptions);
+
+    const self = this;
+    this.getCachedAccessToken = util.promisify(
+      memoizer({
+        load(options, callback) {
+          self
+            .clientCredentialsGrant(options.domain, options.scope, options.audience)
+            .then((data) => {
+              callback(null, data);
+            })
+            .catch((err) => {
+              callback(err);
+            });
+        },
+        hash(options) {
+          return `${options.domain}-${options.clientId}-${options.scope}`;
+        },
+        itemMaxAge(options, data) {
+          if (options.cacheTTLInSeconds) {
+            return options.cacheTTLInSeconds * 1000;
+          }
+
+          // if the expires_in is lower or equal to than 10 seconds, do not subtract 10 additional seconds.
+          if (data.expires_in && data.expires_in <= 10 /* seconds */) {
+            return data.expires_in * 1000;
+          } else if (data.expires_in) {
+            // Subtract 10 seconds from expires_in to fetch a new one, before it expires.
+            return data.expires_in * 1000 - 10000 /* milliseconds */;
+          }
+          return 60 * 60 * 1000; //1h
+        },
+        max: 100,
+      })
+    );
   }
 
-  this.options = params;
-  var authenticationClientOptions = {
-    domain: this.options.domain,
-    clientId: this.options.clientId,
-    clientSecret: this.options.clientSecret,
-    telemetry: this.options.telemetry,
-    clientInfo: this.options.clientInfo,
-    headers: this.options.headers
-  };
-  this.authenticationClient = new AuthenticationClient(authenticationClientOptions);
-
-  var self = this;
-  this.getCachedAccessToken = es6Promisify.promisify(
-    memoizer({
-      load: function(options, callback) {
-        self
-          .clientCredentialsGrant(options.domain, options.scope, options.audience)
-          .then(function(data) {
-            callback(null, data);
-          })
-          .catch(function(err) {
-            callback(err);
-          });
-      },
-      hash: function(options) {
-        return options.domain + '-' + options.clientId + '-' + options.scope;
-      },
-      itemMaxAge: function(options, data) {
-        if (options.cacheTTLInSeconds) {
-          return options.cacheTTLInSeconds * 1000;
-        }
-
-        // if the expires_in is lower or equal to than 10 seconds, do not subtract 10 additional seconds.
-        if (data.expires_in && data.expires_in <= 10 /* seconds */) {
-          return data.expires_in * 1000;
-        } else if (data.expires_in) {
-          // Subtract 10 seconds from expires_in to fetch a new one, before it expires.
-          return data.expires_in * 1000 - 10000 /* milliseconds */;
-        }
-        return 60 * 60 * 1000; //1h
-      },
-      max: 100
-    })
-  );
-};
-
-/**
- * Returns the access_token.
- *
- * @method    getAccessToken
- * @memberOf  module:management.ManagementTokenProvider.prototype
- *
- * @return {Promise}   Promise returning an access_token.
- */
-ManagementTokenProvider.prototype.getAccessToken = function() {
-  if (this.options.enableCache) {
-    return this.getCachedAccessToken(this.options).then(function(data) {
+  /**
+   * Returns the access_token.
+   *
+   * @returns {Promise} Promise returning an access_token.
+   */
+  async getAccessToken() {
+    if (this.options.enableCache) {
+      const data = await this.getCachedAccessToken(this.options);
       return data.access_token;
-    });
-  } else {
-    return this.clientCredentialsGrant(
-      this.options.domain,
-      this.options.scope,
-      this.options.audience
-    ).then(function(data) {
+    } else {
+      const data = await this.clientCredentialsGrant(
+        this.options.domain,
+        this.options.scope,
+        this.options.audience
+      );
       return data.access_token;
+    }
+  }
+
+  clientCredentialsGrant(domain, scope, audience) {
+    return this.authenticationClient.clientCredentialsGrant({
+      audience,
+      scope,
     });
   }
-};
-
-ManagementTokenProvider.prototype.clientCredentialsGrant = function(domain, scope, audience) {
-  return this.authenticationClient.clientCredentialsGrant({
-    audience: audience,
-    scope: scope
-  });
-};
+}
 
 module.exports = ManagementTokenProvider;

package/src/management/MigrationsManager.js

@@ -1,108 +1,99 @@
-var ArgumentError = require('rest-facade').ArgumentError;
-var Auth0RestClient = require('../Auth0RestClient');
-var RetryRestClient = require('../RetryRestClient');
+const { ArgumentError } = require('rest-facade');
+const Auth0RestClient = require('../Auth0RestClient');
+const RetryRestClient = require('../RetryRestClient');
 
 /**
- * @class
  * Abstracts interaction with the migrations endpoint.
- * @constructor
- * @memberOf module:management
- *
- * @param {Object} options            The client options.
- * @param {String} options.baseUrl    The URL of the API.
- * @param {Object} [options.headers]  Headers to be included in all requests.
- * @param {Object} [options.retry]    Retry Policy Config
  */
-var MigrationsManager = function(options) {
-  if (options === null || typeof options !== 'object') {
-    throw new ArgumentError('Must provide manager options');
-  }
+class MigrationsManager {
+  /**
+   * @param {object} options            The client options.
+   * @param {string} options.baseUrl    The URL of the API.
+   * @param {object} [options.headers]  Headers to be included in all requests.
+   * @param {object} [options.retry]    Retry Policy Config
+   */
+  constructor(options) {
+    if (options === null || typeof options !== 'object') {
+      throw new ArgumentError('Must provide manager options');
+    }
 
-  if (options.baseUrl === null || options.baseUrl === undefined) {
-    throw new ArgumentError('Must provide a base URL for the API');
-  }
+    if (options.baseUrl === null || options.baseUrl === undefined) {
+      throw new ArgumentError('Must provide a base URL for the API');
+    }
 
-  if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
-    throw new ArgumentError('The provided base URL is invalid');
-  }
+    if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+      throw new ArgumentError('The provided base URL is invalid');
+    }
 
-  var clientOptions = {
-    errorFormatter: { message: 'message', name: 'error' },
-    headers: options.headers,
-    query: { repeatParams: false }
-  };
+    const clientOptions = {
+      errorFormatter: { message: 'message', name: 'error' },
+      headers: options.headers,
+      query: { repeatParams: false },
+    };
+
+    /**
+     * Provides an abstraction layer for consuming the migrations endpoint
+     *
+     * @type {external:RestClient}
+     */
+    const auth0RestClient = new Auth0RestClient(
+      `${options.baseUrl}/migrations`,
+      clientOptions,
+      options.tokenProvider
+    );
+    this.resource = new RetryRestClient(auth0RestClient, options.retry);
+  }
 
   /**
-   * Provides an abstraction layer for consuming the migrations endpoint
+   * Update the tenant migrations.
    *
-   * @type {external:RestClient}
+   * @example
+   * management.migrations.updateMigrations(data, function (err) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   * });
+   * @param   {object}    data  The tenant migrations to be updated
+   * @param   {object}    data.flags  The tenant migrations flags to be updated
+   * @param   {Function}  [cb]  Callback function.
+   * @returns  {Promise|undefined}
    */
-  var auth0RestClient = new Auth0RestClient(
-    options.baseUrl + '/migrations',
-    clientOptions,
-    options.tokenProvider
-  );
-  this.resource = new RetryRestClient(auth0RestClient, options.retry);
-};
+  updateMigrations(data, cb) {
+    if (cb && cb instanceof Function) {
+      return this.resource.patch({}, data, cb);
+    }
 
-/**
- * Update the tenant migrations.
- *
- * @method    updateMigrations
- * @memberOf  module:management.MigrationsManager.prototype
- *
- * @example
- * management.migrations.updateMigrations(data, function (err) {
- *   if (err) {
- *     // Handle error.
- *   }
- * });
- *
- * @param   {Object}    data  The tenant migrations to be updated
- * @param   {Object}    data.flags  The tenant migrations flags to be updated
- * @param   {Function}  [cb]  Callback function.
- *
- * @return  {Promise|undefined}
- */
-MigrationsManager.prototype.updateMigrations = function(data, cb) {
-  if (cb && cb instanceof Function) {
-    return this.resource.patch({}, data, cb);
+    // Return a promise.
+    return this.resource.patch({}, data);
   }
 
-  // Return a promise.
-  return this.resource.patch({}, data);
-};
+  /**
+   * Get the tenant migrations.
+   *
+   * @example
+   * management.migrations.getMigrations(function (err, migrations) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   console.log(migrations.flags);
+   * });
+   * @param data
+   * @param   {Function}  [cb]    Callback function.
+   * @returns  {Promise|undefined}
+   */
+  getMigrations(data, cb) {
+    if (data instanceof Function && !cb) {
+      cb = data;
+      data = {};
+    }
+    if (cb && cb instanceof Function) {
+      return this.resource.get(data, cb);
+    }
 
-/**
- * Get the tenant migrations.
- *
- * @method    getMigrations
- * @memberOf  module:management.MigrationsManager.prototype
- *
- * @example
- * management.migrations.getMigrations(function (err, migrations) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   console.log(migrations.flags);
- * });
- *
- * @param   {Function}  [cb]    Callback function.
- *
- * @return  {Promise|undefined}
- */
-MigrationsManager.prototype.getMigrations = function(data, cb) {
-  if (data instanceof Function && !cb) {
-    cb = data;
-    data = {};
+    // Return a promise.
+    return this.resource.get(data);
   }
-  if (cb && cb instanceof Function) {
-    return this.resource.get(data, cb);
-  }
-
-  // Return a promise.
-  return this.resource.get(data);
-};
+}
 
 module.exports = MigrationsManager;