silosdk 0.0.4 → 0.0.5

package/README.md

@@ -31,7 +31,7 @@ collections.
 
 ```ts
 import { createCollection } from '@tanstack/react-db'
-import { source } from 'silosdk/source'
+import { createID, source } from 'silosdk/source'
 
 type Post = {
   title: string
@@ -55,19 +55,37 @@ Query and mutate with TanStack DB directly:
 ```tsx
 import { eq, useLiveQuery } from '@tanstack/react-db'
 
-const { data = [] } = useLiveQuery((q) =>
+const { data: docs = [] } = useLiveQuery((q) =>
   q.from({ posts }).where(({ posts }) => eq(posts.published, true)),
 )
 
+const doc = docs[0]
+const post = doc?.data()
+
+doc?.id
+post?.title
+```
+
+```ts
+const id = createID()
+
 const tx = posts.insert({
-  id: crypto.randomUUID(),
-  title: 'Hello',
-  body: '',
-  published: false,
-  coverImage: null,
+  id,
+  data: {
+    title: 'Hello',
+    body: '',
+    published: false,
+    coverImage: null,
+  },
 })
 
 await tx.isPersisted.promise
+
+await posts.update(id, (doc) => {
+  doc.set({ published: true })
+}).isPersisted.promise
+
+await posts.delete(id).isPersisted.promise
 ```
 
 Source rows are intentionally flat. Field values must be:
@@ -134,7 +152,7 @@ Store the returned `media://...` ref in source rows:
 
 ```ts
 posts.update(postId, (draft) => {
-  draft.coverImage = coverImage
+  draft.set({ coverImage })
 })
 ```
 

package/dist/media.cjs

@@ -1,8 +1,8 @@
 const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
 let expo_sqlite = require("expo-sqlite");
+let nanoid = require("nanoid");
 let __tanstack_react_query = require("@tanstack/react-query");
 let expo_file_system = require("expo-file-system");
-let nanoid = require("nanoid");
 
 //#region src/media/index.ts
 const media = {

package/dist/media.mjs

@@ -1,7 +1,7 @@
 import { openDatabaseSync } from "expo-sqlite";
+import { nanoid } from "nanoid";
 import { mutationOptions, queryOptions } from "@tanstack/react-query";
 import { Directory, File, Paths } from "expo-file-system";
-import { nanoid } from "nanoid";
 
 //#region src/media/index.ts
 const media = {

package/dist/source.cjs

@@ -1,9 +1,19 @@
 const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
 let expo_sqlite = require("expo-sqlite");
+let nanoid = require("nanoid");
 
 //#region src/source/index.ts
 const sourceNames = /* @__PURE__ */ new Set();
 const sourceNamePattern = /^[A-Za-z][A-Za-z0-9_-]*$/;
+const reservedDocumentFields = new Set([
+	"id",
+	"data",
+	"set"
+]);
+const deletedDocs = /* @__PURE__ */ new WeakSet();
+function createID() {
+	return (0, nanoid.nanoid)();
+}
 function source(name, defaults) {
 	assertSourceName(name);
 	assertFlatDefaults(name, defaults);
@@ -38,7 +48,7 @@ function source(name, defaults) {
 					await updateRows(name, transaction.mutations);
 				},
 				onDelete: async ({ transaction }) => {
-					await deleteRows(name, transaction.mutations.map((mutation) => mutation.key));
+					await deleteRows(name, transaction.mutations);
 				}
 			};
 		}
@@ -48,7 +58,10 @@ function assertSourceName(name) {
 	if (!sourceNamePattern.test(name)) throw new Error(`Source names must start with a letter and contain only letters, numbers, underscores, or hyphens. Received "${name}".`);
 }
 function assertFlatDefaults(sourceName, defaults) {
-	for (const [field, defaultValue] of Object.entries(defaults)) if (!isFieldValue(resolveDefault(defaultValue))) throw new Error(`Source "${sourceName}" field "${field}" must default to a string, number, boolean, null, or a function returning one of those values.`);
+	for (const [field, defaultValue] of Object.entries(defaults)) {
+		if (reservedDocumentFields.has(field)) throw new Error(`Source "${sourceName}" field "${field}" is reserved by Silo documents.`);
+		if (!isFieldValue(resolveDefault(defaultValue))) throw new Error(`Source "${sourceName}" field "${field}" must default to a string, number, boolean, null, or a function returning one of those values.`);
+	}
 }
 function createSourceSchema(sourceName, defaults) {
 	return { "~standard": {
@@ -56,21 +69,64 @@ function createSourceSchema(sourceName, defaults) {
 		vendor: "silo",
 		validate(value) {
 			if (!isRecord(value)) return failure("Expected a flat source row object.");
-			if (typeof value.id !== "string") return failure("Expected source row field \"id\" to be a string.", ["id"]);
-			const row = { id: value.id };
-			for (const [field, fieldValue] of Object.entries(value)) {
-				if (field === "id") continue;
-				if (!isFieldValue(fieldValue)) return failure(`Source "${sourceName}" field "${field}" must be a string, number, boolean, or null.`, [field]);
-				row[field] = fieldValue;
+			if (typeof value.id !== "string") return failure("Expected source document field \"id\" to be a string.", ["id"]);
+			const inputData = isRecord(value.data) ? value.data : extractDocumentData(value);
+			const data = {};
+			for (const [field, fieldValue] of Object.entries(inputData)) {
+				if (reservedDocumentFields.has(field)) return failure(`Source "${sourceName}" field "${field}" is reserved by Silo documents.`, ["data", field]);
+				if (!isFieldValue(fieldValue)) return failure(`Source "${sourceName}" field "${field}" must be a string, number, boolean, or null.`, ["data", field]);
+				data[field] = fieldValue;
 			}
 			for (const [field, defaultValue] of Object.entries(defaults)) {
-				if (field in row) continue;
-				row[field] = resolveDefault(defaultValue);
+				if (field in data) continue;
+				data[field] = resolveDefault(defaultValue);
 			}
-			return { value: row };
+			return { value: createDoc(value.id, data) };
 		}
 	} };
 }
+function createDoc(id, data) {
+	const doc = {};
+	Object.defineProperty(doc, "id", {
+		value: id,
+		enumerable: true,
+		writable: false,
+		configurable: false
+	});
+	for (const [field, value] of Object.entries(data)) Object.defineProperty(doc, field, {
+		value,
+		enumerable: true,
+		writable: true,
+		configurable: true
+	});
+	Object.defineProperty(doc, "data", {
+		value() {
+			return deletedDocs.has(this) ? null : extractDocumentData(this);
+		},
+		enumerable: true,
+		writable: false,
+		configurable: false
+	});
+	Object.defineProperty(doc, "set", {
+		get() {
+			return function setDocumentData(patch) {
+				Object.assign(this, patch);
+			};
+		},
+		enumerable: true,
+		configurable: false
+	});
+	return doc;
+}
+function extractDocumentData(value) {
+	if (!isRecord(value)) return {};
+	const data = {};
+	for (const [field, fieldValue] of Object.entries(value)) {
+		if (reservedDocumentFields.has(field) || field.startsWith("$") || typeof fieldValue === "function") continue;
+		if (isFieldValue(fieldValue)) data[field] = fieldValue;
+	}
+	return data;
+}
 function resolveDefault(value) {
 	const resolved = typeof value === "function" ? value() : value;
 	if (!isFieldValue(resolved)) throw new Error("Source defaults must resolve to a string, number, boolean, or null.");
@@ -109,21 +165,18 @@ function getDatabase() {
 	return database;
 }
 function loadRows(sourceName) {
-	return getDatabase().getAllSync(`SELECT id, data FROM sources WHERE source = ?`, [sourceName]).map((row) => ({
-		id: row.id,
-		...JSON.parse(row.data)
-	}));
+	return getDatabase().getAllSync(`SELECT id, data FROM sources WHERE source = ?`, [sourceName]).map((row) => createDoc(row.id, JSON.parse(row.data)));
 }
 function insertRows(sourceName, rows) {
 	const db = getDatabase();
 	const timestamp = (/* @__PURE__ */ new Date()).toISOString();
 	db.withTransactionSync(() => {
 		for (const row of rows) {
-			const { id, ...data } = row;
+			const data = extractDocumentData(row);
 			db.runSync(`INSERT INTO sources (source, id, data, createdAt, updatedAt, version)
          VALUES (?, ?, ?, ?, ?, 1)`, [
 				sourceName,
-				id,
+				row.id,
 				JSON.stringify(data),
 				timestamp,
 				timestamp
@@ -137,7 +190,8 @@ function updateRows(sourceName, mutations) {
 	const timestamp = (/* @__PURE__ */ new Date()).toISOString();
 	db.withTransactionSync(() => {
 		for (const mutation of mutations) {
-			const { id, ...data } = mutation.modified;
+			const data = extractDocumentData(mutation.modified);
+			mutation.modified = createDoc(String(mutation.key), data);
 			db.runSync(`UPDATE sources
          SET data = ?, updatedAt = ?, version = version + 1
          WHERE source = ? AND id = ?`, [
@@ -150,13 +204,18 @@ function updateRows(sourceName, mutations) {
 	});
 	return Promise.resolve();
 }
-function deleteRows(sourceName, ids) {
+function deleteRows(sourceName, mutations) {
 	const db = getDatabase();
 	db.withTransactionSync(() => {
-		for (const id of ids) db.runSync(`DELETE FROM sources WHERE source = ? AND id = ?`, [sourceName, String(id)]);
+		for (const mutation of mutations) {
+			if (mutation.original) deletedDocs.add(mutation.original);
+			deletedDocs.add(mutation.modified);
+			db.runSync(`DELETE FROM sources WHERE source = ? AND id = ?`, [sourceName, String(mutation.key)]);
+		}
 	});
 	return Promise.resolve();
 }
 
 //#endregion
+exports.createID = createID;
 exports.source = source;

package/dist/source.d.cts

@@ -9,21 +9,28 @@ type InvalidDocumentKeys<T extends object> = { [K in keyof T]-?: Exclude<T[K], u
 type DocumentData<T extends object> = InvalidDocumentKeys<T> extends never ? T : never;
 type DefaultValue<T> = Exclude<T, undefined> | (() => Exclude<T, undefined>);
 type SourceDefaults<T extends object> = { [K in RequiredKeys<DocumentData<T>>]: DefaultValue<DocumentData<T>[K]> } & { [K in OptionalKeys<DocumentData<T>>]?: DefaultValue<DocumentData<T>[K]> };
-type SourceRow<T extends object> = {
-  id: string;
-} & DocumentData<T>;
 type SourceInput<T extends object> = {
   id: string;
-} & Partial<DocumentData<T>>;
+  data: Partial<DocumentData<T>>;
+};
+type Doc<T extends object> = {
+  readonly id: string;
+  data(): DocumentData<T> | null;
+  readonly set: (patch: Partial<DocumentData<T>>) => void;
+} & DocumentData<T>;
+type SourceRow<T extends object> = Doc<T>;
 type SourceCollectionOptions<T extends object> = {
   startSync?: boolean;
 };
 type Source<T extends object> = {
   readonly name: string;
   readonly defaults: SourceDefaults<T>;
-  readonly schema: StandardSchemaV1<SourceInput<T>, SourceRow<T>>;
-  collectionOptions(options?: SourceCollectionOptions<T>): CollectionConfig<SourceRow<T>, string, StandardSchemaV1<SourceInput<T>, SourceRow<T>>>;
+  readonly schema: StandardSchemaV1<any, SourceRow<T>>;
+  collectionOptions(options?: SourceCollectionOptions<T>): CollectionConfig<SourceRow<T>, string, StandardSchemaV1<any, SourceRow<T>>> & {
+    schema: StandardSchemaV1<any, SourceRow<T>>;
+  };
 };
+declare function createID(): string;
 declare function source<T extends object>(name: string, defaults: SourceDefaults<T>): Source<T>;
 //#endregion
-export { DefaultValue, DocumentData, FieldValue, Source, SourceCollectionOptions, SourceDefaults, SourceInput, SourceRow, source };
+export { DefaultValue, Doc, DocumentData, FieldValue, Source, SourceCollectionOptions, SourceDefaults, SourceInput, SourceRow, createID, source };

package/dist/source.d.mts

@@ -9,21 +9,28 @@ type InvalidDocumentKeys<T extends object> = { [K in keyof T]-?: Exclude<T[K], u
 type DocumentData<T extends object> = InvalidDocumentKeys<T> extends never ? T : never;
 type DefaultValue<T> = Exclude<T, undefined> | (() => Exclude<T, undefined>);
 type SourceDefaults<T extends object> = { [K in RequiredKeys<DocumentData<T>>]: DefaultValue<DocumentData<T>[K]> } & { [K in OptionalKeys<DocumentData<T>>]?: DefaultValue<DocumentData<T>[K]> };
-type SourceRow<T extends object> = {
-  id: string;
-} & DocumentData<T>;
 type SourceInput<T extends object> = {
   id: string;
-} & Partial<DocumentData<T>>;
+  data: Partial<DocumentData<T>>;
+};
+type Doc<T extends object> = {
+  readonly id: string;
+  data(): DocumentData<T> | null;
+  readonly set: (patch: Partial<DocumentData<T>>) => void;
+} & DocumentData<T>;
+type SourceRow<T extends object> = Doc<T>;
 type SourceCollectionOptions<T extends object> = {
   startSync?: boolean;
 };
 type Source<T extends object> = {
   readonly name: string;
   readonly defaults: SourceDefaults<T>;
-  readonly schema: StandardSchemaV1<SourceInput<T>, SourceRow<T>>;
-  collectionOptions(options?: SourceCollectionOptions<T>): CollectionConfig<SourceRow<T>, string, StandardSchemaV1<SourceInput<T>, SourceRow<T>>>;
+  readonly schema: StandardSchemaV1<any, SourceRow<T>>;
+  collectionOptions(options?: SourceCollectionOptions<T>): CollectionConfig<SourceRow<T>, string, StandardSchemaV1<any, SourceRow<T>>> & {
+    schema: StandardSchemaV1<any, SourceRow<T>>;
+  };
 };
+declare function createID(): string;
 declare function source<T extends object>(name: string, defaults: SourceDefaults<T>): Source<T>;
 //#endregion
-export { DefaultValue, DocumentData, FieldValue, Source, SourceCollectionOptions, SourceDefaults, SourceInput, SourceRow, source };
+export { DefaultValue, Doc, DocumentData, FieldValue, Source, SourceCollectionOptions, SourceDefaults, SourceInput, SourceRow, createID, source };

package/dist/source.mjs

@@ -1,8 +1,18 @@
 import { openDatabaseSync } from "expo-sqlite";
+import { nanoid } from "nanoid";
 
 //#region src/source/index.ts
 const sourceNames = /* @__PURE__ */ new Set();
 const sourceNamePattern = /^[A-Za-z][A-Za-z0-9_-]*$/;
+const reservedDocumentFields = new Set([
+	"id",
+	"data",
+	"set"
+]);
+const deletedDocs = /* @__PURE__ */ new WeakSet();
+function createID() {
+	return nanoid();
+}
 function source(name, defaults) {
 	assertSourceName(name);
 	assertFlatDefaults(name, defaults);
@@ -37,7 +47,7 @@ function source(name, defaults) {
 					await updateRows(name, transaction.mutations);
 				},
 				onDelete: async ({ transaction }) => {
-					await deleteRows(name, transaction.mutations.map((mutation) => mutation.key));
+					await deleteRows(name, transaction.mutations);
 				}
 			};
 		}
@@ -47,7 +57,10 @@ function assertSourceName(name) {
 	if (!sourceNamePattern.test(name)) throw new Error(`Source names must start with a letter and contain only letters, numbers, underscores, or hyphens. Received "${name}".`);
 }
 function assertFlatDefaults(sourceName, defaults) {
-	for (const [field, defaultValue] of Object.entries(defaults)) if (!isFieldValue(resolveDefault(defaultValue))) throw new Error(`Source "${sourceName}" field "${field}" must default to a string, number, boolean, null, or a function returning one of those values.`);
+	for (const [field, defaultValue] of Object.entries(defaults)) {
+		if (reservedDocumentFields.has(field)) throw new Error(`Source "${sourceName}" field "${field}" is reserved by Silo documents.`);
+		if (!isFieldValue(resolveDefault(defaultValue))) throw new Error(`Source "${sourceName}" field "${field}" must default to a string, number, boolean, null, or a function returning one of those values.`);
+	}
 }
 function createSourceSchema(sourceName, defaults) {
 	return { "~standard": {
@@ -55,21 +68,64 @@ function createSourceSchema(sourceName, defaults) {
 		vendor: "silo",
 		validate(value) {
 			if (!isRecord(value)) return failure("Expected a flat source row object.");
-			if (typeof value.id !== "string") return failure("Expected source row field \"id\" to be a string.", ["id"]);
-			const row = { id: value.id };
-			for (const [field, fieldValue] of Object.entries(value)) {
-				if (field === "id") continue;
-				if (!isFieldValue(fieldValue)) return failure(`Source "${sourceName}" field "${field}" must be a string, number, boolean, or null.`, [field]);
-				row[field] = fieldValue;
+			if (typeof value.id !== "string") return failure("Expected source document field \"id\" to be a string.", ["id"]);
+			const inputData = isRecord(value.data) ? value.data : extractDocumentData(value);
+			const data = {};
+			for (const [field, fieldValue] of Object.entries(inputData)) {
+				if (reservedDocumentFields.has(field)) return failure(`Source "${sourceName}" field "${field}" is reserved by Silo documents.`, ["data", field]);
+				if (!isFieldValue(fieldValue)) return failure(`Source "${sourceName}" field "${field}" must be a string, number, boolean, or null.`, ["data", field]);
+				data[field] = fieldValue;
 			}
 			for (const [field, defaultValue] of Object.entries(defaults)) {
-				if (field in row) continue;
-				row[field] = resolveDefault(defaultValue);
+				if (field in data) continue;
+				data[field] = resolveDefault(defaultValue);
 			}
-			return { value: row };
+			return { value: createDoc(value.id, data) };
 		}
 	} };
 }
+function createDoc(id, data) {
+	const doc = {};
+	Object.defineProperty(doc, "id", {
+		value: id,
+		enumerable: true,
+		writable: false,
+		configurable: false
+	});
+	for (const [field, value] of Object.entries(data)) Object.defineProperty(doc, field, {
+		value,
+		enumerable: true,
+		writable: true,
+		configurable: true
+	});
+	Object.defineProperty(doc, "data", {
+		value() {
+			return deletedDocs.has(this) ? null : extractDocumentData(this);
+		},
+		enumerable: true,
+		writable: false,
+		configurable: false
+	});
+	Object.defineProperty(doc, "set", {
+		get() {
+			return function setDocumentData(patch) {
+				Object.assign(this, patch);
+			};
+		},
+		enumerable: true,
+		configurable: false
+	});
+	return doc;
+}
+function extractDocumentData(value) {
+	if (!isRecord(value)) return {};
+	const data = {};
+	for (const [field, fieldValue] of Object.entries(value)) {
+		if (reservedDocumentFields.has(field) || field.startsWith("$") || typeof fieldValue === "function") continue;
+		if (isFieldValue(fieldValue)) data[field] = fieldValue;
+	}
+	return data;
+}
 function resolveDefault(value) {
 	const resolved = typeof value === "function" ? value() : value;
 	if (!isFieldValue(resolved)) throw new Error("Source defaults must resolve to a string, number, boolean, or null.");
@@ -108,21 +164,18 @@ function getDatabase() {
 	return database;
 }
 function loadRows(sourceName) {
-	return getDatabase().getAllSync(`SELECT id, data FROM sources WHERE source = ?`, [sourceName]).map((row) => ({
-		id: row.id,
-		...JSON.parse(row.data)
-	}));
+	return getDatabase().getAllSync(`SELECT id, data FROM sources WHERE source = ?`, [sourceName]).map((row) => createDoc(row.id, JSON.parse(row.data)));
 }
 function insertRows(sourceName, rows) {
 	const db = getDatabase();
 	const timestamp = (/* @__PURE__ */ new Date()).toISOString();
 	db.withTransactionSync(() => {
 		for (const row of rows) {
-			const { id, ...data } = row;
+			const data = extractDocumentData(row);
 			db.runSync(`INSERT INTO sources (source, id, data, createdAt, updatedAt, version)
          VALUES (?, ?, ?, ?, ?, 1)`, [
 				sourceName,
-				id,
+				row.id,
 				JSON.stringify(data),
 				timestamp,
 				timestamp
@@ -136,7 +189,8 @@ function updateRows(sourceName, mutations) {
 	const timestamp = (/* @__PURE__ */ new Date()).toISOString();
 	db.withTransactionSync(() => {
 		for (const mutation of mutations) {
-			const { id, ...data } = mutation.modified;
+			const data = extractDocumentData(mutation.modified);
+			mutation.modified = createDoc(String(mutation.key), data);
 			db.runSync(`UPDATE sources
          SET data = ?, updatedAt = ?, version = version + 1
          WHERE source = ? AND id = ?`, [
@@ -149,13 +203,17 @@ function updateRows(sourceName, mutations) {
 	});
 	return Promise.resolve();
 }
-function deleteRows(sourceName, ids) {
+function deleteRows(sourceName, mutations) {
 	const db = getDatabase();
 	db.withTransactionSync(() => {
-		for (const id of ids) db.runSync(`DELETE FROM sources WHERE source = ? AND id = ?`, [sourceName, String(id)]);
+		for (const mutation of mutations) {
+			if (mutation.original) deletedDocs.add(mutation.original);
+			deletedDocs.add(mutation.modified);
+			db.runSync(`DELETE FROM sources WHERE source = ? AND id = ?`, [sourceName, String(mutation.key)]);
+		}
 	});
 	return Promise.resolve();
 }
 
 //#endregion
-export { source };
+export { createID, source };

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "silosdk",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "type": "module",
   "scripts": {
     "build": "tsdown",
     "watch": "tsdown --watch",
     "test": "vitest run",
-    "publish": "tsdown && npm publish"
+    "pub": "tsdown && npm publish"
   },
   "packageManager": "yarn@1.22.22",
   "files": [