@imtbl/auth-next-client 2.12.7-alpha.1 → 2.12.7-alpha.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@imtbl/auth-next-client",
-  "version": "2.12.7-alpha.1",
+  "version": "2.12.7-alpha.10",
   "description": "Immutable Auth.js v5 integration for Next.js - Client-side components",
   "author": "Immutable",
   "license": "Apache-2.0",
@@ -27,8 +27,8 @@
     }
   },
   "dependencies": {
-    "@imtbl/auth": "2.12.7-alpha.1",
-    "@imtbl/auth-next-server": "2.12.7-alpha.1"
+    "@imtbl/auth": "2.12.7-alpha.10",
+    "@imtbl/auth-next-server": "2.12.7-alpha.10"
   },
   "peerDependencies": {
     "next": "^15.0.0",
@@ -49,6 +49,8 @@
   "devDependencies": {
     "@swc/core": "^1.4.2",
     "@swc/jest": "^0.2.37",
+    "@testing-library/jest-dom": "^5.16.5",
+    "@testing-library/react": "^13.4.0",
     "@types/jest": "^29.5.12",
     "@types/node": "^22.10.7",
     "@types/react": "^18.3.5",

package/src/callback.tsx

@@ -6,6 +6,7 @@ import { signIn } from 'next-auth/react';
 import { handleLoginCallback as handleAuthCallback, type TokenResponse } from '@imtbl/auth';
 import type { ImmutableUserClient } from './types';
 import { IMMUTABLE_PROVIDER_ID } from './constants';
+import { storeIdToken } from './idTokenStorage';
 
 /**
  * Config for CallbackPage - matches LoginConfig from @imtbl/auth
@@ -159,6 +160,12 @@ export function CallbackPage({
           // Not in a popup - sign in to NextAuth with the tokens
           const tokenData = mapTokensToSignInData(tokens);
 
+          // Persist idToken to localStorage before signIn so it's available
+          // immediately. The cookie won't contain idToken (stripped by jwt.encode).
+          if (tokens.idToken) {
+            storeIdToken(tokens.idToken);
+          }
+
           const result = await signIn(IMMUTABLE_PROVIDER_ID, {
             tokens: JSON.stringify(tokenData),
             redirect: false,

package/src/constants.ts

@@ -37,3 +37,9 @@ export const DEFAULT_TOKEN_EXPIRY_SECONDS = 900;
  * Default token expiry in milliseconds
  */
 export const DEFAULT_TOKEN_EXPIRY_MS = DEFAULT_TOKEN_EXPIRY_SECONDS * 1000;
+
+/**
+ * Buffer time in milliseconds before token expiry to trigger refresh.
+ * Matches TOKEN_EXPIRY_BUFFER_SECONDS (60s) in @imtbl/auth-next-server.
+ */
+export const TOKEN_EXPIRY_BUFFER_MS = 60 * 1000;

package/src/hooks.test.tsx

@@ -0,0 +1,317 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable import/first */
+import { renderHook, act } from '@testing-library/react';
+import { TOKEN_EXPIRY_BUFFER_MS } from './constants';
+
+// ---------------------------------------------------------------------------
+// Mocks -- must be declared before importing the modules that use them
+// ---------------------------------------------------------------------------
+
+const mockUpdate = jest.fn();
+const mockUseSession = jest.fn();
+
+jest.mock('next-auth/react', () => ({
+  useSession: () => mockUseSession(),
+  signIn: jest.fn(),
+  signOut: jest.fn(),
+}));
+
+jest.mock('@imtbl/auth', () => ({
+  loginWithPopup: jest.fn(),
+  loginWithEmbedded: jest.fn(),
+  loginWithRedirect: jest.fn(),
+  logoutWithRedirect: jest.fn(),
+}));
+
+import { useImmutableSession } from './hooks';
+
+// ---------------------------------------------------------------------------
+// Helpers
+// ---------------------------------------------------------------------------
+
+/**
+ * Full session shape matching what NextAuth returns at runtime.
+ * The public ImmutableSession type intentionally omits accessToken,
+ * but the underlying data still has it -- tests need the full shape
+ * to set up mock sessions correctly.
+ */
+interface TestSession {
+  accessToken: string;
+  refreshToken?: string;
+  idToken?: string;
+  accessTokenExpires: number;
+  zkEvm?: { ethAddress: string; userAdminAddress: string };
+  error?: string;
+  user?: any;
+  expires: string;
+}
+
+function createSession(overrides: Partial<TestSession> = {}): TestSession {
+  return {
+    accessToken: 'valid-token',
+    refreshToken: 'refresh-token',
+    idToken: 'id-token',
+    accessTokenExpires: Date.now() + 10 * 60 * 1000, // 10 min from now
+    user: { sub: 'user-1', email: 'test@test.com' },
+    expires: new Date(Date.now() + 24 * 60 * 60 * 1000).toISOString(),
+    ...overrides,
+  };
+}
+
+function setupUseSession(session: TestSession | null, status: string = 'authenticated') {
+  mockUseSession.mockReturnValue({
+    data: session,
+    status,
+    update: mockUpdate,
+  });
+}
+
+// ---------------------------------------------------------------------------
+// Tests
+// ---------------------------------------------------------------------------
+
+describe('useImmutableSession', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+    mockUpdate.mockReset();
+  });
+
+  describe('session type safety', () => {
+    it('does not expose accessToken on the public session type', () => {
+      const session = createSession();
+      setupUseSession(session);
+      mockUpdate.mockResolvedValue(session);
+
+      const { result } = renderHook(() => useImmutableSession());
+
+      // TypeScript prevents accessing accessToken, but at runtime the
+      // underlying object still has it. Verify the hook returns a session
+      // and that the public type doesn't advertise accessToken.
+      expect(result.current.session).toBeDefined();
+      expect(result.current.session?.error).toBeUndefined();
+      // The property exists at runtime (it's the same object) but the type
+      // system hides it -- this is a compile-time guard, not a runtime one.
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      expect((result.current.session as any).accessToken).toBeDefined();
+    });
+  });
+
+  describe('getAccessToken()', () => {
+    it('returns the token immediately when it is valid (fast path)', async () => {
+      const session = createSession();
+      setupUseSession(session);
+      mockUpdate.mockResolvedValue(session); // in case proactive timer fires
+
+      const { result } = renderHook(() => useImmutableSession());
+
+      const token = await result.current.getAccessToken();
+      expect(token).toBe('valid-token');
+    });
+
+    it('triggers refresh and returns fresh token when expired', async () => {
+      const expiredSession = createSession({
+        accessTokenExpires: Date.now() - 1000, // already expired
+      });
+      setupUseSession(expiredSession);
+
+      const freshSession = createSession({
+        accessToken: 'fresh-token',
+        accessTokenExpires: Date.now() + 10 * 60 * 1000,
+      });
+      mockUpdate.mockResolvedValue(freshSession);
+
+      const { result } = renderHook(() => useImmutableSession());
+
+      let token: string = '';
+      await act(async () => {
+        token = await result.current.getAccessToken();
+      });
+      expect(token).toBe('fresh-token');
+      expect(mockUpdate).toHaveBeenCalled();
+    });
+
+    it('triggers refresh when token is within the buffer window', async () => {
+      const almostExpiredSession = createSession({
+        accessTokenExpires: Date.now() + TOKEN_EXPIRY_BUFFER_MS - 1000, // within buffer
+      });
+      setupUseSession(almostExpiredSession);
+
+      const freshSession = createSession({
+        accessToken: 'refreshed-token',
+        accessTokenExpires: Date.now() + 10 * 60 * 1000,
+      });
+      mockUpdate.mockResolvedValue(freshSession);
+
+      const { result } = renderHook(() => useImmutableSession());
+
+      let token: string = '';
+      await act(async () => {
+        token = await result.current.getAccessToken();
+      });
+      expect(token).toBe('refreshed-token');
+      expect(mockUpdate).toHaveBeenCalled();
+    });
+
+    it('throws when refresh fails (no accessToken in response)', async () => {
+      const expiredSession = createSession({
+        accessTokenExpires: Date.now() - 1000,
+      });
+      setupUseSession(expiredSession);
+
+      mockUpdate.mockResolvedValue(null);
+
+      const { result } = renderHook(() => useImmutableSession());
+
+      await expect(
+        act(async () => {
+          await result.current.getAccessToken();
+        }),
+      ).rejects.toThrow('[auth-next-client] Failed to get access token');
+    });
+
+    it('throws when refresh returns a session with error', async () => {
+      const expiredSession = createSession({
+        accessTokenExpires: Date.now() - 1000,
+      });
+      setupUseSession(expiredSession);
+
+      const errorSession = createSession({ error: 'RefreshTokenError' });
+      mockUpdate.mockResolvedValue(errorSession);
+
+      const { result } = renderHook(() => useImmutableSession());
+
+      await expect(
+        act(async () => {
+          await result.current.getAccessToken();
+        }),
+      ).rejects.toThrow('RefreshTokenError');
+    });
+
+    it('deduplicates concurrent calls (only one update())', async () => {
+      const expiredSession = createSession({
+        accessTokenExpires: Date.now() - 1000,
+      });
+      setupUseSession(expiredSession);
+
+      const freshSession = createSession({
+        accessToken: 'deduped-token',
+        accessTokenExpires: Date.now() + 10 * 60 * 1000,
+      });
+
+      // Track how many times update is actually invoked
+      let updateCallCount = 0;
+      mockUpdate.mockImplementation(() => {
+        updateCallCount++;
+        return Promise.resolve(freshSession);
+      });
+
+      const { result } = renderHook(() => useImmutableSession());
+
+      let token1: string = '';
+      let token2: string = '';
+      await act(async () => {
+        [token1, token2] = await Promise.all([
+          result.current.getAccessToken(),
+          result.current.getAccessToken(),
+        ]);
+      });
+
+      expect(token1).toBe('deduped-token');
+      expect(token2).toBe('deduped-token');
+      // The proactive effect may also trigger one call, so we check
+      // that concurrent getAccessToken calls are deduped (not doubled)
+      // The key invariant: at most 1 update() call per pending refresh cycle
+      expect(updateCallCount).toBeLessThanOrEqual(2); // 1 from effect + 1 from getAccessToken (deduped)
+    });
+  });
+
+  describe('reactive refresh on mount', () => {
+    it('triggers refresh when token is already expired on mount', async () => {
+      const session = createSession({
+        accessTokenExpires: Date.now() - 1000, // already expired
+      });
+      setupUseSession(session);
+
+      const freshSession = createSession({
+        accessToken: 'immediate-refresh',
+      });
+      mockUpdate.mockResolvedValue(freshSession);
+
+      await act(async () => {
+        renderHook(() => useImmutableSession());
+      });
+
+      // The proactive useEffect should have called update
+      expect(mockUpdate).toHaveBeenCalled();
+    });
+
+    it('does not set isRefreshing during reactive refresh (prevents UI flicker)', async () => {
+      const session = createSession({
+        accessTokenExpires: Date.now() - 1000, // already expired
+      });
+      setupUseSession(session);
+
+      const freshSession = createSession({
+        accessToken: 'immediate-refresh',
+      });
+      mockUpdate.mockResolvedValue(freshSession);
+
+      const capturedIsRefreshing: boolean[] = [];
+      const { result } = renderHook(() => {
+        const hook = useImmutableSession();
+        capturedIsRefreshing.push(hook.isRefreshing);
+        return hook;
+      });
+
+      await act(async () => {
+        // Let the reactive refresh effect run and complete
+        await mockUpdate.mock.results[0]?.value;
+      });
+
+      // isRefreshing should NEVER have been true during reactive refresh.
+      // It is reserved for explicit user-triggered refreshes (getUser(true)).
+      expect(capturedIsRefreshing.every((v) => v === false)).toBe(true);
+      expect(result.current.isRefreshing).toBe(false);
+    });
+
+    it('does not trigger refresh when token is valid and far from expiry', async () => {
+      const session = createSession({
+        accessTokenExpires: Date.now() + 10 * 60 * 1000, // 10 min from now, well beyond buffer
+      });
+      setupUseSession(session);
+
+      await act(async () => {
+        renderHook(() => useImmutableSession());
+      });
+
+      // Should NOT have called update -- token is still valid
+      expect(mockUpdate).not.toHaveBeenCalled();
+    });
+  });
+
+  describe('getUser() respects pending refresh', () => {
+    it('waits for in-flight refresh before returning user', async () => {
+      const expiredSession = createSession({
+        accessTokenExpires: Date.now() - 1000,
+      });
+      setupUseSession(expiredSession);
+
+      const freshSession = createSession({
+        accessToken: 'user-fresh-token',
+        accessTokenExpires: Date.now() + 10 * 60 * 1000,
+      });
+
+      mockUpdate.mockResolvedValue(freshSession);
+
+      const { result } = renderHook(() => useImmutableSession());
+
+      let user: any;
+      await act(async () => {
+        user = await result.current.getUser();
+      });
+
+      // getUser() should have waited for the refresh and gotten the fresh token
+      expect(user?.accessToken).toBe('user-fresh-token');
+    });
+  });
+});

package/src/hooks.tsx

@@ -1,6 +1,8 @@
 'use client';
 
-import { useCallback, useRef, useState } from 'react';
+import {
+  useCallback, useEffect, useRef, useState,
+} from 'react';
 import { useSession, signIn, signOut } from 'next-auth/react';
 import type { Session } from 'next-auth';
 import type {
@@ -16,12 +18,35 @@ import {
   loginWithRedirect as rawLoginWithRedirect,
   logoutWithRedirect as rawLogoutWithRedirect,
 } from '@imtbl/auth';
-import { IMMUTABLE_PROVIDER_ID } from './constants';
+import { IMMUTABLE_PROVIDER_ID, TOKEN_EXPIRY_BUFFER_MS } from './constants';
+import { storeIdToken, getStoredIdToken, clearStoredIdToken } from './idTokenStorage';
+
+// ---------------------------------------------------------------------------
+// Module-level deduplication for session refresh
+// ---------------------------------------------------------------------------
+
+/**
+ * Deduplicates concurrent session refresh calls.
+ * Multiple components may mount useImmutableSession simultaneously; without
+ * deduplication each would trigger its own update() call, which could fail
+ * if the auth server rotates refresh tokens.
+ */
+let pendingRefresh: Promise<Session | null | undefined> | null = null;
+
+function deduplicatedUpdate(
+  update: () => Promise<Session | null | undefined>,
+): Promise<Session | null | undefined> {
+  if (!pendingRefresh) {
+    pendingRefresh = update().finally(() => { pendingRefresh = null; });
+  }
+  return pendingRefresh;
+}
 
 /**
- * Extended session type with Immutable token data
+ * Internal session type with full token data (not exported).
+ * Used internally by the hook for token validation, refresh logic, and getUser/getAccessToken.
  */
-export interface ImmutableSession extends Session {
+interface ImmutableSessionInternal extends Session {
   accessToken: string;
   refreshToken?: string;
   idToken?: string;
@@ -30,6 +55,15 @@ export interface ImmutableSession extends Session {
   error?: string;
 }
 
+/**
+ * Public session type exposed to consumers.
+ *
+ * Does **not** include `accessToken` -- consumers must use the `getAccessToken()`
+ * function returned by `useImmutableSession()` to obtain a guaranteed-fresh token.
+ * This prevents accidental use of stale/expired tokens.
+ */
+export type ImmutableSession = Omit<ImmutableSessionInternal, 'accessToken'>;
+
 /**
  * Return type for useImmutableSession hook
  */
@@ -53,6 +87,13 @@ export interface UseImmutableSessionReturn {
    *   The refreshed session will include updated zkEvm data if available.
    */
   getUser: (forceRefresh?: boolean) => Promise<User | null>;
+  /**
+   * Get a guaranteed-fresh access token.
+   * Returns immediately if the current token is valid.
+   * If expired, triggers a refresh and blocks (awaits) until the fresh token is available.
+   * Throws if the user is not authenticated or if refresh fails.
+   */
+  getAccessToken: () => Promise<string>;
 }
 
 /**
@@ -92,8 +133,8 @@ export function useImmutableSession(): UseImmutableSessionReturn {
   // Track when a manual refresh is in progress (via getUser(true))
   const [isRefreshing, setIsRefreshing] = useState(false);
 
-  // Cast session to our extended type
-  const session = sessionData as ImmutableSession | null;
+  // Cast session to our internal type (includes accessToken for internal logic)
+  const session = sessionData as ImmutableSessionInternal | null;
 
   const isLoading = status === 'loading';
 
@@ -114,7 +155,7 @@ export function useImmutableSession(): UseImmutableSessionReturn {
   // Use a ref to always have access to the latest session.
   // This avoids stale closure issues when the wallet stores the getUser function
   // and calls it later - the ref always points to the current session.
-  const sessionRef = useRef<ImmutableSession | null>(session);
+  const sessionRef = useRef<ImmutableSessionInternal | null>(session);
   sessionRef.current = session;
 
   // Also store update in a ref so the callback is stable
@@ -125,6 +166,44 @@ export function useImmutableSession(): UseImmutableSessionReturn {
   const setIsRefreshingRef = useRef(setIsRefreshing);
   setIsRefreshingRef.current = setIsRefreshing;
 
+  // ---------------------------------------------------------------------------
+  // Proactive token refresh
+  // ---------------------------------------------------------------------------
+
+  // Reactive refresh: when the effect runs and the token is already expired
+  // (e.g., after tab regains focus), trigger an immediate silent refresh.
+  // For tokens that are still valid, getAccessToken() handles refresh on demand.
+  //
+  // NOTE: This intentionally does NOT set isRefreshing. isRefreshing is reserved
+  // for explicit user-triggered refreshes (e.g., getUser(true) after wallet
+  // registration). Background token refreshes must be invisible to consumers --
+  // setting isRefreshing would cause downstream hooks that gate SWR keys on
+  // `!isRefreshing` to briefly lose their cached data, resulting in UI flicker.
+  useEffect(() => {
+    if (!session?.accessTokenExpires) return;
+
+    const timeUntilExpiry = session.accessTokenExpires - Date.now() - TOKEN_EXPIRY_BUFFER_MS;
+
+    if (timeUntilExpiry <= 0) {
+      // Already expired -- refresh silently
+      deduplicatedUpdate(() => updateRef.current());
+    }
+  }, [session?.accessTokenExpires]);
+
+  // ---------------------------------------------------------------------------
+  // Sync idToken to localStorage
+  // ---------------------------------------------------------------------------
+
+  // The idToken is stripped from the cookie by jwt.encode on the server to avoid
+  // CloudFront 413 errors. It is only present in the session response transiently
+  // after sign-in or token refresh. When present, persist it in localStorage so
+  // that getUser() can always return it (used by wallet's MagicTEESigner).
+  useEffect(() => {
+    if (session?.idToken) {
+      storeIdToken(session.idToken);
+    }
+  }, [session?.idToken]);
+
   /**
    * Get user function for wallet integration.
    * Returns a User object compatible with @imtbl/wallet's getUser option.
@@ -135,7 +214,7 @@ export function useImmutableSession(): UseImmutableSessionReturn {
    * @param forceRefresh - When true, triggers a server-side token refresh
    */
   const getUser = useCallback(async (forceRefresh?: boolean): Promise<User | null> => {
-    let currentSession: ImmutableSession | null;
+    let currentSession: ImmutableSessionInternal | null;
 
     // If forceRefresh is requested, trigger server-side refresh via NextAuth
     // This calls the jwt callback with trigger='update' and sessionUpdate.forceRefresh=true
@@ -145,10 +224,14 @@ export function useImmutableSession(): UseImmutableSessionReturn {
       try {
         // update() returns the refreshed session
         const updatedSession = await updateRef.current({ forceRefresh: true });
-        currentSession = updatedSession as ImmutableSession | null;
+        currentSession = updatedSession as ImmutableSessionInternal | null;
         // Also update the ref so subsequent calls get the fresh data
         if (currentSession) {
           sessionRef.current = currentSession;
+          // Immediately persist fresh idToken to localStorage (avoids race with useEffect)
+          if (currentSession.idToken) {
+            storeIdToken(currentSession.idToken);
+          }
         }
       } catch (error) {
         // eslint-disable-next-line no-console
@@ -158,6 +241,20 @@ export function useImmutableSession(): UseImmutableSessionReturn {
       } finally {
         setIsRefreshingRef.current(false);
       }
+    } else if (pendingRefresh) {
+      // If a refresh is in-flight (proactive timer or another getAccessToken call),
+      // wait for it and use the refreshed session rather than returning a stale token.
+      const refreshed = await pendingRefresh;
+      if (refreshed) {
+        currentSession = refreshed as ImmutableSessionInternal;
+        sessionRef.current = currentSession;
+        // Persist fresh idToken to localStorage immediately
+        if (currentSession.idToken) {
+          storeIdToken(currentSession.idToken);
+        }
+      } else {
+        currentSession = sessionRef.current;
+      }
     } else {
       // Read from ref - instant, no network call
       // The ref is always updated on each render with the latest session
@@ -178,7 +275,9 @@ export function useImmutableSession(): UseImmutableSessionReturn {
     return {
       accessToken: currentSession.accessToken,
       refreshToken: currentSession.refreshToken,
-      idToken: currentSession.idToken,
+      // Prefer session idToken (fresh after sign-in or refresh, before useEffect
+      // stores it), fall back to localStorage for normal reads (cookie has no idToken).
+      idToken: currentSession.idToken || getStoredIdToken(),
       profile: {
         sub: currentSession.user?.sub ?? '',
         email: currentSession.user?.email ?? undefined,
@@ -188,13 +287,55 @@ export function useImmutableSession(): UseImmutableSessionReturn {
     };
   }, []); // Empty deps - uses refs for latest values
 
+  /**
+   * Get a guaranteed-fresh access token.
+   * Returns immediately if the current token is valid (fast path, no network call).
+   * If expired, triggers a server-side refresh and blocks (awaits) until the fresh
+   * token is available. Piggybacks on any in-flight refresh to avoid duplicate calls.
+   *
+   * @throws Error if the user is not authenticated or if the refresh fails.
+   */
+  const getAccessToken = useCallback(async (): Promise<string> => {
+    const currentSession = sessionRef.current;
+
+    // Fast path: token is valid -- return immediately
+    if (
+      currentSession?.accessToken
+      && currentSession.accessTokenExpires
+      && Date.now() < currentSession.accessTokenExpires - TOKEN_EXPIRY_BUFFER_MS
+      && !currentSession.error
+    ) {
+      return currentSession.accessToken;
+    }
+
+    // Token is expired or missing -- wait for in-flight refresh or trigger one
+    const refreshed = await deduplicatedUpdate(
+      () => updateRef.current(),
+    ) as ImmutableSessionInternal | null;
+
+    if (!refreshed?.accessToken || refreshed.error) {
+      throw new Error(
+        `[auth-next-client] Failed to get access token: ${refreshed?.error || 'no session'}`,
+      );
+    }
+
+    // Update ref so subsequent sync reads get the fresh data
+    sessionRef.current = refreshed;
+    return refreshed.accessToken;
+  }, []); // Empty deps -- uses refs for latest values
+
+  // Cast to public type (omits accessToken) to prevent consumers from
+  // accidentally using a potentially stale token. Use getAccessToken() instead.
+  const publicSession = session as ImmutableSession | null;
+
   return {
-    session,
+    session: publicSession,
     status,
     isLoading,
     isAuthenticated,
     isRefreshing,
     getUser,
+    getAccessToken,
   };
 }
 
@@ -271,6 +412,12 @@ export function useLogin(): UseLoginReturn {
     profile: { sub: string; email?: string; nickname?: string };
     zkEvm?: ZkEvmInfo;
   }) => {
+    // Persist idToken to localStorage before signIn so it's available immediately.
+    // The cookie won't contain idToken (stripped by jwt.encode on the server).
+    if (tokens.idToken) {
+      storeIdToken(tokens.idToken);
+    }
+
     const result = await signIn(IMMUTABLE_PROVIDER_ID, {
       tokens: JSON.stringify(tokens),
       redirect: false,
@@ -434,6 +581,9 @@ export function useLogout(): UseLogoutReturn {
     setError(null);
 
     try {
+      // Clear idToken from localStorage before clearing session
+      clearStoredIdToken();
+
       // First, clear the NextAuth session (this clears the JWT cookie)
       // We use redirect: false to handle the redirect ourselves for federated logout
       await signOut({ redirect: false });