tinybase 3.0.0-beta.0 → 3.0.0

package/lib/debug/persisters.d.ts

@@ -27,7 +27,7 @@
  * @module persisters
  */
 
-import {Store, Tables} from './store.d';
+import {Store, Tables, Values} from './store.d';
 import {Callback} from './common.d';
 
 /**
@@ -105,9 +105,9 @@ export type PersisterStats = {
  *
  * await persister.save();
  * console.log(sessionStorage.getItem('pets'));
- * // -> '{"pets":{"fido":{"species":"dog"}}}'
+ * // -> '[{"pets":{"fido":{"species":"dog"}}},{}]'
  *
- * sessionStorage.setItem('pets', '{"pets":{"toto":{"species":"dog"}}}');
+ * sessionStorage.setItem('pets', '[{"pets":{"toto":{"species":"dog"}}},{}]');
  * await persister.load();
  * console.log(store.getTables());
  * // -> {pets: {toto: {species: 'dog'}}}
@@ -130,10 +130,10 @@ export type PersisterStats = {
  * store.setTables({pets: {felix: {species: 'cat'}}});
  * // ...
  * console.log(sessionStorage.getItem('pets'));
- * // -> '{"pets":{"felix":{"species":"cat"}}}'
+ * // -> '[{"pets":{"felix":{"species":"cat"}}},{}]'
  *
  * // In another browser tab:
- * sessionStorage.setItem('pets', '{"pets":{"toto":{"species":"dog"}}}');
+ * sessionStorage.setItem('pets', '[{"pets":{"toto":{"species":"dog"}}},{}]');
  * // -> StorageEvent('storage', {storageArea: sessionStorage, key: 'pets'})
  *
  * // ...
@@ -163,6 +163,8 @@ export interface Persister {
    *
    * @param initialTables An optional Tables object used when the underlying
    * storage has not previously been populated.
+   * @param initialValues An optional Values object used when the underlying
+   * storage has not previously been populated, since v3.0.0.
    * @returns A Promise containing a reference to the Persister object.
    * @example
    * This example creates an empty Store, and loads data into it from the
@@ -170,7 +172,7 @@ export interface Persister {
    * previously populated.
    *
    * ```js
-   * sessionStorage.setItem('pets', '{"pets":{"fido":{"species":"dog"}}}');
+   * sessionStorage.setItem('pets', '[{"pets":{"fido":{"species":"dog"}}},{}]');
    *
    * const store = createStore();
    * const persister = createSessionPersister(store, 'pets');
@@ -195,7 +197,7 @@ export interface Persister {
    * console.log(store.getTables());
    * // -> {pets: {fido: {species: 'dog'}}}
    *
-   * sessionStorage.setItem('pets', '{"pets":{"toto":{"species":"dog"}}}');
+   * sessionStorage.setItem('pets', '[{"pets":{"toto":{"species":"dog"}}},{}]');
    * await persister.load({pets: {fido: {species: 'dog'}}});
    * console.log(store.getTables());
    * // -> {pets: {toto: {species: 'dog'}}}
@@ -204,7 +206,7 @@ export interface Persister {
    * ```
    * @category Load
    */
-  load(initialTables?: Tables): Promise<Persister>;
+  load(initialTables?: Tables, initialValues?: Values): Promise<Persister>;
 
   /**
    * The startAutoLoad method gets persisted data from storage, and loads it
@@ -229,6 +231,8 @@ export interface Persister {
    *
    * @param initialTables An optional Tables object used when the underlying
    * storage has not previously been populated.
+   * @param initialValues An optional Values object used when the underlying
+   * storage has not previously been populated, since v3.0.0.
    * @returns A Promise containing a reference to the Persister object.
    * @example
    * This example creates an empty Store, and loads data into it from the
@@ -246,7 +250,7 @@ export interface Persister {
    * // -> {pets: {fido: {species: 'dog'}}}
    *
    * // In another browser tab:
-   * sessionStorage.setItem('pets', '{"pets":{"toto":{"species":"dog"}}}');
+   * sessionStorage.setItem('pets', '[{"pets":{"toto":{"species":"dog"}}},{}]');
    * // -> StorageEvent('storage', {storageArea: sessionStorage, key: 'pets'})
    *
    * // ...
@@ -258,7 +262,10 @@ export interface Persister {
    * ```
    * @category Load
    */
-  startAutoLoad(initialTables?: Tables): Promise<Persister>;
+  startAutoLoad(
+    initialTables?: Tables,
+    initialValues?: Values,
+  ): Promise<Persister>;
 
   /**
    * The stopAutoLoad method stops the automatic loading of data from storage
@@ -279,7 +286,7 @@ export interface Persister {
    * await persister.startAutoLoad();
    *
    * // In another browser tab:
-   * sessionStorage.setItem('pets', '{"pets":{"toto":{"species":"dog"}}}');
+   * sessionStorage.setItem('pets', '[{"pets":{"toto":{"species":"dog"}}},{}]');
    * // -> StorageEvent('storage', {storageArea: sessionStorage, key: 'pets'})
    * // ...
    * console.log(store.getTables());
@@ -288,7 +295,10 @@ export interface Persister {
    * persister.stopAutoLoad();
    *
    * // In another browser tab:
-   * sessionStorage.setItem('pets', '{"pets":{"felix":{"species":"cat"}}}');
+   * sessionStorage.setItem(
+   *   'pets',
+   *   '[{"pets":{"felix":{"species":"cat"}}},{}]',
+   * );
    * // -> StorageEvent('storage', {storageArea: sessionStorage, key: 'pets'})
    * // ...
    * console.log(store.getTables());
@@ -322,7 +332,7 @@ export interface Persister {
    *
    * await persister.save();
    * console.log(sessionStorage.getItem('pets'));
-   * // -> '{"pets":{"fido":{"species":"dog"}}}'
+   * // -> '[{"pets":{"fido":{"species":"dog"}}},{}]'
    *
    * persister.destroy();
    * sessionStorage.clear();
@@ -356,12 +366,12 @@ export interface Persister {
    *
    * await persister.startAutoSave();
    * console.log(sessionStorage.getItem('pets'));
-   * // -> '{"pets":{"fido":{"species":"dog"}}}'
+   * // -> '[{"pets":{"fido":{"species":"dog"}}},{}]'
    *
    * store.setTables({pets: {toto: {species: 'dog'}}});
    * // ...
    * console.log(sessionStorage.getItem('pets'));
-   * // -> '{"pets":{"toto":{"species":"dog"}}}'
+   * // -> '[{"pets":{"toto":{"species":"dog"}}},{}]'
    *
    * sessionStorage.clear();
    * ```
@@ -391,14 +401,14 @@ export interface Persister {
    * store.setTables({pets: {toto: {species: 'dog'}}});
    * // ...
    * console.log(sessionStorage.getItem('pets'));
-   * // -> '{"pets":{"toto":{"species":"dog"}}}'
+   * // -> '[{"pets":{"toto":{"species":"dog"}}},{}]'
    *
    * persister.stopAutoSave();
    *
    * store.setTables({pets: {felix: {species: 'cat'}}});
    * // ...
    * console.log(sessionStorage.getItem('pets'));
-   * // -> '{"pets":{"toto":{"species":"dog"}}}'
+   * // -> '[{"pets":{"toto":{"species":"dog"}}},{}]'
    * // Store change has not been automatically saved.
    *
    * sessionStorage.clear();
@@ -423,7 +433,7 @@ export interface Persister {
    * persister.getStore().setTables({pets: {fido: {species: 'dog'}}});
    * // ...
    * console.log(sessionStorage.getItem('pets'));
-   * // -> '{"pets":{"fido":{"species":"dog"}}}'
+   * // -> '[{"pets":{"fido":{"species":"dog"}}},{}]'
    *
    * sessionStorage.clear();
    * ```
@@ -493,7 +503,7 @@ export interface Persister {
    * store.setTables({pets: {felix: {species: 'cat'}}});
    * // ...
    *
-   * sessionStorage.setItem('pets', '{"pets":{"toto":{"species":"dog"}}}');
+   * sessionStorage.setItem('pets', '[{"pets":{"toto":{"species":"dog"}}},{}]');
    * // -> StorageEvent('storage', {storageArea: sessionStorage, key: 'pets'})
    * // ...
    *
@@ -529,7 +539,7 @@ export interface Persister {
  *
  * await persister.save();
  * console.log(sessionStorage.getItem('pets'));
- * // -> '{"pets":{"fido":{"species":"dog"}}}'
+ * // -> '[{"pets":{"fido":{"species":"dog"}}},{}]'
  *
  * persister.destroy();
  * sessionStorage.clear();
@@ -562,7 +572,7 @@ export function createSessionPersister(
  *
  * await persister.save();
  * console.log(localStorage.getItem('pets'));
- * // -> '{"pets":{"fido":{"species":"dog"}}}'
+ * // -> '[{"pets":{"fido":{"species":"dog"}}},{}]'
  *
  * persister.destroy();
  * localStorage.clear();
@@ -696,9 +706,9 @@ export function createFilePersister(store: Store, filePath: string): Persister;
  *
  * await persister.save();
  * console.log(storeJson);
- * // -> '{"pets":{"fido":{"species":"dog"}}}'
+ * // -> '[{"pets":{"fido":{"species":"dog"}}},{}]'
  *
- * storeJson = '{"pets":{"fido":{"species":"dog","color":"brown"}}}';
+ * storeJson = '[{"pets":{"fido":{"species":"dog","color":"brown"}}},{}]';
  * await persister.load();
  *
  * console.log(store.getTables());

package/lib/debug/persisters.js

@@ -18,11 +18,12 @@ const createCustomPersister = (
   stopListeningToPersisted,
 ) => {
   let tablesListenerId;
+  let valuesListenerId;
   let loadSave = 0;
   let loads = 0;
   let saves = 0;
   const persister = {
-    load: async (initialTables) => {
+    load: async (initialTables, initialValues) => {
       /* istanbul ignore else */
       if (loadSave != 2) {
         loadSave = 1;
@@ -33,15 +34,17 @@ const createCustomPersister = (
         if (!isUndefined(body) && body != EMPTY_STRING) {
           store.setJson(body);
         } else {
-          store.setTables(initialTables);
+          store.transaction(() =>
+            store.setTables(initialTables).setValues(initialValues),
+          );
         }
         loadSave = 0;
       }
       return persister;
     },
-    startAutoLoad: async (initialTables) => {
+    startAutoLoad: async (initialTables, initialValues) => {
       persister.stopAutoLoad();
-      await persister.load(initialTables);
+      await persister.load(initialTables, initialValues);
       startListeningToPersisted(persister.load);
       return persister;
     },
@@ -63,11 +66,13 @@ const createCustomPersister = (
     },
     startAutoSave: async () => {
       await persister.stopAutoSave().save();
-      tablesListenerId = store.addTablesListener(() => persister.save());
+      tablesListenerId = store.addTablesListener(persister.save);
+      valuesListenerId = store.addValuesListener(persister.save);
       return persister;
     },
     stopAutoSave: () => {
       ifNotUndefined(tablesListenerId, store.delListener);
+      ifNotUndefined(valuesListenerId, store.delListener);
       return persister;
     },
     getStore: () => store,

package/lib/debug/queries.js

@@ -163,7 +163,7 @@ const getAggregateValue = (
     : aggregateValue;
 };
 
-const getCellType = (cell) => {
+const getCellOrValueType = (cell) => {
   const type = getTypeOf(cell);
   return isTypeStringOrBoolean(type) || (type == NUMBER && isFiniteNumber(cell))
     ? type
@@ -525,7 +525,7 @@ const createQueries = getCreateFunction((store) => {
                         aggregators,
                       );
                       groupRow[groupedCellId] = isUndefined(
-                        getCellType(aggregateValue),
+                        getCellOrValueType(aggregateValue),
                       )
                         ? null
                         : aggregateValue;

package/lib/debug/relationships.js

@@ -262,10 +262,22 @@ const getListenerFunctions = (getThing) => {
   let thing;
   const [getId, releaseId] = getPoolFunctions();
   const allListeners = mapNew();
-  const addListener = (listener, idSetNode, path) => {
+  const addListener = (
+    listener,
+    idSetNode,
+    path,
+    pathGetters = [],
+    extraArgsGetter = () => [],
+  ) => {
     thing ??= getThing();
     const id = getId();
-    mapSet(allListeners, id, [listener, idSetNode, path]);
+    mapSet(allListeners, id, [
+      listener,
+      idSetNode,
+      path,
+      pathGetters,
+      extraArgsGetter,
+    ]);
     setAdd(visitTree(idSetNode, path ?? [EMPTY_STRING], setNew), id);
     return id;
   };
@@ -285,20 +297,23 @@ const getListenerFunctions = (getThing) => {
       releaseId(id);
       return idOrNulls;
     });
-  const callListener = (id, idNullGetters, extraArgsGetter) =>
-    ifNotUndefined(mapGet(allListeners, id), ([listener, , idOrNulls = []]) => {
-      const callWithIds = (...ids) => {
-        const index = arrayLength(ids);
-        index == arrayLength(idOrNulls)
-          ? listener(thing, ...ids, ...extraArgsGetter(ids))
-          : isUndefined(idOrNulls[index])
-          ? arrayForEach(idNullGetters[index](...ids), (id2) =>
-              callWithIds(...ids, id2),
-            )
-          : callWithIds(...ids, idOrNulls[index]);
-      };
-      callWithIds();
-    });
+  const callListener = (id) =>
+    ifNotUndefined(
+      mapGet(allListeners, id),
+      ([listener, , path = [], pathGetters, extraArgsGetter]) => {
+        const callWithIds = (...ids) => {
+          const index = arrayLength(ids);
+          index == arrayLength(path)
+            ? listener(thing, ...ids, ...extraArgsGetter(ids))
+            : isUndefined(path[index])
+            ? arrayForEach(pathGetters[index]?.(...ids) ?? [], (id2) =>
+                callWithIds(...ids, id2),
+              )
+            : callWithIds(...ids, path[index]);
+        };
+        callWithIds();
+      },
+    );
   return [addListener, callListeners, delListener, callListener];
 };