mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-09 13:01:00 +00:00
Full audit of every overlapping claim across the five top-level docs
against the v1.3.2 codebase. Fixes structural drift accumulated since
v1.2:
- README: API envelope was documented as `{ data, error, meta }` but the
actual helpers return `{ data, error }`. Architecture tree was missing
6 src/app/, 4 components/, 8 lib/ subdirectories that landed in
1.2/1.3 (auth, mood, charts, targets, notifications, bugreport,
gamification, settings, ai, feedback, insights, logging, moodlog,
monitoring, …). API Reference grew 4 new sections (Personalization,
Feedback + Tokens, Notifications, Admin) covering ~25 previously
undocumented endpoints. Route count `~60` → `100+`. Achievement count
`30+` → `38+`. i18n keys `1000+` → `1500+` with note about the new
integrity test.
- AGENTS.md: Status `v1.2.0` → `v1.3.2` with the body-composition / SSRF
/ GHCR / pg-boss-drain / blocking-CI / locale-integrity highlights.
Prisma `7.4` → `7.8`. Migrations `0001–0018` → `0001–0022`. Settings
page `13 sections / ~2100 lines` → `8 top-level sections / ~3150
lines` with the actual section IDs. Insights page line estimate
trimmed to `~1750`, section ID `medications` → `meds`.
NotificationChannel / EventType correctly described as `String`
fields (not Prisma enums) sourced from
`src/lib/notifications/types.ts`.
- CONTRIBUTING.md: UI-language statement was inverted ("UI text in
German" → English-default with German user-selectable, plus the
i18n integrity test). Dark-mode-only claim corrected — light/system
toggle exists in the topbar. Node `22+` → `20+` to match the README.
openssl recipe split: POSTGRES_PASSWORD uses base64 24, the three
hex secrets use hex 32. CI check list expanded to the 5-step
pipeline (typecheck, lint, test, format:check, build).
- CLAUDE.md: vitest config path `vitest.config.ts` → `vitest.config.mts`.
Bearer-token hashing labelled `HMAC-SHA256` (keyed by
`API_TOKEN_HMAC_KEY`) instead of plain SHA-256. Removed the
reference to a non-existent `docs/STATUS.md` and the overstated
`docs/{architecture,security,ops,API,ADRs}` directory list — the
long-form end-user docs live at docs.healthlog.dev, only audit notes
are local.
- SECURITY.md: pin example bumped from `:1.2.0` to `:1.3.2`.
Verified against code: 23 Prisma models, all listed endpoints exist,
all package.json versions match, every CHANGELOG v1.3.x claim
(SSRF guard, Withings 77/88 mapping, pg-boss SIGTERM drain, WCAG
44×44 touch targets, rate-limited threshold writes, N+1 fix in
/api/insights/comprehensive) traced to the actual implementation.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
8.3 KiB
8.3 KiB
CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
Project
HealthLog — a personal health-tracking PWA (weight, blood pressure, pulse, mood, medication compliance) with Withings integration, moodLog.app sync, Dracula-themed UI, mobile-first design, offline caching, and doctor report PDF export.
Commands
# Development
pnpm dev # Start dev server (http://localhost:3000)
pnpm build # Production build
pnpm lint # ESLint
pnpm format # Prettier format
pnpm format:check # Prettier check
pnpm typecheck # TypeScript strict check
# Tests
pnpm test # Run all tests (vitest)
pnpm test:watch # Watch mode
# Database
pnpm db:generate # Generate Prisma client
pnpm db:migrate # Create & apply migration (dev)
pnpm db:migrate:deploy # Apply migrations (production)
pnpm db:push # Push schema without migration (prototyping)
pnpm db:studio # Prisma Studio GUI
# Docker
docker compose up -d # Start app + postgres
docker compose logs -f app # Tail app logs
Architecture
- Next.js 16 App Router with TypeScript strict. Pages are RSC by default;
"use client"only for interactivity. - Prisma 7 ORM with PostgreSQL (23 models). Uses
PrismaPgadapter from@prisma/adapter-pg. Client singleton atsrc/lib/db.ts. Generated client atsrc/generated/prisma/client(note the/clientsuffix). Prisma config inprisma.config.ts(not in schema.prisma). - shadcn/ui components (new-york style) in
src/components/ui/. Add new ones viapnpm dlx shadcn@latest add <component>. - Dracula theme via CSS variables in
globals.css. Dark mode is default. Use--dracula-*tokens for chart colors. - TanStack Query for client-side data fetching. Provider in
src/components/providers.tsx. - Zod v4 (
zod/v4) for all input validation (API routes and forms). - API response envelope:
{ data, error, meta }via helpers insrc/lib/api-response.ts. - apiHandler wraps ALL API route handlers (
src/lib/api-handler.ts) — error handling, Wide Event logging, x-request-id propagation. - Structured Logging (Wide Events) in
src/lib/logging/— one JSON event per request/operation viaWideEventBuilder+AsyncLocalStorage. Tail sampling, stdout JSON + optional Loki Push. - Vitest for unit testing. Config in
vitest.config.mts. - pg-boss (PostgreSQL-native) for job queue: medication reminders, insight caching, weekly data backups.
- jsPDF + jspdf-autotable for client-side doctor report PDF generation (
src/lib/doctor-report-pdf.ts). - PWA offline via service worker caching strategies in
public/sw.js(cache-first for static, network-first for pages, network-only for API). - Proxy route protection —
src/proxy.tschecks session cookie, enforces auth on all non-public paths. Next.js 16 uses proxy.ts (not middleware.ts).
Key Conventions
- Default locale is English. All code-level strings in English. UI text via i18n
t()with German + English translations. - Timezone:
Europe/Berlinfor display, UTC in database. - Sensitive data (Withings tokens, API keys, VAPID private keys) encrypted with AES-256-GCM (
src/lib/crypto.ts) before DB storage. - Passkeys are primary auth (SimpleWebAuthn v13). Sessions stored server-side in PostgreSQL.
- All API mutations require authentication. External ingest uses Bearer token (hashed with HMAC-SHA256 keyed by
API_TOKEN_HMAC_KEY). - Rate limiting (in-memory sliding window) on auth and external-facing endpoints.
File Layout
src/app/— pages and API routes (App Router)src/components/ui/— shadcn/ui primitivessrc/components/layout/— shell (sidebar-nav, topbar, mobile-nav, bottom-nav)src/components/medications/— medication form, card, timelinesrc/components/measurements/— measurement form, listsrc/components/mood/— mood form, mood listsrc/components/charts/— Recharts wrapperssrc/lib/logging/— Wide Events structured logging (types, config, event-builder, context, sampler, transports, background)src/lib/api-handler.ts— apiHandler wrapper, requireAuth(), requireAdmin(), HttpErrorsrc/lib/— server utilities (db, crypto, auth, analytics, export, rate-limit, gravatar)src/lib/export.ts— CSV/JSON export formatting (measurements, medications, mood)src/lib/doctor-report-pdf.ts— client-side PDF generation (jsPDF, European medical format)src/lib/withings/— Withings OAuth client and sync servicesrc/lib/notifications/— dispatcher, types, senders (telegram, ntfy, web-push)src/lib/jobs/— pg-boss reminder worker (reminders, insights, data backups)src/lib/analytics/— trend calculations, compliance, correlationssrc/lib/i18n/— i18n context, config, locale detectionsrc/lib/validations/— Zod schemas shared between API + clientsrc/hooks/— React hooks (use-auth)messages/de.json+messages/en.json— i18n translationsprisma/schema.prisma— database schema (23 models)prisma.config.ts— Prisma config (DB URL here, not in schema)public/sw.js— Service worker for Web Push notifications + offline cachingdocs/— long-form audit notes (docs/audit/); end-user docs live in the separate site at https://docs.healthlog.devAGENTS.md— AI agent instructions (Codex, Cursor, etc.)CHANGELOG.md— release notes per semver tag
Important Patterns
- Import Prisma client from
@/generated/prisma/client(not@/generated/prisma) - Prisma 7 does NOT support
url = env("...")in schema.prisma — useprisma.config.ts - Next.js 16 uses
proxy.ts(notmiddleware.ts) — having both causes build error - SimpleWebAuthn v13 has no
@simplewebauthn/server/script/deps— define Transport type inline zxcvbn-typescriptuses default export only (no namedzxcvbnAsync/zxcvbnOptions)- pg-boss v12:
{ PgBoss }named import,localConcurrencyinstead ofteamSize, handler receivesJob<T>[]array - i18n: All UI text uses
useTranslations()hook witht("section.key"). Messages inmessages/en.json(English, default) +messages/de.json(German, user-selectable). Keys missing in the active locale fall back to English; missing from both surfaces the raw key — thesrc/lib/__tests__/i18n*.test.tssuite guards against that. Numbers/dates go throughuseFormatters()— never hand-rollIntl.*with a fixed locale. - Notifications: 3 channels (Telegram, ntfy, Web Push). Dispatcher at
src/lib/notifications/dispatcher.ts. Opt-out model (all events enabled by default) - Gravatar: Server-side SHA-256 hash via
src/lib/gravatar.ts. URL returned in/api/auth/meresponse asgravatarUrlfield - Sidebar: Collapsible (localStorage-persisted). Settings mode with section shortcuts. User section at bottom with three-dot dropdown menu
- ESLint: Strict
react-hooks/set-state-in-effectrule — avoidsetStateinsideuseEffect. Use lazyuseState()initializer for localStorage reads - Proxy route protection:
src/proxy.tscheckshealthlog_sessioncookie; PUBLIC_PATHS array bypasses auth. Security headers (CSP, HSTS, X-Frame-Options) applied to all responses - PWA safe area: Root layout has
viewportFit: "cover". Bottom-nav usespb-[env(safe-area-inset-bottom)]for iOS safe area - Doctor report PDF: Client-side via
src/lib/doctor-report-pdf.ts(jsPDF). Data fromPOST /api/doctor-report. European medical format, German terminology - Achievements: Persistent in
UserAchievementtable. Computed on API call, new unlocks written to DB with stableunlockedAttimestamps - Data backup: pg-boss
data-backupqueue runs weekly (Sundays 03:00), stores JSON inDataBackupmodel - Wide Events / Structured Logging:
apiHandler()wraps all API routes. Useannotate()from@/lib/logging/contextfor business-action annotations. UserequireAuth()/requireAdmin()from@/lib/api-handler(auto-annotates auth). Background jobs usewithBackgroundEvent(). External calls tracked viagetEvent()?.addExternalCall(). Noconsole.login production code — use event annotations instead. Env vars:LOG_LEVEL,LOG_SAMPLE_RATE,LOG_SLOW_THRESHOLD_MS,LOG_INCLUDE_STACK,LOKI_ENDPOINT,LOKI_USERNAME,LOKI_PASSWORD