; // Refresh tokens function
}
```
**Example:**
```ts
"use client";
import { useAuth } from "@duongtrungnguyen/next-helper";
export default function LoginForm() {
const { login, state } = useAuth();
const handleSubmit = async (e) => {
e.preventDefault();
await login({
email: "user@example.com",
password: "password"
});
};
return (
);
}
```
#### `useProtectedRoute()`
React hook that redirects to the login page if the user is not authenticated.
**Returns:**
```ts
{
isLoading: boolean; // True when authentication state is loading
isAuthenticated: boolean; // True when user is authenticated
}
```
**Example:**
```ts
"use client";
import { useProtectedRoute } from "@duongtrungnguyen/next-prepare";
export default function ProfilePage() {
const { isLoading } = useProtectedRoute();
if (isLoading) {
return Loading...
;
}
return Profile content (only visible to authenticated users)
;
}
```
#### `AuthProvider`
React context provider that must wrap your application.
**Props:**
```ts
{ children: ReactNode; // Child components }
```
### Server-Side API
#### `getCurrentUser()`
Server action that retrieves the current user based on the access token in cookies.
**Returns:**
```ts
Promise // User object or null if not authenticated
```
**Example:**
```ts
// app/profile/page.tsx
import { getCurrentUser } from "@duongtrungnguyen/next-prepare";
export default async function ProfilePage() {
const user = await getCurrentUser();
if (!user) {
return Please log in to view your profile
;
}
return (
Welcome, {user.name}
Email: {user.email}
);
}
```
#### `setAuthCookies(tokens: AuthTokens)`
Server action that sets authentication cookies for access and refresh tokens.
**Parameters:**
* `tokens`: Object containing `accessToken` and `refreshToken`
**Example:**
```ts
import { setAuthCookies } from "@duongtrungnguyen/next-prepare";
// Example usage in a custom login API route
export async function POST(request: Request) {
const { email, password } = await request.json();
// Authenticate user (implementation depends on your backend)
const tokens = await authenticateUser(email, password);
if (tokens) {
await setAuthCookies(tokens);
return Response.json({ success: true });
}
return Response.json({ success: false }, { status: 401 });
}
```
#### `clearAuthCookies()`
Server action that clears authentication cookies.
**Example:**
```ts
import { clearAuthCookies } from "@duongtrungnguyen/next-prepare";
// Example usage in a custom logout API route
export async function POST() {
await clearAuthCookies();
return Response.json({ success: true });
}
```
#### `refreshAccessToken()`
Server action that refreshes the access token using the refresh token in cookies.
**Returns:**
```ts
Promise // True if token was successfully refreshed
```
### Middleware
#### `authMiddleware(request: NextRequest)`
Middleware function that checks if the access token is about to expire and refreshes it if necessary.
**Parameters:**
* `request`: Next.js request object
**Returns:**
`Promise // Next.js response object`
**Example:**
```ts
// middleware.ts
import { NextRequest, NextResponse } from "next/server";
import { authMiddleware } from "@duongtrungnguyen/next-prepare";
export async function middleware(request: NextRequest) {
return await authMiddleware(request);
}
export const config = {
matcher: [
"/((?!_next/static|_next/image|favicon.ico|.*\\.(?:svg|png|jpg|jpeg|gif|webp)$).*)",
],
};
```
### HTTP Utilities
#### `HttpClient`
Universal fetch utility class that works in both client and server components.
**Methods:**
* `get(url: string, config?: RequestConfigs): Promise`
* `post(url: string, data?: any, config?: RequestConfigs): Promise`
* `put(url: string, data?: any, config?: RequestConfigs): Promise`
* `delete(url: string, config?: RequestConfigs): Promise`
**Example:**
```ts
import { httpClient } from "@duongtrungnguyen/next-prepare";
// In any component (client or server)
const fetchData = async () => {
try {
const data = await httpClient.get("/api/protected-resource");
return data;
} catch (error) {
console.error("Error fetching data:", error);
}
};
```