Initial Commit
This commit is contained in:
47
openspec/archive/2026-05-26-api-auth-anonymous/proposal.md
Normal file
47
openspec/archive/2026-05-26-api-auth-anonymous/proposal.md
Normal file
@@ -0,0 +1,47 @@
|
||||
# `@suaveplan/api-auth-anonymous` — Null-principal session resolver
|
||||
|
||||
**Package**: `@suaveplan/api-auth-anonymous`
|
||||
**Status**: PROPOSED
|
||||
**Type**: new-package
|
||||
**Stage**: 4 (Base adapters) — see umbrella `openspec/changes/api-plugin-foundation/`
|
||||
|
||||
## Why
|
||||
|
||||
Per design doc §2.3, every API host MUST configure a session resolver — even fully public APIs. `api-auth-anonymous` is the trivial session resolver that always returns `null`. Configuring it explicitly makes the "no auth" choice visible in `host.json` and lets the rest of the host (RBAC gate, error envelope, OpenAPI) operate uniformly: the principal is simply `null`, never undefined.
|
||||
|
||||
Stage 4 invariant: both direct and worker-proxy surfaces ship and pass `runAuthSessionConformance` (§5.2a, §13.4). The proxy is trivial here (no network/state) but its presence keeps the adapter table uniform — every adapter has both surfaces, no exceptions.
|
||||
|
||||
## What changes
|
||||
|
||||
Net-new package depending on `@suaveplan/api-auth`, `@suaveplan/api-types`, `@suaveplan/api-worker-rpc`.
|
||||
|
||||
- ADDED: `createAnonymousSessionResolver()` — direct-surface factory returning an `AuthAdapter` whose `resolveSession` always returns `null`.
|
||||
- ADDED: `createAnonymousSessionResolverWorkerProxy(port)` — proxy-surface factory.
|
||||
- ADDED: `securitySchemeContribution()` — returns an empty OpenAPI `securitySchemes` block. Routes without `publicRoutes` declaration still emit the host's default security entry list (which is empty for anonymous).
|
||||
- ADDED: `AnonymousResolverOptions` — currently empty; reserved for future flags (e.g. `logAnonymousAccess: boolean`).
|
||||
|
||||
## Out of scope
|
||||
|
||||
- Policy on whether a route requires auth — the host enforces `publicRoutes` from each plugin's manifest; this resolver only ever supplies `null`.
|
||||
- Rate limiting based on IP / fingerprint — `api-rate-limit` Stage 8.
|
||||
|
||||
## Source mapping
|
||||
|
||||
Genesis-original. Source of design intent: `docs/superpowers/specs/2026-05-13-api-plugin-foundation-design.md`.
|
||||
|
||||
| Requirement | Design doc section |
|
||||
|---|---|
|
||||
| Always returns null principal | §2.3 (`api-auth-anonymous` bullet) |
|
||||
| Worker-proxy variant required | §5.2a |
|
||||
| Conformance both surfaces | §13.4 |
|
||||
|
||||
## Verification approach
|
||||
|
||||
- `src/factory/create-anonymous-session-resolver.test.ts` — direct surface always returns null.
|
||||
- `src/factory/create-anonymous-session-resolver.spec-conformance.test.ts` — `runAuthSessionConformance("anonymous-direct", ...)` (the suite must accept resolvers that always return null).
|
||||
- `src/proxy/create-anonymous-session-resolver-worker-proxy.test.ts` — proxy unit tests.
|
||||
- `src/proxy/create-anonymous-session-resolver-worker-proxy.spec-conformance.test.ts` — `runAuthSessionConformance("anonymous-worker-proxy", ...)`.
|
||||
|
||||
## Migration impact
|
||||
|
||||
None — additive only.
|
||||
@@ -0,0 +1,52 @@
|
||||
<!-- markdownlint-disable MD024 -->
|
||||
|
||||
# Capability Spec Delta: api-auth-anonymous (api-auth-anonymous)
|
||||
|
||||
**Package**: `@suaveplan/api-auth-anonymous`
|
||||
**Status**: PROPOSED
|
||||
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: resolveSession always returns null
|
||||
|
||||
The package SHALL implement the session-resolver contract such that `resolveSession(request)` returns `null` for every input, synchronously decidable.
|
||||
|
||||
#### Scenario: any request resolves to null
|
||||
|
||||
- **WHEN** `resolveSession(request)` is called with any request shape (Authorization header, cookie, missing entirely)
|
||||
- **THEN** the resolver returns `null` AND no exception is thrown AND no network I/O occurs
|
||||
|
||||
**Verified by:** `src/factory/create-anonymous-session-resolver.test.ts::"resolveSession returns null for every input"`
|
||||
|
||||
---
|
||||
|
||||
### Requirement: Direct and worker-proxy surfaces both pass conformance
|
||||
|
||||
The adapter SHALL pass `runAuthSessionConformance` under BOTH the direct and worker-proxy surfaces. The conformance suite MUST tolerate a resolver that exclusively returns null (the "no auth configured" case is a valid host topology).
|
||||
|
||||
#### Scenario: direct surface conforms
|
||||
|
||||
- **WHEN** `runAuthSessionConformance("anonymous-direct", createAnonymousSessionResolver)` runs
|
||||
- **THEN** every invariant passes
|
||||
|
||||
#### Scenario: worker-proxy surface conforms
|
||||
|
||||
- **WHEN** `runAuthSessionConformance("anonymous-worker-proxy", () => createAnonymousSessionResolverWorkerProxy(channel.port2))` runs over a real `MessageChannel`
|
||||
- **THEN** every invariant passes
|
||||
|
||||
**Verified by:** `src/factory/create-anonymous-session-resolver.spec-conformance.test.ts::"anonymous-direct conforms to AuthSession contract"` AND `src/proxy/create-anonymous-session-resolver-worker-proxy.spec-conformance.test.ts::"anonymous-worker-proxy conforms to AuthSession contract"`
|
||||
|
||||
---
|
||||
|
||||
### Requirement: Empty securitySchemes contribution
|
||||
|
||||
`securitySchemeContribution()` SHALL return an empty `securitySchemes` block. OpenAPI documents assembled from a host using only this resolver MUST emit no `security` entry on routes.
|
||||
|
||||
#### Scenario: contribution is empty
|
||||
|
||||
- **WHEN** `securitySchemeContribution()` is called
|
||||
- **THEN** the returned value is `{ securitySchemes: {} }`
|
||||
|
||||
**Verified by:** `src/security-scheme/security-scheme-contribution.test.ts::"contribution exposes no security schemes"`
|
||||
|
||||
<!-- markdownlint-enable MD024 -->
|
||||
64
openspec/archive/2026-05-26-api-auth-anonymous/tasks.md
Normal file
64
openspec/archive/2026-05-26-api-auth-anonymous/tasks.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# Tasks — `@suaveplan/api-auth-anonymous`
|
||||
|
||||
> 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-anonymous/spec.md`
|
||||
- [x] 1.6 Every requirement carries `**Verified by:**`
|
||||
|
||||
## 2. Implementation
|
||||
|
||||
- [ ] 2.1 Scaffold `packages/api/api-auth-anonymous/` (deps: api-auth, api-types, api-worker-rpc)
|
||||
- [ ] 2.2 `src/factory/create-anonymous-session-resolver.ts` — direct surface
|
||||
- [ ] 2.3 `src/proxy/create-anonymous-session-resolver-worker-proxy.ts` — proxy surface
|
||||
- [ ] 2.4 `src/security-scheme/security-scheme-contribution.ts` — empty OpenAPI block
|
||||
- [ ] 2.5 `src/index.ts` — explicit named re-exports
|
||||
|
||||
## 3. Tests
|
||||
|
||||
- [ ] 3.1 `src/factory/create-anonymous-session-resolver.test.ts`
|
||||
- [ ] 3.2 `src/factory/create-anonymous-session-resolver.spec-conformance.test.ts` — direct surface conformance
|
||||
- [ ] 3.3 `src/proxy/create-anonymous-session-resolver-worker-proxy.test.ts`
|
||||
- [ ] 3.4 `src/proxy/create-anonymous-session-resolver-worker-proxy.spec-conformance.test.ts` — proxy surface conformance
|
||||
- [ ] 3.5 Every `it(...)` carries `{ timeout: 5000 }`
|
||||
|
||||
## 4. Documentation
|
||||
|
||||
- [ ] 4.1 Sibling `.md` per implementation `.ts` (≥200 words, basic + advanced)
|
||||
- [ ] 4.2 README documents this is the default for fully public APIs
|
||||
|
||||
## 5. Pre-archive verification (5-gate triple)
|
||||
|
||||
- [ ] 5.1 `bun run check` — clean
|
||||
- [ ] 5.2 `bunx turbo lint typecheck test --filter=@suaveplan/api-auth-anonymous` — green
|
||||
- [ ] 5.3 `bunx turbo test:coverage --filter=@suaveplan/api-auth-anonymous` — 100/100/100/100
|
||||
- [ ] 5.4 `bun scripts/openspec-conformance.ts @suaveplan/api-auth-anonymous` — exit 0
|
||||
- [ ] 5.5 `bunx turbo build --filter=@suaveplan/api-auth-anonymous` — green
|
||||
|
||||
## 6. Pre-archive 7-row checklist
|
||||
|
||||
- [ ] 6.1 Generics threaded; `expectTypeOf` asserts `resolveSession` returns `Promise<null>`
|
||||
- [ ] 6.2 Zod schemas — N/A (no options)
|
||||
- [ ] 6.3 Error codes — N/A (no failure paths)
|
||||
- [ ] 6.4 Strict-mode — N/A
|
||||
- [ ] 6.5 OTel instruments — N/A (no work performed)
|
||||
- [ ] 6.6 Lifecycle dedup — N/A
|
||||
- [ ] 6.7 No retroactive tick
|
||||
|
||||
## 7. Archive
|
||||
|
||||
- [ ] 7.1 Fold into `openspec/specs/api-auth-anonymous/spec.md`
|
||||
- [ ] 7.2 Move to `openspec/archive/<yyyy-mm-dd>-api-auth-anonymous/`
|
||||
- [ ] 7.3 Tick Stage 4 box in umbrella tasks
|
||||
- [ ] 7.4 Refresh `MANIFEST.md`
|
||||
Reference in New Issue
Block a user