@taladb/next 0.9.3 → 0.9.4

package/dist/server.d.mts

@@ -1,5 +1,156 @@
 import { TalaDB } from 'taladb';
 
+/**
+ * Server helpers for coverage-first replication.
+ *
+ * Implements the two endpoints a client needs to build a **trustworthy** local
+ * replica of a table:
+ *
+ * - `GET  ?page=&limit=&snapshot=` — the bootstrap walk
+ * - `GET  ?since=<cursor>`         — the delta feed
+ *
+ * Framework-neutral: it takes a `Request` and returns a `Response`, so it drops
+ * into a Next route handler, a Remix loader, a Hono route, or an Express adapter.
+ *
+ * ## Why the snapshot matters more than it looks
+ *
+ * The obvious way to build a replica is to walk `?page=1,2,3…` and stop. It is
+ * also **wrong on live data**, and wrong in a way nothing detects.
+ *
+ * Fetch page 1. A row gets deleted. Every later row shifts up one. Fetch page 2 at
+ * offset 100 — but the row that *was* at offset 100 is now at 99, which you already
+ * passed. It is never fetched. The walk completes, the client marks the collection
+ * complete, and from then on every query is served locally from a replica with a
+ * silent hole in it. No error, no warning, just a product that quietly doesn't
+ * exist for that user until the next full rebuild.
+ *
+ * A snapshot token fixes it: the client echoes it back on every page, and the
+ * server answers each page from the *same logical view* of the table. On Postgres
+ * this is a monotonic revision column and a `rev <= :snapshot` predicate — no
+ * long-lived transaction required.
+ *
+ * An origin that cannot do this is still usable, but the client caps its coverage
+ * at `best-effort` and keeps serving reads from the network, because it cannot
+ * prove the replica is whole. That is the honest outcome, and it is why
+ * {@link createReplicationHandlers} pushes you toward supporting it.
+ */
+/** A row as your database returns it. Must carry a stable primary key. */
+type Row = Record<string, unknown>;
+interface BootstrapArgs {
+    /** Offset (or opaque page token) to resume from. `null` on the first page. */
+    page: string | number | null;
+    /** Rows requested. Already clamped to `maxLimit`. */
+    limit: number;
+    /**
+     * The snapshot to read from — `null` on the first page, when you should *issue*
+     * one. Every later page echoes it back, and you must answer from that same view.
+     */
+    snapshot: string | null;
+    /** The authorized scope (tenant, user, store). Never serve across scopes. */
+    scope: string;
+}
+interface BootstrapResult {
+    rows: Row[];
+    /** Resume token for the next page; `null` when the walk is done. */
+    nextPage: string | number | null;
+    /**
+     * Issue this on the first page. Omitting it caps the client at `best-effort`
+     * coverage — reads keep hitting the network forever. See the module doc.
+     */
+    snapshot?: string;
+    /**
+     * The cursor the delta feed should resume from — issued **on the first page**,
+     * i.e. as of the snapshot. Issuing it after the walk instead would lose anything
+     * that changed *during* the walk: it would fall between "bootstrap ended" and
+     * "delta began".
+     */
+    deltaCursor?: string;
+    /** Total rows in scope, if cheap to know. Drives the client's progress bar. */
+    total?: number;
+}
+interface DeltaArgs {
+    /** The cursor the client last stored. */
+    since: string;
+    scope: string;
+}
+interface DeltaResult {
+    changed: Row[];
+    /**
+     * Primary keys deleted since `since`.
+     *
+     * **This is the only way a REST replica ever learns about a deletion.** A paged
+     * GET returns survivors, and a row's absence is ambiguous — deleted, or merely
+     * shifted to another page? The client refuses to guess (guessing eventually
+     * deletes live data), so if you don't report deletions here, deleted rows live
+     * on in every client forever. A soft-delete table or an `is_deleted` flag with a
+     * revision is the usual answer.
+     */
+    deleted: Array<string | number>;
+    cursor: string;
+    hasMore?: boolean;
+}
+interface CreateReplicationHandlersOptions {
+    bootstrap(args: BootstrapArgs): Promise<BootstrapResult>;
+    delta?(args: DeltaArgs): Promise<DeltaResult>;
+    /**
+     * Identify the caller and return a scope key — **your security boundary**.
+     * Return `null` to reject with 401. Omit only for genuinely public data: without
+     * it every caller shares one scope, and a replica hydrated by one user is served
+     * to the next.
+     */
+    authorize?(req: Request): Promise<string | null | undefined> | string | null | undefined;
+    /** Largest page a client may request. Default 1000. */
+    maxLimit?: number;
+    /** Page size when the client doesn't ask. Default 500. */
+    defaultLimit?: number;
+}
+interface ReplicationHandlers {
+    /** Mount as the `GET` handler for your collection endpoint. */
+    GET(req: Request): Promise<Response>;
+}
+/**
+ * Build the `GET` handler that serves both the bootstrap walk and the delta feed.
+ *
+ * The two are distinguished by the query string: `?since=` means delta, anything
+ * else means bootstrap.
+ *
+ * @example
+ * // app/api/products/route.ts
+ * export const { GET } = createReplicationHandlers({
+ *   authorize: (req) => getSession(req)?.storeId ?? null,
+ *   async bootstrap({ page, limit, snapshot, scope }) {
+ *     // Issue a snapshot on the first page: the current max revision. Later pages
+ *     // read `rev <= snapshot`, so the walk sees one consistent view of the table
+ *     // even while it is being written to.
+ *     const rev = snapshot ?? String(await currentRevision());
+ *     const offset = Number(page ?? 0);
+ *     const rows = await sql`
+ *       SELECT id, name, price, category, rev FROM products
+ *       WHERE store_id = ${scope} AND rev <= ${rev} AND NOT is_deleted
+ *       ORDER BY id LIMIT ${limit} OFFSET ${offset}`;
+ *     return {
+ *       rows,
+ *       nextPage: rows.length < limit ? null : offset + limit,
+ *       snapshot: rev,
+ *       deltaCursor: rev,
+ *       total: await countProducts(scope, rev),
+ *     };
+ *   },
+ *   async delta({ since, scope }) {
+ *     const rows = await sql`
+ *       SELECT id, name, price, category, rev, is_deleted FROM products
+ *       WHERE store_id = ${scope} AND rev > ${since}`;
+ *     const now = String(await currentRevision());
+ *     return {
+ *       changed: rows.filter((r) => !r.is_deleted),
+ *       deleted: rows.filter((r) => r.is_deleted).map((r) => r.id),
+ *       cursor: now,
+ *     };
+ *   },
+ * });
+ */
+declare function createReplicationHandlers(options: CreateReplicationHandlersOptions): ReplicationHandlers;
+
 /** The fields of a TalaDB change record the store keys on. Everything else in
  * a record is opaque — store it verbatim. */
 interface ChangeRecord {
@@ -82,4 +233,4 @@ declare function memorySyncStore(): SyncStore;
  */
 declare function taladbSyncStore(db: TalaDB, collectionName?: string): SyncStore;
 
-export { type ChangeRecord, type CreateSyncHandlersOptions, type SyncHandlers, type SyncStore, createSyncHandlers, memorySyncStore, taladbSyncStore };
+export { type BootstrapArgs, type BootstrapResult, type ChangeRecord, type CreateReplicationHandlersOptions, type CreateSyncHandlersOptions, type DeltaArgs, type DeltaResult, type ReplicationHandlers, type Row, type SyncHandlers, type SyncStore, createReplicationHandlers, createSyncHandlers, memorySyncStore, taladbSyncStore };

package/dist/server.d.ts

@@ -1,5 +1,156 @@
 import { TalaDB } from 'taladb';
 
+/**
+ * Server helpers for coverage-first replication.
+ *
+ * Implements the two endpoints a client needs to build a **trustworthy** local
+ * replica of a table:
+ *
+ * - `GET  ?page=&limit=&snapshot=` — the bootstrap walk
+ * - `GET  ?since=<cursor>`         — the delta feed
+ *
+ * Framework-neutral: it takes a `Request` and returns a `Response`, so it drops
+ * into a Next route handler, a Remix loader, a Hono route, or an Express adapter.
+ *
+ * ## Why the snapshot matters more than it looks
+ *
+ * The obvious way to build a replica is to walk `?page=1,2,3…` and stop. It is
+ * also **wrong on live data**, and wrong in a way nothing detects.
+ *
+ * Fetch page 1. A row gets deleted. Every later row shifts up one. Fetch page 2 at
+ * offset 100 — but the row that *was* at offset 100 is now at 99, which you already
+ * passed. It is never fetched. The walk completes, the client marks the collection
+ * complete, and from then on every query is served locally from a replica with a
+ * silent hole in it. No error, no warning, just a product that quietly doesn't
+ * exist for that user until the next full rebuild.
+ *
+ * A snapshot token fixes it: the client echoes it back on every page, and the
+ * server answers each page from the *same logical view* of the table. On Postgres
+ * this is a monotonic revision column and a `rev <= :snapshot` predicate — no
+ * long-lived transaction required.
+ *
+ * An origin that cannot do this is still usable, but the client caps its coverage
+ * at `best-effort` and keeps serving reads from the network, because it cannot
+ * prove the replica is whole. That is the honest outcome, and it is why
+ * {@link createReplicationHandlers} pushes you toward supporting it.
+ */
+/** A row as your database returns it. Must carry a stable primary key. */
+type Row = Record<string, unknown>;
+interface BootstrapArgs {
+    /** Offset (or opaque page token) to resume from. `null` on the first page. */
+    page: string | number | null;
+    /** Rows requested. Already clamped to `maxLimit`. */
+    limit: number;
+    /**
+     * The snapshot to read from — `null` on the first page, when you should *issue*
+     * one. Every later page echoes it back, and you must answer from that same view.
+     */
+    snapshot: string | null;
+    /** The authorized scope (tenant, user, store). Never serve across scopes. */
+    scope: string;
+}
+interface BootstrapResult {
+    rows: Row[];
+    /** Resume token for the next page; `null` when the walk is done. */
+    nextPage: string | number | null;
+    /**
+     * Issue this on the first page. Omitting it caps the client at `best-effort`
+     * coverage — reads keep hitting the network forever. See the module doc.
+     */
+    snapshot?: string;
+    /**
+     * The cursor the delta feed should resume from — issued **on the first page**,
+     * i.e. as of the snapshot. Issuing it after the walk instead would lose anything
+     * that changed *during* the walk: it would fall between "bootstrap ended" and
+     * "delta began".
+     */
+    deltaCursor?: string;
+    /** Total rows in scope, if cheap to know. Drives the client's progress bar. */
+    total?: number;
+}
+interface DeltaArgs {
+    /** The cursor the client last stored. */
+    since: string;
+    scope: string;
+}
+interface DeltaResult {
+    changed: Row[];
+    /**
+     * Primary keys deleted since `since`.
+     *
+     * **This is the only way a REST replica ever learns about a deletion.** A paged
+     * GET returns survivors, and a row's absence is ambiguous — deleted, or merely
+     * shifted to another page? The client refuses to guess (guessing eventually
+     * deletes live data), so if you don't report deletions here, deleted rows live
+     * on in every client forever. A soft-delete table or an `is_deleted` flag with a
+     * revision is the usual answer.
+     */
+    deleted: Array<string | number>;
+    cursor: string;
+    hasMore?: boolean;
+}
+interface CreateReplicationHandlersOptions {
+    bootstrap(args: BootstrapArgs): Promise<BootstrapResult>;
+    delta?(args: DeltaArgs): Promise<DeltaResult>;
+    /**
+     * Identify the caller and return a scope key — **your security boundary**.
+     * Return `null` to reject with 401. Omit only for genuinely public data: without
+     * it every caller shares one scope, and a replica hydrated by one user is served
+     * to the next.
+     */
+    authorize?(req: Request): Promise<string | null | undefined> | string | null | undefined;
+    /** Largest page a client may request. Default 1000. */
+    maxLimit?: number;
+    /** Page size when the client doesn't ask. Default 500. */
+    defaultLimit?: number;
+}
+interface ReplicationHandlers {
+    /** Mount as the `GET` handler for your collection endpoint. */
+    GET(req: Request): Promise<Response>;
+}
+/**
+ * Build the `GET` handler that serves both the bootstrap walk and the delta feed.
+ *
+ * The two are distinguished by the query string: `?since=` means delta, anything
+ * else means bootstrap.
+ *
+ * @example
+ * // app/api/products/route.ts
+ * export const { GET } = createReplicationHandlers({
+ *   authorize: (req) => getSession(req)?.storeId ?? null,
+ *   async bootstrap({ page, limit, snapshot, scope }) {
+ *     // Issue a snapshot on the first page: the current max revision. Later pages
+ *     // read `rev <= snapshot`, so the walk sees one consistent view of the table
+ *     // even while it is being written to.
+ *     const rev = snapshot ?? String(await currentRevision());
+ *     const offset = Number(page ?? 0);
+ *     const rows = await sql`
+ *       SELECT id, name, price, category, rev FROM products
+ *       WHERE store_id = ${scope} AND rev <= ${rev} AND NOT is_deleted
+ *       ORDER BY id LIMIT ${limit} OFFSET ${offset}`;
+ *     return {
+ *       rows,
+ *       nextPage: rows.length < limit ? null : offset + limit,
+ *       snapshot: rev,
+ *       deltaCursor: rev,
+ *       total: await countProducts(scope, rev),
+ *     };
+ *   },
+ *   async delta({ since, scope }) {
+ *     const rows = await sql`
+ *       SELECT id, name, price, category, rev, is_deleted FROM products
+ *       WHERE store_id = ${scope} AND rev > ${since}`;
+ *     const now = String(await currentRevision());
+ *     return {
+ *       changed: rows.filter((r) => !r.is_deleted),
+ *       deleted: rows.filter((r) => r.is_deleted).map((r) => r.id),
+ *       cursor: now,
+ *     };
+ *   },
+ * });
+ */
+declare function createReplicationHandlers(options: CreateReplicationHandlersOptions): ReplicationHandlers;
+
 /** The fields of a TalaDB change record the store keys on. Everything else in
  * a record is opaque — store it verbatim. */
 interface ChangeRecord {
@@ -82,4 +233,4 @@ declare function memorySyncStore(): SyncStore;
  */
 declare function taladbSyncStore(db: TalaDB, collectionName?: string): SyncStore;
 
-export { type ChangeRecord, type CreateSyncHandlersOptions, type SyncHandlers, type SyncStore, createSyncHandlers, memorySyncStore, taladbSyncStore };
+export { type BootstrapArgs, type BootstrapResult, type ChangeRecord, type CreateReplicationHandlersOptions, type CreateSyncHandlersOptions, type DeltaArgs, type DeltaResult, type ReplicationHandlers, type Row, type SyncHandlers, type SyncStore, createReplicationHandlers, createSyncHandlers, memorySyncStore, taladbSyncStore };

package/dist/server.js

@@ -20,11 +20,74 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/server.ts
 var server_exports = {};
 __export(server_exports, {
+  createReplicationHandlers: () => createReplicationHandlers,
   createSyncHandlers: () => createSyncHandlers,
   memorySyncStore: () => memorySyncStore,
   taladbSyncStore: () => taladbSyncStore
 });
 module.exports = __toCommonJS(server_exports);
+
+// src/replication.ts
+var json = (body, status = 200) => new Response(JSON.stringify(body), {
+  status,
+  headers: { "content-type": "application/json" }
+});
+function createReplicationHandlers(options) {
+  const {
+    bootstrap,
+    delta,
+    authorize,
+    maxLimit = 1e3,
+    defaultLimit = 500
+  } = options;
+  return {
+    async GET(req) {
+      let scope = "default";
+      if (authorize) {
+        const result2 = await authorize(req);
+        if (!result2) return json({ error: "unauthorized" }, 401);
+        scope = result2;
+      }
+      const url = new URL(req.url);
+      const since = url.searchParams.get("since");
+      if (since !== null) {
+        if (!delta) {
+          return json(
+            {
+              error: "this endpoint has no delta feed; the client cannot refresh incrementally and deletions will never propagate"
+            },
+            501
+          );
+        }
+        const result2 = await delta({ since, scope });
+        return json({
+          data: result2.changed,
+          deleted: result2.deleted,
+          cursor: result2.cursor,
+          hasMore: result2.hasMore ?? false
+        });
+      }
+      const rawLimit = Number(url.searchParams.get("limit") ?? defaultLimit);
+      const limit = Number.isFinite(rawLimit) && rawLimit > 0 ? Math.min(Math.floor(rawLimit), maxLimit) : defaultLimit;
+      const pageParam = url.searchParams.get("page");
+      const result = await bootstrap({
+        page: pageParam === null ? null : pageParam,
+        limit,
+        snapshot: url.searchParams.get("snapshot"),
+        scope
+      });
+      return json({
+        data: result.rows,
+        nextPage: result.nextPage,
+        ...result.snapshot !== void 0 ? { snapshot: result.snapshot } : {},
+        ...result.deltaCursor !== void 0 ? { deltaCursor: result.deltaCursor } : {},
+        ...result.total !== void 0 ? { total: result.total } : {}
+      });
+    }
+  };
+}
+
+// src/server.ts
 function createSyncHandlers(options) {
   const { store } = options;
   const maxBodyBytes = options.maxBodyBytes ?? 1024 * 1024;
@@ -162,6 +225,7 @@ function taladbSyncStore(db, collectionName = "sync_changes") {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  createReplicationHandlers,
   createSyncHandlers,
   memorySyncStore,
   taladbSyncStore

package/dist/server.mjs

@@ -1,3 +1,63 @@
+// src/replication.ts
+var json = (body, status = 200) => new Response(JSON.stringify(body), {
+  status,
+  headers: { "content-type": "application/json" }
+});
+function createReplicationHandlers(options) {
+  const {
+    bootstrap,
+    delta,
+    authorize,
+    maxLimit = 1e3,
+    defaultLimit = 500
+  } = options;
+  return {
+    async GET(req) {
+      let scope = "default";
+      if (authorize) {
+        const result2 = await authorize(req);
+        if (!result2) return json({ error: "unauthorized" }, 401);
+        scope = result2;
+      }
+      const url = new URL(req.url);
+      const since = url.searchParams.get("since");
+      if (since !== null) {
+        if (!delta) {
+          return json(
+            {
+              error: "this endpoint has no delta feed; the client cannot refresh incrementally and deletions will never propagate"
+            },
+            501
+          );
+        }
+        const result2 = await delta({ since, scope });
+        return json({
+          data: result2.changed,
+          deleted: result2.deleted,
+          cursor: result2.cursor,
+          hasMore: result2.hasMore ?? false
+        });
+      }
+      const rawLimit = Number(url.searchParams.get("limit") ?? defaultLimit);
+      const limit = Number.isFinite(rawLimit) && rawLimit > 0 ? Math.min(Math.floor(rawLimit), maxLimit) : defaultLimit;
+      const pageParam = url.searchParams.get("page");
+      const result = await bootstrap({
+        page: pageParam === null ? null : pageParam,
+        limit,
+        snapshot: url.searchParams.get("snapshot"),
+        scope
+      });
+      return json({
+        data: result.rows,
+        nextPage: result.nextPage,
+        ...result.snapshot !== void 0 ? { snapshot: result.snapshot } : {},
+        ...result.deltaCursor !== void 0 ? { deltaCursor: result.deltaCursor } : {},
+        ...result.total !== void 0 ? { total: result.total } : {}
+      });
+    }
+  };
+}
+
 // src/server.ts
 function createSyncHandlers(options) {
   const { store } = options;
@@ -135,6 +195,7 @@ function taladbSyncStore(db, collectionName = "sync_changes") {
   };
 }
 export {
+  createReplicationHandlers,
   createSyncHandlers,
   memorySyncStore,
   taladbSyncStore

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taladb/next",
-  "version": "0.9.3",
+  "version": "0.9.4",
   "description": "First-party Next.js integration for TalaDB — sync route handlers for the server, a SyncProvider for the client",
   "sideEffects": false,
   "exports": {
@@ -40,9 +40,9 @@
     "node": ">=18"
   },
   "peerDependencies": {
-    "@taladb/react": "^0.9.3",
+    "@taladb/react": "^0.9.4",
     "react": ">=18.0.0",
-    "taladb": "^0.9.3"
+    "taladb": "^0.9.4"
   },
   "peerDependenciesMeta": {
     "@taladb/react": {
@@ -59,9 +59,9 @@
     "tsup": "^8.0.0",
     "typescript": "^5.9.3",
     "vitest": "^3.2.0",
-    "@taladb/node": "0.9.3",
-    "@taladb/react": "0.9.3",
-    "taladb": "0.9.3"
+    "@taladb/react": "0.9.4",
+    "@taladb/node": "0.9.4",
+    "taladb": "0.9.4"
   },
   "scripts": {
     "build": "tsup",