Schemas for the whole v1 surface: 38 methods, 9 events, 25 named types and the
JSON-RPC envelope, with x-privileged / x-transports / x-deadlineMs / x-errors
annotations that both generators emit as data rather than prose.
Four generators over one IR (contracts/codegen/schema_ir.py), so the C++ structs,
the TypeScript types and the OpenRPC document cannot disagree about what the
contract says:
gen_cpp.py -> core/generated/velox_proto.{hpp,cpp}
gen_ts.py -> extension/src/shared/protocol/
gen_openrpc.py -> contracts/openrpc.json
gen_cpp_conformance.py -> tests/conformance/cpp/fixture_dispatcher.hpp
Inbound parsing never throws: parse<T>() returns std::expected<T, ParseError> and
nlohmann's throwing ADL from_json is deliberately not emitted. Schema constraints
(minimum, maxLength, pattern, ...) become real runtime checks in both languages —
the daemon does not trust the extension and the extension does not trust the
daemon.
59 golden fixtures: a success case per method, 12 error cases, 9 events. Replayed
by tests/conformance/ against both the generated C++ and a live server over both
transports. tools/mockd serves the same fixtures with unhappy-path flags so the
GUI and EXT lanes never wait for veloxd.
run.sh also proves capture.offer fails open: with a daemon answering slower than
750 ms the client gives up and lets Firefox take the download.
core/generated/ is libveloxproto, a separate target from libveloxcore, which
still never sees JSON — see docs/adr/0009.
Co-Authored-By: Claude Opus 5 <[email protected]>
Claude-Session: https://claude.ai/code/session_012fgjnqFCS5h5L7gZTZo3rV
112 lines
2.5 KiB
JSON
112 lines
2.5 KiB
JSON
{
|
|
"name": "category.list \u2014 the five built-in categories",
|
|
"description": "Read-only and available over both transports: the extension's default-category picker needs it.",
|
|
"request": {
|
|
"jsonrpc": "2.0",
|
|
"id": 30,
|
|
"method": "category.list",
|
|
"params": {}
|
|
},
|
|
"response": {
|
|
"jsonrpc": "2.0",
|
|
"id": 30,
|
|
"result": {
|
|
"items": [
|
|
{
|
|
"categoryId": "compressed",
|
|
"name": "Compressed",
|
|
"saveDir": "/home/sami/Downloads/Compressed",
|
|
"extensions": [
|
|
"zip",
|
|
"tar",
|
|
"gz",
|
|
"xz",
|
|
"zst",
|
|
"7z",
|
|
"rar"
|
|
],
|
|
"mimeTypes": [
|
|
"application/zip"
|
|
],
|
|
"builtin": true,
|
|
"sortOrder": 0
|
|
},
|
|
{
|
|
"categoryId": "documents",
|
|
"name": "Documents",
|
|
"saveDir": "/home/sami/Downloads/Documents",
|
|
"extensions": [
|
|
"pdf",
|
|
"epub",
|
|
"odt",
|
|
"docx"
|
|
],
|
|
"mimeTypes": [
|
|
"application/pdf"
|
|
],
|
|
"builtin": true,
|
|
"sortOrder": 1
|
|
},
|
|
{
|
|
"categoryId": "music",
|
|
"name": "Music",
|
|
"saveDir": "/home/sami/Downloads/Music",
|
|
"extensions": [
|
|
"mp3",
|
|
"flac",
|
|
"ogg",
|
|
"opus",
|
|
"wav"
|
|
],
|
|
"mimeTypes": [
|
|
"audio/flac"
|
|
],
|
|
"builtin": true,
|
|
"sortOrder": 2
|
|
},
|
|
{
|
|
"categoryId": "programs",
|
|
"name": "Programs",
|
|
"saveDir": "/home/sami/Downloads/Programs",
|
|
"extensions": [
|
|
"exe",
|
|
"msi",
|
|
"deb",
|
|
"rpm",
|
|
"appimage",
|
|
"iso",
|
|
"dmg"
|
|
],
|
|
"mimeTypes": [
|
|
"application/x-iso9660-image"
|
|
],
|
|
"builtin": true,
|
|
"sortOrder": 3
|
|
},
|
|
{
|
|
"categoryId": "video",
|
|
"name": "Video",
|
|
"saveDir": "/home/sami/Downloads/Video",
|
|
"extensions": [
|
|
"mkv",
|
|
"mp4",
|
|
"avi",
|
|
"webm",
|
|
"mov"
|
|
],
|
|
"mimeTypes": [
|
|
"video/mp4",
|
|
"video/x-matroska"
|
|
],
|
|
"builtin": true,
|
|
"sortOrder": 4
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"assertions": [
|
|
"built-in categories always exist and cannot be removed",
|
|
"extensions are lowercase and carry no leading dot"
|
|
]
|
|
}
|