Allow SWR mutation in useUser hook

[tusharpandey13]

Fixes: #1937

Changes

• Added an invalidate function to the return value of the useUser hook.
• This function allows developers to manually trigger a re-validation (re-fetch) of the user profile data from the /auth/profile endpoint.

Testing

Tests have been updated in src/client/hooks/use-user.test.tsx to cover the new invalidate functionality, ensuring it correctly triggers a data refresh using SWR's mutate function.

PASSING

Test Files  12 passed (12)
      Tests  180 passed | 4 skipped (184)
   Start at  15:39:08
   Duration  2.18s (transform 608ms, setup 0ms, collect 2.46s, tests 619ms, environment 816ms, prepare 2.13s)

Usage

Client Components:

You can access the invalidate function from the useUser hook and call it when you need to refresh the user data, for example, after a user profile update action.

"use client";

import { useUser } from '@auth0/nextjs-auth0/client';

export default function ProfileUpdater() {
  const { user, error, isLoading, invalidate } = useUser();

  if (isLoading) return <div>Loading...</div>;
  if (error) return <div>{error.message}</div>;

  const handleUpdateProfile = async () => {
    // Perform profile update logic...
    // const response = await fetch('/api/update-profile', { method: 'POST', ... });

    // After successful update, invalidate the user cache to refetch
    // invalidate(); // <--- Call invalidate here
    // Or use mutate directly if you have the updated user data
    // invalidate(updatedUserData, false); // Update local data immediately, don't revalidate
  };

  return (
    user && (
      <div>
        <h1>Welcome {user.name}!</h1>
        <button onClick={handleUpdateProfile}>Update Profile & Refresh</button>
      </div>
    )
  );
}

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 82.75862% with 5 lines in your changes missing coverage. Please review.

Project coverage is 80.02%. Comparing base (dbfd502) to head (e6967b5).

Files with missing lines	Patch %	Lines
src/server/session/stateless-session-store.ts	50.00%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2045      +/-   ##
==========================================
+ Coverage   78.47%   80.02%   +1.55%     
==========================================
  Files          21       21              
  Lines        1909     1907       -2     
  Branches      307      315       +8     
==========================================
+ Hits         1498     1526      +28     
+ Misses        405      376      -29     
+ Partials        6        5       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

This has been taken care of