@auth0/auth0-react 2.3.0 → 2.4.0

package/dist/auth-state.d.ts

@@ -1,15 +1,15 @@
-import { User } from '@auth0/auth0-spa-js';
-/**
- * The auth state which, when combined with the auth methods, make up the return object of the `useAuth0` hook.
- */
-export interface AuthState<TUser extends User = User> {
-    error?: Error;
-    isAuthenticated: boolean;
-    isLoading: boolean;
-    user?: TUser;
-}
-/**
- * The initial auth state.
- */
-export declare const initialAuthState: AuthState;
+import { User } from '@auth0/auth0-spa-js';
+/**
+ * The auth state which, when combined with the auth methods, make up the return object of the `useAuth0` hook.
+ */
+export interface AuthState<TUser extends User = User> {
+    error: Error | undefined;
+    isAuthenticated: boolean;
+    isLoading: boolean;
+    user: TUser | undefined;
+}
+/**
+ * The initial auth state.
+ */
+export declare const initialAuthState: AuthState;
 //# sourceMappingURL=auth-state.d.ts.map

package/dist/auth-state.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth-state.d.ts","sourceRoot":"","sources":["../src/auth-state.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,KAAK,SAAS,IAAI,GAAG,IAAI;IAClD,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,eAAe,EAAE,OAAO,CAAC;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,KAAK,CAAC;CACd;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,SAG9B,CAAC"}
+{"version":3,"file":"auth-state.d.ts","sourceRoot":"","sources":["../src/auth-state.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,KAAK,SAAS,IAAI,GAAG,IAAI;IAClD,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;IACzB,eAAe,EAAE,OAAO,CAAC;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,EAAE,KAAK,GAAG,SAAS,CAAC;CACzB;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,SAK9B,CAAC"}

package/dist/auth0-context.d.ts

@@ -1,136 +1,135 @@
-/// <reference types="react" />
-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';
-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.
- */
-export interface Auth0ContextInterface<TUser extends User = User> extends AuthState<TUser> {
-    /**
-     * ```js
-     * const token = await getAccessTokenSilently(options);
-     * ```
-     *
-     * If there's a valid token stored, return it. Otherwise, opens an
-     * iframe with the `/authorize` URL using the parameters provided
-     * as arguments. Random and secure `state` and `nonce` parameters
-     * will be auto-generated. If the response is successful, results
-     * will be valid according to their expiration times.
-     *
-     * If refresh tokens are used, the token endpoint is called directly with the
-     * 'refresh_token' grant. If no refresh token is available to make this call,
-     * the SDK will only fall back to using an iframe to the '/authorize' URL if
-     * the `useRefreshTokensFallback` setting has been set to `true`. By default this
-     * setting is `false`.
-     *
-     * This method may use a web worker to perform the token call if the in-memory
-     * cache is used.
-     *
-     * If an `audience` value is given to this function, the SDK always falls
-     * back to using an iframe to make the token exchange.
-     *
-     * Note that in all cases, falling back to an iframe requires access to
-     * the `auth0` cookie.
-     */
-    getAccessTokenSilently: {
-        (options: GetTokenSilentlyOptions & {
-            detailedResponse: true;
-        }): Promise<GetTokenSilentlyVerboseResponse>;
-        (options?: GetTokenSilentlyOptions): Promise<string>;
-        (options: GetTokenSilentlyOptions): Promise<GetTokenSilentlyVerboseResponse | string>;
-    };
-    /**
-     * ```js
-     * const token = await getTokenWithPopup(options, config);
-     * ```
-     *
-     * Get an access token interactively.
-     *
-     * Opens a popup with the `/authorize` URL using the parameters
-     * provided as arguments. Random and secure `state` and `nonce`
-     * 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 | undefined>;
-    /**
-     * ```js
-     * const claims = await getIdTokenClaims();
-     * ```
-     *
-     * Returns all claims from the id_token if available.
-     */
-    getIdTokenClaims: () => Promise<IdToken | undefined>;
-    /**
-     * ```js
-     * await loginWithRedirect(options);
-     * ```
-     *
-     * Performs a redirect to `/authorize` using the parameters
-     * provided as arguments. Random and secure `state` and `nonce`
-     * parameters will be auto-generated.
-     */
-    loginWithRedirect: (options?: RedirectLoginOptions<AppState>) => Promise<void>;
-    /**
-     * ```js
-     * await loginWithPopup(options, config);
-     * ```
-     *
-     * Opens a popup with the `/authorize` URL using the parameters
-     * provided as arguments. Random and secure `state` and `nonce`
-     * parameters will be auto-generated. If the response is successful,
-     * results will be valid according to their expiration times.
-     *
-     * IMPORTANT: This method has to be called from an event handler
-     * that was started by the user like a button click, for example,
-     * otherwise the popup will be blocked in most browsers.
-     */
-    loginWithPopup: (options?: PopupLoginOptions, config?: PopupConfigOptions) => Promise<void>;
-    /**
-     * ```js
-     * auth0.logout({ logoutParams: { returnTo: window.location.origin } });
-     * ```
-     *
-     * Clears the application session and performs a redirect to `/v2/logout`, using
-     * the parameters provided as arguments, to clear the Auth0 session.
-     * 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) => Promise<void>;
-    /**
-     * After the browser redirects back to the callback page,
-     * call `handleRedirectCallback` to handle success and error
-     * responses from Auth0. If the response is successful, results
-     * will be valid according to their expiration times.
-     *
-     * @param url The URL to that should be used to retrieve the `state` and `code` values. Defaults to `window.location.href` if not given.
-     */
-    handleRedirectCallback: (url?: string) => Promise<RedirectLoginResult>;
-}
-/**
- * @ignore
- */
-export declare const initialContext: {
-    buildAuthorizeUrl: () => never;
-    buildLogoutUrl: () => never;
-    getAccessTokenSilently: () => never;
-    getAccessTokenWithPopup: () => never;
-    getIdTokenClaims: () => never;
-    loginWithRedirect: () => never;
-    loginWithPopup: () => never;
-    logout: () => never;
-    handleRedirectCallback: () => never;
-    error?: Error | undefined;
-    isAuthenticated: boolean;
-    isLoading: boolean;
-    user?: User | undefined;
-};
-/**
- * The Auth0 Context
- */
-declare const Auth0Context: import("react").Context<Auth0ContextInterface<User>>;
-export default Auth0Context;
+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';
+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.
+ */
+export interface Auth0ContextInterface<TUser extends User = User> extends AuthState<TUser> {
+    /**
+     * ```js
+     * const token = await getAccessTokenSilently(options);
+     * ```
+     *
+     * If there's a valid token stored, return it. Otherwise, opens an
+     * iframe with the `/authorize` URL using the parameters provided
+     * as arguments. Random and secure `state` and `nonce` parameters
+     * will be auto-generated. If the response is successful, results
+     * will be valid according to their expiration times.
+     *
+     * If refresh tokens are used, the token endpoint is called directly with the
+     * 'refresh_token' grant. If no refresh token is available to make this call,
+     * the SDK will only fall back to using an iframe to the '/authorize' URL if
+     * the `useRefreshTokensFallback` setting has been set to `true`. By default this
+     * setting is `false`.
+     *
+     * This method may use a web worker to perform the token call if the in-memory
+     * cache is used.
+     *
+     * If an `audience` value is given to this function, the SDK always falls
+     * back to using an iframe to make the token exchange.
+     *
+     * Note that in all cases, falling back to an iframe requires access to
+     * the `auth0` cookie.
+     */
+    getAccessTokenSilently: {
+        (options: GetTokenSilentlyOptions & {
+            detailedResponse: true;
+        }): Promise<GetTokenSilentlyVerboseResponse>;
+        (options?: GetTokenSilentlyOptions): Promise<string>;
+        (options: GetTokenSilentlyOptions): Promise<GetTokenSilentlyVerboseResponse | string>;
+    };
+    /**
+     * ```js
+     * const token = await getTokenWithPopup(options, config);
+     * ```
+     *
+     * Get an access token interactively.
+     *
+     * Opens a popup with the `/authorize` URL using the parameters
+     * provided as arguments. Random and secure `state` and `nonce`
+     * 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 | undefined>;
+    /**
+     * ```js
+     * const claims = await getIdTokenClaims();
+     * ```
+     *
+     * Returns all claims from the id_token if available.
+     */
+    getIdTokenClaims: () => Promise<IdToken | undefined>;
+    /**
+     * ```js
+     * await loginWithRedirect(options);
+     * ```
+     *
+     * Performs a redirect to `/authorize` using the parameters
+     * provided as arguments. Random and secure `state` and `nonce`
+     * parameters will be auto-generated.
+     */
+    loginWithRedirect: (options?: RedirectLoginOptions<AppState>) => Promise<void>;
+    /**
+     * ```js
+     * await loginWithPopup(options, config);
+     * ```
+     *
+     * Opens a popup with the `/authorize` URL using the parameters
+     * provided as arguments. Random and secure `state` and `nonce`
+     * parameters will be auto-generated. If the response is successful,
+     * results will be valid according to their expiration times.
+     *
+     * IMPORTANT: This method has to be called from an event handler
+     * that was started by the user like a button click, for example,
+     * otherwise the popup will be blocked in most browsers.
+     */
+    loginWithPopup: (options?: PopupLoginOptions, config?: PopupConfigOptions) => Promise<void>;
+    /**
+     * ```js
+     * auth0.logout({ logoutParams: { returnTo: window.location.origin } });
+     * ```
+     *
+     * Clears the application session and performs a redirect to `/v2/logout`, using
+     * the parameters provided as arguments, to clear the Auth0 session.
+     * 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) => Promise<void>;
+    /**
+     * After the browser redirects back to the callback page,
+     * call `handleRedirectCallback` to handle success and error
+     * responses from Auth0. If the response is successful, results
+     * will be valid according to their expiration times.
+     *
+     * @param url The URL to that should be used to retrieve the `state` and `code` values. Defaults to `window.location.href` if not given.
+     */
+    handleRedirectCallback: (url?: string) => Promise<RedirectLoginResult>;
+}
+/**
+ * @ignore
+ */
+export declare const initialContext: {
+    buildAuthorizeUrl: () => never;
+    buildLogoutUrl: () => never;
+    getAccessTokenSilently: () => never;
+    getAccessTokenWithPopup: () => never;
+    getIdTokenClaims: () => never;
+    loginWithRedirect: () => never;
+    loginWithPopup: () => never;
+    logout: () => never;
+    handleRedirectCallback: () => never;
+    error: Error | undefined;
+    isAuthenticated: boolean;
+    isLoading: boolean;
+    user: User | undefined;
+};
+/**
+ * The Auth0 Context
+ */
+declare const Auth0Context: import("react").Context<Auth0ContextInterface<User>>;
+export default Auth0Context;
 //# sourceMappingURL=auth0-context.d.ts.map

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,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;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;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,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;;;;;;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;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;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,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;;;;;;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,72 +1,72 @@
-import React from 'react';
-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 type AppState = {
-    returnTo?: string;
-    [key: string]: any;
-};
-/**
- * The main configuration to instantiate the `Auth0Provider`.
- */
-export interface Auth0ProviderOptions extends Auth0ClientOptions {
-    /**
-     * The child nodes your Provider has wrapped
-     */
-    children?: React.ReactNode;
-    /**
-     * By default this removes the code and state parameters from the url when you are redirected from the authorize page.
-     * It uses `window.history` but you might want to overwrite this if you are using a custom router, like `react-router-dom`
-     * See the EXAMPLES.md for more info.
-     */
-    onRedirectCallback?: (appState?: AppState, user?: User) => void;
-    /**
-     * By default, if the page url has code/state params, the SDK will treat them as Auth0's and attempt to exchange the
-     * code for a token. In some cases the code might be for something else (another OAuth SDK perhaps). In these
-     * instances you can instruct the client to ignore them eg
-     *
-     * ```jsx
-     * <Auth0Provider
-     *   clientId={clientId}
-     *   domain={domain}
-     *   skipRedirectCallback={window.location.pathname === '/stripe-oauth-callback'}
-     * >
-     * ```
-     */
-    skipRedirectCallback?: boolean;
-    /**
-     * Context to be used when creating the Auth0Provider, defaults to the internally created context.
-     *
-     * This allows multiple Auth0Providers to be nested within the same application, the context value can then be
-     * passed to useAuth0, withAuth0, or withAuthenticationRequired to use that specific Auth0Provider to access
-     * auth state and methods specifically tied to the provider that the context belongs to.
-     *
-     * When using multiple Auth0Providers in a single application you should do the following to ensure sessions are not
-     * overwritten:
-     *
-     * * Configure a different redirect_uri for each Auth0Provider, and set skipRedirectCallback for each provider to ignore
-     * the others redirect_uri
-     * * If using localstorage for both Auth0Providers, ensure that the audience and scope are different for so that the key
-     * used to store data is different
-     *
-     * 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>;
-}
-/**
- * ```jsx
- * <Auth0Provider
- *   domain={domain}
- *   clientId={clientId}
- *   authorizationParams={{ redirect_uri: window.location.origin }}>
- *   <MyApp />
- * </Auth0Provider>
- * ```
- *
- * Provides the Auth0Context to its child components.
- */
-declare const Auth0Provider: (opts: Auth0ProviderOptions) => React.JSX.Element;
-export default Auth0Provider;
+import React from 'react';
+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 type AppState = {
+    returnTo?: string;
+    [key: string]: any;
+};
+/**
+ * The main configuration to instantiate the `Auth0Provider`.
+ */
+export interface Auth0ProviderOptions<TUser extends User = User> extends Auth0ClientOptions {
+    /**
+     * The child nodes your Provider has wrapped
+     */
+    children?: React.ReactNode;
+    /**
+     * By default this removes the code and state parameters from the url when you are redirected from the authorize page.
+     * It uses `window.history` but you might want to overwrite this if you are using a custom router, like `react-router-dom`
+     * See the EXAMPLES.md for more info.
+     */
+    onRedirectCallback?: (appState?: AppState, user?: TUser) => void;
+    /**
+     * By default, if the page url has code/state params, the SDK will treat them as Auth0's and attempt to exchange the
+     * code for a token. In some cases the code might be for something else (another OAuth SDK perhaps). In these
+     * instances you can instruct the client to ignore them eg
+     *
+     * ```jsx
+     * <Auth0Provider
+     *   clientId={clientId}
+     *   domain={domain}
+     *   skipRedirectCallback={window.location.pathname === '/stripe-oauth-callback'}
+     * >
+     * ```
+     */
+    skipRedirectCallback?: boolean;
+    /**
+     * Context to be used when creating the Auth0Provider, defaults to the internally created context.
+     *
+     * This allows multiple Auth0Providers to be nested within the same application, the context value can then be
+     * passed to useAuth0, withAuth0, or withAuthenticationRequired to use that specific Auth0Provider to access
+     * auth state and methods specifically tied to the provider that the context belongs to.
+     *
+     * When using multiple Auth0Providers in a single application you should do the following to ensure sessions are not
+     * overwritten:
+     *
+     * * Configure a different redirect_uri for each Auth0Provider, and set skipRedirectCallback for each provider to ignore
+     * the others redirect_uri
+     * * If using localstorage for both Auth0Providers, ensure that the audience and scope are different for so that the key
+     * used to store data is different
+     *
+     * 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<TUser>>;
+}
+/**
+ * ```jsx
+ * <Auth0Provider
+ *   domain={domain}
+ *   clientId={clientId}
+ *   authorizationParams={{ redirect_uri: window.location.origin }}>
+ *   <MyApp />
+ * </Auth0Provider>
+ * ```
+ *
+ * Provides the Auth0Context to its child components.
+ */
+declare const Auth0Provider: <TUser extends User = User>(opts: Auth0ProviderOptions<TUser>) => React.JSX.Element;
+export default Auth0Provider;
 //# sourceMappingURL=auth0-provider.d.ts.map

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,EAEL,kBAAkB,EAMlB,IAAI,EACL,MAAM,qBAAqB,CAAC;AAC7B,OAAqB,EACnB,qBAAqB,EAGtB,MAAM,iBAAiB,CAAC;AAUzB;;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;AAoCD;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,aAAa,SAAU,oBAAoB,sBAmKhD,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;AAUzB;;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,oBAAoB,CAAC,KAAK,SAAS,IAAI,GAAG,IAAI,CAAE,SAAQ,kBAAkB;IACzF;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC;IACjE;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC;CACvD;AAoCD;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,aAAa,GAAI,KAAK,SAAS,IAAI,GAAG,IAAI,EAAE,MAAM,oBAAoB,CAAC,KAAK,CAAC,sBAmKlF,CAAC;AAEF,eAAe,aAAa,CAAC"}