Initial Commit

This commit is contained in:
2026-05-27 23:29:53 +01:00
commit fbc70f96e6
10000 changed files with 1102152 additions and 0 deletions

View File

@@ -0,0 +1,68 @@
# Tasks — `@suaveplan/api-audit-file`
## 0. Pre-flight (non-negotiable)
- [ ] 0.1 Confirm clean working tree (`git status` reports nothing) and no in-flight worktrees with uncommitted work (`git worktree list` then `git status` in each)
- [ ] 0.2 If any worktrees exist under `.claude/worktrees/`, account for each one: still-active agent, work-pending-merge, or stale-and-prune. Stale worktrees MUST be removed (`git worktree remove`) before opening a new one — code that has been lost twice on main is the failure mode this guards against.
- [ ] 0.3 Confirm the package set in `MANIFEST.md` matches `find packages -maxdepth 3 -name package.json` count. Drift here means a prior change archived without regenerating the manifest.
## 1. Spec authoring
- [x] 1.1 Read design doc (§12.5)
- [x] 1.2 Read `openspec/AGENTS.md` Sections 13 and 14
- [x] 1.3 Draft `proposal.md`
- [x] 1.4 Draft `specs/api-audit-file/spec.md`
- [x] 1.5 Every requirement carries `**Verified by:**`
## 2. Implementation
- [ ] 2.1 Scaffold `packages/api/api-audit-file/`
- [ ] 2.2 `src/sink/` — `createFileAuditSink`, append/strict-sync writer
- [ ] 2.3 `src/rotation/` — size + time rotation
- [ ] 2.4 `src/retention/` — `maxFiles` eviction
- [ ] 2.5 `src/schema/` — `AuditRecord` Zod schema (shared shape with `api-audit-stdout`)
- [ ] 2.6 `src/hmac/` — HMAC-SHA-256 over canonical bytes
- [ ] 2.7 `src/error-codes.ts`
- [ ] 2.8 `src/instruments/` — records_total, dropped_total, rotation_evicted_total
- [ ] 2.9 `src/index.ts` — explicit named re-exports
## 3. Tests
- [ ] 3.1 `src/sink/sink.test.ts`
- [ ] 3.2 `src/sink/sink.spec-conformance.test.ts`
- [ ] 3.3 `src/rotation/rotation.test.ts`
- [ ] 3.4 `src/retention/retention.test.ts`
- [ ] 3.5 `src/hmac/hmac.test.ts`
- [ ] 3.6 `tests/dep-graph.test.ts`
- [ ] 3.7 Every `it(...)` carries `{ timeout: 5000 }` (30000 for write-heavy tests)
## 4. Documentation
- [ ] 4.1 Sibling `.md` per implementation `.ts`
- [ ] 4.2 `README.md` `## Modules`
- [ ] 4.3 Update `CLAUDE.md` package listing
## 5. Pre-archive verification (the 5-gate triple)
- [ ] 5.1 `bun run check`
- [ ] 5.2 `bunx turbo lint typecheck test --filter=@suaveplan/api-audit-file`
- [ ] 5.3 `bunx turbo test:coverage --filter=@suaveplan/api-audit-file` — 100/100/100/100
- [ ] 5.4 `bun scripts/openspec-conformance.ts @suaveplan/api-audit-file`
- [ ] 5.5 `bunx turbo build --filter=@suaveplan/api-audit-file`
## 6. Pre-archive 7-row checklist
- [ ] 6.1 Generics threaded; shared `AuditSink` typing parity with stdout
- [ ] 6.2 Zod schemas wired at record-write boundary
- [ ] 6.3 Every `AUDIT_FILE_*` code thrown by a production path
- [ ] 6.4 Strict-mode: rotation under load is correct; drops observable
- [ ] 6.5 OTel counters asserted with real `MeterProvider`
- [ ] 6.6 Lifecycle dedup — `dispose()` flushes and is idempotent
- [ ] 6.7 No retroactive tick
## 7. Archive
- [ ] 7.1 Fold spec delta into `openspec/specs/api-audit-file/spec.md`
- [ ] 7.2 Move folder to archive
- [ ] 7.3 Tick `8.11` in umbrella tasks
- [ ] 7.4 Refresh `MANIFEST.md`