Skip to main content

Packages

One engine, @oimdb/core, and integrations built on it.

Which package for which task​

You want to…TakeWhere it is documented
hold entities, put them in buckets, derive values, subscribe@oimdb/coreThe model
render that state in React@oimdb/reactReact
render that state with Exodra@oimdb/exodraExodra
keep part of the app in Redux and mirror OIMDB into it, or write back from reducers@oimdb/redux-adapterRedux Adapter
save collections to storage and load them back@oimdb/persist plus one backend: @oimdb/persist-idb, @oimdb/persist-localstorage, @oimdb/persist-async-kv, @oimdb/persist-memory, @oimdb/persist-jsonPersist
fill the store on the server and hand it to the client@oimdb/core aloneServer-side rendering
wire the database into the application and pick its strategies@oimdb/core aloneDependency injection
run every write from an orchestrator and let it decide when frames are delivered@oimdb/core alone, with cnstra calling flush()OIMDB with cnstra
name collections and inspect them while debugging@oimdb/devtoolsbelow
read live browser state from a shell (you or an AI assistant with a terminal)@oimdb/cliits README
let an AI assistant without a shell read live browser state@oimdb/mcpits README
load data asynchronouslynothing extra: await the I/O, then writeStubs
read which entities changed since you last askednothing extra: an effect, a content-change listener, or @oimdb/persistSnapshot Manager

Each integration takes a collection as a pair: the collection service, and the store slot that is the instance.

@oimdb/devtools​

A debug registry: name your store slots and indexes and inspect them at run time. Keep the registrations in *.debug.ts files next to the collections they describe, import them all from one debug.ts that only your debug entry point imports, and build the services it should hear with defaults: OIM_DEV_DEFAULTS; a production build then contains none of it. Its README has the full API. @oimdb/cli and @oimdb/mcp read the same registry.

Stubs​

  • @oimdb/async is deprecated and exports nothing. Do the waiting outside the store: await your network or IndexedDB read, then write the result with collectionService.writeSlotContentByKey(entityStoreSlot, key, entity). A pending request is ordinary state, an entity or a bucket you write when the request starts and again when it settles. OIMDB with cnstra shows the loading-then-data sequence written that way.
  • @oimdb/snapshot-manager exports nothing either. Snapshot Manager says what to use for each of its old jobs.

Installing​

See Installation.