auth0 3.3.0 → 4.0.0-beta.0

package/src/management/LogStreamsManager.js

@@ -1,136 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * The logStreams class provides a simple abstraction for performing CRUD operations
- * on Auth0 Log Streams.
- */
-class LogStreamsManager extends BaseManager {
-  /**
-   * @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) {
-    super(options);
-
-    /**
-     * Provides an abstraction layer for performing CRUD operations on
-     * {@link https://auth0.com/docs/api/management/v2#!/Log_Streams Auth0
-     *  Log Streams}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/log-streams/:id ');
-  }
-
-  /**
-   * Get all Log Streams.
-   *
-   * @example
-   *
-   * management.logStreams.getAll(function (err, logStreams) {
-   *   console.log(logStreams.length);
-   * });
-   * @param   {Function}  [cb]                    Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getAll(...args) {
-    return this.resource.getAll(...args);
-  }
-
-  /**
-   * Get an Auth0 Log Streams.
-   *
-   * @example
-   * management.logStreams.get({ id: LOG_STREAM_ID }, function (err, logStream) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(logStream);
-   * });
-   * @param   {object}    params          Log Stream parameters.
-   * @param   {string}    params.id       Log Stream ID.
-   * @param   {Function}  [cb]            Callback function.
-   * @returns  {Promise|undefined}
-   */
-  get(...args) {
-    return this.resource.get(...args);
-  }
-
-  /**
-   * Create an Auth0 Log Stream.
-   *
-   * @example
-   * management.logStreams.create(data, function (err, log) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(log);
-   * });
-   * @param   {object}    data          Log Stream data.
-   * @param   {Function}  [cb]          Callback function.
-   * @returns  {Promise|undefined}
-   */
-  create(...args) {
-    return this.resource.create(...args);
-  }
-
-  /**
-   * Update an Auth0 Log Streams.
-   *
-   * @example
-   * var data = { name: 'New name' };
-   * var params = { id: LOG_STREAM_ID };
-   *
-   * // Using auth0 instance.
-   * management.updateLogStream(params, data, function (err, logStream) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(logStream.name);  // 'New name'
-   * });
-   *
-   * // Using the logStreams manager directly.
-   * management.logStreams.update(params, data, function (err, logStream) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(logStream.name);
-   * });
-   * @param   {object}    params          Log Stream parameters.
-   * @param   {string}    params.id       Log Stream ID.
-   * @param   {object}    data            Updated Log Stream data.
-   * @param   {Function}  [cb]            Callback function.
-   * @returns  {Promise|undefined}
-   */
-  update(...args) {
-    return this.resource.patch(...args);
-  }
-
-  /**
-   * Delete an Auth0 Log Streams.
-   *
-   * @example
-   * management.logStreams.delete({ id: LOG_STREAM_ID }, function (err, log) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(log);
-   * });
-   * @param   {object}    params          Log Stream parameters.
-   * @param   {string}    params.id       Log Stream ID.
-   * @param   {Function}  [cb]            Callback function.
-   * @returns  {Promise|undefined}
-   */
-  delete(...args) {
-    return this.resource.delete(...args);
-  }
-}
-
-module.exports = LogStreamsManager;

package/src/management/LogsManager.js

@@ -1,82 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * Represents the relationship between Auth0 and an Identity provider.
- */
-class LogsManager extends BaseManager {
-  /**
-   * @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) {
-    super(options);
-
-    /**
-     * Provides an abstraction layer for performing CRUD operations on
-     * {@link https://auth0.com/docs/api/v2#!/LogsManagers Auth0
-     *  Logs}.
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/logs/:id');
-  }
-
-  /**
-   * Get all logs.
-   *
-   * @example <caption>
-   *   This method takes an optional object as first argument that may be used to
-   *   specify pagination settings and the search query. If pagination options are
-   *   not present, the first page of a limited number of results will be returned.
-   * </caption>
-   *
-   * // Pagination settings.
-   * var params = {
-   *   per_page: 10,
-   *   page: 2
-   * };
-   *
-   * management.logs.getAll(params, function (err, logs) {
-   *   console.log(logs.length);
-   * });
-   * @param   {object}    [params]                Logs params.
-   * @param   {string}    [params.q]              Search Criteria using Query String Syntax
-   * @param   {number}    [params.page]           Page number. Zero based
-   * @param   {number}    [params.per_page]       The amount of entries per page
-   * @param   {string}    [params.sort]           The field to use for sorting.
-   * @param   {string}    [params.fields]         A comma separated list of fields to include or exclude
-   * @param   {boolean}   [params.include_fields] true if the fields specified are to be included in the result, false otherwise.
-   * @param   {boolean}   [params.include_totals] true if a query summary must be included in the result, false otherwise. Default false
-   * @param   {string}    [params.from]           For checkpoint pagination, log event Id from which to start selection from.
-   * @param   {number}    [params.take]           When using the `from` parameter, the number of entries to retrieve. Default 50, max 100.
-   * @param   {Function}  [cb]                    Callback function.
-   * @returns  {Promise|undefined}
-   */
-  getAll(...args) {
-    return this.resource.getAll(...args);
-  }
-
-  /**
-   * Get an Auth0 log.
-   *
-   * @example
-   * management.logs.get({ id: EVENT_ID }, function (err, log) {
-   *   if (err) {
-   *     // Handle error.
-   *   }
-   *
-   *   console.log(log);
-   * });
-   * @param   {object}    params          Log parameters.
-   * @param   {string}    params.id       Log ID.
-   * @param   {Function}  [cb]            Callback function.
-   * @returns  {Promise|undefined}
-   */
-  get(...args) {
-    return this.resource.get(...args);
-  }
-}
-
-module.exports = LogsManager;

package/src/management/ManagementTokenProvider.js

@@ -1,144 +0,0 @@
-const { ArgumentError } = require('rest-facade');
-const AuthenticationClient = require('../auth');
-const memoizer = require('lru-memoizer');
-const util = require('util');
-
-/**
- * Auth0 Management API Token Provider.
- */
-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.clientAssertionSigningKey Private key used to sign the client assertion JWT.
-   * @param {string}  options.clientAssertionSigningAlg Default 'RS256'.
-   * @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.
-   * @param {string}  [options.proxy]                 Add the `superagent-proxy` dependency and specify a proxy url eg 'https://myproxy.com:1234'
-   */
-  constructor(options) {
-    if (!options || typeof options !== 'object') {
-      throw new ArgumentError('Options must be an object');
-    }
-
-    const params = { enableCache: true, ...options };
-
-    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.clientSecret || params.clientSecret.length === 0) &&
-      (!params.clientAssertionSigningKey || params.clientAssertionSigningKey.length === 0)
-    ) {
-      throw new ArgumentError('Must provide a clientSecret or a clientAssertionSigningKey');
-    }
-
-    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 (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.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,
-      clientAssertionSigningKey: this.options.clientAssertionSigningKey,
-      clientAssertionSigningAlg: this.options.clientAssertionSigningAlg,
-      telemetry: this.options.telemetry,
-      clientInfo: this.options.clientInfo,
-      headers: this.options.headers,
-      proxy: this.options.proxy,
-    };
-    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,
-      })
-    );
-  }
-
-  /**
-   * 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 {
-      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,
-    });
-  }
-}
-
-module.exports = ManagementTokenProvider;

package/src/management/MigrationsManager.js

@@ -1,76 +0,0 @@
-const BaseManager = require('./BaseManager');
-
-/**
- * Abstracts interaction with the migrations endpoint.
- */
-class MigrationsManager extends BaseManager {
-  /**
-   * @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) {
-    super(options);
-
-    /**
-     * Provides an abstraction layer for consuming the migrations endpoint
-     *
-     * @type {external:RestClient}
-     */
-    this.resource = this._getRestClient('/migrations');
-  }
-
-  /**
-   * Update the tenant migrations.
-   *
-   * @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}
-   */
-  updateMigrations(data, cb) {
-    if (cb && cb instanceof Function) {
-      return this.resource.patch({}, data, cb);
-    }
-
-    // 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);
-    }
-
-    // Return a promise.
-    return this.resource.get(data);
-  }
-}
-
-module.exports = MigrationsManager;