0.2.6 • Published 5 months ago
h3-clerk-test v0.2.6
h3-clerk
Unofficial Clerk middleware for H3.
Check here for a demo with Nuxt.
Getting Started
To use this middleware you should first create a Clerk application and retrieve a Secret Key and a Publishable Key for your application (see here) to be used as environment variables CLERK_PUBLISHABLE_KEY & CLERK_SECRET_KEY.
Installation
npm install h3-clerkUsage
import { createApp, createError, eventHandler } from 'h3'
import { clerkClient, withClerkAuth, withClerkMiddleware } from 'h3-clerk'
const app = createApp()
// For all routes
app.use(withClerkMiddleware())
app.use('/protected-endpoint', async (event) => {
const { userId } = event.context.auth
if (!userId)
throw createError({ statusCode: 403 })
const user = await clerkClient.users.getUser(userId)
return { user }
})
// For a specific route
app.use(
'/protected-endpoint',
withClerkAuth(async (event) => {
const { userId } = event.context.auth
if (!userId)
throw createError({ statusCode: 403 })
const user = await clerkClient.users.getUser(userId)
return { user }
})
)Options
| Name | Type | Description |
|---|---|---|
authorizedParties | string[] | Validate that the azp claim in the Clerk Session JWT equals any of your known origins that are permitted to generate those tokens. This is an extra security check that we highly recommend that you do. For more information, refer to Manual JWT Verification. E.g. ['http://localhost:4003', 'https://clerk.dev'] |
jwtKey | string | Clerk's JWT session token can be verified in a networkless manner using the JWT verification key. By default, Clerk will use our well-known JWKs endpoint to fetch and cache the key for any subsequent token verification. If you use the CLERK_JWT_KEY environment variable or the jwtKey option to supply the key, Clerk will pick it up and do networkless verification for session tokens using it. For more information, refer to Networkless Token Verification. |
onError | (error: ClerkAPIResponseError) => unknown | This function can act as a custom error handler tailored to the needs of your application. |
adjustProtoHeaderInDev | boolean | Adjusts the x-forwarded-proto header in development mode to match the protocol of the request. Temporary hacky fix to GitHub Issue #23348. |
TypeScript Shim
declare module 'h3' {
interface H3EventContext {
auth: import('@clerk/backend').SignedInAuthObject | import('@clerk/backend').SignedOutAuthObject
}
}License
MIT