viteboard 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## 0.2.1
+
+### Added
+
+- Export selected board regions as PDF, JPEG, or SVG; export Markdown documents and directories as PDF.
+- Discover capability branches as portable Agent Skills, including a live OpenCode HTTP catalog and supporting files.
+- Receive API change notifications over SSE and refresh affected views, trees, and search roots.
+- Run the packaged application from the CLI using the same Vite-hosted API as development mode.
+- Run API regression tests with `npm test`.
+
+### Improved
+
+- Serialize API writes and deletes per target; accept `expectedRevision: null` for create-only writes and preserve revisions through UI autosave.
+- Reject docs-root filesystem paths that follow symlinks, and preserve existing docs-root IDs across upgrades.
+- Bound and scope capability indexing; cache metadata briefly and read support-file contents on demand.
+- Batch SSE notifications without a resetting debounce and replace image-export animation-frame polling with load-completion waiters.
+- Bound canvas export dimensions and pixels, include rotated board element bounds, and wait for images and fonts before rendering.
+
+### Notes
+
+- Direct filesystem edits do not produce SSE notifications; clients must refresh or fetch current content.
+- PDF export requires a Chromium-compatible browser on the machine running ViteBoard.
+- SVG board exports embed a raster image rather than editable vector paths.
+- The API rejects symlink components even when a symlink points back inside a docs root.

package/README.md

@@ -58,6 +58,8 @@ title: System Architecture
 ```
 ````
 
+Select a board region to embed it in a document or export it as PDF, JPEG, or SVG. The HTTP API also supports full-board and document PDF exports. Export responses are returned as bytes; ViteBoard does not choose a destination on your machine.
+
 ### Capability Specs
 
 Structured markdown documents with YAML frontmatter (`title`, `summary`, `tags`). Designed for building AI prompts -- add specs to a cart and copy them as a combined prompt.
@@ -126,6 +128,7 @@ npm run dev
 |---------|-------------|
 | `npm run dev` | Start development server |
 | `npm run build` | Type-check and bundle to `dist/` |
+| `npm test` | Run API regression tests with Node's test runner |
 | `npm run preview` | Preview the production build |
 | `npm start` | Run via the CLI entry point |
 
@@ -165,21 +168,33 @@ ViteBoard exposes a local REST API at `/__api/` during development:
 | Endpoint | Method | Description |
 |----------|--------|-------------|
 | `/workspace` | GET | List all projects and their docs roots |
+| `/events` | GET | Stream workspace, file, board, and asset change notifications (SSE) |
 | `/workspace/pick-project` | POST | Open native folder picker to add a project |
 | `/workspace/project` | DELETE | Remove a project from workspace |
 | `/tree` | GET | Get file tree for a docs root |
 | `/project-tree` | GET | Get full directory tree for a project |
+| `/capabilities` | GET | Discover capabilities and their portable Agent Skill metadata |
+| `/capability` | GET | Read one capability's rules, generated `SKILL.md`, and supporting-file URLs |
+| `/skills/catalog/index.json` | GET | OpenCode-compatible live HTTP skill catalog |
 | `/file` | GET/PUT/PATCH/DELETE | Read, write, rename, or delete files |
 | `/directory` | PUT | Create a directory |
 | `/board` | GET/PUT/DELETE | Read, write, or delete board documents |
 | `/asset` | GET/POST | Serve or upload assets |
+| `/export/document/pdf` | POST | Render a Markdown document or directory as PDF bytes |
+| `/export/board` | POST | Render a board region as PDF, JPEG, or SVG bytes |
+
+File operations are scoped to registered docs roots and reject symlink paths as well as paths outside the root. Writes can include an `expectedRevision`; use `null` for create-only writes and the revision returned by a read for updates. API mutations publish Server-Sent Events at `/events`; connected UIs refresh affected views, while serialized revision checks protect edits from overwriting newer API writes. Changes made directly on disk do not emit notifications.
 
-All file operations are scoped to registered docs roots and reject paths that escape the root directory.
+Capability branches are exposed as standard [Agent Skills](https://agentskills.io): `/__api/capabilities` lists them, `/__api/capability` returns their rules and skill content, and `/__api/skills/catalog/` is a live OpenCode catalog. The same generated `SKILL.md` can be installed under Codex's `.agents/skills/` or Claude Code's `.claude/skills/` with the branch's supporting files.
+
+Machine clients can discover the HTTP authoring contract at `/viteboard-guide.md` and the agent workflow at `/viteboard-skill.md`. Document and board exports return bytes; the client saves them to its own requested path. ViteBoard does not write to the agent's filesystem. Board SVG output contains a raster image in an SVG wrapper, not editable vector paths.
 
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines.
 
+See [CHANGELOG.md](CHANGELOG.md) for the 0.2.1 release notes.
+
 ## License
 
 [MIT](LICENSE)