Skip to content

Declaration coverage and open contracts

This index separates the current contract from SDK features and unfinished proposals. A field being accepted by an SDK does not extend a host profile or weaken a refusal below. Where a complete portable schema is deferred, do not invent another declaration file to work around it. The future declaration still belongs in realm.ts.

Declaration Normative destination and current boundary
Source and imports Source selection and definition evaluation; legacy loading remains supported. Enforcement gaps are stated there.
Metadata, profile and language Realm metadata; complete exports and retry semantics and target-contract negotiation remain unspecified. Realm, module, capture and installation identities are distinct; see glossary.
Handlers and schemas Handlers and the schema profile. Standard Schema adapters and inferred types are SDK behavior. Only the evaluated supported JSON Schema reaches the host; optional-output null tolerance does not apply to inputs.
Dependencies Dependencies, including sources, methods, state and explicit batch limits of evidence. Bundled npm requirements have legacy-only declaration status.
Types and properties Declaring types, including visibility and property validation. Complete population, method/retrieval defaults, examples/perspective selection, value enumeration and cardinality interactions remain unspecified. Existing lifecycle, spine and hub semantics are not removed because an SDK omits their fields.
Producers and joins Captured producers, conventional producers and Virtual Cypher. persistMinted remains refused at validation/install. An SDK accepting it does not permit persistence of minted anchors. Exhaustive nested-field/default tables and SDK coverage of query inputs, per-rule producer selection and paging remain deferred.
APIs and credentials APIs, credentials, GraphQL and hosted API operations. Public reads use auth: "none". The current captured profile uses JSON documents/responses and host-owned User-Agent. YAML API documents, additional codecs/raw responses and media negotiation require a later profile; the NDJSON section remains a proposal.
Channels and events Channels, sources/consumers/triggers and publication. Conventional event and channel forms remain governed by the main specification.
Actions, goals and webhooks Captured goals and the conventional main specification remain distinct. Spec-required goal inputs and webhook fields remain required even if an SDK makes them optional. Complete conventional OAuth, LLM-option and webhook field mappings are deferred. Retired filesystem secret sources must not be recommended; use the host’s credential binding.
Lenses, focuses and agents Captured lenses use handlers; conventional query and procedural/module lenses retain their separate forms in the main specification. vc is an SDK formatting helper, not permission to replace procedural source with a graph query. Conventional focus null/default, builtin categories and skills follow that specification, even where SDK types are narrower. Agent-scope questions explicitly marked open there remain open, not portable defaults.
Views views declares a captured list of named queries; queries.views instead references admitted views and does not declare them. Existing node/tabular, materialization and TTL semantics are in Views and Virtual Cypher. Parameter-choice coercion, audience, data-contract modes and whole-list refusal scope need a complete portable contract; SDK transformations are not normative.
Skills and model Shipped skills, model call and hosted model capability. Full skill frontmatter/reference traversal and digest-format rules remain deferred.
Apps and write proposals Apps, write proposals; the host rechecks captured identity and grants before returning results or accepting effects.
Cross-realm composition Graph boundaries. from.realm is reserved and explicitly refused today. Future consent, version lookup, variants and policy-required provenance remain possible.

The complete field-by-field conformance fixture suite remains future work. The worked composition examples and dependency declarations are authoring examples, not evidence that every host implements these rules. A host must publish its supported profile and report unsupported behavior rather than claiming it ran successfully.