auth0 2.42.0 → 2.44.0

package/src/management/StatsManager.js

@@ -1,11 +1,9 @@
-const { ArgumentError } = require('rest-facade');
-const Auth0RestClient = require('../Auth0RestClient');
-const RetryRestClient = require('../RetryRestClient');
+const BaseManager = require('./BaseManager');
 
 /**
  * Abstracts interaction with the stats endpoint.
  */
-class StatsManager {
+class StatsManager extends BaseManager {
   /**
    * @param {object} options            The client options.
    * @param {string} options.baseUrl    The URL of the API.
@@ -13,23 +11,7 @@ class StatsManager {
    * @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 ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
-      throw new ArgumentError('The provided base URL is invalid');
-    }
-
-    const clientOptions = {
-      errorFormatter: { message: 'message', name: 'error' },
-      headers: options.headers,
-      query: { repeatParams: false },
-    };
+    super(options);
 
     /**
      * Provides an abstraction layer for consuming the
@@ -37,12 +19,7 @@ class StatsManager {
      *
      * @type {external:RestClient}
      */
-    const auth0RestClient = new Auth0RestClient(
-      `${options.baseUrl}/stats/:type`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.resource = new RetryRestClient(auth0RestClient, options.retry);
+    this.resource = this._getRestClient('/stats/:type');
   }
 
   /**

package/src/management/TenantManager.js

@@ -1,11 +1,9 @@
-const { ArgumentError } = require('rest-facade');
-const Auth0RestClient = require('../Auth0RestClient');
-const RetryRestClient = require('../RetryRestClient');
+const BaseManager = require('./BaseManager');
 
 /**
  * Abstracts interaction with the tenant endpoint.
  */
-class TenantManager {
+class TenantManager extends BaseManager {
   /**
    * @param {object} options            The client options.
    * @param {string} options.baseUrl    The URL of the API.
@@ -13,23 +11,7 @@ class TenantManager {
    * @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 ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
-      throw new ArgumentError('The provided base URL is invalid');
-    }
-
-    const clientOptions = {
-      errorFormatter: { message: 'message', name: 'error' },
-      headers: options.headers,
-      query: { repeatParams: false },
-    };
+    super(options);
 
     /**
      * Provides an abstraction layer for consuming the
@@ -37,12 +19,7 @@ class TenantManager {
      *
      * @type {external:RestClient}
      */
-    const auth0RestClient = new Auth0RestClient(
-      `${options.baseUrl}/tenants/settings`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.resource = new RetryRestClient(auth0RestClient, options.retry);
+    this.resource = this._getRestClient('/tenants/settings');
   }
 
   /**

package/src/management/TicketsManager.js

@@ -1,11 +1,9 @@
-const { ArgumentError } = require('rest-facade');
-const Auth0RestClient = require('../Auth0RestClient');
-const RetryRestClient = require('../RetryRestClient');
+const BaseManager = require('./BaseManager');
 
 /**
  * Abstracts interaction with the tickets endpoint.
  */
-class TicketsManager {
+class TicketsManager extends BaseManager {
   /**
    * @param {object} options            The client options.
    * @param {string} options.baseUrl    The URL of the API.
@@ -13,23 +11,7 @@ class TicketsManager {
    * @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 ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
-      throw new ArgumentError('The provided base URL is invalid');
-    }
-
-    const clientOptions = {
-      errorFormatter: { message: 'message', name: 'error' },
-      headers: options.headers,
-      query: { repeatParams: false },
-    };
+    super(options);
 
     /**
      * Provides an abstraction layer for consuming the
@@ -37,12 +19,7 @@ class TicketsManager {
      *
      * @type {external:RestClient}
      */
-    const auth0RestClient = new Auth0RestClient(
-      `${options.baseUrl}/tickets/:type`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.resource = new RetryRestClient(auth0RestClient, options.retry);
+    this.resource = this._getRestClient('/tickets/:type');
   }
 
   /**

package/src/management/UserBlocksManager.js

@@ -1,11 +1,10 @@
 const { ArgumentError } = require('rest-facade');
-const Auth0RestClient = require('../Auth0RestClient');
-const RetryRestClient = require('../RetryRestClient');
+const BaseManager = require('./BaseManager');
 
 /**
  * Abstracts interaction with the user-blocks endpoint.
  */
-class UserBlocksManager {
+class UserBlocksManager extends BaseManager {
   /**
    * @param {object} options            The client options.
    * @param {string} options.baseUrl    The URL of the API.
@@ -13,40 +12,11 @@ class UserBlocksManager {
    * @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 ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
-      throw new ArgumentError('The provided base URL is invalid');
-    }
-
-    const clientOptions = {
-      errorFormatter: { message: 'message', name: 'error' },
-      headers: options.headers,
-      query: { repeatParams: false },
-    };
+    super(options);
 
-    const userBlocksByIdResource = new Auth0RestClient(
-      `${options.baseUrl}/user-blocks/:id`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.userBlocksById = new RetryRestClient(userBlocksByIdResource, options.retry);
+    this.userBlocksById = this._getRestClient('/user-blocks/:id');
 
-    const userBlocksByIdentifierResource = new Auth0RestClient(
-      `${options.baseUrl}/user-blocks`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.userBlocksByIdentifier = new RetryRestClient(
-      userBlocksByIdentifierResource,
-      options.retry
-    );
+    this.userBlocksByIdentifier = this._getRestClient('/user-blocks');
   }
 
   /**

package/src/management/UsersManager.js

@@ -1,12 +1,12 @@
 const { ArgumentError } = require('rest-facade');
-const Auth0RestClient = require('../Auth0RestClient');
-const RetryRestClient = require('../RetryRestClient');
+const BaseManager = require('./BaseManager');
+
 const { sanitizeArguments } = require('../utils');
 
 /**
  * Abstracts interaction with the users endpoint.
  */
-class UsersManager {
+class UsersManager extends BaseManager {
   /**
    * @param {object} options            The client options.
    * @param {string} options.baseUrl    The URL of the API.
@@ -14,30 +14,9 @@ class UsersManager {
    * @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 ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
-      throw new ArgumentError('The provided base URL is invalid');
-    }
+    super(options);
 
-    const clientOptions = {
-      errorFormatter: { message: 'message', name: 'error' },
-      headers: options.headers,
-      query: { repeatParams: false },
-    };
-
-    const usersAuth0RestClient = new Auth0RestClient(
-      `${options.baseUrl}/users/:id`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.users = new RetryRestClient(usersAuth0RestClient, options.retry);
+    this.users = this._getRestClient('/users/:id');
 
     /**
      * Provides an abstraction layer for consuming the
@@ -46,89 +25,50 @@ class UsersManager {
      *
      * @type {external:RestClient}
      */
-    const multifactorAuth0RestClient = new Auth0RestClient(
-      `${options.baseUrl}/users/:id/multifactor/:provider`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.multifactor = new RetryRestClient(multifactorAuth0RestClient, options.retry);
+    this.multifactor = this._getRestClient('/users/:id/multifactor/:provider');
 
     /**
      * Provides a simple abstraction layer for linking user accounts.
      *
      * @type {external:RestClient}
      */
-    const identitiesAuth0RestClient = new Auth0RestClient(
-      `${options.baseUrl}/users/:id/identities/:provider/:user_id`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.identities = new RetryRestClient(identitiesAuth0RestClient, options.retry);
+    this.identities = this._getRestClient('/users/:id/identities/:provider/:user_id');
 
     /**
      * Provides a simple abstraction layer for user logs
      *
      * @type {external:RestClient}
      */
-    const userLogsAuth0RestClient = new Auth0RestClient(
-      `${options.baseUrl}/users/:id/logs`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.userLogs = new RetryRestClient(userLogsAuth0RestClient, options.retry);
+    this.userLogs = this._getRestClient('/users/:id/logs');
 
     /**
      * Provides an abstraction layer for retrieving Guardian enrollments.
      *
      * @type {external:RestClient}
      */
-    const enrollmentsAuth0RestClient = new Auth0RestClient(
-      `${options.baseUrl}/users/:id/enrollments`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.enrollments = new RetryRestClient(enrollmentsAuth0RestClient, options.retry);
+    this.enrollments = this._getRestClient('/users/:id/enrollments');
 
     /**
      * Provides an abstraction layer for the new "users-by-email" API
      *
      * @type {external:RestClient}
      */
-    const usersByEmailClient = new Auth0RestClient(
-      `${options.baseUrl}/users-by-email`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.usersByEmail = new RetryRestClient(usersByEmailClient, options.retry);
+    this.usersByEmail = this._getRestClient('/users-by-email');
 
     /**
      * Provides an abstraction layer for regenerating Guardian recovery codes.
      *
      * @type {external:RestClient}
      */
-    const recoveryCodeRegenerationAuth0RestClients = new Auth0RestClient(
-      `${options.baseUrl}/users/:id/recovery-code-regeneration`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.recoveryCodeRegenerations = new RetryRestClient(
-      recoveryCodeRegenerationAuth0RestClients,
-      options.retry
-    );
+    this.recoveryCodeRegenerations = this._getRestClient('/users/:id/recovery-code-regeneration');
 
     /**
      * Provides an abstraction layer for invalidating all remembered browsers for MFA.
      *
      * @type {external:RestClient}
      */
-    const invalidateRememberBrowserAuth0RestClients = new Auth0RestClient(
-      `${options.baseUrl}/users/:id/multifactor/actions/invalidate-remember-browser`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.invalidateRememberBrowsers = new RetryRestClient(
-      invalidateRememberBrowserAuth0RestClients,
-      options.retry
+    this.invalidateRememberBrowsers = this._getRestClient(
+      '/users/:id/multifactor/actions/invalidate-remember-browser'
     );
 
     /**
@@ -136,31 +76,16 @@ class UsersManager {
      *
      * @type {external:RestClient}
      */
-    const userRolesClient = new Auth0RestClient(
-      `${options.baseUrl}/users/:id/roles`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.roles = new RetryRestClient(userRolesClient, options.retry);
+    this.roles = this._getRestClient('/users/:id/roles');
 
     /**
      * Provides an abstraction layer for CRD on permissions directly on a user
      *
      * @type {external:RestClient}
      */
-    const userPermissionsClient = new Auth0RestClient(
-      `${options.baseUrl}/users/:id/permissions`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.permissions = new RetryRestClient(userPermissionsClient, options.retry);
+    this.permissions = this._getRestClient('/users/:id/permissions');
 
-    const organizationsClient = new Auth0RestClient(
-      `${options.baseUrl}/users/:id/organizations`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.organizations = new RetryRestClient(organizationsClient, options.retry);
+    this.organizations = this._getRestClient('/users/:id/organizations');
   }
 
   /**

package/src/management/index.js

@@ -90,6 +90,8 @@ class ManagementClient {
    * @param   {boolean} [options.retry.enabled=true]                Enabled or Disable Retry Policy functionality.
    * @param   {number}  [options.retry.maxRetries=10]               Retry failed requests X times.
    * @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'
+   * @param   {boolean}  [options.includeResponseHeaders]            Include the response headers in the payload in the format `{ data, headers }`.
    */
   constructor(options) {
     if (!options || typeof options !== 'object') {
@@ -147,6 +149,8 @@ class ManagementClient {
     }
 
     managerOptions.retry = options.retry;
+    managerOptions.includeResponseHeaders = options.includeResponseHeaders;
+    managerOptions.proxy = options.proxy;
 
     /**
      * Simple abstraction for performing CRUD operations on the
@@ -523,6 +527,8 @@ class ManagementClient {
    * });
    * @param   {object}    params            Client parameters.
    * @param   {string}    params.client_id  Application client ID.
+   * @param   {string}    params.fields     Comma-separated list of fields to include or exclude (based on value provided for include_fields).
+   * @param   {string}    params.include_fields  Whether specified fields are to be included (true) or excluded (false).
    * @param   {Function}  [cb]              Callback function.
    * @returns  {Promise|undefined}
    */