@auth0/auth0-react 2.3.0 → 2.5.0

package/dist/errors.d.ts

@@ -1,12 +1,12 @@
-/**
- * An OAuth2 error will come from the authorization server and will have at least an `error` property which will
- * be the error code. And possibly an `error_description` property
- *
- * See: https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3.1.2.6
- */
-export declare class OAuthError extends Error {
-    error: string;
-    error_description?: string | undefined;
-    constructor(error: string, error_description?: string | undefined);
-}
+/**
+ * An OAuth2 error will come from the authorization server and will have at least an `error` property which will
+ * be the error code. And possibly an `error_description` property
+ *
+ * See: https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3.1.2.6
+ */
+export declare class OAuthError extends Error {
+    error: string;
+    error_description?: string | undefined;
+    constructor(error: string, error_description?: string | undefined);
+}
 //# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,KAAK;IAChB,KAAK,EAAE,MAAM;IAAS,iBAAiB,CAAC;gBAAxC,KAAK,EAAE,MAAM,EAAS,iBAAiB,CAAC,oBAAQ;CAMpE"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,KAAK;IAChB,KAAK,EAAE,MAAM;IAAS,iBAAiB,CAAC,EAAE,MAAM;gBAAhD,KAAK,EAAE,MAAM,EAAS,iBAAiB,CAAC,EAAE,MAAM,YAAA;CAMpE"}

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-export { default as Auth0Provider, Auth0ProviderOptions, AppState, } from './auth0-provider';
-export { default as useAuth0 } from './use-auth0';
-export { default as withAuth0, WithAuth0Props } from './with-auth0';
-export { default as withAuthenticationRequired, WithAuthenticationRequiredOptions, } from './with-authentication-required';
-export { default as Auth0Context, Auth0ContextInterface, initialContext, LogoutOptions, RedirectLoginOptions, } from './auth0-context';
-export { AuthorizationParams, PopupLoginOptions, PopupConfigOptions, GetTokenWithPopupOptions, LogoutUrlOptions, CacheLocation, GetTokenSilentlyOptions, IdToken, User, ICache, InMemoryCache, LocalStorageCache, Cacheable, TimeoutError, MfaRequiredError, PopupCancelledError, PopupTimeoutError, AuthenticationError, MissingRefreshTokenError, GenericError } from '@auth0/auth0-spa-js';
-export { OAuthError } from './errors';
+export { default as Auth0Provider, Auth0ProviderOptions, AppState, } from './auth0-provider';
+export { default as useAuth0 } from './use-auth0';
+export { default as withAuth0, WithAuth0Props } from './with-auth0';
+export { default as withAuthenticationRequired, WithAuthenticationRequiredOptions, } from './with-authentication-required';
+export { default as Auth0Context, Auth0ContextInterface, initialContext, LogoutOptions, RedirectLoginOptions, } from './auth0-context';
+export { AuthorizationParams, PopupLoginOptions, PopupConfigOptions, GetTokenWithPopupOptions, LogoutUrlOptions, CacheLocation, GetTokenSilentlyOptions, IdToken, User, ICache, InMemoryCache, LocalStorageCache, Cacheable, TimeoutError, MfaRequiredError, PopupCancelledError, PopupTimeoutError, AuthenticationError, MissingRefreshTokenError, GenericError, UseDpopNonceError, type FetcherConfig } from '@auth0/auth0-spa-js';
+export { OAuthError } from './errors';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,IAAI,aAAa,EACxB,oBAAoB,EACpB,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EACL,OAAO,IAAI,0BAA0B,EACrC,iCAAiC,GAClC,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,OAAO,IAAI,YAAY,EACvB,qBAAqB,EACrB,cAAc,EACd,aAAa,EACb,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,wBAAwB,EACxB,gBAAgB,EAChB,aAAa,EACb,uBAAuB,EACvB,OAAO,EACP,IAAI,EACJ,MAAM,EACN,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,YAAY,EACZ,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,wBAAwB,EACxB,YAAY,EACb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,IAAI,aAAa,EACxB,oBAAoB,EACpB,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EACL,OAAO,IAAI,0BAA0B,EACrC,iCAAiC,GAClC,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,OAAO,IAAI,YAAY,EACvB,qBAAqB,EACrB,cAAc,EACd,aAAa,EACb,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,wBAAwB,EACxB,gBAAgB,EAChB,aAAa,EACb,uBAAuB,EACvB,OAAO,EACP,IAAI,EACJ,MAAM,EACN,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,YAAY,EACZ,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,wBAAwB,EACxB,YAAY,EACZ,iBAAiB,EACjB,KAAK,aAAa,EACnB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC"}

package/dist/reducer.d.ts

@@ -1,19 +1,19 @@
-import { User } from '@auth0/auth0-spa-js';
-import { AuthState } from './auth-state';
-type Action = {
-    type: 'LOGIN_POPUP_STARTED';
-} | {
-    type: 'INITIALISED' | 'LOGIN_POPUP_COMPLETE' | 'GET_ACCESS_TOKEN_COMPLETE' | 'HANDLE_REDIRECT_COMPLETE';
-    user?: User;
-} | {
-    type: 'LOGOUT';
-} | {
-    type: 'ERROR';
-    error: Error;
-};
-/**
- * Handles how that state changes in the `useAuth0` hook.
- */
-export declare const reducer: (state: AuthState, action: Action) => AuthState;
-export {};
+import { User } from '@auth0/auth0-spa-js';
+import { AuthState } from './auth-state';
+type Action = {
+    type: 'LOGIN_POPUP_STARTED';
+} | {
+    type: 'INITIALISED' | 'LOGIN_POPUP_COMPLETE' | 'GET_ACCESS_TOKEN_COMPLETE' | 'HANDLE_REDIRECT_COMPLETE';
+    user: User | undefined;
+} | {
+    type: 'LOGOUT';
+} | {
+    type: 'ERROR';
+    error: Error;
+};
+/**
+ * Handles how that state changes in the `useAuth0` hook.
+ */
+export declare const reducer: <TUser extends User = User>(state: AuthState<TUser>, action: Action) => AuthState<TUser>;
+export {};
 //# sourceMappingURL=reducer.d.ts.map

package/dist/reducer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reducer.d.ts","sourceRoot":"","sources":["../src/reducer.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,KAAK,MAAM,GACP;IAAE,IAAI,EAAE,qBAAqB,CAAA;CAAE,GAC/B;IACE,IAAI,EACA,aAAa,GACb,sBAAsB,GACtB,2BAA2B,GAC3B,0BAA0B,CAAC;IAC/B,IAAI,CAAC,EAAE,IAAI,CAAC;CACb,GACD;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,OAAO,UAAW,SAAS,UAAU,MAAM,KAAG,SAuC1D,CAAC"}
+{"version":3,"file":"reducer.d.ts","sourceRoot":"","sources":["../src/reducer.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,KAAK,MAAM,GACP;IAAE,IAAI,EAAE,qBAAqB,CAAA;CAAE,GAC/B;IACE,IAAI,EACA,aAAa,GACb,sBAAsB,GACtB,2BAA2B,GAC3B,0BAA0B,CAAC;IAC/B,IAAI,EAAE,IAAI,GAAG,SAAS,CAAC;CACxB,GACD;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,KAAK,SAAS,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,CAAC,KAAK,CAAC,EAAE,QAAQ,MAAM,KAAG,SAAS,CAAC,KAAK,CAuC3G,CAAC"}

package/dist/use-auth0.d.ts

@@ -1,28 +1,27 @@
-/// <reference types="react" />
-import { User } from '@auth0/auth0-spa-js';
-import { Auth0ContextInterface } from './auth0-context';
-/**
- * ```js
- * const {
- *   // Auth state:
- *   error,
- *   isAuthenticated,
- *   isLoading,
- *   user,
- *   // Auth methods:
- *   getAccessTokenSilently,
- *   getAccessTokenWithPopup,
- *   getIdTokenClaims,
- *   loginWithRedirect,
- *   loginWithPopup,
- *   logout,
- * } = useAuth0<TUser>();
- * ```
- *
- * Use the `useAuth0` hook in your components to access the auth state and methods.
- *
- * TUser is an optional type param to provide a type to the `user` field.
- */
-declare const useAuth0: <TUser extends User = User>(context?: import("react").Context<Auth0ContextInterface<User>>) => Auth0ContextInterface<TUser>;
-export default useAuth0;
+import { User } from '@auth0/auth0-spa-js';
+import { Auth0ContextInterface } from './auth0-context';
+/**
+ * ```js
+ * const {
+ *   // Auth state:
+ *   error,
+ *   isAuthenticated,
+ *   isLoading,
+ *   user,
+ *   // Auth methods:
+ *   getAccessTokenSilently,
+ *   getAccessTokenWithPopup,
+ *   getIdTokenClaims,
+ *   loginWithRedirect,
+ *   loginWithPopup,
+ *   logout,
+ * } = useAuth0<TUser>();
+ * ```
+ *
+ * Use the `useAuth0` hook in your components to access the auth state and methods.
+ *
+ * TUser is an optional type param to provide a type to the `user` field.
+ */
+declare const useAuth0: <TUser extends User = User>(context?: import("react").Context<Auth0ContextInterface<User>>) => Auth0ContextInterface<TUser>;
+export default useAuth0;
 //# sourceMappingURL=use-auth0.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"use-auth0.d.ts","sourceRoot":"","sources":["../src/use-auth0.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAqB,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,QAAA,MAAM,QAAQ,6HAGuC,CAAC;AAEtD,eAAe,QAAQ,CAAC"}
+{"version":3,"file":"use-auth0.d.ts","sourceRoot":"","sources":["../src/use-auth0.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAqB,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,QAAA,MAAM,QAAQ,GAAI,KAAK,SAAS,IAAI,GAAG,IAAI,EACzC,8DAAsB,KACrB,qBAAqB,CAAC,KAAK,CACuB,CAAC;AAEtD,eAAe,QAAQ,CAAC"}

package/dist/utils.d.ts

@@ -1,10 +1,10 @@
-export declare const hasAuthParams: (searchParams?: string) => boolean;
-export declare const loginError: (error: unknown) => Error;
-export declare const tokenError: (error: unknown) => Error;
-/**
- * @ignore
- * Helper function to map the v1 `redirectUri` option to the v2 `authorizationParams.redirect_uri`
- * and log a warning.
- */
-export declare const deprecateRedirectUri: (options?: any) => void;
+export declare const hasAuthParams: (searchParams?: string) => boolean;
+export declare const loginError: (error: unknown) => Error;
+export declare const tokenError: (error: unknown) => Error;
+/**
+ * @ignore
+ * Helper function to map the v1 `redirectUri` option to the v2 `authorizationParams.redirect_uri`
+ * and log a warning.
+ */
+export declare const deprecateRedirectUri: (options?: any) => void;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.tsx"],"names":[],"mappings":"AAMA,eAAO,MAAM,aAAa,6BAA4C,OAEzC,CAAC;AA0B9B,eAAO,MAAM,UAAU,UAtBb,OAAO,KAAG,KAsBsC,CAAC;AAE3D,eAAO,MAAM,UAAU,UAxBb,OAAO,KAAG,KAwBiD,CAAC;AAEtE;;;;GAIG;AAEH,eAAO,MAAM,oBAAoB,aAAc,GAAG,SAkBjD,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.tsx"],"names":[],"mappings":"AAMA,eAAO,MAAM,aAAa,GAAI,qBAAqC,KAAG,OAEzC,CAAC;AA0B9B,eAAO,MAAM,UAAU,UAtBb,OAAO,KAAG,KAsBsC,CAAC;AAE3D,eAAO,MAAM,UAAU,UAxBb,OAAO,KAAG,KAwBiD,CAAC;AAEtE;;;;GAIG;AAEH,eAAO,MAAM,oBAAoB,GAAI,UAAU,GAAG,SAkBjD,CAAC"}

package/dist/with-auth0.d.ts

@@ -1,29 +1,29 @@
-import React, { ComponentType } from 'react';
-import { Auth0ContextInterface } from './auth0-context';
-/**
- * Components wrapped in `withAuth0` will have an additional `auth0` prop
- */
-export interface WithAuth0Props {
-    auth0: Auth0ContextInterface;
-}
-/**
- * ```jsx
- * class MyComponent extends Component {
- *   render() {
- *     // Access the auth context from the `auth0` prop
- *     const { user } = this.props.auth0;
- *     return <div>Hello {user.name}!</div>
- *   }
- * }
- * // Wrap your class component in withAuth0
- * export default withAuth0(MyComponent);
- * ```
- *
- * Wrap your class components in this Higher Order Component to give them access to the Auth0Context.
- *
- * Providing a context as the second argument allows you to configure the Auth0Provider the Auth0Context
- * should come from f you have multiple within your application.
- */
-declare const withAuth0: <P extends WithAuth0Props>(Component: React.ComponentType<P>, context?: React.Context<Auth0ContextInterface<import("@auth0/auth0-spa-js").User>>) => React.ComponentType<Omit<P, "auth0">>;
-export default withAuth0;
+import React, { ComponentType } from 'react';
+import { Auth0ContextInterface } from './auth0-context';
+/**
+ * Components wrapped in `withAuth0` will have an additional `auth0` prop
+ */
+export interface WithAuth0Props {
+    auth0: Auth0ContextInterface;
+}
+/**
+ * ```jsx
+ * class MyComponent extends Component {
+ *   render() {
+ *     // Access the auth context from the `auth0` prop
+ *     const { user } = this.props.auth0;
+ *     return <div>Hello {user.name}!</div>
+ *   }
+ * }
+ * // Wrap your class component in withAuth0
+ * export default withAuth0(MyComponent);
+ * ```
+ *
+ * Wrap your class components in this Higher Order Component to give them access to the Auth0Context.
+ *
+ * Providing a context as the second argument allows you to configure the Auth0Provider the Auth0Context
+ * should come from f you have multiple within your application.
+ */
+declare const withAuth0: <P extends WithAuth0Props>(Component: ComponentType<P>, context?: React.Context<Auth0ContextInterface<import("@auth0/auth0-spa-js").User>>) => ComponentType<Omit<P, keyof WithAuth0Props>>;
+export default withAuth0;
 //# sourceMappingURL=with-auth0.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"with-auth0.d.ts","sourceRoot":"","sources":["../src/with-auth0.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAqB,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,qBAAqB,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,QAAA,MAAM,SAAS,4LAad,CAAC;AAEF,eAAe,SAAS,CAAC"}
+{"version":3,"file":"with-auth0.d.ts","sourceRoot":"","sources":["../src/with-auth0.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAqB,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,qBAAqB,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,QAAA,MAAM,SAAS,GAAI,CAAC,SAAS,cAAc,EACzC,WAAW,aAAa,CAAC,CAAC,CAAC,EAC3B,kFAAsB,KACrB,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,cAAc,CAAC,CAU7C,CAAC;AAEF,eAAe,SAAS,CAAC"}

package/dist/with-authentication-required.d.ts

@@ -1,77 +1,77 @@
-import React, { ComponentType, FC } from 'react';
-import { Auth0ContextInterface, RedirectLoginOptions } from './auth0-context';
-/**
- * Options for the withAuthenticationRequired Higher Order Component
- */
-export interface WithAuthenticationRequiredOptions {
-    /**
-     * ```js
-     * withAuthenticationRequired(Profile, {
-     *   returnTo: '/profile'
-     * })
-     * ```
-     *
-     * or
-     *
-     * ```js
-     * withAuthenticationRequired(Profile, {
-     *   returnTo: () => window.location.hash.substr(1)
-     * })
-     * ```
-     *
-     * Add a path for the `onRedirectCallback` handler to return the user to after login.
-     */
-    returnTo?: string | (() => string);
-    /**
-     * ```js
-     * withAuthenticationRequired(Profile, {
-     *   onRedirecting: () => <div>Redirecting you to the login...</div>
-     * })
-     * ```
-     *
-     * Render a message to show that the user is being redirected to the login.
-     */
-    onRedirecting?: () => React.JSX.Element;
-    /**
-     * ```js
-     * withAuthenticationRequired(Profile, {
-     *   onBeforeAuthentication: () => { analyticsLibrary.track('login_triggered'); }
-     * })
-     * ```
-     *
-     * Allows executing logic before the user is redirected to the login page.
-     */
-    onBeforeAuthentication?: () => Promise<void>;
-    /**
-     * ```js
-     * withAuthenticationRequired(Profile, {
-     *   loginOptions: {
-     *     appState: {
-     *       customProp: 'foo'
-     *     }
-     *   }
-     * })
-     * ```
-     *
-     * Pass additional login options, like extra `appState` to the login page.
-     * This will be merged with the `returnTo` option used by the `onRedirectCallback` handler.
-     */
-    loginOptions?: RedirectLoginOptions;
-    /**
-     * The context to be used when calling useAuth0, this should only be provided if you are using multiple Auth0Providers
-     * within your application and you wish to tie a specific component to a Auth0Provider other than the Auth0Provider
-     * associated with the default Auth0Context.
-     */
-    context?: React.Context<Auth0ContextInterface>;
-}
-/**
- * ```js
- * const MyProtectedComponent = withAuthenticationRequired(MyComponent);
- * ```
- *
- * When you wrap your components in this Higher Order Component and an anonymous user visits your component
- * they will be redirected to the login page; after login they will be returned to the page they were redirected from.
- */
-declare const withAuthenticationRequired: <P extends object>(Component: React.ComponentType<P>, options?: WithAuthenticationRequiredOptions) => React.FC<P>;
-export default withAuthenticationRequired;
+import React, { ComponentType, FC } from 'react';
+import { Auth0ContextInterface, RedirectLoginOptions } from './auth0-context';
+/**
+ * Options for the withAuthenticationRequired Higher Order Component
+ */
+export interface WithAuthenticationRequiredOptions {
+    /**
+     * ```js
+     * withAuthenticationRequired(Profile, {
+     *   returnTo: '/profile'
+     * })
+     * ```
+     *
+     * or
+     *
+     * ```js
+     * withAuthenticationRequired(Profile, {
+     *   returnTo: () => window.location.hash.substr(1)
+     * })
+     * ```
+     *
+     * Add a path for the `onRedirectCallback` handler to return the user to after login.
+     */
+    returnTo?: string | (() => string);
+    /**
+     * ```js
+     * withAuthenticationRequired(Profile, {
+     *   onRedirecting: () => <div>Redirecting you to the login...</div>
+     * })
+     * ```
+     *
+     * Render a message to show that the user is being redirected to the login.
+     */
+    onRedirecting?: () => React.JSX.Element;
+    /**
+     * ```js
+     * withAuthenticationRequired(Profile, {
+     *   onBeforeAuthentication: () => { analyticsLibrary.track('login_triggered'); }
+     * })
+     * ```
+     *
+     * Allows executing logic before the user is redirected to the login page.
+     */
+    onBeforeAuthentication?: () => Promise<void>;
+    /**
+     * ```js
+     * withAuthenticationRequired(Profile, {
+     *   loginOptions: {
+     *     appState: {
+     *       customProp: 'foo'
+     *     }
+     *   }
+     * })
+     * ```
+     *
+     * Pass additional login options, like extra `appState` to the login page.
+     * This will be merged with the `returnTo` option used by the `onRedirectCallback` handler.
+     */
+    loginOptions?: RedirectLoginOptions;
+    /**
+     * The context to be used when calling useAuth0, this should only be provided if you are using multiple Auth0Providers
+     * within your application and you wish to tie a specific component to a Auth0Provider other than the Auth0Provider
+     * associated with the default Auth0Context.
+     */
+    context?: React.Context<Auth0ContextInterface>;
+}
+/**
+ * ```js
+ * const MyProtectedComponent = withAuthenticationRequired(MyComponent);
+ * ```
+ *
+ * When you wrap your components in this Higher Order Component and an anonymous user visits your component
+ * they will be redirected to the login page; after login they will be returned to the page they were redirected from.
+ */
+declare const withAuthenticationRequired: <P extends object>(Component: ComponentType<P>, options?: WithAuthenticationRequiredOptions) => FC<P>;
+export default withAuthenticationRequired;
 //# sourceMappingURL=with-authentication-required.d.ts.map

package/dist/with-authentication-required.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"with-authentication-required.d.ts","sourceRoot":"","sources":["../src/with-authentication-required.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,aAAa,EAAa,EAAE,EAAE,MAAM,OAAO,CAAC;AAE5D,OAAqB,EACnB,qBAAqB,EACrB,oBAAoB,EACrB,MAAM,iBAAiB,CAAC;AAkBzB;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IACnC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC;IACxC;;;;;;;;OAQG;IACH,sBAAsB,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,EAAE,oBAAoB,CAAC;IACpC;;;;OAIG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;CAChD;AAED;;;;;;;GAOG;AACH,QAAA,MAAM,0BAA0B,kEAErB,iCAAiC,gBAwC3C,CAAC;AAEF,eAAe,0BAA0B,CAAC"}
+{"version":3,"file":"with-authentication-required.d.ts","sourceRoot":"","sources":["../src/with-authentication-required.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,aAAa,EAAa,EAAE,EAAE,MAAM,OAAO,CAAC;AAE5D,OAAqB,EACnB,qBAAqB,EACrB,oBAAoB,EACrB,MAAM,iBAAiB,CAAC;AAkBzB;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IACnC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC;IACxC;;;;;;;;OAQG;IACH,sBAAsB,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,EAAE,oBAAoB,CAAC;IACpC;;;;OAIG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;CAChD;AAED;;;;;;;GAOG;AACH,QAAA,MAAM,0BAA0B,GAAI,CAAC,SAAS,MAAM,EAClD,WAAW,aAAa,CAAC,CAAC,CAAC,EAC3B,UAAS,iCAAsC,KAC9C,EAAE,CAAC,CAAC,CAuCN,CAAC;AAEF,eAAe,0BAA0B,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "Auth0",
   "name": "@auth0/auth0-react",
-  "version": "2.3.0",
+  "version": "2.5.0",
   "description": "Auth0 SDK for React Single Page Applications (SPA)",
   "keywords": [
     "auth0",
@@ -54,28 +54,28 @@
     "@rollup/plugin-node-resolve": "^15.0.1",
     "@rollup/plugin-replace": "^5.0.1",
     "@rollup/plugin-terser": "^0.4.3",
-    "@testing-library/jest-dom": "6.6.3",
-    "@testing-library/react": "16.1.0",
     "@testing-library/dom": "^10.4.0",
-    "@types/jest": "^29.2.3",
-    "@types/react": "19.0.7",
-    "@types/react-dom": "19.0.3",
-    "@typescript-eslint/eslint-plugin": "^5.45.0",
-    "@typescript-eslint/parser": "^5.45.0",
+    "@testing-library/jest-dom": "6.6.3",
+    "@testing-library/react": "16.3.0",
+    "@types/jest": "^29.5.14",
+    "@types/react": "19.1.8",
+    "@types/react-dom": "19.1.6",
+    "@typescript-eslint/eslint-plugin": "^8.36.0",
+    "@typescript-eslint/parser": "^8.36.0",
     "browserstack-cypress-cli": "^1.19.1",
     "cypress": "^13.1.0",
     "eslint": "^8.28.0",
     "eslint-plugin-react": "^7.31.11",
     "eslint-plugin-react-hooks": "^4.6.0",
     "husky": "^8.0.3",
-    "jest": "^29.3.1",
+    "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.3.1",
     "jest-junit": "^15.0.0",
-    "oidc-provider": "^8.0.0",
+    "oidc-provider": "^8.8.1",
     "prettier": "^2.8.1",
     "pretty-quick": "^3.1.3",
-    "react": "^19.0.0",
-    "react-dom": "19.0.0",
+    "react": "19.1.0",
+    "react-dom": "19.1.0",
     "rollup": "^3.7.0",
     "rollup-plugin-analyzer": "^4.0.0",
     "rollup-plugin-delete": "^2.0.0",
@@ -85,16 +85,16 @@
     "rollup-plugin-serve": "^2.0.2",
     "rollup-plugin-typescript2": "^0.36.0",
     "start-server-and-test": "^2.0",
-    "ts-jest": "^29.0.3",
-    "tslib": "^2.4.1",
-    "typedoc": "^0.25.3",
-    "typescript": "^4.9.4"
+    "ts-jest": "^29.4.0",
+    "tslib": "^2.8.1",
+    "typedoc": "^0.28.7",
+    "typescript": "^5.8.3"
   },
   "peerDependencies": {
     "react": "^16.11.0 || ^17 || ^18 || ^19",
     "react-dom": "^16.11.0 || ^17 || ^18 || ^19"
   },
   "dependencies": {
-    "@auth0/auth0-spa-js": "^2.1.3"
+    "@auth0/auth0-spa-js": "^2.4.1"
   }
 }

package/src/auth-state.tsx

@@ -4,10 +4,10 @@ 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;
+  error: Error | undefined;
   isAuthenticated: boolean;
   isLoading: boolean;
-  user?: TUser;
+  user: TUser | undefined;
 }
 
 /**
@@ -16,4 +16,6 @@ export interface AuthState<TUser extends User = User> {
 export const initialAuthState: AuthState = {
   isAuthenticated: false,
   isLoading: true,
+  error: undefined,
+  user: undefined,
 };

package/src/auth0-context.tsx

@@ -9,14 +9,15 @@ import {
   User,
   GetTokenSilentlyVerboseResponse,
   RedirectLoginOptions as SPARedirectLoginOptions,
+  type Auth0Client,
 } from '@auth0/auth0-spa-js';
 import { createContext } from 'react';
 import { AuthState, initialAuthState } from './auth-state';
 import { AppState } from './auth0-provider';
 
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface LogoutOptions extends Omit<SPALogoutOptions, 'onRedirect'> {}
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface RedirectLoginOptions<TAppState = AppState>
   extends Omit<SPARedirectLoginOptions<TAppState>, 'onRedirect'> {}
 
@@ -140,6 +141,51 @@ export interface Auth0ContextInterface<TUser extends User = User>
    * @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>;
+
+  /**
+   * Returns the current DPoP nonce used for making requests to Auth0.
+   *
+   * It can return `undefined` because when starting fresh it will not
+   * be populated until after the first response from the server.
+   *
+   * It requires enabling the {@link Auth0ClientOptions.useDpop} option.
+   *
+   * @param nonce The nonce value.
+   * @param id    The identifier of a nonce: if absent, it will get the nonce
+   *              used for requests to Auth0. Otherwise, it will be used to
+   *              select a specific non-Auth0 nonce.
+   */
+  getDpopNonce: Auth0Client['getDpopNonce'];
+
+  /**
+   * Sets the current DPoP nonce used for making requests to Auth0.
+   *
+   * It requires enabling the {@link Auth0ClientOptions.useDpop} option.
+   *
+   * @param nonce The nonce value.
+   * @param id    The identifier of a nonce: if absent, it will set the nonce
+   *              used for requests to Auth0. Otherwise, it will be used to
+   *              select a specific non-Auth0 nonce.
+   */
+  setDpopNonce: Auth0Client['setDpopNonce'];
+
+  /**
+   * Returns a string to be used to demonstrate possession of the private
+   * key used to cryptographically bind access tokens with DPoP.
+   *
+   * It requires enabling the {@link Auth0ClientOptions.useDpop} option.
+   */
+  generateDpopProof: Auth0Client['generateDpopProof'];
+
+  /**
+   * Returns a new `Fetcher` class that will contain a `fetchWithAuth()` method.
+   * This is a drop-in replacement for the Fetch API's `fetch()` method, but will
+   * handle certain authentication logic for you, like building the proper auth
+   * headers or managing DPoP nonces and retries automatically.
+   * 
+   * Check the `EXAMPLES.md` file for a deeper look into this method.
+   */
+  createFetcher: Auth0Client['createFetcher'];
 }
 
 /**
@@ -163,6 +209,10 @@ export const initialContext = {
   loginWithPopup: stub,
   logout: stub,
   handleRedirectCallback: stub,
+  getDpopNonce: stub,
+  setDpopNonce: stub,
+  generateDpopProof: stub,
+  createFetcher: stub,
 };
 
 /**