@foretag/tanstack-db-surrealdb 0.1.1 → 0.1.2

package/README.md

@@ -51,13 +51,12 @@ type Product = {
 
 export const products = createCollection(
 	surrealCollection<Product>({
-		id: 'products',
+		db,
 		useLoro: true, // Optional if you need CRDTs
-		getKey: (collection) => collection.id,
 		table: {
-			db,
 			name: 'products',
-			where: expr(eq('store', '123'))
+			where: expr(eq('store', '123')),
+			fields: ['name', 'price'] // Optional or defaults to *
 		},
 	});
 )

package/dist/index.d.mts

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

package/dist/index.d.ts

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

package/dist/index.js

@@ -27,16 +27,13 @@ var import_surrealdb2 = require("surrealdb");
 
 // src/table.ts
 var import_surrealdb = require("surrealdb");
-function manageTable({
-  db,
-  name,
-  ...args
-}) {
+function manageTable(db, { name, ...args }) {
+  const fields = args.fields?.join(", ") ?? "*";
   const listAll = async () => {
-    return await db.select(new import_surrealdb.Table(name)).where(args.where).fields(args.fields);
+    return await db.select(new import_surrealdb.Table(name)).where(args.where).fields(fields);
   };
   const listActive = async () => {
-    return await db.select(new import_surrealdb.Table(name)).where((0, import_surrealdb.and)(args.where, (0, import_surrealdb.eq)("sync_deleted", false))).fields(args.fields);
+    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({
@@ -104,6 +101,7 @@ function surrealCollectionOptions({
   id,
   useLoro = false,
   onError,
+  db,
   ...config
 }) {
   let loro;
@@ -236,7 +234,7 @@ function surrealCollectionOptions({
     }
     prevById = currById;
   };
-  const table = manageTable(config.table);
+  const table = manageTable(db, config.table);
   const sync = ({
     begin,
     write,

package/dist/index.mjs

@@ -9,16 +9,13 @@ import {
   Table,
   Uuid
 } from "surrealdb";
-function manageTable({
-  db,
-  name,
-  ...args
-}) {
+function manageTable(db, { name, ...args }) {
+  const fields = args.fields?.join(", ") ?? "*";
   const listAll = async () => {
-    return await db.select(new Table(name)).where(args.where).fields(args.fields);
+    return await db.select(new Table(name)).where(args.where).fields(fields);
   };
   const listActive = async () => {
-    return await db.select(new Table(name)).where(and(args.where, eq("sync_deleted", false))).fields(args.fields);
+    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({
@@ -86,6 +83,7 @@ function surrealCollectionOptions({
   id,
   useLoro = false,
   onError,
+  db,
   ...config
 }) {
   let loro;
@@ -218,7 +216,7 @@ function surrealCollectionOptions({
     }
     prevById = currById;
   };
-  const table = manageTable(config.table);
+  const table = manageTable(db, config.table);
   const sync = ({
     begin,
     write,

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.1",
+	"version": "0.1.2",
 	"files": [
 		"dist"
 	],
@@ -42,11 +42,11 @@
 	"dependencies": {
 		"@tanstack/db": "^0.4.10",
 		"loro-crdt": "^1.8.4",
-		"surrealdb": "2.0.0-alpha.8"
+		"surrealdb": "2.0.0-alpha.9"
 	},
 	"devDependencies": {
 		"@biomejs/biome": "^2.2.6",
-		"bunup": "^0.14.20",
+		"@tanstack/svelte-db": "^0.1.32",
 		"tsup": "^8.5.0"
 	}
 }