tinybase 5.0.0-beta.27 → 5.0.0-beta.28

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

@@ -1,7 +1,7 @@
 /**
- * The persister-sync module of the TinyBase project lets you synchronize
+ * The synchronizers module of the TinyBase project lets you synchronize
  * MergeableStore data to and from other MergeableStore instances.
- * @see Synchronizing Data guide
+ * @see Synchronization guide
  * @packageDocumentation
  * @module synchronizers
  * @since v5.0.0
@@ -33,35 +33,51 @@ import type {MergeableStore} from '../../mergeable-store/with-schemas/index.d.ts
 export const enum Message {
   /**
    * A message that is a response to a previous request.
+   * @category Enum
+   * @since v5.0.0
    */
   Response = 0,
   /**
    * A message that is a request to get ContentHashes from another
    * MergeableStore.
+   * @category Enum
+   * @since v5.0.0
    */
   GetContentHashes = 1,
   /**
    * A message that contains ContentHashes.
+   * @category Enum
+   * @since v5.0.0
    */
   ContentHashes = 2,
   /**
    * A message that contains a ContentDiff.
+   * @category Enum
+   * @since v5.0.0
    */
   ContentDiff = 3,
   /**
    * A message that is a request to get a TableDiff from another MergeableStore.
+   * @category Enum
+   * @since v5.0.0
    */
   GetTableDiff = 4,
   /**
    * A message that is a request to get a RowDiff from another MergeableStore.
+   * @category Enum
+   * @since v5.0.0
    */
   GetRowDiff = 5,
   /**
    * A message that is a request to get a CellDiff from another MergeableStore.
+   * @category Enum
+   * @since v5.0.0
    */
   GetCellDiff = 6,
   /**
    * A message that is a request to get a ValueDiff from another MergeableStore.
+   * @category Enum
+   * @since v5.0.0
    */
   GetValueDiff = 7,
 }
@@ -127,7 +143,7 @@ export type SynchronizerStats = {
 };
 
 /**
- * The Synchronizer object lets you synchronize MergeableStore data with another
+ * A Synchronizer object lets you synchronize MergeableStore data with another
  * TinyBase client or system.
  *
  * This is useful for sharing data between users, or between devices of a single
@@ -376,7 +392,7 @@ export interface Synchronizer<Schemas extends OptionalSchemas>
  * createCustomSynchronizer(
  *   store: MergeableStore,
  *   send: Send,
- *   onReceive: (receive: Receive) => void,
+ *   registerReceive: (receive: Receive) => void,
  *   destroy: () => void,
  *   requestTimeoutSeconds: number,
  *   onIgnoredError?: (error: any) => void,
@@ -389,9 +405,9 @@ export interface Synchronizer<Schemas extends OptionalSchemas>
  * medium of communication used.
  * @param store The MergeableStore to synchronize.
  * @param send A Send function for sending a message.
- * @param onReceive A callback (called once when the Synchronizer is created)
- * that is passed a Receive function that you need to ensure can receive
- * messages.
+ * @param registerReceive A callback (called once when the Synchronizer is
+ * created) that is passed a Receive function that you need to ensure will
+ * receive messages addressed or broadcast to this client.
  * @param destroy A function called when destroying the Persister which can be
  * used to clean up underlying resources.
  * @param requestTimeoutSeconds An number of seconds before a request sent from
@@ -427,7 +443,7 @@ export interface Synchronizer<Schemas extends OptionalSchemas>
  *       remoteBus.push([clientId, requestId, message, body]);
  *     },
  *     (receive) => {
- *       // onReceive
+ *       // registerReceive
  *       timer = setInterval(() => {
  *         if (localBus.length > 0) {
  *           receive(...localBus.shift());
@@ -449,11 +465,13 @@ export interface Synchronizer<Schemas extends OptionalSchemas>
  * await synchronizer2.startSync();
  *
  * store1.setTables({pets: {fido: {species: 'dog'}}});
+ * store2.setTables({pets: {felix: {species: 'cat'}}});
+ *
  * // ...
  * console.log(store1.getTables());
- * // -> {pets: {fido: {species: 'dog'}}}
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  * console.log(store2.getTables());
- * // -> {pets: {fido: {species: 'dog'}}}
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
  * synchronizer1.destroy();
  * synchronizer2.destroy();
@@ -464,7 +482,7 @@ export interface Synchronizer<Schemas extends OptionalSchemas>
 export function createCustomSynchronizer<Schemas extends OptionalSchemas>(
   store: MergeableStore<Schemas>,
   send: Send,
-  onReceive: (receive: Receive) => void,
+  registerReceive: (receive: Receive) => void,
   destroy: () => void,
   requestTimeoutSeconds: number,
   onIgnoredError?: (error: any) => void,

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

@@ -23,28 +23,40 @@ import type {Id} from '../common/index.d.cts';
 export type StoreStats = {
   /**
    * The number of Table objects in the Store.
+   * @category Stat
+   * @since v2.2.0
    */
   totalTables: number;
   /**
    * The number of Row objects in the Store, across all Table objects.
+   * @category Stat
+   * @since v2.2.0
    */
   totalRows: number;
   /**
    * The number of Cell objects in the Store, across all Row objects, across all
    * Table objects.
+   * @category Stat
+   * @since v2.2.0
    */
   totalCells: number;
   /**
    * The number of Value objects in the Store, since v3.0.
+   * @category Stat
+   * @since v2.2.0
    */
   totalValues: number;
   /**
    * The string length of the Store when serialized to JSON.
+   * @category Stat
+   * @since v2.2.0
    */
   jsonLength: number;
   /**
    * Additional detailed statistics about the Store if the `detail` flag is
    * specified in the getStoreStats method.
+   * @category Stat
+   * @since v2.2.0
    */
   detail?: StoreStatsDetail;
 };
@@ -61,6 +73,8 @@ export type StoreStats = {
 export type StoreStatsDetail = {
   /**
    * Information about each Table in the Store.
+   * @category Stat
+   * @since v2.2.0
    */
   tables: {[tableId: Id]: StoreStatsTableDetail};
 };
@@ -74,14 +88,20 @@ export type StoreStatsDetail = {
 export type StoreStatsTableDetail = {
   /**
    * The number of Row objects in the Table.
+   * @category Stat
+   * @since v2.2.0
    */
   tableRows: number;
   /**
    * The number of Cell objects in the Table, across all Row objects.
+   * @category Stat
+   * @since v2.2.0
    */
   tableCells: number;
   /**
    * Detail about the Table object.
+   * @category Stat
+   * @since v2.2.0
    */
   rows: {[rowId: Id]: StoreStatsRowDetail};
 };
@@ -95,6 +115,8 @@ export type StoreStatsTableDetail = {
 export type StoreStatsRowDetail = {
   /**
    * The number of Cell objects in the Row.
+   * @category Stat
+   * @since v2.2.0
    */
   rowCells: number;
 };

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

@@ -23,28 +23,40 @@ import type {Id} from '../common/index.d.ts';
 export type StoreStats = {
   /**
    * The number of Table objects in the Store.
+   * @category Stat
+   * @since v2.2.0
    */
   totalTables: number;
   /**
    * The number of Row objects in the Store, across all Table objects.
+   * @category Stat
+   * @since v2.2.0
    */
   totalRows: number;
   /**
    * The number of Cell objects in the Store, across all Row objects, across all
    * Table objects.
+   * @category Stat
+   * @since v2.2.0
    */
   totalCells: number;
   /**
    * The number of Value objects in the Store, since v3.0.
+   * @category Stat
+   * @since v2.2.0
    */
   totalValues: number;
   /**
    * The string length of the Store when serialized to JSON.
+   * @category Stat
+   * @since v2.2.0
    */
   jsonLength: number;
   /**
    * Additional detailed statistics about the Store if the `detail` flag is
    * specified in the getStoreStats method.
+   * @category Stat
+   * @since v2.2.0
    */
   detail?: StoreStatsDetail;
 };
@@ -61,6 +73,8 @@ export type StoreStats = {
 export type StoreStatsDetail = {
   /**
    * Information about each Table in the Store.
+   * @category Stat
+   * @since v2.2.0
    */
   tables: {[tableId: Id]: StoreStatsTableDetail};
 };
@@ -74,14 +88,20 @@ export type StoreStatsDetail = {
 export type StoreStatsTableDetail = {
   /**
    * The number of Row objects in the Table.
+   * @category Stat
+   * @since v2.2.0
    */
   tableRows: number;
   /**
    * The number of Cell objects in the Table, across all Row objects.
+   * @category Stat
+   * @since v2.2.0
    */
   tableCells: number;
   /**
    * Detail about the Table object.
+   * @category Stat
+   * @since v2.2.0
    */
   rows: {[rowId: Id]: StoreStatsRowDetail};
 };
@@ -95,6 +115,8 @@ export type StoreStatsTableDetail = {
 export type StoreStatsRowDetail = {
   /**
    * The number of Cell objects in the Row.
+   * @category Stat
+   * @since v2.2.0
    */
   rowCells: number;
 };

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

@@ -23,28 +23,40 @@ import type {Id} from '../../common/with-schemas/index.d.cts';
 export type StoreStats = {
   /**
    * The number of Table objects in the Store.
+   * @category Stat
+   * @since v2.2.0
    */
   totalTables: number;
   /**
    * The number of Row objects in the Store, across all Table objects.
+   * @category Stat
+   * @since v2.2.0
    */
   totalRows: number;
   /**
    * The number of Cell objects in the Store, across all Row objects, across all
    * Table objects.
+   * @category Stat
+   * @since v2.2.0
    */
   totalCells: number;
   /**
    * The number of Value objects in the Store, since v3.0.
+   * @category Stat
+   * @since v2.2.0
    */
   totalValues: number;
   /**
    * The string length of the Store when serialized to JSON.
+   * @category Stat
+   * @since v2.2.0
    */
   jsonLength: number;
   /**
    * Additional detailed statistics about the Store if the `detail` flag is
    * specified in the getStoreStats method.
+   * @category Stat
+   * @since v2.2.0
    */
   detail?: StoreStatsDetail;
 };
@@ -61,6 +73,8 @@ export type StoreStats = {
 export type StoreStatsDetail = {
   /**
    * Information about each Table in the Store.
+   * @category Stat
+   * @since v2.2.0
    */
   tables: {[tableId: Id]: StoreStatsTableDetail};
 };
@@ -74,14 +88,20 @@ export type StoreStatsDetail = {
 export type StoreStatsTableDetail = {
   /**
    * The number of Row objects in the Table.
+   * @category Stat
+   * @since v2.2.0
    */
   tableRows: number;
   /**
    * The number of Cell objects in the Table, across all Row objects.
+   * @category Stat
+   * @since v2.2.0
    */
   tableCells: number;
   /**
    * Detail about the Table object.
+   * @category Stat
+   * @since v2.2.0
    */
   rows: {[rowId: Id]: StoreStatsRowDetail};
 };
@@ -95,6 +115,8 @@ export type StoreStatsTableDetail = {
 export type StoreStatsRowDetail = {
   /**
    * The number of Cell objects in the Row.
+   * @category Stat
+   * @since v2.2.0
    */
   rowCells: number;
 };

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

@@ -23,28 +23,40 @@ import type {Id} from '../../common/with-schemas/index.d.ts';
 export type StoreStats = {
   /**
    * The number of Table objects in the Store.
+   * @category Stat
+   * @since v2.2.0
    */
   totalTables: number;
   /**
    * The number of Row objects in the Store, across all Table objects.
+   * @category Stat
+   * @since v2.2.0
    */
   totalRows: number;
   /**
    * The number of Cell objects in the Store, across all Row objects, across all
    * Table objects.
+   * @category Stat
+   * @since v2.2.0
    */
   totalCells: number;
   /**
    * The number of Value objects in the Store, since v3.0.
+   * @category Stat
+   * @since v2.2.0
    */
   totalValues: number;
   /**
    * The string length of the Store when serialized to JSON.
+   * @category Stat
+   * @since v2.2.0
    */
   jsonLength: number;
   /**
    * Additional detailed statistics about the Store if the `detail` flag is
    * specified in the getStoreStats method.
+   * @category Stat
+   * @since v2.2.0
    */
   detail?: StoreStatsDetail;
 };
@@ -61,6 +73,8 @@ export type StoreStats = {
 export type StoreStatsDetail = {
   /**
    * Information about each Table in the Store.
+   * @category Stat
+   * @since v2.2.0
    */
   tables: {[tableId: Id]: StoreStatsTableDetail};
 };
@@ -74,14 +88,20 @@ export type StoreStatsDetail = {
 export type StoreStatsTableDetail = {
   /**
    * The number of Row objects in the Table.
+   * @category Stat
+   * @since v2.2.0
    */
   tableRows: number;
   /**
    * The number of Cell objects in the Table, across all Row objects.
+   * @category Stat
+   * @since v2.2.0
    */
   tableCells: number;
   /**
    * Detail about the Table object.
+   * @category Stat
+   * @since v2.2.0
    */
   rows: {[rowId: Id]: StoreStatsRowDetail};
 };
@@ -95,6 +115,8 @@ export type StoreStatsTableDetail = {
 export type StoreStatsRowDetail = {
   /**
    * The number of Cell objects in the Row.
+   * @category Stat
+   * @since v2.2.0
    */
   rowCells: number;
 };