tinybase 1.3.4 → 2.0.0-beta.1

package/lib/debug/store.d.ts

@@ -94,7 +94,7 @@ export type Cell = string | number | boolean;
  *
  * This is used when describing a Cell that is present _or_ that is not present
  * - such as when it has been deleted, or when describing a previous state where
- * the Cell value has since been added.
+ *   the Cell value has since been added.
  *
  * @category Store
  */
@@ -327,7 +327,6 @@ export type RowListener = (
  * @param store A reference to the Store that changed.
  * @param tableId The Id of the Table that changed.
  * @param rowId The Id of the Row that changed.
- * changes.
  * @category Listener
  */
 export type CellIdsListener = (store: Store, tableId: Id, rowId: Id) => void;
@@ -390,6 +389,7 @@ export type CellListener = (
  * @param cellId The Id of the Cell that was being changed.
  * @param invalidCells An array of the values of the Cell that were invalid.
  * @category Listener
+ * @since v1.1.0
  */
 export type InvalidCellListener = (
   store: Store,
@@ -420,9 +420,9 @@ export type GetCellChange = (tableId: Id, rowId: Id, cellId: Id) => CellChange;
  * The CellChange type describes a Cell's changes during a transaction.
  *
  * This is returned by the GetCellChange function that is provided to every
- * listener when called. This array contains the previous value of a Cell
- * before the current transaction, the new value after it, and a convenience
- * flag that indicates that the value has changed.
+ * listener when called. This array contains the previous value of a Cell before
+ * the current transaction, the new value after it, and a convenience flag that
+ * indicates that the value has changed.
  *
  * @category Listener
  */
@@ -521,6 +521,7 @@ export type CellSchema =
  * different value and then changed back.
  *
  * @category Transaction
+ * @since v1.2.0
  */
 export type ChangedCells = {
   [tableId: Id]: {
@@ -538,11 +539,12 @@ export type ChangedCells = {
  * the transaction method. See that method for specific examples.
  *
  * This type is a nested structure of Table, Row, and Cell objects, much like
- * the Tables object, but one for which Cell values are listed in array
- * (much like the InvalidCellListener type) so that multiple failed attempts to
- * change a Cell during the transaction are described.
+ * the Tables object, but one for which Cell values are listed in array (much
+ * like the InvalidCellListener type) so that multiple failed attempts to change
+ * a Cell during the transaction are described.
  *
  * @category Transaction
+ * @since v1.2.0
  */
 export type InvalidCells = {
   [tableId: Id]: {
@@ -791,9 +793,9 @@ export interface Store {
    * The getTableIds method returns the Ids of every Table in the Store.
    *
    * Note that this returns a copy of, rather than a reference, to the list of
-   * Ids, so changes made to the list are not made to the Store itself. Although
-   * the order of Ids have no meaning, this method is expected to return them in
-   * the order in which each Table was added.
+   * Ids, so changes made to the list are not made to the Store itself. Since
+   * v2.0.0, the order is significant: this method will return the Ids in the
+   * order in which each Table was added.
    *
    * @returns An array of the Ids of every Table in the Store.
    * @example
@@ -858,9 +860,9 @@ export interface Store {
    * The getRowIds method returns the Ids of every Row in a given Table.
    *
    * Note that this returns a copy of, rather than a reference, to the list of
-   * Ids, so changes made to the list are not made to the Store itself. Although
-   * the order of Ids have no meaning, this method is expected to return them in
-   * the order in which each Row was added.
+   * Ids, so changes made to the list are not made to the Store itself. Since
+   * v2.0.0, the order is significant: this method will return the Ids in the
+   * order in which each Row was added.
    *
    * @param tableId The Id of the Table in the Store.
    * @returns An array of the Ids of every Row in the Table.
@@ -932,9 +934,9 @@ export interface Store {
    * given Table.
    *
    * Note that this returns a copy of, rather than a reference, to the list of
-   * Ids, so changes made to the list are not made to the Store itself. Although
-   * the order of Ids have no meaning, this method is expected to return them in
-   * the order in which each Row was added.
+   * Ids, so changes made to the list are not made to the Store itself. Since
+   * v2.0.0, the order is significant: this method will return the Ids in the
+   * order in which each Cell was added.
    *
    * @param tableId The Id of the Table in the Store.
    * @param rowId The Id of the Row in the Table.
@@ -965,17 +967,13 @@ export interface Store {
   getCellIds(tableId: Id, rowId: Id): Ids;
 
   /**
-   * The getCell method returns an object containing the value of a single Cell
-   * in a given Row, in a given Table.
-   *
-   * Note that this returns a copy of, rather than a reference to the underlying
-   * data, so changes made to the returned object are not made to the Store
-   * itself.
+   * The getCell method returns the value of a single Cell in a given Row, in a
+   * given Table.
    *
    * @param tableId The Id of the Table in the Store.
    * @param rowId The Id of the Row in the Table.
    * @param cellId The Id of the Cell in the Row.
-   * @returns The value of the Cell.
+   * @returns The value of the Cell, or `undefined`.
    * @example
    * This example retrieves a single Cell.
    *
@@ -1710,7 +1708,7 @@ export interface Store {
    *
    * @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.
+   * want to rollback the transaction at the end. Since v1.2.0.
    * @returns Whatever value the provided transaction function returns.
    * @example
    * This example makes changes to two Cells, first outside, and secondly
@@ -1846,6 +1844,7 @@ export interface Store {
    * // -> 'Fido changed'
    * ```
    * @category Transaction
+   * @since v1.3.0
    */
   startTransaction(): Store;
 
@@ -1923,6 +1922,7 @@ export interface Store {
    * // -> {pets: {fido: {species: 'dog', color: 'brown'}}}
    * ```
    * @category Transaction
+   * @since v1.3.0
    */
   finishTransaction(
     doRollback?: (
@@ -2095,12 +2095,19 @@ export interface Store {
    * The addTableIdsListener method registers a listener function with the Store
    * that will be called whenever the Table Ids in the Store change.
    *
-   * Such a listener is only called when a Table is added or removed. To listen
-   * to all changes in the Store, use the addTablesListener method.
-   *
    * The provided listener is a TableIdsListener function, and will be called
    * with a reference to the Store.
    *
+   * By default, such a listener is only called when a Table is added or
+   * removed. To listen to all changes in the Store, use the addTablesListener
+   * method.
+   *
+   * Since v2.0.0, you can use the optional `trackReorder` parameter to
+   * additionally track when the set of Ids has not changed, but the order has -
+   * for example when a Table from the middle of the Store is removed and then
+   * added back within the same transaction. This behavior is disabled by
+   * default due to the potential performance cost of detecting such changes.
+   *
    * Use the optional mutator parameter to indicate that there is code in the
    * listener that will mutate Store data. If set to `false` (or omitted), such
    * mutations will be silently ignored. All relevant mutator listeners (with
@@ -2111,6 +2118,9 @@ export interface Store {
    *
    * @param listener The function that will be called whenever the Table Ids in
    * the Store change.
+   * @param trackReorder An optional boolean that indicates that the listener
+   * should be called if the set of Ids remains the same but their order
+   * changes.
    * @param mutator An optional boolean that indicates that the listener mutates
    * Store data.
    * @returns A unique Id for the listener that can later be used to call it
@@ -2140,7 +2150,8 @@ export interface Store {
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const listenerId = store.addTableIdsListener(
    *   (store) => store.setCell('meta', 'update', 'store', true),
-   *   true,
+   *   false, // track reorder
+   *   true, // mutator
    * );
    *
    * store.setTable('species', {dog: {price: 5}});
@@ -2151,21 +2162,25 @@ export interface Store {
    * ```
    * @category Listener
    */
-  addTableIdsListener(listener: TableIdsListener, mutator?: boolean): Id;
+  addTableIdsListener(
+    listener: TableIdsListener,
+    trackReorder?: boolean,
+    mutator?: boolean,
+  ): Id;
 
   /**
    * The addTableListener method registers a listener function with the Store
    * that will be called whenever data in a Table changes.
    *
-   * You can either listen to a single Table (by specifying its Id as the
-   * method's first parameter) or changes to any Table (by providing a `null`
-   * wildcard).
-   *
    * The provided listener is a TableListener function, and will be called with
    * a reference to the Store, the Id of the Table that changed, and a
    * GetCellChange function in case you need to inspect any changes that
    * occurred.
    *
+   * You can either listen to a single Table (by specifying its Id as the
+   * method's first parameter) or changes to any Table (by providing a `null`
+   * wildcard).
+   *
    * Use the optional mutator parameter to indicate that there is code in the
    * listener that will mutate Store data. If set to `false` (or omitted), such
    * mutations will be silently ignored. All relevant mutator listeners (with
@@ -2254,14 +2269,21 @@ export interface Store {
    * The addRowIdsListener method registers a listener function with the Store
    * that will be called whenever the Row Ids in a Table change.
    *
-   * Such a listener is only called when a Row is added or removed. To listen to
-   * all changes in the Table, use the addTableListener method.
+   * The provided listener is a RowIdsListener function, and will be called with
+   * a reference to the Store and the Id of the Table that changed.
+   *
+   * By default, such a listener is only called when a Row is added or removed.
+   * To listen to all changes in the Table, use the addTableListener method.
    *
    * You can either listen to a single Table (by specifying its Id as the
-   * method's first parameter) or changes to any Table (by providing `null`).
+   * method's first parameter) or changes to any Table (by providing a `null`
+   * wildcard).
    *
-   * The provided listener is a RowIdsListener function, and will be called with
-   * a reference to the Store and the Id of the Table that changed.
+   * Since v2.0.0, you can use the optional `trackReorder` parameter to
+   * additionally track when the set of Ids has not changed, but the order has -
+   * for example when a Row from the middle of the Table is removed and then
+   * added back within the same transaction. This behavior is disabled by
+   * default due to the potential performance cost of detecting such changes.
    *
    * Use the optional mutator parameter to indicate that there is code in the
    * listener that will mutate Store data. If set to `false` (or omitted), such
@@ -2274,6 +2296,9 @@ export interface Store {
    * @param tableId The Id of the Table to listen to, or `null` as a wildcard.
    * @param listener The function that will be called whenever the Row Ids in
    * the Table change.
+   * @param trackReorder An optional boolean that indicates that the listener
+   * should be called if the set of Ids remains the same but their order
+   * changes.
    * @param mutator An optional boolean that indicates that the listener mutates
    * Store data.
    * @returns A unique Id for the listener that can later be used to call it
@@ -2296,6 +2321,36 @@ export interface Store {
    * store.delListener(listenerId);
    * ```
    * @example
+   * This example registers a listener that responds to a change of order in the
+   * rows of a specific Table, even though the set of Ids themselves has not
+   * changed.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {
+   *     fido: {species: 'dog'},
+   *     felix: {species: 'cat'},
+   *   },
+   * });
+   * const listenerId = store.addRowIdsListener(
+   *   'pets',
+   *   (store) => {
+   *     console.log('Row Ids or order for pets table changed');
+   *     console.log(store.getRowIds('pets'));
+   *   },
+   *   true, // track reorder
+   * );
+   *
+   * store.transaction(() => {
+   *   store.delRow('pets', 'fido');
+   *   store.setRow('pets', 'fido', {species: 'dog'});
+   * });
+   * // -> 'Row Ids or order for pets table changed'
+   * // -> ['felix', 'fido']
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @example
    * This example registers a listener that responds to any change to the Row
    * Ids of any Table.
    *
@@ -2324,7 +2379,8 @@ export interface Store {
    * const listenerId = store.addRowIdsListener(
    *   'pets',
    *   (store, tableId) => store.setCell('meta', 'update', tableId, true),
-   *   true,
+   *   false, // track reorder
+   *   true, // mutator
    * );
    *
    * store.setRow('pets', 'felix', {species: 'cat'});
@@ -2338,6 +2394,7 @@ export interface Store {
   addRowIdsListener(
     tableId: IdOrNull,
     listener: RowIdsListener,
+    trackReorder?: boolean,
     mutator?: boolean,
   ): Id;
 
@@ -2345,6 +2402,11 @@ export interface Store {
    * The addRowListener method registers a listener function with the Store that
    * will be called whenever data in a Row changes.
    *
+   * The provided listener is a RowListener function, and will be called with a
+   * reference to the Store, the Id of the Table that changed, the Id of the Row
+   * that changed, and a GetCellChange function in case you need to inspect any
+   * changes that occurred.
+   *
    * You can either listen to a single Row (by specifying the Table Id and Row
    * Id as the method's first two parameters) or changes to any Row (by
    * providing `null` wildcards).
@@ -2354,11 +2416,6 @@ export interface Store {
    * Table, any Row in a specific Table, a specific Row in any Table, or any Row
    * in any Table.
    *
-   * The provided listener is a RowListener function, and will be called with a
-   * reference to the Store, the Id of the Table that changed, the Id of the Row
-   * that changed, and a GetCellChange function in case you need to inspect any
-   * changes that occurred.
-   *
    * Use the optional mutator parameter to indicate that there is code in the
    * listener that will mutate Store data. If set to `false` (or omitted), such
    * mutations will be silently ignored. All relevant mutator listeners (with
@@ -2455,21 +2512,27 @@ export interface Store {
    * The addCellIdsListener method registers a listener function with the Store
    * that will be called whenever the Cell Ids in a Row change.
    *
-   * Such a listener is only called when a Cell is added or removed. To listen
-   * to all changes in the Row, use the addRowListener method.
+   * The provided listener is a CellIdsListener function, and will be called
+   * with a reference to the Store, the Id of the Table, and the Id of the Row
+   * that changed.
+   *
+   * By default, such a listener is only called when a Cell is added or removed.
+   * To listen to all changes in the Row, use the addRowListener method.
    *
    * You can either listen to a single Row (by specifying the Table Id and Row
    * Id as the method's first two parameters) or changes to any Row (by
-   * providing `null`).
+   * providing a `null` wildcard).
    *
    * Both, either, or neither of the `tableId` and `rowId` parameters can be
    * wildcarded with `null`. You can listen to a specific Row in a specific
    * Table, any Row in a specific Table, a specific Row in any Table, or any Row
    * in any Table.
    *
-   * The provided listener is a CellIdsListener function, and will be called
-   * with a reference to the Store, the Id of the Table, and the Id of the Row
-   * that changed.
+   * Since v2.0.0, you can use the optional `trackReorder` parameter to
+   * additionally track when the set of Ids has not changed, but the order has -
+   * for example when a Cell from the middle of the Row is removed and then
+   * added back within the same transaction. This behavior is disabled by
+   * default due to the potential performance cost of detecting such changes.
    *
    * Use the optional mutator parameter to indicate that there is code in the
    * listener that will mutate Store data. If set to `false` (or omitted), such
@@ -2483,6 +2546,9 @@ export interface Store {
    * @param rowId The Id of the Row to listen to, or `null` as a wildcard.
    * @param listener The function that will be called whenever the Cell Ids in
    * the Row change.
+   * @param trackReorder An optional boolean that indicates that the listener
+   * should be called if the set of Ids remains the same but their order
+   * changes.
    * @param mutator An optional boolean that indicates that the listener mutates
    * Store data.
    * @returns A unique Id for the listener that can later be used to call it
@@ -2539,7 +2605,8 @@ export interface Store {
    *   'fido',
    *   (store, tableId, rowId) =>
    *     store.setCell('meta', 'update', `${tableId}_${rowId}`, true),
-   *   true,
+   *   false, // track reorder
+   *   true, // mutator
    * );
    *
    * store.setCell('pets', 'fido', 'color', 'brown');
@@ -2554,6 +2621,7 @@ export interface Store {
     tableId: IdOrNull,
     rowId: IdOrNull,
     listener: CellIdsListener,
+    trackReorder?: boolean,
     mutator?: boolean,
   ): Id;
 
@@ -2561,6 +2629,12 @@ export interface Store {
    * The addCellListener method registers a listener function with the Store
    * that will be called whenever data in a Cell changes.
    *
+   * The provided listener is a CellListener function, and will be called with a
+   * reference to the Store, the Id of the Table that changed, the Id of the Row
+   * that changed, the Id of the Cell that changed, the new Cell value, the old
+   * Cell value, and a GetCellChange function in case you need to inspect any
+   * changes that occurred.
+   *
    * You can either listen to a single Cell (by specifying the Table Id, Row Id,
    * and Cell Id as the method's first three parameters) or changes to any Cell
    * (by providing `null` wildcards).
@@ -2570,12 +2644,6 @@ export interface Store {
    * Row in a specific Table, any Cell in any Row in any Table, for example - or
    * every other combination of wildcards.
    *
-   * The provided listener is a CellListener function, and will be called with a
-   * reference to the Store, the Id of the Table that changed, the Id of the Row
-   * that changed, the Id of the Cell that changed, the new Cell value, the old
-   * Cell value, and a GetCellChange function in case you need to inspect any
-   * changes that occurred.
-   *
    * Use the optional mutator parameter to indicate that there is code in the
    * listener that will mutate Store data. If set to `false` (or omitted), such
    * mutations will be silently ignored. All relevant mutator listeners (with
@@ -2682,6 +2750,14 @@ export interface Store {
    * Store that will be called whenever invalid data was attempted to be written
    * to a Cell.
    *
+   * The provided listener is an InvalidCellListener function, and will be
+   * called with a reference to the Store, the Id of the Table, the Id of the
+   * Row, and the Id of Cell that were being attempted to be changed. It is also
+   * given the invalid value of the Cell, which could have been of absolutely
+   * any type. Since there could have been multiple failed attempts to set the
+   * Cell within a single transaction, this is an array containing each attempt,
+   * chronologically.
+   *
    * You can either listen to a single Cell (by specifying the Table Id, Row Id,
    * and Cell Id as the method's first three parameters) or invalid attempts to
    * change any Cell (by providing `null` wildcards).
@@ -2691,14 +2767,6 @@ export interface Store {
    * Row in a specific Table, any Cell in any Row in any Table, for example - or
    * every other combination of wildcards.
    *
-   * The provided listener is an InvalidCellListener function, and will be
-   * called with a reference to the Store, the Id of the Table, the Id of the
-   * Row, and the Id of Cell that were being attempted to be changed. It is also
-   * given the invalid value of the Cell, which could have been of absolutely
-   * any type. Since there could have been multiple failed attempts to set the
-   * Cell within a single transaction, this is an array containing each attempt,
-   * chronologically.
-   *
    * Use the optional mutator parameter to indicate that there is code in the
    * listener that will mutate Store data. If set to `false` (or omitted), such
    * mutations will be silently ignored. All relevant mutator listeners (with
@@ -2897,6 +2965,7 @@ export interface Store {
    * store.delListener(listenerId);
    * ```
    * @category Listener
+   * @since v1.1.0
    */
   addInvalidCellListener(
     tableId: IdOrNull,
@@ -2971,6 +3040,7 @@ export interface Store {
    * store.delListener(listenerId).delListener(listenerId2);
    * ```
    * @category Listener
+   * @since v1.3.0
    */
   addWillFinishTransactionListener(listener: TransactionListener): Id;
 
@@ -3040,6 +3110,7 @@ export interface Store {
    * store.delListener(listenerId).delListener(listenerId2);
    * ```
    * @category Listener
+   * @since v1.3.0
    */
   addDidFinishTransactionListener(listener: TransactionListener): Id;