@byearlybird/starling 0.4.0 → 0.5.0

package/dist/index.d.ts

@@ -75,9 +75,14 @@ declare const create$1: (iterable?: Iterable<readonly [string, EncodedDocument]>
   };
 };
 declare namespace store_d_exports {
-  export { Plugin, PluginHandle, PluginMethods, Store as StarlingStore, StoreHooks, StoreOnBeforeDelete, StoreOnBeforePatch, StoreOnBeforePut, StoreOnDelete, StoreOnPatch, StoreOnPut, StoreTransaction, create };
+  export { DeepPartial, NotPromise, Plugin, PluginMethods, Store as StarlingStore, StoreHooks, StoreOnDelete, StoreOnPatch, StoreOnPut, StorePutOptions, StoreSetTransaction, create };
 }
 type DeepPartial<T$1> = T$1 extends object ? { [P in keyof T$1]?: DeepPartial<T$1[P]> } : T$1;
+/**
+ * Type constraint to prevent Promise returns from set callbacks.
+ * Transactions must be synchronous operations.
+ */
+type NotPromise<T$1> = T$1 extends Promise<any> ? never : T$1;
 /**
  * Called once per commit with all put operations accumulated as decoded entries.
  * Only fires if at least one put occurred.
@@ -93,68 +98,47 @@ type StoreOnPatch<T$1> = (entries: ReadonlyArray<readonly [string, T$1]>) => voi
  * Only fires if at least one delete occurred.
  */
 type StoreOnDelete = (keys: ReadonlyArray<string>) => void;
-/**
- * Called before a put operation is applied.
- * Throws to reject the operation.
- */
-type StoreOnBeforePut<T$1> = (key: string, value: T$1) => void;
-/**
- * Called before a patch operation is applied.
- * Throws to reject the operation.
- */
-type StoreOnBeforePatch<T$1> = (key: string, value: DeepPartial<T$1>) => void;
-/**
- * Called before a delete operation is applied.
- * Throws to reject the operation.
- */
-type StoreOnBeforeDelete = (key: string) => void;
 /**
  * Hook callbacks that receive batches of decoded entries.
  * Hooks fire on commit only, never during staged operations.
  * Arrays are readonly to prevent external mutation.
  */
 type StoreHooks<T$1> = {
-  onBeforePut?: StoreOnBeforePut<T$1>;
-  onBeforePatch?: StoreOnBeforePatch<T$1>;
-  onBeforeDelete?: StoreOnBeforeDelete;
   onPut?: StoreOnPut<T$1>;
   onPatch?: StoreOnPatch<T$1>;
   onDelete?: StoreOnDelete;
 };
-type StoreTransaction<T$1> = {
-  put: (key: string, value: T$1) => void;
+type StorePutOptions = {
+  withId?: string;
+};
+type StoreSetTransaction<T$1> = {
+  put: (value: T$1, options?: StorePutOptions) => string;
   patch: (key: string, value: DeepPartial<T$1>) => void;
   merge: (doc: EncodedDocument) => void;
   del: (key: string) => void;
-  has: (key: string) => boolean;
-  commit: (opts?: {
-    silent: boolean;
-  }) => void;
+  get: (key: string) => T$1 | null;
   rollback: () => void;
 };
 type PluginMethods = Record<string, (...args: any[]) => any>;
-type PluginHandle<T$1, M$1 extends PluginMethods = {}> = {
-  init: () => Promise<void> | void;
+type Plugin<T$1, M$1 extends PluginMethods = {}> = {
+  init: (store: Store<T$1>) => Promise<void> | void;
   dispose: () => Promise<void> | void;
   hooks?: StoreHooks<T$1>;
   methods?: M$1;
 };
-type Plugin<T$1, M$1 extends PluginMethods = {}> = (store: Store<T$1, any>) => PluginHandle<T$1, M$1>;
 type Store<T$1, Extended = {}> = {
   get: (key: string) => T$1 | null;
-  has: (key: string) => boolean;
-  readonly size: number;
-  values: () => IterableIterator<T$1>;
+  set: <R = void>(callback: (tx: StoreSetTransaction<T$1>) => NotPromise<R>, opts?: {
+    silent?: boolean;
+  }) => NotPromise<R>;
   entries: () => IterableIterator<readonly [string, T$1]>;
   snapshot: () => EncodedDocument[];
-  put: (key: string, value: T$1) => void;
-  patch: (key: string, value: DeepPartial<T$1>) => void;
-  del: (key: string) => void;
-  begin: () => StoreTransaction<T$1>;
   use: <M extends PluginMethods>(plugin: Plugin<T$1, M>) => Store<T$1, Extended & M>;
   init: () => Promise<Store<T$1, Extended>>;
   dispose: () => Promise<void>;
 } & Extended;
-declare const create: <T>() => Store<T, {}>;
+declare const create: <T>(config?: {
+  getId?: () => string;
+}) => Store<T, {}>;
 //#endregion
 export { type clock_d_exports as Clock, document_d_exports as Document, eventstamp_d_exports as Eventstamp, kv_d_exports as KV, record_d_exports as Record, store_d_exports as Store, value_d_exports as Value };

package/dist/index.js

@@ -226,20 +226,18 @@ const create$1 = (iterable) => {
 //#endregion
 //#region src/store.ts
 var store_exports = /* @__PURE__ */ __export({ create: () => create });
-const create = () => {
+const create = (config = {}) => {
 	const kv = create$1();
 	const clock = create$2();
+	const initializers = /* @__PURE__ */ new Set();
+	const disposers = /* @__PURE__ */ new Set();
+	const getId = config.getId ?? (() => crypto.randomUUID());
 	const encodeValue = (key, value) => encode(key, value, clock.now());
 	const listeners = {
-		beforePut: /* @__PURE__ */ new Set(),
-		beforePatch: /* @__PURE__ */ new Set(),
-		beforeDel: /* @__PURE__ */ new Set(),
 		put: /* @__PURE__ */ new Set(),
 		patch: /* @__PURE__ */ new Set(),
 		del: /* @__PURE__ */ new Set()
 	};
-	const initializers = /* @__PURE__ */ new Set();
-	const disposers = /* @__PURE__ */ new Set();
 	const decodeActive = (doc) => {
 		if (!doc || doc["~deletedAt"]) return null;
 		return decode(doc)["~data"];
@@ -248,18 +246,6 @@ const create = () => {
 		get(key) {
 			return decodeActive(kv.get(key));
 		},
-		has(key) {
-			return decodeActive(kv.get(key)) !== null;
-		},
-		values() {
-			function* iterator() {
-				for (const doc of kv.values()) {
-					const data = decodeActive(doc);
-					if (data !== null) yield data;
-				}
-			}
-			return iterator();
-		},
 		entries() {
 			function* iterator() {
 				for (const [key, doc] of kv.entries()) {
@@ -272,45 +258,27 @@ const create = () => {
 		snapshot() {
 			return Array.from(kv.values());
 		},
-		get size() {
-			let count = 0;
-			for (const doc of kv.values()) if (doc && !doc["~deletedAt"]) count++;
-			return count;
-		},
-		put(key, value) {
-			const tx = this.begin();
-			tx.put(key, value);
-			tx.commit();
-		},
-		patch(key, value) {
-			const tx = this.begin();
-			tx.patch(key, value);
-			tx.commit();
-		},
-		del(key) {
-			const tx = this.begin();
-			tx.del(key);
-			tx.commit();
-		},
-		begin() {
+		set(callback, opts) {
 			const tx = kv.begin();
+			const silent = opts?.silent ?? false;
 			const putKeyValues = [];
 			const patchKeyValues = [];
 			const deleteKeys = [];
-			return {
-				put(key, value) {
-					for (const fn of listeners.beforePut) fn(key, value);
+			let rolledBack = false;
+			const setTransaction = {
+				put(value, options) {
+					const key = options?.withId ?? getId();
 					tx.put(key, encodeValue(key, value));
 					putKeyValues.push([key, value]);
+					return key;
 				},
 				patch(key, value) {
-					for (const fn of listeners.beforePatch) fn(key, value);
 					tx.patch(key, encode(key, value, clock.now()));
 					const merged = decodeActive(tx.get(key));
 					if (merged) patchKeyValues.push([key, merged]);
 				},
 				merge(doc) {
-					if (tx.has(doc["~id"])) tx.patch(doc["~id"], doc);
+					if (tx.get(doc["~id"])) tx.patch(doc["~id"], doc);
 					else tx.put(doc["~id"], doc);
 					const currentDoc = tx.get(doc["~id"]);
 					if (currentDoc && !currentDoc["~deletedAt"]) {
@@ -319,50 +287,36 @@ const create = () => {
 					}
 				},
 				del(key) {
-					for (const fn of listeners.beforeDel) fn(key);
 					if (!tx.get(key)) return;
 					tx.del(key, clock.now());
 					deleteKeys.push(key);
 				},
-				has(key) {
-					return tx.has(key);
-				},
-				commit(opts = { silent: false }) {
-					tx.commit();
-					if (opts.silent) return;
-					if (putKeyValues.length > 0) for (const fn of listeners.put) fn(Object.freeze([...putKeyValues]));
-					if (patchKeyValues.length > 0) for (const fn of listeners.patch) fn(Object.freeze([...patchKeyValues]));
-					if (deleteKeys.length > 0) for (const fn of listeners.del) fn(Object.freeze([...deleteKeys]));
+				get(key) {
+					return decodeActive(tx.get(key));
 				},
 				rollback() {
+					rolledBack = true;
 					tx.rollback();
 				}
 			};
+			try {
+				const result = callback(setTransaction);
+				if (rolledBack) return result;
+				tx.commit();
+				if (!silent) {
+					if (putKeyValues.length > 0) for (const fn of listeners.put) fn(Object.freeze([...putKeyValues]));
+					if (patchKeyValues.length > 0) for (const fn of listeners.patch) fn(Object.freeze([...patchKeyValues]));
+					if (deleteKeys.length > 0) for (const fn of listeners.del) fn(Object.freeze([...deleteKeys]));
+				}
+				return result;
+			} catch (error) {
+				tx.rollback();
+				throw error;
+			}
 		},
 		use(plugin) {
-			const { hooks: pluginHooks, init, dispose, methods } = plugin(this);
+			const { hooks: pluginHooks, init, dispose, methods } = plugin;
 			if (pluginHooks) {
-				if (pluginHooks.onBeforePut) {
-					const callback = pluginHooks.onBeforePut;
-					listeners.beforePut.add(callback);
-					disposers.add(() => {
-						listeners.beforePut.delete(callback);
-					});
-				}
-				if (pluginHooks.onBeforePatch) {
-					const callback = pluginHooks.onBeforePatch;
-					listeners.beforePatch.add(callback);
-					disposers.add(() => {
-						listeners.beforePatch.delete(callback);
-					});
-				}
-				if (pluginHooks.onBeforeDelete) {
-					const callback = pluginHooks.onBeforeDelete;
-					listeners.beforeDel.add(callback);
-					disposers.add(() => {
-						listeners.beforeDel.delete(callback);
-					});
-				}
 				if (pluginHooks.onPut) {
 					const callback = pluginHooks.onPut;
 					listeners.put.add(callback);
@@ -391,7 +345,7 @@ const create = () => {
 			return this;
 		},
 		async init() {
-			for (const fn of initializers) await fn();
+			for (const fn of initializers) await fn(this);
 			return this;
 		},
 		async dispose() {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@byearlybird/starling",
-	"version": "0.4.0",
+	"version": "0.5.0",
 	"type": "module",
 	"license": "MIT",
 	"main": "./dist/index.js",