@x12i/memorix-relationships
v3.1.0
Published
Memorix relationship engine: compile, discover, materialize, verify/rebuild (Phase 7 / G7). The only trusted production relationship-link writer.
Readme
@x12i/memorix-relationships
Trusted relationship engine: compile definitions, discover, materialize, verify, and rebuild four-field links.
This is the only production path that writes relationship links. Remote clients use HTTP; ad-hoc /links mutation is rejected (405).
Install
npm install @x12i/[email protected]| Audience | Use this package? |
|----------|-------------------|
| Remote app | No — /api/relationships |
| Platform / pipelines | Yes |
Core API
import { createRelationshipEngine } from "@x12i/memorix-relationships";
const engine = createRelationshipEngine({ /* store, metadata resolver, data reader */ });
// Dry-run candidates
await engine.discoverAndMaterialize(scope, definitionId, { dryRun: true });
// Persist links
await engine.discoverAndMaterialize(scope, definitionId, { dryRun: false });
await engine.verify(scope, definitionId);
await engine.rebuild(scope, definitionId);Lifecycle:
relationship definition (metadata)
→ discover (candidates, service-held)
→ materialize (four-field links in store)
→ verify / rebuildHard rules
- Links are exactly four fields (
relationshipId,relationshipDefinitionId,fromRecordId,toRecordId). - Never copy related payloads into the source record (
associated*as storage is forbidden). - Neighbor content is read at expand time, not embedded.
Related
| Need | Package |
|------|---------|
| Persistence adapter | @x12i/memorix-relationship-store |
| Compose / expand reads | @x12i/memorix-data |
| Pipeline steps | relationship-discover / relationship-write in @x12i/memorix-pipeline |
Docs
npm test