@miadi/tide-contract
v0.1.3
Published
Schema-first Tide API contract shared by Miadi and the IronSilk tide runtime.
Downloads
624
Readme
@miadi/tide-contract
Schema-first contract for the Tide operator cockpit boundary.
This package is the shared covenant between:
- the IronSilk
tideruntime, - the
@miadi/tideTypeScript client, - the
/api/tide/*Next.js routes, - and the cockpit UI at
/tide.
Current shape
schema/tide-api.schema.jsonis the planned source of truth.src/index.tscarries hand-written TypeScript types for this scaffold.- Runtime identity constants are exported from
src/index.tsand mirrored in the schemax-tidemetadata:tide,MIADI_HOME,~/.miadi/navigator, andmiadi.tide.daemon.v2. - Future work should generate the TypeScript types from the schema and validate IronSilk runtime payloads with Python
jsonschema.
Drift posture
The intended CI shape is:
- Generate TypeScript types from
schema/tide-api.schema.json. - Compare generated output against committed types.
- Validate runtime fixture JSON from IronSilk.
- Fail when the contract, client, routes, and runtime drift.
Ref: jgwill/Miadi#378
