tinybase 5.2.0-beta.4 → 5.2.0

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

@@ -73,52 +73,155 @@ export type Stamp<Thing, Hashed extends boolean = false> = Hashed extends true
   ? [thing: Thing, time: Time, hash: Hash]
   : [thing: Thing, time?: Time];
 
-// ContentHashes
+/**
+ * The ContentHashes type is used to quickly compare the content of two
+ * MergeableStore objects.
+ *
+ * It is simply an array of two Hash types, one for the MergeableStore's Tables
+ * and one for its Values.
+ *
+ * This type is mostly utilized internally within TinyBase itself and is
+ * generally assumed to be opaque to applications that use it.
+ * @category Syncing
+ * @since v5.0.0
+ */
 export type ContentHashes = [tablesHash: Hash, valuesHash: Hash];
 
-// TablesStamp
+/**
+ * The TablesStamp type is used as metadata to decide how to merge two different
+ * sets of Tables together.
+ *
+ * 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 TablesStamp<Hashed extends boolean = false> = Stamp<
   {[tableId: Id]: TableStamp<Hashed>},
   Hashed
 >;
 
-// TableHashes
+/**
+ * The TableHashes type is used to quickly compare the content of two sets of
+ * Table objects.
+ *
+ * It is simply an object of Hash types, one for each Table Id in the
+ * MergeableStore.
+ *
+ * This type is mostly utilized internally within TinyBase itself and is
+ * generally assumed to be opaque to applications that use it.
+ * @category Syncing
+ * @since v5.0.0
+ */
 export type TableHashes = {[tableId: Id]: Hash};
 
-// TableStamp
+/**
+ * The TableStamp type is used as metadata to decide how to merge two different
+ * Table objects together.
+ *
+ * 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 TableStamp<Hashed extends boolean = false> = Stamp<
   {[rowId: Id]: RowStamp<Hashed>},
   Hashed
 >;
 
-// RowHashes
+/**
+ * The RowHashes type is used to quickly compare the content of two sets of Row
+ * objects.
+ *
+ * It is simply a nested object of Hash types, one for each Row Id, for each
+ * TableId, in the MergeableStore.
+ *
+ * This type is mostly utilized internally within TinyBase itself and is
+ * generally assumed to be opaque to applications that use it.
+ * @category Syncing
+ * @since v5.0.0
+ */
 export type RowHashes = {[tableId: Id]: {[rowId: Id]: Hash}};
 
-// RowStamp
+/**
+ * The RowStamp type is used as metadata to decide how to merge two different
+ * Row objects together.
+ *
+ * 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 RowStamp<Hashed extends boolean = false> = Stamp<
   {[cellId: Id]: CellStamp<Hashed>},
   Hashed
 >;
 
-// CellHashes
+/**
+ * The CellHashes type is used to quickly compare the content of two sets of
+ * Cell objects.
+ *
+ * It is simply a nested object of Hash types, one for each Cell Id, for each
+ * Row Id, for each TableId, in the MergeableStore.
+ *
+ * This type is mostly utilized internally within TinyBase itself and is
+ * generally assumed to be opaque to applications that use it.
+ * @category Syncing
+ * @since v5.0.0
+ */
 export type CellHashes = {[tableId: Id]: {[rowId: Id]: {[cellId: Id]: Hash}}};
 
-// CellStamp
+/**
+ * The CellStamp type is used as metadata to decide how to merge two different
+ * Cell objects together.
+ *
+ * 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 CellStamp<Hashed extends boolean = false> = Stamp<
   CellOrUndefined,
   Hashed
 >;
 
-// ValuesStamp
+/**
+ * The ValuesStamp type is used as metadata to decide how to merge two different
+ * sets of Values together.
+ *
+ * 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 ValuesStamp<Hashed extends boolean = false> = Stamp<
   {[valueId: Id]: ValueStamp<Hashed>},
   Hashed
 >;
 
-// ValueHashes
+/**
+ * The ValueHashes type is used to quickly compare the content of two sets of
+ * Value objects.
+ *
+ * It is simply an object of Hash types, one for each Value Id in the
+ * MergeableStore.
+ *
+ * This type is mostly utilized internally within TinyBase itself and is
+ * generally assumed to be opaque to applications that use it.
+ * @category Syncing
+ * @since v5.0.0
+ */
 export type ValueHashes = {[valueId: Id]: Hash};
 
-// ValueStamp
+/**
+ * The ValueStamp type is used as metadata to decide how to merge two different
+ * Value objects together.
+ *
+ * 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 ValueStamp<Hashed extends boolean = false> = Stamp<
   ValueOrUndefined,
   Hashed

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

@@ -73,52 +73,155 @@ export type Stamp<Thing, Hashed extends boolean = false> = Hashed extends true
   ? [thing: Thing, time: Time, hash: Hash]
   : [thing: Thing, time?: Time];
 
-// ContentHashes
+/**
+ * The ContentHashes type is used to quickly compare the content of two
+ * MergeableStore objects.
+ *
+ * It is simply an array of two Hash types, one for the MergeableStore's Tables
+ * and one for its Values.
+ *
+ * This type is mostly utilized internally within TinyBase itself and is
+ * generally assumed to be opaque to applications that use it.
+ * @category Syncing
+ * @since v5.0.0
+ */
 export type ContentHashes = [tablesHash: Hash, valuesHash: Hash];
 
-// TablesStamp
+/**
+ * The TablesStamp type is used as metadata to decide how to merge two different
+ * sets of Tables together.
+ *
+ * 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 TablesStamp<Hashed extends boolean = false> = Stamp<
   {[tableId: Id]: TableStamp<Hashed>},
   Hashed
 >;
 
-// TableHashes
+/**
+ * The TableHashes type is used to quickly compare the content of two sets of
+ * Table objects.
+ *
+ * It is simply an object of Hash types, one for each Table Id in the
+ * MergeableStore.
+ *
+ * This type is mostly utilized internally within TinyBase itself and is
+ * generally assumed to be opaque to applications that use it.
+ * @category Syncing
+ * @since v5.0.0
+ */
 export type TableHashes = {[tableId: Id]: Hash};
 
-// TableStamp
+/**
+ * The TableStamp type is used as metadata to decide how to merge two different
+ * Table objects together.
+ *
+ * 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 TableStamp<Hashed extends boolean = false> = Stamp<
   {[rowId: Id]: RowStamp<Hashed>},
   Hashed
 >;
 
-// RowHashes
+/**
+ * The RowHashes type is used to quickly compare the content of two sets of Row
+ * objects.
+ *
+ * It is simply a nested object of Hash types, one for each Row Id, for each
+ * TableId, in the MergeableStore.
+ *
+ * This type is mostly utilized internally within TinyBase itself and is
+ * generally assumed to be opaque to applications that use it.
+ * @category Syncing
+ * @since v5.0.0
+ */
 export type RowHashes = {[tableId: Id]: {[rowId: Id]: Hash}};
 
-// RowStamp
+/**
+ * The RowStamp type is used as metadata to decide how to merge two different
+ * Row objects together.
+ *
+ * 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 RowStamp<Hashed extends boolean = false> = Stamp<
   {[cellId: Id]: CellStamp<Hashed>},
   Hashed
 >;
 
-// CellHashes
+/**
+ * The CellHashes type is used to quickly compare the content of two sets of
+ * Cell objects.
+ *
+ * It is simply a nested object of Hash types, one for each Cell Id, for each
+ * Row Id, for each TableId, in the MergeableStore.
+ *
+ * This type is mostly utilized internally within TinyBase itself and is
+ * generally assumed to be opaque to applications that use it.
+ * @category Syncing
+ * @since v5.0.0
+ */
 export type CellHashes = {[tableId: Id]: {[rowId: Id]: {[cellId: Id]: Hash}}};
 
-// CellStamp
+/**
+ * The CellStamp type is used as metadata to decide how to merge two different
+ * Cell objects together.
+ *
+ * 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 CellStamp<Hashed extends boolean = false> = Stamp<
   CellOrUndefined,
   Hashed
 >;
 
-// ValuesStamp
+/**
+ * The ValuesStamp type is used as metadata to decide how to merge two different
+ * sets of Values together.
+ *
+ * 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 ValuesStamp<Hashed extends boolean = false> = Stamp<
   {[valueId: Id]: ValueStamp<Hashed>},
   Hashed
 >;
 
-// ValueHashes
+/**
+ * The ValueHashes type is used to quickly compare the content of two sets of
+ * Value objects.
+ *
+ * It is simply an object of Hash types, one for each Value Id in the
+ * MergeableStore.
+ *
+ * This type is mostly utilized internally within TinyBase itself and is
+ * generally assumed to be opaque to applications that use it.
+ * @category Syncing
+ * @since v5.0.0
+ */
 export type ValueHashes = {[valueId: Id]: Hash};
 
-// ValueStamp
+/**
+ * The ValueStamp type is used as metadata to decide how to merge two different
+ * Value objects together.
+ *
+ * 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 ValueStamp<Hashed extends boolean = false> = Stamp<
   ValueOrUndefined,
   Hashed

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

@@ -86,10 +86,38 @@ export type Stamp<Thing, Hashed extends boolean = false> = Hashed extends true
   ? [thing: Thing, time: Time, hash: Hash]
   : [thing: Thing, time?: Time];
 
-// ContentHashes
+/**
+ * The ContentHashes type is used to quickly compare the content of two
+ * MergeableStore objects.
+ *
+ * It is simply an array of two Hash types, one for the MergeableStore's Tables
+ * and one for its Values.
+ *
+ * This type is mostly utilized internally within TinyBase itself and is
+ * generally assumed to be opaque to applications that use it.
+ * @category Syncing
+ * @since v5.0.0
+ */
 export type ContentHashes = [tablesHash: Hash, valuesHash: Hash];
 
-// TablesStamp
+/**
+ * The TablesStamp type is used as metadata to decide how to merge two different
+ * sets of Tables together.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * export type TablesStamp<Hashed extends boolean = false> = Stamp<
+ *   {[tableId: Id]: TableStamp<Hashed>},
+ *   Hashed
+ * >;
+ * ```
+ *
+ * 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 TablesStamp<
   Schema extends OptionalTablesSchema,
   Hashed extends boolean = false,
@@ -104,24 +132,92 @@ export type TablesStamp<
   Hashed
 >;
 
-// TableHashes
+/**
+ * The TableHashes type is used to quickly compare the content of two sets of
+ * Table objects.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * {[tableId: Id]: Hash};
+ * ```
+ *
+ * It is simply an object of Hash types, one for each Table Id in the
+ * MergeableStore.
+ *
+ * This type is mostly utilized internally within TinyBase itself and is
+ * generally assumed to be opaque to applications that use it.
+ * @category Syncing
+ * @since v5.0.0
+ */
 export type TableHashes<Schema extends OptionalTablesSchema> = {
   [TableId in TableIdFromSchema<Schema>]?: Hash;
 };
 
-// TableStamp
+/**
+ * The TableStamp type is used as metadata to decide how to merge two different
+ * Table objects together.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * export type TableStamp<Hashed extends boolean = false> = Stamp<
+ *   {[rowId: Id]: RowStamp<Hashed>},
+ *   Hashed
+ * >;
+ * ```
+ *
+ * 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 TableStamp<
   Schema extends OptionalTablesSchema,
   TableId extends TableIdFromSchema<Schema>,
   Hashed extends boolean = false,
 > = Stamp<{[rowId: Id]: RowStamp<Schema, TableId, Hashed>}, Hashed>;
 
-// RowHashes
+/**
+ * The RowHashes type is used to quickly compare the content of two sets of Row
+ * objects.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * {[tableId: Id]: {[rowId: Id]: Hash}};
+ * ```
+ *
+ * It is simply a nested object of Hash types, one for each Row Id, for each
+ * TableId, in the MergeableStore.
+ *
+ * This type is mostly utilized internally within TinyBase itself and is
+ * generally assumed to be opaque to applications that use it.
+ * @category Syncing
+ * @since v5.0.0
+ */
 export type RowHashes<Schema extends OptionalTablesSchema> = {
   [TableId in TableIdFromSchema<Schema>]?: {[rowId: Id]: Hash};
 };
 
-// RowStamp
+/**
+ * The RowStamp type is used as metadata to decide how to merge two different
+ * Row objects together.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * export type RowStamp<Hashed extends boolean = false> = Stamp<
+ *   {[cellId: Id]: CellStamp<Hashed>},
+ *   Hashed
+ * >;
+ * ```
+ *
+ * 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 RowStamp<
   Schema extends OptionalTablesSchema,
   TableId extends TableIdFromSchema<Schema>,
@@ -138,14 +234,48 @@ export type RowStamp<
   Hashed
 >;
 
-// CellHashes
+/**
+ * The CellHashes type is used to quickly compare the content of two sets of
+ * Cell objects.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * {[tableId: Id]: {[rowId: Id]: {[cellId: Id]: Hash}}};
+ * ```
+ *
+ * It is simply a nested object of Hash types, one for each Cell Id, for each
+ * Row Id, for each TableId, in the MergeableStore.
+ *
+ * This type is mostly utilized internally within TinyBase itself and is
+ * generally assumed to be opaque to applications that use it.
+ * @category Syncing
+ * @since v5.0.0
+ */
 export type CellHashes<Schema extends OptionalTablesSchema> = {
   [TableId in TableIdFromSchema<Schema>]?: {
     [rowId: Id]: {[CellId in CellIdFromSchema<Schema, TableId>]?: Hash};
   };
 };
 
-// CellStamp
+/**
+ * The CellStamp type is used as metadata to decide how to merge two different
+ * Cell objects together.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * export type CellStamp<Hashed extends boolean = false> = Stamp<
+ *   CellOrUndefined,
+ *   Hashed
+ * >;
+ * ```
+ *
+ * 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 CellStamp<
   Schema extends OptionalTablesSchema,
   TableId extends TableIdFromSchema<Schema>,
@@ -153,7 +283,24 @@ export type CellStamp<
   Hashed extends boolean = false,
 > = Stamp<CellOrUndefined<Schema, TableId, CellId>, Hashed>;
 
-// ValuesStamp
+/**
+ * The ValuesStamp type is used as metadata to decide how to merge two different
+ * sets of Values together.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * export type ValuesStamp<Hashed extends boolean = false> = Stamp<
+ *   {[valueId: Id]: ValueStamp<Hashed>},
+ *   Hashed
+ * >;
+ * ```
+ *
+ * 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 ValuesStamp<
   Schema extends OptionalValuesSchema,
   Hashed extends boolean = false,
@@ -168,12 +315,46 @@ export type ValuesStamp<
   Hashed
 >;
 
-// ValueHashes
+/**
+ * The ValueHashes type is used to quickly compare the content of two sets of
+ * Value objects.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * {[valueId: Id]: Hash};
+ * ```
+ *
+ * It is simply an object of Hash types, one for each Value Id in the
+ * MergeableStore.
+ *
+ * This type is mostly utilized internally within TinyBase itself and is
+ * generally assumed to be opaque to applications that use it.
+ * @category Syncing
+ * @since v5.0.0
+ */
 export type ValueHashes<Schema extends OptionalValuesSchema> = {
   [ValueId in ValueIdFromSchema<Schema>]?: Hash;
 };
 
-// ValueStamp
+/**
+ * The ValueStamp type is used as metadata to decide how to merge two different
+ * Value objects together.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * export type ValueStamp<Hashed extends boolean = false> = Stamp<
+ *   ValueOrUndefined,
+ *   Hashed
+ * >;
+ * ```
+ *
+ * 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 ValueStamp<
   Schema extends OptionalValuesSchema,
   ValueId extends ValueIdFromSchema<Schema>,