Initial Commit

openspec/archive/2026-05-26-api-openapi-ui-redoc/proposal.md

@@ -0,0 +1,42 @@
+# `@suaveplan/api-openapi-ui-redoc` — ReDoc UI adapter for the `/docs` endpoint
+
+**Package**: `@suaveplan/api-openapi-ui-redoc`
+**Status**: PROPOSED
+**Type**: new-package
+**Stage**: 8 — see umbrella `openspec/changes/api-plugin-foundation/`
+
+## Why
+
+Per design doc §7, ReDoc is the third pluggable UI choice for `/docs`. ReDoc's three-pane layout suits read-heavy API reference sites. The package mirrors the Scalar / Swagger sibling shapes so the host's UI selection logic is uniform.
+
+## What changes
+
+- ADDED: `createRedocUiHandler({ openapiUrl, title, theme, expandResponses })` — returns an HTTP handler serving the ReDoc HTML shell pointing at `openapiUrl`.
+- ADDED: `createPerPluginRedocUiHandler({ openapiUrlForPlugin, plugin })` — for `/docs/{plugin}`.
+- ADDED: `RedocUiOptions` Zod schema (`theme`, `expandResponses`, `hideDownloadButton`, `nativeScrollbars`).
+- ADDED: Asset strategy (cdn / bundled) mirroring the Scalar adapter.
+- ADDED: Error codes (`OPENAPI_UI_REDOC_*`): `ASSETS_MISSING`, `INVALID_OPTIONS`.
+
+## Out of scope
+
+- Authoring OpenAPI documents — that's `api-openapi`.
+- Scalar / Swagger — sibling packages.
+
+## Source mapping
+
+Genesis-original. Source of design intent: `docs/superpowers/specs/2026-05-13-api-plugin-foundation-design.md`.
+
+| Requirement | Design doc section |
+|---|---|
+| Pluggable UI (ReDoc as alternative) | §7 |
+
+## Verification approach
+
+- `src/handler/handler.test.ts` — HTML references `openapiUrl`; `expandResponses` toggles the ReDoc config.
+- `src/per-plugin/per-plugin.test.ts` — per-plugin URL embedded.
+- `src/assets/assets.test.ts` — cdn vs bundled.
+- `tests/dep-graph.test.ts` — runtime deps.
+
+## Migration impact
+
+None — additive only. `api-host` selects this when `host.openapi.ui = "redoc"`.

openspec/archive/2026-05-26-api-openapi-ui-redoc/specs/api-openapi-ui-redoc/spec.md

@@ -0,0 +1,70 @@
+<!-- markdownlint-disable MD024 -->
+
+# Capability Spec Delta: api-openapi-ui-redoc (api-openapi-ui-redoc)
+
+**Package**: `@suaveplan/api-openapi-ui-redoc`
+**Status**: PROPOSED
+
+> Every requirement below carries a `**Verified by:**` line at authoring time.
+
+## ADDED Requirements
+
+### Requirement: ReDoc UI handler renders the host's OpenAPI document
+
+The package SHALL expose `createRedocUiHandler({ openapiUrl, title, theme, expandResponses })` returning an HTTP handler responding with the ReDoc HTML shell pointing at `openapiUrl`.
+
+#### Scenario: handler returns HTML referencing openapiUrl
+
+- WHEN the handler is invoked with `openapiUrl = "/openapi.json"`
+- THEN response is `text/html` AND the body references `/openapi.json`
+
+#### Scenario: expandResponses configured
+
+- WHEN `expandResponses: "200,201"`
+- THEN the embedded ReDoc config expands those response codes by default
+
+**Verified by:** `src/handler/handler.test.ts::"handler returns HTML referencing openapiUrl"` AND `src/handler/handler.test.ts::"expandResponses is embedded in config"`
+
+---
+
+### Requirement: Per-plugin handler points at filtered URL
+
+The package SHALL expose `createPerPluginRedocUiHandler({ openapiUrlForPlugin, plugin })` whose shell references the plugin-filtered URL.
+
+#### Scenario: per-plugin URL embedded
+
+- WHEN the per-plugin handler is invoked
+- THEN the response body references the filtered URL
+
+**Verified by:** `src/per-plugin/per-plugin.test.ts::"per-plugin handler embeds filtered URL"`
+
+---
+
+### Requirement: Options validated by Zod
+
+The package SHALL validate `RedocUiOptions` via a Zod schema. Invalid options raise `OPENAPI_UI_REDOC_INVALID_OPTIONS`.
+
+#### Scenario: invalid option rejected
+
+- WHEN `expandResponses` is set to a non-allowed value
+- THEN handler construction throws `OPENAPI_UI_REDOC_INVALID_OPTIONS`
+
+**Verified by:** `src/options/options.test.ts::"invalid expandResponses rejected"`
+
+---
+
+### Requirement: Asset strategy supports cdn and bundled
+
+The package SHALL resolve the ReDoc runtime asset URL from `host.openapi.uiAssets`. `"cdn"` returns the upstream CDN URL; `"bundled"` returns the embedded path. A missing bundled asset raises `OPENAPI_UI_REDOC_ASSETS_MISSING`.
+
+#### Scenario: cdn mode
+
+- WHEN `uiAssets = "cdn"`
+- THEN the resolved asset URL points at the documented ReDoc CDN
+
+#### Scenario: bundled mode without asset raises
+
+- WHEN `uiAssets = "bundled"` AND the bundled asset is missing
+- THEN handler construction throws `OPENAPI_UI_REDOC_ASSETS_MISSING`
+
+**Verified by:** `src/assets/assets.test.ts::"cdn mode returns CDN URL"` AND `src/assets/assets.test.ts::"bundled mode without asset raises ASSETS_MISSING"`

openspec/archive/2026-05-26-api-openapi-ui-redoc/tasks.md

@@ -0,0 +1,64 @@
+# Tasks — `@suaveplan/api-openapi-ui-redoc`
+
+## 0. Pre-flight (non-negotiable)
+
+- [x] 0.1 Confirm clean working tree
+- [x] 0.2 Worktree accounted for
+- [x] 0.3 MANIFEST.md drift check
+
+## 1. Spec authoring
+
+- [x] 1.1 Read design doc (§7)
+- [x] 1.2 Read `openspec/AGENTS.md` Sections 13 and 14
+- [x] 1.3 Draft `proposal.md`
+- [x] 1.4 Draft `specs/api-openapi-ui-redoc/spec.md`
+- [x] 1.5 Every requirement carries `**Verified by:**`
+
+## 2. Implementation
+
+- [x] 2.1 Scaffold `packages/api-stack/api/api-openapi-ui-redoc/`
+- [x] 2.2 `src/handler/` — `createRedocUiHandler`
+- [x] 2.3 `src/per-plugin/` — `createPerPluginRedocUiHandler`
+- [x] 2.4 `src/options/` — `RedocUiOptions` Zod schema
+- [x] 2.5 `src/assets/` — cdn/bundled/inline resolver
+- [x] 2.6 `src/error-codes/` folder (CLAUDE.md no-flat-modules rule)
+- [x] 2.7 `src/index.ts` — explicit named re-exports + side-effect import
+
+## 3. Tests
+
+- [x] 3.1 `src/handler/handler.test.ts`
+- [x] 3.2 `src/per-plugin/per-plugin.test.ts`
+- [x] 3.3 `src/assets/assets.test.ts`
+- [x] 3.4 `tests/dep-graph.test.ts`
+- [x] 3.5 Every `it(...)` carries `{ timeout: 5000 }`
+
+## 4. Documentation
+
+- [x] 4.1 Sibling `.md` per implementation `.ts`
+- [x] 4.2 `README.md` `## Modules`
+- [x] 4.3 Update `CLAUDE.md` package listing
+
+## 5. Pre-archive verification (the 5-gate triple)
+
+- [x] 5.1 `bun run check`
+- [x] 5.2 `bunx turbo lint typecheck test --filter=@suaveplan/api-openapi-ui-redoc`
+- [x] 5.3 `bunx turbo test:coverage --filter=@suaveplan/api-openapi-ui-redoc` — 100/100/100/100
+- [x] 5.4 `bun scripts/openspec-conformance.ts packages/api-stack/api/api-openapi-ui-redoc`
+- [x] 5.5 `bunx turbo build --filter=@suaveplan/api-openapi-ui-redoc`
+
+## 6. Pre-archive 7-row checklist
+
+- [x] 6.1 Generics threaded for typed options
+- [x] 6.2 Zod schemas wired at host-config ingestion
+- [x] 6.3 Every `OPENAPI_UI_REDOC.*` code thrown by a production path
+- [x] 6.4 Strict-mode: bundled mode without asset raises
+- [x] 6.5 OTel — n/a
+- [x] 6.6 Lifecycle dedup — handler is idempotent
+- [x] 6.7 No retroactive tick
+
+## 7. Archive
+
+- [x] 7.1 Fold spec delta into `openspec/specs/api-openapi-ui-redoc/spec.md`
+- [x] 7.2 Move folder to archive
+- [x] 7.3 Tick `8.9` in umbrella tasks
+- [x] 7.4 Refresh `MANIFEST.md`