auth0 3.4.0 → 4.0.0-beta.0

package/README.md

@@ -1,16 +1,17 @@
 ![Node.js client library for Auth0](https://cdn.auth0.com/website/sdks/banner/node-auth0-banner.png)
 
+> ⚠️ Please be aware that v4 is currently in <strong>Beta</strong>. Whilst we encourage you to test the update within your applications, we do no recommend using this version in production yet.
+
 ![Release](https://img.shields.io/npm/v/auth0)
 [![Codecov](https://img.shields.io/codecov/c/github/auth0/node-auth0)](https://codecov.io/gh/auth0/node-auth0)
 ![Downloads](https://img.shields.io/npm/dw/auth0)
 [![License](https://img.shields.io/:license-mit-blue.svg?style=flat)](https://opensource.org/licenses/MIT)
 ![CircleCI](https://img.shields.io/circleci/build/github/auth0/node-auth0)
 
-📚 [Documentation](#documentation) - 🚀 [Getting Started](#getting-started) - 💻 [API Reference](#api-reference) - 💬 [Feedback](#feedback)
+📚 [Documentation](#documentation) - 🚀 [Getting Started](#getting-started) - 💬 [Feedback](#feedback)
 
 ## Documentation
 
-- [FAQs](https://github.com/auth0/node-auth0/blob/master/FAQ.md) - frequently asked questions about node-auth0.
 - [Docs Site](https://auth0.com/docs) - explore our docs site and learn more about Auth0
 
 ## Getting Started
@@ -19,56 +20,59 @@
 
 This library supports the following tooling versions:
 
-- Node.js: `>=8.3.0`
+- Node.js: `>=16`
 
 ### Installation
 
 Using [npm](https://npmjs.org) in your project directory run the following command:
 
 ```bash
-npm install auth0
+npm install auth0@beta
 ```
 
 ### Configure the SDK
 
 #### Authentication API Client
 
-This client must be used to access Auth0's [Authentication API](https://auth0.com/docs/api/authentication).
+This client can be used to access Auth0's [Authentication API](https://auth0.com/docs/api/authentication).
 
 The **AuthenticationClient** constructor takes an _optional_ client ID, if specified it will be used as default value for all endpoints that accept a client ID.
 
 ```js
-var AuthenticationClient = require('auth0').AuthenticationClient;
+import { AuthenticationClient } from 'auth0';
 
-var auth0 = new AuthenticationClient({
+const auth0 = new AuthenticationClient({
   domain: '{YOUR_ACCOUNT}.auth0.com',
   clientId: '{OPTIONAL_CLIENT_ID}',
+  clientSecret: '{OPTIONAL_CLIENT_SECRET}',
 });
 ```
 
 #### Management API Client
 
-> Note: When using the ManagementClient in a browser you should set `telemetry: false`.
-
 The Auth0 Management API is meant to be used by back-end servers or trusted parties performing administrative tasks. Generally speaking, anything that can be done through the Auth0 dashboard (and more) can also be done through this API.
 
 Initialize your client class with an API v2 token and a domain.
 
 ```js
-var ManagementClient = require('auth0').ManagementClient;
+import { ManagementClient } from 'auth0';
 
 var management = new ManagementClient({
-  token: '{YOUR_API_V2_TOKEN}',
   domain: '{YOUR_ACCOUNT}.auth0.com',
+  token: '{YOUR_API_V2_TOKEN}',
 });
 ```
 
-For other examples see the [EXAMPLES.md](https://github.com/auth0/node-auth0/blob/master/EXAMPLES.md) document.
+Or, initialize your client class with a client secret and a domain.
 
-## API Reference
+```js
+import { ManagementClient } from 'auth0';
 
-- [AuthenticationClient](https://auth0.github.io/node-auth0/AuthenticationClient.html)
-- [ManagementClient](https://auth0.github.io/node-auth0/ManagementClient.html)
+var management = new ManagementClient({
+  token: '{YOUR_API_V2_TOKEN}',
+  domain: '{YOUR_ACCOUNT}.auth0.com',
+});
+```
 
 ## Feedback
 

package/package.json

@@ -1,27 +1,39 @@
 {
   "name": "auth0",
-  "version": "3.4.0",
+  "version": "4.0.0-beta.0",
   "description": "SDK for Auth0 API v2",
-  "main": "src/index.js",
-  "module": "src/index.mjs",
+  "main": "dist/cjs/index.js",
+  "types": "dist/types/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/esm/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
   "sideEffects": false,
   "files": [
-    "src"
+    "dist"
   ],
   "scripts": {
-    "test": "mocha --reporter spec './test/**/*.tests.js'",
-    "test:ci": "nyc npm run test -- --forbid-only --reporter mocha-junit-reporter",
-    "test:watch": "cross-env NODE_ENV=test mocha --timeout 5000 './test/**/*.tests.js' './test/*.tests.js' --watch",
-    "jsdoc:generate": "jsdoc --configure .jsdoc.json --verbose",
+    "prebuild": "rm -rf dist",
+    "build": "tsc -b ./tsconfig.cjs.json ./tsconfig.esm.json ./tsconfig.types.json && echo '{\"type\": \"commonjs\"}'> dist/cjs/package.json",
+    "docs": "typedoc --options typedoc.cjs",
+    "test": "npm run test:mocha && npm run test:jest",
+    "test:mocha": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' mocha",
+    "test:jest": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest",
+    "test:ci": "c8 npm run test",
     "precommit": "pretty-quick --staged",
-    "lint": "eslint ."
+    "lint": "eslint ./src --ext ts",
+    "start:playground": "node --experimental-specifier-resolution=node --no-warnings --loader ts-node/esm playground/index.ts"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/auth0/node-auth0"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "keywords": [
     "auth0",
@@ -34,39 +46,41 @@
   },
   "homepage": "https://github.com/auth0/node-auth0",
   "dependencies": {
-    "axios": "^0.27.2",
-    "form-data": "^3.0.1",
-    "jsonwebtoken": "^9.0.0",
-    "jwks-rsa": "^3.0.1",
-    "lru-memoizer": "^2.1.4",
-    "rest-facade": "^1.16.3",
-    "retry": "^0.13.1",
+    "form-data": "^4.0.0",
+    "jose": "^4.13.2",
+    "node-fetch": "^2.6.7",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
+    "@types/chai": "^4.3.4",
+    "@types/chai-as-promised": "^7.1.5",
+    "@types/jest": "^29.5.0",
+    "@types/mocha": "^10.0.1",
+    "@types/node-fetch": "^2.6.3",
+    "@types/uuid": "^9.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.58.0",
+    "@typescript-eslint/parser": "^5.58.0",
+    "c8": "^7.13.0",
     "chai": "^4.2.0",
-    "cross-env": "^5.2.0",
+    "chai-as-promised": "^7.1.1",
+    "commander": "^10.0.1",
+    "dotenv": "^16.0.3",
     "eslint": "^8.16.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-jsdoc": "^37.0.3",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-promise": "^6.0.0",
     "husky": "^3.0.1",
-    "jsdoc": "^3.6.7",
-    "json-loader": "^0.5.7",
-    "jws": "^3.2.2",
-    "minami": "^1.2.3",
-    "mocha": "^8.4.0",
-    "mocha-junit-reporter": "^2.0.0",
+    "jest": "^29.5.0",
+    "mocha": "^9.1.3",
     "nock": "^13.2.7",
-    "nyc": "^14.1.1",
-    "prettier": "2.4.1",
+    "prettier": "^2.8.7",
     "pretty-quick": "^1.11.1",
-    "proxyquire": "^2.1.3",
     "sinon": "^14.0.0",
-    "string-replace-webpack-plugin": "0.1.3",
-    "superagent-proxy": "^3.0.0",
-    "webpack": "^4.36.1"
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.1",
+    "typedoc": "^0.24.6",
+    "typescript": "4.9.5"
   }
 }