auth0 2.41.0 → 2.43.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## [v2.43.0](https://github.com/auth0/node-auth0/tree/v2.43.0) (2022-10-10)
+
+[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.42.0...v2.43.0)
+
+**Added**
+
+- Add option to include response headers in the result [\#744](https://github.com/auth0/node-auth0/pull/744) ([adamjmcgrath](https://github.com/adamjmcgrath))
+
+## [v2.42.0](https://github.com/auth0/node-auth0/tree/v2.42.0) (2022-05-23)
+
+[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.41.0...v2.42.0)
+
+**Added**
+
+- chore: add branding theme routes [\#725](https://github.com/auth0/node-auth0/pull/725) ([alejofernandez](https://github.com/alejofernandez))
+
 ## [v2.41.0](https://github.com/auth0/node-auth0/tree/v2.41.0) (2022-05-20)
 
 [Full Changelog](https://github.com/auth0/node-auth0/compare/v2.40.0...v2.41.0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0",
-  "version": "2.41.0",
+  "version": "2.43.0",
   "description": "SDK for Auth0 API v2",
   "main": "src/index.js",
   "sideEffects": false,
@@ -10,7 +10,6 @@
   "scripts": {
     "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",
     "jsdoc:generate": "jsdoc --configure .jsdoc.json --verbose",
     "precommit": "pretty-quick --staged",
@@ -34,7 +33,7 @@
   },
   "homepage": "https://github.com/auth0/node-auth0",
   "dependencies": {
-    "axios": "^0.26.1",
+    "axios": "^0.27.2",
     "form-data": "^3.0.1",
     "jsonwebtoken": "^8.5.1",
     "jwks-rsa": "^1.12.1",
@@ -44,14 +43,13 @@
   },
   "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": "^8.16.0",
+    "eslint-config-prettier": "^8.5.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",
+    "eslint-plugin-promise": "^6.0.0",
     "husky": "^3.0.1",
     "jsdoc": "^3.6.7",
     "json-loader": "^0.5.7",
@@ -59,13 +57,13 @@
     "minami": "^1.2.3",
     "mocha": "^8.4.0",
     "mocha-junit-reporter": "^2.0.0",
-    "nock": "^10.0.6",
+    "nock": "^13.2.7",
     "nyc": "^14.1.1",
     "pem": "^1.14.2",
     "prettier": "2.4.1",
     "pretty-quick": "^1.11.1",
     "proxyquire": "^2.1.3",
-    "sinon": "^11.1.2",
+    "sinon": "^14.0.0",
     "string-replace-webpack-plugin": "0.1.3",
     "webpack": "^4.36.1"
   }

package/src/Auth0RestClient.js

@@ -27,7 +27,7 @@ class Auth0RestClient {
 
     this.wrappedProvider = function (method, args) {
       if (!this.provider) {
-        return this.restClient[method](...args);
+        return this._request(method, args);
       }
 
       let callback;
@@ -39,7 +39,7 @@ class Auth0RestClient {
         .getAccessToken()
         .then((access_token) => {
           this.restClient.options.headers['Authorization'] = `Bearer ${access_token}`;
-          return this.restClient[method](...args);
+          return this._request(method, args);
         })
         .catch((err) => {
           if (callback) {
@@ -50,6 +50,36 @@ class Auth0RestClient {
     };
   }
 
+  _request(method, args) {
+    if (!this.options.includeResponseHeaders) {
+      return this.restClient[method](...args);
+    }
+
+    let callback;
+    // Handle the case where the promise variant is called without any args
+    // client.get() -> client.get({}, callback)
+    if (!args || !args.length) {
+      args = [{}];
+    }
+    // Handle the case where an undefined placeholder is defined for callback
+    // client.get(params, undefined) -> client.get(params, callback)
+    if (typeof args[args.length - 1] === 'undefined') {
+      args.pop();
+    }
+    if (typeof args[args.length - 1] === 'function') {
+      callback = args.pop();
+    }
+    return new Promise((resolve, reject) => {
+      this.restClient[method](...args, (err, data, headers) => {
+        const payload = { data, headers };
+        if (err) {
+          (callback && callback(err)) || reject(err);
+        }
+        (callback && callback(null, payload)) || resolve(payload);
+      });
+    });
+  }
+
   getAll(...args) {
     return this.wrappedProvider('getAll', args);
   }

package/src/management/ActionsManager.js

@@ -1,13 +1,11 @@
-const { ArgumentError } = require('rest-facade');
-const Auth0RestClient = require('../Auth0RestClient');
-const RetryRestClient = require('../RetryRestClient');
+const BaseManager = require('./BaseManager');
 
 /**
  * {@link https://auth0.com/docs/api/v2#!/Actions/get_actions Actions} provide a way to extend
  * Auth0 flows with custom logic.
  * See the {@link https://auth0.com/docs/actions Actions documentation} for more information.
  */
-class ActionsManager {
+class ActionsManager extends BaseManager {
   /**
    * @param {object} options            The client options.
    * @param {string} options.baseUrl    The URL of the API.
@@ -15,28 +13,7 @@ class ActionsManager {
    * @param {object} [options.retry]    Retry Policy Config
    */
   constructor(options) {
-    if (options === null || typeof options !== 'object') {
-      throw new ArgumentError('Must provide client 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');
-    }
-
-    /**
-     * Options object for the Rest Client instance.
-     *
-     * @type {object}
-     */
-    const clientOptions = {
-      errorFormatter: { message: 'message', name: 'error' },
-      headers: options.headers,
-      query: { repeatParams: false },
-    };
+    super(options);
 
     /**
      * Provides an abstraction layer for consuming the
@@ -44,61 +21,23 @@ class ActionsManager {
      *
      * @type {external:RestClient}
      */
-    const auth0RestClient = new Auth0RestClient(
-      `${options.baseUrl}/actions/actions/:id`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.resource = new RetryRestClient(auth0RestClient, options.retry);
+    this.resource = this._getRestClient('/actions/actions/:id');
 
-    const actionsDeployRestClient = new Auth0RestClient(
-      `${options.baseUrl}/actions/actions/:id/deploy`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.actionsDeploy = new RetryRestClient(actionsDeployRestClient, options.retry);
+    this.actionsDeploy = this._getRestClient('/actions/actions/:id/deploy');
 
-    const actionsTestRestClient = new Auth0RestClient(
-      `${options.baseUrl}/actions/actions/:id/test`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.actionsTest = new RetryRestClient(actionsTestRestClient, options.retry);
+    this.actionsTest = this._getRestClient('/actions/actions/:id/test');
 
-    const triggersRestClient = new Auth0RestClient(
-      `${options.baseUrl}/actions/triggers/:trigger_id`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.triggers = new RetryRestClient(triggersRestClient, options.retry);
+    this.triggers = this._getRestClient('/actions/triggers/:trigger_id');
 
-    const triggerBindingsRestClient = new Auth0RestClient(
-      `${options.baseUrl}/actions/triggers/:trigger_id/bindings`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.triggerBindings = new RetryRestClient(triggerBindingsRestClient, options.retry);
+    this.triggerBindings = this._getRestClient('/actions/triggers/:trigger_id/bindings');
 
-    const executionsRestClient = new Auth0RestClient(
-      `${options.baseUrl}/actions/executions/:execution_id`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.executions = new RetryRestClient(executionsRestClient, options.retry);
+    this.executions = this._getRestClient('/actions/executions/:execution_id');
 
-    const actionVersionRestClient = new Auth0RestClient(
-      `${options.baseUrl}/actions/actions/:id/versions/:version_id`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.actionVersions = new RetryRestClient(actionVersionRestClient, options.retry);
+    this.actionVersions = this._getRestClient('/actions/actions/:id/versions/:version_id');
 
-    const deployActionVersionRestClient = new Auth0RestClient(
-      `${options.baseUrl}/actions/actions/:id/versions/:version_id/deploy`,
-      clientOptions,
-      options.tokenProvider
+    this.actionVersionDeploy = this._getRestClient(
+      '/actions/actions/:id/versions/:version_id/deploy'
     );
-    this.actionVersionDeploy = new RetryRestClient(deployActionVersionRestClient, options.retry);
   }
 
   /**

package/src/management/AttackProtectionManager.js

@@ -1,6 +1,4 @@
-const { ArgumentError } = require('rest-facade');
-const Auth0RestClient = require('../Auth0RestClient');
-const RetryRestClient = require('../RetryRestClient');
+const BaseManager = require('./BaseManager');
 
 /**
  * Simple facade for consuming a REST API endpoint.
@@ -9,7 +7,7 @@ const RetryRestClient = require('../RetryRestClient');
  * @see https://github.com/ngonzalvez/rest-facade
  */
 
-class AttackProtectionManager {
+class AttackProtectionManager extends BaseManager {
   /**
    * @class
    * Abstracts interaction with the attack-protection endpoints.
@@ -21,44 +19,17 @@ class AttackProtectionManager {
    * @param {object} [options.tokenProvider] Management API Token Provider
    */
   constructor(options) {
-    if (options === null || typeof options !== 'object') {
-      throw new ArgumentError('Must provide manager options');
-    }
+    super(options);
 
-    if (options.baseUrl === null || options.baseUrl === undefined) {
-      throw new ArgumentError('Must provide a base URL for the API');
-    }
+    this.bruteForceProtection = this._getRestClient('/attack-protection/brute-force-protection');
 
-    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 },
-    };
-
-    const bruteForceProtection = new Auth0RestClient(
-      `${options.baseUrl}/attack-protection/brute-force-protection`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.bruteForceProtection = new RetryRestClient(bruteForceProtection, options.retry);
-
-    const suspiciousIpThrottling = new Auth0RestClient(
-      `${options.baseUrl}/attack-protection/suspicious-ip-throttling`,
-      clientOptions,
-      options.tokenProvider
+    this.suspiciousIpThrottling = this._getRestClient(
+      '/attack-protection/suspicious-ip-throttling'
     );
-    this.suspiciousIpThrottling = new RetryRestClient(suspiciousIpThrottling, options.retry);
 
-    const breachedPasswordDetection = new Auth0RestClient(
-      `${options.baseUrl}/attack-protection/breached-password-detection`,
-      clientOptions,
-      options.tokenProvider
+    this.breachedPasswordDetection = this._getRestClient(
+      '/attack-protection/breached-password-detection'
     );
-    this.breachedPasswordDetection = new RetryRestClient(breachedPasswordDetection, options.retry);
   }
 
   /**

package/src/management/BaseManager.js

@@ -0,0 +1,40 @@
+const { ArgumentError } = require('rest-facade');
+const Auth0RestClient = require('../Auth0RestClient');
+const RetryRestClient = require('../RetryRestClient');
+
+class BaseManager {
+  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');
+    }
+
+    this._options = options;
+  }
+
+  _getRestClient(path) {
+    const options = this._options;
+    const clientOptions = {
+      errorFormatter: { message: 'message', name: 'error' },
+      headers: options.headers,
+      query: { repeatParams: false },
+      includeResponseHeaders: options.includeResponseHeaders,
+    };
+
+    const usersAuth0RestClient = new Auth0RestClient(
+      `${options.baseUrl}${path}`,
+      clientOptions,
+      options.tokenProvider
+    );
+    return new RetryRestClient(usersAuth0RestClient, options.retry);
+  }
+}
+
+module.exports = BaseManager;

package/src/management/BlacklistedTokensManager.js

@@ -1,12 +1,10 @@
-const { ArgumentError } = require('rest-facade');
-const Auth0RestClient = require('../Auth0RestClient');
-const RetryRestClient = require('../RetryRestClient');
+const BaseManager = require('./BaseManager');
 
 /**
  * The BlacklistedTokensManager class provides methods to retrieve the list of
  * blacklisted tokens and blacklist new ones..
  */
-class BlacklistedTokensManager {
+class BlacklistedTokensManager extends BaseManager {
   /**
    * @param {object} options            The client options.
    * @param {string} options.baseUrl    The URL of the API.
@@ -14,28 +12,7 @@ class BlacklistedTokensManager {
    * @param {object} [options.retry]    Retry Policy Config
    */
   constructor(options) {
-    if (options === null || typeof options !== 'object') {
-      throw new ArgumentError('Must provide client 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');
-    }
-
-    /**
-     * Options object for the Rest Client instance.
-     *
-     * @type {object}
-     */
-    const clientOptions = {
-      errorFormatter: { message: 'message', name: 'error' },
-      headers: options.headers,
-      query: { repeatParams: false },
-    };
+    super(options);
 
     /**
      * Provides an abstraction layer for consuming the
@@ -43,12 +20,7 @@ class BlacklistedTokensManager {
      *
      * @type {external:RestClient}
      */
-    const auth0RestClient = new Auth0RestClient(
-      `${options.baseUrl}/blacklists/tokens`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.resource = new RetryRestClient(auth0RestClient, options.retry);
+    this.resource = this._getRestClient('/blacklists/tokens');
   }
 
   /**

package/src/management/BrandingManager.js

@@ -1,11 +1,9 @@
-const { ArgumentError } = require('rest-facade');
-const Auth0RestClient = require('../Auth0RestClient');
-const RetryRestClient = require('../RetryRestClient');
+const BaseManager = require('./BaseManager');
 
 /**
  * Manages settings related to branding.
  */
-class BrandingManager {
+class BrandingManager extends BaseManager {
   /**
    * @param {object} options            The client options.
    * @param {string} options.baseUrl    The URL of the API.
@@ -13,23 +11,7 @@ class BrandingManager {
    * @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 BrandingManager {
      *
      * @type {external:RestClient}
      */
-    const auth0RestClient = new Auth0RestClient(
-      `${options.baseUrl}/branding`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.resource = new RetryRestClient(auth0RestClient, options.retry);
+    this.resource = this._getRestClient('/branding');
 
     /**
      * Provides an abstraction layer for consuming the
@@ -50,12 +27,15 @@ class BrandingManager {
      *
      * @type {external:RestClient}
      */
-    const brandingTemplateAuth0RestClient = new Auth0RestClient(
-      `${options.baseUrl}/branding/templates/universal-login`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.brandingTemplates = new RetryRestClient(brandingTemplateAuth0RestClient, options.retry);
+    this.brandingTemplates = this._getRestClient('/branding/templates/universal-login');
+
+    /**
+     * Provides an abstraction layer for consuming the
+     * {@link https://auth0.com/docs/api/management/v2#!/Branding/get_branding_theme Branding theme endpoint}.
+     *
+     * @type {external:RestClient}
+     */
+    this.brandingThemes = this._getRestClient('/branding/themes/:id');
   }
 
   /**
@@ -156,6 +136,115 @@ class BrandingManager {
   deleteUniversalLoginTemplate(...args) {
     return this.brandingTemplates.delete(...args);
   }
+
+  /**
+   * Get the new universal login theme by id.
+   *
+   * @example
+   * var params = { id: THEME_ID };
+   *
+   * management.branding.getTheme(params, function (err, theme) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *    // Theme
+   *    console.log(theme);
+   * });
+   * @param   {object}    params            Theme params
+   * @param   {object}    params.id         Theme identifier.
+   * @param   {Function}  [cb]              Callback function.
+   * @returns    {Promise|undefined}
+   */
+  getTheme(...args) {
+    return this.brandingThemes.get(...args);
+  }
+
+  /**
+   * Get the default new universal login theme.
+   *
+   * @example
+   * management.branding.getDefaultTheme(function (err, theme) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *    // Theme
+   *    console.log(theme);
+   * });
+   * @param   {Function}  [cb]              Callback function.
+   * @returns    {Promise|undefined}
+   */
+  getDefaultTheme(...args) {
+    return this.brandingThemes.get(...[{ id: 'default' }].concat(args));
+  }
+
+  /**
+   * Create a new theme.
+   *
+   * @example
+   * management.branding.createTheme(data, function (err, theme) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   // Theme created.
+   *   console.log(theme);
+   * });
+   * @param   {object}    data     theme data object.
+   * @param   {Function}  [cb]     Callback function.
+   * @returns  {Promise|undefined}
+   */
+  createTheme(...args) {
+    return this.brandingThemes.create(...args);
+  }
+
+  /**
+   * Update a theme.
+   *
+   * @example
+   * var data = THEME_OBJ;
+   * var params = { id: THEME_ID };
+   *
+   * management.branding.updateTheme(params, data, function (err, theme) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   // Theme updated.
+   *   console.log(theme);
+   * });
+   * @param   {object}    params            Theme parameters.
+   * @param   {object}    params.id         Theme identifier.
+   * @param   {object}    data              Updated theme data.
+   * @param   {Function}  [cb]              Callback function.
+   * @returns    {Promise|undefined}
+   */
+  updateTheme(...args) {
+    return this.brandingThemes.patch(...args);
+  }
+
+  /**
+   * Delete a theme.
+   *
+   * @example
+   * var params = { id: THEME_ID };
+   *
+   * management.branding.deleteTheme(params, function (err) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   // Theme deleted.
+   * });
+   * @param   {object}    params            Theme parameters.
+   * @param   {object}    params.id         Theme identifier.
+   * @param   {Function}  [cb]              Callback function.
+   * @returns    {Promise|undefined}
+   */
+  deleteTheme(...args) {
+    return this.brandingThemes.delete(...args);
+  }
 }
 
 module.exports = BrandingManager;

package/src/management/ClientGrantsManager.js

@@ -1,13 +1,11 @@
-const { ArgumentError } = require('rest-facade');
-const Auth0RestClient = require('../Auth0RestClient');
-const RetryRestClient = require('../RetryRestClient');
+const BaseManager = require('./BaseManager');
 
 /**
  * Auth0 Client Grants Manager.
  *
  * See {@link https://auth0.com/docs/api/v2#!/Client_Grants Client Grants}
  */
-class ClientGrantsManager {
+class ClientGrantsManager extends BaseManager {
   /**
    * @param {object} options            The client options.
    * @param {string} options.baseUrl    The URL of the API.
@@ -15,28 +13,7 @@ class ClientGrantsManager {
    * @param {object} [options.retry]    Retry Policy Config
    */
   constructor(options) {
-    if (options === null || typeof options !== 'object') {
-      throw new ArgumentError('Must provide client 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');
-    }
-
-    /**
-     * Options object for the Rest Client instance.
-     *
-     * @type {object}
-     */
-    const clientOptions = {
-      errorFormatter: { message: 'message', name: 'error' },
-      headers: options.headers,
-      query: { repeatParams: false },
-    };
+    super(options);
 
     /**
      * Provides an abstraction layer for consuming the
@@ -44,12 +21,7 @@ class ClientGrantsManager {
      *
      * @type {external:RestClient}
      */
-    const auth0RestClient = new Auth0RestClient(
-      `${options.baseUrl}/client-grants/:id`,
-      clientOptions,
-      options.tokenProvider
-    );
-    this.resource = new RetryRestClient(auth0RestClient, options.retry);
+    this.resource = this._getRestClient('/client-grants/:id');
   }
 
   /**