starred/linsa-linsa-io
1
0
Fork 0
mirror of https://github.com/linsa-io/linsa.git synced 2026-04-20 07:21:34 +02:00
Code Issues 2 Packages Projects Releases Wiki Activity

chore: refactor clerk middleware and add readme for route protection (#147)

Browse Source
This commit is contained in:
Aslam
2024-09-08 03:55:57 +07:00
committed by GitHub
parent 83af8cc819
commit e78d4fce7a
2 changed files with 64 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
web/middleware.ts
View File

@@ -1,23 +1,32 @@
import { clerkMiddleware, createRouteMatcher } from '@clerk/nextjs/server' import { clerkMiddleware, createRouteMatcher } from "@clerk/nextjs/server"
const isPublicRoute = createRouteMatcher([ const ROUTE_PATTERNS = {
'/sign-in(.*)', public: ["/sign-in(.*)", "/sign-up(.*)", "/", "/:topicName(.*)"],
'/sign-up(.*)', protected: [
'/', "/edit-profile(.*)",
'/:topicName(.*)' "/links(.*)",
]) "/pages(.*)",
"/profile(.*)",
"/search(.*)",
"/settings(.*)",
"/tauri(.*)"
]
}
const isPublicRoute = createRouteMatcher(ROUTE_PATTERNS.public)
const isProtectedRoute = createRouteMatcher(ROUTE_PATTERNS.protected)
export default clerkMiddleware((auth, request) => { export default clerkMiddleware((auth, request) => {
if (!isPublicRoute(request)) { if (isProtectedRoute(request) || !isPublicRoute(request)) {
auth().protect() auth().protect()
} }
}) })
export const config = { export const config = {
matcher: [ matcher: [
// Skip Next.js internals and all static files, unless found in search params // Skip Next.js internals and all static files, unless found in search params
'/((?!_next|[^?]*\\.(?:html?|css|js(?!on)|jpe?g|webp|png|gif|svg|ttf|woff2?|ico|csv|docx?|xlsx?|zip|webmanifest)).*)', "/((?!_next|[^?]*\\.(?:html?|css|js(?!on)|jpe?g|webp|png|gif|svg|ttf|woff2?|ico|csv|docx?|xlsx?|zip|webmanifest)).*)",
// Always run for API routes // Always run for API routes
'/(api|trpc)(.*)' "/(api|trpc)(.*)"
] ]
} }

40
web/readme.md
View File

@@ -1,5 +1,43 @@
### LA Editor ## LA Editor
This folder should not contain any changes. It is a copy of the original LA Editor component from the [LA Editor](https://github.com/learn-anything/la-editor) repository. This folder should not contain any changes. It is a copy of the original LA Editor component from the [LA Editor](https://github.com/learn-anything/la-editor) repository.
> This component is a temporary solution until the original repository publish the component to npm. > This component is a temporary solution until the original repository publish the component to npm.
## Clerk Middleware for Route Protection
This middleware manages authentication and protects routes in our Next.js application using Clerk.
## Key Concepts
- **Public Routes**: Accessible to all users
- **Protected Routes**: Require authentication
## Important: Route Registration
The middleware uses a catch-all public route `"/:topicName(.*)"`. This means:
1. New routes are public by default
2. Protected routes MUST be explicitly registered
## How to Register Routes
Update the `ROUTE_PATTERNS` object in the middleware file:
```typescript
const ROUTE_PATTERNS = {
public: ["/sign-in(.*)", "/sign-up(.*)", "/", "/:topicName(.*)"],
protected: [
"/edit-profile(.*)",
"/links(.*)",
// Add new protected routes here
"/new-protected-feature(.*)"
]
}
```
## Best Practices
1. Always add new protected routes to `ROUTE_PATTERNS.protected`
2. Regularly review routes to ensure proper protection
3. Be cautious when modifying the `"/:topicName(.*)"` catch-all route