diff --git a/.agents/skills/better-auth-best-practices/SKILL.md b/.agents/skills/better-auth-best-practices/SKILL.md new file mode 100644 index 0000000..fabd32f --- /dev/null +++ b/.agents/skills/better-auth-best-practices/SKILL.md @@ -0,0 +1,183 @@ +--- +name: better-auth-best-practices +description: Configure Better Auth server and client, set up database adapters, manage sessions, add plugins, and handle environment variables. Use when users mention Better Auth, betterauth, auth.ts, or need to set up TypeScript authentication with email/password, OAuth, or plugin configuration. +--- + +# Better Auth Integration Guide + +**Always consult [better-auth.com/docs](https://better-auth.com/docs) for code examples and latest API.** + +--- + +## Setup Workflow + +1. Install: `npm install better-auth` +2. Set env vars: `BETTER_AUTH_SECRET` and `BETTER_AUTH_URL` +3. Create `auth.ts` with database + config +4. Create route handler for your framework +5. Run `npx @better-auth/cli@latest migrate` +6. Verify: call `GET /api/auth/ok` — should return `{ status: "ok" }` + +--- + +## Quick Reference + +### Environment Variables + +- `BETTER_AUTH_SECRET` - Encryption secret (min 32 chars). Generate: `openssl rand -base64 32` +- `BETTER_AUTH_URL` - Base URL (e.g., `https://example.com`) + +Only define `baseURL`/`secret` in config if env vars are NOT set. + +### File Location + +CLI looks for `auth.ts` in: `./`, `./lib`, `./utils`, or under `./src`. Use `--config` for custom path. + +### CLI Commands + +- `npx @better-auth/cli@latest migrate` - Apply schema (built-in adapter) +- `npx @better-auth/cli@latest generate` - Generate schema for Prisma/Drizzle +- `npx @better-auth/cli mcp --cursor` - Add MCP to AI tools + +**Re-run after adding/changing plugins.** + +--- + +## Core Config Options + +| Option | Notes | +| ------------------ | ---------------------------------------------- | +| `appName` | Optional display name | +| `baseURL` | Only if `BETTER_AUTH_URL` not set | +| `basePath` | Default `/api/auth`. Set `/` for root. | +| `secret` | Only if `BETTER_AUTH_SECRET` not set | +| `database` | Required for most features. See adapters docs. | +| `secondaryStorage` | Redis/KV for sessions & rate limits | +| `emailAndPassword` | `{ enabled: true }` to activate | +| `socialProviders` | `{ google: { clientId, clientSecret }, ... }` | +| `plugins` | Array of plugins | +| `trustedOrigins` | CSRF whitelist | + +--- + +## Database + +**Direct connections:** Pass `pg.Pool`, `mysql2` pool, `better-sqlite3`, or `bun:sqlite` instance. + +**ORM adapters:** Import from `better-auth/adapters/drizzle`, `better-auth/adapters/prisma`, `better-auth/adapters/mongodb`. + +**Critical:** Better Auth uses adapter model names, NOT underlying table names. If Prisma model is `User` mapping to table `users`, use `modelName: "user"` (Prisma reference), not `"users"`. + +--- + +## Session Management + +**Storage priority:** + +1. If `secondaryStorage` defined → sessions go there (not DB) +2. Set `session.storeSessionInDatabase: true` to also persist to DB +3. No database + `cookieCache` → fully stateless mode + +**Cookie cache strategies:** + +- `compact` (default) - Base64url + HMAC. Smallest. +- `jwt` - Standard JWT. Readable but signed. +- `jwe` - Encrypted. Maximum security. + +**Key options:** `session.expiresIn` (default 7 days), `session.updateAge` (refresh interval), `session.cookieCache.maxAge`, `session.cookieCache.version` (change to invalidate all sessions). + +--- + +## User & Account Config + +**User:** `user.modelName`, `user.fields` (column mapping), `user.additionalFields`, `user.changeEmail.enabled` (disabled by default), `user.deleteUser.enabled` (disabled by default). + +**Account:** `account.modelName`, `account.accountLinking.enabled`, `account.storeAccountCookie` (for stateless OAuth). + +**Required for registration:** `email` and `name` fields. + +--- + +## Email Flows + +- `emailVerification.sendVerificationEmail` - Must be defined for verification to work +- `emailVerification.sendOnSignUp` / `sendOnSignIn` - Auto-send triggers +- `emailAndPassword.sendResetPassword` - Password reset email handler + +--- + +## Security + +**In `advanced`:** + +- `useSecureCookies` - Force HTTPS cookies +- `disableCSRFCheck` - ⚠️ Security risk +- `disableOriginCheck` - ⚠️ Security risk +- `crossSubDomainCookies.enabled` - Share cookies across subdomains +- `ipAddress.ipAddressHeaders` - Custom IP headers for proxies +- `database.generateId` - Custom ID generation or `"serial"`/`"uuid"`/`false` + +**Rate limiting:** `rateLimit.enabled`, `rateLimit.window`, `rateLimit.max`, `rateLimit.storage` ("memory" | "database" | "secondary-storage"). + +--- + +## Hooks + +**Endpoint hooks:** `hooks.before` / `hooks.after` - Array of `{ matcher, handler }`. Use `createAuthMiddleware`. Access `ctx.path`, `ctx.context.returned` (after), `ctx.context.session`. + +**Database hooks:** `databaseHooks.user.create.before/after`, same for `session`, `account`. Useful for adding default values or post-creation actions. + +**Hook context (`ctx.context`):** `session`, `secret`, `authCookies`, `password.hash()`/`verify()`, `adapter`, `internalAdapter`, `generateId()`, `tables`, `baseURL`. + +--- + +## Plugins + +**Import from dedicated paths for tree-shaking:** + +``` +import { twoFactor } from "better-auth/plugins/two-factor" +``` + +NOT `from "better-auth/plugins"`. + +**Popular plugins:** `twoFactor`, `organization`, `passkey`, `magicLink`, `emailOtp`, `username`, `phoneNumber`, `admin`, `apiKey`, `bearer`, `jwt`, `multiSession`, `sso`, `oauthProvider`, `oidcProvider`, `openAPI`, `genericOAuth`. + +Client plugins go in `createAuthClient({ plugins: [...] })`. + +--- + +## Client + +Import from: `better-auth/client` (vanilla), `better-auth/react`, `better-auth/vue`, `better-auth/svelte`, `better-auth/solid`. + +Key methods: `signUp.email()`, `signIn.email()`, `signIn.social()`, `signOut()`, `useSession()`, `getSession()`, `revokeSession()`, `revokeSessions()`. + +--- + +## Type Safety + +Infer types: `typeof auth.$Infer.Session`, `typeof auth.$Infer.Session.user`. + +For separate client/server projects: `createAuthClient()`. + +--- + +## Common Gotchas + +1. **Model vs table name** - Config uses ORM model name, not DB table name +2. **Plugin schema** - Re-run CLI after adding plugins +3. **Secondary storage** - Sessions go there by default, not DB +4. **Cookie cache** - Custom session fields NOT cached, always re-fetched +5. **Stateless mode** - No DB = session in cookie only, logout on cache expiry +6. **Change email flow** - Sends to current email first, then new email + +--- + +## Resources + +- [Docs](https://better-auth.com/docs) +- [Options Reference](https://better-auth.com/docs/reference/options) +- [LLMs.txt](https://better-auth.com/llms.txt) +- [GitHub](https://github.com/better-auth/better-auth) +- [Init Options Source](https://github.com/better-auth/better-auth/blob/main/packages/core/src/types/init-options.ts) diff --git a/.agents/skills/better-auth-security-best-practices/SKILL.MD b/.agents/skills/better-auth-security-best-practices/SKILL.MD new file mode 100644 index 0000000..071998c --- /dev/null +++ b/.agents/skills/better-auth-security-best-practices/SKILL.MD @@ -0,0 +1,426 @@ +--- +name: better-auth-security-best-practices +description: Configure rate limiting, manage auth secrets, set up CSRF protection, define trusted origins, secure sessions and cookies, encrypt OAuth tokens, track IP addresses, and implement audit logging for Better Auth. Use when users need to secure their auth setup, prevent brute force attacks, or harden a Better Auth deployment. +--- + +## Secret Management + +### Configuring the Secret + +```ts +import { betterAuth } from 'better-auth'; + +export const auth = betterAuth({ + secret: process.env.BETTER_AUTH_SECRET // or via `BETTER_AUTH_SECRET` env +}); +``` + +Better Auth looks for secrets in this order: + +1. `options.secret` in your config +2. `BETTER_AUTH_SECRET` environment variable +3. `AUTH_SECRET` environment variable + +### Secret Requirements + +- Rejects default/placeholder secrets in production +- Warns if shorter than 32 characters or entropy below 120 bits +- Generate: `openssl rand -base64 32` +- Never commit secrets to version control + +## Rate Limiting + +Enabled in production by default. Applies to all endpoints. Plugins can override per-endpoint. + +### Default Configuration + +```ts +import { betterAuth } from 'better-auth'; + +export const auth = betterAuth({ + rateLimit: { + enabled: true, // Default: true in production + window: 10, // Time window in seconds (default: 10) + max: 100 // Max requests per window (default: 100) + } +}); +``` + +### Storage Options + +Options: `"memory"` (resets on restart, avoid on serverless), `"database"` (persistent), `"secondary-storage"` (Redis, default when available). + +```ts +rateLimit: { + storage: "database", +} +``` + +### Custom Storage + +Implement your own rate limit storage: + +```ts +rateLimit: { + customStorage: { + get: async (key) => { + // Return { count: number, expiresAt: number } or null + }, + set: async (key, data) => { + // Store the rate limit data + }, + }, +} +``` + +### Per-Endpoint Rules + +Sensitive endpoints default to 3 requests per 10 seconds (`/sign-in`, `/sign-up`, `/change-password`, `/change-email`). Override: + +```ts +rateLimit: { + customRules: { + "/api/auth/sign-in/email": { + window: 60, // 1 minute window + max: 5, // 5 attempts + }, + "/api/auth/some-safe-endpoint": false, // Disable rate limiting + }, +} +``` + +## CSRF Protection + +Multi-layer protection: origin header validation, Fetch Metadata checks, and first-login protection. + +### Configuration + +```ts +import { betterAuth } from 'better-auth'; + +export const auth = betterAuth({ + advanced: { + disableCSRFCheck: false // Default: false (keep enabled) + } +}); +``` + +Only disable for testing or with an alternative CSRF mechanism. + +## Trusted Origins + +### Configuring Trusted Origins + +```ts +import { betterAuth } from 'better-auth'; + +export const auth = betterAuth({ + baseURL: 'https://api.example.com', + trustedOrigins: ['https://app.example.com', 'https://admin.example.com'] +}); +``` + +The `baseURL` origin is automatically trusted. Also configurable via env: `BETTER_AUTH_TRUSTED_ORIGINS=https://app.example.com,https://admin.example.com` + +### Wildcard Patterns + +```ts +trustedOrigins: [ + '*.example.com', // Matches any subdomain + 'https://*.example.com', // Protocol-specific wildcard + 'exp://192.168.*.*:*/*' // Custom schemes (e.g., Expo) +]; +``` + +### Dynamic Trusted Origins + +Compute trusted origins based on the request: + +```ts +trustedOrigins: async (request) => { + // Validate against database, header, etc. + const tenant = getTenantFromRequest(request); + return [`https://${tenant}.myapp.com`]; +}; +``` + +Validates `callbackURL`, `redirectTo`, `errorCallbackURL`, `newUserCallbackURL`, and `origin` against trusted origins. Invalid URLs receive 403. + +## Session Security + +### Session Expiration + +```ts +import { betterAuth } from 'better-auth'; + +export const auth = betterAuth({ + session: { + expiresIn: 60 * 60 * 24 * 7, // 7 days (default) + updateAge: 60 * 60 * 24 // Refresh session every 24 hours (default) + } +}); +``` + +### Session Caching Strategies + +Cache session data in cookies to reduce database queries: + +```ts +session: { + cookieCache: { + enabled: true, + maxAge: 60 * 5, // 5 minutes + strategy: "compact", // Options: "compact", "jwt", "jwe" + }, +} +``` + +Strategies: `"compact"` (Base64url + HMAC, smallest), `"jwt"` (HS256, standard), `"jwe"` (encrypted, use when session has sensitive data). + +## Cookie Security + +Defaults: `secure: true` (HTTPS/production), `sameSite: "lax"`, `httpOnly: true`, `path: "/"`, prefix `__Secure-`. + +### Custom Cookie Configuration + +```ts +import { betterAuth } from 'better-auth'; + +export const auth = betterAuth({ + advanced: { + useSecureCookies: true, // Force secure cookies + cookiePrefix: 'myapp', // Custom prefix (default: "better-auth") + defaultCookieAttributes: { + sameSite: 'strict', // Stricter CSRF protection + path: '/auth' // Limit cookie scope + } + } +}); +``` + +### Cross-Subdomain Cookies + +```ts +advanced: { + crossSubDomainCookies: { + enabled: true, + domain: ".example.com", // Note the leading dot + additionalCookies: ["session_token", "session_data"], + }, +} +``` + +Only enable if you need authentication sharing and trust all subdomains. + +## OAuth / Social Provider Security + +PKCE is automatic for all OAuth flows. State tokens are 32-char random strings expiring after 10 minutes. + +### State Parameter Storage + +```ts +import { betterAuth } from 'better-auth'; + +export const auth = betterAuth({ + account: { + storeStateStrategy: 'cookie' // Options: "cookie" (default), "database" + } +}); +``` + +### Encrypting OAuth Tokens + +```ts +account: { + encryptOAuthTokens: true, // Uses AES-256-GCM +} +``` + +Enable if storing OAuth tokens for API access on behalf of users. Use `skipStateCookieCheck: true` only for mobile apps that cannot maintain cookies. + +## IP-Based Security + +### IP Address Configuration + +```ts +import { betterAuth } from 'better-auth'; + +export const auth = betterAuth({ + advanced: { + ipAddress: { + ipAddressHeaders: ['x-forwarded-for', 'x-real-ip'], // Headers to check + disableIpTracking: false // Keep enabled for rate limiting + } + } +}); +``` + +Set `ipv6Subnet` (128, 64, 48, 32; default 64) to group IPv6 addresses. Enable `trustedProxyHeaders: true` only if behind a trusted reverse proxy. + +## Database Hooks for Security Auditing + +```ts +import { betterAuth } from 'better-auth'; + +export const auth = betterAuth({ + databaseHooks: { + session: { + create: { + after: async ({ data, ctx }) => { + await auditLog('session.created', { + userId: data.userId, + ip: ctx?.request?.headers.get('x-forwarded-for'), + userAgent: ctx?.request?.headers.get('user-agent') + }); + } + }, + delete: { + before: async ({ data }) => { + await auditLog('session.revoked', { sessionId: data.id }); + } + } + }, + user: { + update: { + after: async ({ data, oldData }) => { + if (oldData?.email !== data.email) { + await auditLog('user.email_changed', { + userId: data.id, + oldEmail: oldData?.email, + newEmail: data.email + }); + } + } + } + }, + account: { + create: { + after: async ({ data }) => { + await auditLog('account.linked', { + userId: data.userId, + provider: data.providerId + }); + } + } + } + } +}); +``` + +Return `false` from a `before` hook to prevent an operation. + +## Background Tasks + +```ts +import { betterAuth } from 'better-auth'; + +export const auth = betterAuth({ + advanced: { + backgroundTasks: { + handler: (promise) => { + // Platform-specific handler + // Vercel: waitUntil(promise) + // Cloudflare: ctx.waitUntil(promise) + waitUntil(promise); + } + } + } +}); +``` + +Ensures operations like sending emails don't affect response timing. + +## Account Enumeration Prevention + +Built-in: consistent response messages, dummy operations on invalid requests, background email sending. Return generic error messages ("Invalid credentials") rather than specific ones ("User not found"). + +## Complete Security Configuration Example + +```ts +import { betterAuth } from 'better-auth'; + +export const auth = betterAuth({ + secret: process.env.BETTER_AUTH_SECRET, + baseURL: 'https://api.example.com', + trustedOrigins: ['https://app.example.com', 'https://*.preview.example.com'], + + // Rate limiting + rateLimit: { + enabled: true, + storage: 'secondary-storage', + customRules: { + '/api/auth/sign-in/email': { window: 60, max: 5 }, + '/api/auth/sign-up/email': { window: 60, max: 3 } + } + }, + + // Session security + session: { + expiresIn: 60 * 60 * 24 * 7, // 7 days + updateAge: 60 * 60 * 24, // 24 hours + freshAge: 60 * 60, // 1 hour for sensitive actions + cookieCache: { + enabled: true, + maxAge: 300, + strategy: 'jwe' // Encrypted session data + } + }, + + // OAuth security + account: { + encryptOAuthTokens: true, + storeStateStrategy: 'cookie' + }, + + // Advanced settings + advanced: { + useSecureCookies: true, + cookiePrefix: 'myapp', + defaultCookieAttributes: { + sameSite: 'lax' + }, + ipAddress: { + ipAddressHeaders: ['x-forwarded-for'], + ipv6Subnet: 64 + }, + backgroundTasks: { + handler: (promise) => waitUntil(promise) + } + }, + + // Security auditing + databaseHooks: { + session: { + create: { + after: async ({ data, ctx }) => { + console.log(`New session for user ${data.userId}`); + } + } + }, + user: { + update: { + after: async ({ data, oldData }) => { + if (oldData?.email !== data.email) { + console.log(`Email changed for user ${data.id}`); + } + } + } + } + } +}); +``` + +## Security Checklist + +Before deploying to production: + +- [ ] **Secret**: Use a strong, unique secret (32+ characters, high entropy) +- [ ] **HTTPS**: Ensure `baseURL` uses HTTPS +- [ ] **Trusted Origins**: Configure all valid origins (frontend, mobile apps) +- [ ] **Rate Limiting**: Keep enabled with appropriate limits +- [ ] **CSRF Protection**: Keep enabled (`disableCSRFCheck: false`) +- [ ] **Secure Cookies**: Enabled automatically with HTTPS +- [ ] **OAuth Tokens**: Consider `encryptOAuthTokens: true` if storing tokens +- [ ] **Background Tasks**: Configure for serverless platforms +- [ ] **Audit Logging**: Implement via `databaseHooks` or `hooks` +- [ ] **IP Tracking**: Configure headers if behind a proxy diff --git a/.agents/skills/create-auth-skill/SKILL.md b/.agents/skills/create-auth-skill/SKILL.md new file mode 100644 index 0000000..93e5887 --- /dev/null +++ b/.agents/skills/create-auth-skill/SKILL.md @@ -0,0 +1,327 @@ +--- +name: create-auth-skill +description: Scaffold and implement authentication in TypeScript/JavaScript apps using Better Auth. Detect frameworks, configure database adapters, set up route handlers, add OAuth providers, and create auth UI pages. Use when users want to add login, sign-up, or authentication to a new or existing project with Better Auth. +--- + +# Create Auth Skill + +Guide for adding authentication to TypeScript/JavaScript applications using Better Auth. + +**For code examples and syntax, see [better-auth.com/docs](https://better-auth.com/docs).** + +--- + +## Phase 1: Planning (REQUIRED before implementation) + +Before writing any code, gather requirements by scanning the project and asking the user structured questions. This ensures the implementation matches their needs. + +### Step 1: Scan the project + +Analyze the codebase to auto-detect: + +- **Framework** — Look for `next.config`, `svelte.config`, `nuxt.config`, `astro.config`, `vite.config`, or Express/Hono entry files. +- **Database/ORM** — Look for `prisma/schema.prisma`, `drizzle.config`, `package.json` deps (`pg`, `mysql2`, `better-sqlite3`, `mongoose`, `mongodb`). +- **Existing auth** — Look for existing auth libraries (`next-auth`, `lucia`, `clerk`, `supabase/auth`, `firebase/auth`) in `package.json` or imports. +- **Package manager** — Check for `pnpm-lock.yaml`, `yarn.lock`, `bun.lockb`, or `package-lock.json`. + +Use what you find to pre-fill defaults and skip questions you can already answer. + +### Step 2: Ask planning questions + +Use the `AskQuestion` tool to ask the user **all applicable questions in a single call**. Skip any question you already have a confident answer for from the scan. Group them under a title like "Auth Setup Planning". + +**Questions to ask:** + +1. **Project type** (skip if detected) + - Prompt: "What type of project is this?" + - Options: New project from scratch | Adding auth to existing project | Migrating from another auth library + +2. **Framework** (skip if detected) + - Prompt: "Which framework are you using?" + - Options: Next.js (App Router) | Next.js (Pages Router) | SvelteKit | Nuxt | Astro | Express | Hono | SolidStart | Other + +3. **Database & ORM** (skip if detected) + - Prompt: "Which database setup will you use?" + - Options: PostgreSQL (Prisma) | PostgreSQL (Drizzle) | PostgreSQL (pg driver) | MySQL (Prisma) | MySQL (Drizzle) | MySQL (mysql2 driver) | SQLite (Prisma) | SQLite (Drizzle) | SQLite (better-sqlite3 driver) | MongoDB (Mongoose) | MongoDB (native driver) + +4. **Authentication methods** (always ask, allow multiple) + - Prompt: "Which sign-in methods do you need?" + - Options: Email & password | Social OAuth (Google, GitHub, etc.) | Magic link (passwordless email) | Passkey (WebAuthn) | Phone number + - `allow_multiple: true` + +5. **Social providers** (only if they selected Social OAuth above — ask in a follow-up call) + - Prompt: "Which social providers do you need?" + - Options: Google | GitHub | Apple | Microsoft | Discord | Twitter/X + - `allow_multiple: true` + +6. **Email verification** (only if Email & password was selected above — ask in a follow-up call) + - Prompt: "Do you want to require email verification?" + - Options: Yes | No + +7. **Email provider** (only if email verification is Yes, or if Password reset is selected in features — ask in a follow-up call) + - Prompt: "How do you want to send emails?" + - Options: Resend | Mock it for now (console.log) + +8. **Features & plugins** (always ask, allow multiple) + - Prompt: "Which additional features do you need?" + - Options: Two-factor authentication (2FA) | Organizations / teams | Admin dashboard | API bearer tokens | Password reset | None of these + - `allow_multiple: true` + +9. **Auth pages** (always ask, allow multiple — pre-select based on earlier answers) + - Prompt: "Which auth pages do you need?" + - Options vary based on previous answers: + - Always available: Sign in | Sign up + - If Email & password selected: Forgot password | Reset password + - If email verification enabled: Email verification + - `allow_multiple: true` + +10. **Auth UI style** (always ask) + +- Prompt: "What style do you want for the auth pages? Pick one or describe your own." +- Options: Minimal & clean | Centered card with background | Split layout (form + hero image) | Floating / glassmorphism | Other (I'll describe) + +### Step 3: Summarize the plan + +After collecting answers, present a concise implementation plan as a markdown checklist. Example: + +``` +## Auth Implementation Plan + +- **Framework:** Next.js (App Router) +- **Database:** PostgreSQL via Prisma +- **Auth methods:** Email/password, Google OAuth, GitHub OAuth +- **Plugins:** 2FA, Organizations, Email verification +- **UI:** Custom forms + +### Steps +1. Install `better-auth` and `@better-auth/cli` +2. Create `lib/auth.ts` with server config +3. Create `lib/auth-client.ts` with React client +4. Set up route handler at `app/api/auth/[...all]/route.ts` +5. Configure Prisma adapter and generate schema +6. Add Google & GitHub OAuth providers +7. Enable `twoFactor` and `organization` plugins +8. Set up email verification handler +9. Run migrations +10. Create sign-in / sign-up pages +``` + +Ask the user to confirm the plan before proceeding to Phase 2. + +--- + +## Phase 2: Implementation + +Only proceed here after the user confirms the plan from Phase 1. + +Follow the decision tree below, guided by the answers collected above. + +``` +Is this a new/empty project? +├─ YES → New project setup +│ 1. Install better-auth (+ scoped packages per plan) +│ 2. Create auth.ts with all planned config +│ 3. Create auth-client.ts with framework client +│ 4. Set up route handler +│ 5. Set up environment variables +│ 6. Run CLI migrate/generate +│ 7. Add plugins from plan +│ 8. Create auth UI pages +│ +├─ MIGRATING → Migration from existing auth +│ 1. Audit current auth for gaps +│ 2. Plan incremental migration +│ 3. Install better-auth alongside existing auth +│ 4. Migrate routes, then session logic, then UI +│ 5. Remove old auth library +│ 6. See migration guides in docs +│ +└─ ADDING → Add auth to existing project + 1. Analyze project structure + 2. Install better-auth + 3. Create auth config matching plan + 4. Add route handler + 5. Run schema migrations + 6. Integrate into existing pages + 7. Add planned plugins and features +``` + +At the end of implementation, guide users thoroughly on remaining next steps (e.g., setting up OAuth app credentials, deploying env vars, testing flows). + +--- + +## Installation + +**Core:** `npm install better-auth` + +**Scoped packages (as needed):** +| Package | Use case | +|---------|----------| +| `@better-auth/passkey` | WebAuthn/Passkey auth | +| `@better-auth/sso` | SAML/OIDC enterprise SSO | +| `@better-auth/stripe` | Stripe payments | +| `@better-auth/scim` | SCIM user provisioning | +| `@better-auth/expo` | React Native/Expo | + +--- + +## Environment Variables + +```env +BETTER_AUTH_SECRET=<32+ chars, generate with: openssl rand -base64 32> +BETTER_AUTH_URL=http://localhost:3000 +DATABASE_URL= +``` + +Add OAuth secrets as needed: `GITHUB_CLIENT_ID`, `GITHUB_CLIENT_SECRET`, `GOOGLE_CLIENT_ID`, etc. + +--- + +## Server Config (auth.ts) + +**Location:** `lib/auth.ts` or `src/lib/auth.ts` + +**Minimal config needs:** + +- `database` - Connection or adapter +- `emailAndPassword: { enabled: true }` - For email/password auth + +**Standard config adds:** + +- `socialProviders` - OAuth providers (google, github, etc.) +- `emailVerification.sendVerificationEmail` - Email verification handler +- `emailAndPassword.sendResetPassword` - Password reset handler + +**Full config adds:** + +- `plugins` - Array of feature plugins +- `session` - Expiry, cookie cache settings +- `account.accountLinking` - Multi-provider linking +- `rateLimit` - Rate limiting config + +**Export types:** `export type Session = typeof auth.$Infer.Session` + +--- + +## Client Config (auth-client.ts) + +**Import by framework:** +| Framework | Import | +|-----------|--------| +| React/Next.js | `better-auth/react` | +| Vue | `better-auth/vue` | +| Svelte | `better-auth/svelte` | +| Solid | `better-auth/solid` | +| Vanilla JS | `better-auth/client` | + +**Client plugins** go in `createAuthClient({ plugins: [...] })`. + +**Common exports:** `signIn`, `signUp`, `signOut`, `useSession`, `getSession` + +--- + +## Route Handler Setup + +| Framework | File | Handler | +| ------------------ | -------------------------------- | ------------------------------------------------ | +| Next.js App Router | `app/api/auth/[...all]/route.ts` | `toNextJsHandler(auth)` → export `{ GET, POST }` | +| Next.js Pages | `pages/api/auth/[...all].ts` | `toNextJsHandler(auth)` → default export | +| Express | Any file | `app.all("/api/auth/*", toNodeHandler(auth))` | +| SvelteKit | `src/hooks.server.ts` | `svelteKitHandler(auth)` | +| SolidStart | Route file | `solidStartHandler(auth)` | +| Hono | Route file | `auth.handler(c.req.raw)` | + +**Next.js Server Components:** Add `nextCookies()` plugin to auth config. + +--- + +## Database Migrations + +| Adapter | Command | +| --------------- | -------------------------------------------------------------------------------------------------- | +| Built-in Kysely | `npx @better-auth/cli@latest migrate` (applies directly) | +| Prisma | `npx @better-auth/cli@latest generate --output prisma/schema.prisma` then `npx prisma migrate dev` | +| Drizzle | `npx @better-auth/cli@latest generate --output src/db/auth-schema.ts` then `npx drizzle-kit push` | + +**Re-run after adding plugins.** + +--- + +## Database Adapters + +| Database | Setup | +| ---------- | -------------------------------------------------------------------------------------- | +| SQLite | Pass `better-sqlite3` or `bun:sqlite` instance directly | +| PostgreSQL | Pass `pg.Pool` instance directly | +| MySQL | Pass `mysql2` pool directly | +| Prisma | `prismaAdapter(prisma, { provider: "postgresql" })` from `better-auth/adapters/prisma` | +| Drizzle | `drizzleAdapter(db, { provider: "pg" })` from `better-auth/adapters/drizzle` | +| MongoDB | `mongodbAdapter(db)` from `better-auth/adapters/mongodb` | + +--- + +## Common Plugins + +| Plugin | Server Import | Client Import | Purpose | +| -------------- | ---------------------- | -------------------- | ----------------- | +| `twoFactor` | `better-auth/plugins` | `twoFactorClient` | 2FA with TOTP/OTP | +| `organization` | `better-auth/plugins` | `organizationClient` | Teams/orgs | +| `admin` | `better-auth/plugins` | `adminClient` | User management | +| `bearer` | `better-auth/plugins` | - | API token auth | +| `openAPI` | `better-auth/plugins` | - | API docs | +| `passkey` | `@better-auth/passkey` | `passkeyClient` | WebAuthn | +| `sso` | `@better-auth/sso` | - | Enterprise SSO | + +**Plugin pattern:** Server plugin + client plugin + run migrations. + +--- + +## Auth UI Implementation + +**Sign in flow:** + +1. `signIn.email({ email, password })` or `signIn.social({ provider, callbackURL })` +2. Handle `error` in response +3. Redirect on success + +**Session check (client):** `useSession()` hook returns `{ data: session, isPending }` + +**Session check (server):** `auth.api.getSession({ headers: await headers() })` + +**Protected routes:** Check session, redirect to `/sign-in` if null. + +--- + +## Security Checklist + +- [ ] `BETTER_AUTH_SECRET` set (32+ chars) +- [ ] `advanced.useSecureCookies: true` in production +- [ ] `trustedOrigins` configured +- [ ] Rate limits enabled +- [ ] Email verification enabled +- [ ] Password reset implemented +- [ ] 2FA for sensitive apps +- [ ] CSRF protection NOT disabled +- [ ] `account.accountLinking` reviewed + +--- + +## Troubleshooting + +| Issue | Fix | +| ------------------------------- | ------------------------------------------------------------- | +| "Secret not set" | Add `BETTER_AUTH_SECRET` env var | +| "Invalid Origin" | Add domain to `trustedOrigins` | +| Cookies not setting | Check `baseURL` matches domain; enable secure cookies in prod | +| OAuth callback errors | Verify redirect URIs in provider dashboard | +| Type errors after adding plugin | Re-run CLI generate/migrate | + +--- + +## Resources + +- [Docs](https://better-auth.com/docs) +- [Examples](https://github.com/better-auth/examples) +- [Plugins](https://better-auth.com/docs/concepts/plugins) +- [CLI](https://better-auth.com/docs/concepts/cli) +- [Migration Guides](https://better-auth.com/docs/guides) diff --git a/.agents/skills/email-and-password-best-practices/SKILL.md b/.agents/skills/email-and-password-best-practices/SKILL.md new file mode 100644 index 0000000..b1bcb04 --- /dev/null +++ b/.agents/skills/email-and-password-best-practices/SKILL.md @@ -0,0 +1,211 @@ +--- +name: email-and-password-best-practices +description: Configure email verification, implement password reset flows, set password policies, and customise hashing algorithms for Better Auth email/password authentication. Use when users need to set up login, sign-in, sign-up, credential authentication, or password security with Better Auth. +--- + +## Quick Start + +1. Enable email/password: `emailAndPassword: { enabled: true }` +2. Configure `emailVerification.sendVerificationEmail` +3. Add `sendResetPassword` for password reset flows +4. Run `npx @better-auth/cli@latest migrate` +5. Verify: attempt sign-up and confirm verification email triggers + +--- + +## Email Verification Setup + +Configure `emailVerification.sendVerificationEmail` to verify user email addresses. + +```ts +import { betterAuth } from 'better-auth'; +import { sendEmail } from './email'; // your email sending function + +export const auth = betterAuth({ + emailVerification: { + sendVerificationEmail: async ({ user, url, token }, request) => { + await sendEmail({ + to: user.email, + subject: 'Verify your email address', + text: `Click the link to verify your email: ${url}` + }); + } + } +}); +``` + +**Note**: The `url` parameter contains the full verification link. The `token` is available if you need to build a custom verification URL. + +### Requiring Email Verification + +For stricter security, enable `emailAndPassword.requireEmailVerification` to block sign-in until the user verifies their email. When enabled, unverified users will receive a new verification email on each sign-in attempt. + +```ts +export const auth = betterAuth({ + emailAndPassword: { + requireEmailVerification: true + } +}); +``` + +**Note**: This requires `sendVerificationEmail` to be configured and only applies to email/password sign-ins. + +## Client Side Validation + +Implement client-side validation for immediate user feedback and reduced server load. + +## Callback URLs + +Always use absolute URLs (including the origin) for callback URLs in sign-up and sign-in requests. This prevents Better Auth from needing to infer the origin, which can cause issues when your backend and frontend are on different domains. + +```ts +const { data, error } = await authClient.signUp.email({ + callbackURL: 'https://example.com/callback' // absolute URL with origin +}); +``` + +## Password Reset Flows + +Provide `sendResetPassword` in the email and password config to enable password resets. + +```ts +import { betterAuth } from 'better-auth'; +import { sendEmail } from './email'; // your email sending function + +export const auth = betterAuth({ + emailAndPassword: { + enabled: true, + // Custom email sending function to send reset-password email + sendResetPassword: async ({ user, url, token }, request) => { + void sendEmail({ + to: user.email, + subject: 'Reset your password', + text: `Click the link to reset your password: ${url}` + }); + }, + // Optional event hook + onPasswordReset: async ({ user }, request) => { + // your logic here + console.log(`Password for user ${user.email} has been reset.`); + } + } +}); +``` + +### Security Considerations + +Built-in protections: background email sending (timing attack prevention), dummy operations on invalid requests, constant response messages regardless of user existence. + +On serverless platforms, configure a background task handler: + +```ts +export const auth = betterAuth({ + advanced: { + backgroundTasks: { + handler: (promise) => { + // Use platform-specific methods like waitUntil + waitUntil(promise); + } + } + } +}); +``` + +#### Token Security + +Tokens expire after 1 hour by default. Configure with `resetPasswordTokenExpiresIn` (in seconds): + +```ts +export const auth = betterAuth({ + emailAndPassword: { + enabled: true, + resetPasswordTokenExpiresIn: 60 * 30 // 30 minutes + } +}); +``` + +Tokens are single-use — deleted immediately after successful reset. + +#### Session Revocation + +Enable `revokeSessionsOnPasswordReset` to invalidate all existing sessions on password reset: + +```ts +export const auth = betterAuth({ + emailAndPassword: { + enabled: true, + revokeSessionsOnPasswordReset: true + } +}); +``` + +#### Password Requirements + +Password length limits (configurable): + +```ts +export const auth = betterAuth({ + emailAndPassword: { + enabled: true, + minPasswordLength: 12, + maxPasswordLength: 256 + } +}); +``` + +### Sending the Password Reset + +Call `requestPasswordReset` to send the reset link. Triggers the `sendResetPassword` function from your config. + +```ts +const data = await auth.api.requestPasswordReset({ + body: { + email: 'john.doe@example.com', // required + redirectTo: 'https://example.com/reset-password' + } +}); +``` + +Or authClient: + +```ts +const { data, error } = await authClient.requestPasswordReset({ + email: 'john.doe@example.com', // required + redirectTo: 'https://example.com/reset-password' +}); +``` + +**Note**: While the `email` is required, we also recommend configuring the `redirectTo` for a smoother user experience. + +## Password Hashing + +Default: `scrypt` (Node.js native, no external dependencies). + +### Custom Hashing Algorithm + +To use Argon2id or another algorithm, provide custom `hash` and `verify` functions: + +```ts +import { betterAuth } from 'better-auth'; +import { hash, verify, type Options } from '@node-rs/argon2'; + +const argon2Options: Options = { + memoryCost: 65536, // 64 MiB + timeCost: 3, // 3 iterations + parallelism: 4, // 4 parallel lanes + outputLen: 32, // 32 byte output + algorithm: 2 // Argon2id variant +}; + +export const auth = betterAuth({ + emailAndPassword: { + enabled: true, + password: { + hash: (password) => hash(password, argon2Options), + verify: ({ password, hash: storedHash }) => verify(storedHash, password, argon2Options) + } + } +}); +``` + +**Note**: If you switch hashing algorithms on an existing system, users with passwords hashed using the old algorithm won't be able to sign in. Plan a migration strategy if needed. diff --git a/.agents/skills/organization-best-practices/SKILL.md b/.agents/skills/organization-best-practices/SKILL.md new file mode 100644 index 0000000..f299c82 --- /dev/null +++ b/.agents/skills/organization-best-practices/SKILL.md @@ -0,0 +1,478 @@ +--- +name: organization-best-practices +description: Configure multi-tenant organizations, manage members and invitations, define custom roles and permissions, set up teams, and implement RBAC using Better Auth's organization plugin. Use when users need org setup, team management, member roles, access control, or the Better Auth organization plugin. +--- + +## Setup + +1. Add `organization()` plugin to server config +2. Add `organizationClient()` plugin to client config +3. Run `npx @better-auth/cli migrate` +4. Verify: check that organization, member, invitation tables exist in your database + +```ts +import { betterAuth } from 'better-auth'; +import { organization } from 'better-auth/plugins'; + +export const auth = betterAuth({ + plugins: [ + organization({ + allowUserToCreateOrganization: true, + organizationLimit: 5, // Max orgs per user + membershipLimit: 100 // Max members per org + }) + ] +}); +``` + +### Client-Side Setup + +```ts +import { createAuthClient } from 'better-auth/client'; +import { organizationClient } from 'better-auth/client/plugins'; + +export const authClient = createAuthClient({ + plugins: [organizationClient()] +}); +``` + +## Creating Organizations + +The creator is automatically assigned the `owner` role. + +```ts +const createOrg = async () => { + const { data, error } = await authClient.organization.create({ + name: 'My Company', + slug: 'my-company', + logo: 'https://example.com/logo.png', + metadata: { plan: 'pro' } + }); +}; +``` + +### Controlling Organization Creation + +Restrict who can create organizations based on user attributes: + +```ts +organization({ + allowUserToCreateOrganization: async (user) => { + return user.emailVerified === true; + }, + organizationLimit: async (user) => { + // Premium users get more organizations + return user.plan === 'premium' ? 20 : 3; + } +}); +``` + +### Creating Organizations on Behalf of Users + +Administrators can create organizations for other users (server-side only): + +```ts +await auth.api.createOrganization({ + body: { + name: 'Client Organization', + slug: 'client-org', + userId: 'user-id-who-will-be-owner' // `userId` is required + } +}); +``` + +**Note**: The `userId` parameter cannot be used alongside session headers. + +## Active Organizations + +Stored in the session and scopes subsequent API calls. Set after user selects one. + +```ts +const setActive = async (organizationId: string) => { + const { data, error } = await authClient.organization.setActive({ + organizationId + }); +}; +``` + +Many endpoints use the active organization when `organizationId` is not provided (`listMembers`, `listInvitations`, `inviteMember`, etc.). + +Use `getFullOrganization()` to retrieve the active org with all members, invitations, and teams. + +## Members + +### Adding Members (Server-Side) + +```ts +await auth.api.addMember({ + body: { + userId: 'user-id', + role: 'member', + organizationId: 'org-id' + } +}); +``` + +For client-side member additions, use the invitation system instead. + +### Assigning Multiple Roles + +```ts +await auth.api.addMember({ + body: { + userId: 'user-id', + role: ['admin', 'moderator'], + organizationId: 'org-id' + } +}); +``` + +### Removing Members + +Use `removeMember({ memberIdOrEmail })`. The last owner cannot be removed — assign ownership to another member first. + +### Updating Member Roles + +Use `updateMemberRole({ memberId, role })`. + +### Membership Limits + +```ts +organization({ + membershipLimit: async (user, organization) => { + if (organization.metadata?.plan === 'enterprise') { + return 1000; + } + return 50; + } +}); +``` + +## Invitations + +### Setting Up Invitation Emails + +```ts +import { betterAuth } from 'better-auth'; +import { organization } from 'better-auth/plugins'; +import { sendEmail } from './email'; + +export const auth = betterAuth({ + plugins: [ + organization({ + sendInvitationEmail: async (data) => { + const { email, organization, inviter, invitation } = data; + + await sendEmail({ + to: email, + subject: `Join ${organization.name}`, + html: ` +

${inviter.user.name} invited you to join ${organization.name}

+ + Accept Invitation + + ` + }); + } + }) + ] +}); +``` + +### Sending Invitations + +```ts +await authClient.organization.inviteMember({ + email: 'newuser@example.com', + role: 'member' +}); +``` + +### Shareable Invitation URLs + +```ts +const { data } = await authClient.organization.getInvitationURL({ + email: 'newuser@example.com', + role: 'member', + callbackURL: 'https://yourapp.com/dashboard' +}); + +// Share data.url via any channel +``` + +This endpoint does not call `sendInvitationEmail` — handle delivery yourself. + +### Invitation Configuration + +```ts +organization({ + invitationExpiresIn: 60 * 60 * 24 * 7, // 7 days (default: 48 hours) + invitationLimit: 100, // Max pending invitations per org + cancelPendingInvitationsOnReInvite: true // Cancel old invites when re-inviting +}); +``` + +## Roles & Permissions + +Default roles: `owner` (full access), `admin` (manage members/invitations/settings), `member` (basic access). + +### Checking Permissions + +```ts +const { data } = await authClient.organization.hasPermission({ + permission: 'member:write' +}); + +if (data?.hasPermission) { + // User can manage members +} +``` + +Use `checkRolePermission({ role, permissions })` for client-side UI rendering (static only). For dynamic access control, use the `hasPermission` endpoint. + +## Teams + +### Enabling Teams + +```ts +import { organization } from 'better-auth/plugins'; + +export const auth = betterAuth({ + plugins: [ + organization({ + teams: { + enabled: true + } + }) + ] +}); +``` + +### Creating Teams + +```ts +const { data } = await authClient.organization.createTeam({ + name: 'Engineering' +}); +``` + +### Managing Team Members + +Use `addTeamMember({ teamId, userId })` (member must be in org first) and `removeTeamMember({ teamId, userId })` (stays in org). + +Set active team with `setActiveTeam({ teamId })`. + +### Team Limits + +```ts +organization({ + teams: { + maximumTeams: 20, // Max teams per org + maximumMembersPerTeam: 50, // Max members per team + allowRemovingAllTeams: false // Prevent removing last team + } +}); +``` + +## Dynamic Access Control + +### Enabling Dynamic Access Control + +```ts +import { organization } from 'better-auth/plugins'; +import { dynamicAccessControl } from '@better-auth/organization/addons'; + +export const auth = betterAuth({ + plugins: [ + organization({ + dynamicAccessControl: { + enabled: true + } + }) + ] +}); +``` + +### Creating Custom Roles + +```ts +await authClient.organization.createRole({ + role: 'moderator', + permission: { + member: ['read'], + invitation: ['read'] + } +}); +``` + +Use `updateRole({ roleId, permission })` and `deleteRole({ roleId })`. Pre-defined roles (owner, admin, member) cannot be deleted. Roles assigned to members cannot be deleted until reassigned. + +## Lifecycle Hooks + +Execute custom logic at various points in the organization lifecycle: + +```ts +organization({ + hooks: { + organization: { + beforeCreate: async ({ data, user }) => { + // Validate or modify data before creation + return { + data: { + ...data, + metadata: { ...data.metadata, createdBy: user.id } + } + }; + }, + afterCreate: async ({ organization, member }) => { + // Post-creation logic (e.g., send welcome email, create default resources) + await createDefaultResources(organization.id); + }, + beforeDelete: async ({ organization }) => { + // Cleanup before deletion + await archiveOrganizationData(organization.id); + } + }, + member: { + afterCreate: async ({ member, organization }) => { + await notifyAdmins(organization.id, `New member joined`); + } + }, + invitation: { + afterCreate: async ({ invitation, organization, inviter }) => { + await logInvitation(invitation); + } + } + } +}); +``` + +## Schema Customization + +Customize table names, field names, and add additional fields: + +```ts +organization({ + schema: { + organization: { + modelName: 'workspace', // Rename table + fields: { + name: 'workspaceName' // Rename fields + }, + additionalFields: { + billingId: { + type: 'string', + required: false + } + } + }, + member: { + additionalFields: { + department: { + type: 'string', + required: false + }, + title: { + type: 'string', + required: false + } + } + } + } +}); +``` + +## Security Considerations + +### Owner Protection + +- The last owner cannot be removed from an organization +- The last owner cannot leave the organization +- The owner role cannot be removed from the last owner + +Always ensure ownership transfer before removing the current owner: + +```ts +// Transfer ownership first +await authClient.organization.updateMemberRole({ + memberId: 'new-owner-member-id', + role: 'owner' +}); + +// Then the previous owner can be demoted or removed +``` + +### Organization Deletion + +Deleting an organization removes all associated data (members, invitations, teams). Prevent accidental deletion: + +```ts +organization({ + disableOrganizationDeletion: true // Disable via config +}); +``` + +Or implement soft delete via hooks: + +```ts +organization({ + hooks: { + organization: { + beforeDelete: async ({ organization }) => { + // Archive instead of delete + await archiveOrganization(organization.id); + throw new Error('Organization archived, not deleted'); + } + } + } +}); +``` + +### Invitation Security + +- Invitations expire after 48 hours by default +- Only the invited email address can accept an invitation +- Pending invitations can be cancelled by organization admins + +## Complete Configuration Example + +```ts +import { betterAuth } from 'better-auth'; +import { organization } from 'better-auth/plugins'; +import { sendEmail } from './email'; + +export const auth = betterAuth({ + plugins: [ + organization({ + // Organization limits + allowUserToCreateOrganization: true, + organizationLimit: 10, + membershipLimit: 100, + creatorRole: 'owner', + + // Slugs + defaultOrganizationIdField: 'slug', + + // Invitations + invitationExpiresIn: 60 * 60 * 24 * 7, // 7 days + invitationLimit: 50, + sendInvitationEmail: async (data) => { + await sendEmail({ + to: data.email, + subject: `Join ${data.organization.name}`, + html: `Accept` + }); + }, + + // Hooks + hooks: { + organization: { + afterCreate: async ({ organization }) => { + console.log(`Organization ${organization.name} created`); + } + } + } + }) + ] +}); +``` diff --git a/.agents/skills/two-factor-authentication-best-practices/SKILL.md b/.agents/skills/two-factor-authentication-best-practices/SKILL.md new file mode 100644 index 0000000..bafaa92 --- /dev/null +++ b/.agents/skills/two-factor-authentication-best-practices/SKILL.md @@ -0,0 +1,331 @@ +--- +name: two-factor-authentication-best-practices +description: Configure TOTP authenticator apps, send OTP codes via email/SMS, manage backup codes, handle trusted devices, and implement 2FA sign-in flows using Better Auth's twoFactor plugin. Use when users need MFA, multi-factor authentication, authenticator setup, or login security with Better Auth. +--- + +## Setup + +1. Add `twoFactor()` plugin to server config with `issuer` +2. Add `twoFactorClient()` plugin to client config +3. Run `npx @better-auth/cli migrate` +4. Verify: check that `twoFactorSecret` column exists on user table + +```ts +import { betterAuth } from 'better-auth'; +import { twoFactor } from 'better-auth/plugins'; + +export const auth = betterAuth({ + appName: 'My App', + plugins: [ + twoFactor({ + issuer: 'My App' + }) + ] +}); +``` + +### Client-Side Setup + +```ts +import { createAuthClient } from 'better-auth/client'; +import { twoFactorClient } from 'better-auth/client/plugins'; + +export const authClient = createAuthClient({ + plugins: [ + twoFactorClient({ + onTwoFactorRedirect() { + window.location.href = '/2fa'; + } + }) + ] +}); +``` + +## Enabling 2FA for Users + +Requires password verification. Returns TOTP URI (for QR code) and backup codes. + +```ts +const enable2FA = async (password: string) => { + const { data, error } = await authClient.twoFactor.enable({ + password + }); + + if (data) { + // data.totpURI — generate a QR code from this + // data.backupCodes — display to user + } +}; +``` + +`twoFactorEnabled` is not set to `true` until first TOTP verification succeeds. Override with `skipVerificationOnEnable: true` (not recommended). + +## TOTP (Authenticator App) + +### Displaying the QR Code + +```tsx +import QRCode from 'react-qr-code'; + +const TotpSetup = ({ totpURI }: { totpURI: string }) => { + return ; +}; +``` + +### Verifying TOTP Codes + +Accepts codes from one period before/after current time: + +```ts +const verifyTotp = async (code: string) => { + const { data, error } = await authClient.twoFactor.verifyTotp({ + code, + trustDevice: true + }); +}; +``` + +### TOTP Configuration Options + +```ts +twoFactor({ + totpOptions: { + digits: 6, // 6 or 8 digits (default: 6) + period: 30 // Code validity period in seconds (default: 30) + } +}); +``` + +## OTP (Email/SMS) + +### Configuring OTP Delivery + +```ts +import { betterAuth } from 'better-auth'; +import { twoFactor } from 'better-auth/plugins'; +import { sendEmail } from './email'; + +export const auth = betterAuth({ + plugins: [ + twoFactor({ + otpOptions: { + sendOTP: async ({ user, otp }, ctx) => { + await sendEmail({ + to: user.email, + subject: 'Your verification code', + text: `Your code is: ${otp}` + }); + }, + period: 5, // Code validity in minutes (default: 3) + digits: 6, // Number of digits (default: 6) + allowedAttempts: 5 // Max verification attempts (default: 5) + } + }) + ] +}); +``` + +### Sending and Verifying OTP + +Send: `authClient.twoFactor.sendOtp()`. Verify: `authClient.twoFactor.verifyOtp({ code, trustDevice: true })`. + +### OTP Storage Security + +Configure how OTP codes are stored in the database: + +```ts +twoFactor({ + otpOptions: { + storeOTP: 'encrypted' // Options: "plain", "encrypted", "hashed" + } +}); +``` + +For custom encryption: + +```ts +twoFactor({ + otpOptions: { + storeOTP: { + encrypt: async (token) => myEncrypt(token), + decrypt: async (token) => myDecrypt(token) + } + } +}); +``` + +## Backup Codes + +Generated automatically when 2FA is enabled. Each code is single-use. + +### Displaying Backup Codes + +```tsx +const BackupCodes = ({ codes }: { codes: string[] }) => { + return ( +
+

Save these codes in a secure location:

+
    + {codes.map((code, i) => ( +
  • {code}
    • + ))} +
+
+ ); +}; +``` + +### Regenerating Backup Codes + +Invalidates all previous codes: + +```ts +const regenerateBackupCodes = async (password: string) => { + const { data, error } = await authClient.twoFactor.generateBackupCodes({ + password + }); + // data.backupCodes contains the new codes +}; +``` + +### Using Backup Codes for Recovery + +```ts +const verifyBackupCode = async (code: string) => { + const { data, error } = await authClient.twoFactor.verifyBackupCode({ + code, + trustDevice: true + }); +}; +``` + +### Backup Code Configuration + +```ts +twoFactor({ + backupCodeOptions: { + amount: 10, // Number of codes to generate (default: 10) + length: 10, // Length of each code (default: 10) + storeBackupCodes: 'encrypted' // Options: "plain", "encrypted" + } +}); +``` + +## Handling 2FA During Sign-In + +Response includes `twoFactorRedirect: true` when 2FA is required: + +### Sign-In Flow + +1. Call `signIn.email({ email, password })` +2. Check `context.data.twoFactorRedirect` in `onSuccess` +3. If `true`, redirect to `/2fa` verification page +4. Verify via TOTP, OTP, or backup code +5. Session cookie is created on successful verification + +```ts +const signIn = async (email: string, password: string) => { + const { data, error } = await authClient.signIn.email( + { email, password }, + { + onSuccess(context) { + if (context.data.twoFactorRedirect) { + window.location.href = '/2fa'; + } + } + } + ); +}; +``` + +Server-side: check `"twoFactorRedirect" in response` when using `auth.api.signInEmail`. + +## Trusted Devices + +Pass `trustDevice: true` when verifying. Default trust duration: 30 days (`trustDeviceMaxAge`). Refreshes on each sign-in. + +## Security Considerations + +### Session Management + +Flow: credentials → session removed → temporary 2FA cookie (10 min default) → verify → session created. + +```ts +twoFactor({ + twoFactorCookieMaxAge: 600 // 10 minutes in seconds (default) +}); +``` + +### Rate Limiting + +Built-in: 3 requests per 10 seconds for all 2FA endpoints. OTP has additional attempt limiting: + +```ts +twoFactor({ + otpOptions: { + allowedAttempts: 5 // Max attempts per OTP code (default: 5) + } +}); +``` + +### Encryption at Rest + +TOTP secrets: encrypted with auth secret. Backup codes: encrypted by default. OTP: configurable (`"plain"`, `"encrypted"`, `"hashed"`). Uses constant-time comparison for verification. + +2FA can only be enabled for credential (email/password) accounts. + +## Disabling 2FA + +Requires password confirmation. Revokes trusted device records: + +```ts +const disable2FA = async (password: string) => { + const { data, error } = await authClient.twoFactor.disable({ + password + }); +}; +``` + +## Complete Configuration Example + +```ts +import { betterAuth } from 'better-auth'; +import { twoFactor } from 'better-auth/plugins'; +import { sendEmail } from './email'; + +export const auth = betterAuth({ + appName: 'My App', + plugins: [ + twoFactor({ + // TOTP settings + issuer: 'My App', + totpOptions: { + digits: 6, + period: 30 + }, + // OTP settings + otpOptions: { + sendOTP: async ({ user, otp }) => { + await sendEmail({ + to: user.email, + subject: 'Your verification code', + text: `Your code is: ${otp}` + }); + }, + period: 5, + allowedAttempts: 5, + storeOTP: 'encrypted' + }, + // Backup code settings + backupCodeOptions: { + amount: 10, + length: 10, + storeBackupCodes: 'encrypted' + }, + // Session settings + twoFactorCookieMaxAge: 600, // 10 minutes + trustDeviceMaxAge: 30 * 24 * 60 * 60 // 30 days + }) + ] +}); +``` diff --git a/.gitignore b/.gitignore index b2240a9..a122eb5 100644 --- a/.gitignore +++ b/.gitignore @@ -20,6 +20,4 @@ Thumbs.db # Vite vite.config.js.timestamp-* -vite.config.ts.timestamp-* - -/../generated/prisma +vite.config.ts.timestamp-* \ No newline at end of file diff --git a/.prettierrc b/.prettierrc index 8aacc14..075d35f 100644 --- a/.prettierrc +++ b/.prettierrc @@ -4,10 +4,7 @@ "trailingComma": "none", "semi": true, "printWidth": 100, - "plugins": [ - "prettier-plugin-svelte", - "prettier-plugin-tailwindcss" - ], + "plugins": ["prettier-plugin-svelte", "prettier-plugin-tailwindcss"], "overrides": [ { "files": "*.svelte", @@ -17,4 +14,4 @@ } ], "tailwindStylesheet": "./src/routes/layout.css" -} \ No newline at end of file +} diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..b5694ff --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,27 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "name": "Backend (server-side code)", + "type": "node", + "request": "launch", + "runtimeExecutable": "npm", + "runtimeArgs": ["run", "dev"], + "cwd": "${workspaceFolder}", + "console": "integratedTerminal", + "skipFiles": ["/**"], + "autoAttachChildProcesses": true + }, + { + "name": "Frontend (client-side code)", + "type": "chrome", + "request": "launch", + "preLaunchTask": "Start Dev Server", + "url": "http://localhost:5173", + "webRoot": "${workspaceFolder}", + "sourceMapPathOverrides": { + "vite:///src/*": "${webRoot}/src/*" + } + } + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1 @@ +{} diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..b6e7737 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,26 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "Start Dev Server", + "type": "shell", + "command": "npm run dev -- --port 5173 --strictPort", + "isBackground": true, + "problemMatcher": { + "pattern": [ + { + "regexp": "^.*$", + "file": 0, + "location": 0, + "message": 0 + } + ], + "background": { + "activeOnStart": true, + "beginsPattern": "^.*VITE.*v", + "endsPattern": "^.*localhost:.*$" + } + } + } + ] +} diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..45a22ca --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,407 @@ +You're right — I gave you the optimized root content earlier, but I did not provide it cleanly as a single copy/paste artifact. Here it is. + +Save this as: + +```text +AGENTS.md +``` + +at your project root: + +````text +# Rhemawave Portal AI Guide + +## Mission + +You are working on portal.Rhemawavetech.com. + +Act as a senior engineer making complete, production-ready changes. + +Do not stop after analysis. +Do not provide a plan and wait. +Do not describe what should be done instead of doing it. + +When asked to make a change: + +1. Inspect the relevant code. +2. Understand the existing implementation. +3. Make the change. +4. Validate the result. +5. Fix any problems introduced. +6. Report what changed and what was verified. + +A task is incomplete until the implementation is finished and verified. + +--- + +# Working Style + +## Focused Context + +Do not load the entire repository into context. + +Use a focused approach: + +1. Identify relevant files. +2. Read only necessary code. +3. Find existing patterns. +4. Make the smallest correct change. + +Avoid: +- broad rewrites +- unrelated cleanup +- speculative refactors +- introducing unnecessary dependencies + +Prefer: +- small diffs +- existing conventions +- explicit implementations + +--- + +# Development Loop + +Always follow this workflow: + +## 1. Understand + +Before editing: + +- Locate relevant files. +- Inspect current behavior. +- Find similar working examples. +- Identify constraints. + +## 2. Implement + +Make the smallest correct change. + +Follow existing architecture. + +Do not replace working patterns with new abstractions unless required. + +## 3. Verify + +Run appropriate checks: + +```sh +npm run check +npm run lint +npm run test +```` + +Use narrower commands when appropriate. + +## 4. Complete + +If validation fails: + +* Diagnose the failure. +* Fix the issue. +* Run validation again. + +Never finish with known failures. + +--- + +# Project Overview + +Application: + +portal.Rhemawavetech.com + +Stack: + +* SvelteKit 2 +* Svelte 5 +* TypeScript +* Tailwind CSS v4 +* Prisma 7 +* PostgreSQL +* Better Auth +* Vitest +* Playwright + +Package manager: + +npm + +--- + +# Quick Start + +Install: + +```sh +npm install +``` + +Generate types: + +```sh +npm run prepare +``` + +Run development: + +```sh +npm run dev +``` + +Required environment: + +```text +DATABASE_URL +BETTER_AUTH_SECRET +BETTER_AUTH_URL +``` + +--- + +# Architecture Map + +## Routes + +Protected routes: + +```text +(protected)/ +``` + +Require authentication and profile. + +User routes: + +```text +(user)/ +``` + +User-facing functionality. + +Admin routes: + +```text +admin/ +``` + +Require: + +```text +roleId <= 3 +``` + +Roles: + +```text +SUPER = 1 +ADMIN = 2 +STAFF = 3 +USER = 4 +``` + +--- + +# Database + +Prisma generated client: + +```text +src/lib/generated/prisma/ +``` + +Do not import Prisma from: + +```text +node_modules/.prisma/client +``` + +Database singleton: + +```text +src/lib/db.ts +``` + +--- + +# Authentication + +Server: + +```text +src/lib/auth.ts +``` + +Browser: + +```text +src/lib/auth-client.ts +``` + +Session handling: + +```text +src/hooks.server.ts +``` + +--- + +# Admin Architecture + +Admin forms are route-specific. + +Example: + +```text +admin/[model]/ + ModelForm.svelte +``` + +Do not recreate deleted generic components: + +```text +AdminForm.svelte +AdminPage.svelte +``` + +Registry metadata exists for: + +* columns +* searches +* relations + +Forms are manually implemented per route. + +--- + +# Svelte Rules + +This project uses Svelte 5 runes. + +Use: + +```text +$state() +$derived() +$effect() +$props() +``` + +Do not use: + +```text +writable() +derived() +legacy stores +``` + +For Svelte-specific patterns, read: + +```text +docs/ai/svelte-patterns.md +``` + +Only load that file when modifying Svelte components or Svelte logic. + +--- + +# Testing Rules + +Testing uses: + +* Vitest +* Playwright browser testing + +For testing patterns, read: + +```text +docs/ai/testing-patterns.md +``` + +Only load that file when modifying tests. + +--- + +# API Rules + +For API routes, authentication, keys, or integrations, read: + +```text +docs/ai/api.md +``` + +Only load that file when working on API functionality. + +--- + +# Formatting + +Prettier rules: + +* tabs +* single quotes +* no trailing commas +* 80 character print width + +Follow existing formatting. + +--- + +# Important Commands + +Check: + +```sh +npm run check +``` + +Lint: + +```sh +npm run lint +``` + +Format: + +```sh +npm run format +``` + +Tests: + +```sh +npm run test +``` + +Build: + +```sh +npm run build +``` + +--- + +# Completion Standard + +Before claiming a task is complete: + +Confirm: + +1. Code changes are implemented. +2. Relevant tests/checks were run. +3. Failures were fixed. +4. The final response explains: + + * what changed + * files modified + * verification performed + +Do not stop at: + +* "I found the issue" +* "Here is a plan" +* "The next step would be" + +Finish the work. + + diff --git a/AGENTS.md.bak b/AGENTS.md.bak new file mode 100644 index 0000000..4006341 --- /dev/null +++ b/AGENTS.md.bak @@ -0,0 +1,363 @@ +# portal.Rhemawavetech.com + +SvelteKit 2 + Svelte 5 (runes) + Tailwind CSS v4 + Prisma 7 + PostgreSQL + Better-Auth. + +## Quick start + +```sh +npm install # engine-strict=true in .npmrc +npm run prepare # svelte-kit sync (generate types) +npm run dev # vite dev on :5173 +``` + +Requires `.env` with at least `DATABASE_URL`, `BETTER_AUTH_SECRET`, `BETTER_AUTH_URL`. + +## Commands + +| npm run ... | What it does | +| -------------------------- | ------------------------------------------------ | +| `check` | `svelte-kit sync && svelte-check` (typecheck) | +| `lint` | `prettier --check . && eslint .` (order matters) | +| `format` | `prettier --write .` | +| `test` | `vitest --run` (single run) | +| `test:unit` | `vitest` (watch mode) | +| `migrate -- --name ` | Create a Prisma migration | +| `deploy` | Apply pending migrations | +| `build` | Production build (adapter-node) | + +## Testing quirks + +- **Two Vitest projects**: `client` (Playwright/Chromium headless, `src/**/*.svelte.{test,spec}.{js,ts}`) and `server` (node env, everything else — `src/**/*.{test,spec}.{js,ts}` excluding `.svelte.*`). Tests co-located beside source files. +- **`expect: { requireAssertions: true }`** — every test must assert something. No assertions = test fails. +- **All route tests mock `$lib/db`** (Prisma client) and `$lib/auth-client`/`$lib/auth` via `vi.mock()`. Stub factories in `src/lib/test-utils.ts`. +- **No `.env.test`** — mocking `$lib/db` makes real DB unnecessary. +- **Mock `$app/forms`** for any component using `use:enhance` — provide `enhance: () => () => {}` (action → destroy fn). +- **Mock TipTap** for client tests rendering ProclamationForm — the Svelte 5 component mock pattern is a function `($anchor: Element) => { …; $anchor.replaceWith(div); }`. + +## Architecture notes + +- **Route groups**: `(protected)/` requires auth + profile; `(user)/` is user-facing; `admin/` requires roleId <= 3 (STAFF+). +- **Admin forms**: Each route has its own form component (e.g. `ProclamationForm.svelte`, `CategoryForm.svelte`). The generic `AdminForm.svelte` / `AdminPage.svelte` were **deleted**. Registry config (`registry.ts`) still provides metadata, list fields, search fields, relation options, etc., but forms are hand-written per route. +- **Prisma client** generated to `src/lib/generated/prisma/` (not `node_modules/.prisma/client`). Lazy singleton via Proxy in `src/lib/db.ts`. +- **Better-Auth** server instance in `src/lib/auth.ts`, browser client in `src/lib/auth-client.ts`. Session fetched in `src/hooks.server.ts`. +- **Roles**: integer hierarchy (SUPER=1, ADMIN=2, STAFF=3, USER=4). `canAccessAdmin` checks roleId <= 3. +- **Payments are stubbed** (`src/lib/payments.ts` — setTimeout + console.log). +- **API keys**: SHA-256 hashed before storage (`ApiKey` model); only prefix (11 chars) stored for identification. `/api/v1/*` requires `Authorization: Bearer `, except `/api/v1/automations/` (GHL webhook, no API key needed). Rotation: normal (48h grace via `expiresAt`) or emergency (immediate via `revokedAt`). Super-only admin page at `/admin/api-keys`. + +## Formatting conventions + +- Tabs, single quotes, no trailing commas, 100 print width (enforced by Prettier). +- Svelte 5 runes only (`$state`, `$derived`, `$effect`, `$props`). No legacy stores (`writable`, `derived`, etc.). + +--- + +## Svelte 5 Runes Gotchas & Patterns + +### `$state` initialization vs `$effect` sync + +State variables declared with `$state('')` are set once on component mount. To keep them in sync with a changing `$props()` value, use a **separate `$effect`**: + +```svelte + +``` + +This is the **only correct pattern** for form fields that edit an existing record. Do NOT initialize `$state` directly from the prop — that only captures the initial value and won't re-sync when the parent changes the record (e.g. switching from one row to another in a modal). + +### `$effect` ordering matters + +Effects run in declaration order. If you have multiple effects, the first one's writes are applied before the second one runs. This matters for the `dirty` flag: + +```svelte +let dirty = $state(false); + +// Runs first — resets dirty on mount / record change +$effect(() => { + dirty = false; +}); + +// Runs second — syncs field values +$effect(() => { + name = String(record.name ?? ''); + // … +}); +``` + +Both effects run synchronously during mount, so by the time the browser paints, all state is consistent. + +### `bind:value` on `` elements when the state is set from a `$effect`. Svelte 5's select binding does not respond to `$state` changes triggered inside `$effect`. Instead: + +**Use `selected` on ` + {#each options as opt (opt.value)} + + {/each} + +``` + +This pattern applies to ALL `` works fine + +Unlike `` works correctly with `$effect`-driven state. Feel free to use it for text inputs. + +### `$props()` destructuring + +Always destructure `$props()` with defaults: + +```svelte +let { + record = {} as Record, + fieldErrors = {} as Record, + isSuper = false, +}: { record?: Record; … } = $props(); +``` + +The type annotation on the destructuring object is REQUIRED for Svelte 5 to infer prop types. Default values are used when the parent doesn't pass that prop. + +### Component mocking for client tests + +When mocking a Svelte 5 component in `vi.mock`, use a function that takes `($anchor, props)`: + +```ts +vi.mock('$lib/components/tiptap/TipTap.svelte', () => ({ + default: ($anchor: Element, _props: Record) => { + const div = document.createElement('div'); + div.setAttribute('data-testid', 'tiptap-mock'); + $anchor.replaceWith(div); + } +})); +``` + +--- + +## Testing Patterns & Gotchas + +### What tests to write + +For every admin route, write BOTH: + +1. **Server test** (`page.server.spec.ts`): Test the `load` function and all `actions` (upsert, delete). Cover role-based access control (Super vs non-Super content stripping, rejection of unauthorized mutations). Mock `$lib/db` and `$lib/svelte-admin/crud`. + +2. **Client test** (`Component.svelte.spec.ts`): Test the form component rendering in Playwright/Chromium. Cover: + - All fields render + - Pre-fill on edit (name input, select values) + - Conditional field visibility (e.g. content hidden for non-Super) + - Submit button disabled/enabled by dirty state + - No visual regression testing — only functional assertions. + +### Available Playwright/Vitest Browser Locator API + +These methods are available on `page` from `vitest/browser`: + +| Method | Works? | Example | +| ------------------- | ------ | --------------------------------------------- | +| `getByRole` | ✅ | `page.getByRole('textbox', { name: 'Name' })` | +| `getByText` | ✅ | `page.getByText('Content')` | +| `getByPlaceholder` | ✅ | `page.getByPlaceholder('Email Address')` | +| `getByAltText` | ✅ | `page.getByAltText('Sign In with Google')` | +| `getByTestId` | ✅ | `page.getByTestId('tiptap-mock')` | +| `getByLabel` | ❌ | Not available in this version | +| `getByDisplayValue` | ❌ | Not available in this version | + +For label-identified elements, use `getByRole` with `name` option: + +- Text inputs → `getByRole('textbox', { name: /^Name$/ })` +- Selects → `getByRole('combobox', { name: /^Frequency$/ })` +- Buttons → `getByRole('button', { name: 'Save' })` + +**Always use regex `{ name: /^Exact$/ }`** for role queries to avoid strict-mode violations from substring matches (e.g. `'Category'` matching both `'Category'` and `'Sub-Category'`). + +### Querying select values in client tests + +Since `bind:value` on selects doesn't work with `$effect`-driven state, and we use `selected` on `