74 lines
4.0 KiB
Markdown
74 lines
4.0 KiB
Markdown
# Tasks — `@suaveplan/api-auth-jwt`
|
|
|
|
> Every checkbox MUST reflect work actually done in this change.
|
|
|
|
## 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 (§2.3, §5.2a, §13.4)
|
|
- [x] 1.2 Read `openspec/changes/api-auth/` for upstream contract
|
|
- [x] 1.3 Read `openspec/AGENTS.md` Sections 13 and 14
|
|
- [x] 1.4 Draft `proposal.md`
|
|
- [x] 1.5 Draft `specs/api-auth-jwt/spec.md`
|
|
- [x] 1.6 Every requirement carries `**Verified by:**`
|
|
|
|
## 2. Implementation
|
|
|
|
- [ ] 2.1 Scaffold `packages/api/api-auth-jwt/` (`"version": "0.1.0"`, `"sideEffects": false`, deps: api-auth, api-types, api-worker-rpc, jws, error, zod)
|
|
- [ ] 2.2 `src/options/jwt-session-resolver-options.ts` — Zod schema
|
|
- [ ] 2.3 `src/factory/create-jwt-session-resolver.ts` — direct surface
|
|
- [ ] 2.4 `src/proxy/create-jwt-session-resolver-worker-proxy.ts` — proxy surface
|
|
- [ ] 2.5 `src/jwks/jwks-cache.ts` — TTL + ETag + `kid` miss refresh
|
|
- [ ] 2.6 `src/claim-mapping/default-claim-to-principal.ts` — `claims → Principal`
|
|
- [ ] 2.7 `src/security-scheme/security-scheme-contribution.ts` — OpenAPI securitySchemes block
|
|
- [ ] 2.8 `src/error-codes.ts` — `AUTH_JWT_*` codes via `defineCodes`
|
|
- [ ] 2.9 `src/index.ts` — explicit named re-exports
|
|
|
|
## 3. Tests
|
|
|
|
- [ ] 3.1 `src/factory/create-jwt-session-resolver.test.ts`
|
|
- [ ] 3.2 `src/factory/create-jwt-session-resolver.spec-conformance.test.ts` — `runAuthSessionConformance("jwt-direct", ...)`
|
|
- [ ] 3.3 `src/proxy/create-jwt-session-resolver-worker-proxy.test.ts`
|
|
- [ ] 3.4 `src/proxy/create-jwt-session-resolver-worker-proxy.spec-conformance.test.ts` — `runAuthSessionConformance("jwt-worker-proxy", ...)`
|
|
- [ ] 3.5 `src/jwks/jwks-cache.test.ts`
|
|
- [ ] 3.6 `src/claim-mapping/default-claim-to-principal.test.ts`
|
|
- [ ] 3.7 `src/security-scheme/security-scheme-contribution.test.ts`
|
|
- [ ] 3.8 `tests/integration/integration.test.ts`
|
|
- [ ] 3.9 Every `it(...)` carries `{ timeout: 5000 }` (30000 if genuinely async)
|
|
|
|
## 4. Documentation
|
|
|
|
- [ ] 4.1 Sibling `.md` per implementation `.ts` (≥200 words, basic + advanced)
|
|
- [ ] 4.2 README links co-located `.md` files
|
|
- [ ] 4.3 Document the pair-with-IdP usage pattern (Clerk/Auth0/Cognito)
|
|
|
|
## 5. Pre-archive verification (5-gate triple)
|
|
|
|
- [ ] 5.1 `bun run check` — clean
|
|
- [ ] 5.2 `bunx turbo lint typecheck test --filter=@suaveplan/api-auth-jwt` — green
|
|
- [ ] 5.3 `bunx turbo test:coverage --filter=@suaveplan/api-auth-jwt` — 100/100/100/100
|
|
- [ ] 5.4 `bun scripts/openspec-conformance.ts @suaveplan/api-auth-jwt` — exit 0
|
|
- [ ] 5.5 `bunx turbo build --filter=@suaveplan/api-auth-jwt` — green
|
|
|
|
## 6. Pre-archive 7-row checklist
|
|
|
|
- [ ] 6.1 Generics on `AuthAdapter` signature; `expectTypeOf` assertions on `Principal` projection
|
|
- [ ] 6.2 Zod schema at the `JwtSessionResolverOptions` boundary
|
|
- [ ] 6.3 Every `AUTH_JWT_*` code thrown by at least one production path
|
|
- [ ] 6.4 Strict-mode behaviors (audience/issuer required vs optional) tested both on and off
|
|
- [ ] 6.5 OTel instruments (`api.auth.resolve_duration_ms`, `api.auth.failures_total{reason}`) asserted with in-memory `MeterProvider`
|
|
- [ ] 6.6 JWKS in-flight refresh dedup tested (concurrent `kid` misses → one network fetch)
|
|
- [ ] 6.7 No retroactive tick
|
|
|
|
## 7. Archive
|
|
|
|
- [ ] 7.1 Fold into `openspec/specs/api-auth-jwt/spec.md`
|
|
- [ ] 7.2 Move to `openspec/archive/<yyyy-mm-dd>-api-auth-jwt/`
|
|
- [ ] 7.3 Tick Stage 4 box in umbrella tasks
|
|
- [ ] 7.4 Refresh `MANIFEST.md`
|