Licence
exellix-license
Version
3.1.1
Deps
1
Size
166 kB
Vulns
0
Weekly
0
@x12i/memorix-pipeline-runtime
Org-scoped operational persistence helpers used by the pipeline stack: artifacts (DataRef), receipts, DLQ, execution leases, checkpoints, schedule leases, retention sweeps, identity merge helpers, and repeated-work stores (Work definitions, evaluations, batches, queue settings).
This is a ledger/storage package, not the DAG engine. The engine lives in @x12i/memorix-pipeline.
Install
npm install @x12i/memorix-pipeline-runtime@3.0.2
| Audience | Use this package? |
|---|---|
| Remote app | No — /api/pipelines + /api/operations (+ future /api/jobs/v1) |
| Platform / pipeline package | Yes (Mongo or in-memory stores) |
What it stores
| Kind | Role |
|---|---|
| Artifacts | Large step outputs behind DataRef / artifactId |
| Receipts | Write acknowledgements |
| DLQ | Failed items for replay policy |
| Leases / checkpoints | Step lease + cursor state for durable execution |
| Schedule leases | Scheduler ownership |
| Work definitions | Continuous repeated-work configs (runtime-only; never Magit) |
| Work evaluations | Evaluation observability (matched/eligible/excluded) |
| Batches | Frozen cohorts of pipeline runs |
| Queue settings | Pause/resume + concurrency defaults |
Lease layering
| Layer | Store | Key |
|---|---|---|
| Run admission | PipelineRun.admission on pipeline run ledger |
run document |
| Step execution | LeaseStore |
orgId:runId:stepId |
| Schedule fire | ScheduleLeaseStore |
orgId:scheduleId:dueAt |
Core API
import {
createMongoOperationalStores,
createMemoryOperationalStores,
ensureOperationalIndexes,
COLLECTION_NAMES,
redactSensitive,
deriveCanonicalRecordId,
mergeRecords,
sweepRetentionClasses,
} from "@x12i/memorix-pipeline-runtime";
| Export | Role |
|---|---|
createMongoOperationalStores / createMemoryOperationalStores |
Store bundle (OperationalStores) |
ensureOperationalIndexes / COLLECTION_NAMES |
Mongo layout |
redactSensitive |
Scrub sensitive values in logs/exports |
deriveCanonicalRecordId / mergeRecords / batchMerge |
Identity policy helpers |
sweepRetentionClass(es) |
Retention class cleanup |
How it fits
memorix-pipeline (engine + admission + Work evaluator)
→ run / attempt ledger (pipeline package)
→ work / batch / evaluation / settings (this package)
→ artifacts / DataRef (this package + pipeline ledger)
memorix-service /api/pipelines · /api/operations · /api/jobs/v1 (P3)
Docs
- Ebook: Building Pipelines
- Jobs reuse plan:
.operational/jobs-memorix-reuse-plan.md - Jobs API FR:
.operational/jobs-v1-api-FR.md - Mutation capture note (journey):
../memorix-pipeline/docs/mutation-refs-capture.md - Hub: https://docs.memorix.x12i.com
npm test