tinybase 5.0.0-beta.1 → 5.0.0-beta.2

package/lib/types/store.d.ts

@@ -11,6 +11,7 @@
  */
 
 import {Id, IdOrNull, Ids, Json} from './common.d';
+import {StoreAlias} from './internal/store.d';
 
 /**
  * The TablesSchema type describes the tabular structure of a Store in terms of
@@ -523,7 +524,7 @@ export type DoRollback = (
  * log of the changes made or attempted during the transaction, since v4.0.
  * @category Listener
  */
-export type TransactionListener = (
+export type TransactionListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   getTransactionChanges: GetTransactionChanges,
   getTransactionLog: GetTransactionLog,
@@ -544,7 +545,10 @@ export type TransactionListener = (
  * @category Listener
  * @since v4.4.0
  */
-export type HasTablesListener = (store: Store, hasTables: boolean) => void;
+export type HasTablesListener<Store extends StoreAlias = StoreAlias> = (
+  store: Store,
+  hasTables: boolean,
+) => void;
 
 /**
  * The TablesListener type describes a function that is used to listen to
@@ -565,7 +569,7 @@ export type HasTablesListener = (store: Store, hasTables: boolean) => void;
  * changes.
  * @category Listener
  */
-export type TablesListener = (
+export type TablesListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   getCellChange: GetCellChange | undefined,
 ) => void;
@@ -586,7 +590,7 @@ export type TablesListener = (
  * since v3.3.
  * @category Listener
  */
-export type TableIdsListener = (
+export type TableIdsListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   getIdChanges: GetIdChanges | undefined,
 ) => void;
@@ -608,7 +612,7 @@ export type TableIdsListener = (
  * @category Listener
  * @since v4.4.0
  */
-export type HasTableListener = (
+export type HasTableListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   tableId: Id,
   hasTable: boolean,
@@ -634,7 +638,7 @@ export type HasTableListener = (
  * changes.
  * @category Listener
  */
-export type TableListener = (
+export type TableListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   tableId: Id,
   getCellChange: GetCellChange | undefined,
@@ -656,7 +660,7 @@ export type TableListener = (
  * @category Listener
  * @since v3.3.0
  */
-export type TableCellIdsListener = (
+export type TableCellIdsListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   tableId: Id,
   getIdChanges: GetIdChanges | undefined,
@@ -680,7 +684,7 @@ export type TableCellIdsListener = (
  * @category Listener
  * @since v4.4.0
  */
-export type HasTableCellListener = (
+export type HasTableCellListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   tableId: Id,
   cellId: Id,
@@ -702,7 +706,7 @@ export type HasTableCellListener = (
  * @category Listener
  * @since v4.1.0
  */
-export type RowCountListener = (
+export type RowCountListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   tableId: Id,
   count: number,
@@ -726,7 +730,7 @@ export type RowCountListener = (
  * since v3.3.
  * @category Listener
  */
-export type RowIdsListener = (
+export type RowIdsListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   tableId: Id,
   getIdChanges: GetIdChanges | undefined,
@@ -755,7 +759,7 @@ export type RowIdsListener = (
  * @category Listener
  * @since v2.0.0
  */
-export type SortedRowIdsListener = (
+export type SortedRowIdsListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   tableId: Id,
   cellId: Id | undefined,
@@ -783,7 +787,7 @@ export type SortedRowIdsListener = (
  * @category Listener
  * @since v4.4.0
  */
-export type HasRowListener = (
+export type HasRowListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   tableId: Id,
   rowId: Id,
@@ -812,7 +816,7 @@ export type HasRowListener = (
  * changes.
  * @category Listener
  */
-export type RowListener = (
+export type RowListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   tableId: Id,
   rowId: Id,
@@ -838,7 +842,7 @@ export type RowListener = (
  * since v3.3.
  * @category Listener
  */
-export type CellIdsListener = (
+export type CellIdsListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   tableId: Id,
   rowId: Id,
@@ -864,7 +868,7 @@ export type CellIdsListener = (
  * @category Listener
  * @since v4.4.0
  */
-export type HasCellListener = (
+export type HasCellListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   tableId: Id,
   rowId: Id,
@@ -899,7 +903,7 @@ export type HasCellListener = (
  * changes.
  * @category Listener
  */
-export type CellListener = (
+export type CellListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   tableId: Id,
   rowId: Id,
@@ -924,7 +928,10 @@ export type CellListener = (
  * @category Listener
  * @since v4.4.0
  */
-export type HasValuesListener = (store: Store, hasValues: boolean) => void;
+export type HasValuesListener<Store extends StoreAlias = StoreAlias> = (
+  store: Store,
+  hasValues: boolean,
+) => void;
 
 /**
  * The ValuesListener type describes a function that is used to listen to
@@ -945,7 +952,7 @@ export type HasValuesListener = (store: Store, hasValues: boolean) => void;
  * changes.
  * @category Listener
  */
-export type ValuesListener = (
+export type ValuesListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   getValueChange: GetValueChange | undefined,
 ) => void;
@@ -966,7 +973,7 @@ export type ValuesListener = (
  * since v3.3.
  * @category Listener
  */
-export type ValueIdsListener = (
+export type ValueIdsListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   getIdChanges: GetIdChanges | undefined,
 ) => void;
@@ -988,7 +995,7 @@ export type ValueIdsListener = (
  * @category Listener
  * @since v4.4.0
  */
-export type HasValueListener = (
+export type HasValueListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   valueId: Id,
   hasValue: boolean,
@@ -1019,7 +1026,7 @@ export type HasValueListener = (
  * @category Listener
  * @since v3.0.0
  */
-export type ValueListener = (
+export type ValueListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   valueId: Id,
   newValue: Value,
@@ -1048,7 +1055,7 @@ export type ValueListener = (
  * @category Listener
  * @since v1.1.0
  */
-export type InvalidCellListener = (
+export type InvalidCellListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   tableId: Id,
   rowId: Id,
@@ -1075,7 +1082,7 @@ export type InvalidCellListener = (
  * @category Listener
  * @since v3.0.0
  */
-export type InvalidValueListener = (
+export type InvalidValueListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
   valueId: Id,
   invalidValues: any[],
@@ -2657,7 +2664,7 @@ export interface Store {
    * @category Setter
    * @since v4.0.0
    */
-  setContent([tables, values]: [Tables, Values]): Store;
+  setContent([tables, values]: [Tables, Values]): this;
 
   /**
    * The setTables method takes an object and sets the entire tabular data of
@@ -2705,7 +2712,7 @@ export interface Store {
    * ```
    * @category Setter
    */
-  setTables(tables: Tables): Store;
+  setTables(tables: Tables): this;
 
   /**
    * The setTable method takes an object and sets the entire data of a single
@@ -2755,7 +2762,7 @@ export interface Store {
    * ```
    * @category Setter
    */
-  setTable(tableId: Id, table: Table): Store;
+  setTable(tableId: Id, table: Table): this;
 
   /**
    * The setRow method takes an object and sets the entire data of a single Row
@@ -2804,7 +2811,7 @@ export interface Store {
    * ```
    * @category Setter
    */
-  setRow(tableId: Id, rowId: Id, row: Row): Store;
+  setRow(tableId: Id, rowId: Id, row: Row): this;
 
   /**
    * The addRow method takes an object and creates a new Row in the Store,
@@ -2916,7 +2923,7 @@ export interface Store {
    * ```
    * @category Setter
    */
-  setPartialRow(tableId: Id, rowId: Id, partialRow: Row): Store;
+  setPartialRow(tableId: Id, rowId: Id, partialRow: Row): this;
 
   /**
    * The setCell method sets the value of a single Cell in the Store.
@@ -2973,7 +2980,7 @@ export interface Store {
    * ```
    * @category Setter
    */
-  setCell(tableId: Id, rowId: Id, cellId: Id, cell: Cell | MapCell): Store;
+  setCell(tableId: Id, rowId: Id, cellId: Id, cell: Cell | MapCell): this;
 
   /**
    * The setValues method takes an object and sets all the Values in the Store.
@@ -3020,7 +3027,7 @@ export interface Store {
    * @category Setter
    * @since v3.0.0
    */
-  setValues(values: Values): Store;
+  setValues(values: Values): this;
 
   /**
    * The setPartialValues method takes an object and sets its Values in the
@@ -3069,7 +3076,7 @@ export interface Store {
    * @category Setter
    * @since v3.0.0
    */
-  setPartialValues(partialValues: Values): Store;
+  setPartialValues(partialValues: Values): this;
 
   /**
    * The setValue method sets a single keyed Value in the Store.
@@ -3122,7 +3129,7 @@ export interface Store {
    * @category Setter
    * @since v3.0.0
    */
-  setValue(valueId: Id, value: Value | MapValue): Store;
+  setValue(valueId: Id, value: Value | MapValue): this;
 
   /**
    * The setTransactionChanges method applies a set of TransactionChanges to the
@@ -3163,7 +3170,7 @@ export interface Store {
    * @category Setter
    * @since v4.0.0
    */
-  setTransactionChanges(transactionChanges: TransactionChanges): Store;
+  setTransactionChanges(transactionChanges: TransactionChanges): this;
 
   /**
    * The setTablesJson method takes a string serialization of all of the Tables
@@ -3197,7 +3204,7 @@ export interface Store {
    * @category Setter
    * @since v3.0.0
    */
-  setTablesJson(tablesJson: Json): Store;
+  setTablesJson(tablesJson: Json): this;
 
   /**
    * The setValuesJson method takes a string serialization of all of the Values
@@ -3231,7 +3238,7 @@ export interface Store {
    * @category Setter
    * @since v3.0.0
    */
-  setValuesJson(valuesJson: Json): Store;
+  setValuesJson(valuesJson: Json): this;
 
   /**
    * The setJson method takes a string serialization of all of the Tables and
@@ -3289,7 +3296,7 @@ export interface Store {
    * ```
    * @category Setter
    */
-  setJson(tablesAndValuesJson: Json): Store;
+  setJson(tablesAndValuesJson: Json): this;
 
   /**
    * The setTablesSchema method lets you specify the TablesSchema of the tabular
@@ -3321,7 +3328,7 @@ export interface Store {
    * @category Setter
    * @since v3.0.0
    */
-  setTablesSchema(tablesSchema: TablesSchema): Store;
+  setTablesSchema(tablesSchema: TablesSchema): this;
 
   /**
    * The setValuesSchema method lets you specify the ValuesSchema of the keyed
@@ -3350,7 +3357,7 @@ export interface Store {
    * @category Setter
    * @since v3.0.0
    */
-  setValuesSchema(valuesSchema: ValuesSchema): Store;
+  setValuesSchema(valuesSchema: ValuesSchema): this;
 
   /**
    * The setSchema method lets you specify the TablesSchema and ValuesSchema of
@@ -3408,7 +3415,7 @@ export interface Store {
    * ```
    * @category Setter
    */
-  setSchema(tablesSchema: TablesSchema, valuesSchema?: ValuesSchema): Store;
+  setSchema(tablesSchema: TablesSchema, valuesSchema?: ValuesSchema): this;
 
   /**
    * The delTables method lets you remove all of the data in a Store.
@@ -3425,7 +3432,7 @@ export interface Store {
    * ```
    * @category Deleter
    */
-  delTables(): Store;
+  delTables(): this;
 
   /**
    * The delTable method lets you remove a single Table from the Store.
@@ -3446,7 +3453,7 @@ export interface Store {
    * ```
    * @category Deleter
    */
-  delTable(tableId: Id): Store;
+  delTable(tableId: Id): this;
 
   /**
    * The delRow method lets you remove a single Row from a Table.
@@ -3469,7 +3476,7 @@ export interface Store {
    * ```
    * @category Deleter
    */
-  delRow(tableId: Id, rowId: Id): Store;
+  delRow(tableId: Id, rowId: Id): this;
 
   /**
    * The delCell method lets you remove a single Cell from a Row.
@@ -3552,7 +3559,7 @@ export interface Store {
    * ```
    * @category Deleter
    */
-  delCell(tableId: Id, rowId: Id, cellId: Id, forceDel?: boolean): Store;
+  delCell(tableId: Id, rowId: Id, cellId: Id, forceDel?: boolean): this;
 
   /**
    * The delValues method lets you remove all the Values from a Store.
@@ -3590,7 +3597,7 @@ export interface Store {
    * @category Deleter
    * @since v3.0.0
    */
-  delValues(): Store;
+  delValues(): this;
 
   /**
    * The delValue method lets you remove a single Value from a Store.
@@ -3629,7 +3636,7 @@ export interface Store {
    * @category Deleter
    * @since v3.0.0
    */
-  delValue(valueId: Id): Store;
+  delValue(valueId: Id): this;
 
   /**
    * The delTablesSchema method lets you remove the TablesSchema of the Store.
@@ -3647,7 +3654,7 @@ export interface Store {
    * ```
    * @category Deleter
    */
-  delTablesSchema(): Store;
+  delTablesSchema(): this;
 
   /**
    * The delValuesSchema method lets you remove the ValuesSchema of the Store.
@@ -3666,7 +3673,7 @@ export interface Store {
    * @category Deleter
    * @since v3.0.0
    */
-  delValuesSchema(): Store;
+  delValuesSchema(): this;
 
   /**
    * The delSchema method lets you remove both the TablesSchema and ValuesSchema
@@ -3692,7 +3699,7 @@ export interface Store {
    * @category Deleter
    * @since v3.0.0
    */
-  delSchema(): Store;
+  delSchema(): this;
 
   /**
    * The transaction method takes a function that makes multiple mutations to
@@ -3871,7 +3878,7 @@ export interface Store {
    * @category Transaction
    * @since v1.3.0
    */
-  startTransaction(): Store;
+  startTransaction(): this;
 
   /**
    * The finishTransaction method allows you to explicitly finish a transaction
@@ -3968,7 +3975,7 @@ export interface Store {
    * @category Transaction
    * @since v1.3.0
    */
-  finishTransaction(doRollback?: DoRollback): Store;
+  finishTransaction(doRollback?: DoRollback): this;
 
   /**
    * The forEachTable method takes a function that it will then call for each
@@ -4179,7 +4186,10 @@ export interface Store {
    * @category Listener
    * @since v4.4.0
    */
-  addHasTablesListener(listener: HasTablesListener, mutator?: boolean): Id;
+  addHasTablesListener(
+    listener: HasTablesListener<this>,
+    mutator?: boolean,
+  ): Id;
 
   /**
    * The addTablesListener method registers a listener function with the Store
@@ -4242,7 +4252,7 @@ export interface Store {
    * ```
    * @category Listener
    */
-  addTablesListener(listener: TablesListener, mutator?: boolean): Id;
+  addTablesListener(listener: TablesListener<this>, mutator?: boolean): Id;
 
   /**
    * The addTableIdsListener method registers a listener function with the Store
@@ -4304,7 +4314,7 @@ export interface Store {
    * ```
    * @category Listener
    */
-  addTableIdsListener(listener: TableIdsListener, mutator?: boolean): Id;
+  addTableIdsListener(listener: TableIdsListener<this>, mutator?: boolean): Id;
 
   /**
    * The addHasTableListener method registers a listener function with the Store
@@ -4403,7 +4413,7 @@ export interface Store {
    */
   addHasTableListener(
     tableId: IdOrNull,
-    listener: HasTableListener,
+    listener: HasTableListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -4499,7 +4509,7 @@ export interface Store {
    */
   addTableListener(
     tableId: IdOrNull,
-    listener: TableListener,
+    listener: TableListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -4603,7 +4613,7 @@ export interface Store {
    */
   addTableCellIdsListener(
     tableId: IdOrNull,
-    listener: TableCellIdsListener,
+    listener: TableCellIdsListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -4722,7 +4732,7 @@ export interface Store {
   addHasTableCellListener(
     tableId: IdOrNull,
     cellId: IdOrNull,
-    listener: HasTableCellListener,
+    listener: HasTableCellListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -4815,7 +4825,7 @@ export interface Store {
    */
   addRowCountListener(
     tableId: IdOrNull,
-    listener: RowCountListener,
+    listener: RowCountListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -4906,7 +4916,7 @@ export interface Store {
    */
   addRowIdsListener(
     tableId: IdOrNull,
-    listener: RowIdsListener,
+    listener: RowIdsListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -5131,7 +5141,7 @@ export interface Store {
     descending: boolean,
     offset: number,
     limit: number | undefined,
-    listener: SortedRowIdsListener,
+    listener: SortedRowIdsListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -5248,7 +5258,7 @@ export interface Store {
   addHasRowListener(
     tableId: IdOrNull,
     rowId: IdOrNull,
-    listener: HasRowListener,
+    listener: HasRowListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -5357,7 +5367,7 @@ export interface Store {
   addRowListener(
     tableId: IdOrNull,
     rowId: IdOrNull,
-    listener: RowListener,
+    listener: RowListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -5462,7 +5472,7 @@ export interface Store {
   addCellIdsListener(
     tableId: IdOrNull,
     rowId: IdOrNull,
-    listener: CellIdsListener,
+    listener: CellIdsListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -5586,7 +5596,7 @@ export interface Store {
     tableId: IdOrNull,
     rowId: IdOrNull,
     cellId: IdOrNull,
-    listener: HasCellListener,
+    listener: HasCellListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -5705,7 +5715,7 @@ export interface Store {
     tableId: IdOrNull,
     rowId: IdOrNull,
     cellId: IdOrNull,
-    listener: CellListener,
+    listener: CellListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -5770,7 +5780,10 @@ export interface Store {
    * @category Listener
    * @since v4.4.0
    */
-  addHasValuesListener(listener: HasValuesListener, mutator?: boolean): Id;
+  addHasValuesListener(
+    listener: HasValuesListener<this>,
+    mutator?: boolean,
+  ): Id;
 
   /**
    * The addValuesListener method registers a listener function with the Store
@@ -5830,7 +5843,7 @@ export interface Store {
    * @category Listener
    * @since v3.0.0
    */
-  addValuesListener(listener: ValuesListener, mutator?: boolean): Id;
+  addValuesListener(listener: ValuesListener<this>, mutator?: boolean): Id;
 
   /**
    * The addValueIdsListener method registers a listener function with the Store
@@ -5893,7 +5906,7 @@ export interface Store {
    * @category Listener
    * @since v3.0.0
    */
-  addValueIdsListener(listener: ValueIdsListener, mutator?: boolean): Id;
+  addValueIdsListener(listener: ValueIdsListener<this>, mutator?: boolean): Id;
 
   /**
    * The addHasValueListener method registers a listener function with the Store
@@ -5986,7 +5999,7 @@ export interface Store {
    */
   addHasValueListener(
     valueId: IdOrNull,
-    listener: HasValueListener,
+    listener: HasValueListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -6078,7 +6091,7 @@ export interface Store {
    */
   addValueListener(
     valueId: IdOrNull,
-    listener: ValueListener,
+    listener: ValueListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -6308,7 +6321,7 @@ export interface Store {
     tableId: IdOrNull,
     rowId: IdOrNull,
     cellId: IdOrNull,
-    listener: InvalidCellListener,
+    listener: InvalidCellListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -6483,7 +6496,7 @@ export interface Store {
    */
   addInvalidValueListener(
     valueId: IdOrNull,
-    listener: InvalidValueListener,
+    listener: InvalidValueListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -6531,7 +6544,7 @@ export interface Store {
    * @category Listener
    * @since v3.2.0
    */
-  addStartTransactionListener(listener: TransactionListener): Id;
+  addStartTransactionListener(listener: TransactionListener<this>): Id;
 
   /**
    * The addWillFinishTransactionListener method registers a listener function
@@ -6630,7 +6643,7 @@ export interface Store {
    * @category Listener
    * @since v1.3.0
    */
-  addWillFinishTransactionListener(listener: TransactionListener): Id;
+  addWillFinishTransactionListener(listener: TransactionListener<this>): Id;
 
   /**
    * The addDidFinishTransactionListener method registers a listener function
@@ -6728,7 +6741,7 @@ export interface Store {
    * @category Listener
    * @since v1.3.0
    */
-  addDidFinishTransactionListener(listener: TransactionListener): Id;
+  addDidFinishTransactionListener(listener: TransactionListener<this>): Id;
 
   /**
    * The callListener method provides a way for you to manually provoke a
@@ -6844,7 +6857,7 @@ export interface Store {
    * ```
    * @category Listener
    */
-  callListener(listenerId: Id): Store;
+  callListener(listenerId: Id): this;
 
   /**
    * The delListener method removes a listener that was previously added to the
@@ -6876,7 +6889,7 @@ export interface Store {
    * ```
    * @category Listener
    */
-  delListener(listenerId: Id): Store;
+  delListener(listenerId: Id): this;
 
   /**
    * The getListenerStats method provides a set of statistics about the

package/lib/types/tinybase.d.ts

@@ -10,4 +10,5 @@ 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';

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

@@ -212,6 +212,7 @@ export type UndoOrRedoInformation = [boolean, Callback, Id | undefined, string];
  * useSetTableCallback hook or useSetRowCallback hook - so that the Id arguments
  * of the object to set can also be dependent on the event or parameter
  * provided (as well as the object itself being set).
+ * @category Identity
  */
 export type GetId<Parameter> = (parameter: Parameter, store: Store) => Id;