elysia-clerk

Elysia plugin to integrate with Clerk.

[!NOTE] This unofficial package isn't connected to Clerk.com. It's a project designed to smoothly incorporate Clerk features to your Elysia applications.

Install

1bun add elysia-clerk

Usage

Retrieve your Backend API key from the API Keys screen in your Clerk dashboard and set it as an environment variable in a .env file:

1CLERK_PUBLISHABLE_KEY=pk_*******
2CLERK_SECRET_KEY=sk_******

Configure clerkPlugin in your Elysia application

1import { Elysia } from 'elysia'
2import { clerkPlugin } from 'elysia-clerk'
3
4new Elysia()
5  .use(clerkPlugin())
6  .get('/private', async ({ clerk, auth, error }) => {
7    /**
8     * Access the auth state in the context.
9     * See the AuthObject here https://clerk.com/docs/references/nextjs/auth-object#auth-object
10     */
11    if (!auth?.userId) {
12      return error(401)
13    }
14
15    /**
16     * For other resource operations, you can use the clerk client from the context.
17     * See what other utilities Clerk exposes here https://clerk.com/docs/references/backend/overview
18     */
19    const user = await clerk.users.getUser(auth.userId)
20
21    return { user }
22  })
23  .listen(3000)

Instead of using Clerk globally, you can use Clerk for a subset of routes via Elysia plugins:

1import { Elysia } from 'elysia'
2import { clerkPlugin } from 'elysia-clerk'
3
4const privateRoutes = new Elysia({ prefix: '/api' })
5  .use(clerkPlugin())
6  .get('/user', async ({ clerk, auth, error }) => {
7
8    if (!auth?.userId) {
9      return error(401)
10    }
11
12    const user = await clerk.users.getUser(auth.userId)
13
14    return { user }
15  })
16
17new Elysia()
18  .use(privateRoutes)
19  .get('/', () => 'Hello world!')
20  .listen(3000)

To see the available options you can pass to the clerkPlugin function, see AuthenticateRequestOptions.

License

MIT