All files / src/hooks/useUserProfile useUserProfile.ts

100% Statements 5/5
100% Branches 4/4
100% Functions 2/2
100% Lines 5/5

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67                                                                            2x 8x 5x                         14x             14x            
/**
 * useUserProfile Hook
 * Story 1.17, Task 5b: React Query hook for user profile data
 *
 * Fetches and caches user profile data with roles and preferences.
 * Uses React Query for server state management with 5-minute stale time.
 */
 
import { useQuery } from '@tanstack/react-query';
import apiClient from '@/services/api/apiClient';
 
interface UserProfile {
  userId: string;
  email: string;
  firstName: string;
  lastName: string;
  currentRole: string;
  availableRoles: string[];
  companyId: string;
  profilePhotoUrl: string | null;
  preferences: {
    language: string;
    notifications: {
      emailEnabled: boolean;
      inAppEnabled: boolean;
    };
    theme: string;
  };
}
 
interface UseUserProfileOptions {
  enabled?: boolean;
  staleTime?: number;
}
 
/**
 * Fetch user profile with roles and preferences
 */
const fetchUserProfile = async (): Promise<UserProfile> => {
  const response = await apiClient.get('/users/me?include=roles,preferences');
  return response.data;
};
 
/**
 * Custom hook to fetch and cache user profile data
 *
 * @param options - Query options
 * @returns React Query result with user profile data
 *
 * @example
 * const { data: profile, isLoading, error } = useUserProfile();
 */
export function useUserProfile(options?: UseUserProfileOptions) {
  const query = useQuery({
    queryKey: ['userProfile'],
    queryFn: fetchUserProfile,
    staleTime: options?.staleTime ?? 1000 * 60 * 5, // 5 minutes default
    enabled: options?.enabled ?? true,
  });
 
  return {
    ...query,
    // Add custom property for unread count if needed in the future
    userProfile: query.data,
  };
}