npm.io
3.2.2 • Published 3d ago

@x12i/memorix-memory

Licence
exellix-license
Version
3.2.2
Deps
9
Size
362 kB
Vulns
0
Weekly
0
SummaryDependencyVersions

@x12i/memorix-memory

Memory collector: pull from external sources (via credentialRef + connectors) and land exact raw as memorix-record/2 with contentType: "raw".

Raw existence never auto-promotes to snapshots — promotion is an explicit pipeline path (map-normalize → validate → identity-dedupe → write-record).

Install

npm install @x12i/memorix-memory@3.0.2
Audience Use this package?
Remote app No — /api/memory
Platform / pipelines Yes (memory-pull step / collector)

What it does

  1. Resolve SourceDefinition + routes from effective metadata
  2. Resolve secrets only via credentialRef (never inline secrets on the API)
  3. Invoke connector: first-party OpX/KnowX via in-process DefinedConnector; every generic connector via FR-040 remote MGC host (hostBaseUrl / MGC_SOURCE_SERVICE_URL) POST /v1/pull (targets: POST /v1/deliver)
  4. landItem / commit-page → draft with exact provider payload in .data + _system.provenance.memory
  5. Write through @x12i/memorix-data writer; update pull run / cursor / quarantine ledgers

Generic providers (e.g. Google Drive, CISA KEV) run only on MGC hosts; Memory never vendors those runtimes or talks to the provider. First-party opx-rest / knowx-* stay in-process. Alignment: memorix-mgc-alignment.md.

Core surface

import {
  createMemoryCollector,
  createMongoMemoryRunStore,
  createStaticCredentialProvider,
  createOpxRestConnector,
} from "@x12i/memorix-memory";

const collector = createMemoryCollector({ /* writer, metadata, credentials, frameworkConnectors */ });
await collector.pull(scope, {
  sourceId: "opx-source",
  mode: "knowledge", // or "context" (+ workRef)
});

HTTP equivalents

Route Role
POST /api/memory/pull Run a pull (first-party in-process or MGC /v1/pull)
GET /api/memory/raw Read landed Memory raw objects
PUT/GET /api/v1/raw-records/… Grant-scoped _raw cache for MGC / MCP
GET /api/memory/sources List sources from metadata
PUT /api/memory/destinations/:id Upsert target destination (alias /api/memory/targets)
POST /api/memory/deliver Deliver via MGC /v1/deliver (alias POST /api/jobs/target-deliveries)
POST /api/memory/target-receipts/… Grant-scoped per-item claim/complete/release ledger
Runs / quarantine / receipts Under /api/memory and operations

Hard rules

  • Connectors must be read-only for pull.
  • Exact provider payload in raw .data — no decoration.
  • Secrets: credentialRef only.

Docs

npm test