tinybase 6.2.0-beta.3 → 6.2.0

package/@types/mergeable-store/index.d.ts

@@ -19,7 +19,7 @@
  * @module mergeable-store
  * @since v5.0.0
  */
-import type {GetNow, Id} from '../common/index.d.ts';
+import type {GetNow, Hash, Hlc, Id} from '../common/index.d.ts';
 import type {
   CellOrUndefined,
   Content,
@@ -27,41 +27,12 @@ import type {
   ValueOrUndefined,
 } from '../store/index.d.ts';
 
-/**
- * The Hash type is used within the mergeable-store module to quickly compare
- * the content of two objects.
- *
- * This is simply an alias for a JavaScript `number`.
- *
- * This type is mostly utilized internally within TinyBase itself and is
- * generally assumed to be opaque to applications that use it.
- * @category Stamps
- * @since v5.0.0
- */
-export type Hash = number;
-
-/**
- * The Time type is used within the mergeable-store module to store the value of
- * a hybrid logical clock (HLC).
- *
- * It is simply an alias for a JavaScript `string`, but it comprises three HLC
- * parts: a logical timestamp, a sequence counter, and a client Id. It is
- * designed to be string-sortable and unique across all of the systems involved
- * in synchronizing a MergeableStore.
- *
- * This type is mostly utilized internally within TinyBase itself and is
- * generally assumed to be opaque to applications that use it.
- * @category Stamps
- * @since v5.0.0
- */
-export type Time = string;
-
 /**
  * The Stamp type is used as metadata to decide how to merge two different
  * MergeableStore objects together.
  *
- * It describes a combination of a value (or object), a Time, and optionally a
- * Hash, all in an array.
+ * It describes a combination of a value (or object), an Hlc timestamp, and
+ * optionally a Hash, all in an array.
  *
  * This type is mostly utilized internally within TinyBase itself and is
  * generally assumed to be opaque to applications that use it.
@@ -69,8 +40,8 @@ export type Time = string;
  * @since v5.0.0
  */
 export type Stamp<Thing, Hashed extends boolean = false> = Hashed extends true
-  ? [thing: Thing, time: Time, hash: Hash]
-  : [thing: Thing, time?: Time];
+  ? [thing: Thing, hlc: Hlc, hash: Hash]
+  : [thing: Thing, hlc?: Hlc];
 
 /**
  * The ContentHashes type is used to quickly compare the content of two

package/@types/mergeable-store/with-schemas/index.d.ts

@@ -24,7 +24,7 @@ import type {
   TableIdFromSchema,
   ValueIdFromSchema,
 } from '../../_internal/store/with-schemas/index.d.ts';
-import type {GetNow, Id} from '../../common/with-schemas/index.d.ts';
+import type {GetNow, Hash, Hlc, Id} from '../../common/with-schemas/index.d.ts';
 import type {
   CellOrUndefined,
   Content,
@@ -40,41 +40,12 @@ import type {
   ValuesSchema,
 } from '../../store/with-schemas/index.d.ts';
 
-/**
- * The Hash type is used within the mergeable-store module to quickly compare
- * the content of two objects.
- *
- * This is simply an alias for a JavaScript `number`.
- *
- * This type is mostly utilized internally within TinyBase itself and is
- * generally assumed to be opaque to applications that use it.
- * @category Stamps
- * @since v5.0.0
- */
-export type Hash = number;
-
-/**
- * The Time type is used within the mergeable-store module to store the value of
- * a hybrid logical clock (HLC).
- *
- * It is simply an alias for a JavaScript `string`, but it comprises three HLC
- * parts: a logical timestamp, a sequence counter, and a client Id. It is
- * designed to be string-sortable and unique across all of the systems involved
- * in synchronizing a MergeableStore.
- *
- * This type is mostly utilized internally within TinyBase itself and is
- * generally assumed to be opaque to applications that use it.
- * @category Stamps
- * @since v5.0.0
- */
-export type Time = string;
-
 /**
  * The Stamp type is used as metadata to decide how to merge two different
  * MergeableStore objects together.
  *
- * It describes a combination of a value (or object), a Time, and optionally a
- * Hash, all in an array.
+ * It describes a combination of a value (or object), an Hlc timestamp, and
+ * optionally a Hash, all in an array.
  *
  * This type is mostly utilized internally within TinyBase itself and is
  * generally assumed to be opaque to applications that use it.
@@ -82,8 +53,8 @@ export type Time = string;
  * @since v5.0.0
  */
 export type Stamp<Thing, Hashed extends boolean = false> = Hashed extends true
-  ? [thing: Thing, time: Time, hash: Hash]
-  : [thing: Thing, time?: Time];
+  ? [thing: Thing, hlc: Hlc, hash: Hash]
+  : [thing: Thing, hlc?: Hlc];
 
 /**
  * The ContentHashes type is used to quickly compare the content of two

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

@@ -49,6 +49,6 @@ export * from '../../synchronizers/synchronizer-ws-server-durable-object/with-sc
 export * from '../../synchronizers/synchronizer-ws-server-simple/with-schemas/index.d.ts';
 export * from '../../synchronizers/synchronizer-ws-server/with-schemas/index.d.ts';
 export * from '../../synchronizers/with-schemas/index.d.ts';
-export * from '../../ui-react-dom/with-schemas/index.d.ts';
-export * from '../../ui-react-inspector/with-schemas/index.d.ts';
-export * from '../../ui-react/with-schemas/index.d.ts';
+export {WithSchemas as UiReactDomWithSchemas} from '../../ui-react-dom/with-schemas/index.d.ts';
+export {WithSchemas as UiReactInspectorWithSchemas} from '../../ui-react-inspector/with-schemas/index.d.ts';
+export {WithSchemas as UiReactWithSchemas} from '../../ui-react/with-schemas/index.d.ts';

package/common/index.js

@@ -6,6 +6,7 @@ const GLOBAL = globalThis;
 const math = Math;
 const mathMax = math.max;
 const mathFloor = math.floor;
+const isInstanceOf = (thing, cls) => thing instanceof cls;
 const isUndefined = (thing) => thing == void 0;
 const ifNotUndefined = (value, then, otherwise) =>
   isUndefined(value) ? otherwise?.() : then(value);
@@ -14,6 +15,9 @@ const arrayForEach = (array, cb) => array.forEach(cb);
 const arrayMap = (array, cb) => array.map(cb);
 const arrayReduce = (array, cb, initial) => array.reduce(cb, initial);
 
+const object = Object;
+const objEntries = object.entries;
+
 const mapNew = (entries) => new Map(entries);
 const mapGet = (map, key) => map?.get(key);
 
@@ -37,16 +41,55 @@ const getUniqueId = (length = 16) =>
     '',
   );
 
+const jsonString = JSON.stringify;
+const jsonStringWithMap = (obj) =>
+  jsonString(obj, (_key, value) =>
+    isInstanceOf(value, Map) ? object.fromEntries([...value]) : value,
+  );
+
 const textEncoder = /* @__PURE__ */ new GLOBAL.TextEncoder();
-const getHash = (value) => {
+const getHash = (string) => {
   let hash = 2166136261;
-  arrayForEach(textEncoder.encode(value), (char) => {
+  arrayForEach(textEncoder.encode(string), (char) => {
     hash ^= char;
     hash +=
       (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) + (hash << 24);
   });
   return hash >>> 0;
 };
+const addOrRemoveHash = (hash1, hash2) => (hash1 ^ hash2) >>> 0;
+const getValuesHash = (valueHashes) =>
+  arrayReduce(
+    objEntries(valueHashes),
+    (valuesHash, [valueId, valueHash]) =>
+      addOrRemoveHash(
+        valuesHash,
+        getValueInValuesHash(valueId, valueHash) ^
+          getValueInValuesHash(valueId, 0),
+        // legacy v5; remove in v7
+      ),
+    0,
+    // legacy v5; valuesHlc in v7?
+  );
+const getValueInValuesHash = (valueId, valueHash) =>
+  getHash(valueId + ':' + valueHash);
+const getValueHash = (value, valueHlc) =>
+  getHash(jsonStringWithMap(value ?? null) + ':' + valueHlc);
+const getCellHash = getValueHash;
+const getCellInRowHash = getValueInValuesHash;
+const getRowHash = getValuesHash;
+const getRowInTableHash = getValueInValuesHash;
+const getTableHash = (rowHashes) =>
+  // alias to getValuesHash in v7
+  arrayReduce(
+    objEntries(rowHashes),
+    (valuesHash, [rowId, rowHash]) =>
+      addOrRemoveHash(valuesHash, getValueInValuesHash(rowId, rowHash)),
+    0,
+    // legacy v5; rowHlc in v7?
+  );
+const getTableInTablesHash = getValueInValuesHash;
+const getTablesHash = getTableHash;
 
 const SHIFT36 = 2 ** 36;
 const SHIFT30 = 2 ** 30;
@@ -132,4 +175,20 @@ const getHlcFunctions = (uniqueId, getNow = Date.now) => {
 const defaultSorter = (sortKey1, sortKey2) =>
   (sortKey1 ?? 0) < (sortKey2 ?? 0) ? -1 : 1;
 
-export {defaultSorter, getHlcFunctions, getRandomValues, getUniqueId};
+export {
+  addOrRemoveHash,
+  defaultSorter,
+  getCellHash,
+  getCellInRowHash,
+  getHash,
+  getHlcFunctions,
+  getRowHash,
+  getRowInTableHash,
+  getTableHash,
+  getTableInTablesHash,
+  getTablesHash,
+  getUniqueId,
+  getValueHash,
+  getValueInValuesHash,
+  getValuesHash,
+};

package/common/with-schemas/index.js

@@ -6,6 +6,7 @@ const GLOBAL = globalThis;
 const math = Math;
 const mathMax = math.max;
 const mathFloor = math.floor;
+const isInstanceOf = (thing, cls) => thing instanceof cls;
 const isUndefined = (thing) => thing == void 0;
 const ifNotUndefined = (value, then, otherwise) =>
   isUndefined(value) ? otherwise?.() : then(value);
@@ -14,6 +15,9 @@ const arrayForEach = (array, cb) => array.forEach(cb);
 const arrayMap = (array, cb) => array.map(cb);
 const arrayReduce = (array, cb, initial) => array.reduce(cb, initial);
 
+const object = Object;
+const objEntries = object.entries;
+
 const mapNew = (entries) => new Map(entries);
 const mapGet = (map, key) => map?.get(key);
 
@@ -37,16 +41,55 @@ const getUniqueId = (length = 16) =>
     '',
   );
 
+const jsonString = JSON.stringify;
+const jsonStringWithMap = (obj) =>
+  jsonString(obj, (_key, value) =>
+    isInstanceOf(value, Map) ? object.fromEntries([...value]) : value,
+  );
+
 const textEncoder = /* @__PURE__ */ new GLOBAL.TextEncoder();
-const getHash = (value) => {
+const getHash = (string) => {
   let hash = 2166136261;
-  arrayForEach(textEncoder.encode(value), (char) => {
+  arrayForEach(textEncoder.encode(string), (char) => {
     hash ^= char;
     hash +=
       (hash << 1) + (hash << 4) + (hash << 7) + (hash << 8) + (hash << 24);
   });
   return hash >>> 0;
 };
+const addOrRemoveHash = (hash1, hash2) => (hash1 ^ hash2) >>> 0;
+const getValuesHash = (valueHashes) =>
+  arrayReduce(
+    objEntries(valueHashes),
+    (valuesHash, [valueId, valueHash]) =>
+      addOrRemoveHash(
+        valuesHash,
+        getValueInValuesHash(valueId, valueHash) ^
+          getValueInValuesHash(valueId, 0),
+        // legacy v5; remove in v7
+      ),
+    0,
+    // legacy v5; valuesHlc in v7?
+  );
+const getValueInValuesHash = (valueId, valueHash) =>
+  getHash(valueId + ':' + valueHash);
+const getValueHash = (value, valueHlc) =>
+  getHash(jsonStringWithMap(value ?? null) + ':' + valueHlc);
+const getCellHash = getValueHash;
+const getCellInRowHash = getValueInValuesHash;
+const getRowHash = getValuesHash;
+const getRowInTableHash = getValueInValuesHash;
+const getTableHash = (rowHashes) =>
+  // alias to getValuesHash in v7
+  arrayReduce(
+    objEntries(rowHashes),
+    (valuesHash, [rowId, rowHash]) =>
+      addOrRemoveHash(valuesHash, getValueInValuesHash(rowId, rowHash)),
+    0,
+    // legacy v5; rowHlc in v7?
+  );
+const getTableInTablesHash = getValueInValuesHash;
+const getTablesHash = getTableHash;
 
 const SHIFT36 = 2 ** 36;
 const SHIFT30 = 2 ** 30;
@@ -132,4 +175,20 @@ const getHlcFunctions = (uniqueId, getNow = Date.now) => {
 const defaultSorter = (sortKey1, sortKey2) =>
   (sortKey1 ?? 0) < (sortKey2 ?? 0) ? -1 : 1;
 
-export {defaultSorter, getHlcFunctions, getRandomValues, getUniqueId};
+export {
+  addOrRemoveHash,
+  defaultSorter,
+  getCellHash,
+  getCellInRowHash,
+  getHash,
+  getHlcFunctions,
+  getRowHash,
+  getRowInTableHash,
+  getTableHash,
+  getTableInTablesHash,
+  getTablesHash,
+  getUniqueId,
+  getValueHash,
+  getValueInValuesHash,
+  getValuesHash,
+};