tinybase 5.0.0-beta.5 → 5.0.0-beta.7

package/lib/types/synchronizers/synchronizer-ws-client.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The synchronizer-ws module of the TinyBase project lets you synchronize
+ * MergeableStore data to and from other MergeableStore instances via WebSockets
+ * facilitated by a server.
+ * @see Synchronizing Data guide
+ * @packageDocumentation
+ * @module synchronizer-ws-client
+ * @since v5.0.0
+ */
+
+import {MergeableStore} from '../mergeable-store';
+import {Synchronizer} from '../synchronizers';
+import {WebSocket} from 'ws';
+
+/**
+ * The WsSynchronizer interface
+ * @category Synchronizer
+ */
+export interface WsSynchronizer extends Synchronizer {}
+
+/**
+ * The createWsSynchronizer function
+ * @category Creation
+ */
+export function createWsSynchronizer(
+  store: MergeableStore,
+  webSocket: WebSocket,
+  requestTimeoutSeconds?: number,
+  onIgnoredError?: (error: any) => void,
+): Promise<WsSynchronizer>;

package/lib/types/synchronizers/synchronizer-ws-server.d.ts

@@ -0,0 +1,24 @@
+/**
+ * The synchronizer-ws-server module of the TinyBase project lets you create
+ * a server that facilitates synchronization between clients.
+ * @see Synchronizing Data guide
+ * @packageDocumentation
+ * @module synchronizer-ws-server
+ * @since v5.0.0
+ */
+
+import {WebSocketServer} from 'ws';
+
+/**
+ * The WsServer interface
+ */
+export interface WsServer {
+  getWebSocketServer: () => WebSocketServer;
+  destroy: () => void;
+}
+
+/**
+ * The createWsServer function
+ * @category Creation
+ */
+export function createWsServer(WebSocketServer: WebSocketServer): WsServer;

package/lib/types/synchronizers.d.ts

@@ -0,0 +1,131 @@
+/**
+ * The persister-sync module of the TinyBase project lets you synchronize
+ * MergeableStore data to and from other MergeableStore instances.
+ * @see Synchronizing Data guide
+ * @packageDocumentation
+ * @module synchronizers
+ * @since v5.0.0
+ */
+
+import {Id, IdOrNull} from './common';
+import {MergeableStore} from './mergeable-store';
+import {Persister} from './persisters';
+
+/**
+ * The MessageType type
+ * @category Synchronization
+ */
+export type MessageType = number;
+
+/**
+ * The Receive type
+ * @category Synchronization
+ */
+export type Receive = (
+  fromClientId: Id,
+  requestId: IdOrNull,
+  messageType: MessageType,
+  messageBody: any,
+) => void;
+
+/**
+ * The Send type
+ * @category Synchronization
+ */
+export type Send = (
+  toClientId: IdOrNull,
+  requestId: IdOrNull,
+  messageType: MessageType,
+  messageBody: any,
+) => void;
+
+/**
+ * The SynchronizerStats type
+ * @category Development
+ */
+export type SynchronizerStats = {
+  sends?: number;
+  receives?: number;
+};
+
+/**
+ * The Synchronizer interface is a minor extension to the Persister interface.
+ *
+ * It provides extra convenience methods for starting and stopping the
+ * synchronization.
+ *
+ * You should use the createCustomSynchronizer function to create a Synchronizer
+ * object.
+ * @category Synchronizer
+ * @since v5.0.0
+ */
+export interface Synchronizer extends Persister<true> {
+  /**
+   * The startSync method
+   * @category Synchronization
+   */
+  startSync(): Promise<this>;
+  /**
+   * The stopSync method
+   * @category Synchronization
+   */
+  stopSync(): this;
+  /**
+   * The getSynchronizerStats method
+   * @category Synchronization
+   */
+  getSynchronizerStats(): SynchronizerStats;
+}
+
+/**
+ * The createCustomSynchronizer function creates a Synchronizer object that can
+ * persist one MergeableStore to another.
+ *
+ * As well as providing a reference to the MergeableStore to synchronize, you
+ * must provide a `client` parameter which identifies the Client that is used to
+ * transmit changes to and from this MergeableStore and its peers.
+ * @param store The MergeableStore to synchronize.
+ * @param client The reference of the Client.
+ * @param requestTimeoutSeconds An optional number of seconds before a request
+ * to the Client times out, defaulting to 5.
+ * @param onIgnoredError An optional handler for the errors that the
+ * Synchronizer would otherwise ignore when trying to save or load data. This is
+ * suitable for debugging synchronization issues in a development environment.
+ * @returns A reference to the new Synchronizer object.
+ * @example
+ * This example creates a Synchronizer object and synchronizes one
+ * MergeableStore to another.
+ *
+ * ```js
+ * const store1 = createMergeableStore('store1').setTables({
+ *   pets: {fido: {species: 'dog'}},
+ * });
+ * const synchronizer1 = createLocalSynchronizer(store1);
+ *
+ * const store2 = createMergeableStore('store2');
+ * const synchronizer2 = createLocalSynchronizer(store2);
+ * await synchronizer2.startSync();
+ *
+ * await synchronizer1.save();
+ * // ...
+ * // Store2 will be synced with Store1.
+ *
+ * console.log(store2.getTables());
+ * // -> {pets: {fido: {species: 'dog'}}}
+ *
+ * await synchronizer1.load();
+ * // Store1 will be synced with Store2.
+ *
+ * synchronizer1.destroy();
+ * synchronizer2.destroy();
+ * ```
+ * @category Creation
+ */
+export function createCustomSynchronizer(
+  store: MergeableStore,
+  send: Send,
+  onReceive: (receive: Receive) => void,
+  destroy: () => void,
+  requestTimeoutSeconds?: number,
+  onIgnoredError?: (error: any) => void,
+): Synchronizer;

package/lib/types/tinybase.d.ts

@@ -3,12 +3,13 @@
  * @packageDocumentation
  */
 
-export * from './checkpoints.d';
-export * from './common.d';
-export * from './indexes.d';
-export * from './metrics.d';
-export * from './persisters.d';
-export * from './queries.d';
-export * from './relationships.d';
-export * from './mergeable-store.d';
-export * from './store.d';
+export * from './checkpoints.d.ts';
+export * from './common.d.ts';
+export * from './indexes.d.ts';
+export * from './metrics.d.ts';
+export * from './persisters.d.ts';
+export * from './synchronizers.d.ts';
+export * from './queries.d.ts';
+export * from './relationships.d.ts';
+export * from './mergeable-store.d.ts';
+export * from './store.d.ts';

package/lib/types/tools.d.ts

@@ -9,8 +9,8 @@
  * @since v2.2.0
  */
 
-import {Store, TablesSchema, ValuesSchema} from './store.d';
-import {Id} from './common.d';
+import {Store, TablesSchema, ValuesSchema} from './store.d.ts';
+import {Id} from './common.d.ts';
 
 /**
  * The StoreStats type describes a set of statistics about the Store, and

package/lib/types/ui-react.d.ts

@@ -22,7 +22,7 @@
  * @module ui-react
  */
 
-import {Callback, Id, IdOrNull, Ids, ParameterizedCallback} from './common.d';
+import {Callback, Id, IdOrNull, Ids, ParameterizedCallback} from './common.d.ts';
 import {
   Cell,
   CellIdsListener,
@@ -56,22 +56,22 @@ import {
   ValueOrUndefined,
   Values,
   ValuesListener,
-} from './store.d';
+} from './store.d.ts';
 import {
   CheckpointIds,
   CheckpointIdsListener,
   CheckpointListener,
   Checkpoints,
-} from './checkpoints.d';
+} from './checkpoints.d.ts';
 import {ComponentType, ReactElement} from 'react';
-import {Indexes, SliceIdsListener, SliceRowIdsListener} from './indexes.d';
+import {Indexes, SliceIdsListener, SliceRowIdsListener} from './indexes.d.ts';
 import {
   LinkedRowIdsListener,
   LocalRowIdsListener,
   Relationships,
   RemoteRowIdListener,
-} from './relationships.d';
-import {MetricListener, Metrics} from './metrics.d';
+} from './relationships.d.ts';
+import {MetricListener, Metrics} from './metrics.d.ts';
 import {
   Queries,
   ResultCellIdsListener,
@@ -82,8 +82,8 @@ import {
   ResultSortedRowIdsListener,
   ResultTableCellIdsListener,
   ResultTableListener,
-} from './queries.d';
-import {Persister} from './persisters.d';
+} from './queries.d.ts';
+import {Persister} from './persisters.d.ts';
 
 /**
  * The StoreOrStoreId type is used when you need to refer to a Store in a React

package/lib/types/with-schemas/checkpoints.d.ts

@@ -10,8 +10,8 @@
  * @module checkpoints
  */
 
-import {Id, IdOrNull, Ids} from './common.d';
-import {OptionalSchemas, Store} from './store.d';
+import {Id, IdOrNull, Ids} from './common.d.ts';
+import {OptionalSchemas, Store} from './store.d.ts';
 
 /**
  * The CheckpointIds type is a representation of the list of checkpoint Ids

package/lib/types/with-schemas/indexes.d.ts

@@ -17,8 +17,8 @@ import {
   OptionalTablesSchema,
   RowCallback,
   Store,
-} from './store.d';
-import {Id, IdOrNull, Ids, SortKey} from './common.d';
+} from './store.d.ts';
+import {Id, IdOrNull, Ids, SortKey} from './common.d.ts';
 
 /**
  * The Index type represents the concept of a map of Slice objects, keyed by Id.

package/lib/types/with-schemas/mergeable-store.d.ts

@@ -2,6 +2,7 @@
  * The mergeable-store module
  * @packageDocumentation
  * @module mergeable-store
+ * @since v5.0.0
  */
 
 import {
@@ -21,9 +22,8 @@ import {
   TablesSchema,
   ValueOrUndefined,
   ValuesSchema,
-} from './store.d';
-import {Id} from './common';
-import {IdObj} from '../../common/obj';
+} from './store.d.ts';
+import {Id, Ids} from './common';
 
 /**
  * The Hash type
@@ -37,39 +37,127 @@ export type Hash = number;
  */
 export type Time = string;
 
-/**
- * The HashStamp type
- * @category Stamps
- */
-export type HashStamp<Thing> = [time: Time, thing: Thing, hash: Hash];
-
 /**
  * The Stamp type
  * @category Stamps
  */
-export type Stamp<Thing> = [time: Time, thing: Thing];
+export type Stamp<Thing, Hashed extends boolean = false> = Hashed extends true
+  ? [time: Time, thing: Thing, hash: Hash]
+  : [time: Time, thing: Thing];
+
+// ContentHashes
+export type ContentHashes = [time: Time, [tablesHash: Hash, valuesHash: Hash]];
+
+// TablesStamp
+export type TablesStamp<
+  Schema extends OptionalTablesSchema,
+  Hashed extends boolean = false,
+> = Stamp<
+  {
+    [TableId in TableIdFromSchema<Schema>]?: TableStamp<
+      Schema,
+      TableId,
+      Hashed
+    >;
+  },
+  Hashed
+>;
+
+// TableHashes
+export type TableHashes<Schema extends OptionalTablesSchema> = {
+  [TableId in TableIdFromSchema<Schema>]?: Hash;
+};
+
+// TableIdsDiff
+export type TableIdsDiff<Schema extends OptionalTablesSchema> =
+  TableIdFromSchema<Schema>[];
+
+// TableStamp
+export type TableStamp<
+  Schema extends OptionalTablesSchema,
+  TableId extends TableIdFromSchema<Schema>,
+  Hashed extends boolean = false,
+> = Stamp<{[rowId: Id]: RowStamp<Schema, TableId, Hashed>}, Hashed>;
+
+// RowHashes
+export type RowHashes<Schema extends OptionalTablesSchema> = {
+  [TableId in TableIdFromSchema<Schema>]?: {[rowId: Id]: Hash};
+};
+
+// RowIdsDiff
+export type RowIdsDiff<Schema extends OptionalTablesSchema> = {
+  [TableId in TableIdFromSchema<Schema>]?: Ids;
+};
+
+// RowStamp
+export type RowStamp<
+  Schema extends OptionalTablesSchema,
+  TableId extends TableIdFromSchema<Schema>,
+  Hashed extends boolean = false,
+> = Stamp<
+  {
+    [CellId in CellIdFromSchema<Schema, TableId>]?: CellStamp<
+      Schema,
+      TableId,
+      CellId,
+      Hashed
+    >;
+  },
+  Hashed
+>;
+
+// CellHashes
+export type CellHashes<Schema extends OptionalTablesSchema> = {
+  [TableId in TableIdFromSchema<Schema>]?: {
+    [rowId: Id]: {[CellId in CellIdFromSchema<Schema, TableId>]?: Hash};
+  };
+};
+
+// CellStamp
+export type CellStamp<
+  Schema extends OptionalTablesSchema,
+  TableId extends TableIdFromSchema<Schema>,
+  CellId extends CellIdFromSchema<Schema, TableId>,
+  Hashed extends boolean = false,
+> = Stamp<CellOrUndefined<Schema, TableId, CellId>, Hashed>;
+
+// ValuesStamp
+export type ValuesStamp<
+  Schema extends OptionalValuesSchema,
+  Hashed extends boolean = false,
+> = Stamp<
+  {
+    [ValueId in ValueIdFromSchema<Schema>]?: ValueStamp<
+      Schema,
+      ValueId,
+      Hashed
+    >;
+  },
+  Hashed
+>;
+
+// ValuesHashes
+export type ValuesHashes<Schema extends OptionalValuesSchema> = {
+  [ValueId in ValueIdFromSchema<Schema>]?: Hash;
+};
+
+// ValueStamp
+export type ValueStamp<
+  Schema extends OptionalValuesSchema,
+  ValueId extends ValueIdFromSchema<Schema>,
+  Hashed extends boolean = false,
+> = Stamp<ValueOrUndefined<Schema, ValueId>, Hashed>;
 
 /**
  * The MergeableContent type
  * @category Mergeable
  */
-export type MergeableContent<Schemas extends OptionalSchemas> = HashStamp<
+export type MergeableContent<Schemas extends OptionalSchemas> = Stamp<
   [
-    mergeableTables: HashStamp<{
-      [TableId in TableIdFromSchema<Schemas[0]>]?: HashStamp<{
-        [rowId: Id]: HashStamp<{
-          [CellId in CellIdFromSchema<Schemas[0], TableId>]?: HashStamp<
-            CellOrUndefined<Schemas[0], TableId, CellId>
-          >;
-        }>;
-      }>;
-    }>,
-    mergeableValues: HashStamp<{
-      [ValueId in ValueIdFromSchema<Schemas[1]>]?: HashStamp<
-        ValueOrUndefined<Schemas[1], ValueId>
-      >;
-    }>,
-  ]
+    mergeableTables: TablesStamp<Schemas[0], true>,
+    mergeableValues: ValuesStamp<Schemas[1], true>,
+  ],
+  true
 >;
 
 /**
@@ -78,22 +166,9 @@ export type MergeableContent<Schemas extends OptionalSchemas> = HashStamp<
  */
 export type MergeableChanges<Schemas extends OptionalSchemas> = Stamp<
   [
-    mergeableTables: Stamp<{
-      [TableId in TableIdFromSchema<Schemas[0]>]?: Stamp<
-        IdObj<
-          Stamp<{
-            [CellId in CellIdFromSchema<Schemas[0], TableId>]?: Stamp<
-              CellOrUndefined<Schemas[0], TableId, CellId>
-            >;
-          }>
-        >
-      >;
-    }>,
-    mergeableValues: Stamp<{
-      [ValueId in ValueIdFromSchema<Schemas[1]>]?: Stamp<
-        ValueOrUndefined<Schemas[1], ValueId>
-      >;
-    }>,
+    mergeableTables: TablesStamp<Schemas[0]>,
+    mergeableValues: ValuesStamp<Schemas[1]>,
+    isChanges: 1,
   ]
 >;
 
@@ -105,87 +180,110 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
   extends Store<Schemas> {
   //
   /**
-   * The merge method
-   * @category Merging
+   * The getId method
+   * @category Getter
    */
-  merge(mergeableStore: MergeableStore<Schemas>): MergeableStore<Schemas>;
+  getId(): Id;
 
   /**
    * The getMergeableContent method
-   * @category Merging
+   * @category Getter
    */
   getMergeableContent(): MergeableContent<Schemas>;
 
   /**
-   * The setMergeableContent method
-   * @category Merging
+   * The getMergeableContentHashes method
+   * @category Syncing
    */
-  setMergeableContent(
-    mergeableContent: MergeableContent<Schemas>,
-  ): MergeableStore<Schemas>;
+  getMergeableContentHashes(): ContentHashes;
 
   /**
-   * The getTransactionMergeableChanges method
-   * @category Merging
+   * The getMergeableTableHashes method
+   * @category Syncing
    */
-  getTransactionMergeableChanges(): MergeableChanges<Schemas>;
+  getMergeableTableHashes(): TableHashes<Schemas[0]>;
 
   /**
-   * The applyMergeableChanges method
-   * @category Merging
+   * The getMergeableTableIdsDiff method
+   * @category Syncing
    */
-  applyMergeableChanges(
-    mergeableChanges: MergeableChanges<Schemas> | MergeableContent<Schemas>,
-  ): MergeableStore<Schemas>;
+  getMergeableTableIdsDiff(
+    relativeTo: TableHashes<Schemas[0]>,
+  ): TableIdsDiff<Schemas[0]>;
+
+  /**
+   * The getMergeableRowHashes method
+   * @category Syncing
+   */
+  getMergeableRowHashes(
+    tablesDelta: TableIdsDiff<Schemas[0]>,
+  ): RowHashes<Schemas[0]>;
 
   /**
-   * The getContentHash method
-   * @category Hashes
+   * The getMergeableRowIdsDiff method
+   * @category Syncing
    */
-  getContentHash(): Hash;
+  getMergeableRowIdsDiff(
+    relativeTo: RowHashes<Schemas[0]>,
+  ): RowIdsDiff<Schemas[0]>;
 
   /**
-   * The getTablesHash method
-   * @category Hashes
+   * The getMergeableCellHashes method
+   * @category Syncing
    */
-  getTablesHash(): Hash;
+  getMergeableCellHashes(
+    tableDelta: RowIdsDiff<Schemas[0]>,
+  ): CellHashes<Schemas[0]>;
 
   /**
-   * The getTableHash method
-   * @category Hashes
+   * The getMergeableTablesChanges method
+   * @category Syncing
    */
-  getTableHash(tableId: TableIdFromSchema<Schemas[0]>): Hash;
+  getMergeableTablesChanges(
+    relativeTo: CellHashes<Schemas[0]>,
+  ): TablesStamp<Schemas[0]>;
 
   /**
-   * The getRowHash method
-   * @category Hashes
+   * The getMergeableValuesHashes method
+   * @category Syncing
+   */
+  getMergeableValuesHashes(): ValuesHashes<Schemas[1]>;
+
+  /**
+   * The getMergeableValuesChanges method
+   * @category Syncing
+   */
+  getMergeableValuesChanges(
+    relativeTo: ValuesHashes<Schemas[1]>,
+  ): ValuesStamp<Schemas[1]>;
+
+  /**
+   * The setMergeableContent method
+   * @category Setter
    */
-  getRowHash<TableId extends TableIdFromSchema<Schemas[0]>>(
-    tableId: TableId,
-    rowId: Id,
-  ): Hash;
+  setMergeableContent(
+    mergeableContent: MergeableContent<Schemas>,
+  ): MergeableStore<Schemas>;
 
   /**
-   * The getCellHash method
-   * @category Hashes
+   * The getTransactionMergeableChanges method
+   * @category Getter
    */
-  getCellHash<TableId extends TableIdFromSchema<Schemas[0]>>(
-    tableId: TableId,
-    rowId: Id,
-    cellId: CellIdFromSchema<Schemas[0], TableId>,
-  ): Hash;
+  getTransactionMergeableChanges(): MergeableChanges<Schemas>;
 
   /**
-   * The getValuesHash method
-   * @category Hashes
+   * The applyMergeableChanges method
+   * @category Setter
    */
-  getValuesHash(): Hash;
+  applyMergeableChanges(
+    mergeableChanges: MergeableChanges<Schemas> | MergeableContent<Schemas>,
+  ): MergeableStore<Schemas>;
 
   /**
-   * The getValueHash method
-   * @category Hashes
+   * The merge method
+   * @category Setter
    */
-  getValueHash(valueId: ValueIdFromSchema<Schemas[1]>): Hash;
+  merge(mergeableStore: MergeableStore<Schemas>): MergeableStore<Schemas>;
 
   /**
    * The setTablesSchema method lets you specify the TablesSchema of the tabular

package/lib/types/with-schemas/metrics.d.ts

@@ -11,8 +11,8 @@
  */
 
 import {CellIdFromSchema, TableIdFromSchema} from './internal/store';
-import {GetCell, OptionalSchemas, Store} from './store.d';
-import {Id, IdOrNull, Ids} from './common.d';
+import {GetCell, OptionalSchemas, Store} from './store.d.ts';
+import {Id, IdOrNull, Ids} from './common.d.ts';
 
 /**
  * The Metric type is simply an alias, but represents a number formed by

package/lib/types/with-schemas/persisters/persister-automerge.d.ts

@@ -21,6 +21,9 @@ import {Persister} from '../persisters';
  *
  * It simply provides an extra getDocHandle method for accessing the Automerge
  * document handler the Store is being persisted to.
+ *
+ * You should use the createAutomergePersister function to create an
+ * AutomergePersister object.
  * @category Persister
  * @since v4.3.14
  */
@@ -47,7 +50,7 @@ export interface AutomergePersister<Schemas extends OptionalSchemas>
    * @category Getter
    * @since v4.3.14
    */
-  getDocHandle: () => DocHandle<any>;
+  getDocHandle(): DocHandle<any>;
 }
 
 /**