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,52 @@
# `@suaveplan/api-auth-static-principal` — Fixed-Principal session resolver for tests
**Package**: `@suaveplan/api-auth-static-principal`
**Status**: PROPOSED
**Type**: new-package
**Stage**: 5 (Testing kit + conformance suites) — see umbrella `openspec/changes/api-plugin-foundation/`
## Why
Per design doc §13.2, the testing kit needs an auth adapter that supplies a fixed `Principal` without any token decoding. The §13.2 example uses it directly:
```ts
adapters: {
"auth.session": { kind: "static-principal", principal: { id: "u1", scopes: ["billing:write"], tenantId: "acme" } },
}
```
Tests exercise the whole pipeline — RBAC gate, tenant resolver chain reading `principal.tenantId`, tenant-scoped DB — with a deterministic principal carried verbatim in config. No mocks, no token signing, no JWKS setup.
## What changes
Net-new package depending on `@suaveplan/api-auth` (contract + `./testing` conformance), `@suaveplan/api-types`, `@suaveplan/error`, `zod`.
- ADDED: `createStaticPrincipalResolver(opts)` — factory returning an `AuthAdapter` whose `resolveSession()` always returns `opts.principal` (a single fixed `Principal`). Optional `nullForPaths?: string[]` makes the resolver return `null` for matching request paths (test public-route behaviour without rewiring the whole adapter chain).
- ADDED: `StaticPrincipalResolverOptions` — Zod schema validating the `Principal` shape (`id`, `scopes`, `tenantId?`, `claims?`) and the optional `nullForPaths` glob list.
- ADDED: `securitySchemeContribution()` — returns an empty `securitySchemes` block (no auth flows to document for test use).
- ADDED: `AUTH_STATIC_PRINCIPAL_*` error codes (`AUTH_STATIC_PRINCIPAL_INVALID_OPTIONS`).
- ADDED: Registered in `@suaveplan/api-host/testing`'s adapter table as the `{ kind: "static-principal", principal: ... }` shorthand.
## Out of scope
- Multiple Principals selected by token / header — for that, write a custom resolver or compose two `static-principal` resolvers behind a chain.
- Worker-proxy surface — Stage 5 in-memory adapters are direct-only (cf. `api-router-in-memory`).
## Source mapping
Genesis-original. Source of design intent: `docs/superpowers/specs/2026-05-13-api-plugin-foundation-design.md`.
| Requirement | Design doc section |
|---|---|
| Fixed Principal config in test host | §13.2 |
| Registered in `api-host/testing` adapter table | §15 Stage 5 |
## Verification approach
- `src/factory/create-static-principal-resolver.test.ts` — resolves to the configured Principal; null for matching path patterns; deep equality (not reference equality) on the returned Principal.
- `src/factory/create-static-principal-resolver.spec-conformance.test.ts` — `runAuthSessionConformance("static-principal-direct", ...)`.
- `tests/integration/integration.test.ts` — booted by `createTestHost`'s default adapter table.
## Migration impact
None — additive only.

View File

@@ -0,0 +1,77 @@
<!-- markdownlint-disable MD024 -->
# Capability Spec Delta: api-auth-static-principal (api-auth-static-principal)
**Package**: `@suaveplan/api-auth-static-principal`
**Status**: PROPOSED
## ADDED Requirements
### Requirement: resolveSession returns the configured Principal verbatim
The package SHALL return the exact `Principal` from `options.principal` on every `resolveSession()` call, regardless of request shape. The returned Principal MUST deep-equal the configured one (no mutation, no reference-leak across calls).
#### Scenario: every request resolves to the configured Principal
- **WHEN** the adapter is configured with `principal: { id: "u1", scopes: ["x:write"], tenantId: "acme" }` AND two distinct requests are processed
- **THEN** both `resolveSession()` calls return Principals that deep-equal the configured one
#### Scenario: returned Principal is not the same reference each call
- **WHEN** two `resolveSession()` calls are made
- **THEN** the returned objects are deep-equal AND callers cannot mutate one and affect the other (defensive clone OR documented frozen reference — pin one)
**Verified by:** `src/factory/create-static-principal-resolver.test.ts::"every request resolves to the configured Principal"` AND `src/factory/create-static-principal-resolver.test.ts::"returned Principal is isolated across calls"`
---
### Requirement: nullForPaths overrides specific routes
When `options.nullForPaths` is set, `resolveSession()` SHALL return `null` for requests whose path matches any entry (exact match or glob). Used to test `publicRoutes` behaviour without changing adapter wiring.
#### Scenario: matching path returns null
- **WHEN** `nullForPaths: ["/webhooks/*"]` is configured AND the request path is `/webhooks/stripe`
- **THEN** `resolveSession()` returns `null`
#### Scenario: non-matching path returns the Principal
- **WHEN** `nullForPaths: ["/webhooks/*"]` is configured AND the request path is `/billing/invoices`
- **THEN** `resolveSession()` returns the configured Principal
**Verified by:** `src/factory/create-static-principal-resolver.test.ts::"matching path in nullForPaths returns null"` AND `src/factory/create-static-principal-resolver.test.ts::"non-matching path returns the configured Principal"`
---
### Requirement: Conforms to AuthSession contract
#### Scenario: conformance suite passes
- **WHEN** `runAuthSessionConformance("static-principal-direct", () => createStaticPrincipalResolver({ principal: P }))` runs
- **THEN** every invariant passes
**Verified by:** `src/factory/create-static-principal-resolver.spec-conformance.test.ts::"static-principal-direct conforms to AuthSession contract"`
---
### Requirement: Options Zod-validated
#### Scenario: missing principal.id throws
- **WHEN** `createStaticPrincipalResolver({ principal: { scopes: [], claims: {} } as never })`
- **THEN** a `SuaveplanError` with code `AUTH_STATIC_PRINCIPAL_INVALID_OPTIONS` is thrown synchronously
**Verified by:** `src/options/static-principal-resolver-options.test.ts::"throws when principal.id is missing"`
---
### Requirement: Registered in `api-host/testing` adapter table
#### Scenario: createTestHost resolves the kind sentinel
- **WHEN** `createTestHost({ adapters: { "auth.session": { kind: "static-principal", principal: P } } })`
- **THEN** the resulting `host.auth` is an instance produced by this factory
**Verified by:** `tests/integration/integration.test.ts::"createTestHost resolves kind:\"static-principal\" to this adapter"`
<!-- markdownlint-enable MD024 -->

View File

@@ -0,0 +1,65 @@
# Tasks — `@suaveplan/api-auth-static-principal`
> Every checkbox MUST reflect work actually done in this change.
## 0. Pre-flight (non-negotiable)
- [x] 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)
- [x] 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.
- [x] 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 (§13.2, §15 Stage 5)
- [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-static-principal/spec.md`
- [x] 1.6 Every requirement carries `**Verified by:**`
## 2. Implementation
- [x] 2.1 Scaffold `packages/api/api-auth-static-principal/` (deps: api-auth, api-types, error, zod)
- [x] 2.2 `src/options/static-principal-resolver-options.ts` — Zod schema
- [x] 2.3 `src/factory/create-static-principal-resolver.ts` — direct surface
- [x] 2.4 `src/security-scheme/security-scheme-contribution.ts` — empty block
- [x] 2.5 `src/error-codes.ts` — `AUTH_STATIC_PRINCIPAL_*` codes via `defineCodes`
- [x] 2.6 `src/index.ts` — explicit named re-exports
- [ ] 2.7 Register this adapter in `@suaveplan/api-host/testing`'s adapter table under `kind: "static-principal"` — BLOCKED: `api-host/testing` is currently the Stage-2 `STAGE_2_RESERVED` placeholder. Wired when Stage-5 `createTestHost` lands; documented in README "Stage-5 wiring (forward-looking)".
## 3. Tests
- [x] 3.1 `src/factory/create-static-principal-resolver.test.ts`
- [x] 3.2 `src/factory/create-static-principal-resolver.spec-conformance.test.ts` — conformance
- [ ] 3.3 `tests/integration/integration.test.ts` — via `createTestHost` — BLOCKED on task 2.7. Conformance + package tests cover the resolver behaviour in full; the createTestHost integration lands with the Stage-5 host surface.
- [x] 3.4 Every `it(...)` carries `{ timeout: 5000 }`
## 4. Documentation
- [x] 4.1 Sibling `.md` per implementation `.ts`
- [x] 4.2 README copies the §13.2 example verbatim
## 5. Pre-archive verification (5-gate triple)
- [x] 5.1 `bun run check` — clean
- [x] 5.2 `bunx turbo lint typecheck test --filter=@suaveplan/api-auth-static-principal` — green
- [x] 5.3 `bunx turbo test:coverage --filter=@suaveplan/api-auth-static-principal` — 100/100/100/100
- [x] 5.4 `bun scripts/openspec-conformance.ts @suaveplan/api-auth-static-principal` — exit 0
- [x] 5.5 `bunx turbo build --filter=@suaveplan/api-auth-static-principal` — green
## 6. Pre-archive 7-row checklist
- [x] 6.1 `expectTypeOf` asserts `resolveSession` returns the exact configured Principal type
- [x] 6.2 Zod schema validates the Principal shape
- [x] 6.3 Every `AUTH_STATIC_PRINCIPAL_*` code thrown by at least one production path
- [x] 6.4 Strict-mode (`nullForPaths` set vs unset) tested both ways
- [x] 6.5 OTel instruments emitted (same set as other auth adapters) asserted with in-memory `MeterProvider`
- [x] 6.6 Lifecycle dedup — N/A (no state)
- [x] 6.7 No retroactive tick
## 7. Archive
- [x] 7.1 Fold into `openspec/specs/api-auth-static-principal/spec.md`
- [x] 7.2 Move to `openspec/archive/<yyyy-mm-dd>-api-auth-static-principal/`
- [x] 7.3 Tick Stage 5 box in umbrella tasks
- [x] 7.4 Refresh `MANIFEST.md`