@foretag/tanstack-db-surrealdb 0.1.8 → 0.1.10

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).
+Add Offline / Local First Caching & Syncing to your SurrealDB app with TanstackDB and Loro (CRDTs). For SurrealDB v3 and SurrealDB JS SDK v2.
 
 - Local / Offline first applications with TanstackDB and Loro
 - High performance with Low resource consumption

package/dist/index.d.mts

@@ -1,22 +1,22 @@
 import { CollectionConfig, UtilsRecord } from '@tanstack/db';
 import { Container } from 'loro-crdt';
-import { Surreal, Expr } from 'surrealdb';
+import { RecordId, Surreal, Expr } from 'surrealdb';
 
-type Id = string;
-type SurrealObject<T> = T & {
-    id: Id;
+type WithId<T> = T & {
+    id: string | RecordId;
 };
-type SurrealField<I> = keyof I;
-type SyncedRow = SurrealObject<{
+type SyncedTable<T> = WithId<T & {
     sync_deleted?: boolean;
     updated_at?: Date;
 }>;
 type TableOptions<T> = {
     name: string;
     where?: Expr;
-    fields?: SurrealField<T>[];
+    fields?: (keyof T)[];
 };
-type SurrealCollectionConfig<T extends SurrealObject<object>> = {
+type SurrealCollectionConfig<T extends {
+    id: string | RecordId;
+}> = {
     id?: string;
     db: Surreal;
     table: TableOptions<T>;
@@ -24,7 +24,7 @@ type SurrealCollectionConfig<T extends SurrealObject<object>> = {
     onError?: (e: unknown) => void;
 };
 
-declare function surrealCollectionOptions<T extends SyncedRow, S extends Record<string, Container> = {
+declare function surrealCollectionOptions<T extends SyncedTable<object>, S extends Record<string, Container> = {
     [k: string]: never;
 }>({ id, useLoro, onError, db, ...config }: SurrealCollectionConfig<T>): CollectionConfig<T, string | number, never, UtilsRecord>;
 

package/dist/index.d.ts

@@ -1,22 +1,22 @@
 import { CollectionConfig, UtilsRecord } from '@tanstack/db';
 import { Container } from 'loro-crdt';
-import { Surreal, Expr } from 'surrealdb';
+import { RecordId, Surreal, Expr } from 'surrealdb';
 
-type Id = string;
-type SurrealObject<T> = T & {
-    id: Id;
+type WithId<T> = T & {
+    id: string | RecordId;
 };
-type SurrealField<I> = keyof I;
-type SyncedRow = SurrealObject<{
+type SyncedTable<T> = WithId<T & {
     sync_deleted?: boolean;
     updated_at?: Date;
 }>;
 type TableOptions<T> = {
     name: string;
     where?: Expr;
-    fields?: SurrealField<T>[];
+    fields?: (keyof T)[];
 };
-type SurrealCollectionConfig<T extends SurrealObject<object>> = {
+type SurrealCollectionConfig<T extends {
+    id: string | RecordId;
+}> = {
     id?: string;
     db: Surreal;
     table: TableOptions<T>;
@@ -24,7 +24,7 @@ type SurrealCollectionConfig<T extends SurrealObject<object>> = {
     onError?: (e: unknown) => void;
 };
 
-declare function surrealCollectionOptions<T extends SyncedRow, S extends Record<string, Container> = {
+declare function surrealCollectionOptions<T extends SyncedTable<object>, S extends Record<string, Container> = {
     [k: string]: never;
 }>({ id, useLoro, onError, db, ...config }: SurrealCollectionConfig<T>): CollectionConfig<T, string | number, never, UtilsRecord>;
 

package/dist/index.js

@@ -63,19 +63,9 @@ function manageTable(db, { name, ...args }) {
         cb({ type: "delete", row: { id: value.id } });
     };
     const start = async () => {
-      if (!args.where) {
-        live = await db.live(new import_surrealdb.Table(name));
-        live.subscribe(on);
-      } else {
-        const ctx = {
-          def() {
-            return "";
-          }
-        };
-        const [id] = await db.query(
-          `LIVE SELECT * FROM ${name} WHERE ${args.where.toSQL(ctx)}`
-        ).collect();
-        live = await db.liveOf(new import_surrealdb.Uuid(id));
+      const isLiveSupported = db.isFeatureSupported(import_surrealdb.Features.LiveQueries);
+      if (isLiveSupported) {
+        live = await db.live(new import_surrealdb.Table(name)).where(args.where);
         live.subscribe(on);
       }
     };
@@ -106,7 +96,8 @@ function surrealCollectionOptions({
 }) {
   let loro;
   if (useLoro) loro = { doc: new import_loro_crdt.LoroDoc(), key: id };
-  const getKey = (row) => row.id;
+  const keyOf = (id2) => typeof id2 === "string" ? id2 : id2.toString();
+  const getKey = (row) => keyOf(row.id);
   const loroKey = loro?.key ?? id ?? "surreal";
   const loroMap = useLoro ? loro?.doc?.getMap?.(loroKey) ?? null : null;
   const loroToArray = () => {
@@ -116,22 +107,25 @@ function surrealCollectionOptions({
   };
   const loroPut = (row) => {
     if (!loroMap) return;
-    loroMap.set(String(getKey(row)), row);
+    loroMap.set(getKey(row), row);
     loro?.doc?.commit?.();
   };
   const loroRemove = (id2) => {
     if (!loroMap) return;
-    loroMap.delete(String(id2));
+    loroMap.delete(id2);
     loro?.doc?.commit?.();
   };
   const flushPushQueue = async () => {
     const ops = pushQueue.splice(0, pushQueue.length);
     for (const op of ops) {
       if (op.kind === "upsert") {
-        const rid = new import_surrealdb2.RecordId(config.table.name, op.row.id);
+        const rid = new import_surrealdb2.RecordId(
+          config.table.name,
+          op.row.id.toString()
+        );
         await table.upsert(rid, op.row);
       } else {
-        const rid = new import_surrealdb2.RecordId(config.table.name, op.id);
+        const rid = new import_surrealdb2.RecordId(config.table.name, op.id.toString());
         await table.softDelete(rid);
       }
     }
@@ -141,15 +135,13 @@ function surrealCollectionOptions({
   const newer = (a, b) => (a?.getTime() ?? -1) > (b?.getTime() ?? -1);
   const reconcileBoot = (serverRows, write) => {
     const localRows = useLoro ? loroToArray() : [];
-    const serverById = new Map(
-      serverRows.map((r) => [getKey(r), r])
-    );
+    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.sync_deleted) loroRemove(row.id);
+      if (row.sync_deleted) loroRemove(getKey(row));
       else loroPut(row);
     };
     for (const id2 of ids) {
@@ -242,7 +234,11 @@ function surrealCollectionOptions({
     markReady
   }) => {
     let offLive = null;
-    const makeTombstone = (id2) => ({ id: id2, updated_at: /* @__PURE__ */ new Date(), sync_deleted: true });
+    const makeTombstone = (id2) => ({
+      id: new import_surrealdb2.RecordId(config.table.name, id2).toString(),
+      updated_at: /* @__PURE__ */ new Date(),
+      sync_deleted: true
+    });
     const start = async () => {
       try {
         const serverRows = await table.listAll();
@@ -258,18 +254,18 @@ function surrealCollectionOptions({
             if (evt.type === "insert" || evt.type === "update") {
               const row = evt.row;
               if (row.sync_deleted) {
-                if (useLoro) loroRemove(row.id);
-                const prev = prevById.get(row.id) ?? makeTombstone(row.id);
+                if (useLoro) loroRemove(getKey(row));
+                const prev = prevById.get(getKey(row)) ?? makeTombstone(getKey(row));
                 write({ type: "delete", value: prev });
-                prevById.delete(row.id);
+                prevById.delete(getKey(row));
               } else {
                 if (useLoro) loroPut(row);
-                const had = prevById.has(row.id);
+                const had = prevById.has(getKey(row));
                 write({
                   type: had ? "update" : "insert",
                   value: row
                 });
-                prevById.set(row.id, row);
+                prevById.set(getKey(row), row);
               }
             } else if (evt.type === "delete") {
               const id2 = getKey(evt.row);
@@ -303,7 +299,7 @@ function surrealCollectionOptions({
         deleted: false
       };
       if (useLoro) loroPut(row);
-      const rid = new import_surrealdb2.RecordId(config.table.name, row.id);
+      const rid = new import_surrealdb2.RecordId(config.table.name, getKey(row));
       await table.upsert(rid, row);
       resultRows.push(row);
     }
@@ -316,7 +312,7 @@ function surrealCollectionOptions({
       const id2 = m.key;
       const merged = { ...m.modified, id: id2, updated_at: now() };
       if (useLoro) loroPut(merged);
-      const rid = new import_surrealdb2.RecordId(config.table.name, id2);
+      const rid = new import_surrealdb2.RecordId(config.table.name, keyOf(id2));
       await table.upsert(rid, merged);
       resultRows.push(merged);
     }
@@ -327,8 +323,8 @@ function surrealCollectionOptions({
     for (const m of p.transaction.mutations) {
       if (m.type !== "delete") continue;
       const id2 = m.key;
-      if (useLoro) loroRemove(id2);
-      await table.softDelete(new import_surrealdb2.RecordId(config.table.name, id2));
+      if (useLoro) loroRemove(keyOf(id2));
+      await table.softDelete(new import_surrealdb2.RecordId(config.table.name, keyOf(id2)));
     }
     return resultRows;
   };

package/dist/index.mjs

@@ -6,8 +6,8 @@ import { RecordId } from "surrealdb";
 import {
   and,
   eq,
-  Table,
-  Uuid
+  Features,
+  Table
 } from "surrealdb";
 function manageTable(db, { name, ...args }) {
   const fields = args.fields?.join(", ") ?? "*";
@@ -45,19 +45,9 @@ function manageTable(db, { name, ...args }) {
         cb({ type: "delete", row: { id: value.id } });
     };
     const start = async () => {
-      if (!args.where) {
-        live = await db.live(new Table(name));
-        live.subscribe(on);
-      } else {
-        const ctx = {
-          def() {
-            return "";
-          }
-        };
-        const [id] = await db.query(
-          `LIVE SELECT * FROM ${name} WHERE ${args.where.toSQL(ctx)}`
-        ).collect();
-        live = await db.liveOf(new Uuid(id));
+      const isLiveSupported = db.isFeatureSupported(Features.LiveQueries);
+      if (isLiveSupported) {
+        live = await db.live(new Table(name)).where(args.where);
         live.subscribe(on);
       }
     };
@@ -88,7 +78,8 @@ function surrealCollectionOptions({
 }) {
   let loro;
   if (useLoro) loro = { doc: new LoroDoc(), key: id };
-  const getKey = (row) => row.id;
+  const keyOf = (id2) => typeof id2 === "string" ? id2 : id2.toString();
+  const getKey = (row) => keyOf(row.id);
   const loroKey = loro?.key ?? id ?? "surreal";
   const loroMap = useLoro ? loro?.doc?.getMap?.(loroKey) ?? null : null;
   const loroToArray = () => {
@@ -98,22 +89,25 @@ function surrealCollectionOptions({
   };
   const loroPut = (row) => {
     if (!loroMap) return;
-    loroMap.set(String(getKey(row)), row);
+    loroMap.set(getKey(row), row);
     loro?.doc?.commit?.();
   };
   const loroRemove = (id2) => {
     if (!loroMap) return;
-    loroMap.delete(String(id2));
+    loroMap.delete(id2);
     loro?.doc?.commit?.();
   };
   const flushPushQueue = async () => {
     const ops = pushQueue.splice(0, pushQueue.length);
     for (const op of ops) {
       if (op.kind === "upsert") {
-        const rid = new RecordId(config.table.name, op.row.id);
+        const rid = new RecordId(
+          config.table.name,
+          op.row.id.toString()
+        );
         await table.upsert(rid, op.row);
       } else {
-        const rid = new RecordId(config.table.name, op.id);
+        const rid = new RecordId(config.table.name, op.id.toString());
         await table.softDelete(rid);
       }
     }
@@ -123,15 +117,13 @@ function surrealCollectionOptions({
   const newer = (a, b) => (a?.getTime() ?? -1) > (b?.getTime() ?? -1);
   const reconcileBoot = (serverRows, write) => {
     const localRows = useLoro ? loroToArray() : [];
-    const serverById = new Map(
-      serverRows.map((r) => [getKey(r), r])
-    );
+    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.sync_deleted) loroRemove(row.id);
+      if (row.sync_deleted) loroRemove(getKey(row));
       else loroPut(row);
     };
     for (const id2 of ids) {
@@ -224,7 +216,11 @@ function surrealCollectionOptions({
     markReady
   }) => {
     let offLive = null;
-    const makeTombstone = (id2) => ({ id: id2, updated_at: /* @__PURE__ */ new Date(), sync_deleted: true });
+    const makeTombstone = (id2) => ({
+      id: new RecordId(config.table.name, id2).toString(),
+      updated_at: /* @__PURE__ */ new Date(),
+      sync_deleted: true
+    });
     const start = async () => {
       try {
         const serverRows = await table.listAll();
@@ -240,18 +236,18 @@ function surrealCollectionOptions({
             if (evt.type === "insert" || evt.type === "update") {
               const row = evt.row;
               if (row.sync_deleted) {
-                if (useLoro) loroRemove(row.id);
-                const prev = prevById.get(row.id) ?? makeTombstone(row.id);
+                if (useLoro) loroRemove(getKey(row));
+                const prev = prevById.get(getKey(row)) ?? makeTombstone(getKey(row));
                 write({ type: "delete", value: prev });
-                prevById.delete(row.id);
+                prevById.delete(getKey(row));
               } else {
                 if (useLoro) loroPut(row);
-                const had = prevById.has(row.id);
+                const had = prevById.has(getKey(row));
                 write({
                   type: had ? "update" : "insert",
                   value: row
                 });
-                prevById.set(row.id, row);
+                prevById.set(getKey(row), row);
               }
             } else if (evt.type === "delete") {
               const id2 = getKey(evt.row);
@@ -285,7 +281,7 @@ function surrealCollectionOptions({
         deleted: false
       };
       if (useLoro) loroPut(row);
-      const rid = new RecordId(config.table.name, row.id);
+      const rid = new RecordId(config.table.name, getKey(row));
       await table.upsert(rid, row);
       resultRows.push(row);
     }
@@ -298,7 +294,7 @@ function surrealCollectionOptions({
       const id2 = m.key;
       const merged = { ...m.modified, id: id2, updated_at: now() };
       if (useLoro) loroPut(merged);
-      const rid = new RecordId(config.table.name, id2);
+      const rid = new RecordId(config.table.name, keyOf(id2));
       await table.upsert(rid, merged);
       resultRows.push(merged);
     }
@@ -309,8 +305,8 @@ function surrealCollectionOptions({
     for (const m of p.transaction.mutations) {
       if (m.type !== "delete") continue;
       const id2 = m.key;
-      if (useLoro) loroRemove(id2);
-      await table.softDelete(new RecordId(config.table.name, 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.8",
+	"version": "0.1.10",
 	"files": [
 		"dist"
 	],
@@ -40,7 +40,8 @@
 		"build": "tsup src/index.ts --dts --format esm,cjs"
 	},
 	"dependencies": {
-		"@tanstack/db": "^0.4.19",
+		"@tanstack/db": "^0.4.20",
+		"@tanstack/query-db-collection": "^0.3.0",
 		"loro-crdt": "^1.8.9"
 	},
 	"peerDependencies": {