Lunora Durable Objects: ShardDO (SQLite, OCC, hibernated WebSocket subscriptions) and SessionDO
[![typescript-image][typescript-badge]][typescript-url]
[![FSL-1.1-Apache-2.0 licence][license-badge]][license]
[![npm version][npm-version-badge]][npm-version]
[![npm downloads][npm-downloads-badge]][npm-downloads]
[![PRs Welcome][prs-welcome-badge]][prs-welcome]
---
Daniel Bannert's open source work is supported by the community on GitHub Sponsors
---
The Durable Object base classes for Lunora. `ShardDO` is a SQLite-backed shard with optimistic concurrency, the WebSocket Hibernation API, and a live subscription registry; `SessionDO` pins auth sessions. Subclass these from a Worker that uses [`@lunora/runtime`](https://www.npmjs.com/package/@lunora/runtime). It also ships the `createShardCtxDb` adapter and `runShardMigrations` helper that generated functions build on.
Part of the [Lunora](https://github.com/anolilab/lunora) framework — a type-safe, real-time backend on Cloudflare Workers + Durable Objects with a Vite-first DX.
## Install
```sh
npm install @lunora/do
```
```sh
yarn add @lunora/do
```
```sh
pnpm add @lunora/do
```
## Usage
```ts
import { createShardCtxDb, runShardMigrations, ShardDO } from "@lunora/do";
import schema from "../lunora/schema";
export class MyShard extends ShardDO {
private migrated = false;
public override async handleRpc(functionPath: string, args: unknown) {
if (!this.migrated) {
runShardMigrations(this.sql, schema);
this.migrated = true;
}
const db = createShardCtxDb({
broadcast: (delta) => this.broadcastDelta(delta),
schema,
sql: this.sql,
});
// dispatch functionPath + args into your generated function registry...
}
}
```
> This README covers the basics. For the full API, options, and guides, see the **[documentation](https://lunora.sh/docs/api/do)**.
## Related
- [`@lunora/runtime`](https://www.npmjs.com/package/@lunora/runtime) — the Worker entry that routes RPC and WebSocket traffic into these Durable Objects.
- [`@lunora/d1`](https://www.npmjs.com/package/@lunora/d1) — backs `.global()` tables, which `ShardDO` skips.
- [`@lunora/server`](https://www.npmjs.com/package/@lunora/server) — defines the schema `runShardMigrations` and `createShardCtxDb` consume.
## Supported Node.js Versions
Libraries in this ecosystem make the best effort to track [Node.js' release schedule](https://github.com/nodejs/release#release-schedule).
Here's [a post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a).
## Contributing
If you would like to help take a look at the [list of issues](https://github.com/anolilab/lunora/issues) and check our [Contributing](https://github.com/anolilab/lunora/blob/alpha/.github/CONTRIBUTING.md) guidelines.
> **Note:** please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
## Credits
- [Daniel Bannert](https://github.com/prisis)
- [All Contributors](https://github.com/anolilab/lunora/graphs/contributors)
## Made with ❤️ at Anolilab
This is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. [Anolilab](https://www.anolilab.com/open-source) is a Development and AI Studio. Contact us at [hello@anolilab.com](mailto:hello@anolilab.com) if you need any help with these technologies or just want to say hi!
## License
The Lunora do package is open-sourced software licensed under the [FSL-1.1-Apache-2.0][license].
[license-badge]: https://img.shields.io/badge/license-FSL--1.1--Apache--2.0-blue.svg?style=for-the-badge
[license]: https://github.com/anolilab/lunora/blob/alpha/LICENSE.md
[npm-version-badge]: https://img.shields.io/npm/v/@lunora/do?style=for-the-badge
[npm-version]: https://www.npmjs.com/package/@lunora/do
[npm-downloads-badge]: https://img.shields.io/npm/dm/@lunora/do?style=for-the-badge
[npm-downloads]: https://www.npmjs.com/package/@lunora/do
[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
[prs-welcome]: https://github.com/anolilab/lunora/blob/alpha/.github/CONTRIBUTING.md
[typescript-badge]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
[typescript-url]: https://www.typescriptlang.org/