@orkestrel/database

One typed database API for keyed rows, fluent queries, cursors, and whole-store transactions, running unchanged over an in-memory map, a JSON file, SQLite, or IndexedDB.

Declare your tables with the createDatabase function, hold each TableInterface it hands back, and reach rows by key or through the fluent query() builder. TableInterface.cursor() opens the CursorInterface contract for serial bulk mutation. Built on @orkestrel/contract for validation and @orkestrel/emitter for the observation surface, reusing both directly. Part of the @orkestrel line.

Install

npm install @orkestrel/database

Requirements

• Node.js >= 22.12.0, matching the package engine declaration
• The ./server SQLite driver additionally requires a Node.js release that provides node:sqlite
• Core is ESM; the ./server subpath ships dual ESM+CJS builds; ./browser is ESM-only

Status

Pre-release: the core engine and the memory, JSON file, SQLite, and IndexedDB drivers are all implemented and tested, but the public API is still unstable and may change without notice. See guides/database.md for the full documented surface.

Package

Published as three environment-scoped entry points per the exports field in package.json: . (the shared, environment-agnostic core engine plus the in-memory driver), ./server (adds the JSON file and SQLite drivers), and ./browser (adds the IndexedDB driver). Core and ./server ship dual ESM+CJS builds; ./browser is ESM-only.

The server and browser drivers use the declared @orkestrel/sqlite and @orkestrel/indexeddb package ranges. Wrapper upgrades are deliberate: update the declared range, refresh the lockfile, run the full package gates, and publish Database only after its wrapper dependencies are available.

License

MIT © Orkestrel — see LICENSE.