ra-core/src/auth/useGetIdentity.ts

Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React

import { useMemo } from 'react';
import { useQuery, UseQueryOptions, QueryObserverResult } from 'react-query';

import useAuthProvider from './useAuthProvider';
import { UserIdentity } from '../types';

const defaultIdentity = {
    id: '',
    fullName: null,
};
const defaultQueryParams = {
    staleTime: 5 * 60 * 1000,
};

/**
 * Return the current user identity by calling authProvider.getIdentity() on mount
 *
 * The return value updates according to the call state:
 *
 * - mount: { isLoading: true }
 * - success: { data: Identity, refetch: () => {}, isLoading: false }
 * - error: { error: Error, isLoading: false }
 *
 * The implementation is left to the authProvider.
 *
 * @returns The current user identity. Destructure as { isLoading, data, error, refetch }.
 *
 * @example
 * import { useGetIdentity, useGetOne } from 'react-admin';
 *
 * const PostDetail = ({ id }) => {
 *     const { data: post, isLoading: postLoading } = useGetOne('posts', { id });
 *     const { data: identity, isLoading: identityLoading } = useGetIdentity();
 *     if (postLoading || identityLoading) return <>Loading...</>;
 *     if (!post.lockedBy || post.lockedBy === identity.id) {
 *         // post isn't locked, or is locked by me
 *         return <PostEdit post={post} />
 *     } else {
 *         // post is locked by someone else and cannot be edited
 *         return <PostShow post={post} />
 *     }
 * }
 */
export const useGetIdentity = (
    queryParams: UseQueryOptions<UserIdentity, Error> = defaultQueryParams
): UseGetIdentityResult => {
    const authProvider = useAuthProvider();

    const result = useQuery(
        ['auth', 'getIdentity'],
        authProvider
            ? () => authProvider.getIdentity()
            : async () => defaultIdentity,
        {
            enabled: typeof authProvider?.getIdentity === 'function',
            ...queryParams,
        }
    );

    // @FIXME: return useQuery's result directly by removing identity prop (BC break - to be done in v5)
    return useMemo(
        () =>
            result.isLoading
                ? { isLoading: true }
                : result.error
                ? { error: result.error, isLoading: false }
                : {
                      data: result.data,
                      identity: result.data,
                      refetch: result.refetch,
                      isLoading: false,
                  },

        [result]
    );
};

export type UseGetIdentityResult =
    | {
          isLoading: true;
          data?: undefined;
          identity?: undefined;
          error?: undefined;
          refetch?: undefined;
      }
    | {
          isLoading: false;
          data?: undefined;
          identity?: undefined;
          error: Error;
          refetch?: undefined;
      }
    | {
          isLoading: false;
          data: UserIdentity;
          /**
           * @deprecated Use data instead
           */
          identity: UserIdentity;
          error?: undefined;
          refetch: () => Promise<QueryObserverResult<UserIdentity, Error>>;
      };

export default useGetIdentity;