samiandClaude Opus 5
53421d6cb8
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
83 lines
2.1 KiB
JSON
83 lines
2.1 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"$id": "https://velox.dev/schema/methods/media.addVariant.schema.json",
|
|
"title": "media.addVariant",
|
|
"description": "Turn one enumerated variant into a task. The daemon fetches the segments in parallel and muxes them with ffmpeg; the result is an ordinary task that appears in the list like any other download. Refused with -32602 when the variant is DRM-protected.",
|
|
"x-privileged": false,
|
|
"x-transports": [
|
|
"uds",
|
|
"ws"
|
|
],
|
|
"x-deadlineMs": 30000,
|
|
"x-errors": [
|
|
-32011,
|
|
-32602,
|
|
-32013
|
|
],
|
|
"x-wsRestrictions": [
|
|
"Same saveDir restriction as download.add."
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"params": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"description": "spec carries the same destination and queueing fields as download.add; its url is ignored because the manifest and variant determine the source.",
|
|
"required": [
|
|
"manifestUrl",
|
|
"variantId"
|
|
],
|
|
"properties": {
|
|
"manifestUrl": {
|
|
"type": "string",
|
|
"format": "uri"
|
|
},
|
|
"variantId": {
|
|
"type": "string"
|
|
},
|
|
"audioVariantId": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"description": "For DASH and HLS renditions where audio is a separate track to be muxed in."
|
|
},
|
|
"spec": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "https://velox.dev/schema/types/DownloadSpec.schema.json"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"result": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"taskId",
|
|
"state"
|
|
],
|
|
"properties": {
|
|
"taskId": {
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"state": {
|
|
"$ref": "https://velox.dev/schema/types/TaskState.schema.json"
|
|
},
|
|
"estimatedBytes": {
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
],
|
|
"minimum": 0
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|