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

package/lib/debug/metrics.js

@@ -52,9 +52,11 @@ const mapForEach = (map, cb) =>
   collForEach(map, (value, key) => cb(key, value));
 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);
 };

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

@@ -3,6 +3,7 @@ const TINYBASE = 'tinybase';
 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 arrayMap = (array, cb) => array.map(cb);
@@ -12,8 +13,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(
@@ -24,13 +23,15 @@ const isObject = (obj) =>
     /* istanbul ignore next */
     () => true,
   );
+const objIds = object.keys;
+const objFreeze = object.freeze;
 const objGet = (obj, id) => ifNotUndefined(obj, (obj2) => obj2[id]);
-const objHas = (obj, id) => !isUndefined(objGet(obj, id));
+const objHas = (obj, id) => id in obj;
 const objDel = (obj, id) => {
   delete obj[id];
   return obj;
 };
-const objMap = (obj, cb) =>
+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 +49,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 +85,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 +135,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 +191,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 +203,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 +225,8 @@ const createCustomPersister = (
     getStore: () => store,
     destroy: () => persister.stopAutoLoad().stopAutoSave(),
     getStats: () => ({loads, saves}),
+    ...extra,
   };
-  if (getThing) {
-    persister[getThing] = () => thing;
-  }
   return objFreeze(persister);
 };
 
@@ -208,56 +239,51 @@ const getDocContent = (doc, docObjName) => [
   doc[docObjName].t,
   doc[docObjName].v,
 ];
-const setTransactionChangesToDoc = (
-  doc,
-  docObjName,
-  getContent,
-  getTransactionChanges,
-) => {
+const applyChangesToDoc = (doc, docObjName, getContent, getChanges) => {
   ensureDocContent(doc, docObjName);
   const [docTables, docValues] = getDocContent(doc, docObjName);
-  const transactionChangesDidFail = () => {
-    transactionChangesFailed = 1;
+  const changesDidFail = () => {
+    changesFailed = 1;
   };
-  let transactionChangesFailed = 1;
-  ifNotUndefined(getTransactionChanges?.(), ([cellChanges, valueChanges]) => {
-    transactionChangesFailed = 0;
-    objMap(cellChanges, (table, tableId) =>
-      transactionChangesFailed
+  let changesFailed = 1;
+  ifNotUndefined(getChanges?.(), ([cellChanges, valueChanges]) => {
+    changesFailed = 0;
+    objToArray(cellChanges, (table, tableId) =>
+      changesFailed
         ? 0
         : isUndefined(table)
           ? objDel(docTables, tableId)
           : ifNotUndefined(
               docTables[tableId],
               (docTable) =>
-                objMap(table, (row, rowId) =>
-                  transactionChangesFailed
+                objToArray(table, (row, rowId) =>
+                  changesFailed
                     ? 0
                     : isUndefined(row)
                       ? objDel(docTable, rowId)
                       : ifNotUndefined(
                           objGet(docTable, rowId),
                           (docRow) =>
-                            objMap(row, (cell, cellId) =>
+                            objToArray(row, (cell, cellId) =>
                               isUndefined(cell)
                                 ? objDel(docRow, cellId)
                                 : (docRow[cellId] = cell),
                             ),
-                          transactionChangesDidFail,
+                          changesDidFail,
                         ),
                 ),
-              transactionChangesDidFail,
+              changesDidFail,
             ),
     );
-    objMap(valueChanges, (value, valueId) =>
-      transactionChangesFailed
+    objToArray(valueChanges, (value, valueId) =>
+      changesFailed
         ? 0
         : isUndefined(value)
           ? objDel(docValues, valueId)
           : (docValues[valueId] = value),
     );
   });
-  if (transactionChangesFailed) {
+  if (changesFailed) {
     const [tables, values] = getContent();
     docObjMatch(docTables, void 0, tables, (_, tableId, table) =>
       docObjMatch(docTables, tableId, table, (docTable, rowId, row) =>
@@ -281,12 +307,12 @@ const docObjMatch = (docObjOrParent, idInParent, obj, set) => {
     ? docObjOrParent
     : objEnsure(docObjOrParent, idInParent, () => ({}));
   let changed;
-  objMap(obj, (value, id) => {
+  objToArray(obj, (value, id) => {
     if (set(docObj, id, value)) {
       changed = 1;
     }
   });
-  objMap(docObj, (_, id) => {
+  objToArray(docObj, (_, id) => {
     if (!objHas(obj, id)) {
       objDel(docObj, id);
       changed = 1;
@@ -304,18 +330,15 @@ const createAutomergePersister = (
   onIgnoredError,
 ) => {
   docHandle.change((doc) => (doc[docObjName] = {}));
-  const getPersisted = async () =>
-    objSize(docHandle.doc[docObjName]) == 2
-      ? getDocContent(docHandle.doc, docObjName)
+  const getPersisted = async () => {
+    const doc = await docHandle.doc();
+    return objSize(doc[docObjName]) == 2
+      ? getDocContent(doc, docObjName)
       : void 0;
-  const setPersisted = async (getContent, getTransactionChanges) =>
+  };
+  const setPersisted = async (getContent, getChanges) =>
     docHandle.change((doc) =>
-      setTransactionChangesToDoc(
-        doc,
-        docObjName,
-        getContent,
-        getTransactionChanges,
-      ),
+      applyChangesToDoc(doc, docObjName, getContent, getChanges),
     );
   const addPersisterListener = (listener) => {
     const observer = ({doc}) => listener(() => getDocContent(doc, docObjName));
@@ -332,7 +355,8 @@ const createAutomergePersister = (
     addPersisterListener,
     delPersisterListener,
     onIgnoredError,
-    ['getDocHandle', docHandle],
+    false,
+    {getDocHandle: () => docHandle},
   );
 };
 

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

@@ -1,7 +1,7 @@
-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);
@@ -9,8 +9,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(
@@ -21,14 +19,21 @@ 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 jsonParse = JSON.parse;
+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);
@@ -37,15 +42,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,
@@ -53,18 +78,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)) {
@@ -96,48 +128,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;
@@ -146,7 +184,7 @@ const createCustomPersister = (
         }
         await persister.schedule(async () => {
           try {
-            await setPersisted(store.getContent, getTransactionChanges);
+            await setPersisted(getContent, getChanges2);
           } catch (error) {
             /* istanbul ignore next */
             onIgnoredError?.(error);
@@ -158,21 +196,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();
@@ -181,10 +218,8 @@ const createCustomPersister = (
     getStore: () => store,
     destroy: () => persister.stopAutoLoad().stopAutoSave(),
     getStats: () => ({loads, saves}),
+    ...extra,
   };
-  if (getThing) {
-    persister[getThing] = () => thing;
-  }
   return objFreeze(persister);
 };
 
@@ -196,9 +231,10 @@ const createStoragePersister = (
   storage,
   onIgnoredError,
 ) => {
-  const getPersisted = async () => jsonParse(storage.getItem(storageName));
+  const getPersisted = async () =>
+    jsonParseWithUndefined(storage.getItem(storageName));
   const setPersisted = async (getContent) =>
-    storage.setItem(storageName, jsonString(getContent()));
+    storage.setItem(storageName, jsonStringWithUndefined(getContent()));
   const addPersisterListener = (listener) => {
     const storageListener = (event) => {
       if (event.storageArea === storage && event.key === storageName) {
@@ -217,7 +253,8 @@ const createStoragePersister = (
     addPersisterListener,
     delPersisterListener,
     onIgnoredError,
-    ['getStorageName', storageName],
+    true,
+    {getStorageName: () => storageName},
   );
 };
 const createLocalPersister = (store, storageName, onIgnoredError) =>