auth0 2.43.0 → 2.44.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## [v2.44.0](https://github.com/auth0/node-auth0/tree/v2.44.0) (2022-10-11)
+
+[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.43.0...v2.44.0)
+
+**Added**
+
+- [SDK-3653] Add proxy support to Management Client [\#747](https://github.com/auth0/node-auth0/pull/747) ([adamjmcgrath](https://github.com/adamjmcgrath))
+
 ## [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)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0",
-  "version": "2.43.0",
+  "version": "2.44.0",
   "description": "SDK for Auth0 API v2",
   "main": "src/index.js",
   "sideEffects": false,
@@ -65,6 +65,7 @@
     "proxyquire": "^2.1.3",
     "sinon": "^14.0.0",
     "string-replace-webpack-plugin": "0.1.3",
+    "superagent-proxy": "^3.0.0",
     "webpack": "^4.36.1"
   }
 }

package/src/management/BaseManager.js

@@ -24,6 +24,7 @@ class BaseManager {
     const clientOptions = {
       errorFormatter: { message: 'message', name: 'error' },
       headers: options.headers,
+      proxy: options.proxy,
       query: { repeatParams: false },
       includeResponseHeaders: options.includeResponseHeaders,
     };

package/src/management/ClientsManager.js

@@ -97,6 +97,8 @@ class ClientsManager extends BaseManager {
    * });
    * @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}
    */

package/src/management/index.js

@@ -90,7 +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   {object}  [options.includeResponseHeaders]            Include the response headers in the payload in the format `{ data, headers }`.
+   * @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') {
@@ -149,6 +150,7 @@ class ManagementClient {
 
     managerOptions.retry = options.retry;
     managerOptions.includeResponseHeaders = options.includeResponseHeaders;
+    managerOptions.proxy = options.proxy;
 
     /**
      * Simple abstraction for performing CRUD operations on the
@@ -525,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}
    */