ra-core/src/auth/useAuthenticated.ts

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

import { UseQueryOptions } from '@tanstack/react-query';
import useAuthState from './useAuthState';

/**
 * Restrict access to authenticated users.
 * Redirect anonymous users to the login page.
 *
 * Use it in your custom page components to require
 * authentication.
 *
 * You can set additional `authParams` at will if your authProvider
 * requires it.
 *
 * @example
 * import { Admin, CustomRoutes, useAuthenticated } from 'react-admin';
 *
 * const FooPage = () => {
 *     const { isPending } = useAuthenticated();
 *     if (isPending) return null;
 *     return <Foo />;
 * }
 *
 * const customRoutes = [
 *     <Route path="/foo" element={<FooPage />} />
 * ];
 *
 * const App = () => (
 *     <Admin>
 *         <CustomRoutes>{customRoutes}</CustomRoutes>
 *     </Admin>
 * );
 */
export const useAuthenticated = <ParamsType = any>({
    params,
    logoutOnFailure = true,
    ...options
}: UseAuthenticatedOptions<ParamsType> = {}) => {
    return useAuthState(params ?? emptyParams, logoutOnFailure, options);
};

export type UseAuthenticatedOptions<ParamsType> = Omit<
    UseQueryOptions<boolean, any> & {
        params?: ParamsType;
    },
    'queryKey' | 'queryFn'
> & {
    logoutOnFailure?: boolean;
};

const emptyParams = {};