@auth0/auth0-react 1.12.0 → 2.0.0-beta.0

package/README.md

@@ -1,45 +1,62 @@
-# @auth0/auth0-react
+![Auth0 SDK for React Single Page Applications](https://cdn.auth0.com/website/sdks/banners/auth0-react-banner.png)
 
-Auth0 SDK for React Single Page Applications (SPA).
+> :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.
 
-[![CircleCI](https://img.shields.io/circleci/build/github/auth0/auth0-react.svg?branch=master&style=flat)](https://circleci.com/gh/auth0/auth0-react)
-[![License](https://img.shields.io/:license-mit-blue.svg?style=flat)](https://opensource.org/licenses/MIT)
 [![npm](https://img.shields.io/npm/v/@auth0/auth0-react.svg?style=flat)](https://www.npmjs.com/package/@auth0/auth0-react)
 [![codecov](https://img.shields.io/codecov/c/github/auth0/auth0-react/master.svg?style=flat)](https://codecov.io/gh/auth0/auth0-react)
+![Downloads](https://img.shields.io/npm/dw/@auth0/auth0-react)
+[![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/auth0-react.svg?branch=master&style=flat)](https://circleci.com/gh/auth0/auth0-react)
 
-## Table of Contents
-
-- [Documentation](#documentation)
-- [Installation](#installation)
-- [Getting Started](#getting-started)
-- [Contributing](#contributing)
-- [Support + Feedback](#support--feedback)
-- [Troubleshooting](#troubleshooting)
-- [Frequently Asked Questions](#frequently-asked-questions)
-- [Vulnerability Reporting](#vulnerability-reporting)
-- [What is Auth0](#what-is-auth0)
-- [License](#license)
+📚 [Documentation](#documentation) - 🚀 [Getting Started](#getting-started) - 💻 [API Reference](#api-reference) - 💬 [Feedback](#feedback)
 
 ## Documentation
 
-- [API Reference](https://auth0.github.io/auth0-react/)
-- [Quickstart Guide](https://auth0.com/docs/quickstart/spa/react)
+- [Quickstart](https://auth0.com/docs/quickstart/spa/react) - our interactive guide for quickly adding login, logout and user information to a React app using Auth0.
+- [Sample App](https://github.com/auth0-samples/auth0-react-samples/tree/master/Sample-01) - a full-fledged React application integrated with Auth0.
+- [FAQs](https://github.com/auth0/auth0-react/blob/master/FAQ.md) - frequently asked questions about the auth0-react SDK.
+- [Examples](https://github.com/auth0/auth0-react/blob/master/EXAMPLES.md) - code samples for common React authentication scenario's.
+- [Docs site](https://www.auth0.com/docs) - explore our docs site and learn more about Auth0.
+
+## Getting started
 
-## Installation
+### Installation
 
 Using [npm](https://npmjs.org/)
 
 ```bash
-npm install @auth0/auth0-react
+npm install @auth0/auth0-react@beta
 ```
 
 Using [yarn](https://yarnpkg.com/)
 
 ```bash
-yarn add @auth0/auth0-react
+yarn add @auth0/auth0-react@beta
 ```
 
-## Getting Started
+### Configure Auth0
+
+Create a **Single Page Application** in the [Auth0 Dashboard](https://manage.auth0.com/#/applications).
+
+> **If you're using an existing application**, verify that you have configured the following settings in your Single Page Application:
+>
+> - Click on the "Settings" tab of your application's page.
+> - Ensure that "Token Endpoint Authentication Method" under "Application Properties" is set to "None"
+> - Scroll down and click on the "Show Advanced Settings" link.
+> - Under "Advanced Settings", click on the "OAuth" tab.
+> - Ensure that "JsonWebToken Signature Algorithm" is set to `RS256` and that "OIDC Conformant" is enabled.
+
+Next, configure the following URLs for your application under the "Application URIs" section of the "Settings" page:
+
+- **Allowed Callback URLs**: `http://localhost:3000`
+- **Allowed Logout URLs**: `http://localhost:3000`
+- **Allowed Web Origins**: `http://localhost:3000`
+
+> These URLs should reflect the origins that your application is running on. **Allowed Callback URLs** may also include a path, depending on where you're handling the callback.
+
+Take note of the **Client ID** and **Domain** values under the "Basic Information" section. You'll need these values in the next step.
+
+### Configure the SDK
 
 Configure the SDK by wrapping your application in `Auth0Provider`:
 
@@ -54,7 +71,9 @@ ReactDOM.render(
   <Auth0Provider
     domain="YOUR_AUTH0_DOMAIN"
     clientId="YOUR_AUTH0_CLIENT_ID"
-    redirectUri={window.location.origin}
+    authorizationParams={{
+      redirect_uri: window.location.origin,
+    }}
   >
     <App />
   </Auth0Provider>,
@@ -70,14 +89,8 @@ import React from 'react';
 import { useAuth0 } from '@auth0/auth0-react';
 
 function App() {
-  const {
-    isLoading,
-    isAuthenticated,
-    error,
-    user,
-    loginWithRedirect,
-    logout,
-  } = useAuth0();
+  const { isLoading, isAuthenticated, error, user, loginWithRedirect, logout } =
+    useAuth0();
 
   if (isLoading) {
     return <div>Loading...</div>;
@@ -103,101 +116,21 @@ function App() {
 export default App;
 ```
 
-If you're using TypeScript, you can pass a type parameter to `useAuth0` to specify the type of `user`:
+For more code samples on how to integrate **auth0-react** SDK in your **React** application, have a look at our [examples](https://github.com/auth0/auth0-react/blob/master/EXAMPLES.md).
 
-```ts
-const { user } = useAuth0<{ name: string }>();
+## API reference
 
-user.name; // is a string
-```
-
-### Use with a Class Component
-
-Use the `withAuth0` higher order component to add the `auth0` property to Class components:
-
-```jsx
-import React, { Component } from 'react';
-import { withAuth0 } from '@auth0/auth0-react';
-
-class Profile extends Component {
-  render() {
-    // `this.props.auth0` has all the same properties as the `useAuth0` hook
-    const { user } = this.props.auth0;
-    return <div>Hello {user.name}</div>;
-  }
-}
-
-export default withAuth0(Profile);
-```
+Explore public API's available in auth0-react.
 
-### Protect a Route
+- [Auth0Provider](https://auth0.github.io/auth0-react/modules.html#Auth0Provider)
+- [Auth0ProviderOptions](https://auth0.github.io/auth0-react/interfaces/Auth0ProviderOptions.html)
+- [useAuth0](https://auth0.github.io/auth0-react/modules.html#useAuth0)
+- [withAuth0](https://auth0.github.io/auth0-react/modules.html#withAuth0)
+- [withAuthenticationRequired](https://auth0.github.io/auth0-react/modules.html#withAuthenticationRequired)
 
-Protect a route component using the `withAuthenticationRequired` higher order component. Visits to this route when unauthenticated will redirect the user to the login page and back to this page after login:
-
-```jsx
-import React from 'react';
-import { withAuthenticationRequired } from '@auth0/auth0-react';
+## Feedback
 
-const PrivateRoute = () => <div>Private</div>;
-
-export default withAuthenticationRequired(PrivateRoute, {
-  // Show a message while the user waits to be redirected to the login page.
-  onRedirecting: () => <div>Redirecting you to the login page...</div>,
-});
-```
-
-**Note** If you are using a custom router, you will need to supply the `Auth0Provider` with a custom `onRedirectCallback` method to perform the action that returns the user to the protected page. See examples for [react-router](https://github.com/auth0/auth0-react/blob/master/EXAMPLES.md#1-protecting-a-route-in-a-react-router-dom-app), [Gatsby](https://github.com/auth0/auth0-react/blob/master/EXAMPLES.md#2-protecting-a-route-in-a-gatsby-app) and [Next.js](https://github.com/auth0/auth0-react/blob/master/EXAMPLES.md#3-protecting-a-route-in-a-nextjs-app-in-spa-mode).
-
-### Call an API
-
-Call a protected API with an Access Token:
-
-```jsx
-import React, { useEffect, useState } from 'react';
-import { useAuth0 } from '@auth0/auth0-react';
-
-const Posts = () => {
-  const { getAccessTokenSilently } = useAuth0();
-  const [posts, setPosts] = useState(null);
-
-  useEffect(() => {
-    (async () => {
-      try {
-        const token = await getAccessTokenSilently({
-          audience: 'https://api.example.com/',
-          scope: 'read:posts',
-        });
-        const response = await fetch('https://api.example.com/posts', {
-          headers: {
-            Authorization: `Bearer ${token}`,
-          },
-        });
-        setPosts(await response.json());
-      } catch (e) {
-        console.error(e);
-      }
-    })();
-  }, [getAccessTokenSilently]);
-
-  if (!posts) {
-    return <div>Loading...</div>;
-  }
-
-  return (
-    <ul>
-      {posts.map((post, index) => {
-        return <li key={index}>{post}</li>;
-      })}
-    </ul>
-  );
-};
-
-export default Posts;
-```
-
-For a more detailed example see how to [create a `useApi` hook for accessing protected APIs with an access token](https://github.com/auth0/auth0-react/blob/master/EXAMPLES.md#4-create-a-useapi-hook-for-accessing-protected-apis-with-an-access-token).
-
-## Contributing
+### Contributing
 
 We appreciate feedback and contribution to this repo! Before you get started, please see the following:
 
@@ -205,35 +138,23 @@ We appreciate feedback and contribution to this repo! Before you get started, pl
 - [Auth0's code of conduct guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)
 - [This repo's contribution guide](https://github.com/auth0/auth0-react/blob/master/CONTRIBUTING.md)
 
-## Support + Feedback
-
-For support or to provide feedback, please [raise an issue on our issue tracker](https://github.com/auth0/auth0-react/issues).
-
-## Troubleshooting
-
-For information on how to solve common problems, check out the [Troubleshooting](https://github.com/auth0/auth0-react/blob/master/TROUBLESHOOTING.md) guide
-
-## Frequently Asked Questions
-
-For a rundown of common issues you might encounter when using the SDK, please check out the [FAQ](https://github.com/auth0/auth0-react/blob/master/FAQ.md).
-
-## Vulnerability Reporting
-
-Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues.
-
-## What is Auth0?
+### Raise an issue
 
-Auth0 helps you to easily:
+To provide feedback or report a bug, please [raise an issue on our issue tracker](https://github.com/auth0/auth0-react/issues).
 
-- Implement authentication with multiple identity providers, including social (e.g., Google, Facebook, Microsoft, LinkedIn, GitHub, Twitter, etc), or enterprise (e.g., Windows Azure AD, Google Apps, Active Directory, ADFS, SAML, etc.)
-- Log in users with username/password databases, passwordless, or multi-factor authentication
-- Link multiple user accounts together
-- Generate signed JSON Web Tokens to authorize your API calls and flow the user identity securely
-- Access demographics and analytics detailing how, when, and where users are logging in
-- Enrich user profiles from other data sources using customizable JavaScript rules
+### Vulnerability Reporting
 
-[Why Auth0?](https://auth0.com/why-auth0)
+Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues.
 
-## License
+---
 
-This project is licensed under the MIT license. See the [LICENSE](https://github.com/auth0/auth0-react/blob/master/LICENSE) file for more info.
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: light)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png"   width="150">
+    <source media="(prefers-color-scheme: dark)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_dark_mode.png" width="150">
+    <img alt="Auth0 Logo" src="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150">
+  </picture>
+</p>
+<p align="center">Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout <a href="https://auth0.com/why-auth0">Why Auth0?</a></p>
+<p align="center">
+This project is licensed under the MIT license. See the <a href="https://github.com/auth0/auth0-react/blob/master/LICENSE"> LICENSE</a> file for more info.</p>

package/dist/auth0-context.d.ts

@@ -1,22 +1,10 @@
 /// <reference types="react" />
-import { BaseLoginOptions, GetIdTokenClaimsOptions, GetTokenSilentlyOptions, GetTokenWithPopupOptions, IdToken, LogoutOptions, LogoutUrlOptions, PopupLoginOptions, PopupConfigOptions, RedirectLoginOptions as Auth0RedirectLoginOptions, RedirectLoginResult, User, GetTokenSilentlyVerboseResponse } from '@auth0/auth0-spa-js';
+import { GetTokenSilentlyOptions, GetTokenWithPopupOptions, IdToken, LogoutOptions as SPALogoutOptions, PopupLoginOptions, PopupConfigOptions, RedirectLoginResult, User, GetTokenSilentlyVerboseResponse, RedirectLoginOptions as SPARedirectLoginOptions } from '@auth0/auth0-spa-js';
 import { AuthState } from './auth-state';
-export interface RedirectLoginOptions extends BaseLoginOptions {
-    /**
-     * The URL where Auth0 will redirect your browser to with
-     * the authentication result. It must be whitelisted in
-     * the "Allowed Callback URLs" field in your Auth0 Application's
-     * settings.
-     */
-    redirectUri?: string;
-    /**
-     * Used to store state before doing the redirect
-     */
-    appState?: any;
-    /**
-     * Used to add to the URL fragment before redirecting
-     */
-    fragment?: string;
+import { AppState } from './auth0-provider';
+export interface LogoutOptions extends Omit<SPALogoutOptions, 'onRedirect'> {
+}
+export interface RedirectLoginOptions<TAppState = AppState> extends Omit<SPARedirectLoginOptions<TAppState>, 'onRedirect'> {
 }
 /**
  * Contains the authenticated state and authentication methods provided by the `useAuth0` hook.
@@ -65,7 +53,7 @@ export interface Auth0ContextInterface<TUser extends User = User> extends AuthSt
      * parameters will be auto-generated. If the response is successful,
      * results will be valid according to their expiration times.
      */
-    getAccessTokenWithPopup: (options?: GetTokenWithPopupOptions, config?: PopupConfigOptions) => Promise<string>;
+    getAccessTokenWithPopup: (options?: GetTokenWithPopupOptions, config?: PopupConfigOptions) => Promise<string | undefined>;
     /**
      * ```js
      * const claims = await getIdTokenClaims();
@@ -73,7 +61,7 @@ export interface Auth0ContextInterface<TUser extends User = User> extends AuthSt
      *
      * Returns all claims from the id_token if available.
      */
-    getIdTokenClaims: (options?: GetIdTokenClaimsOptions) => Promise<IdToken | undefined>;
+    getIdTokenClaims: () => Promise<IdToken | undefined>;
     /**
      * ```js
      * await loginWithRedirect(options);
@@ -83,7 +71,7 @@ export interface Auth0ContextInterface<TUser extends User = User> extends AuthSt
      * provided as arguments. Random and secure `state` and `nonce`
      * parameters will be auto-generated.
      */
-    loginWithRedirect: (options?: RedirectLoginOptions) => Promise<void>;
+    loginWithRedirect: (options?: RedirectLoginOptions<AppState>) => Promise<void>;
     /**
      * ```js
      * await loginWithPopup(options, config);
@@ -106,32 +94,10 @@ export interface Auth0ContextInterface<TUser extends User = User> extends AuthSt
      *
      * Clears the application session and performs a redirect to `/v2/logout`, using
      * the parameters provided as arguments, to clear the Auth0 session.
-     * If the `federated` option is specified, it also clears the Identity Provider session.
-     * If the `localOnly` option is specified, it only clears the application session.
-     * It is invalid to set both the `federated` and `localOnly` options to `true`,
-     * and an error will be thrown if you do.
+     * If the `logoutParams.federated` option is specified, it also clears the Identity Provider session.
      * [Read more about how Logout works at Auth0](https://auth0.com/docs/logout).
      */
     logout: (options?: LogoutOptions) => void;
-    /**
-     * ```js
-     * const authUrl = await buildAuthorizeUrl();
-     * ```
-     *
-     * Builds an `/authorize` URL for loginWithRedirect using the parameters
-     * provided as arguments. Random and secure `state` and `nonce`
-     * parameters will be auto-generated.
-     */
-    buildAuthorizeUrl: (options?: Auth0RedirectLoginOptions) => Promise<string>;
-    /**
-     * ```js
-     * const logoutUrl = buildLogoutUrl();
-     * ```
-     *
-     * returns a URL to the logout endpoint using the parameters provided as arguments.
-     * @param options
-     */
-    buildLogoutUrl: (options?: LogoutUrlOptions) => string;
     /**
      * After the browser redirects back to the callback page,
      * call `handleRedirectCallback` to handle success and error

package/dist/auth0-context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth0-context.d.ts","sourceRoot":"","sources":["../src/auth0-context.tsx"],"names":[],"mappings":";AAAA,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EACvB,uBAAuB,EACvB,wBAAwB,EACxB,OAAO,EACP,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,IAAI,yBAAyB,EACjD,mBAAmB,EACnB,IAAI,EACJ,+BAA+B,EAChC,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,SAAS,EAAoB,MAAM,cAAc,CAAC;AAE3D,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,KAAK,SAAS,IAAI,GAAG,IAAI,CAC9D,SAAQ,SAAS,CAAC,KAAK,CAAC;IACxB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,sBAAsB,EAAE;QACtB,CACE,OAAO,EAAE,uBAAuB,GAAG;YAAE,gBAAgB,EAAE,IAAI,CAAA;SAAE,GAC5D,OAAO,CAAC,+BAA+B,CAAC,CAAC;QAC5C,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QACrD,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CACzC,+BAA+B,GAAG,MAAM,CACzC,CAAC;KACH,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,uBAAuB,EAAE,CACvB,OAAO,CAAC,EAAE,wBAAwB,EAClC,MAAM,CAAC,EAAE,kBAAkB,KACxB,OAAO,CAAC,MAAM,CAAC,CAAC;IAErB;;;;;;OAMG;IACH,gBAAgB,EAAE,CAChB,OAAO,CAAC,EAAE,uBAAuB,KAC9B,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;IAElC;;;;;;;;OAQG;IACH,iBAAiB,EAAE,CAAC,OAAO,CAAC,EAAE,oBAAoB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE;;;;;;;;;;;;;OAaG;IACH,cAAc,EAAE,CACd,OAAO,CAAC,EAAE,iBAAiB,EAC3B,MAAM,CAAC,EAAE,kBAAkB,KACxB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnB;;;;;;;;;;;;OAYG;IACH,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;IAE1C;;;;;;;;OAQG;IACH,iBAAiB,EAAE,CAAC,OAAO,CAAC,EAAE,yBAAyB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5E;;;;;;;OAOG;IACH,cAAc,EAAE,CAAC,OAAO,CAAC,EAAE,gBAAgB,KAAK,MAAM,CAAC;IAEvD;;;;;;;OAOG;IACH,sBAAsB,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;CACxE;AASD;;GAEG;AACH,eAAO,MAAM,cAAc;6BAPV,KAAK;0BAAL,KAAK;kCAAL,KAAK;mCAAL,KAAK;4BAAL,KAAK;6BAAL,KAAK;0BAAL,KAAK;kBAAL,KAAK;kCAAL,KAAK;;;;;CAkBrB,CAAC;AAEF;;GAEG;AACH,QAAA,MAAM,YAAY,sDAAuD,CAAC;AAE1E,eAAe,YAAY,CAAC"}
+{"version":3,"file":"auth0-context.d.ts","sourceRoot":"","sources":["../src/auth0-context.tsx"],"names":[],"mappings":";AAAA,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,OAAO,EACP,aAAa,IAAI,gBAAgB,EACjC,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,IAAI,EACJ,+BAA+B,EAC/B,oBAAoB,IAAI,uBAAuB,EAChD,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,SAAS,EAAoB,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAG5C,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,gBAAgB,EAAE,YAAY,CAAC;CAAG;AAE9E,MAAM,WAAW,oBAAoB,CAAC,SAAS,GAAG,QAAQ,CACxD,SAAQ,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,EAAE,YAAY,CAAC;CAAG;AAEnE;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,KAAK,SAAS,IAAI,GAAG,IAAI,CAC9D,SAAQ,SAAS,CAAC,KAAK,CAAC;IACxB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,sBAAsB,EAAE;QACtB,CACE,OAAO,EAAE,uBAAuB,GAAG;YAAE,gBAAgB,EAAE,IAAI,CAAA;SAAE,GAC5D,OAAO,CAAC,+BAA+B,CAAC,CAAC;QAC5C,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QACrD,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CACzC,+BAA+B,GAAG,MAAM,CACzC,CAAC;KACH,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,uBAAuB,EAAE,CACvB,OAAO,CAAC,EAAE,wBAAwB,EAClC,MAAM,CAAC,EAAE,kBAAkB,KACxB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEjC;;;;;;OAMG;IACH,gBAAgB,EAAE,MAAM,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;IAErD;;;;;;;;OAQG;IACH,iBAAiB,EAAE,CACjB,OAAO,CAAC,EAAE,oBAAoB,CAAC,QAAQ,CAAC,KACrC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnB;;;;;;;;;;;;;OAaG;IACH,cAAc,EAAE,CACd,OAAO,CAAC,EAAE,iBAAiB,EAC3B,MAAM,CAAC,EAAE,kBAAkB,KACxB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnB;;;;;;;;;OASG;IACH,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;IAE1C;;;;;;;OAOG;IACH,sBAAsB,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;CACxE;AASD;;GAEG;AACH,eAAO,MAAM,cAAc;6BAPV,KAAK;0BAAL,KAAK;kCAAL,KAAK;mCAAL,KAAK;4BAAL,KAAK;6BAAL,KAAK;0BAAL,KAAK;kBAAL,KAAK;kCAAL,KAAK;;;;;CAkBrB,CAAC;AAEF;;GAEG;AACH,QAAA,MAAM,YAAY,sDAAuD,CAAC;AAE1E,eAAe,YAAY,CAAC"}

package/dist/auth0-provider.d.ts

@@ -1,17 +1,17 @@
 import React from 'react';
-import { CacheLocation, ICache, User } from '@auth0/auth0-spa-js';
+import { Auth0ClientOptions, User } from '@auth0/auth0-spa-js';
 import { Auth0ContextInterface } from './auth0-context';
 /**
  * The state of the application before the user was redirected to the login page.
  */
-export declare type AppState = {
+export type AppState = {
     returnTo?: string;
     [key: string]: any;
 };
 /**
  * The main configuration to instantiate the `Auth0Provider`.
  */
-export interface Auth0ProviderOptions {
+export interface Auth0ProviderOptions extends Auth0ClientOptions {
     /**
      * The child nodes your Provider has wrapped
      */
@@ -36,104 +36,6 @@ export interface Auth0ProviderOptions {
      * ```
      */
     skipRedirectCallback?: boolean;
-    /**
-     * Your Auth0 account domain such as `'example.auth0.com'`,
-     * `'example.eu.auth0.com'` or , `'example.mycompany.com'`
-     * (when using [custom domains](https://auth0.com/docs/custom-domains))
-     */
-    domain: string;
-    /**
-     * The issuer to be used for validation of JWTs, optionally defaults to the domain above
-     */
-    issuer?: string;
-    /**
-     * The Client ID found on your Application settings page
-     */
-    clientId: string;
-    /**
-     * The default URL where Auth0 will redirect your browser to with
-     * the authentication result. It must be whitelisted in
-     * the "Allowed Callback URLs" field in your Auth0 Application's
-     * settings. If not provided here, it should be provided in the other
-     * methods that provide authentication.
-     */
-    redirectUri?: string;
-    /**
-     * The value in seconds used to account for clock skew in JWT expirations.
-     * Typically, this value is no more than a minute or two at maximum.
-     * Defaults to 60s.
-     */
-    leeway?: number;
-    /**
-     * The location to use when storing cache data. Valid values are `memory` or `localstorage`.
-     * The default setting is `memory`.
-     *
-     * Read more about [changing storage options in the Auth0 docs](https://auth0.com/docs/libraries/auth0-single-page-app-sdk#change-storage-options)
-     */
-    cacheLocation?: CacheLocation;
-    /**
-     * Specify a custom cache implementation to use for token storage and retrieval. This setting takes precedence over `cacheLocation` if they are both specified.
-     *
-     * Read more about [creating a custom cache](https://github.com/auth0/auth0-spa-js#creating-a-custom-cache)
-     */
-    cache?: ICache;
-    /**
-     * If true, refresh tokens are used to fetch new access tokens from the Auth0 server. If false, the legacy technique of using a hidden iframe and the `authorization_code` grant with `prompt=none` is used.
-     * The default setting is `false`.
-     *
-     * **Note**: Use of refresh tokens must be enabled by an administrator on your Auth0 client application.
-     */
-    useRefreshTokens?: boolean;
-    /**
-     * A maximum number of seconds to wait before declaring background calls to /authorize as failed for timeout
-     * Defaults to 60s.
-     */
-    authorizeTimeoutInSeconds?: number;
-    /**
-     * Changes to recommended defaults, like defaultScope
-     */
-    advancedOptions?: {
-        /**
-         * The default scope to be included with all requests.
-         * If not provided, 'openid profile email' is used. This can be set to `null` in order to effectively remove the default scopes.
-         *
-         * Note: The `openid` scope is **always applied** regardless of this setting.
-         */
-        defaultScope?: string;
-    };
-    /**
-     * Maximum allowable elapsed time (in seconds) since authentication.
-     * If the last time the user authenticated is greater than this value,
-     * the user must be reauthenticated.
-     */
-    maxAge?: string | number;
-    /**
-     * The default scope to be used on authentication requests.
-     * The defaultScope defined in the Auth0Client is included
-     * along with this scope
-     */
-    scope?: string;
-    /**
-     * The default audience to be used for requesting API access.
-     */
-    audience?: string;
-    /**
-     * The Id of an organization to log in to.
-     *
-     * This will specify an `organization` parameter in your user's login request and will add a step to validate
-     * the `org_id` claim in your user's ID Token.
-     */
-    organization?: string;
-    /**
-     * The Id of an invitation to accept. This is available from the user invitation URL that is given when participating in a user invitation flow.
-     */
-    invitation?: string;
-    /**
-     * The name of the connection configured for your application.
-     * If null, it will redirect to the Auth0 Login Page and show
-     * the Login Widget.
-     */
-    connection?: string;
     /**
      * Context to be used when creating the Auth0Provider, defaults to the internally created context.
      *
@@ -152,11 +54,6 @@ export interface Auth0ProviderOptions {
      * For a sample on using multiple Auth0Providers review the [React Account Linking Sample](https://github.com/auth0-samples/auth0-link-accounts-sample/tree/react-variant)
      */
     context?: React.Context<Auth0ContextInterface>;
-    /**
-     * If you need to send custom parameters to the Authorization Server,
-     * make sure to use the original parameter name.
-     */
-    [key: string]: any;
 }
 /**
  * ```jsx

package/dist/auth0-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth0-provider.d.ts","sourceRoot":"","sources":["../src/auth0-provider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAON,MAAM,OAAO,CAAC;AACf,OAAO,EAGL,aAAa,EAQb,MAAM,EAEN,IAAI,EACL,MAAM,qBAAqB,CAAC;AAC7B,OAAqB,EACnB,qBAAqB,EAEtB,MAAM,iBAAiB,CAAC;AAKzB;;GAEG;AACH,oBAAY,QAAQ,GAAG;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,IAAI,KAAK,IAAI,CAAC;IAChE;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,eAAe,CAAC,EAAE;QAChB;;;;;WAKG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IACF;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC/C;;;OAGG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAsDD;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,aAAa,SAAU,oBAAoB,KAAG,WA8KnD,CAAC;AAEF,eAAe,aAAa,CAAC"}
+{"version":3,"file":"auth0-provider.d.ts","sourceRoot":"","sources":["../src/auth0-provider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAON,MAAM,OAAO,CAAC;AACf,OAAO,EAEL,kBAAkB,EAMlB,IAAI,EACL,MAAM,qBAAqB,CAAC;AAC7B,OAAqB,EACnB,qBAAqB,EAGtB,MAAM,iBAAiB,CAAC;AAKzB;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB;IAC9D;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,IAAI,KAAK,IAAI,CAAC;IAChE;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;CAChD;AAkCD;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,aAAa,SAAU,oBAAoB,KAAG,WA2JnD,CAAC;AAEF,eAAe,aAAa,CAAC"}