web / lib/hooks/use-auth-queries

lib/hooks/use-auth-queries

React Query hooks for authentication state.

Provides the current user query and derived auth state booleans. Separated from mutation hooks to enforce clear module boundaries.

Interfaces

Payload CMS /api/users/me response shape.

user: User | null

const authKeys: object

currentUser: readonly ["auth", "current-user"]

fetchCurrentUser(): Promise<CurrentUserResponse>

Fetch the current user from /api/users/me.

Swallows expected auth failures (401/403) as { user: null }. Rethrows transport and server errors so React Query surfaces them.

useCurrentUserQuery(options?): UseQueryResult<CurrentUserResponse, Error>

Query hook for the current authenticated user.

Disabled by default — callers opt in via enabled.

boolean

UseQueryResult<CurrentUserResponse, Error>

useAuthState(): object

Derive auth booleans from the current user query.

Single source of truth for client-side auth state. Components should use this instead of maintaining their own auth state copies.

object

isAuthenticated: boolean

isEmailVerified: boolean

userId: number | null

isLoading: boolean

user: User | null