@adea-ai/contracts
v5.1.1
Published
Runtime-independent service boundary between Adea and the Control Plane: canonical identifiers, envelopes, Control API schemas, pagination, and versioning.
Maintainers
Readme
@control-plane/contracts
The publishable, runtime-independent service boundary between Adea and the Control Plane. Adea supplies authorized product intent and workspace identity; the Control Plane applies execution policy and owns runtime semantics.
The package depends only on Zod and builds without Control Plane domain, database, application, workflow, or adapter packages.
What's inside
- Canonical identifiers: opaque, prefix-qualified identifiers (
req_,wsp_,exe_, …: a three-letter prefix and 26 Crockford base32 characters) with validation schemas inIdentifierSchemas. Consumers may validate and compare them but must not derive database keys, timestamps, routing decisions, or vendor-native identifiers from their contents. - Control API schemas: request/response contracts for the Control API.
- Envelopes: standardized request/response wrappers with authentication and versioning metadata.
- Pagination, versioning, and memory-writeback contracts.
- Fixtures: deterministic test fixtures for consumers.
Install
bun add @adea-ai/contractsUsage
import { IdentifierSchemas, PageSchema, ReadRequestEnvelopeSchema } from '@adea-ai/contracts'See the Control API reference for the full contract reference, including the identifier prefix table.
Device sync compaction
DeviceSyncCheckpoint*, DeviceSyncRegisterCheckpoint* and DeviceSyncAck*
schemas describe log/checkpoint, log/checkpoint/register and log/ack.
DeviceSyncLogRequestSchema takes an optional readerKeyId, which identifies
the reader for acknowledgements and does not page. New error codes are
SYNC_LOG_COMPACTED, SYNC_LOG_TRUNCATED, SYNC_CHECKPOINT_CONFLICT,
SYNC_CHECKPOINT_INVALID and SYNC_AUTHOR_NOT_PRIMARY.
Model funding display
ModelSelectionFunding{Request,Response,View}Schema and ModelFundingOwnerSchema
export the additive model-funding-display/v1 disclosure contract. The request
uses model-selection.funding.get and requires workspace/caller plus accepted
execution, attempt and immutable selection reference/revision. Ready responses
include explicit recorded payer metadata; blocked responses contain only the
binding and a bounded reason code. This is display data, never admission, a
credential or spending authority. Existing model connection DTOs remain unchanged.
License
Apache-2.0
Published build compatibility
Contracts preserve comments in their emitted JavaScript and declarations. The
package overrides the root removeComments optimization so published
declarations keep their public documentation. Other packages retain the root optimization, and the unchanged
repository distribution ceiling still applies.
src/declaration-emit.test.ts compiles an isolated public contract through both
configurations and checks the exact declaration bytes: contracts retain public
documentation while the root configuration strips it. Complete release payload
qualification additionally compares the packed source files against the exact
registry archive; this test does not substitute for that byte check.
