openloop-protocol

Hub-Edge Protocol

openloop-protocol is OpenLoop's public, dependency-light collaboration protocol package described in ADR-005. The current root API is the Hub-Edge protocol; OpenLoop's internal Agent Adapter Event Protocol remains private to OpenLoop Core.

This package owns only the wire-safe Team Hub ↔ Local Edge collaboration protocol:

• envelopes and discriminated payloads;
• dependency-free runtime decoders;
• declarative payload shape validation for every message family;
• protocol version negotiation;
• canonical JSON serialization and SHA-256 payload hashes;
• redaction helpers;
• golden fixtures and a compatibility matrix.

It intentionally does not import OpenLoop Core, TeamLoop, a Hub database, HTTP server, Agent SDK, UI code, or local runner implementation.

The prerelease tarball builds src to dist/*.js and dist/*.d.ts before packing so downstream Hub/Edge consumers can import the protocol package without transpiling TypeScript from node_modules.

decodeHubEdgeMessage accepts unknown, validates envelope and payload values at runtime, and returns a correlated envelope union. Consumers can narrow on messageType without recreating wire schemas or asserting payload types. The public payload and decoded-envelope types are inferred from the same message definitions used by the runtime validator.