silosdk 0.0.7 → 0.0.9

package/README.md

@@ -25,14 +25,14 @@ TanStack owns:
 yarn add silosdk @tanstack/react-db @tanstack/react-query expo-crypto expo-sqlite expo-file-system
 ```
 
-## Datastores
+## Stores
 
-Datastores define SQLite-backed document collections and a link collection for
+Stores define SQLite-backed document collections and a link collection for
 relationships between them. They produce options for TanStack DB collections.
 
 ```ts
 import { createCollection } from '@tanstack/react-db'
-import { createDatastore, createID } from 'silosdk/source'
+import { createID, createStore } from 'silosdk/store'
 
 type Post = {
   title: string
@@ -45,7 +45,7 @@ type Tag = {
   name: string
 }
 
-export const datastore = createDatastore<{
+export const store = createStore<{
   posts: Post
   tags: Tag
 }>({
@@ -60,9 +60,9 @@ export const datastore = createDatastore<{
   },
 })
 
-export const posts = createCollection(datastore.collectionOptions('posts'))
-export const tags = createCollection(datastore.collectionOptions('tags'))
-export const links = createCollection(datastore.linkCollectionOptions())
+export const posts = createCollection(store.collectionOptions('posts'))
+export const tags = createCollection(store.collectionOptions('tags'))
+export const links = createCollection(store.linkCollectionOptions())
 ```
 
 Query and mutate with TanStack DB directly:
@@ -149,8 +149,8 @@ a different semantic relationship.
 
 ## Sources
 
-The lower-level `source()` API remains available when you only need one
-collection definition.
+The lower-level `source()` API remains available from `silosdk/store` when you
+only need one collection definition.
 
 ## Settings
 
@@ -223,16 +223,30 @@ const { data: uri } = useQuery(media.queryOptions(post.coverImage))
 `media.queryOptions()` returns `string | null`. It returns `null` when the ref is
 empty, invalid, unknown, or missing on disk.
 
+Delete a media ref when your app no longer stores it:
+
+```tsx
+const deleteMedia = useMutation(media.deleteMutationOptions({ queryClient }))
+
+await deleteMedia.mutateAsync(coverImage)
+```
+
+Deletion removes Silo's copied file and media mapping only. Remove the ref from
+your own source rows or settings separately. Invalid or unknown refs are safe and
+return `false`.
+
 ## API Shape
 
 Silo exposes definition objects and option factories:
 
 ```ts
-createCollection(postsSource.collectionOptions())
+createCollection(store.collectionOptions('posts'))
+createCollection(store.linkCollectionOptions())
 useQuery(theme.queryOptions())
 useMutation(theme.mutationOptions({ queryClient }))
 useQuery(media.queryOptions(ref))
 useMutation(media.mutationOptions({ queryClient }))
+useMutation(media.deleteMutationOptions({ queryClient }))
 ```
 
 There is no Silo provider and no Silo hook wrapper API.

package/dist/media.cjs

@@ -25,6 +25,23 @@ const media = {
 				return imported.ref;
 			}
 		});
+	},
+	delete(ref) {
+		return deleteMedia(ref);
+	},
+	deleteMutationOptions(options = {}) {
+		return (0, __tanstack_react_query.mutationOptions)({
+			mutationKey: [
+				"silo",
+				"media",
+				"delete"
+			],
+			mutationFn: async (ref) => {
+				const deleted = await deleteMedia(ref);
+				if (isMediaRef(ref)) options.queryClient?.setQueryData(mediaQueryKey(ref), null);
+				return deleted;
+			}
+		});
 	}
 };
 function isMediaRef(value) {
@@ -71,10 +88,22 @@ async function importMedia(input) {
 }
 function resolveMediaUri(ref) {
 	if (!isMediaRef(ref)) return null;
-	const row = getDatabase().getFirstSync(`SELECT ref, uri FROM media_files WHERE ref = ?`, [ref]);
+	const row = getMediaFile(ref);
 	if (!row) return null;
 	return new expo_file_system.File(row.uri).exists ? row.uri : null;
 }
+async function deleteMedia(ref) {
+	if (!isMediaRef(ref)) return false;
+	const row = getMediaFile(ref);
+	if (!row) return false;
+	const file = new expo_file_system.File(row.uri);
+	if (file.exists) await file.delete();
+	deleteMediaFileRow(ref);
+	return true;
+}
+function getMediaFile(ref) {
+	return getDatabase().getFirstSync(`SELECT ref, uri FROM media_files WHERE ref = ?`, [ref]);
+}
 function createMediaRef(kind, id) {
 	return `media://silo/${kindDirectoryName(kind)}/${id}`;
 }
@@ -129,6 +158,9 @@ function insertMediaFile(file) {
 		JSON.stringify(file.data)
 	]);
 }
+function deleteMediaFileRow(ref) {
+	getDatabase().runSync(`DELETE FROM media_files WHERE ref = ?`, [ref]);
+}
 
 //#endregion
 exports.isMediaRef = isMediaRef;

package/dist/media.d.cts

@@ -16,6 +16,7 @@ type MediaImportInput = {
   mimeType?: string | null;
   data?: MediaData;
 };
+type MediaDeleteInput = MediaRef | string | null | undefined;
 type MediaQueryKey = readonly ['silo', 'media', MediaRef | string | null];
 type MediaMutationOptions = {
   queryClient?: QueryClient;
@@ -23,7 +24,9 @@ type MediaMutationOptions = {
 declare const media: {
   queryOptions(ref: MediaRef | string | null | undefined): UseQueryOptions<string | null, Error, string | null, MediaQueryKey>;
   mutationOptions(options?: MediaMutationOptions): UseMutationOptions<MediaRef, Error, MediaImportInput>;
+  delete(ref: MediaDeleteInput): Promise<boolean>;
+  deleteMutationOptions(options?: MediaMutationOptions): UseMutationOptions<boolean, Error, MediaDeleteInput>;
 };
 declare function isMediaRef(value: unknown): value is MediaRef;
 //#endregion
-export { MediaData, MediaImportInput, MediaJson, MediaKind, MediaMutationOptions, MediaQueryKey, MediaRef, isMediaRef, media };
+export { MediaData, MediaDeleteInput, MediaImportInput, MediaJson, MediaKind, MediaMutationOptions, MediaQueryKey, MediaRef, isMediaRef, media };

package/dist/media.d.mts

@@ -16,6 +16,7 @@ type MediaImportInput = {
   mimeType?: string | null;
   data?: MediaData;
 };
+type MediaDeleteInput = MediaRef | string | null | undefined;
 type MediaQueryKey = readonly ['silo', 'media', MediaRef | string | null];
 type MediaMutationOptions = {
   queryClient?: QueryClient;
@@ -23,7 +24,9 @@ type MediaMutationOptions = {
 declare const media: {
   queryOptions(ref: MediaRef | string | null | undefined): UseQueryOptions<string | null, Error, string | null, MediaQueryKey>;
   mutationOptions(options?: MediaMutationOptions): UseMutationOptions<MediaRef, Error, MediaImportInput>;
+  delete(ref: MediaDeleteInput): Promise<boolean>;
+  deleteMutationOptions(options?: MediaMutationOptions): UseMutationOptions<boolean, Error, MediaDeleteInput>;
 };
 declare function isMediaRef(value: unknown): value is MediaRef;
 //#endregion
-export { MediaData, MediaImportInput, MediaJson, MediaKind, MediaMutationOptions, MediaQueryKey, MediaRef, isMediaRef, media };
+export { MediaData, MediaDeleteInput, MediaImportInput, MediaJson, MediaKind, MediaMutationOptions, MediaQueryKey, MediaRef, isMediaRef, media };

package/dist/media.mjs

@@ -24,6 +24,23 @@ const media = {
 				return imported.ref;
 			}
 		});
+	},
+	delete(ref) {
+		return deleteMedia(ref);
+	},
+	deleteMutationOptions(options = {}) {
+		return mutationOptions({
+			mutationKey: [
+				"silo",
+				"media",
+				"delete"
+			],
+			mutationFn: async (ref) => {
+				const deleted = await deleteMedia(ref);
+				if (isMediaRef(ref)) options.queryClient?.setQueryData(mediaQueryKey(ref), null);
+				return deleted;
+			}
+		});
 	}
 };
 function isMediaRef(value) {
@@ -70,10 +87,22 @@ async function importMedia(input) {
 }
 function resolveMediaUri(ref) {
 	if (!isMediaRef(ref)) return null;
-	const row = getDatabase().getFirstSync(`SELECT ref, uri FROM media_files WHERE ref = ?`, [ref]);
+	const row = getMediaFile(ref);
 	if (!row) return null;
 	return new File(row.uri).exists ? row.uri : null;
 }
+async function deleteMedia(ref) {
+	if (!isMediaRef(ref)) return false;
+	const row = getMediaFile(ref);
+	if (!row) return false;
+	const file = new File(row.uri);
+	if (file.exists) await file.delete();
+	deleteMediaFileRow(ref);
+	return true;
+}
+function getMediaFile(ref) {
+	return getDatabase().getFirstSync(`SELECT ref, uri FROM media_files WHERE ref = ?`, [ref]);
+}
 function createMediaRef(kind, id) {
 	return `media://silo/${kindDirectoryName(kind)}/${id}`;
 }
@@ -128,6 +157,9 @@ function insertMediaFile(file) {
 		JSON.stringify(file.data)
 	]);
 }
+function deleteMediaFileRow(ref) {
+	getDatabase().runSync(`DELETE FROM media_files WHERE ref = ?`, [ref]);
+}
 
 //#endregion
 export { isMediaRef, media };

package/dist/{source.cjs → store.cjs}

@@ -2,7 +2,7 @@ const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
 let expo_crypto = require("expo-crypto");
 let expo_sqlite = require("expo-sqlite");
 
-//#region src/source/index.ts
+//#region src/store/index.ts
 const sourceNames = /* @__PURE__ */ new Set();
 const sourceNamePattern = /^[A-Za-z][A-Za-z0-9_-]*$/;
 const reservedDocumentFields = new Set([
@@ -14,18 +14,18 @@ const deletedDocs = /* @__PURE__ */ new WeakSet();
 function createID() {
 	return (0, expo_crypto.randomUUID)();
 }
-function createDatastore(defaults) {
+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("Datastore collection names must be unique.");
+	if (new Set(names).size !== names.length) throw new Error("Store collection names must be unique.");
 	return {
 		names,
 		collectionOptions(name, options = {}) {
-			assertDatastoreCollectionName(nameSet, name);
+			assertStoreCollectionName(nameSet, name);
 			return createSourceCollectionOptions(name, defaults[name], options);
 		},
 		linkCollectionOptions(options = {}) {
@@ -136,8 +136,8 @@ function createLinkCollectionOptions(names, nameSet, options = {}) {
 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 assertDatastoreCollectionName(nameSet, name) {
-	if (!nameSet.has(name)) throw new Error(`Datastore collection "${name}" is not registered.`);
+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}".`);
@@ -427,6 +427,6 @@ function deleteLinksForSourceRow(sourceName, id) {
 }
 
 //#endregion
-exports.createDatastore = createDatastore;
 exports.createID = createID;
+exports.createStore = createStore;
 exports.source = source;

package/dist/{source.d.cts → store.d.cts}

@@ -1,7 +1,7 @@
 import { StandardSchemaV1 } from "@standard-schema/spec";
 import { CollectionConfig } from "@tanstack/react-db";
 
-//#region src/source/index.d.ts
+//#region src/store/index.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>>;
@@ -22,7 +22,7 @@ type SourceRow<T extends object> = Doc<T>;
 type SourceCollectionOptions<T extends object> = {
   startSync?: boolean;
 };
-type DatastoreDefaults<TCollections extends Record<string, object>> = { [Name in keyof TCollections]: SourceDefaults<TCollections[Name]> };
+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;
@@ -36,7 +36,7 @@ type LinkUtils<TName extends string = string> = {
   unlink(collectionA: TName, idA: string, collectionB: TName, idB: string): Promise<void>;
   has(collectionA: TName, idA: string, collectionB: TName, idB: string): boolean;
 };
-type Datastore<TCollections extends Record<string, object>> = {
+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]>>;
@@ -55,7 +55,7 @@ type Source<T extends object> = {
   };
 };
 declare function createID(): string;
-declare function createDatastore<TCollections extends Record<string, object>>(defaults: DatastoreDefaults<TCollections>): Datastore<TCollections>;
+declare function createStore<TCollections extends Record<string, object>>(defaults: StoreDefaults<TCollections>): Store<TCollections>;
 declare function source<T extends object>(name: string, defaults: SourceDefaults<T>): Source<T>;
 //#endregion
-export { Datastore, DatastoreDefaults, DefaultValue, Doc, DocumentData, FieldValue, LinkRow, LinkUtils, Source, SourceCollectionOptions, SourceDefaults, SourceInput, SourceRow, createDatastore, createID, source };
+export { DefaultValue, Doc, DocumentData, FieldValue, LinkRow, LinkUtils, Source, SourceCollectionOptions, SourceDefaults, SourceInput, SourceRow, Store, StoreDefaults, createID, createStore, source };

package/dist/{source.d.mts → store.d.mts}

@@ -1,7 +1,7 @@
 import { StandardSchemaV1 } from "@standard-schema/spec";
 import { CollectionConfig } from "@tanstack/react-db";
 
-//#region src/source/index.d.ts
+//#region src/store/index.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>>;
@@ -22,7 +22,7 @@ type SourceRow<T extends object> = Doc<T>;
 type SourceCollectionOptions<T extends object> = {
   startSync?: boolean;
 };
-type DatastoreDefaults<TCollections extends Record<string, object>> = { [Name in keyof TCollections]: SourceDefaults<TCollections[Name]> };
+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;
@@ -36,7 +36,7 @@ type LinkUtils<TName extends string = string> = {
   unlink(collectionA: TName, idA: string, collectionB: TName, idB: string): Promise<void>;
   has(collectionA: TName, idA: string, collectionB: TName, idB: string): boolean;
 };
-type Datastore<TCollections extends Record<string, object>> = {
+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]>>;
@@ -55,7 +55,7 @@ type Source<T extends object> = {
   };
 };
 declare function createID(): string;
-declare function createDatastore<TCollections extends Record<string, object>>(defaults: DatastoreDefaults<TCollections>): Datastore<TCollections>;
+declare function createStore<TCollections extends Record<string, object>>(defaults: StoreDefaults<TCollections>): Store<TCollections>;
 declare function source<T extends object>(name: string, defaults: SourceDefaults<T>): Source<T>;
 //#endregion
-export { Datastore, DatastoreDefaults, DefaultValue, Doc, DocumentData, FieldValue, LinkRow, LinkUtils, Source, SourceCollectionOptions, SourceDefaults, SourceInput, SourceRow, createDatastore, createID, source };
+export { DefaultValue, Doc, DocumentData, FieldValue, LinkRow, LinkUtils, Source, SourceCollectionOptions, SourceDefaults, SourceInput, SourceRow, Store, StoreDefaults, createID, createStore, source };

package/dist/{source.mjs → store.mjs}

@@ -1,7 +1,7 @@
 import { randomUUID } from "expo-crypto";
 import { openDatabaseSync } from "expo-sqlite";
 
-//#region src/source/index.ts
+//#region src/store/index.ts
 const sourceNames = /* @__PURE__ */ new Set();
 const sourceNamePattern = /^[A-Za-z][A-Za-z0-9_-]*$/;
 const reservedDocumentFields = new Set([
@@ -13,18 +13,18 @@ const deletedDocs = /* @__PURE__ */ new WeakSet();
 function createID() {
 	return randomUUID();
 }
-function createDatastore(defaults) {
+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("Datastore collection names must be unique.");
+	if (new Set(names).size !== names.length) throw new Error("Store collection names must be unique.");
 	return {
 		names,
 		collectionOptions(name, options = {}) {
-			assertDatastoreCollectionName(nameSet, name);
+			assertStoreCollectionName(nameSet, name);
 			return createSourceCollectionOptions(name, defaults[name], options);
 		},
 		linkCollectionOptions(options = {}) {
@@ -135,8 +135,8 @@ function createLinkCollectionOptions(names, nameSet, options = {}) {
 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 assertDatastoreCollectionName(nameSet, name) {
-	if (!nameSet.has(name)) throw new Error(`Datastore collection "${name}" is not registered.`);
+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}".`);
@@ -426,4 +426,4 @@ function deleteLinksForSourceRow(sourceName, id) {
 }
 
 //#endregion
-export { createDatastore, createID, source };
+export { createID, createStore, source };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "silosdk",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "type": "module",
   "scripts": {
     "build": "tsdown",
@@ -45,14 +45,14 @@
     "printWidth": 80,
     "tabWidth": 2
   },
-  "main": "./dist/source.cjs",
-  "module": "./dist/source.mjs",
-  "types": "./dist/source.d.cts",
+  "main": "./dist/store.cjs",
+  "module": "./dist/store.mjs",
+  "types": "./dist/store.d.cts",
   "exports": {
-    "./source": {
-      "types": "./dist/source.d.mts",
-      "import": "./dist/source.mjs",
-      "require": "./dist/source.cjs"
+    "./store": {
+      "types": "./dist/store.d.mts",
+      "import": "./dist/store.mjs",
+      "require": "./dist/store.cjs"
     },
     "./settings": {
       "types": "./dist/settings.d.mts",