auth0 3.2.0 → 3.3.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## [v3.3.0](https://github.com/auth0/node-auth0/tree/v3.3.0) (2023-03-14)
+
+[Full Changelog](https://github.com/auth0/node-auth0/compare/v3.2.0...v3.3.0)
+
+**Added**
+
+- [SDK-4013] Add API2 Factor Management Endpoints [\#791](https://github.com/auth0/node-auth0/pull/791) ([adamjmcgrath](https://github.com/adamjmcgrath))
+- ESM support [\#784](https://github.com/auth0/node-auth0/pull/784) ([btakita](https://github.com/btakita))
+
 ## [v3.2.0](https://github.com/auth0/node-auth0/tree/v3.2.0) (2023-02-09)
 
 [Full Changelog](https://github.com/auth0/node-auth0/compare/v3.1.2...v3.2.0)

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "auth0",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "SDK for Auth0 API v2",
   "main": "src/index.js",
+  "module": "src/index.mjs",
   "sideEffects": false,
   "files": [
     "src"

package/src/index.mjs

@@ -0,0 +1,11 @@
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+/**
+ * Simple facade for consuming a REST API endpoint.
+ *
+ * @external RestClient
+ * {@link https://github.com/ngonzalvez/rest-facade}
+ */
+export const ManagementClient = require('./management');
+export const AuthenticationClient = require('./auth');
+export default { ManagementClient, AuthenticationClient }

package/src/management/ConnectionsManager.js

@@ -72,10 +72,15 @@ class ConnectionsManager extends BaseManager {
    * management.connections.getAll(params, function (err, connections) {
    *   console.log(connections.length);
    * });
-   * @param   {object}    [params]          Connections params.
-   * @param   {number}    [params.per_page] Number of results per page.
-   * @param   {number}    [params.page]     Page number, zero indexed.
-   * @param   {Function}  [cb]              Callback function.
+   * @param   {object}    [params]                Connections params.
+   * @param   {number}    [params.per_page]       Number of results per page.
+   * @param   {number}    [params.page]           Page number, zero indexed.
+   * @param   {string[]}  [params.fields]         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. Default true
+   * @param   {boolean}   [params.include_totals] true if a query summary must be included in the result, false otherwise. Default false
+   * @param   {string}    [params.strategy]       Provide strategies to only retrieve connections with such strategies
+   * @param   {string}    [params.name]           Provide the name of the connection to retrieve
+   * @param   {Function}  [cb]                    Callback function.
    * @returns  {Promise|undefined}
    */
   getAll(...args) {

package/src/management/UsersManager.js

@@ -93,6 +93,10 @@ class UsersManager extends BaseManager {
     this.authenticators = this._getRestClient('/users/:id/authenticators');
 
     this.organizations = this._getRestClient('/users/:id/organizations');
+
+    this.authenticationMethods = this._getRestClient(
+      '/users/:id/authentication-methods/:authentication_method_id'
+    );
   }
 
   /**
@@ -782,6 +786,97 @@ class UsersManager extends BaseManager {
   getUserOrganizations(...args) {
     return this.organizations.getAll(...args);
   }
+
+  /**
+   * Gets a list of authentication methods.
+   *
+   * @param   {object}    params      The user data object.
+   * @param   {string}    params.id   The user id.
+   * @param   {Function}  [cb]        Callback function.
+   * @returns  {Promise|undefined}
+   */
+  getAuthenticationMethods(...args) {
+    return this.authenticationMethods.getAll(...args);
+  }
+
+  /**
+   * Gets an authentication method by ID.
+   *
+   * @param   {object}    params                          The user data object.
+   * @param   {string}    params.id                       The user id.
+   * @param   {string}    params.authentication_method_id The authentication method id.
+   * @param   {Function}  [cb]                            Callback function.
+   * @returns  {Promise|undefined}
+   */
+  getAuthenticationMethodById(...args) {
+    return this.authenticationMethods.get(...args);
+  }
+
+  /**
+   * Creates an authentication method for a given user.
+   *
+   * @param   {object}    params                          The user data object.
+   * @param   {string}    params.id                       The user id.
+   * @param   {object}    data                            Authentication method data.
+   * @param   {Function}  [cb]                            Callback function.
+   * @returns  {Promise|undefined}
+   */
+  createAuthenticationMethod(...args) {
+    return this.authenticationMethods.create(...args);
+  }
+
+  /**
+   * Updates all authentication methods for a user by replacing them with the given ones.
+   *
+   * @param   {object}    params                          The user data object.
+   * @param   {string}    params.id                       The user id.
+   * @param   {object}    data                            Updated authentication method data.
+   * @param   {Function}  [cb]                            Callback function.
+   * @returns  {Promise|undefined}
+   */
+  updateAuthenticationMethods(...args) {
+    return this.authenticationMethods.update(...args);
+  }
+
+  /**
+   * Updates an authentication method.
+   *
+   * @param   {object}    params                          The user data object.
+   * @param   {string}    params.id                       The user id.
+   * @param   {string}    params.authentication_method_id The authentication method id.
+   * @param   {object}    data                            Updated authentication method data.
+   * @param   {Function}  [cb]                            Callback function.
+   * @returns  {Promise|undefined}
+   */
+  updateAuthenticationMethodById(...args) {
+    return this.authenticationMethods.patch(...args);
+  }
+
+  /**
+   * Deletes all authentication methods for the given user.
+   *
+   * @param   {object}    params                          The user data object.
+   * @param   {string}    params.id                       The user id.
+   * @param   {Function}  [cb]                            Callback function.
+   * @returns  {Promise|undefined}
+   */
+  deleteAuthenticationMethods(...args) {
+    return this.authenticationMethods.delete(...args);
+  }
+
+  /**
+   * Deletes an authentication method by ID.
+   *
+   * @param   {object}    params                          The user data object.
+   * @param   {string}    params.id                       The user id.
+   * @param   {string}    params.authentication_method_id The authentication method id.
+   * @param   {object}    data                            Updated authentication method data.
+   * @param   {Function}  [cb]                            Callback function.
+   * @returns  {Promise|undefined}
+   */
+  deleteAuthenticationMethodById(...args) {
+    return this.authenticationMethods.delete(...args);
+  }
 }
 
 module.exports = UsersManager;

package/src/management/index.js

@@ -92,8 +92,8 @@ class ManagementClient {
   /**
    * @param   {object}  options                                   Options for the ManagementClient SDK.
    *          If a token is provided only the domain is required, other parameters are ignored.
-   *          If no token is provided domain, clientId, clientSecret (or clientAssertionSigningKey)
-   *          and scopes are required
+   *          If no token is provided domain, clientId and clientSecret (or clientAssertionSigningKey)
+   *          are required.
    * @param   {string}  options.domain                              ManagementClient server domain.
    * @param   {string}  [options.token]                             API access token.
    * @param   {string}  [options.clientId]                          Management API Non Interactive Client Id.