waykeep-contract

The integration contract for Cairn — types and constants only, zero dependencies.

This package defines the surfaces a client adapter or external integration builds against:

• Client identity — the client enumeration and per-client capabilities.
• Vocabulary — memory kinds, context modes, and user intents stored in rows and crossing process boundaries.
• Hook events — the normalized, discriminated-union hook event payloads.
• Routes — the hook-socket route classification.
• Memory paths — the memory-path grammar.
• Round-trip format — the portable export/import record format.
• Client adapter — the adapter registration and lifecycle interfaces.

Install

npm install waykeep-contract

Usage

import type { ClientAdapterLifecycle } from 'waykeep-contract';
import { CONTEXT_MODES, INTENTS } from 'waykeep-contract';

Stability

Everything exported is frozen under an additive-stability guarantee: values may be added, never changed or removed within a major version, and consumers must tolerate unknown values. Versions before 1.0.0 may still see breaking changes.

License

MIT. The contract is intentionally permissive so adapters and integrations can build against Cairn without restriction; the Cairn runtime itself (cairn-memory) is licensed under the Elastic License 2.0.