@yohangel / auth-express

1.0.0 ▾

1.0.0

MIT

GitHub

Better Auth for Express 5: mount the auth routes and protect APIs with requireAuth

Code3 filesContext~405 tokensscan passed

~405 tokens→ src/lib/auth-express/AGENTS.md→ .cursor/rules/genpm-yohangel-auth-express.mdc

This is exactly what your AI reads when it works in src/lib/auth-express. Nothing else is added to its context.

@yohangel/auth-express — rules for AI agents

Purpose

Connects @yohangel/auth to Express 5: mounts Better Auth on /api/auth/* and provides requireAuth / optionalAuth middleware that put the session in res.locals.

Module map

index.ts — mountAuth(app, opts), requireAuth, optionalAuth, AuthLocals type, createAuth re-export.

Integration (do this after installing)

Order matters — mount auth BEFORE body parsers:

import express from 'express';
import { mountAuth, requireAuth } from './lib/auth-express/index.js';
const app = express();
mountAuth(app, { sendEmail });          // /api/auth/*
app.use(express.json());
app.get('/api/me', requireAuth, (req, res) => res.json({ id: res.locals.user.id }));

Frontend on another origin: app.use(cors({ origin: ['https://app.example.com'], credentials: true })) before mountAuth, and list that origin in AUTH_TRUSTED_ORIGINS.
Behind a proxy/CDN set app.set('trust proxy', 1) and AUTH_IP_HEADER so rate limits use the real client IP.
Express 4 is not supported (route syntax *splat is Express 5). Project must be ESM ("type": "module").

Conventions

Protect routes with requireAuth; read res.locals.user / res.locals.session (typed by AuthLocals).
Authorization (who can do what) goes in your handlers after requireAuth, never on the client.

Don't

Don't put express.json() before mountAuth (Better Auth must read the raw body).
Don't use cors({ origin: '*', credentials: true }).
Don't return res.locals.session (contains the token) to the client.

# @yohangel/auth-express — rules for AI agents

## Purpose
Connects `@yohangel/auth` to Express 5: mounts Better Auth on `/api/auth/*` and provides `requireAuth` / `optionalAuth` middleware that put the session in `res.locals`.

## Module map
- `index.ts` — `mountAuth(app, opts)`, `requireAuth`, `optionalAuth`, `AuthLocals` type, `createAuth` re-export.

## Integration (do this after installing)
1. Order matters — mount auth BEFORE body parsers:
   ```ts
   import express from 'express';
   import { mountAuth, requireAuth } from './lib/auth-express/index.js';
   const app = express();
   mountAuth(app, { sendEmail });          // /api/auth/*
   app.use(express.json());
   app.get('/api/me', requireAuth, (req, res) => res.json({ id: res.locals.user.id }));
   ```
2. Frontend on another origin: `app.use(cors({ origin: ['https://app.example.com'], credentials: true }))` before `mountAuth`, and list that origin in `AUTH_TRUSTED_ORIGINS`.
3. Behind a proxy/CDN set `app.set('trust proxy', 1)` and `AUTH_IP_HEADER` so rate limits use the real client IP.
4. Express 4 is not supported (route syntax `*splat` is Express 5). Project must be ESM (`"type": "module"`).

## Conventions
- Protect routes with `requireAuth`; read `res.locals.user` / `res.locals.session` (typed by `AuthLocals`).
- Authorization (who can do what) goes in your handlers after `requireAuth`, never on the client.

## Don't
- Don't put `express.json()` before `mountAuth` (Better Auth must read the raw body).
- Don't use `cors({ origin: '*', credentials: true })`.
- Don't return `res.locals.session` (contains the token) to the client.

The exact tree that will be injected, after .genpmignore. Pinned to

src/lib/auth-express/LICENSEread-only · 7145b9d

MIT License

Copyright (c) 2026 Yohangel

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.