Documentation
¶
Overview ¶
Command harbor-protocol-ts-lockstep emits the committed wire-surface manifest (web/console/src/lib/protocol/wire-manifest.gen.json) from the canonical Harbor Protocol single sources (RFC §5):
- internal/protocol/singlesource.CanonicalWireTypes — the wire-type inventory, rendered field-by-field via reflection over the typeInstanceIndex.
- internal/protocol/methods — the canonical method registry.
- internal/protocol/errors — the canonical error-code set.
- internal/events — the canonical event-type wire strings, read by a textual tree scan (no driver imports — the manifest stays a pure contract reader).
The manifest is the machine-checkable contract the hand-maintained Console TypeScript client is lockstep-gated against: the Go-side generator emits the manifest, a TypeScript-source scan (web/console/scripts/check-protocol-ts-lockstep.mjs) verifies the hand-written interfaces declare every manifest type's fields, and the `make protocol-ts-gen-check` git-diff gate forces a regeneration whenever a Go wire shape changes. The Console TypeScript client is NOT generated from this manifest — emitting the per-domain TypeScript type modules is a deferred future deliverable, and the cmd/harbor-gen-protocol-ts name is reserved for it.
The output is deterministic (sorted map keys, sorted method/error/event sets) so the gate is byte-stable.
Source Files