Adapters

Capability model

Memorie doesn't have one monolithic "storage adapter" interface. Each concern is its own interface in @memorie/storage:

• MemoryStore (required — the canonical store)
• VersionStore, ProvenanceStore, ConflictStore
• VectorStore, SearchStore, GraphStore, CacheStore, BlobStore

A single adapter package may implement one or several. Nothing requires implementing all of them.

Implemented in this repo

The engine wires CacheStore in as a real cache-aside layer, not just a configuration flag: engine.get() checks the cache before the canonical MemoryStore and populates it on a miss; update()/delete()/every evolution-pipeline write invalidates the corresponding entry rather than ever writing a possibly-stale value back into the cache (see packages/core/test/cache.test.ts, and "Never allow stale cache state to overwrite newer canonical state" in the original design brief).

Writing a custom adapter

Implement whichever interfaces you need:

import type { MemoryStore } from "@memorie/storage";
import type { Memory, ListOptions, CountOptions } from "@memorie/types";
 
export class MyMemoryStore implements MemoryStore {
  async create(memory: Memory): Promise<Memory> { /* ... */ }
  async get(id: string): Promise<Memory | null> { /* ... */ }
  async update(id: string, patch: Partial<Memory>, options?: { expectedVersion?: number }): Promise<Memory> { /* ... */ }
  async delete(id: string): Promise<void> { /* ... */ }
  async list(options?: ListOptions): Promise<Memory[]> { /* ... */ }
  async count(options?: CountOptions): Promise<number> { /* ... */ }
}

Then verify it against the contract suite:

import { runMemoryStoreContractTests } from "@memorie/storage/contract-tests";
import { MyMemoryStore } from "../src/my-memory-store.js";
 
runMemoryStoreContractTests("MyMemoryStore", () => new MyMemoryStore());

Contract suites exist for every capability implemented so far — runMemoryStoreContractTests, runSearchStoreContractTests, runVectorStoreContractTests, runConflictStoreContractTests, runGraphStoreContractTests, runCacheStoreContractTests (all exported from @memorie/storage/contract-tests). This is exactly how every adapter in this repo is verified — e.g. packages/storage-postgres/test/postgres-store.test.ts and packages/cache-redis/test/redis-cache-store.test.ts — every implemented adapter passes the same suite (spec section 57).

Planned adapters (not yet built)

MongoDB, MySQL (storage); Qdrant, Weaviate, Pinecone, Milvus, LanceDB (real vector databases — @memorie/vector-memory is a brute-force in-process reference implementation, not one of these); Elasticsearch, OpenSearch (search); Neo4j, ArangoDB (real graph databases — @memorie/storage-memory's InMemoryGraphStore is the reference implementation, not one of these); filesystem/S3 (blob). None of these exist yet in this repo.

MongoDB in particular could not be added in this environment: it isn't available through the Ubuntu package repositories this sandbox has network access to (its official apt repo isn't on the allowlist), and per the "no fake implementations" rule, an adapter isn't added here without being verified against a live instance of the thing it adapts — the same standard @memorie/storage-postgres and @memorie/cache-redis were held to.

When an adapter is added, it will (a) pass the relevant contract test suite against a live instance, (b) be documented here with any capability caveats, and (c) be marked experimental in its package.json description if it hasn't had real integration testing.