@foretag/tanstack-db-surrealdb 0.1.13 → 0.1.15

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,29 +27,43 @@ 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);
   };
   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 upsert = async (id, data) => {
-    await db.upsert(id).merge({
-      ...data,
-      sync_deleted: false,
-      updated_at: Date.now()
-    });
+  const create = async (data) => {
+    await db.create(new import_surrealdb.Table(name)).content(data);
+  };
+  const update = async (id, data) => {
+    if (useLoro) {
+      await db.update(id).merge({
+        ...data,
+        sync_deleted: false,
+        updated_at: Date.now()
+      });
+    } else {
+      await db.update(id).merge({
+        ...data
+      });
+    }
   };
   const remove = async (id) => {
     await db.delete(id);
   };
   const softDelete = async (id) => {
-    await db.upsert(id).merge({
-      sync_deleted: true,
-      updated_at: Date.now()
-    });
+    if (useLoro) {
+      await db.update(id).merge({
+        sync_deleted: true,
+        updated_at: Date.now()
+      });
+    } else {
+      await db.delete(id);
+    }
   };
   const subscribe = (cb) => {
     let killed = false;
@@ -79,7 +93,8 @@ function manageTable(db, { name, ...args }) {
   return {
     listAll,
     listActive,
-    upsert,
+    create,
+    update,
     remove,
     softDelete,
     subscribe
@@ -115,32 +130,44 @@ function surrealCollectionOptions({
     loroMap.delete(id2);
     loro?.doc?.commit?.();
   };
+  const pushQueue = [];
+  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 === "upsert") {
+      if (op.kind === "create") {
+        await table.create(op.row);
+      }
+      if (op.kind === "update") {
         const rid = new import_surrealdb2.RecordId(
           config.table.name,
           op.row.id.toString()
         );
-        await table.upsert(rid, op.row);
-      } else {
+        await table.update(rid, op.row);
+      }
+      if (op.kind === "delete") {
         const rid = new import_surrealdb2.RecordId(config.table.name, op.id.toString());
         await table.softDelete(rid);
       }
     }
   };
-  const pushQueue = [];
-  const enqueuePush = (op) => pushQueue.push(op);
   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);
     };
@@ -148,18 +175,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);
@@ -168,8 +199,8 @@ function surrealCollectionOptions({
             current.push(s);
           }
         } else {
-          if (newer(l.updated_at, s.updated_at)) {
-            enqueuePush({ kind: "upsert", row: l });
+          if (newer(lUpdated, sUpdated)) {
+            enqueuePush({ kind: "update", row: l });
             applyLocal(l);
             current.push(l);
           } else {
@@ -181,16 +212,18 @@ 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);
         } else {
-          enqueuePush({ kind: "upsert", row: l });
+          enqueuePush({ kind: "create", row: l });
           applyLocal(l);
           current.push(l);
         }
@@ -200,15 +233,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) {
@@ -226,7 +268,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,
@@ -236,15 +279,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();
@@ -253,7 +299,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 });
@@ -288,19 +335,18 @@ 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(),
-        deleted: false
-      };
+        sync_deleted: false
+      } : base;
       if (useLoro) loroPut(row);
-      const rid = new import_surrealdb2.RecordId(config.table.name, getKey(row));
-      await table.upsert(rid, row);
+      await table.create(row);
       resultRows.push(row);
     }
     return resultRows;
@@ -310,10 +356,14 @@ 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.upsert(rid, merged);
+      await table.update(rid, merged);
       resultRows.push(merged);
     }
     return resultRows;
@@ -323,7 +373,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,29 +9,43 @@ 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);
   };
   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 upsert = async (id, data) => {
-    await db.upsert(id).merge({
-      ...data,
-      sync_deleted: false,
-      updated_at: Date.now()
-    });
+  const create = async (data) => {
+    await db.create(new Table(name)).content(data);
+  };
+  const update = async (id, data) => {
+    if (useLoro) {
+      await db.update(id).merge({
+        ...data,
+        sync_deleted: false,
+        updated_at: Date.now()
+      });
+    } else {
+      await db.update(id).merge({
+        ...data
+      });
+    }
   };
   const remove = async (id) => {
     await db.delete(id);
   };
   const softDelete = async (id) => {
-    await db.upsert(id).merge({
-      sync_deleted: true,
-      updated_at: Date.now()
-    });
+    if (useLoro) {
+      await db.update(id).merge({
+        sync_deleted: true,
+        updated_at: Date.now()
+      });
+    } else {
+      await db.delete(id);
+    }
   };
   const subscribe = (cb) => {
     let killed = false;
@@ -61,7 +75,8 @@ function manageTable(db, { name, ...args }) {
   return {
     listAll,
     listActive,
-    upsert,
+    create,
+    update,
     remove,
     softDelete,
     subscribe
@@ -97,32 +112,44 @@ function surrealCollectionOptions({
     loroMap.delete(id2);
     loro?.doc?.commit?.();
   };
+  const pushQueue = [];
+  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 === "upsert") {
+      if (op.kind === "create") {
+        await table.create(op.row);
+      }
+      if (op.kind === "update") {
         const rid = new RecordId(
           config.table.name,
           op.row.id.toString()
         );
-        await table.upsert(rid, op.row);
-      } else {
+        await table.update(rid, op.row);
+      }
+      if (op.kind === "delete") {
         const rid = new RecordId(config.table.name, op.id.toString());
         await table.softDelete(rid);
       }
     }
   };
-  const pushQueue = [];
-  const enqueuePush = (op) => pushQueue.push(op);
   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);
     };
@@ -130,18 +157,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);
@@ -150,8 +181,8 @@ function surrealCollectionOptions({
             current.push(s);
           }
         } else {
-          if (newer(l.updated_at, s.updated_at)) {
-            enqueuePush({ kind: "upsert", row: l });
+          if (newer(lUpdated, sUpdated)) {
+            enqueuePush({ kind: "update", row: l });
             applyLocal(l);
             current.push(l);
           } else {
@@ -163,16 +194,18 @@ 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);
         } else {
-          enqueuePush({ kind: "upsert", row: l });
+          enqueuePush({ kind: "create", row: l });
           applyLocal(l);
           current.push(l);
         }
@@ -182,15 +215,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) {
@@ -208,7 +250,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,
@@ -218,15 +261,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();
@@ -235,7 +281,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 });
@@ -270,19 +317,18 @@ 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(),
-        deleted: false
-      };
+        sync_deleted: false
+      } : base;
       if (useLoro) loroPut(row);
-      const rid = new RecordId(config.table.name, getKey(row));
-      await table.upsert(rid, row);
+      await table.create(row);
       resultRows.push(row);
     }
     return resultRows;
@@ -292,10 +338,14 @@ 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.upsert(rid, merged);
+      await table.update(rid, merged);
       resultRows.push(merged);
     }
     return resultRows;
@@ -305,7 +355,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.13",
+	"version": "0.1.15",
 	"files": [
 		"dist"
 	],
@@ -43,8 +43,8 @@
 		"loro-crdt": "^1.9.0"
 	},
 	"peerDependencies": {
-		"@tanstack/db": "*",
-		"@tanstack/query-db-collection": "*",
+		"@tanstack/db": "^0.5.0",
+		"@tanstack/query-db-collection": "^1.0.0",
 		"surrealdb": "2.0.0-alpha.13"
 	},
 	"devDependencies": {