tinybase 5.0.0-beta.1 → 5.0.0-beta.10

package/lib/debug/persisters/persister-file.js

@@ -3,10 +3,10 @@ import {readFile, writeFile} from 'fs/promises';
 
 const UTF8 = 'utf8';
 
-const isInstanceOf = (thing, cls) => thing instanceof cls;
 const isUndefined = (thing) => thing == void 0;
 const ifNotUndefined = (value, then, otherwise) =>
   isUndefined(value) ? otherwise?.() : then(value);
+const isArray = (thing) => Array.isArray(thing);
 const size = (arrayOrString) => arrayOrString.length;
 
 const arrayPush = (array, ...values) => array.push(...values);
@@ -14,8 +14,6 @@ const arrayShift = (array) => array.shift();
 
 const object = Object;
 const getPrototypeOf = (obj) => object.getPrototypeOf(obj);
-const objIds = object.keys;
-const objFreeze = object.freeze;
 const isObject = (obj) =>
   !isUndefined(obj) &&
   ifNotUndefined(
@@ -26,14 +24,20 @@ const isObject = (obj) =>
     /* istanbul ignore next */
     () => true,
   );
+const objIds = object.keys;
+const objFreeze = object.freeze;
 const objSize = (obj) => size(objIds(obj));
 const objIsEmpty = (obj) => isObject(obj) && objSize(obj) == 0;
 
-const jsonString = (obj) =>
+const UNDEFINED_MARKER = '\uFFFC';
+const jsonStringWithUndefined = (obj) =>
   JSON.stringify(obj, (_key, value) =>
-    isInstanceOf(value, Map) ? object.fromEntries([...value]) : value,
+    value === void 0 ? UNDEFINED_MARKER : value,
+  );
+const jsonParseWithUndefined = (str) =>
+  JSON.parse(str, (_key, value) =>
+    value === UNDEFINED_MARKER ? void 0 : value,
   );
-const jsonParse = JSON.parse;
 
 const collHas = (coll, keyOrValue) => coll?.has(keyOrValue) ?? false;
 const collDel = (coll, keyOrValue) => coll?.delete(keyOrValue);
@@ -42,15 +46,35 @@ const mapNew = (entries) => new Map(entries);
 const mapGet = (map, key) => map?.get(key);
 const mapSet = (map, key, value) =>
   isUndefined(value) ? (collDel(map, key), map) : map?.set(key, value);
-const mapEnsure = (map, key, getDefaultValue) => {
+const mapEnsure = (map, key, getDefaultValue, hadExistingValue) => {
   if (!collHas(map, key)) {
     mapSet(map, key, getDefaultValue());
+  } else {
+    hadExistingValue?.(mapGet(map, key));
   }
   return mapGet(map, key);
 };
 
 const scheduleRunning = mapNew();
 const scheduleActions = mapNew();
+const getStoreFunctions = (supportsMergeableStore, store) =>
+  !supportsMergeableStore || isUndefined(store.getMergeableContent)
+    ? [
+        0,
+        store.getContent,
+        store.getTransactionChanges,
+        ([changedTables, changedValues]) =>
+          !objIsEmpty(changedTables) || !objIsEmpty(changedValues),
+        store.setContent,
+      ]
+    : [
+        1,
+        store.getMergeableContent,
+        store.getTransactionMergeableChanges,
+        ([[changedTables], [changedValues]]) =>
+          !objIsEmpty(changedTables) || !objIsEmpty(changedValues),
+        store.setDefaultContent,
+      ];
 const createCustomPersister = (
   store,
   getPersisted,
@@ -58,18 +82,25 @@ const createCustomPersister = (
   addPersisterListener,
   delPersisterListener,
   onIgnoredError,
-  [getThing, thing] = [],
+  supportsMergeableStore,
+  extra = {},
   scheduleId = [],
 ) => {
-  let listenerId;
   let loadSave = 0;
   let loads = 0;
   let saves = 0;
-  let listening = 0;
   let action;
-  let listeningHandle;
+  let autoLoadHandle;
+  let autoSaveListenerId;
   mapEnsure(scheduleRunning, scheduleId, () => 0);
   mapEnsure(scheduleActions, scheduleId, () => []);
+  const [
+    isMergeableStore,
+    getContent,
+    getChanges,
+    hasChanges,
+    setDefaultContent,
+  ] = getStoreFunctions(supportsMergeableStore, store);
   const run = async () => {
     /* istanbul ignore else */
     if (!mapGet(scheduleRunning, scheduleId)) {
@@ -101,48 +132,54 @@ const createCustomPersister = (
     }
     return persister;
   };
+  const setContentOrChanges = (contentOrChanges) => {
+    (isMergeableStore && isArray(contentOrChanges?.[0])
+      ? contentOrChanges?.[2] === 1
+        ? store.applyMergeableChanges
+        : store.setMergeableContent
+      : contentOrChanges?.[2] === 1
+        ? store.applyChanges
+        : store.setContent)(contentOrChanges);
+  };
   const persister = {
-    load: async (initialTables, initialValues) =>
+    load: async (initialContent) =>
       await loadLock(async () => {
         try {
-          store.setContent(await getPersisted());
-        } catch {
-          store.setContent([initialTables, initialValues]);
+          setContentOrChanges(await getPersisted());
+        } catch (error) {
+          onIgnoredError?.(error);
+          if (initialContent) {
+            setDefaultContent(initialContent);
+          }
         }
       }),
-    startAutoLoad: async (initialTables = {}, initialValues = {}) => {
-      persister.stopAutoLoad();
-      await persister.load(initialTables, initialValues);
-      listening = 1;
-      listeningHandle = addPersisterListener(
-        async (getContent, getTransactionChanges) => {
-          if (getTransactionChanges) {
-            const transactionChanges = getTransactionChanges();
-            await loadLock(async () =>
-              store.setTransactionChanges(transactionChanges),
-            );
-          } else {
-            await loadLock(async () => {
-              try {
-                store.setContent(getContent?.() ?? (await getPersisted()));
-              } catch (error) {
-                onIgnoredError?.(error);
-              }
-            });
-          }
+    startAutoLoad: async (initialContent) => {
+      await persister.stopAutoLoad().load(initialContent);
+      autoLoadHandle = addPersisterListener(
+        async (getContent2, getChanges2) => {
+          const changes = getChanges2?.();
+          await loadLock(async () => {
+            try {
+              setContentOrChanges(
+                changes ?? getContent2?.() ?? (await getPersisted()),
+              );
+            } catch (error) {
+              onIgnoredError?.(error);
+            }
+          });
         },
       );
       return persister;
     },
     stopAutoLoad: () => {
-      if (listening) {
-        delPersisterListener(listeningHandle);
-        listeningHandle = void 0;
-        listening = 0;
+      if (autoLoadHandle) {
+        delPersisterListener(autoLoadHandle);
+        autoLoadHandle = void 0;
       }
       return persister;
     },
-    save: async (getTransactionChanges) => {
+    isAutoLoading: () => !isUndefined(autoLoadHandle),
+    save: async (getChanges2) => {
       /* istanbul ignore else */
       if (loadSave != 1) {
         loadSave = 2;
@@ -151,7 +188,7 @@ const createCustomPersister = (
         }
         await persister.schedule(async () => {
           try {
-            await setPersisted(store.getContent, getTransactionChanges);
+            await setPersisted(getContent, getChanges2);
           } catch (error) {
             /* istanbul ignore next */
             onIgnoredError?.(error);
@@ -163,21 +200,20 @@ const createCustomPersister = (
     },
     startAutoSave: async () => {
       await persister.stopAutoSave().save();
-      listenerId = store.addDidFinishTransactionListener(
-        (_store, getTransactionChanges) => {
-          const [tableChanges, valueChanges] = getTransactionChanges();
-          if (!objIsEmpty(tableChanges) || !objIsEmpty(valueChanges)) {
-            persister.save(() => [tableChanges, valueChanges]);
-          }
-        },
-      );
+      autoSaveListenerId = store.addDidFinishTransactionListener(() => {
+        const changes = getChanges();
+        if (hasChanges(changes)) {
+          persister.save(() => changes);
+        }
+      });
       return persister;
     },
     stopAutoSave: () => {
-      ifNotUndefined(listenerId, store.delListener);
-      listenerId = void 0;
+      ifNotUndefined(autoSaveListenerId, store.delListener);
+      autoSaveListenerId = void 0;
       return persister;
     },
+    isAutoSaving: () => !isUndefined(autoSaveListenerId),
     schedule: async (...actions) => {
       arrayPush(mapGet(scheduleActions, scheduleId), ...actions);
       await run();
@@ -186,17 +222,16 @@ const createCustomPersister = (
     getStore: () => store,
     destroy: () => persister.stopAutoLoad().stopAutoSave(),
     getStats: () => ({loads, saves}),
+    ...extra,
   };
-  if (getThing) {
-    persister[getThing] = () => thing;
-  }
   return objFreeze(persister);
 };
 
 const createFilePersister = (store, filePath, onIgnoredError) => {
-  const getPersisted = async () => jsonParse(await readFile(filePath, UTF8));
+  const getPersisted = async () =>
+    jsonParseWithUndefined(await readFile(filePath, UTF8));
   const setPersisted = async (getContent) =>
-    await writeFile(filePath, jsonString(getContent()), UTF8);
+    await writeFile(filePath, jsonStringWithUndefined(getContent()), UTF8);
   const addPersisterListener = (listener) => watch(filePath, () => listener());
   const delPersisterListener = (watcher) => watcher?.close();
   return createCustomPersister(
@@ -206,7 +241,8 @@ const createFilePersister = (store, filePath, onIgnoredError) => {
     addPersisterListener,
     delPersisterListener,
     onIgnoredError,
-    ['getFilePath', filePath],
+    true,
+    {getFilePath: () => filePath},
   );
 };
 

package/lib/debug/persisters/persister-indexed-db.js

@@ -10,6 +10,7 @@ const stopInterval = clearInterval;
 const isUndefined = (thing) => thing == void 0;
 const ifNotUndefined = (value, then, otherwise) =>
   isUndefined(value) ? otherwise?.() : then(value);
+const isArray = (thing) => Array.isArray(thing);
 const size = (arrayOrString) => arrayOrString.length;
 const promiseNew = (resolver) => new promise(resolver);
 const promiseAll = async (promises) => promise.all(promises);
@@ -21,8 +22,6 @@ const arrayShift = (array) => array.shift();
 const object = Object;
 const getPrototypeOf = (obj) => object.getPrototypeOf(obj);
 const objEntries = object.entries;
-const objIds = object.keys;
-const objFreeze = object.freeze;
 const isObject = (obj) =>
   !isUndefined(obj) &&
   ifNotUndefined(
@@ -33,10 +32,11 @@ const isObject = (obj) =>
     /* istanbul ignore next */
     () => true,
   );
+const objIds = object.keys;
+const objFreeze = object.freeze;
 const objNew = (entries = []) => object.fromEntries(entries);
-const objGet = (obj, id) => ifNotUndefined(obj, (obj2) => obj2[id]);
-const objHas = (obj, id) => !isUndefined(objGet(obj, id));
-const objMap = (obj, cb) =>
+const objHas = (obj, id) => id in obj;
+const objToArray = (obj, cb) =>
   arrayMap(objEntries(obj), ([id, value]) => cb(value, id));
 const objSize = (obj) => size(objIds(obj));
 const objIsEmpty = (obj) => isObject(obj) && objSize(obj) == 0;
@@ -48,15 +48,35 @@ const mapNew = (entries) => new Map(entries);
 const mapGet = (map, key) => map?.get(key);
 const mapSet = (map, key, value) =>
   isUndefined(value) ? (collDel(map, key), map) : map?.set(key, value);
-const mapEnsure = (map, key, getDefaultValue) => {
+const mapEnsure = (map, key, getDefaultValue, hadExistingValue) => {
   if (!collHas(map, key)) {
     mapSet(map, key, getDefaultValue());
+  } else {
+    hadExistingValue?.(mapGet(map, key));
   }
   return mapGet(map, key);
 };
 
 const scheduleRunning = mapNew();
 const scheduleActions = mapNew();
+const getStoreFunctions = (supportsMergeableStore, store) =>
+  !supportsMergeableStore || isUndefined(store.getMergeableContent)
+    ? [
+        0,
+        store.getContent,
+        store.getTransactionChanges,
+        ([changedTables, changedValues]) =>
+          !objIsEmpty(changedTables) || !objIsEmpty(changedValues),
+        store.setContent,
+      ]
+    : [
+        1,
+        store.getMergeableContent,
+        store.getTransactionMergeableChanges,
+        ([[changedTables], [changedValues]]) =>
+          !objIsEmpty(changedTables) || !objIsEmpty(changedValues),
+        store.setDefaultContent,
+      ];
 const createCustomPersister = (
   store,
   getPersisted,
@@ -64,18 +84,25 @@ const createCustomPersister = (
   addPersisterListener,
   delPersisterListener,
   onIgnoredError,
-  [getThing, thing] = [],
+  supportsMergeableStore,
+  extra = {},
   scheduleId = [],
 ) => {
-  let listenerId;
   let loadSave = 0;
   let loads = 0;
   let saves = 0;
-  let listening = 0;
   let action;
-  let listeningHandle;
+  let autoLoadHandle;
+  let autoSaveListenerId;
   mapEnsure(scheduleRunning, scheduleId, () => 0);
   mapEnsure(scheduleActions, scheduleId, () => []);
+  const [
+    isMergeableStore,
+    getContent,
+    getChanges,
+    hasChanges,
+    setDefaultContent,
+  ] = getStoreFunctions(supportsMergeableStore, store);
   const run = async () => {
     /* istanbul ignore else */
     if (!mapGet(scheduleRunning, scheduleId)) {
@@ -107,48 +134,54 @@ const createCustomPersister = (
     }
     return persister;
   };
+  const setContentOrChanges = (contentOrChanges) => {
+    (isMergeableStore && isArray(contentOrChanges?.[0])
+      ? contentOrChanges?.[2] === 1
+        ? store.applyMergeableChanges
+        : store.setMergeableContent
+      : contentOrChanges?.[2] === 1
+        ? store.applyChanges
+        : store.setContent)(contentOrChanges);
+  };
   const persister = {
-    load: async (initialTables, initialValues) =>
+    load: async (initialContent) =>
       await loadLock(async () => {
         try {
-          store.setContent(await getPersisted());
-        } catch {
-          store.setContent([initialTables, initialValues]);
+          setContentOrChanges(await getPersisted());
+        } catch (error) {
+          onIgnoredError?.(error);
+          if (initialContent) {
+            setDefaultContent(initialContent);
+          }
         }
       }),
-    startAutoLoad: async (initialTables = {}, initialValues = {}) => {
-      persister.stopAutoLoad();
-      await persister.load(initialTables, initialValues);
-      listening = 1;
-      listeningHandle = addPersisterListener(
-        async (getContent, getTransactionChanges) => {
-          if (getTransactionChanges) {
-            const transactionChanges = getTransactionChanges();
-            await loadLock(async () =>
-              store.setTransactionChanges(transactionChanges),
-            );
-          } else {
-            await loadLock(async () => {
-              try {
-                store.setContent(getContent?.() ?? (await getPersisted()));
-              } catch (error) {
-                onIgnoredError?.(error);
-              }
-            });
-          }
+    startAutoLoad: async (initialContent) => {
+      await persister.stopAutoLoad().load(initialContent);
+      autoLoadHandle = addPersisterListener(
+        async (getContent2, getChanges2) => {
+          const changes = getChanges2?.();
+          await loadLock(async () => {
+            try {
+              setContentOrChanges(
+                changes ?? getContent2?.() ?? (await getPersisted()),
+              );
+            } catch (error) {
+              onIgnoredError?.(error);
+            }
+          });
         },
       );
       return persister;
     },
     stopAutoLoad: () => {
-      if (listening) {
-        delPersisterListener(listeningHandle);
-        listeningHandle = void 0;
-        listening = 0;
+      if (autoLoadHandle) {
+        delPersisterListener(autoLoadHandle);
+        autoLoadHandle = void 0;
       }
       return persister;
     },
-    save: async (getTransactionChanges) => {
+    isAutoLoading: () => !isUndefined(autoLoadHandle),
+    save: async (getChanges2) => {
       /* istanbul ignore else */
       if (loadSave != 1) {
         loadSave = 2;
@@ -157,7 +190,7 @@ const createCustomPersister = (
         }
         await persister.schedule(async () => {
           try {
-            await setPersisted(store.getContent, getTransactionChanges);
+            await setPersisted(getContent, getChanges2);
           } catch (error) {
             /* istanbul ignore next */
             onIgnoredError?.(error);
@@ -169,21 +202,20 @@ const createCustomPersister = (
     },
     startAutoSave: async () => {
       await persister.stopAutoSave().save();
-      listenerId = store.addDidFinishTransactionListener(
-        (_store, getTransactionChanges) => {
-          const [tableChanges, valueChanges] = getTransactionChanges();
-          if (!objIsEmpty(tableChanges) || !objIsEmpty(valueChanges)) {
-            persister.save(() => [tableChanges, valueChanges]);
-          }
-        },
-      );
+      autoSaveListenerId = store.addDidFinishTransactionListener(() => {
+        const changes = getChanges();
+        if (hasChanges(changes)) {
+          persister.save(() => changes);
+        }
+      });
       return persister;
     },
     stopAutoSave: () => {
-      ifNotUndefined(listenerId, store.delListener);
-      listenerId = void 0;
+      ifNotUndefined(autoSaveListenerId, store.delListener);
+      autoSaveListenerId = void 0;
       return persister;
     },
+    isAutoSaving: () => !isUndefined(autoSaveListenerId),
     schedule: async (...actions) => {
       arrayPush(mapGet(scheduleActions, scheduleId), ...actions);
       await run();
@@ -192,10 +224,8 @@ const createCustomPersister = (
     getStore: () => store,
     destroy: () => persister.stopAutoLoad().stopAutoSave(),
     getStats: () => ({loads, saves}),
+    ...extra,
   };
-  if (getThing) {
-    persister[getThing] = () => thing;
-  }
   return objFreeze(persister);
 };
 
@@ -203,7 +233,7 @@ const WINDOW = globalThis.window;
 const OBJECT_STORE_NAMES = [T, V];
 const KEY_PATH = {keyPath: 'k'};
 const objectStoreMatch = async (objectStore, obj) => {
-  const actions = objMap(obj, (v, k) =>
+  const actions = objToArray(obj, (v, k) =>
     execObjectStore(objectStore, 'put', {k, v}),
   );
   arrayMap(await execObjectStore(objectStore, 'getAllKeys'), (id) =>
@@ -227,7 +257,10 @@ const createIndexedDbPersister = (
 ) => {
   const forObjectStores = async (forObjectStore, args = [], create = 0) =>
     promiseNew((resolve, reject) => {
-      const request = WINDOW.indexedDB.open(dbName, create ? 2 : void 0);
+      const request = (WINDOW ? WINDOW.indexedDB : indexedDB).open(
+        dbName,
+        create ? 2 : void 0,
+      );
       request.onupgradeneeded = () =>
         create &&
         arrayMap(OBJECT_STORE_NAMES, (objectStoreName) => {
@@ -286,7 +319,8 @@ const createIndexedDbPersister = (
     addPersisterListener,
     delPersisterListener,
     onIgnoredError,
-    ['getDbName', dbName],
+    false,
+    {getDbName: () => dbName},
   );
 };