@sqlite-sync/cloudflare 0.4.0 → 0.4.2

package/README.md

@@ -0,0 +1,58 @@
+# @sqlite-sync/cloudflare
+
+Cloudflare backend utilities for [sqlite-sync](https://github.com/krolebord-dev/sqlite-sync) — a local-first SQLite sync engine for web apps, with reactive queries, offline persistence, and CRDT-based replication.
+
+This package provides a Durable Object adapter and execution helpers for running the sync backend on Cloudflare, so clients built with [`@sqlite-sync/core`](https://www.npmjs.com/package/@sqlite-sync/core) can sync CRDT event batches with a remote server.
+
+## Install
+
+```bash
+pnpm add @sqlite-sync/cloudflare
+```
+
+## Quick start
+
+```ts
+// event-log-server.ts
+import { durableObjectAdapter, type RemoteHandler } from "@sqlite-sync/cloudflare";
+import { type Connection, routePartykitRequest, Server } from "partyserver";
+import { syncDbSchema } from "../src/db-schema";
+
+export class EventLogServer extends Server<Env> {
+  private remoteHandler!: RemoteHandler;
+
+  onStart() {
+    const { remoteHandler } = durableObjectAdapter.createCrdtStorage({
+      storage: this.ctx.storage,
+      nodeId: this.ctx.id.toString(),
+      syncDbSchema,
+      crdtEventsTable: "crdt_events",
+      batchSize: 100,
+      broadcastPayload: (payload) => this.broadcast(payload),
+    });
+    this.remoteHandler = remoteHandler;
+  }
+
+  onMessage(connection: Connection, message: string) {
+    const result = this.remoteHandler.handleMessage(message);
+    if (result.success) {
+      connection.send(result.payload);
+    }
+  }
+}
+
+export default {
+  fetch: (request: Request, env: Env) =>
+    routePartykitRequest(request, env).then(
+      (res) => res || new Response("Not Found", { status: 404 }),
+    ),
+} satisfies ExportedHandler<Env>;
+```
+
+## Documentation
+
+See the [full documentation](https://github.com/krolebord-dev/sqlite-sync/blob/main/docs.md) and the [project README](https://github.com/krolebord-dev/sqlite-sync) for how sync works and client setup.
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sqlite-sync/cloudflare",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "Cloudflare utilities for @sqlite-sync/core",
   "type": "module",
   "license": "MIT",
@@ -30,7 +30,7 @@
     "dist"
   ],
   "dependencies": {
-    "@sqlite-sync/core": "0.4.0"
+    "@sqlite-sync/core": "0.4.2"
   },
   "peerDependencies": {
     "@cloudflare/workers-types": "^4.0.0",