@foretag/tanstack-db-surrealdb 0.1.14 → 0.1.16

package/README.md

@@ -2,7 +2,7 @@
 
 > Note: Please note this Software is Pre-release pending testing and not yet recommended for production use.
 
-Add Offline / Local First Caching & Syncing to your SurrealDB app with TanstackDB and Loro (CRDTs). For SurrealDB v3 and SurrealDB JS SDK v2.
+Add Offline / Local First Caching & Syncing to your SurrealDB app with TanstackDB and Loro (CRDTs). For SurrealDB v3.alpha-13 and SurrealDB JS SDK v2 (and above).
 
 - Local / Offline first applications with TanstackDB and Loro
 - High performance with Low resource consumption

package/dist/index.js

@@ -27,28 +27,51 @@ var import_surrealdb2 = require("surrealdb");
 
 // src/table.ts
 var import_surrealdb = require("surrealdb");
-function manageTable(db, { name, ...args }) {
+function manageTable(db, useLoro, { name, ...args }) {
   const fields = args.fields ?? "*";
   const listAll = async () => {
-    return await db.select(new import_surrealdb.Table(name)).where(args.where).fields(...fields);
+    let q = db.select(new import_surrealdb.Table(name));
+    if (args.where) q = q.where(args.where);
+    return await q.fields(...fields);
   };
   const listActive = async () => {
+    if (!useLoro) return listAll();
     return await db.select(new import_surrealdb.Table(name)).where((0, import_surrealdb.and)(args.where, (0, import_surrealdb.eq)("sync_deleted", false))).fields(...fields);
   };
   const create = async (data) => {
     await db.create(new import_surrealdb.Table(name)).content(data);
   };
   const update = async (id, data) => {
-    await db.update(id).merge({
-      ...data,
-      sync_deleted: false,
-      updated_at: Date.now()
-    });
+    if (!useLoro) {
+      await db.update(id).merge({
+        ...data
+      });
+      return;
+    }
+    try {
+      await db.update(id).merge({
+        ...data,
+        sync_deleted: false,
+        updated_at: Date.now()
+      });
+    } catch (error) {
+      console.warn(
+        `Please ensure the table ${name} has sync_deleted and updated_at fields defined`
+      );
+      console.error(
+        "Failed to update record with Loro (CRDTs) with: ",
+        error
+      );
+    }
   };
   const remove = async (id) => {
     await db.delete(id);
   };
   const softDelete = async (id) => {
+    if (!useLoro) {
+      await db.delete(id);
+      return;
+    }
     await db.upsert(id).merge({
       sync_deleted: true,
       updated_at: Date.now()
@@ -58,6 +81,7 @@ function manageTable(db, { name, ...args }) {
     let killed = false;
     let live;
     const on = ({ action, value }) => {
+      console.debug("[surreal live]", name, action, value);
       if (action === "KILLED") return;
       if (action === "CREATE") cb({ type: "insert", row: value });
       else if (action === "UPDATE")
@@ -120,11 +144,17 @@ function surrealCollectionOptions({
     loro?.doc?.commit?.();
   };
   const pushQueue = [];
-  const enqueuePush = (op) => pushQueue.push(op);
+  const enqueuePush = (op) => {
+    if (!useLoro) return;
+    pushQueue.push(op);
+  };
   const flushPushQueue = async () => {
+    if (!useLoro) return;
     const ops = pushQueue.splice(0, pushQueue.length);
     for (const op of ops) {
-      if (op.kind === "create") await table.create(op.row);
+      if (op.kind === "create") {
+        await table.create(op.row);
+      }
       if (op.kind === "update") {
         const rid = new import_surrealdb2.RecordId(
           config.table.name,
@@ -140,13 +170,17 @@ function surrealCollectionOptions({
   };
   const newer = (a, b) => (a?.getTime() ?? -1) > (b?.getTime() ?? -1);
   const reconcileBoot = (serverRows, write) => {
-    const localRows = useLoro ? loroToArray() : [];
+    if (!useLoro) {
+      diffAndEmit(serverRows, write);
+      return;
+    }
+    const localRows = loroToArray();
     const serverById = new Map(serverRows.map((r) => [getKey(r), r]));
     const localById = new Map(localRows.map((r) => [getKey(r), r]));
     const ids = /* @__PURE__ */ new Set([...serverById.keys(), ...localById.keys()]);
     const current = [];
     const applyLocal = (row) => {
-      if (!useLoro || !row) return;
+      if (!row) return;
       if (row.sync_deleted) loroRemove(getKey(row));
       else loroPut(row);
     };
@@ -154,18 +188,22 @@ function surrealCollectionOptions({
       const s = serverById.get(id2);
       const l = localById.get(id2);
       if (s && l) {
-        if (s.sync_deleted && l.sync_deleted) {
+        const sDeleted = s.sync_deleted ?? false;
+        const lDeleted = l.sync_deleted ?? false;
+        const sUpdated = s.updated_at;
+        const lUpdated = l.updated_at;
+        if (sDeleted && lDeleted) {
           applyLocal(s);
           current.push(s);
-        } else if (s.sync_deleted && !l.sync_deleted) {
+        } else if (sDeleted && !lDeleted) {
           applyLocal(s);
           current.push(s);
-        } else if (!s.sync_deleted && l.sync_deleted) {
-          if (newer(l.updated_at, s.updated_at)) {
+        } else if (!sDeleted && lDeleted) {
+          if (newer(lUpdated, sUpdated)) {
             enqueuePush({
               kind: "delete",
               id: id2,
-              updated_at: l.updated_at
+              updated_at: lUpdated ?? /* @__PURE__ */ new Date()
             });
             applyLocal(l);
             current.push(l);
@@ -174,7 +212,7 @@ function surrealCollectionOptions({
             current.push(s);
           }
         } else {
-          if (newer(l.updated_at, s.updated_at)) {
+          if (newer(lUpdated, sUpdated)) {
             enqueuePush({ kind: "update", row: l });
             applyLocal(l);
             current.push(l);
@@ -187,11 +225,13 @@ function surrealCollectionOptions({
         applyLocal(s);
         current.push(s);
       } else if (!s && l) {
-        if (l.sync_deleted) {
+        const lDeleted = l.sync_deleted ?? false;
+        const lUpdated = l.updated_at;
+        if (lDeleted) {
           enqueuePush({
             kind: "delete",
             id: id2,
-            updated_at: l.updated_at
+            updated_at: lUpdated ?? /* @__PURE__ */ new Date()
           });
           applyLocal(l);
           current.push(l);
@@ -206,15 +246,24 @@ function surrealCollectionOptions({
   };
   let prevById = /* @__PURE__ */ new Map();
   const buildMap = (rows) => new Map(rows.map((r) => [getKey(r), r]));
-  const same = (a, b) => a.sync_deleted === b.sync_deleted && a.updated_at.getTime() === b.updated_at.getTime() && JSON.stringify({
-    ...a,
-    updated_at: void 0,
-    sync_deleted: void 0
-  }) === JSON.stringify({
-    ...b,
-    updated_at: void 0,
-    sync_deleted: void 0
-  });
+  const same = (a, b) => {
+    if (useLoro) {
+      const aUpdated = a.updated_at;
+      const bUpdated = b.updated_at;
+      const aDeleted = a.sync_deleted ?? false;
+      const bDeleted = b.sync_deleted ?? false;
+      return aDeleted === bDeleted && (aUpdated?.getTime() ?? 0) === (bUpdated?.getTime() ?? 0) && JSON.stringify({
+        ...a,
+        updated_at: void 0,
+        sync_deleted: void 0
+      }) === JSON.stringify({
+        ...b,
+        updated_at: void 0,
+        sync_deleted: void 0
+      });
+    }
+    return JSON.stringify(a) === JSON.stringify(b);
+  };
   const diffAndEmit = (currentRows, write) => {
     const currById = buildMap(currentRows);
     for (const [id2, row] of currById) {
@@ -232,7 +281,8 @@ function surrealCollectionOptions({
     }
     prevById = currById;
   };
-  const table = manageTable(db, config.table);
+  const table = manageTable(db, useLoro, config.table);
+  const now = () => /* @__PURE__ */ new Date();
   const sync = ({
     begin,
     write,
@@ -242,15 +292,18 @@ function surrealCollectionOptions({
     let offLive = null;
     const makeTombstone = (id2) => ({
       id: new import_surrealdb2.RecordId(config.table.name, id2).toString(),
-      updated_at: /* @__PURE__ */ new Date(),
+      updated_at: now(),
       sync_deleted: true
     });
     const start = async () => {
       try {
         const serverRows = await table.listAll();
         begin();
-        if (useLoro) reconcileBoot(serverRows, write);
-        else diffAndEmit(serverRows, write);
+        if (useLoro) {
+          reconcileBoot(serverRows, write);
+        } else {
+          diffAndEmit(serverRows, write);
+        }
         commit();
         markReady();
         await flushPushQueue();
@@ -259,7 +312,8 @@ function surrealCollectionOptions({
           try {
             if (evt.type === "insert" || evt.type === "update") {
               const row = evt.row;
-              if (row.sync_deleted) {
+              const deleted = useLoro ? row.sync_deleted ?? false : false;
+              if (deleted) {
                 if (useLoro) loroRemove(getKey(row));
                 const prev = prevById.get(getKey(row)) ?? makeTombstone(getKey(row));
                 write({ type: "delete", value: prev });
@@ -294,16 +348,16 @@ function surrealCollectionOptions({
       if (offLive) offLive();
     };
   };
-  const now = () => /* @__PURE__ */ new Date();
   const onInsert = async (p) => {
     const resultRows = [];
     for (const m of p.transaction.mutations) {
       if (m.type !== "insert") continue;
-      const row = {
-        ...m.modified,
+      const base = { ...m.modified };
+      const row = useLoro ? {
+        ...base,
         updated_at: now(),
         sync_deleted: false
-      };
+      } : base;
       if (useLoro) loroPut(row);
       await table.create(row);
       resultRows.push(row);
@@ -315,7 +369,11 @@ function surrealCollectionOptions({
     for (const m of p.transaction.mutations) {
       if (m.type !== "update") continue;
       const id2 = m.key;
-      const merged = { ...m.modified, id: id2, updated_at: now() };
+      const base = { ...m.modified, id: id2 };
+      const merged = useLoro ? {
+        ...base,
+        updated_at: now()
+      } : base;
       if (useLoro) loroPut(merged);
       const rid = new import_surrealdb2.RecordId(config.table.name, keyOf(id2));
       await table.update(rid, merged);
@@ -328,7 +386,9 @@ function surrealCollectionOptions({
     for (const m of p.transaction.mutations) {
       if (m.type !== "delete") continue;
       const id2 = m.key;
-      if (useLoro) loroRemove(keyOf(id2));
+      if (useLoro) {
+        loroRemove(keyOf(id2));
+      }
       await table.softDelete(new import_surrealdb2.RecordId(config.table.name, keyOf(id2)));
     }
     return resultRows;

package/dist/index.mjs

@@ -9,28 +9,51 @@ import {
   Features,
   Table
 } from "surrealdb";
-function manageTable(db, { name, ...args }) {
+function manageTable(db, useLoro, { name, ...args }) {
   const fields = args.fields ?? "*";
   const listAll = async () => {
-    return await db.select(new Table(name)).where(args.where).fields(...fields);
+    let q = db.select(new Table(name));
+    if (args.where) q = q.where(args.where);
+    return await q.fields(...fields);
   };
   const listActive = async () => {
+    if (!useLoro) return listAll();
     return await db.select(new Table(name)).where(and(args.where, eq("sync_deleted", false))).fields(...fields);
   };
   const create = async (data) => {
     await db.create(new Table(name)).content(data);
   };
   const update = async (id, data) => {
-    await db.update(id).merge({
-      ...data,
-      sync_deleted: false,
-      updated_at: Date.now()
-    });
+    if (!useLoro) {
+      await db.update(id).merge({
+        ...data
+      });
+      return;
+    }
+    try {
+      await db.update(id).merge({
+        ...data,
+        sync_deleted: false,
+        updated_at: Date.now()
+      });
+    } catch (error) {
+      console.warn(
+        `Please ensure the table ${name} has sync_deleted and updated_at fields defined`
+      );
+      console.error(
+        "Failed to update record with Loro (CRDTs) with: ",
+        error
+      );
+    }
   };
   const remove = async (id) => {
     await db.delete(id);
   };
   const softDelete = async (id) => {
+    if (!useLoro) {
+      await db.delete(id);
+      return;
+    }
     await db.upsert(id).merge({
       sync_deleted: true,
       updated_at: Date.now()
@@ -40,6 +63,7 @@ function manageTable(db, { name, ...args }) {
     let killed = false;
     let live;
     const on = ({ action, value }) => {
+      console.debug("[surreal live]", name, action, value);
       if (action === "KILLED") return;
       if (action === "CREATE") cb({ type: "insert", row: value });
       else if (action === "UPDATE")
@@ -102,11 +126,17 @@ function surrealCollectionOptions({
     loro?.doc?.commit?.();
   };
   const pushQueue = [];
-  const enqueuePush = (op) => pushQueue.push(op);
+  const enqueuePush = (op) => {
+    if (!useLoro) return;
+    pushQueue.push(op);
+  };
   const flushPushQueue = async () => {
+    if (!useLoro) return;
     const ops = pushQueue.splice(0, pushQueue.length);
     for (const op of ops) {
-      if (op.kind === "create") await table.create(op.row);
+      if (op.kind === "create") {
+        await table.create(op.row);
+      }
       if (op.kind === "update") {
         const rid = new RecordId(
           config.table.name,
@@ -122,13 +152,17 @@ function surrealCollectionOptions({
   };
   const newer = (a, b) => (a?.getTime() ?? -1) > (b?.getTime() ?? -1);
   const reconcileBoot = (serverRows, write) => {
-    const localRows = useLoro ? loroToArray() : [];
+    if (!useLoro) {
+      diffAndEmit(serverRows, write);
+      return;
+    }
+    const localRows = loroToArray();
     const serverById = new Map(serverRows.map((r) => [getKey(r), r]));
     const localById = new Map(localRows.map((r) => [getKey(r), r]));
     const ids = /* @__PURE__ */ new Set([...serverById.keys(), ...localById.keys()]);
     const current = [];
     const applyLocal = (row) => {
-      if (!useLoro || !row) return;
+      if (!row) return;
       if (row.sync_deleted) loroRemove(getKey(row));
       else loroPut(row);
     };
@@ -136,18 +170,22 @@ function surrealCollectionOptions({
       const s = serverById.get(id2);
       const l = localById.get(id2);
       if (s && l) {
-        if (s.sync_deleted && l.sync_deleted) {
+        const sDeleted = s.sync_deleted ?? false;
+        const lDeleted = l.sync_deleted ?? false;
+        const sUpdated = s.updated_at;
+        const lUpdated = l.updated_at;
+        if (sDeleted && lDeleted) {
           applyLocal(s);
           current.push(s);
-        } else if (s.sync_deleted && !l.sync_deleted) {
+        } else if (sDeleted && !lDeleted) {
           applyLocal(s);
           current.push(s);
-        } else if (!s.sync_deleted && l.sync_deleted) {
-          if (newer(l.updated_at, s.updated_at)) {
+        } else if (!sDeleted && lDeleted) {
+          if (newer(lUpdated, sUpdated)) {
             enqueuePush({
               kind: "delete",
               id: id2,
-              updated_at: l.updated_at
+              updated_at: lUpdated ?? /* @__PURE__ */ new Date()
             });
             applyLocal(l);
             current.push(l);
@@ -156,7 +194,7 @@ function surrealCollectionOptions({
             current.push(s);
           }
         } else {
-          if (newer(l.updated_at, s.updated_at)) {
+          if (newer(lUpdated, sUpdated)) {
             enqueuePush({ kind: "update", row: l });
             applyLocal(l);
             current.push(l);
@@ -169,11 +207,13 @@ function surrealCollectionOptions({
         applyLocal(s);
         current.push(s);
       } else if (!s && l) {
-        if (l.sync_deleted) {
+        const lDeleted = l.sync_deleted ?? false;
+        const lUpdated = l.updated_at;
+        if (lDeleted) {
           enqueuePush({
             kind: "delete",
             id: id2,
-            updated_at: l.updated_at
+            updated_at: lUpdated ?? /* @__PURE__ */ new Date()
           });
           applyLocal(l);
           current.push(l);
@@ -188,15 +228,24 @@ function surrealCollectionOptions({
   };
   let prevById = /* @__PURE__ */ new Map();
   const buildMap = (rows) => new Map(rows.map((r) => [getKey(r), r]));
-  const same = (a, b) => a.sync_deleted === b.sync_deleted && a.updated_at.getTime() === b.updated_at.getTime() && JSON.stringify({
-    ...a,
-    updated_at: void 0,
-    sync_deleted: void 0
-  }) === JSON.stringify({
-    ...b,
-    updated_at: void 0,
-    sync_deleted: void 0
-  });
+  const same = (a, b) => {
+    if (useLoro) {
+      const aUpdated = a.updated_at;
+      const bUpdated = b.updated_at;
+      const aDeleted = a.sync_deleted ?? false;
+      const bDeleted = b.sync_deleted ?? false;
+      return aDeleted === bDeleted && (aUpdated?.getTime() ?? 0) === (bUpdated?.getTime() ?? 0) && JSON.stringify({
+        ...a,
+        updated_at: void 0,
+        sync_deleted: void 0
+      }) === JSON.stringify({
+        ...b,
+        updated_at: void 0,
+        sync_deleted: void 0
+      });
+    }
+    return JSON.stringify(a) === JSON.stringify(b);
+  };
   const diffAndEmit = (currentRows, write) => {
     const currById = buildMap(currentRows);
     for (const [id2, row] of currById) {
@@ -214,7 +263,8 @@ function surrealCollectionOptions({
     }
     prevById = currById;
   };
-  const table = manageTable(db, config.table);
+  const table = manageTable(db, useLoro, config.table);
+  const now = () => /* @__PURE__ */ new Date();
   const sync = ({
     begin,
     write,
@@ -224,15 +274,18 @@ function surrealCollectionOptions({
     let offLive = null;
     const makeTombstone = (id2) => ({
       id: new RecordId(config.table.name, id2).toString(),
-      updated_at: /* @__PURE__ */ new Date(),
+      updated_at: now(),
       sync_deleted: true
     });
     const start = async () => {
       try {
         const serverRows = await table.listAll();
         begin();
-        if (useLoro) reconcileBoot(serverRows, write);
-        else diffAndEmit(serverRows, write);
+        if (useLoro) {
+          reconcileBoot(serverRows, write);
+        } else {
+          diffAndEmit(serverRows, write);
+        }
         commit();
         markReady();
         await flushPushQueue();
@@ -241,7 +294,8 @@ function surrealCollectionOptions({
           try {
             if (evt.type === "insert" || evt.type === "update") {
               const row = evt.row;
-              if (row.sync_deleted) {
+              const deleted = useLoro ? row.sync_deleted ?? false : false;
+              if (deleted) {
                 if (useLoro) loroRemove(getKey(row));
                 const prev = prevById.get(getKey(row)) ?? makeTombstone(getKey(row));
                 write({ type: "delete", value: prev });
@@ -276,16 +330,16 @@ function surrealCollectionOptions({
       if (offLive) offLive();
     };
   };
-  const now = () => /* @__PURE__ */ new Date();
   const onInsert = async (p) => {
     const resultRows = [];
     for (const m of p.transaction.mutations) {
       if (m.type !== "insert") continue;
-      const row = {
-        ...m.modified,
+      const base = { ...m.modified };
+      const row = useLoro ? {
+        ...base,
         updated_at: now(),
         sync_deleted: false
-      };
+      } : base;
       if (useLoro) loroPut(row);
       await table.create(row);
       resultRows.push(row);
@@ -297,7 +351,11 @@ function surrealCollectionOptions({
     for (const m of p.transaction.mutations) {
       if (m.type !== "update") continue;
       const id2 = m.key;
-      const merged = { ...m.modified, id: id2, updated_at: now() };
+      const base = { ...m.modified, id: id2 };
+      const merged = useLoro ? {
+        ...base,
+        updated_at: now()
+      } : base;
       if (useLoro) loroPut(merged);
       const rid = new RecordId(config.table.name, keyOf(id2));
       await table.update(rid, merged);
@@ -310,7 +368,9 @@ function surrealCollectionOptions({
     for (const m of p.transaction.mutations) {
       if (m.type !== "delete") continue;
       const id2 = m.key;
-      if (useLoro) loroRemove(keyOf(id2));
+      if (useLoro) {
+        loroRemove(keyOf(id2));
+      }
       await table.softDelete(new RecordId(config.table.name, keyOf(id2)));
     }
     return resultRows;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@foretag/tanstack-db-surrealdb",
 	"description": "Add Offline / Local First Caching & Syncing to your SurrealDB app with TanstackDB and Loro (CRDTs)",
-	"version": "0.1.14",
+	"version": "0.1.16",
 	"files": [
 		"dist"
 	],
@@ -40,17 +40,17 @@
 		"build": "tsup src/index.ts --dts --format esm,cjs"
 	},
 	"dependencies": {
-		"loro-crdt": "^1.9.0"
+		"loro-crdt": "^1.10.2"
 	},
 	"peerDependencies": {
-		"@tanstack/db": "*",
-		"@tanstack/query-db-collection": "*",
-		"surrealdb": "2.0.0-alpha.13"
+		"@tanstack/db": "^0.5.10",
+		"@tanstack/query-db-collection": "^1.0.0",
+		"surrealdb": "2.0.0-alpha.14"
 	},
 	"devDependencies": {
-		"@biomejs/biome": "^2.3.5",
-		"@tanstack/svelte-db": "^0.1.43",
-		"surrealdb": "2.0.0-alpha.13",
+		"@biomejs/biome": "^2.3.8",
+		"@tanstack/svelte-db": "^0.1.53",
+		"surrealdb": "2.0.0-alpha.14",
 		"tsup": "^8.5.1"
 	}
 }