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-clerk

Usage

import { createApp, createError, eventHandler } from 'h3'
import { clerkClient, getAuth, withClerkMiddleware } from 'h3-clerk'

const app = createApp()

// For all routes
app.use(withClerkMiddleware())
app.use('/protected-endpoint', async (event) => {
  const { userId } = getAuth(event)

  if (!userId)
    throw createError({ statusCode: 403 })

  const user = await clerkClient.users.getUser(userId)

  return { user }
})

// For a single route
app.use(
  '/protected-endpoint',
  eventHandler({
    onRequest: [withClerkMiddleware()],
    handler: async (event) => {
      const { userId } = getAuth(event)

      if (!userId)
        throw createError({ statusCode: 403 })

      const user = await clerkClient.users.getUser(userId)

      return { user }
    }
  })
)

TypeScript Shim

import type { SignedInAuthObject, SignedOutAuthObject } from '@clerk/backend/internal'

declare module 'h3' {
  interface H3EventContext {
    auth: SignedInAuthObject | SignedOutAuthObject
  }
}

License

MIT