silosdk 0.0.9 → 0.0.10

package/dist/store/shared.cjs

@@ -0,0 +1,338 @@
+
+//#region src/store/shared.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 createStoreApi(storage) {
+	function createStore(defaults) {
+		const names = Object.keys(defaults);
+		const nameSet = new Set(names);
+		for (const name of names) {
+			assertSourceName(name);
+			assertFlatDefaults(name, defaults[name]);
+		}
+		if (new Set(names).size !== names.length) throw new Error("Store collection names must be unique.");
+		return {
+			names,
+			collectionOptions(name, options = {}) {
+				assertStoreCollectionName(nameSet, name);
+				return createSourceCollectionOptions(storage, name, defaults[name], options);
+			},
+			linkCollectionOptions(options = {}) {
+				return createLinkCollectionOptions(storage, names, nameSet, options);
+			}
+		};
+	}
+	function source(name, defaults) {
+		assertSourceName(name);
+		assertFlatDefaults(name, defaults);
+		if (sourceNames.has(name)) throw new Error(`Source "${name}" is already registered. Define each source once and import the existing source instead.`);
+		sourceNames.add(name);
+		return {
+			name,
+			defaults,
+			schema: createSourceSchema(name, defaults),
+			collectionOptions(options = {}) {
+				return createSourceCollectionOptions(storage, name, defaults, options);
+			}
+		};
+	}
+	return {
+		createStore,
+		source
+	};
+}
+function createSourceCollectionOptions(storage, name, defaults, options = {}) {
+	return {
+		id: name,
+		getKey: (item) => item.id,
+		schema: createSourceSchema(name, defaults),
+		startSync: options.startSync,
+		sync: { sync({ begin, write, commit, markReady, truncate }) {
+			Promise.resolve(storage.loadRows(name)).then((rows) => {
+				begin();
+				truncate();
+				for (const row of rows) write({
+					type: "insert",
+					value: row
+				});
+				commit();
+				markReady();
+			}).catch((error) => {
+				reportSyncError(name, error);
+				begin();
+				truncate();
+				commit();
+				markReady();
+			});
+		} },
+		onInsert: async ({ transaction }) => {
+			await storage.insertRows(name, transaction.mutations.map((mutation) => mutation.modified));
+		},
+		onUpdate: async ({ transaction }) => {
+			await storage.updateRows(name, transaction.mutations);
+		},
+		onDelete: async ({ transaction }) => {
+			await storage.deleteRows(name, transaction.mutations);
+		}
+	};
+}
+function createLinkCollectionOptions(storage, names, nameSet, options = {}) {
+	const schema = createLinkSchema();
+	let syncBegin;
+	let syncWrite;
+	let syncCommit;
+	const writeSyncedLink = (type, row) => {
+		if (!syncBegin || !syncWrite || !syncCommit) return;
+		syncBegin();
+		syncWrite({
+			type,
+			value: row
+		});
+		syncCommit();
+	};
+	return {
+		id: "silo-links",
+		getKey: (item) => item.id,
+		schema,
+		startSync: options.startSync,
+		sync: { sync({ begin, write, commit, markReady, truncate }) {
+			syncBegin = begin;
+			syncWrite = write;
+			syncCommit = commit;
+			Promise.resolve(storage.loadLinkRows()).then((storedRows) => {
+				const rows = storedRows.map((row) => createLinkRow(names, row));
+				begin();
+				truncate();
+				for (const row of rows) write({
+					type: "insert",
+					value: row
+				});
+				commit();
+				markReady();
+			}).catch((error) => {
+				reportSyncError("silo-links", error);
+				begin();
+				truncate();
+				commit();
+				markReady();
+			});
+		} },
+		onInsert: async ({ transaction }) => {
+			for (const mutation of transaction.mutations) await storage.insertLinkRow(extractStoredLinkRow(mutation.modified));
+		},
+		onDelete: async ({ transaction }) => {
+			for (const mutation of transaction.mutations) await storage.deleteLinkRow(String(mutation.key));
+		},
+		utils: {
+			async link(collectionA, idA, collectionB, idB) {
+				const row = createStoredLinkRow(nameSet, collectionA, idA, collectionB, idB);
+				if (!await storage.insertLinkRow(row)) writeSyncedLink("insert", createLinkRow(names, row));
+			},
+			async unlink(collectionA, idA, collectionB, idB) {
+				const row = createStoredLinkRow(nameSet, collectionA, idA, collectionB, idB);
+				if (await storage.deleteLinkRow(row.id)) writeSyncedLink("delete", createLinkRow(names, row));
+			},
+			has(collectionA, idA, collectionB, idB) {
+				const row = createStoredLinkRow(nameSet, collectionA, idA, collectionB, idB);
+				return storage.hasLinkRow(row.id);
+			}
+		}
+	};
+}
+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 assertStoreCollectionName(nameSet, name) {
+	if (!nameSet.has(name)) throw new Error(`Store collection "${name}" is not registered.`);
+}
+function assertLinkCollectionName(nameSet, name) {
+	if (!nameSet.has(name)) throw new Error(`Cannot link unknown collection "${name}".`);
+}
+function createStoredLinkRow(nameSet, collectionA, idA, collectionB, idB) {
+	assertLinkCollectionName(nameSet, collectionA);
+	assertLinkCollectionName(nameSet, collectionB);
+	if (collectionA === collectionB) throw new Error(`Links between the same collection are not supported. Received "${collectionA}".`);
+	const [firstCollection, firstId, secondCollection, secondId] = collectionA < collectionB ? [
+		collectionA,
+		idA,
+		collectionB,
+		idB
+	] : [
+		collectionB,
+		idB,
+		collectionA,
+		idA
+	];
+	const collections = encodePair(firstCollection, secondCollection);
+	const ids = encodePair(firstId, secondId);
+	return {
+		id: encodePair(collections, ids),
+		collections,
+		ids,
+		createdAt: (/* @__PURE__ */ new Date()).toISOString()
+	};
+}
+function createLinkRow(names, row) {
+	const [firstCollection, secondCollection] = decodePair(row.collections);
+	const [firstId, secondId] = decodePair(row.ids);
+	const result = {
+		id: row.id,
+		collections: row.collections,
+		ids: row.ids,
+		createdAt: row.createdAt
+	};
+	for (const other of names) {
+		const byCurrent = {};
+		for (const current of names) {
+			let id = null;
+			if (other !== current) {
+				if (current === firstCollection && other === secondCollection) id = firstId;
+				else if (current === secondCollection && other === firstCollection) id = secondId;
+			}
+			byCurrent[current] = { id };
+		}
+		result[other] = byCurrent;
+	}
+	return result;
+}
+function extractStoredLinkRow(row) {
+	if (!isRecord(row)) throw new Error("Expected a link row object.");
+	if (typeof row.id !== "string" || typeof row.collections !== "string" || typeof row.ids !== "string" || typeof row.createdAt !== "string") throw new Error("Link rows must include string id, collections, ids, and createdAt fields.");
+	return {
+		id: row.id,
+		collections: row.collections,
+		ids: row.ids,
+		createdAt: row.createdAt
+	};
+}
+function encodePair(first, second) {
+	return `${encodePart(first)}:${encodePart(second)}`;
+}
+function decodePair(value) {
+	const parts = value.split(":");
+	if (parts.length !== 2) throw new Error(`Invalid encoded link pair "${value}".`);
+	return [decodePart(parts[0]), decodePart(parts[1])];
+}
+function encodePart(value) {
+	return encodeURIComponent(value);
+}
+function decodePart(value) {
+	return decodeURIComponent(value);
+}
+function assertFlatDefaults(sourceName, defaults) {
+	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": {
+		version: 1,
+		vendor: "silo",
+		validate(value) {
+			if (!isRecord(value)) return failure("Expected a flat source row object.");
+			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 data) continue;
+				data[field] = resolveDefault(defaultValue);
+			}
+			return { value: createDoc(value.id, data) };
+		}
+	} };
+}
+function createLinkSchema() {
+	return { "~standard": {
+		version: 1,
+		vendor: "silo",
+		validate(value) {
+			try {
+				extractStoredLinkRow(value);
+				return { value };
+			} catch (error) {
+				return failure(error instanceof Error ? error.message : "Expected a link row.");
+			}
+		}
+	} };
+}
+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.");
+	return resolved;
+}
+function isRecord(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isFieldValue(value) {
+	return typeof value === "string" || typeof value === "number" || typeof value === "boolean" || value === null;
+}
+function failure(message, path) {
+	return { issues: [{
+		message,
+		path
+	}] };
+}
+function reportSyncError(collectionName, error) {
+	console.error(`Failed to sync Silo collection "${collectionName}".`, error);
+}
+
+//#endregion
+exports.createDoc = createDoc;
+exports.createStoreApi = createStoreApi;
+exports.decodePair = decodePair;
+exports.deletedDocs = deletedDocs;
+exports.extractDocumentData = extractDocumentData;

package/dist/store/shared.d.cts

@@ -0,0 +1,58 @@
+import { StandardSchemaV1 } from "@standard-schema/spec";
+import { CollectionConfig } from "@tanstack/react-db";
+
+//#region src/store/shared.d.ts
+type FieldValue = string | number | boolean | null;
+type OptionalKeys<T extends object> = { [K in keyof T]-?: object extends Pick<T, K> ? K : never }[keyof T];
+type RequiredKeys<T extends object> = Exclude<keyof T, OptionalKeys<T>>;
+type InvalidDocumentKeys<T extends object> = { [K in keyof T]-?: Exclude<T[K], undefined> extends FieldValue ? never : K }[keyof T];
+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 SourceInput<T extends object> = {
+  id: string;
+  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 StoreDefaults<TCollections extends Record<string, object>> = { [Name in keyof TCollections]: SourceDefaults<TCollections[Name]> };
+type LinkRow<TName extends string = string> = {
+  readonly id: string;
+  readonly collections: string;
+  readonly ids: string;
+  readonly createdAt: string;
+} & { readonly [Other in TName]: { readonly [Current in TName]: {
+  readonly id: string | null;
+} } };
+type LinkUtils<TName extends string = string> = {
+  link(collectionA: TName, idA: string, collectionB: TName, idB: string): Promise<void>;
+  unlink(collectionA: TName, idA: string, collectionB: TName, idB: string): Promise<void>;
+  has(collectionA: TName, idA: string, collectionB: TName, idB: string): boolean;
+};
+type Store<TCollections extends Record<string, object>> = {
+  readonly names: ReadonlyArray<keyof TCollections & string>;
+  collectionOptions<Name$1 extends keyof TCollections & string>(name: Name$1, options?: SourceCollectionOptions<TCollections[Name$1]>): CollectionConfig<SourceRow<TCollections[Name$1]>, string, StandardSchemaV1<any, SourceRow<TCollections[Name$1]>>> & {
+    schema: StandardSchemaV1<any, SourceRow<TCollections[Name$1]>>;
+  };
+  linkCollectionOptions(options?: SourceCollectionOptions<LinkRow<keyof TCollections & string>>): CollectionConfig<LinkRow<keyof TCollections & string>, string, StandardSchemaV1<any, LinkRow<keyof TCollections & string>>, LinkUtils<keyof TCollections & string>> & {
+    schema: StandardSchemaV1<any, LinkRow<keyof TCollections & string>>;
+    utils: LinkUtils<keyof TCollections & string>;
+  };
+};
+type Source<T extends object> = {
+  readonly name: string;
+  readonly defaults: SourceDefaults<T>;
+  readonly schema: StandardSchemaV1<any, SourceRow<T>>;
+  collectionOptions(options?: SourceCollectionOptions<T>): CollectionConfig<SourceRow<T>, string, StandardSchemaV1<any, SourceRow<T>>> & {
+    schema: StandardSchemaV1<any, SourceRow<T>>;
+  };
+};
+//#endregion
+export { DefaultValue, Doc, DocumentData, FieldValue, LinkRow, LinkUtils, Source, SourceCollectionOptions, SourceDefaults, SourceInput, SourceRow, Store, StoreDefaults };

package/dist/store/shared.d.mts

@@ -0,0 +1,58 @@
+import { StandardSchemaV1 } from "@standard-schema/spec";
+import { CollectionConfig } from "@tanstack/react-db";
+
+//#region src/store/shared.d.ts
+type FieldValue = string | number | boolean | null;
+type OptionalKeys<T extends object> = { [K in keyof T]-?: object extends Pick<T, K> ? K : never }[keyof T];
+type RequiredKeys<T extends object> = Exclude<keyof T, OptionalKeys<T>>;
+type InvalidDocumentKeys<T extends object> = { [K in keyof T]-?: Exclude<T[K], undefined> extends FieldValue ? never : K }[keyof T];
+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 SourceInput<T extends object> = {
+  id: string;
+  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 StoreDefaults<TCollections extends Record<string, object>> = { [Name in keyof TCollections]: SourceDefaults<TCollections[Name]> };
+type LinkRow<TName extends string = string> = {
+  readonly id: string;
+  readonly collections: string;
+  readonly ids: string;
+  readonly createdAt: string;
+} & { readonly [Other in TName]: { readonly [Current in TName]: {
+  readonly id: string | null;
+} } };
+type LinkUtils<TName extends string = string> = {
+  link(collectionA: TName, idA: string, collectionB: TName, idB: string): Promise<void>;
+  unlink(collectionA: TName, idA: string, collectionB: TName, idB: string): Promise<void>;
+  has(collectionA: TName, idA: string, collectionB: TName, idB: string): boolean;
+};
+type Store<TCollections extends Record<string, object>> = {
+  readonly names: ReadonlyArray<keyof TCollections & string>;
+  collectionOptions<Name$1 extends keyof TCollections & string>(name: Name$1, options?: SourceCollectionOptions<TCollections[Name$1]>): CollectionConfig<SourceRow<TCollections[Name$1]>, string, StandardSchemaV1<any, SourceRow<TCollections[Name$1]>>> & {
+    schema: StandardSchemaV1<any, SourceRow<TCollections[Name$1]>>;
+  };
+  linkCollectionOptions(options?: SourceCollectionOptions<LinkRow<keyof TCollections & string>>): CollectionConfig<LinkRow<keyof TCollections & string>, string, StandardSchemaV1<any, LinkRow<keyof TCollections & string>>, LinkUtils<keyof TCollections & string>> & {
+    schema: StandardSchemaV1<any, LinkRow<keyof TCollections & string>>;
+    utils: LinkUtils<keyof TCollections & string>;
+  };
+};
+type Source<T extends object> = {
+  readonly name: string;
+  readonly defaults: SourceDefaults<T>;
+  readonly schema: StandardSchemaV1<any, SourceRow<T>>;
+  collectionOptions(options?: SourceCollectionOptions<T>): CollectionConfig<SourceRow<T>, string, StandardSchemaV1<any, SourceRow<T>>> & {
+    schema: StandardSchemaV1<any, SourceRow<T>>;
+  };
+};
+//#endregion
+export { DefaultValue, Doc, DocumentData, FieldValue, LinkRow, LinkUtils, Source, SourceCollectionOptions, SourceDefaults, SourceInput, SourceRow, Store, StoreDefaults };