@auth0/auth0-spa-js 1.22.3 → 2.0.0-beta.0

package/README.md

@@ -1,7 +1,10 @@
-# @auth0/auth0-spa-js
+# @auth0/auth0-spa-js (Beta)
 
 Auth0 SDK for Single Page Applications using [Authorization Code Grant Flow with PKCE](https://auth0.com/docs/api-auth/tutorials/authorization-code-grant-pkce).
 
+> :warning: Please be aware that v2 is currently in [**Beta**](https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages). Whilst we encourage you to test the update within your applications, we do no recommend using this version in production yet. Please follow the [migration guide](./MIGRATION_GUIDE.md) when updating your application.
+
+![Stage: Beta Release](https://img.shields.io/badge/stage-fa-yellow)
 [![CircleCI](https://circleci.com/gh/auth0/auth0-spa-js.svg?style=svg)](https://circleci.com/gh/auth0/auth0-spa-js)
 ![Release](https://img.shields.io/github/v/release/auth0/auth0-spa-js)
 [![Codecov](https://img.shields.io/codecov/c/github/auth0/auth0-spa-js)](https://codecov.io/gh/auth0/auth0-spa-js)
@@ -37,13 +40,13 @@ From the CDN:
 Using [npm](https://npmjs.org):
 
 ```sh
-npm install @auth0/auth0-spa-js
+npm install @auth0/auth0-spa-js@fa
 ```
 
 Using [yarn](https://yarnpkg.com):
 
 ```sh
-yarn add @auth0/auth0-spa-js
+yarn add @auth0/auth0-spa-js@fa
 ```
 
 ## Getting Started
@@ -75,20 +78,24 @@ Take note of the **Client ID** and **Domain** values under the "Basic Informatio
 Create an `Auth0Client` instance before rendering or initializing your application. You should only have one instance of the client.
 
 ```js
-import createAuth0Client from '@auth0/auth0-spa-js';
+import { createAuth0Client } from '@auth0/auth0-spa-js';
 
 //with async/await
 const auth0 = await createAuth0Client({
   domain: '<AUTH0_DOMAIN>',
-  client_id: '<AUTH0_CLIENT_ID>',
-  redirect_uri: '<MY_CALLBACK_URL>'
+  clientId: '<AUTH0_CLIENT_ID>',
+  authorizationParams: {
+    redirect_uri: '<MY_CALLBACK_URL>'
+  }
 });
 
 //with promises
 createAuth0Client({
   domain: '<AUTH0_DOMAIN>',
-  client_id: '<AUTH0_CLIENT_ID>',
-  redirect_uri: '<MY_CALLBACK_URL>'
+  clientId: '<AUTH0_CLIENT_ID>',
+  authorizationParams: {
+    redirect_uri: '<MY_CALLBACK_URL>'
+  }
 }).then(auth0 => {
   //...
 });
@@ -98,8 +105,10 @@ import { Auth0Client } from '@auth0/auth0-spa-js';
 
 const auth0 = new Auth0Client({
   domain: '<AUTH0_DOMAIN>',
-  client_id: '<AUTH0_CLIENT_ID>',
-  redirect_uri: '<MY_CALLBACK_URL>'
+  clientId: '<AUTH0_CLIENT_ID>',
+  authorizationParams: {
+    redirect_uri: '<MY_CALLBACK_URL>'
+  }
 });
 
 //if you do this, you'll need to check the session yourself
@@ -200,7 +209,7 @@ document.getElementById('call-api').addEventListener('click', () => {
 ```
 
 ```js
-import createAuth0Client from '@auth0/auth0-spa-js';
+import { createAuth0Client } from '@auth0/auth0-spa-js';
 
 document.getElementById('logout').addEventListener('click', () => {
   auth0.logout();
@@ -224,9 +233,11 @@ To use the in-memory mode, no additional options need are required as this is th
 ```js
 await createAuth0Client({
   domain: '<AUTH0_DOMAIN>',
-  client_id: '<AUTH0_CLIENT_ID>',
-  redirect_uri: '<MY_CALLBACK_URL>',
-  cacheLocation: 'localstorage' // valid values are: 'memory' or 'localstorage'
+  clientId: '<AUTH0_CLIENT_ID>',,
+  cacheLocation: 'localstorage' // valid values are: 'memory' or 'localstorage',
+  authorizationParams: {
+    redirect_uri: '<MY_CALLBACK_URL>'
+  }
 });
 ```
 
@@ -271,9 +282,11 @@ const sessionStorageCache = {
 
 await createAuth0Client({
   domain: '<AUTH0_DOMAIN>',
-  client_id: '<AUTH0_CLIENT_ID>',
-  redirect_uri: '<MY_CALLBACK_URL>',
-  cache: sessionStorageCache
+  clientId: '<AUTH0_CLIENT_ID>',
+  cache: sessionStorageCache,
+  authorizationParams: {
+    redirect_uri: '<MY_CALLBACK_URL>'
+  }
 });
 ```
 
@@ -290,9 +303,11 @@ To enable the use of refresh tokens, set the `useRefreshTokens` option to `true`
 ```js
 await createAuth0Client({
   domain: '<AUTH0_DOMAIN>',
-  client_id: '<AUTH0_CLIENT_ID>',
-  redirect_uri: '<MY_CALLBACK_URL>',
-  useRefreshTokens: true
+  clientId: '<AUTH0_CLIENT_ID>',
+  useRefreshTokens: true,
+  authorizationParams: {
+    redirect_uri: '<MY_CALLBACK_URL>'
+  }
 });
 ```
 
@@ -319,9 +334,11 @@ Log in to an organization by specifying the `organization` parameter when settin
 ```js
 createAuth0Client({
   domain: '<AUTH0_DOMAIN>',
-  client_id: '<AUTH0_CLIENT_ID>',
-  redirect_uri: '<MY_CALLBACK_URL>',
-  organization: '<MY_ORG_ID>'
+  clientId: '<AUTH0_CLIENT_ID>',
+  authorizationParams: {
+    organization: '<MY_ORG_ID>',
+    redirect_uri: '<MY_CALLBACK_URL>'
+  }
 });
 ```
 
@@ -330,12 +347,16 @@ You can also specify the organization when logging in:
 ```js
 // Using a redirect
 client.loginWithRedirect({
-  organization: '<MY_ORG_ID>'
+  authorizationParams: {
+    organization: '<MY_ORG_ID>'
+  }
 });
 
 // Using a popup window
 client.loginWithPopup({
-  organization: '<MY_ORG_ID>'
+  authorizationParams: {
+    organization: '<MY_ORG_ID>'
+  }
 });
 ```
 
@@ -351,26 +372,14 @@ const invitation = params.get('invitation');
 
 if (organization && invitation) {
   client.loginWithRedirect({
-    organization,
-    invitation
+    authorizationParams: {
+      invitation,
+      organization
+    }
   });
 }
 ```
 
-### Advanced options
-
-Advanced options can be set by specifying the `advancedOptions` property when configuring `Auth0Client`. Learn about the complete set of advanced options in the [API documentation](https://auth0.github.io/auth0-spa-js/interfaces/advancedoptions.html)
-
-```js
-createAuth0Client({
-  domain: '<AUTH0_DOMAIN>',
-  client_id: '<AUTH0_CLIENT_ID>',
-  advancedOptions: {
-    defaultScope: 'email' // change the scopes that are applied to every authz request. **Note**: `openid` is always specified regardless of this setting
-  }
-});
-```
-
 ## Contributing
 
 We appreciate feedback and contribution to this repo! Before you get started, please see the following: