add an async getUser function to Auth0ContextInterface

__tests__/auth-provider.test.tsx

@@ -953,6 +953,30 @@ describe('Auth0Provider', () => {
     });
   });
 
+  it('should return the user on getUser', async () => {
+    const userObject = { name: 'foo' };
+    clientMock.getUser.mockResolvedValue(userObject);
+    const wrapper = createWrapper();
+    const { result } = renderHook(() => useContext(Auth0Context), { wrapper });
+    let user;
+    await act(async () => {
+      user = await result.current.getUser();
+    });
+    expect(user).toBe(userObject);
+  });
+
+  it('should handle getUser errors', async () => {
+    const wrapper = createWrapper();
+    const { result } = renderHook(() => useContext(Auth0Context), { wrapper });
+
+    clientMock.getUser.mockRejectedValue(new Error('__test_error__'));
+    await act(async () => {
+      await expect(() => result.current.getUser()).rejects.toThrowError(
+        '__test_error__'
+      );
+    });
+  });
+
   it('should allow passing a custom context', async () => {
     const context = React.createContext<Auth0ContextInterface>(initialContext);
     clientMock.getIdTokenClaims.mockResolvedValue({

src/auth0-context.tsx

@@ -140,6 +140,14 @@ 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 user information if available (decoded
+   * from the `id_token`).
+   *
+   * @typeparam TUser The type to return, has to extend {@link User}.
+   */
+  getUser: <TUser extends User>() => Promise<TUser | undefined>;
 }
 
 /**
@@ -163,6 +171,7 @@ export const initialContext = {
   loginWithPopup: stub,
   logout: stub,
   handleRedirectCallback: stub,
+  getUser: stub,
 };
 
 /**

src/auth0-provider.tsx

@@ -25,6 +25,7 @@ import {
   hasAuthParams,
   loginError,
   tokenError,
+  userError,
   deprecateRedirectUri,
 } from './utils';
 import { reducer } from './reducer';
@@ -267,6 +268,18 @@ const Auth0Provider = (opts: Auth0ProviderOptions): JSX.Element => {
     [client]
   );
 
+  const getUser = useCallback(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async <TUser extends User>(): Promise<any> => {
+      try {
+        return await client.getUser<TUser>();
+      } catch (error) {
+        throw userError(error);
+      }
+    },
+    [client]
+  );
+
   const contextValue = useMemo<Auth0ContextInterface<User>>(() => {
     return {
       ...state,
@@ -277,6 +290,7 @@ const Auth0Provider = (opts: Auth0ProviderOptions): JSX.Element => {
       loginWithPopup,
       logout,
       handleRedirectCallback,
+      getUser,
     };
   }, [
     state,
@@ -287,6 +301,7 @@ const Auth0Provider = (opts: Auth0ProviderOptions): JSX.Element => {
     loginWithPopup,
     logout,
     handleRedirectCallback,
+    getUser,
   ]);
 
   return <context.Provider value={contextValue}>{children}</context.Provider>;

src/utils.tsx

@@ -36,6 +36,8 @@ export const loginError = normalizeErrorFn('Login failed');
 
 export const tokenError = normalizeErrorFn('Get access token failed');
 
+export const userError = normalizeErrorFn('Get user failed');
+
 /**
  * @ignore
  * Helper function to map the v1 `redirectUri` option to the v2 `authorizationParams.redirect_uri`