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

package/README.md

@@ -10,7 +10,7 @@ This package provides minimal client-side utilities for Next.js applications usi
 
 - `useLogin` - Hook for login flows with state management (loading, error)
 - `useLogout` - Hook for logout with federated logout support (clears both local and upstream sessions)
-- `useImmutableSession` - Hook that provides session state and a `getUser` function for wallet integration
+- `useImmutableSession` - Hook that provides session state, `getAccessToken()` for guaranteed-fresh tokens, and `getUser` for wallet integration
 - `CallbackPage` - OAuth callback handler component
 
 For server-side utilities, use [`@imtbl/auth-next-server`](../auth-next-server).
@@ -27,6 +27,10 @@ npm install @imtbl/auth-next-client @imtbl/auth-next-server next-auth@5
 - `next` >= 14.0.0
 - `next-auth` >= 5.0.0-beta.25
 
+### Next.js 14 Compatibility
+
+This package is compatible with both Next.js 14 and 15. It uses only standard APIs available in both versions (`next/navigation` for `useRouter`, `next-auth/react`). No Next.js 15-only APIs are used.
+
 ## Quick Start
 
 ### 1. Set Up Server-Side Auth
@@ -100,6 +104,42 @@ export default function Callback() {
 }
 ```
 
+### Default Auth (Zero Config)
+
+When using `createAuthConfig()` with no args on the server, you can call login/logout with no config—sandbox clientId and redirectUri are used:
+
+```tsx
+// With default auth - no config needed
+function LoginButton() {
+  const { isAuthenticated } = useImmutableSession();
+  const { loginWithPopup, isLoggingIn, error } = useLogin();
+
+  if (isAuthenticated) return <p>You are logged in!</p>;
+
+  return (
+    <button onClick={() => loginWithPopup()} disabled={isLoggingIn}>
+      {isLoggingIn ? "Signing in..." : "Sign In"}
+    </button>
+  );
+}
+```
+
+Or with custom config (pass full LoginConfig/LogoutConfig when overriding):
+
+```tsx
+// With custom config - pass complete config
+loginWithPopup({
+  clientId: process.env.NEXT_PUBLIC_IMMUTABLE_CLIENT_ID!,
+  redirectUri: `${window.location.origin}/callback`,
+});
+logout({
+  clientId: process.env.NEXT_PUBLIC_IMMUTABLE_CLIENT_ID!,
+  logoutRedirectUri: process.env.NEXT_PUBLIC_BASE_URL!,
+});
+```
+
+See the [wallets-connect-with-nextjs](../../examples/passport/wallets-connect-with-nextjs) example for a full integration with `@imtbl/wallet`.
+
 ### 5. Add Login Button
 
 Use the `useLogin` hook for login flows with built-in state management:
@@ -395,7 +435,11 @@ With federated logout, the auth server's session is also cleared, so users can s
 
 ### `useImmutableSession()`
 
-A convenience hook that wraps `next-auth/react`'s `useSession` with a `getUser` function for wallet integration.
+A convenience hook that wraps `next-auth/react`'s `useSession` with:
+
+- `getAccessToken()` -- async function that returns a **guaranteed-fresh** access token
+- `getUser()` -- function for wallet integration
+- Automatic token refresh -- detects expired tokens and refreshes on demand
 
 ```tsx
 "use client";
@@ -404,10 +448,12 @@ import { useImmutableSession } from "@imtbl/auth-next-client";
 
 function MyComponent() {
   const {
-    session, // Session with tokens
+    session, // Session metadata (user info, zkEvm, error) -- does NOT include accessToken
     status, // 'loading' | 'authenticated' | 'unauthenticated'
     isLoading, // True during initial load
     isAuthenticated, // True when logged in
+    isRefreshing, // True during token refresh
+    getAccessToken, // Async function: returns a guaranteed-fresh access token
     getUser, // Function for wallet integration
   } = useImmutableSession();
 
@@ -420,13 +466,131 @@ function MyComponent() {
 
 #### Return Value
 
-| Property          | Type                                                | Description                                                      |
-| ----------------- | --------------------------------------------------- | ---------------------------------------------------------------- |
-| `session`         | `ImmutableSession \| null`                          | Session with access/refresh tokens                               |
-| `status`          | `string`                                            | Auth status: `'loading'`, `'authenticated'`, `'unauthenticated'` |
-| `isLoading`       | `boolean`                                           | Whether initial auth state is loading                            |
-| `isAuthenticated` | `boolean`                                           | Whether user is authenticated                                    |
-| `getUser`         | `(forceRefresh?: boolean) => Promise<User \| null>` | Get user function for wallet integration                         |
+| Property          | Type                                                | Description                                                                             |
+| ----------------- | --------------------------------------------------- | --------------------------------------------------------------------------------------- |
+| `session`         | `ImmutableSession \| null`                          | Session metadata (user, zkEvm, error). Does **not** include `accessToken` -- see below. |
+| `status`          | `string`                                            | Auth status: `'loading'`, `'authenticated'`, `'unauthenticated'`                        |
+| `isLoading`       | `boolean`                                           | Whether initial auth state is loading                                                   |
+| `isAuthenticated` | `boolean`                                           | Whether user is authenticated                                                           |
+| `isRefreshing`    | `boolean`                                           | Whether a token refresh is in progress                                                  |
+| `getAccessToken`  | `() => Promise<string>`                             | Get a guaranteed-fresh access token. Throws if not authenticated or refresh fails.      |
+| `getUser`         | `(forceRefresh?: boolean) => Promise<User \| null>` | Get user function for wallet integration                                                |
+
+#### Why no `accessToken` on `session`?
+
+The `session` object intentionally does **not** expose `accessToken`. This is a deliberate design choice to prevent consumers from accidentally using a stale/expired token.
+
+**Always use `getAccessToken()`** to obtain a token for authenticated requests:
+
+```tsx
+// ✅ Correct - always fresh
+const token = await getAccessToken();
+await authenticatedGet("/api/data", token);
+
+// ❌ Incorrect - session.accessToken does not exist on the type
+const token = session?.accessToken; // TypeScript error
+```
+
+`getAccessToken()` guarantees freshness:
+
+- **Fast path**: If the current token is valid, returns immediately (no network call).
+- **Slow path**: If the token is expired, triggers a server-side refresh and **blocks** (awaits) until the fresh token is available.
+- **Deduplication**: Multiple concurrent calls share a single refresh request.
+
+#### Checking Authentication Status
+
+**Always use `isAuthenticated` to determine if a user is logged in.** Do not use the `session` object or `status` field directly for this purpose.
+
+**Why not `!!session`?**
+
+A `session` object can exist but be **unusable**. For example, the session may be present but the access token is missing, or a token refresh may have failed (indicated by `session.error === "RefreshTokenError"`). Checking `!!session` would incorrectly treat these broken sessions as authenticated.
+
+**Why not `status === 'authenticated'`?**
+
+The `status` field comes directly from NextAuth's `useSession` and only reflects whether NextAuth considers the session valid at the cookie/JWT level. It does **not** account for whether the access token is actually present or whether a token refresh has failed. A session can have `status === 'authenticated'` while `session.error` is set to `"RefreshTokenError"`, meaning the tokens are no longer usable.
+
+**What `isAuthenticated` checks:**
+
+The `isAuthenticated` boolean validates all of the following:
+
+1. NextAuth reports `'authenticated'` status
+2. The session object exists
+3. A valid access token is present in the session
+4. No session-level error exists (e.g., `RefreshTokenError`)
+
+It also handles transient states gracefully — during session refetches (e.g., window focus) or manual refreshes (e.g., after wallet registration via `getUser(true)`), `isAuthenticated` remains `true` if the user was previously authenticated, preventing UI flicker.
+
+```tsx
+// ✅ Correct - uses isAuthenticated
+const { isAuthenticated } = useImmutableSession();
+if (!isAuthenticated) return <div>Please log in</div>;
+
+// ❌ Incorrect - session can exist with expired/invalid tokens
+const { session } = useImmutableSession();
+if (!session) return <div>Please log in</div>;
+
+// ❌ Incorrect - status doesn't account for token errors
+const { status } = useImmutableSession();
+if (status !== "authenticated") return <div>Please log in</div>;
+```
+
+#### Using `getAccessToken()` in Practice
+
+**SWR fetcher:**
+
+```tsx
+import useSWR from "swr";
+import { useImmutableSession } from "@imtbl/auth-next-client";
+
+function useProfile() {
+  const { getAccessToken, isAuthenticated } = useImmutableSession();
+
+  return useSWR(
+    isAuthenticated ? "/passport-profile/v1/profile" : null,
+    async (path) => {
+      const token = await getAccessToken(); // blocks until fresh
+      return authenticatedGet(path, token);
+    },
+  );
+}
+```
+
+**Event handler:**
+
+```tsx
+import { useImmutableSession } from "@imtbl/auth-next-client";
+
+function ClaimRewardButton({ questId }: { questId: string }) {
+  const { getAccessToken } = useImmutableSession();
+
+  const handleClaim = async () => {
+    const token = await getAccessToken(); // blocks until fresh
+    await authenticatedPost("/v1/quests/claim", token, { questId });
+  };
+
+  return <button onClick={handleClaim}>Claim</button>;
+}
+```
+
+**Periodic polling:**
+
+```tsx
+import useSWR from "swr";
+import { useImmutableSession } from "@imtbl/auth-next-client";
+
+function ActivityFeed() {
+  const { getAccessToken, isAuthenticated } = useImmutableSession();
+
+  return useSWR(
+    isAuthenticated ? "/v1/activities" : null,
+    async (path) => {
+      const token = await getAccessToken();
+      return authenticatedGet(path, token);
+    },
+    { refreshInterval: 10000 }, // polls every 10s, always gets a fresh token
+  );
+}
+```
 
 #### The `getUser` Function
 
@@ -452,13 +616,13 @@ When `forceRefresh` is `true`:
 
 ### ImmutableSession
 
-The session type returned by `useImmutableSession`:
+The session type returned by `useImmutableSession`. Note that `accessToken` is intentionally **not** included -- use `getAccessToken()` instead to obtain a guaranteed-fresh token.
 
 ```typescript
 interface ImmutableSession {
-  accessToken: string;
+  // accessToken is NOT exposed -- use getAccessToken() instead
   refreshToken?: string;
-  idToken?: string;
+  idToken?: string; // Only present transiently after sign-in or token refresh (not stored in cookie)
   accessTokenExpires: number;
   zkEvm?: {
     ethAddress: string;
@@ -473,6 +637,8 @@ interface ImmutableSession {
 }
 ```
 
+> **Note:** The `idToken` is **not** stored in the session cookie (to avoid CloudFront 413 errors from oversized headers). It is only present in the session response transiently after sign-in or token refresh. `@imtbl/auth-next-client` automatically persists it in `localStorage` so that `getUser()` always returns a valid `idToken` for wallet operations. All data extracted from the idToken (`email`, `nickname`, `zkEvm`) remains in the cookie as separate fields and is always available in the session.
+
 ### LoginConfig
 
 Configuration for the `useLogin` hook's login functions:
@@ -531,17 +697,19 @@ interface LogoutConfig {
 
 The session may contain an `error` field indicating authentication issues:
 
-| Error                 | Description           | Handling                                      |
-| --------------------- | --------------------- | --------------------------------------------- |
-| `"TokenExpired"`      | Access token expired  | Server-side refresh will happen automatically |
-| `"RefreshTokenError"` | Refresh token invalid | Prompt user to sign in again                  |
+| Error                 | Description           | Handling                                     |
+| --------------------- | --------------------- | -------------------------------------------- |
+| `"TokenExpired"`      | Access token expired  | Proactive refresh handles this automatically |
+| `"RefreshTokenError"` | Refresh token invalid | Prompt user to sign in again                 |
+
+`getAccessToken()` throws an error if the token cannot be obtained (e.g., refresh failure). Handle it with try/catch:
 
 ```tsx
 import { useImmutableSession } from "@imtbl/auth-next-client";
-import { signIn, signOut } from "next-auth/react";
+import { signOut } from "next-auth/react";
 
 function ProtectedContent() {
-  const { session, isAuthenticated } = useImmutableSession();
+  const { session, isAuthenticated, getAccessToken } = useImmutableSession();
 
   if (session?.error === "RefreshTokenError") {
     return (
@@ -556,11 +724,20 @@ function ProtectedContent() {
     return (
       <div>
         <p>Please sign in to continue.</p>
-        <button onClick={() => signIn()}>Sign In</button>
       </div>
     );
   }
 
+  const handleFetch = async () => {
+    try {
+      const token = await getAccessToken();
+      // Use token for authenticated requests
+    } catch (error) {
+      // Token refresh failed -- session may be expired
+      console.error("Failed to get access token:", error);
+    }
+  };
+
   return <div>Protected content here</div>;
 }
 ```

package/dist/node/index.cjs

@@ -22,7 +22,15 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   CallbackPage: () => CallbackPage,
+  DEFAULT_AUDIENCE: () => DEFAULT_AUDIENCE,
+  DEFAULT_AUTH_DOMAIN: () => DEFAULT_AUTH_DOMAIN,
+  DEFAULT_LOGOUT_REDIRECT_URI_PATH: () => DEFAULT_LOGOUT_REDIRECT_URI_PATH,
+  DEFAULT_REDIRECT_URI_PATH: () => DEFAULT_REDIRECT_URI_PATH,
+  DEFAULT_SANDBOX_CLIENT_ID: () => DEFAULT_SANDBOX_CLIENT_ID,
+  DEFAULT_SCOPE: () => DEFAULT_SCOPE,
+  IMMUTABLE_PROVIDER_ID: () => IMMUTABLE_PROVIDER_ID,
   MarketingConsentStatus: () => import_auth3.MarketingConsentStatus,
+  deriveDefaultRedirectUri: () => deriveDefaultRedirectUri,
   useImmutableSession: () => useImmutableSession,
   useLogin: () => useLogin,
   useLogout: () => useLogout
@@ -36,9 +44,42 @@ var import_react2 = require("next-auth/react");
 var import_auth = require("@imtbl/auth");
 
 // src/constants.ts
+var DEFAULT_AUTH_DOMAIN = "https://auth.immutable.com";
+var DEFAULT_AUDIENCE = "platform_api";
+var DEFAULT_SCOPE = "openid profile email offline_access transact";
 var IMMUTABLE_PROVIDER_ID = "immutable";
-var DEFAULT_TOKEN_EXPIRY_SECONDS = 900;
-var DEFAULT_TOKEN_EXPIRY_MS = DEFAULT_TOKEN_EXPIRY_SECONDS * 1e3;
+var DEFAULT_SANDBOX_CLIENT_ID = "mjtCL8mt06BtbxSkp2vbrYStKWnXVZfo";
+var DEFAULT_REDIRECT_URI_PATH = "/callback";
+var DEFAULT_LOGOUT_REDIRECT_URI_PATH = "/";
+var TOKEN_EXPIRY_BUFFER_MS = 6e4;
+
+// src/idTokenStorage.ts
+var ID_TOKEN_STORAGE_KEY = "imtbl_id_token";
+function storeIdToken(idToken) {
+  try {
+    if (typeof window !== "undefined" && window.localStorage) {
+      window.localStorage.setItem(ID_TOKEN_STORAGE_KEY, idToken);
+    }
+  } catch {
+  }
+}
+function getStoredIdToken() {
+  try {
+    if (typeof window !== "undefined" && window.localStorage) {
+      return window.localStorage.getItem(ID_TOKEN_STORAGE_KEY) ?? void 0;
+    }
+  } catch {
+  }
+  return void 0;
+}
+function clearStoredIdToken() {
+  try {
+    if (typeof window !== "undefined" && window.localStorage) {
+      window.localStorage.removeItem(ID_TOKEN_STORAGE_KEY);
+    }
+  } catch {
+  }
+}
 
 // src/callback.tsx
 var import_jsx_runtime = require("react/jsx-runtime");
@@ -89,6 +130,9 @@ function CallbackPage({
           window.close();
         } else {
           const tokenData = mapTokensToSignInData(tokens);
+          if (tokens.idToken) {
+            storeIdToken(tokens.idToken);
+          }
           const result = await (0, import_react2.signIn)(IMMUTABLE_PROVIDER_ID, {
             tokens: JSON.stringify(tokenData),
             redirect: false
@@ -181,6 +225,51 @@ function CallbackPage({
 var import_react3 = require("react");
 var import_react4 = require("next-auth/react");
 var import_auth2 = require("@imtbl/auth");
+
+// src/defaultConfig.ts
+function deriveDefaultRedirectUri() {
+  if (typeof window === "undefined") {
+    throw new Error(
+      "[auth-next-client] deriveDefaultRedirectUri requires window. Login hooks run in the browser when the user triggers login."
+    );
+  }
+  return `${window.location.origin}${DEFAULT_REDIRECT_URI_PATH}`;
+}
+
+// src/hooks.tsx
+var pendingRefresh = null;
+function deduplicatedUpdate(update) {
+  if (!pendingRefresh) {
+    pendingRefresh = update().finally(() => {
+      pendingRefresh = null;
+    });
+  }
+  return pendingRefresh;
+}
+function getSandboxLoginConfig() {
+  const redirectUri = deriveDefaultRedirectUri();
+  return {
+    clientId: DEFAULT_SANDBOX_CLIENT_ID,
+    redirectUri,
+    popupRedirectUri: redirectUri,
+    scope: DEFAULT_SCOPE,
+    audience: DEFAULT_AUDIENCE,
+    authenticationDomain: DEFAULT_AUTH_DOMAIN
+  };
+}
+function getSandboxLogoutConfig() {
+  if (typeof window === "undefined") {
+    throw new Error(
+      "[auth-next-client] getSandboxLogoutConfig requires window. Logout runs in the browser when the user triggers it."
+    );
+  }
+  const logoutRedirectUri = window.location.origin + DEFAULT_LOGOUT_REDIRECT_URI_PATH;
+  return {
+    clientId: DEFAULT_SANDBOX_CLIENT_ID,
+    logoutRedirectUri,
+    authenticationDomain: DEFAULT_AUTH_DOMAIN
+  };
+}
 function useImmutableSession() {
   const { data: sessionData, status, update } = (0, import_react4.useSession)();
   const [isRefreshing, setIsRefreshing] = (0, import_react3.useState)(false);
@@ -197,6 +286,18 @@ function useImmutableSession() {
   updateRef.current = update;
   const setIsRefreshingRef = (0, import_react3.useRef)(setIsRefreshing);
   setIsRefreshingRef.current = setIsRefreshing;
+  (0, import_react3.useEffect)(() => {
+    if (!session?.accessTokenExpires) return;
+    const timeUntilExpiry = session.accessTokenExpires - Date.now() - TOKEN_EXPIRY_BUFFER_MS;
+    if (timeUntilExpiry <= 0) {
+      deduplicatedUpdate(() => updateRef.current());
+    }
+  }, [session?.accessTokenExpires]);
+  (0, import_react3.useEffect)(() => {
+    if (session?.idToken) {
+      storeIdToken(session.idToken);
+    }
+  }, [session?.idToken]);
   const getUser = (0, import_react3.useCallback)(async (forceRefresh) => {
     let currentSession;
     if (forceRefresh) {
@@ -206,6 +307,9 @@ function useImmutableSession() {
         currentSession = updatedSession;
         if (currentSession) {
           sessionRef.current = currentSession;
+          if (currentSession.idToken) {
+            storeIdToken(currentSession.idToken);
+          }
         }
       } catch (error) {
         console.error("[auth-next-client] Force refresh failed:", error);
@@ -213,6 +317,17 @@ function useImmutableSession() {
       } finally {
         setIsRefreshingRef.current(false);
       }
+    } else if (pendingRefresh) {
+      const refreshed = await pendingRefresh;
+      if (refreshed) {
+        currentSession = refreshed;
+        sessionRef.current = currentSession;
+        if (currentSession.idToken) {
+          storeIdToken(currentSession.idToken);
+        }
+      } else {
+        currentSession = sessionRef.current;
+      }
     } else {
       currentSession = sessionRef.current;
     }
@@ -226,7 +341,9 @@ function useImmutableSession() {
     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 ?? void 0,
@@ -235,19 +352,40 @@ function useImmutableSession() {
       zkEvm: currentSession.zkEvm
     };
   }, []);
+  const getAccessToken = (0, import_react3.useCallback)(async () => {
+    const currentSession = sessionRef.current;
+    if (currentSession?.accessToken && currentSession.accessTokenExpires && Date.now() < currentSession.accessTokenExpires - TOKEN_EXPIRY_BUFFER_MS && !currentSession.error) {
+      return currentSession.accessToken;
+    }
+    const refreshed = await deduplicatedUpdate(
+      () => updateRef.current()
+    );
+    if (!refreshed?.accessToken || refreshed.error) {
+      throw new Error(
+        `[auth-next-client] Failed to get access token: ${refreshed?.error || "no session"}`
+      );
+    }
+    sessionRef.current = refreshed;
+    return refreshed.accessToken;
+  }, []);
+  const publicSession = session;
   return {
-    session,
+    session: publicSession,
     status,
     isLoading,
     isAuthenticated,
     isRefreshing,
-    getUser
+    getUser,
+    getAccessToken
   };
 }
 function useLogin() {
   const [isLoggingIn, setIsLoggingIn] = (0, import_react3.useState)(false);
   const [error, setError] = (0, import_react3.useState)(null);
   const signInWithTokens = (0, import_react3.useCallback)(async (tokens) => {
+    if (tokens.idToken) {
+      storeIdToken(tokens.idToken);
+    }
     const result = await (0, import_react4.signIn)(IMMUTABLE_PROVIDER_ID, {
       tokens: JSON.stringify(tokens),
       redirect: false
@@ -263,7 +401,8 @@ function useLogin() {
     setIsLoggingIn(true);
     setError(null);
     try {
-      const tokens = await (0, import_auth2.loginWithPopup)(config, options);
+      const fullConfig = config ?? getSandboxLoginConfig();
+      const tokens = await (0, import_auth2.loginWithPopup)(fullConfig, options);
       await signInWithTokens(tokens);
     } catch (err) {
       const errorMessage = err instanceof Error ? err.message : "Login failed";
@@ -277,7 +416,8 @@ function useLogin() {
     setIsLoggingIn(true);
     setError(null);
     try {
-      const tokens = await (0, import_auth2.loginWithEmbedded)(config);
+      const fullConfig = config ?? getSandboxLoginConfig();
+      const tokens = await (0, import_auth2.loginWithEmbedded)(fullConfig);
       await signInWithTokens(tokens);
     } catch (err) {
       const errorMessage = err instanceof Error ? err.message : "Login failed";
@@ -291,7 +431,8 @@ function useLogin() {
     setIsLoggingIn(true);
     setError(null);
     try {
-      await (0, import_auth2.loginWithRedirect)(config, options);
+      const fullConfig = config ?? getSandboxLoginConfig();
+      await (0, import_auth2.loginWithRedirect)(fullConfig, options);
     } catch (err) {
       const errorMessage = err instanceof Error ? err.message : "Login failed";
       setError(errorMessage);
@@ -314,8 +455,10 @@ function useLogout() {
     setIsLoggingOut(true);
     setError(null);
     try {
+      clearStoredIdToken();
       await (0, import_react4.signOut)({ redirect: false });
-      (0, import_auth2.logoutWithRedirect)(config);
+      const fullConfig = config ?? getSandboxLogoutConfig();
+      (0, import_auth2.logoutWithRedirect)(fullConfig);
     } catch (err) {
       const errorMessage = err instanceof Error ? err.message : "Logout failed";
       setError(errorMessage);
@@ -335,7 +478,15 @@ var import_auth3 = require("@imtbl/auth");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   CallbackPage,
+  DEFAULT_AUDIENCE,
+  DEFAULT_AUTH_DOMAIN,
+  DEFAULT_LOGOUT_REDIRECT_URI_PATH,
+  DEFAULT_REDIRECT_URI_PATH,
+  DEFAULT_SANDBOX_CLIENT_ID,
+  DEFAULT_SCOPE,
+  IMMUTABLE_PROVIDER_ID,
   MarketingConsentStatus,
+  deriveDefaultRedirectUri,
   useImmutableSession,
   useLogin,
   useLogout