event-sourced-collection 0.0.12 → 0.0.13

package/dist/browser-event-sourced-db-D3vSW3QV.d.mts

@@ -0,0 +1,121 @@
+import { $ as InjectedCreateCollection, L as SyncLock, P as SQLiteDriver, et as InjectedModuleFn, p as EventSourcedSharedOptions } from "./types-uO49i9Ae.mjs";
+import { r as ModulesInput, t as EventSourcedDBHandle } from "./create-event-sourced-db-handle-DmHdplVr.mjs";
+import { PersistedCollectionPersistence } from "@tanstack/db-sqlite-persistence-core";
+
+//#region src/platforms/browser-wa-sqlite-driver.d.ts
+type BrowserWASQLiteDatabase = {
+  execute: <TRow = unknown>(sql: string, params?: ReadonlyArray<unknown>) => Promise<ReadonlyArray<TRow>>;
+  close?: () => Promise<void> | void;
+};
+//#endregion
+//#region src/platforms/browser-types.d.ts
+type BrowserCoordinatorInstance = {
+  dispose: () => void;
+};
+/**
+ * Injected TanStack browser persistence bindings. Parameters are `never` so
+ * version-skewed `@tanstack/browser-db-sqlite-persistence` exports stay assignable.
+ */
+type BrowserPlatformDeps = {
+  openBrowserWASQLiteOPFSDatabase: (options: never) => Promise<BrowserWASQLiteDatabase>;
+  createBrowserWASQLitePersistence: (options: never) => PersistedCollectionPersistence;
+  BrowserCollectionCoordinator: new (options: never) => BrowserCoordinatorInstance;
+};
+type BrowserPlatformConfig = {
+  databaseName: string;
+  coordinatorDbName?: string;
+};
+type BrowserPlatformResult = {
+  driver: SQLiteDriver;
+  persistence: PersistedCollectionPersistence;
+  close: () => Promise<void>;
+};
+//#endregion
+//#region src/platforms/browser-event-sourced-db.d.ts
+type CollectionDefConstraint = {
+  getKey: (state: never) => string | number;
+};
+type BrowserEventSourcedModules = BrowserPlatformDeps & {
+  createCollection: InjectedCreateCollection;
+  persistedCollectionOptions: InjectedModuleFn;
+};
+/**
+ * Browser entry-point config. Shared sync/lifecycle fields come from
+ * {@link EventSourcedSharedOptions} (hover those properties for docs).
+ * Deep guide: `docs/usage.md`.
+ */
+type BrowserEventSourcedDBConfig<TDefs extends Record<string, CollectionDefConstraint>> = Omit<EventSourcedSharedOptions, "lock" | "lockName"> & {
+  /**
+   * User collection registry. Object keys become `db.collections.<key>` and
+   * the wire `collectionId`. Must not collide with reserved names.
+   */
+  collections: TDefs;
+  /**
+   * OPFS SQLite database file name (e.g. `"my-app.sqlite"`). Also used as the
+   * default sync lock namespace so only one tab syncs for this DB at a time.
+   */
+  databaseName: string;
+  /**
+   * Name for the cross-tab collection coordinator database. Defaults to
+   * `databaseName` with a trailing `.sqlite` stripped.
+   */
+  coordinatorDbName?: string;
+  /**
+   * Browser OPFS persistence modules from
+   * `@tanstack/browser-db-sqlite-persistence` plus `createCollection`.
+   * Pass the imported bindings directly, or a function to keep WASM off the
+   * critical path.
+   */
+  modules: ModulesInput<BrowserEventSourcedModules>;
+  /**
+   * Defaults to a Web Locks–backed lock so only one tab syncs at a time.
+   * Pass `null` to opt out and let every tab sync independently.
+   */
+  lock?: SyncLock | null;
+};
+/**
+ * Browser-flavoured event-sourced DB: OPFS SQLite + optional Web Locks sync
+ * election, returned as a lazy singleton.
+ *
+ * @param config - See {@link BrowserEventSourcedDBConfig} for every option.
+ *
+ * @example
+ * ```ts
+ * import { createBrowserEventSourcedDB } from "event-sourced-collection/browser"
+ * import type { CollectionDef, EventSourcedDB } from "event-sourced-collection"
+ *
+ * type Todo = { id: string; title: string }
+ * type Defs = { todos: CollectionDef<Todo, string> }
+ *
+ * const { ensureDb, db } = createBrowserEventSourcedDB<Defs>({
+ *   databaseName: "app.sqlite",
+ *   collections: { todos: { getKey: (todo) => todo.id } },
+ *   sync: { push: "/api/sync/events", pull: "/api/sync/events" },
+ *   modules: async () => {
+ *     const { createCollection } = await import("@tanstack/db")
+ *     const {
+ *       BrowserCollectionCoordinator,
+ *       createBrowserWASQLitePersistence,
+ *       openBrowserWASQLiteOPFSDatabase,
+ *       persistedCollectionOptions,
+ *     } = await import("@tanstack/browser-db-sqlite-persistence")
+ *     return {
+ *       createCollection,
+ *       BrowserCollectionCoordinator,
+ *       createBrowserWASQLitePersistence,
+ *       openBrowserWASQLiteOPFSDatabase,
+ *       persistedCollectionOptions,
+ *     }
+ *   },
+ * })
+ *
+ * export async function start() {
+ *   await ensureDb()
+ * }
+ * export { db }
+ * ```
+ */
+declare function createBrowserEventSourcedDB<const TDefs extends Record<string, CollectionDefConstraint>>(config: BrowserEventSourcedDBConfig<TDefs>): EventSourcedDBHandle<TDefs>;
+//#endregion
+export { BrowserPlatformConfig as a, BrowserWASQLiteDatabase as c, BrowserCoordinatorInstance as i, BrowserEventSourcedModules as n, BrowserPlatformDeps as o, createBrowserEventSourcedDB as r, BrowserPlatformResult as s, BrowserEventSourcedDBConfig as t };
+//# sourceMappingURL=browser-event-sourced-db-D3vSW3QV.d.mts.map

package/dist/browser-event-sourced-db-D3vSW3QV.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-event-sourced-db-D3vSW3QV.d.mts","names":[],"sources":["../src/platforms/browser-wa-sqlite-driver.ts","../src/platforms/browser-types.ts","../src/platforms/browser-event-sourced-db.ts"],"mappings":";;;;;KAEY,uBAAA;EACV,OAAA,mBACE,GAAA,UACA,MAAA,GAAS,aAAA,cACN,OAAA,CAAQ,aAAA,CAAc,IAAA;EAC3B,KAAA,SAAc,OAAA;AAAA;;;KCJJ,0BAAA;EACV,OAAO;AAAA;ADFT;;;;AAAA,KCSY,mBAAA;EACV,+BAAA,GAAkC,OAAA,YAAmB,OAAA,CAAQ,uBAAA;EAC7D,gCAAA,GAAmC,OAAA,YAAmB,8BAAA;EACtD,4BAAA,OAAmC,OAAA,YAAmB,0BAAA;AAAA;AAAA,KAG5C,qBAAA;EACV,YAAA;EACA,iBAAiB;AAAA;AAAA,KAGP,qBAAA;EACV,MAAA,EAD+B,YAAA;EAE/B,WAAA,EAAa,8BAAA;EACb,KAAA,QAAa,OAAA;AAAA;;;KCTV,uBAAA;EACH,MAAA,GAAS,KAAY;AAAA;AAAA,KAGX,0BAAA,GAA6B,mBAAA;EACvC,gBAAA,EAAkB,wBAAA;EAClB,0BAAA,EAA4B,gBAAA;AAAA;;;;;;KAQlB,2BAAA,eAA0C,MAAA,SAAe,uBAAA,KACnE,IAAA,CAAK,yBAAA;EF3BH;;;;EEgCA,WAAA,EAAa,KAAA;EF9BY;;;;EEmCzB,YAAA;;;;ADtCJ;EC2CI,iBAAA;;;AD1CK;AAOT;;;EC0CI,OAAA,EAAS,YAAA,CAAa,0BAAA;EDzC6B;;;;EC8CnD,IAAA,GAAO,QAAA;AAAA;;;;;;;;;;AD5CuE;AAGlF;;;;AAEmB;AAGnB;;;;;;;;;;;;;;;AAGsB;;;;ACZqC;;;;AAIpC;AAGvB;;;iBAqFgB,2BAAA,qBACM,MAAA,SAAe,uBAAA,GACnC,MAAA,EAAQ,2BAAA,CAA4B,KAAA,IAAM,oBAAA,CAAA,KAAA"}

package/dist/browser.d.mts

@@ -1,36 +1,6 @@
-import { $ as InjectedCreateCollection, L as SyncLock, P as SQLiteDriver, et as InjectedModuleFn, p as EventSourcedSharedOptions } from "./types-DrV5f9_t.mjs";
-import { r as ModulesInput, t as EventSourcedDBHandle } from "./create-event-sourced-db-handle-Di5qN4QH.mjs";
-import { PersistedCollectionPersistence } from "@tanstack/db-sqlite-persistence-core";
+import { a as BrowserPlatformConfig, c as BrowserWASQLiteDatabase, i as BrowserCoordinatorInstance, n as BrowserEventSourcedModules, o as BrowserPlatformDeps, r as createBrowserEventSourcedDB, s as BrowserPlatformResult, t as BrowserEventSourcedDBConfig } from "./browser-event-sourced-db-D3vSW3QV.mjs";
+import { t as EventSourcedDBHandle } from "./create-event-sourced-db-handle-DmHdplVr.mjs";
 
-//#region src/platforms/browser-wa-sqlite-driver.d.ts
-type BrowserWASQLiteDatabase = {
-  execute: <TRow = unknown>(sql: string, params?: ReadonlyArray<unknown>) => Promise<ReadonlyArray<TRow>>;
-  close?: () => Promise<void> | void;
-};
-//#endregion
-//#region src/platforms/browser-types.d.ts
-type BrowserCoordinatorInstance = {
-  dispose: () => void;
-};
-/**
- * Injected TanStack browser persistence bindings. Parameters are `never` so
- * version-skewed `@tanstack/browser-db-sqlite-persistence` exports stay assignable.
- */
-type BrowserPlatformDeps = {
-  openBrowserWASQLiteOPFSDatabase: (options: never) => Promise<BrowserWASQLiteDatabase>;
-  createBrowserWASQLitePersistence: (options: never) => PersistedCollectionPersistence;
-  BrowserCollectionCoordinator: new (options: never) => BrowserCoordinatorInstance;
-};
-type BrowserPlatformConfig = {
-  databaseName: string;
-  coordinatorDbName?: string;
-};
-type BrowserPlatformResult = {
-  driver: SQLiteDriver;
-  persistence: PersistedCollectionPersistence;
-  close: () => Promise<void>;
-};
-//#endregion
 //#region src/platforms/browser.d.ts
 /**
  * Opens OPFS SQLite, a cross-tab coordinator, and TanStack persistence.
@@ -61,91 +31,5 @@ type BrowserPlatformResult = {
  */
 declare function createBrowserPlatform(deps: BrowserPlatformDeps, config: BrowserPlatformConfig): Promise<BrowserPlatformResult>;
 //#endregion
-//#region src/platforms/browser-event-sourced-db.d.ts
-type CollectionDefConstraint = {
-  getKey: (state: never) => string | number;
-};
-type BrowserEventSourcedModules = BrowserPlatformDeps & {
-  createCollection: InjectedCreateCollection;
-  persistedCollectionOptions: InjectedModuleFn;
-};
-/**
- * Browser entry-point config. Shared sync/lifecycle fields come from
- * {@link EventSourcedSharedOptions} (hover those properties for docs).
- * Deep guide: `docs/usage.md`.
- */
-type BrowserEventSourcedDBConfig<TDefs extends Record<string, CollectionDefConstraint>> = Omit<EventSourcedSharedOptions, "lock" | "lockName"> & {
-  /**
-   * User collection registry. Object keys become `db.collections.<key>` and
-   * the wire `collectionId`. Must not collide with reserved names.
-   */
-  collections: TDefs;
-  /**
-   * OPFS SQLite database file name (e.g. `"my-app.sqlite"`). Also used as the
-   * default sync lock namespace so only one tab syncs for this DB at a time.
-   */
-  databaseName: string;
-  /**
-   * Name for the cross-tab collection coordinator database. Defaults to
-   * `databaseName` with a trailing `.sqlite` stripped.
-   */
-  coordinatorDbName?: string;
-  /**
-   * Browser OPFS persistence modules from
-   * `@tanstack/browser-db-sqlite-persistence` plus `createCollection`.
-   * Pass the imported bindings directly, or a function to keep WASM off the
-   * critical path.
-   */
-  modules: ModulesInput<BrowserEventSourcedModules>;
-  /**
-   * Defaults to a Web Locks–backed lock so only one tab syncs at a time.
-   * Pass `null` to opt out and let every tab sync independently.
-   */
-  lock?: SyncLock | null;
-};
-/**
- * Browser-flavoured event-sourced DB: OPFS SQLite + optional Web Locks sync
- * election, returned as a lazy singleton.
- *
- * @param config - See {@link BrowserEventSourcedDBConfig} for every option.
- *
- * @example
- * ```ts
- * import { createBrowserEventSourcedDB } from "event-sourced-collection/browser"
- * import type { CollectionDef, EventSourcedDB } from "event-sourced-collection"
- *
- * type Todo = { id: string; title: string }
- * type Defs = { todos: CollectionDef<Todo, string> }
- *
- * const { ensureDb, db } = createBrowserEventSourcedDB<Defs>({
- *   databaseName: "app.sqlite",
- *   collections: { todos: { getKey: (todo) => todo.id } },
- *   sync: { push: "/api/sync/events", pull: "/api/sync/events" },
- *   modules: async () => {
- *     const { createCollection } = await import("@tanstack/db")
- *     const {
- *       BrowserCollectionCoordinator,
- *       createBrowserWASQLitePersistence,
- *       openBrowserWASQLiteOPFSDatabase,
- *       persistedCollectionOptions,
- *     } = await import("@tanstack/browser-db-sqlite-persistence")
- *     return {
- *       createCollection,
- *       BrowserCollectionCoordinator,
- *       createBrowserWASQLitePersistence,
- *       openBrowserWASQLiteOPFSDatabase,
- *       persistedCollectionOptions,
- *     }
- *   },
- * })
- *
- * export async function start() {
- *   await ensureDb()
- * }
- * export { db }
- * ```
- */
-declare function createBrowserEventSourcedDB<const TDefs extends Record<string, CollectionDefConstraint>>(config: BrowserEventSourcedDBConfig<TDefs>): EventSourcedDBHandle<TDefs>;
-//#endregion
 export { type BrowserCoordinatorInstance, type BrowserEventSourcedDBConfig, type EventSourcedDBHandle as BrowserEventSourcedDBHandle, type BrowserEventSourcedModules, type BrowserPlatformConfig, type BrowserPlatformDeps, type BrowserPlatformResult, type BrowserWASQLiteDatabase, createBrowserEventSourcedDB, createBrowserPlatform };
 //# sourceMappingURL=browser.d.mts.map

package/dist/browser.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"browser.d.mts","names":[],"sources":["../src/platforms/browser-wa-sqlite-driver.ts","../src/platforms/browser-types.ts","../src/platforms/browser.ts","../src/platforms/browser-event-sourced-db.ts"],"mappings":";;;;;KAEY,uBAAA;EACV,OAAA,mBACE,GAAA,UACA,MAAA,GAAS,aAAA,cACN,OAAA,CAAQ,aAAA,CAAc,IAAA;EAC3B,KAAA,SAAc,OAAA;AAAA;;;KCJJ,0BAAA;EACV,OAAO;AAAA;;ADFT;;;KCSY,mBAAA;EACV,+BAAA,GAAkC,OAAA,YAAmB,OAAA,CAAQ,uBAAA;EAC7D,gCAAA,GAAmC,OAAA,YAAmB,8BAAA;EACtD,4BAAA,OAAmC,OAAA,YAAmB,0BAAA;AAAA;AAAA,KAG5C,qBAAA;EACV,YAAA;EACA,iBAAiB;AAAA;AAAA,KAGP,qBAAA;EACV,MAAA,EAD+B,YAAA;EAE/B,WAAA,EAAa,8BAAA;EACb,KAAA,QAAa,OAAA;AAAA;;;;;;ADvBf;;;;;;;;;;;;;;;;;;;;;AAKuB;;;iBEoCD,qBAAA,CACpB,IAAA,EAAM,mBAAA,EACN,MAAA,EAAQ,qBAAA,GACP,OAAA,CAAQ,qBAAA;;;KC9BN,uBAAA;EACH,MAAA,GAAS,KAAY;AAAA;AAAA,KAGX,0BAAA,GAA6B,mBAAA;EACvC,gBAAA,EAAkB,wBAAA;EAClB,0BAAA,EAA4B,gBAAA;AAAA;;;;;;KAQlB,2BAAA,eAA0C,MAAA,SAAe,uBAAA,KACnE,IAAA,CAAK,yBAAA;EH5BK;;;;EGiCR,WAAA,EAAa,KAAA;EH9BF;;;;EGmCX,YAAA;EHlCmB;;;;EGuCnB,iBAAA;EF3CkC;;;AAC7B;AAOT;;EE0CI,OAAA,EAAS,YAAA,CAAa,0BAAA;EFzCqC;;;;EE8C3D,IAAA,GAAO,QAAA;AAAA;;;;;;;;;;;AF5CuE;AAGlF;;;;AAEmB;AAGnB;;;;;;;;;;;;;;;AAGsB;;;;ACkBtB;;;;;;;iBC8DgB,2BAAA,qBACM,MAAA,SAAe,uBAAA,GACnC,MAAA,EAAQ,2BAAA,CAA4B,KAAA,IAAM,oBAAA,CAAA,KAAA"}
+{"version":3,"file":"browser.d.mts","names":[],"sources":["../src/platforms/browser.ts"],"mappings":";;;;;AA2CA;;;;;;;;;;;;;;;;AAGgC;;;;;;;;;;iBAHV,qBAAA,CACpB,IAAA,EAAM,mBAAA,EACN,MAAA,EAAQ,qBAAA,GACP,OAAA,CAAQ,qBAAA"}

package/dist/browser.mjs

@@ -1,4 +1,4 @@
-import { n as resolveModules, t as createEventSourcedDBHandle } from "./create-event-sourced-db-handle-CD8WSjXW.mjs";
+import { n as resolveModules, t as createEventSourcedDBHandle } from "./create-event-sourced-db-handle-BqV3vLjS.mjs";
 import { t as createWebLocksSyncLock } from "./web-locks-Bi2f732X.mjs";
 //#region src/platforms/browser-wa-sqlite-driver.ts
 function assertTransactionCallbackHasDriverArg(fn) {

package/dist/{create-event-sourced-db-handle-CD8WSjXW.mjs → create-event-sourced-db-handle-BqV3vLjS.mjs}

@@ -115,6 +115,22 @@ async function replayEvent(context, event) {
 			reason
 		};
 	}
+	if (context.localOnlyIds.has(collectionId)) {
+		const reason = `local-only collection "${collectionId}"`;
+		log.debug("replay skipped: local-only collection", {
+			eventId,
+			collectionId
+		});
+		context.emit("onEventSkipped", {
+			eventId,
+			collectionId,
+			reason
+		});
+		return {
+			status: "skipped",
+			reason
+		};
+	}
 	const migrated = upcast(context, event);
 	if (migrated.status !== "ok") return migrated.outcome;
 	const target = targets[collectionId];
@@ -1459,9 +1475,14 @@ async function createEventSourcedDB(config) {
 	};
 	const { outbox, inbox, deadletter, syncmeta, rowversions } = meta;
 	const userCollections = {};
+	const localOnlyIds = new Set(Object.keys(config.collections).filter((id) => config.collections[id].localOnly === true));
 	for (const collectionId of Object.keys(config.collections)) {
 		const def = config.collections[collectionId];
 		const getKey = def.getKey;
+		const hook = (type) => def.localOnly ? noOutboxHook : createMutationHook({
+			...mutationContext,
+			type
+		});
 		const mutationContext = {
 			outbox,
 			rowversions,
@@ -1479,18 +1500,9 @@ async function createEventSourcedDB(config) {
 			persistence: config.persistence,
 			schemaVersion: def.schemaVersion ?? defaultSchemaVersion,
 			gcTime: Number.POSITIVE_INFINITY,
-			onInsert: createMutationHook({
-				...mutationContext,
-				type: "insert"
-			}),
-			onUpdate: createMutationHook({
-				...mutationContext,
-				type: "update"
-			}),
-			onDelete: createMutationHook({
-				...mutationContext,
-				type: "delete"
-			})
+			onInsert: hook("insert"),
+			onUpdate: hook("update"),
+			onDelete: hook("delete")
 		});
 		const collection = config.createCollection(options);
 		applyCollectionIndexes(collection, collectionId, def.indexes, log);
@@ -1532,8 +1544,10 @@ async function createEventSourcedDB(config) {
 		clientId: clientId.value,
 		pullCursor: readPullCursor(syncmeta, inbox)
 	});
+	for (const entry of [...outbox.state.values()]) if (!entry.sync && localOnlyIds.has(entry.collectionId)) await outbox.delete(entry.eventId).isPersisted.promise;
 	const replayContext = {
 		targets: replayTargets,
+		localOnlyIds,
 		rowversions,
 		deadletter,
 		unknownEventHandling,
@@ -1959,6 +1973,10 @@ function applyCollectionIndexes(collection, collectionId, indexes, log) {
 	register();
 	indexable.on?.("status:ready", register);
 }
+/** Handler for `localOnly` collections: persist locally, author no event. */
+async function noOutboxHook() {
+	return {};
+}
 function createMutationHook(context) {
 	const { outbox, rowversions, collectionId, type, seq, clientId, eventSchemaVersion, conflictDetection, emit, log } = context;
 	return async (params) => {
@@ -2183,4 +2201,4 @@ async function resolveModules(modules) {
 //#endregion
 export { generateEventId as a, resolvePushLimits as c, createHttpTransport as d, BackendMismatchError as f, createEventSourcedDB as i, SyncPullError as l, resolveModules as n, createEventSourcedLogger as o, createLazySingleton as r, SYNC_PUSH_PRESETS as s, createEventSourcedDBHandle as t, SyncPushError as u };
 
-//# sourceMappingURL=create-event-sourced-db-handle-CD8WSjXW.mjs.map
+//# sourceMappingURL=create-event-sourced-db-handle-BqV3vLjS.mjs.map