@x12i/memorix-relationships

@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/memorix-relationships@3.0.2

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 / rebuild

Hard 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

Docs

• documentation/hard-rules.md
• Ebook: Relationships & Memory
• Hub: https://docs.memorix.x12i.com

npm test