Merge branch 'master' into patch-1

auth0 · Aug 8, 2018 · af61b76 · af61b76
2 parents 64f4b23 + a990594
commit af61b76
Show file tree

Hide file tree

Showing 73 changed files with 5,910 additions and 886 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,39 @@
+version: 2
+jobs:
+  build-and-test:
+    docker:
+      - image: circleci/node:6.14.3-browsers
+    environment:
+          LANG: en_US.UTF-8
+    steps:
+      - checkout
+      - run: 
+          name: Update Yarn
+          command: 'sudo npm update -g yarn'
+      - restore-cache:
+          name: Restore Yarn Package Cache
+          keys: 
+            - yarn-packages-{{ checksum "yarn.lock" }}
+      - run:
+          name: Install Dependencies
+          command: yarn install --pure-lockfile
+      - save-cache:
+          name: Save Yarn Package Cache
+          key: yarn-packages-{{ checksum "yarn.lock" }}
+          paths:
+            - ~/.cache/yarn
+      - run: 
+          name: Check
+          command: yarn check
+      - run: 
+          name: Tests
+          command: yarn test:ci
+      - run: 
+          name: Generate Coverage
+          command: yarn test:coverage
+
+workflows:
+  version: 2
+  build-test-report:
+    jobs:
+      - build-and-test
diff --git a/.travis.yml b/.travis.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,18 @@
 # Change Log
 
+## [v2.11.0](https://github.com/auth0/node-auth0/tree/v2.11.0) (2018-07-25)
+
+[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.10.0...v2.11.0)
+
+**Added**
+
+* Added Pagination Docs for a Client Grants, Resouce Servers and Rules [\#282](https://github.com/auth0/node-auth0/pull/282) ([cocojoe](https://github.com/cocojoe))
+* Added rules config methods [\#227](https://github.com/auth0/node-auth0/pull/227) ([dctoon](https://github.com/dctoon))
+
+**Fixed**
+
+* Get access token before importing users [\#267](https://github.com/auth0/node-auth0/pull/267) ([Floppy](https://github.com/Floppy))
+
 ## [v2.10.0](https://github.com/auth0/node-auth0/tree/v2.10.0) (2018-05-29)
 
 [Full Changelog](https://github.com/auth0/node-auth0/compare/v2.9.3...v2.10.0)

diff --git a/circle.yml b/circle.yml
diff --git a/docs/RetryRestClient.js.html b/docs/RetryRestClient.js.html
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/index.js.html b/docs/index.js.html
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
diff --git a/docs/module-auth.html b/docs/module-auth.html
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
diff --git a/docs/module-management.html b/docs/module-management.html
diff --git a/docs/module-utils.html b/docs/module-utils.html
diff --git a/docs/utils.js.html b/docs/utils.js.html
diff --git a/package.json b/package.json
@@ -1,11 +1,9 @@
 {
   "name": "auth0",
-  "version": "2.10.0",
+  "version": "2.11.0",
   "description": "SDK for Auth0 API v2",
   "main": "src/index.js",
-  "files": [
-    "src"
-  ],
+  "files": ["src"],
   "scripts": {
     "test": "mocha -R spec $(find ./test -name *.tests.js)",
     "test:ci":
@@ -43,7 +41,7 @@
     "codecov": "^2.2.0",
     "husky": "^0.14.3",
     "istanbul": "^0.4.0",
-    "jsdoc": "^3.4.0",
+    "jsdoc": "^3.5.5",
     "json-loader": "^0.5.4",
     "minami": "^1.2.3",
     "mocha": "^2.2.4",

diff --git a/src/management/ClientGrantsManager.js b/src/management/ClientGrantsManager.js
@@ -82,12 +82,27 @@ utils.wrapPropertyMethod(ClientGrantsManager, 'create', 'resource.create');
  * @method    getAll
  * @memberOf  module:management.ClientGrantsManager.prototype
  *
- * @example
- * management.clientGrants.getAll(function (err, grants) {
+ * @example <caption>
+ *   This method takes an optional object as first argument that may be used to
+ *   specify pagination settings. 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: 0
+ * };
+ *
+ *
+ * management.clientGrants.getAll(params, function (err, grants) {
  *   console.log(grants.length);
  * });
  *
- * @param   {Function}  [cb]    Callback function.
+ * @param   {Object}    [params]          Client Grants parameters.
+ * @param   {Number}    [params.per_page] Number of results per page.
+ * @param   {Number}    [params.page]     Page number, zero indexed.
+ * @param   {Function}  [cb]              Callback function.
  *
  * @return  {Promise|undefined}
  */

diff --git a/src/management/ClientsManager.js b/src/management/ClientsManager.js
@@ -95,16 +95,16 @@ utils.wrapPropertyMethod(ClientsManager, 'create', 'resource.create');
  * // Pagination settings.
  * var params = {
  *   per_page: 10,
- *   page: 2
+ *   page: 0
  * };
  *
- * management.clients.getAll(function (err, clients) {
+ * management.clients.getAll(params, function (err, clients) {
  *   console.log(clients.length);
  * });
  *
- * @param   {Object}    [params]          Clients params.
- * @param   {Number}    [params.per_page] Number of clients per page.
- * @param   {Number}    [params.page]     Page number.
+ * @param   {Object}    [params]          Clients parameters.
+ * @param   {Number}    [params.per_page] Number of results per page.
+ * @param   {Number}    [params.page]     Page number, zero indexed.
  * @param   {Function}  [cb]              Callback function.
  *
  * @return  {Promise|undefined}

diff --git a/src/management/ConnectionsManager.js b/src/management/ConnectionsManager.js
@@ -89,16 +89,16 @@ utils.wrapPropertyMethod(ConnectionsManager, 'create', 'resource.create');
  * // Pagination settings.
  * var params = {
  *   per_page: 10,
- *   page: 2
+ *   page: 0
  * };
  *
- * management.connections.getAll(function (err, connections) {
+ * management.connections.getAll(params, function (err, connections) {
  *   console.log(connections.length);
  * });
  *
  * @param   {Object}    [params]          Connections params.
- * @param   {Number}    [params.per_page] Number of connections per page.
- * @param   {Number}    [params.page]     Page number.
+ * @param   {Number}    [params.per_page] Number of results per page.
+ * @param   {Number}    [params.page]     Page number, zero indexed.
  * @param   {Function}  [cb]              Callback function.
  *
  * @return  {Promise|undefined}

diff --git a/src/management/GuardianManager.js b/src/management/GuardianManager.js
@@ -0,0 +1,96 @@
+var ArgumentError = require('rest-facade').ArgumentError;
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+
+/**
+ * Simple facade for consuming a REST API endpoint.
+ * @external RestClient
+ * @see https://github.com/ngonzalvez/rest-facade
+ */
+
+/**
+ * @class
+ * Abstracts interaction with the Guardian endpoint.
+ * @constructor
+ * @memberOf module:management
+ *
+ * @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
+ */
+var GuardianManager = function(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');
+  }
+
+  var clientOptions = {
+    errorFormatter: { message: 'message', name: 'error' },
+    headers: options.headers,
+    query: { repeatParams: false }
+  };
+
+  /**
+   * Provides an abstraction layer for retrieving Guardian enrollments.
+   *
+   * @type {external:RestClient}
+   */
+  var guardianEnrollmentsAuth0RestClient = new Auth0RestClient(
+    options.baseUrl + '/guardian/enrollments/:id',
+    clientOptions,
+    options.tokenProvider
+  );
+  this.enrollments = new RetryRestClient(guardianEnrollmentsAuth0RestClient, options.retry);
+};
+
+/**
+ * Get a single Guardian enrollment.
+ *
+ * @method    getGuardianEnrollment
+ * @memberOf  module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.users.getGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollment) {
+ *   console.log(enrollment);
+ * });
+ *
+ * @param   {Object}    data      The user data object.
+ * @param   {String}    data.id   The user id.
+ * @param   {Function}  [cb]      Callback function.
+ *
+ * @return  {Promise|undefined}
+ */
+GuardianManager.prototype.getGuardianEnrollment = function(params, cb) {
+  return this.enrollments.get(params, cb);
+};
+
+/**
+ * Delete a Guardian enrollment.
+ *
+ * @method    deleteGuardianEnrollment
+ * @memberOf  module:management.GuardianManager.prototype
+ *
+ * @example
+ * management.users.deleteGuardianEnrollment({ id: ENROLLMENT_ID }, function (err, enrollments) {
+ *   console.log(enrollments);
+ * });
+ *
+ * @param   {Object}    data      The user data object.
+ * @param   {String}    data.id   The user id.
+ * @param   {Function}  [cb]      Callback function.
+ *
+ * @return  {Promise|undefined}
+ */
+GuardianManager.prototype.deleteGuardianEnrollment = function(params, cb) {
+  return this.enrollments.delete(params, cb);
+};
+
+module.exports = GuardianManager;
diff --git a/src/management/ResourceServersManager.js b/src/management/ResourceServersManager.js
@@ -86,12 +86,26 @@ utils.wrapPropertyMethod(ResourceServersManager, 'create', 'resource.create');
  * @method    getAll
  * @memberOf  module:management.ResourceServersManager.prototype
  *
- * @example
- * management.resourceServers.getAll(function (err, resourceServers) {
+ * @example <caption>
+ *   This method takes an optional object as first argument that may be used to
+ *   specify pagination settings. 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: 0
+ * };
+ *
+ * management.resourceServers.getAll(params, function (err, resourceServers) {
  *   console.log(resourceServers.length);
  * });
  *
- * @param   {Function}  [cb]    Callback function.
+ * @param   {Object}    [params]          Resource Servers parameters.
+ * @param   {Number}    [params.per_page] Number of results per page.
+ * @param   {Number}    [params.page]     Page number, zero indexed.
+ * @param   {Function}  [cb]              Callback function.
  *
  * @return  {Promise|undefined}
  */

diff --git a/src/management/RulesManager.js b/src/management/RulesManager.js
@@ -86,12 +86,26 @@ utils.wrapPropertyMethod(RulesManager, 'create', 'resource.create');
  * @method    getAll
  * @memberOf  module:management.RulesManager.prototype
  *
- * @example
- * management.rules.getAll(function (err, rules) {
+ * @example <caption>
+ *   This method takes an optional object as first argument that may be used to
+ *   specify pagination settings. 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: 0
+ * };
+ *
+ * management.rules.getAll(params, function (err, rules) {
  *   console.log(rules.length);
  * });
  *
- * @param   {Function}  [cb]     Callback function.
+ * @param   {Object}    [params]          Rules parameters.
+ * @param   {Number}    [params.per_page] Number of results per page.
+ * @param   {Number}    [params.page]     Page number, zero indexed.
+ * @param   {Function}  [cb]              Callback function.
  *
  * @return  {Promise|undefined}
  */