tinybase 5.2.0-beta.1 → 5.2.0-beta.3

package/@types/common/index.d.cts

@@ -119,8 +119,40 @@ export type SortKey = string | number | boolean;
 export function defaultSorter(sortKey1: SortKey, sortKey2: SortKey): number;
 
 /**
- * The getUniqueId function.
+ * The getUniqueId function returns a unique string of a given length.
+ *
+ * This is used internally by TinyBase for the synchronizer protocol and for
+ * unique MergeableStore identifiers. But it is useful enough for it to be
+ * publicly exposed for purposes such as identifying shared collaboration rooms,
+ * or creating other Ids that need to be unique.
+ *
+ * The string may contain numbers, lower or upper case letters, or the '-' or
+ * '_' characters. This makes them URL-safe, and means they can be identified
+ * with a regex like `/[-_0-9A-Za-z]+/`.
+ *
+ * This function prefers to use the `crypto` module to generate random numbers,
+ * but where that is not available (such as in React Native), a `Math.random`
+ * implementation is used. Whilst that may not be cryptographically sound, it
+ * should suffice for most TinyBase-related purposes.
+ * @param length The desired length of the unique Id, defaulting to 16.
+ * @returns A unique Id of the required length.
+ * @example
+ * This example creates two 8 character long Ids and compares them.
+ *
+ * ```js
+ * import {getUniqueId} from 'tinybase';
+ *
+ * const id1 = getUniqueId(8);
+ * const id2 = getUniqueId(8);
+ *
+ * console.log(id1.length);
+ * // -> 8
+ * console.log(id2.length);
+ * // -> 8
+ * console.log(id1 == id2);
+ * // -> false
+ * ```
  * @category Convenience
  * @since v5.0.0
  */
-export function getUniqueId(): Id;
+export function getUniqueId(length?: number): Id;

package/@types/common/index.d.ts

@@ -119,8 +119,40 @@ export type SortKey = string | number | boolean;
 export function defaultSorter(sortKey1: SortKey, sortKey2: SortKey): number;
 
 /**
- * The getUniqueId function.
+ * The getUniqueId function returns a unique string of a given length.
+ *
+ * This is used internally by TinyBase for the synchronizer protocol and for
+ * unique MergeableStore identifiers. But it is useful enough for it to be
+ * publicly exposed for purposes such as identifying shared collaboration rooms,
+ * or creating other Ids that need to be unique.
+ *
+ * The string may contain numbers, lower or upper case letters, or the '-' or
+ * '_' characters. This makes them URL-safe, and means they can be identified
+ * with a regex like `/[-_0-9A-Za-z]+/`.
+ *
+ * This function prefers to use the `crypto` module to generate random numbers,
+ * but where that is not available (such as in React Native), a `Math.random`
+ * implementation is used. Whilst that may not be cryptographically sound, it
+ * should suffice for most TinyBase-related purposes.
+ * @param length The desired length of the unique Id, defaulting to 16.
+ * @returns A unique Id of the required length.
+ * @example
+ * This example creates two 8 character long Ids and compares them.
+ *
+ * ```js
+ * import {getUniqueId} from 'tinybase';
+ *
+ * const id1 = getUniqueId(8);
+ * const id2 = getUniqueId(8);
+ *
+ * console.log(id1.length);
+ * // -> 8
+ * console.log(id2.length);
+ * // -> 8
+ * console.log(id1 == id2);
+ * // -> false
+ * ```
  * @category Convenience
  * @since v5.0.0
  */
-export function getUniqueId(): Id;
+export function getUniqueId(length?: number): Id;

package/@types/common/with-schemas/index.d.cts

@@ -119,8 +119,40 @@ export type SortKey = string | number | boolean;
 export function defaultSorter(sortKey1: SortKey, sortKey2: SortKey): number;
 
 /**
- * The getUniqueId function.
+ * The getUniqueId function returns a unique string of a given length.
+ *
+ * This is used internally by TinyBase for the synchronizer protocol and for
+ * unique MergeableStore identifiers. But it is useful enough for it to be
+ * publicly exposed for purposes such as identifying shared collaboration rooms,
+ * or creating other Ids that need to be unique.
+ *
+ * The string may contain numbers, lower or upper case letters, or the '-' or
+ * '_' characters. This makes them URL-safe, and means they can be identified
+ * with a regex like `/[-_0-9A-Za-z]+/`.
+ *
+ * This function prefers to use the `crypto` module to generate random numbers,
+ * but where that is not available (such as in React Native), a `Math.random`
+ * implementation is used. Whilst that may not be cryptographically sound, it
+ * should suffice for most TinyBase-related purposes.
+ * @param length The desired length of the unique Id, defaulting to 16.
+ * @returns A unique Id of the required length.
+ * @example
+ * This example creates two 8 character long Ids and compares them.
+ *
+ * ```js
+ * import {getUniqueId} from 'tinybase';
+ *
+ * const id1 = getUniqueId(8);
+ * const id2 = getUniqueId(8);
+ *
+ * console.log(id1.length);
+ * // -> 8
+ * console.log(id2.length);
+ * // -> 8
+ * console.log(id1 == id2);
+ * // -> false
+ * ```
  * @category Convenience
  * @since v5.0.0
  */
-export function getUniqueId(): Id;
+export function getUniqueId(length?: number): Id;

package/@types/common/with-schemas/index.d.ts

@@ -119,8 +119,40 @@ export type SortKey = string | number | boolean;
 export function defaultSorter(sortKey1: SortKey, sortKey2: SortKey): number;
 
 /**
- * The getUniqueId function.
+ * The getUniqueId function returns a unique string of a given length.
+ *
+ * This is used internally by TinyBase for the synchronizer protocol and for
+ * unique MergeableStore identifiers. But it is useful enough for it to be
+ * publicly exposed for purposes such as identifying shared collaboration rooms,
+ * or creating other Ids that need to be unique.
+ *
+ * The string may contain numbers, lower or upper case letters, or the '-' or
+ * '_' characters. This makes them URL-safe, and means they can be identified
+ * with a regex like `/[-_0-9A-Za-z]+/`.
+ *
+ * This function prefers to use the `crypto` module to generate random numbers,
+ * but where that is not available (such as in React Native), a `Math.random`
+ * implementation is used. Whilst that may not be cryptographically sound, it
+ * should suffice for most TinyBase-related purposes.
+ * @param length The desired length of the unique Id, defaulting to 16.
+ * @returns A unique Id of the required length.
+ * @example
+ * This example creates two 8 character long Ids and compares them.
+ *
+ * ```js
+ * import {getUniqueId} from 'tinybase';
+ *
+ * const id1 = getUniqueId(8);
+ * const id2 = getUniqueId(8);
+ *
+ * console.log(id1.length);
+ * // -> 8
+ * console.log(id2.length);
+ * // -> 8
+ * console.log(id1 == id2);
+ * // -> false
+ * ```
  * @category Convenience
  * @since v5.0.0
  */
-export function getUniqueId(): Id;
+export function getUniqueId(length?: number): Id;

package/@types/synchronizers/synchronizer-local/index.d.cts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-empty-object-type */
 /**
  * The synchronizer-local module of the TinyBase project lets you synchronize
  * MergeableStore data to and from other MergeableStore instances on the same

package/@types/synchronizers/synchronizer-local/index.d.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-empty-object-type */
 /**
  * The synchronizer-local module of the TinyBase project lets you synchronize
  * MergeableStore data to and from other MergeableStore instances on the same

package/@types/synchronizers/synchronizer-local/with-schemas/index.d.cts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-empty-object-type */
 /**
  * The synchronizer-local module of the TinyBase project lets you synchronize
  * MergeableStore data to and from other MergeableStore instances on the same

package/@types/synchronizers/synchronizer-local/with-schemas/index.d.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-empty-object-type */
 /**
  * The synchronizer-local module of the TinyBase project lets you synchronize
  * MergeableStore data to and from other MergeableStore instances on the same

package/@types/synchronizers/synchronizer-ws-server/index.d.cts

@@ -503,7 +503,8 @@ export interface WsServer {
  * If you want your server to persist data itself, you can use the optional
  * second parameter of this function, which allows you to create a Persister for
  * a new path - whenever a new path is accessed by a client. This Persister will
- * only exist when there are active clients on that particular path.
+ * only exist when there are active clients on that particular path. The
+ * creation callback can be asynchronous.
  *
  * You are responsible for creating a MergeableStore to pass to this Persister,
  * but starting and stopping its automatic saving and loading is taken care of
@@ -723,5 +724,7 @@ export function createWsServer<
   ) =>
     | PathPersister
     | [PathPersister, (store: MergeableStore) => void]
+    | Promise<PathPersister>
+    | Promise<[PathPersister, (store: MergeableStore) => void]>
     | undefined,
 ): WsServer;

package/@types/synchronizers/synchronizer-ws-server/index.d.ts

@@ -503,7 +503,8 @@ export interface WsServer {
  * If you want your server to persist data itself, you can use the optional
  * second parameter of this function, which allows you to create a Persister for
  * a new path - whenever a new path is accessed by a client. This Persister will
- * only exist when there are active clients on that particular path.
+ * only exist when there are active clients on that particular path. The
+ * creation callback can be asynchronous.
  *
  * You are responsible for creating a MergeableStore to pass to this Persister,
  * but starting and stopping its automatic saving and loading is taken care of
@@ -723,5 +724,7 @@ export function createWsServer<
   ) =>
     | PathPersister
     | [PathPersister, (store: MergeableStore) => void]
+    | Promise<PathPersister>
+    | Promise<[PathPersister, (store: MergeableStore) => void]>
     | undefined,
 ): WsServer;

package/@types/synchronizers/synchronizer-ws-server/with-schemas/index.d.cts

@@ -517,6 +517,8 @@ export interface WsServer {
  *   ) =>
  *     | PathPersister
  *     | [PathPersister, (store: MergeableStore) => void]
+ *     | Promise<PathPersister>
+ *     | Promise<[PathPersister, (store: MergeableStore) => void]>
  *     | undefined,
  * ): WsServer;
  * ```
@@ -527,7 +529,8 @@ export interface WsServer {
  * If you want your server to persist data itself, you can use the optional
  * second parameter of this function, which allows you to create a Persister for
  * a new path - whenever a new path is accessed by a client. This Persister will
- * only exist when there are active clients on that particular path.
+ * only exist when there are active clients on that particular path. The
+ * creation callback can be asynchronous.
  *
  * You are responsible for creating a MergeableStore to pass to this Persister,
  * but starting and stopping its automatic saving and loading is taken care of
@@ -749,5 +752,7 @@ export function createWsServer<
   ) =>
     | PathPersister
     | [PathPersister, (store: MergeableStore<Schemas>) => void]
+    | Promise<PathPersister>
+    | Promise<[PathPersister, (store: MergeableStore<Schemas>) => void]>
     | undefined,
 ): WsServer;

package/@types/synchronizers/synchronizer-ws-server/with-schemas/index.d.ts

@@ -517,6 +517,8 @@ export interface WsServer {
  *   ) =>
  *     | PathPersister
  *     | [PathPersister, (store: MergeableStore) => void]
+ *     | Promise<PathPersister>
+ *     | Promise<[PathPersister, (store: MergeableStore) => void]>
  *     | undefined,
  * ): WsServer;
  * ```
@@ -527,7 +529,8 @@ export interface WsServer {
  * If you want your server to persist data itself, you can use the optional
  * second parameter of this function, which allows you to create a Persister for
  * a new path - whenever a new path is accessed by a client. This Persister will
- * only exist when there are active clients on that particular path.
+ * only exist when there are active clients on that particular path. The
+ * creation callback can be asynchronous.
  *
  * You are responsible for creating a MergeableStore to pass to this Persister,
  * but starting and stopping its automatic saving and loading is taken care of
@@ -749,5 +752,7 @@ export function createWsServer<
   ) =>
     | PathPersister
     | [PathPersister, (store: MergeableStore<Schemas>) => void]
+    | Promise<PathPersister>
+    | Promise<[PathPersister, (store: MergeableStore<Schemas>) => void]>
     | undefined,
 ): WsServer;

package/checkpoints/index.js

@@ -163,13 +163,15 @@ const getListenerFunctions = (getThing) => {
       ([listener, , path = [], pathGetters, extraArgsGetter]) => {
         const callWithIds = (...ids) => {
           const index = size(ids);
-          index == size(path)
-            ? listener(thing, ...ids, ...extraArgsGetter(ids))
-            : isUndefined(path[index])
-              ? arrayForEach(pathGetters[index]?.(...ids) ?? [], (id2) =>
-                  callWithIds(...ids, id2),
-                )
-              : callWithIds(...ids, path[index]);
+          if (index == size(path)) {
+            listener(thing, ...ids, ...extraArgsGetter(ids));
+          } else if (isUndefined(path[index])) {
+            arrayForEach(pathGetters[index]?.(...ids) ?? [], (id2) =>
+              callWithIds(...ids, id2),
+            );
+          } else {
+            callWithIds(...ids, path[index]);
+          }
         };
         callWithIds();
       },

package/checkpoints/with-schemas/index.js

@@ -163,13 +163,15 @@ const getListenerFunctions = (getThing) => {
       ([listener, , path = [], pathGetters, extraArgsGetter]) => {
         const callWithIds = (...ids) => {
           const index = size(ids);
-          index == size(path)
-            ? listener(thing, ...ids, ...extraArgsGetter(ids))
-            : isUndefined(path[index])
-              ? arrayForEach(pathGetters[index]?.(...ids) ?? [], (id2) =>
-                  callWithIds(...ids, id2),
-                )
-              : callWithIds(...ids, path[index]);
+          if (index == size(path)) {
+            listener(thing, ...ids, ...extraArgsGetter(ids));
+          } else if (isUndefined(path[index])) {
+            arrayForEach(pathGetters[index]?.(...ids) ?? [], (id2) =>
+              callWithIds(...ids, id2),
+            );
+          } else {
+            callWithIds(...ids, path[index]);
+          }
         };
         callWithIds();
       },

package/cjs/checkpoints/index.cjs

@@ -165,13 +165,15 @@ const getListenerFunctions = (getThing) => {
       ([listener, , path = [], pathGetters, extraArgsGetter]) => {
         const callWithIds = (...ids) => {
           const index = size(ids);
-          index == size(path)
-            ? listener(thing, ...ids, ...extraArgsGetter(ids))
-            : isUndefined(path[index])
-              ? arrayForEach(pathGetters[index]?.(...ids) ?? [], (id2) =>
-                  callWithIds(...ids, id2),
-                )
-              : callWithIds(...ids, path[index]);
+          if (index == size(path)) {
+            listener(thing, ...ids, ...extraArgsGetter(ids));
+          } else if (isUndefined(path[index])) {
+            arrayForEach(pathGetters[index]?.(...ids) ?? [], (id2) =>
+              callWithIds(...ids, id2),
+            );
+          } else {
+            callWithIds(...ids, path[index]);
+          }
         };
         callWithIds();
       },

package/cjs/checkpoints/with-schemas/index.cjs

@@ -165,13 +165,15 @@ const getListenerFunctions = (getThing) => {
       ([listener, , path = [], pathGetters, extraArgsGetter]) => {
         const callWithIds = (...ids) => {
           const index = size(ids);
-          index == size(path)
-            ? listener(thing, ...ids, ...extraArgsGetter(ids))
-            : isUndefined(path[index])
-              ? arrayForEach(pathGetters[index]?.(...ids) ?? [], (id2) =>
-                  callWithIds(...ids, id2),
-                )
-              : callWithIds(...ids, path[index]);
+          if (index == size(path)) {
+            listener(thing, ...ids, ...extraArgsGetter(ids));
+          } else if (isUndefined(path[index])) {
+            arrayForEach(pathGetters[index]?.(...ids) ?? [], (id2) =>
+              callWithIds(...ids, id2),
+            );
+          } else {
+            callWithIds(...ids, path[index]);
+          }
         };
         callWithIds();
       },

package/cjs/es6/checkpoints/index.cjs

@@ -199,19 +199,21 @@ const getListenerFunctions = (getThing) => {
         const callWithIds = (...ids) => {
           var _a, _b;
           const index = size(ids);
-          index == size(path)
-            ? listener(thing, ...ids, ...extraArgsGetter(ids))
-            : isUndefined(path[index])
-              ? arrayForEach(
-                  (_b =
-                    (_a = pathGetters[index]) == null
-                      ? void 0
-                      : _a.call(pathGetters, ...ids)) != null
-                    ? _b
-                    : [],
-                  (id2) => callWithIds(...ids, id2),
-                )
-              : callWithIds(...ids, path[index]);
+          if (index == size(path)) {
+            listener(thing, ...ids, ...extraArgsGetter(ids));
+          } else if (isUndefined(path[index])) {
+            arrayForEach(
+              (_b =
+                (_a = pathGetters[index]) == null
+                  ? void 0
+                  : _a.call(pathGetters, ...ids)) != null
+                ? _b
+                : [],
+              (id2) => callWithIds(...ids, id2),
+            );
+          } else {
+            callWithIds(...ids, path[index]);
+          }
         };
         callWithIds();
       },

package/cjs/es6/checkpoints/with-schemas/index.cjs

@@ -199,19 +199,21 @@ const getListenerFunctions = (getThing) => {
         const callWithIds = (...ids) => {
           var _a, _b;
           const index = size(ids);
-          index == size(path)
-            ? listener(thing, ...ids, ...extraArgsGetter(ids))
-            : isUndefined(path[index])
-              ? arrayForEach(
-                  (_b =
-                    (_a = pathGetters[index]) == null
-                      ? void 0
-                      : _a.call(pathGetters, ...ids)) != null
-                    ? _b
-                    : [],
-                  (id2) => callWithIds(...ids, id2),
-                )
-              : callWithIds(...ids, path[index]);
+          if (index == size(path)) {
+            listener(thing, ...ids, ...extraArgsGetter(ids));
+          } else if (isUndefined(path[index])) {
+            arrayForEach(
+              (_b =
+                (_a = pathGetters[index]) == null
+                  ? void 0
+                  : _a.call(pathGetters, ...ids)) != null
+                ? _b
+                : [],
+              (id2) => callWithIds(...ids, id2),
+            );
+          } else {
+            callWithIds(...ids, path[index]);
+          }
         };
         callWithIds();
       },

package/cjs/es6/index.cjs

@@ -197,9 +197,9 @@ const mapToObj = (map, valueMapper, excludeMapValue, excludeObjValue) => {
   collForEach(map, (mapValue, id) => {
     if (!(excludeMapValue == null ? void 0 : excludeMapValue(mapValue, id))) {
       const objValue = valueMapper ? valueMapper(mapValue, id) : mapValue;
-      (excludeObjValue == null ? void 0 : excludeObjValue(objValue))
-        ? 0
-        : (obj[id] = objValue);
+      if (!(excludeObjValue == null ? void 0 : excludeObjValue(objValue))) {
+        obj[id] = objValue;
+      }
     }
   });
   return obj;
@@ -539,19 +539,21 @@ const getListenerFunctions = (getThing) => {
         const callWithIds = (...ids) => {
           var _a, _b;
           const index = size(ids);
-          index == size(path)
-            ? listener(thing, ...ids, ...extraArgsGetter(ids))
-            : isUndefined(path[index])
-              ? arrayForEach(
-                  (_b =
-                    (_a = pathGetters[index]) == null
-                      ? void 0
-                      : _a.call(pathGetters, ...ids)) != null
-                    ? _b
-                    : [],
-                  (id2) => callWithIds(...ids, id2),
-                )
-              : callWithIds(...ids, path[index]);
+          if (index == size(path)) {
+            listener(thing, ...ids, ...extraArgsGetter(ids));
+          } else if (isUndefined(path[index])) {
+            arrayForEach(
+              (_b =
+                (_a = pathGetters[index]) == null
+                  ? void 0
+                  : _a.call(pathGetters, ...ids)) != null
+                ? _b
+                : [],
+              (id2) => callWithIds(...ids, id2),
+            );
+          } else {
+            callWithIds(...ids, path[index]);
+          }
         };
         callWithIds();
       },
@@ -1354,9 +1356,11 @@ const createCustomPersister = (
           __async$1(void 0, null, function* () {
             try {
               const content = yield getPersisted();
-              isArray(content)
-                ? setContentOrChanges(content)
-                : errorNew(`Content is not an array ${content}`);
+              if (isArray(content)) {
+                setContentOrChanges(content);
+              } else {
+                errorNew(`Content is not an array ${content}`);
+              }
             } catch (error) {
               onIgnoredError == null ? void 0 : onIgnoredError(error);
               if (initialContent) {
@@ -2799,7 +2803,11 @@ const createStore = () => {
       cellIdsChanged(tableId, rowId, cellId2, -1);
       mapSet(row, cellId2);
     };
-    isUndefined(defaultCell) ? delCell2(cellId) : mapForEach(row, delCell2);
+    if (isUndefined(defaultCell)) {
+      delCell2(cellId);
+    } else {
+      mapForEach(row, delCell2);
+    }
     if (collIsEmpty(row)) {
       rowIdsChanged(tableId, rowId, -1);
       if (collIsEmpty(mapSet(table, rowId))) {

package/cjs/es6/indexes/index.cjs

@@ -381,19 +381,21 @@ const getListenerFunctions = (getThing) => {
         const callWithIds = (...ids) => {
           var _a, _b;
           const index = size(ids);
-          index == size(path)
-            ? listener(thing, ...ids, ...extraArgsGetter(ids))
-            : isUndefined(path[index])
-              ? arrayForEach(
-                  (_b =
-                    (_a = pathGetters[index]) == null
-                      ? void 0
-                      : _a.call(pathGetters, ...ids)) != null
-                    ? _b
-                    : [],
-                  (id2) => callWithIds(...ids, id2),
-                )
-              : callWithIds(...ids, path[index]);
+          if (index == size(path)) {
+            listener(thing, ...ids, ...extraArgsGetter(ids));
+          } else if (isUndefined(path[index])) {
+            arrayForEach(
+              (_b =
+                (_a = pathGetters[index]) == null
+                  ? void 0
+                  : _a.call(pathGetters, ...ids)) != null
+                ? _b
+                : [],
+              (id2) => callWithIds(...ids, id2),
+            );
+          } else {
+            callWithIds(...ids, path[index]);
+          }
         };
         callWithIds();
       },

package/cjs/es6/indexes/with-schemas/index.cjs

@@ -381,19 +381,21 @@ const getListenerFunctions = (getThing) => {
         const callWithIds = (...ids) => {
           var _a, _b;
           const index = size(ids);
-          index == size(path)
-            ? listener(thing, ...ids, ...extraArgsGetter(ids))
-            : isUndefined(path[index])
-              ? arrayForEach(
-                  (_b =
-                    (_a = pathGetters[index]) == null
-                      ? void 0
-                      : _a.call(pathGetters, ...ids)) != null
-                    ? _b
-                    : [],
-                  (id2) => callWithIds(...ids, id2),
-                )
-              : callWithIds(...ids, path[index]);
+          if (index == size(path)) {
+            listener(thing, ...ids, ...extraArgsGetter(ids));
+          } else if (isUndefined(path[index])) {
+            arrayForEach(
+              (_b =
+                (_a = pathGetters[index]) == null
+                  ? void 0
+                  : _a.call(pathGetters, ...ids)) != null
+                ? _b
+                : [],
+              (id2) => callWithIds(...ids, id2),
+            );
+          } else {
+            callWithIds(...ids, path[index]);
+          }
         };
         callWithIds();
       },