@openlatch/client-schemas
v0.1.14
Published
OpenLatch client wire-format JSON Schemas — canonical contract for events exchanged between openlatch-client and openlatch-platform
Maintainers
Readme
@openlatch/client-schemas
Canonical JSON Schemas for the openlatch-client wire format. This package is the source of truth for the contract between openlatch-client (Rust) and openlatch-platform (Python + React).
Usage
const { schemasPath, loadAll, load } = require("@openlatch/client-schemas");
schemasPath(); // absolute path to the schemas/ directory
loadAll(); // { enums, "event-envelope", ..., all parsed }
load("event-envelope"); // parsed JSON Schema for one fileContents
| File | Purpose |
|---|---|
| enums.schema.json | AgentType, HookEventType, Verdict |
| event-envelope.schema.json | EventEnvelope wire-format |
| verdict-response.schema.json | VerdictResponse returned to agent hooks |
| cloud-ingestion-request.schema.json | CloudIngestionRequest sent to platform |
| cloud-ingestion-response.schema.json | CloudIngestionResponse from platform |
| auth-me-response.schema.json | AuthMeResponse for /api/v1/users/me |
Version is synchronized with the openlatch-client crate — every published version corresponds to the binary release of the same version.
Breaking Changes
Breaking schema changes require a major version bump. Consumers pinning an exact version will not be silently broken. See the openlatch-client CHANGELOG for what changed.
