h3-clerk

Unofficial Clerk middleware for H3.

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 { H3, setResponseStatus } from 'h3';
import { clerkClient, clerkMiddleware, getAuth } from 'h3-clerk';

const app = new H3();

app.use(clerkMiddleware());

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

  if (!userId) {
    setResponseStatus(event, 401, 'Unauthorized');
    return;
  }

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

  return { user };
});

Available methods

clerkMiddleware()

The clerkMiddleware() middleware integrates Clerk authentication into your H3 application. It is required to be set in the middleware chain before using other Clerk utilities, such as getAuth().

import { H3 } from 'h3';
import { clerkMiddleware } from 'h3-clerk';

const app = new H3();

app.use(clerkMiddleware());

Options

The clerkMiddleware() helper accepts the same options as Clerk's middleware: these options.

getAuth()

The getAuth() function retrieves authentication state from the event object.

import { H3, setResponseStatus } from 'h3';
import { clerkMiddleware, getAuth } from 'h3-clerk';

const app = new H3();

app.use(clerkMiddleware());

app.use('/protected-endpoint', async (event) => {
  const { userId, has } = getAuth(event);

  if (!userId || !has({ role: 'org:admin' })) {
    setResponseStatus(event, 401, 'Unauthorized');
    return;
  }

  return { message: 'Hello, admin' };
});

Using acceptsToken for machine auth

You can pass acceptsToken to getAuth() when you want to verify other token types (for example api_key and m2m_token).

import { H3, setResponseStatus } from 'h3';
import { clerkMiddleware, getAuth } from 'h3-clerk';

const app = new H3();

app.use(clerkMiddleware());

app.use('/machine-endpoint', async (event) => {
  const auth = getAuth(event, { acceptsToken: 'api_key' });

  if (auth.tokenType !== 'api_key') {
    setResponseStatus(event, 401, 'Unauthorized');
    return;
  }

  return {
    apiKeyId: auth.id,
    userId: auth.userId,
  };
});

You can also pass multiple token types:

const auth = getAuth(event, {
  acceptsToken: ['session_token', 'api_key', 'm2m_token'],
});

clerkClient

Clerk's JavaScript Backend SDK exposes Clerk's Backend API resources and low-level authentication utilities for JavaScript environments. For example, if you wanted to get a list of all users in your application, instead of creating a fetch to Clerk's https://api.clerk.com/v1/users endpoint, you can use the users.getUserList() method provided by the JavaScript Backend SDK.

All resource operations are mounted as sub-APIs on the clerkClient object. See the reference documentation for more information.

import { clerkClient } from 'h3-clerk';

app.use('/users', async (event) => {
  const users = await clerkClient.users.getUserList();

  return { users };
});

License

MIT