tinybase 5.0.0-beta.1 → 5.0.0-beta.11

package/lib/types/store.d.ts

@@ -10,7 +10,8 @@
  * @module store
  */
 
-import {Id, IdOrNull, Ids, Json} from './common.d';
+import {Id, IdOrNull, Ids, Json} from './common.d.ts';
+import {StoreAlias} from './internal/store.d.ts';
 
 /**
  * The TablesSchema type describes the tabular structure of a Store in terms of
@@ -155,6 +156,37 @@ export type OptionalSchemas = [OptionalTablesSchema, OptionalValuesSchema];
  */
 export type NoSchemas = [NoTablesSchema, NoValuesSchema];
 
+/**
+ * The Content type describes both the Tables and Values in a Store.
+ *
+ * It is an array of two objects, representing tabular and keyed value content.
+ * @example
+ * The following is a valid Content array:
+ * ```json
+ * [
+ *   {
+ *     "pets": {
+ *       "fido": {
+ *         "sold": false,
+ *         "price": 4,
+ *       },
+ *       "felix": {
+ *         "sold": true,
+ *         "price": 5,
+ *       },
+ *     },
+ *   },
+ *   {
+ *     open: true,
+ *     employees: 3,
+ *   },
+ * ]
+ * ```
+ * @category Store
+ * @since v5.0.0
+ */
+export type Content = [Tables, Values];
+
 /**
  * The Tables type is the data structure representing all of the data in a
  * Store.
@@ -489,20 +521,13 @@ export type ChangedValueIds = {[valueId: Id]: IdAddedOrRemoved};
  * A DoRollback can be provided when calling the transaction method or the
  * finishTransaction method. See those methods for specific examples.
  *
- * Since v4.0, this function is provided only with two functions that you can
- * call to get information about the changes made within the transaction (in
- * order to decide whether to do the rollback). See the GetTransactionChanges
- * and GetTransactionLog function types for more details.
- * @param getTransactionChanges A function to be called to get the changes made
- * to the Store during the transaction, since v4.0.
- * @param getTransactionChanges A function to be called to get a more detailed
- * log of the changes made or attempted during the transaction, since v4.0.
+ * Since v5.0, this function is called with the Store as a single argument. You
+ * can use the getTransactionChanges method and getTransactionLog method of the
+ * Store directly to decide whether to do the rollback.
+ * @param store A reference to the Store that is completing a transaction.
  * @category Callback
  */
-export type DoRollback = (
-  getTransactionChanges: GetTransactionChanges,
-  getTransactionLog: GetTransactionLog,
-) => boolean;
+export type DoRollback = (store: Store) => boolean;
 
 /**
  * The TransactionListener type describes a function that is used to listen to
@@ -512,21 +537,15 @@ export type DoRollback = (
  * addWillFinishTransactionListener and addDidFinishTransactionListener methods.
  * See those methods for specific examples.
  *
- * When called, a TransactionListener is simply given a reference to the Store
- * and, since v4.0, two functions that you can call to get information about the
- * changes made within the transaction. See the GetTransactionChanges and
- * GetTransactionLog function types for more details.
+ * Since v5.0, this listener is called with no arguments other than the Store.
+ * You can use the getTransactionChanges method and getTransactionLog method of
+ * the Store directly to get information about the changes made within the
+ * transaction.
  * @param store A reference to the Store that is completing a transaction.
- * @param getTransactionChanges A function to be called to get the changes made
- * to the Store during the transaction, since v4.0.
- * @param getTransactionChanges A function to be called to get a more detailed
- * 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,
 ) => void;
 
 /**
@@ -544,7 +563,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 +587,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 +608,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 +630,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 +656,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 +678,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 +702,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 +724,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 +748,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 +777,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 +805,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 +834,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 +860,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 +886,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 +921,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 +946,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 +970,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 +991,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 +1013,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 +1044,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 +1073,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 +1100,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[],
@@ -1205,7 +1230,7 @@ export type ChangedCells = {
  * @category Transaction
  * @since v1.2.0
  */
-export type ChangedCell = [CellOrUndefined, CellOrUndefined];
+export type ChangedCell = [oldCell: CellOrUndefined, newCell: CellOrUndefined];
 
 /**
  * The InvalidCells type describes the invalid Cell values that have been
@@ -1273,7 +1298,10 @@ export type ChangedValues = {
  * @category Transaction
  * @since v3.0.0
  */
-export type ChangedValue = [ValueOrUndefined, ValueOrUndefined];
+export type ChangedValue = [
+  oldValue: ValueOrUndefined,
+  newValue: ValueOrUndefined,
+];
 
 /**
  * The InvalidValues type describes the invalid Values that have been attempted
@@ -1293,8 +1321,8 @@ export type ChangedValue = [ValueOrUndefined, ValueOrUndefined];
 export type InvalidValues = {[valueId: Id]: any[]};
 
 /**
- * The TransactionChanges type describes the net meaningful changes that were
- * made to a Store during a transaction.
+ * The Changes type describes the net meaningful changes that were made to a
+ * Store during a transaction.
  *
  * This contains mostly equivalent information to a TransactionLog, but in a
  * form that can be more efficiently parsed and serialized (for example in the
@@ -1317,8 +1345,11 @@ export type InvalidValues = {[valueId: Id]: any[]};
  * If not empty, the second object has an entry for each Value in a Store that
  * has had a change. If the entry is null, the Value was deleted, otherwise it
  * will contain the new Value it was changed to during the transaction.
+ *
+ * A third, required, item in the array is the digit `1`, so that instances of
+ * Content and Changes types can be disambiguated.
  * @example
- * The following is a valid TransactionChanges array that conveys the following:
+ * The following is a valid Changes array that conveys the following:
  * ```json
  * [
  *   {                     // changes to tabular data in the Store
@@ -1332,33 +1363,27 @@ export type InvalidValues = {[valueId: Id]: any[]};
  *     "pendingSales": null, // this Table was deleted
  *   },
  *   {},                   // no changes to keyed value data in the Store
+ *   1,                    // indicates that this is a Changes array
  * ]
  * ```
  * @category Transaction
  * @since v4.0.0
  */
-export type TransactionChanges = [
-  {[tableId: Id]: {[rowId: Id]: {[cellId: Id]: Cell | null} | null} | null},
-  {[valueId: Id]: Value | null},
+export type Changes = [
+  changedTables: {
+    [tableId: Id]:
+      | {[rowId: Id]: {[cellId: Id]: CellOrUndefined} | undefined}
+      | undefined;
+  },
+  changedValues: {[valueId: Id]: ValueOrUndefined},
+  isChanges: 1,
 ];
 
-/**
- * The GetTransactionChanges type describes a function that returns the net
- * meaningful changes that were made to a Store during a transaction.
- *
- * It is provided to the DoRollback callback and to a TransactionListener
- * listener when a transaction completes. See the TransactionChanges type for
- * more information and an example of the returned data structure.
- * @category Transaction
- * @since v4.0.0
- */
-export type GetTransactionChanges = () => TransactionChanges;
-
 /**
  * The TransactionLog type describes the changes that were made to a Store
  * during a transaction in detail.
  *
- * This contains equivalent information to a TransactionChanges object, but also
+ * This contains equivalent information to a Changes object, but also
  * information about what the previous state of the Store was. The changedCells
  * and changedValues entries contain information about all changes to those
  * parts of the Store, with their before and after values, for example.
@@ -1374,34 +1399,25 @@ export type GetTransactionChanges = () => TransactionChanges;
  * of `cellsTouched` and `valuesTouched` in the listener will be `false` because
  * all changes have been reverted.
  *
- * See the documentation for the types of the inner objects for other details.
- * @category Transaction
- * @since v4.0.0
- */
-export type TransactionLog = {
-  cellsTouched: boolean;
-  valuesTouched: boolean;
-  changedCells: ChangedCells;
-  invalidCells: InvalidCells;
-  changedValues: ChangedValues;
-  invalidValues: InvalidValues;
-  changedTableIds: ChangedTableIds;
-  changedRowIds: ChangedRowIds;
-  changedCellIds: ChangedCellIds;
-  changedValueIds: ChangedValueIds;
-};
-
-/**
- * The GetTransactionLog type describes a function that returns the changes that
- * were made to a Store during a transaction in detail.
+ * In v5.0, this type changed from an object to an array, but still contains the
+ * same values.
  *
- * It is provided to the DoRollback callback and to a TransactionListener
- * listener when a transaction completes. See the TransactionLog type for more
- * information.
+ * See the documentation for the types of the inner objects for other details.
  * @category Transaction
  * @since v4.0.0
  */
-export type GetTransactionLog = () => TransactionLog;
+export type TransactionLog = [
+  cellsTouched: boolean,
+  valuesTouched: boolean,
+  changedCells: ChangedCells,
+  invalidCells: InvalidCells,
+  changedValues: ChangedValues,
+  invalidValues: InvalidValues,
+  changedTableIds: ChangedTableIds,
+  changedRowIds: ChangedRowIds,
+  changedCellIds: ChangedCellIds,
+  changedValueIds: ChangedValueIds,
+];
 
 /**
  * The StoreListenerStats type describes the number of listeners registered with
@@ -1736,7 +1752,7 @@ export interface Store {
    * @category Getter
    * @since v4.0.0
    */
-  getContent(): [Tables, Values];
+  getContent(): Content;
 
   /**
    * The getTables method returns a Tables object containing the entire tabular
@@ -2657,7 +2673,7 @@ export interface Store {
    * @category Setter
    * @since v4.0.0
    */
-  setContent([tables, values]: [Tables, Values]): Store;
+  setContent(content: Content): this;
 
   /**
    * The setTables method takes an object and sets the entire tabular data of
@@ -2705,7 +2721,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 +2771,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 +2820,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 +2932,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 +2989,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 +3036,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 +3085,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,28 +3138,29 @@ 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
-   * Store.
+   * The applyChanges method applies a set of Changes to the Store.
    *
-   * This method will take a TransactionChanges object (which is available at
-   * the end of a transaction) and apply it to a Store. The most likely need to
-   * do this is to take the changes made during the transaction of one Store,
-   * and apply it to the content of _another_ Store - such as when persisting
-   * and synchronizing data.
+   * This method will take a Changes object (which is available at the end of a
+   * transaction) and apply it to a Store. The most likely need to do this is to
+   * take the changes made during the transaction of one Store, and apply it to
+   * the content of _another_ Store - such as when persisting and synchronizing
+   * data.
    *
-   * Any part of the provided TransactionChanges object are invalid (either
-   * because of its type, or because it does not match the schemas associated
-   * with the Store) will be ignored silently.
+   * Any part of the provided Changes object are invalid (either because of its
+   * type, or because it does not match the schemas associated with the Store)
+   * will be ignored silently.
    *
    * The method returns a reference to the Store so that subsequent operations
    * can be chained in a fluent style.
-   * @param transactionChanges The TransactionChanges to apply to the Store.
+   *
+   * Prior to v5.0, this method was named `setTransactionChanges`.
+   * @param changes The Changes to apply to the Store.
    * @returns A reference to the Store.
    * @example
-   * This example applies a TransactionChanges object that sets a Cell and
+   * This example applies a Changes object that sets a Cell and
    * removes a Value.
    *
    * ```js
@@ -3151,19 +3168,16 @@ export interface Store {
    *   .setTables({pets: {fido: {species: 'dog', color: 'brown'}}})
    *   .setValues({open: true});
    *
-   * store.setTransactionChanges([
-   *   {pets: {fido: {color: 'black'}}},
-   *   {open: null},
-   * ]);
+   * store.applyChanges([{pets: {fido: {color: 'black'}}}, {open: null}]);
    * console.log(store.getTables());
    * // -> {pets: {fido: {species: 'dog', color: 'black'}}}
    * console.log(store.getValues());
    * // -> {}
    * ```
    * @category Setter
-   * @since v4.0.0
+   * @since v5.0.0
    */
-  setTransactionChanges(transactionChanges: TransactionChanges): Store;
+  applyChanges(changes: Changes): this;
 
   /**
    * The setTablesJson method takes a string serialization of all of the Tables
@@ -3197,7 +3211,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 +3245,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 +3303,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 +3335,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 +3364,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 +3422,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 +3439,7 @@ export interface Store {
    * ```
    * @category Deleter
    */
-  delTables(): Store;
+  delTables(): this;
 
   /**
    * The delTable method lets you remove a single Table from the Store.
@@ -3446,7 +3460,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 +3483,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 +3566,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 +3604,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 +3643,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 +3661,7 @@ export interface Store {
    * ```
    * @category Deleter
    */
-  delTablesSchema(): Store;
+  delTablesSchema(): this;
 
   /**
    * The delValuesSchema method lets you remove the ValuesSchema of the Store.
@@ -3666,7 +3680,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 +3706,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
@@ -3718,10 +3732,7 @@ export interface Store {
    *
    * The second, optional parameter, `doRollback` is a DoRollback callback that
    * you can use to rollback the transaction if it did not complete to your
-   * satisfaction. It is called with `getTransactionChanges` and
-   * `getTransactionLog` parameters, which inform you of the net changes that
-   * have been made during the transaction, at different levels of detail. See
-   * the DoRollback documentation for more details.
+   * satisfaction. See the DoRollback documentation for more details.
    * @param actions The function to be executed as a transaction.
    * @param doRollback An optional callback that should return `true` if you
    * want to rollback the transaction at the end. Since v1.2.
@@ -3797,9 +3808,9 @@ export interface Store {
    *       .setCell('pets', 'fido', 'info', {sold: null})
    *       .setValue('open', false)
    *       .setValue('employees', ['alice', 'bob']),
-   *   (_, getTransactionLog) => {
-   *     const {changedCells, invalidCells, changedValues, invalidValues} =
-   *       getTransactionLog();
+   *   () => {
+   *     const [, , changedCells, invalidCells, changedValues, invalidValues] =
+   *       store.getTransactionLog();
    *     console.log(store.getTables());
    *     console.log(changedCells);
    *     console.log(invalidCells);
@@ -3871,7 +3882,82 @@ export interface Store {
    * @category Transaction
    * @since v1.3.0
    */
-  startTransaction(): Store;
+  startTransaction(): this;
+
+  /**
+   * The getTransactionChanges method returns the net meaningful changes that
+   * have been made to a Store during a transaction.
+   *
+   * This is useful for deciding whether to rollback a transaction, for example.
+   * The returned object is only meaningful if the method is called when the
+   * Store is in a transaction - such as in a TransactionListener.
+   * @example
+   * This example makes changes to the Store. At the end of the transaction,
+   * detail about what changed is enumerated.
+   *
+   * ```js
+   * const store = createStore()
+   *   .setTables({pets: {fido: {species: 'dog', color: 'brown'}}})
+   *   .setValues({open: true});
+   *
+   * store
+   *   .startTransaction()
+   *   .setCell('pets', 'fido', 'color', 'black')
+   *   .setValue('open', false)
+   *   .finishTransaction(() => {
+   *     const [changedCells, changedValues] = store.getTransactionChanges();
+   *     console.log(changedCells);
+   *     console.log(changedValues);
+   *   });
+   * // -> {pets: {fido: {color: 'black'}}}
+   * // -> {open: false}
+   * ```
+   * @category Transaction
+   * @since v5.0.0
+   */
+  getTransactionChanges(): Changes;
+
+  /**
+   * The getTransactionLog method returns the changes that were made to a Store
+   * during a transaction in more detail, including invalid changes, and what
+   * previous values were.
+   *
+   * This is useful for deciding whether to rollback a transaction, for example.
+   * The returned object is only meaningful if the method is called when the
+   * Store is in a transaction - such as in a TransactionListener.
+   * @example
+   * This example makes changes to the Store. At the end of the transaction,
+   * detail about what changed is enumerated.
+   *
+   * ```js
+   * const store = createStore()
+   *   .setTables({pets: {fido: {species: 'dog', color: 'brown'}}})
+   *   .setValues({open: true});
+   *
+   * store
+   *   .startTransaction()
+   *   .setCell('pets', 'fido', 'color', 'black')
+   *   .setCell('pets', 'fido', 'eyes', ['left', 'right'])
+   *   .setCell('pets', 'fido', 'info', {sold: null})
+   *   .setValue('open', false)
+   *   .setValue('employees', ['alice', 'bob'])
+   *   .finishTransaction(() => {
+   *     const [, , changedCells, invalidCells, changedValues, invalidValues] =
+   *       store.getTransactionLog();
+   *     console.log(changedCells);
+   *     console.log(invalidCells);
+   *     console.log(changedValues);
+   *     console.log(invalidValues);
+   *   });
+   * // -> {pets: {fido: {color: ['brown', 'black']}}}
+   * // -> {pets: {fido: {eyes: [['left', 'right']], info: [{sold: null}]}}}
+   * // -> {open: [true, false]}
+   * // -> {employees: [['alice', 'bob']]}
+   * ```
+   * @category Transaction
+   * @since v5.0.0
+   */
+  getTransactionLog(): TransactionLog;
 
   /**
    * The finishTransaction method allows you to explicitly finish a transaction
@@ -3944,9 +4030,9 @@ export interface Store {
    *   .setCell('pets', 'fido', 'info', {sold: null})
    *   .setValue('open', false)
    *   .setValue('employees', ['alice', 'bob'])
-   *   .finishTransaction((_, getTransactionLog) => {
-   *     const {changedCells, invalidCells, changedValues, invalidValues} =
-   *       getTransactionLog();
+   *   .finishTransaction(() => {
+   *     const [, , changedCells, invalidCells, changedValues, invalidValues] =
+   *       store.getTransactionLog();
    *     console.log(store.getTables());
    *     console.log(changedCells);
    *     console.log(invalidCells);
@@ -3968,7 +4054,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 +4265,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 +4331,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 +4393,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 +4492,7 @@ export interface Store {
    */
   addHasTableListener(
     tableId: IdOrNull,
-    listener: HasTableListener,
+    listener: HasTableListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -4499,7 +4588,7 @@ export interface Store {
    */
   addTableListener(
     tableId: IdOrNull,
-    listener: TableListener,
+    listener: TableListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -4603,7 +4692,7 @@ export interface Store {
    */
   addTableCellIdsListener(
     tableId: IdOrNull,
-    listener: TableCellIdsListener,
+    listener: TableCellIdsListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -4722,7 +4811,7 @@ export interface Store {
   addHasTableCellListener(
     tableId: IdOrNull,
     cellId: IdOrNull,
-    listener: HasTableCellListener,
+    listener: HasTableCellListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -4815,7 +4904,7 @@ export interface Store {
    */
   addRowCountListener(
     tableId: IdOrNull,
-    listener: RowCountListener,
+    listener: RowCountListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -4906,7 +4995,7 @@ export interface Store {
    */
   addRowIdsListener(
     tableId: IdOrNull,
-    listener: RowIdsListener,
+    listener: RowIdsListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -5131,7 +5220,7 @@ export interface Store {
     descending: boolean,
     offset: number,
     limit: number | undefined,
-    listener: SortedRowIdsListener,
+    listener: SortedRowIdsListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -5248,7 +5337,7 @@ export interface Store {
   addHasRowListener(
     tableId: IdOrNull,
     rowId: IdOrNull,
-    listener: HasRowListener,
+    listener: HasRowListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -5357,7 +5446,7 @@ export interface Store {
   addRowListener(
     tableId: IdOrNull,
     rowId: IdOrNull,
-    listener: RowListener,
+    listener: RowListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -5462,7 +5551,7 @@ export interface Store {
   addCellIdsListener(
     tableId: IdOrNull,
     rowId: IdOrNull,
-    listener: CellIdsListener,
+    listener: CellIdsListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -5586,7 +5675,7 @@ export interface Store {
     tableId: IdOrNull,
     rowId: IdOrNull,
     cellId: IdOrNull,
-    listener: HasCellListener,
+    listener: HasCellListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -5705,7 +5794,7 @@ export interface Store {
     tableId: IdOrNull,
     rowId: IdOrNull,
     cellId: IdOrNull,
-    listener: CellListener,
+    listener: CellListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -5770,7 +5859,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 +5922,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 +5985,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 +6078,7 @@ export interface Store {
    */
   addHasValueListener(
     valueId: IdOrNull,
-    listener: HasValueListener,
+    listener: HasValueListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -6078,7 +6170,7 @@ export interface Store {
    */
   addValueListener(
     valueId: IdOrNull,
-    listener: ValueListener,
+    listener: ValueListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -6308,7 +6400,7 @@ export interface Store {
     tableId: IdOrNull,
     rowId: IdOrNull,
     cellId: IdOrNull,
-    listener: InvalidCellListener,
+    listener: InvalidCellListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -6483,7 +6575,7 @@ export interface Store {
    */
   addInvalidValueListener(
     valueId: IdOrNull,
-    listener: InvalidValueListener,
+    listener: InvalidValueListener<this>,
     mutator?: boolean,
   ): Id;
 
@@ -6531,7 +6623,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
@@ -6572,12 +6664,10 @@ export interface Store {
    *     pets: {fido: {species: 'dog', color: 'brown'}},
    *   })
    *   .setValues({open: true, employees: 3});
-   * const listenerId = store.addWillFinishTransactionListener(
-   *   (store, _, getTransactionLog) => {
-   *     const {cellsTouched, valuesTouched} = getTransactionLog?.() ?? {};
-   *     console.log(`Cells/Values touched: ${cellsTouched}/${valuesTouched}`);
-   *   },
-   * );
+   * const listenerId = store.addWillFinishTransactionListener((store) => {
+   *   const [cellsTouched, valuesTouched] = store.getTransactionLog() ?? {};
+   *   console.log(`Cells/Values touched: ${cellsTouched}/${valuesTouched}`);
+   * });
    * const listenerId2 = store.addTablesListener(() =>
    *   console.log('Tables changed'),
    * );
@@ -6619,7 +6709,7 @@ export interface Store {
    * // Transaction was rolled back.
    *
    * store.callListener(listenerId);
-   * // -> 'Cells/Values touched: undefined/undefined'
+   * // -> 'Cells/Values touched: false/false'
    * // It is meaningless to call this listener directly.
    *
    * store
@@ -6630,7 +6720,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
@@ -6670,12 +6760,10 @@ export interface Store {
    *     pets: {fido: {species: 'dog', color: 'brown'}},
    *   })
    *   .setValues({open: true, employees: 3});
-   * const listenerId = store.addDidFinishTransactionListener(
-   *   (store, _, getTransactionLog) => {
-   *     const {cellsTouched, valuesTouched} = getTransactionLog?.() ?? {};
-   *     console.log(`Cells/Values touched: ${cellsTouched}/${valuesTouched}`);
-   *   },
-   * );
+   * const listenerId = store.addDidFinishTransactionListener((store) => {
+   *   const [cellsTouched, valuesTouched] = store.getTransactionLog() ?? {};
+   *   console.log(`Cells/Values touched: ${cellsTouched}/${valuesTouched}`);
+   * });
    * const listenerId2 = store.addTablesListener(() =>
    *   console.log('Tables changed'),
    * );
@@ -6717,7 +6805,7 @@ export interface Store {
    * // Transaction was rolled back.
    *
    * store.callListener(listenerId);
-   * // -> 'Cells/Values touched: undefined/undefined'
+   * // -> 'Cells/Values touched: false/false'
    * // It is meaningless to call this listener directly.
    *
    * store
@@ -6728,7 +6816,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 +6932,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 +6964,7 @@ export interface Store {
    * ```
    * @category Listener
    */
-  delListener(listenerId: Id): Store;
+  delListener(listenerId: Id): this;
 
   /**
    * The getListenerStats method provides a set of statistics about the