Initial Commit

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

@@ -0,0 +1,44 @@
+# `@suaveplan/api-openapi-ui-scalar` — Scalar UI adapter for the `/docs` endpoint
+
+**Package**: `@suaveplan/api-openapi-ui-scalar`
+**Status**: PROPOSED
+**Type**: new-package
+**Stage**: 8 — see umbrella `openspec/changes/api-plugin-foundation/`
+
+## Why
+
+Per design doc §7 the default `/docs` UI is Scalar — modern, fast, low-bundle, supports OpenAPI 3.1 natively. Wrapping it in its own package keeps the surface clean: operators that prefer Swagger or ReDoc swap the package, not the host config logic.
+
+## What changes
+
+- ADDED: `createScalarUiHandler({ openapiUrl, theme, title })` — returns an HTTP handler that serves the Scalar HTML shell pointing at the host's `/openapi.json` URL. Configurable theme / title / default-open-section / search.
+- ADDED: Per-plugin variant `createPerPluginScalarUiHandler({ openapiUrlForPlugin, plugin })` — used by the host to mount `/docs/{plugin}`.
+- ADDED: `ScalarUiOptions` Zod schema — validates host config when this UI is selected as `host.openapi.ui = "scalar"`.
+- ADDED: A static-asset strategy — Scalar's runtime bundle is shipped CDN-or-bundled per `host.openapi.uiAssets` (`"cdn" | "bundled"`); bundled mode embeds the asset under `dist/assets/` for air-gapped hosts.
+- ADDED: Error codes (`OPENAPI_UI_SCALAR_*`): `ASSETS_MISSING`, `INVALID_OPTIONS`.
+
+## Out of scope
+
+- Modifying Scalar itself — this is a thin shell.
+- Authoring OpenAPI documents — that's `api-openapi`.
+- Swagger or ReDoc — 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 |
+|---|---|
+| Default `/docs` UI is Scalar | §7 |
+| Pluggable UI (`api-openapi-ui-{scalar,swagger,redoc}`) | §7 |
+
+## Verification approach
+
+- `src/handler/handler.test.ts` — handler returns HTML with the right Scalar bootstrap config; `openapiUrl` is embedded; CSP-friendly nonce supported.
+- `src/per-plugin/per-plugin.test.ts` — per-plugin variant points at `/openapi.json?plugin=<name>` (or the host-configured filter URL).
+- `src/assets/assets.test.ts` — `"cdn"` vs `"bundled"` modes resolve the right asset URL; missing bundled asset raises `OPENAPI_UI_SCALAR_ASSETS_MISSING`.
+- `tests/dep-graph.test.ts` — runtime deps include `api-types`, `error`, `zod`, the Scalar runtime.
+
+## Migration impact
+
+None — additive only. `api-host` selects this when `host.openapi.ui = "scalar"`.

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

@@ -0,0 +1,65 @@
+<!-- markdownlint-disable MD024 -->
+
+# Capability Spec Delta: api-openapi-ui-scalar (api-openapi-ui-scalar)
+
+**Package**: `@suaveplan/api-openapi-ui-scalar`
+**Status**: PROPOSED
+
+> Every requirement below carries a `**Verified by:**` line at authoring time.
+
+## ADDED Requirements
+
+### Requirement: Scalar UI handler renders the host's OpenAPI document
+
+The package SHALL expose `createScalarUiHandler({ openapiUrl, theme, title })` returning an HTTP handler that responds with the Scalar HTML shell. The shell MUST reference `openapiUrl` as its document source.
+
+#### Scenario: handler returns HTML pointing at openapiUrl
+
+- WHEN the handler is invoked with `openapiUrl = "/openapi.json"`
+- THEN the response Content-Type is `text/html` AND the body references `/openapi.json` exactly once in the Scalar configuration block
+
+**Verified by:** `src/handler/handler.test.ts::"handler returns HTML referencing openapiUrl"`
+
+---
+
+### Requirement: Per-plugin handler points at filtered URL
+
+The package SHALL expose `createPerPluginScalarUiHandler({ openapiUrlForPlugin, plugin })` whose shell references the plugin-filtered URL.
+
+#### Scenario: per-plugin handler uses filtered URL
+
+- WHEN `createPerPluginScalarUiHandler({ openapiUrlForPlugin: "/openapi.json?plugin=billing", plugin: "billing" })` is invoked
+- THEN the response body references that filtered URL
+
+**Verified by:** `src/per-plugin/per-plugin.test.ts::"per-plugin handler embeds filtered URL"`
+
+---
+
+### Requirement: Host config options validated by Zod
+
+The package SHALL validate `ScalarUiOptions` via a Zod schema. Invalid configuration raises `OPENAPI_UI_SCALAR_INVALID_OPTIONS` at host boot before the handler is registered.
+
+#### Scenario: invalid options rejected at boot
+
+- WHEN host config sets `theme` to a non-allowed value
+- THEN handler construction throws `OPENAPI_UI_SCALAR_INVALID_OPTIONS`
+
+**Verified by:** `src/options/options.test.ts::"invalid theme is rejected by schema"`
+
+---
+
+### Requirement: Asset strategy supports cdn and bundled modes
+
+The package SHALL resolve the Scalar runtime asset URL from `host.openapi.uiAssets`. `"cdn"` returns the upstream CDN URL; `"bundled"` returns the path to the embedded asset under `dist/assets/`. A missing bundled asset raises `OPENAPI_UI_SCALAR_ASSETS_MISSING`.
+
+#### Scenario: cdn mode returns CDN URL
+
+- WHEN `uiAssets = "cdn"`
+- THEN the resolved asset URL points at the documented Scalar CDN
+
+#### Scenario: bundled mode requires file present
+
+- WHEN `uiAssets = "bundled"` AND the bundled asset is missing from `dist/assets/`
+- THEN handler construction throws `OPENAPI_UI_SCALAR_ASSETS_MISSING`
+
+**Verified by:** `src/assets/assets.test.ts::"cdn mode returns documented CDN URL"` AND `src/assets/assets.test.ts::"bundled mode without asset raises ASSETS_MISSING"`

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

@@ -0,0 +1,64 @@
+# Tasks — `@suaveplan/api-openapi-ui-scalar`
+
+## 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 (§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-scalar/spec.md`
+- [x] 1.5 Every requirement carries `**Verified by:**`
+
+## 2. Implementation
+
+- [x] 2.1 Scaffold `packages/api/api-openapi-ui-scalar/`
+- [x] 2.2 `src/handler/` — `createScalarUiHandler`
+- [x] 2.3 `src/per-plugin/` — `createPerPluginScalarUiHandler`
+- [x] 2.4 `src/options/` — `ScalarUiOptions` Zod schema
+- [x] 2.5 `src/assets/` — cdn/bundled resolver
+- [x] 2.6 `src/error-codes.ts`
+- [x] 2.7 `src/index.ts` — explicit named re-exports
+
+## 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-scalar`
+- [x] 5.3 `bunx turbo test:coverage --filter=@suaveplan/api-openapi-ui-scalar` — 100/100/100/100
+- [x] 5.4 `bun scripts/openspec-conformance.ts @suaveplan/api-openapi-ui-scalar`
+- [x] 5.5 `bunx turbo build --filter=@suaveplan/api-openapi-ui-scalar`
+
+## 6. Pre-archive 7-row checklist
+
+- [x] 6.1 Generics threaded where typed options are used
+- [x] 6.2 Zod schemas wired at host-config ingestion boundary
+- [x] 6.3 Every `OPENAPI_UI_SCALAR_*` code thrown by a production path
+- [x] 6.4 Strict-mode: bundled mode without asset file raises, never falls back silently
+- [x] 6.5 OTel — n/a (handler stays passive); doc-fetch counter optional
+- [x] 6.6 Lifecycle dedup — handler is idempotent across requests
+- [x] 6.7 No retroactive tick
+
+## 7. Archive
+
+- [x] 7.1 Fold spec delta into `openspec/specs/api-openapi-ui-scalar/spec.md`
+- [x] 7.2 Move folder to archive
+- [x] 7.3 Tick `8.7` in umbrella tasks
+- [x] 7.4 Refresh `MANIFEST.md`