tinybase 4.0.0-beta.4 → 4.0.0-beta.5.1

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

@@ -9,7 +9,6 @@
  *
  * The components in this module provide a further abstraction over those hooks
  * to ease the composition of user interfaces that use TinyBase.
- *
  * @see Building UIs guides
  * @see Building UIs With Metrics guide
  * @see Building UIs With Indexes guide
@@ -37,6 +36,7 @@ import {
   SortedRowIdsListener,
   Store,
   Table,
+  TableCellIdsListener,
   TableIdsListener,
   TableListener,
   Tables,
@@ -85,7 +85,6 @@ import {Persister} from './persisters.d';
  *
  * Many hooks and components in this ui-react module take this type as a
  * parameter or a prop, allowing you to pass in either the Store or its Id.
- *
  * @category Identity
  */
 export type StoreOrStoreId = Store | Id;
@@ -104,7 +103,6 @@ export type StoreOrStoreId = Store | Id;
  *
  * Many hooks and components in this ui-react module take this type as a
  * parameter or a prop, allowing you to pass in either the Store or its Id.
- *
  * @category Identity
  */
 export type MetricsOrMetricsId = Metrics | Id;
@@ -123,7 +121,6 @@ export type MetricsOrMetricsId = Metrics | Id;
  *
  * Many hooks and components in this ui-react module take this type as a
  * parameter or a prop, allowing you to pass in either the Store or its Id.
- *
  * @category Identity
  */
 export type IndexesOrIndexesId = Indexes | Id;
@@ -142,7 +139,6 @@ export type IndexesOrIndexesId = Indexes | Id;
  *
  * Many hooks and components in this ui-react module take this type as a
  * parameter or a prop, allowing you to pass in either the Store or its Id.
- *
  * @category Identity
  */
 export type RelationshipsOrRelationshipsId = Relationships | Id;
@@ -161,9 +157,8 @@ export type RelationshipsOrRelationshipsId = Relationships | Id;
  *
  * Many hooks and components in this ui-react module take this type as a
  * parameter or a prop, allowing you to pass in either the Store or its Id.
- *
  * @category Identity
- * @since v2.0
+ * @since v2.0.0
  */
 export type QueriesOrQueriesId = Queries | Id;
 
@@ -181,7 +176,6 @@ export type QueriesOrQueriesId = Queries | Id;
  *
  * Many hooks and components in this ui-react module take this type as a
  * parameter or a prop, allowing you to pass in either the Store or its Id.
- *
  * @category Identity
  */
 export type CheckpointsOrCheckpointsId = Checkpoints | Id;
@@ -194,7 +188,6 @@ export type CheckpointsOrCheckpointsId = Checkpoints | Id;
  * This type is useful if you are building undo or redo buttons. See the
  * useUndoInformation hook and the useRedoInformation hook for more details and
  * examples.
- *
  * @category Checkpoints
  */
 export type UndoOrRedoInformation = [boolean, Callback, Id | undefined, string];
@@ -217,7 +210,6 @@ export type UndoOrRedoInformation = [boolean, Callback, Id | undefined, string];
  * should cause the Store to be recreated, you can provide them in an array in
  * the optional second parameter, just as you would for any React hook with
  * dependencies.
- *
  * @param create A function for performing the creation of the Store, plus any
  * additional steps such as adding data or listeners, and returning it.
  * @param createDeps An optional array of dependencies for the `create`
@@ -297,7 +289,6 @@ export function useCreateStore(
  * The useStore hook lets you either get a reference to the default Store (when
  * called without a parameter), or one of the Store objects that are named by Id
  * (when called with an Id parameter).
- *
  * @param id An optional Id for accessing a Store that was named with an Id in
  * the Provider.
  * @returns A reference to the Store (or `undefined` if not within a Provider
@@ -360,7 +351,6 @@ export function useStore(id?: Id): Store | undefined;
  * When first rendered, this hook will create a listener so that changes to the
  * Tables will cause a re-render. When the component containing this hook is
  * unmounted, the listener will be automatically removed.
- *
  * @param storeOrStoreId The Store to be accessed: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
  * reference.
@@ -437,7 +427,6 @@ export function useTables(storeOrStoreId?: StoreOrStoreId): Tables;
  * When first rendered, this hook will create a listener so that changes to the
  * Table Ids will cause a re-render. When the component containing this hook is
  * unmounted, the listener will be automatically removed.
- *
  * @param storeOrStoreId The Store to be accessed: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
  * reference.
@@ -514,7 +503,6 @@ export function useTableIds(storeOrStoreId?: StoreOrStoreId): Ids;
  * When first rendered, this hook will create a listener so that changes to the
  * Table will cause a re-render. When the component containing this hook is
  * unmounted, the listener will be automatically removed.
- *
  * @param tableId The Id of the Table in the Store.
  * @param storeOrStoreId The Store to be accessed: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
@@ -580,6 +568,91 @@ export function useTableIds(storeOrStoreId?: StoreOrStoreId): Ids;
  */
 export function useTable(tableId: Id, storeOrStoreId?: StoreOrStoreId): Table;
 
+/**
+ * The useTableCellIds hook returns the Ids of every Cell used across the whole
+ * Table, and registers a listener so that any changes to that result will cause
+ * a re-render.
+ *
+ * A Provider component is used to wrap part of an application in a context, and
+ * it can contain a default Store or a set of Store objects named by Id. The
+ * useTableCellIds hook lets you indicate which Store to get data for: omit the
+ * optional final parameter for the default context Store, provide an Id for a
+ * named context Store, or provide a Store explicitly by reference.
+ *
+ * When first rendered, this hook will create a listener so that changes to the
+ * Table Cell Ids will cause a re-render. When the component containing this
+ * hook is unmounted, the listener will be automatically removed.
+ * @param tableId The Id of the Table in the Store.
+ * @param storeOrStoreId The Store to be accessed: omit for the default context
+ * Store, provide an Id for a named context Store, or provide an explicit
+ * reference.
+ * @returns An array of the Ids of every Cell used across the whole Table.
+ * @example
+ * This example creates a Store outside the application, which is used in the
+ * useTableCellIds hook by reference. A change to the data in the Store
+ * re-renders the component.
+ *
+ * ```jsx
+ * const store = createStore().setCell('pets', 'fido', 'color', 'brown');
+ * const App = () => (
+ *   <span>{JSON.stringify(useTableCellIds('pets', store))}</span>
+ * );
+ *
+ * const app = document.createElement('div');
+ * ReactDOMClient.createRoot(app).render(<App />); // !act
+ * console.log(app.innerHTML);
+ * // -> '<span>["color"]</span>'
+ *
+ * store.setCell('pets', 'felix', 'species', 'cat'); // !act
+ * console.log(app.innerHTML);
+ * // -> '<span>["color","species"]</span>'
+ * ```
+ * @example
+ * This example creates a Provider context into which a default Store is
+ * provided. A component within it then uses the useTableCellIds hook.
+ *
+ * ```jsx
+ * const App = ({store}) => (
+ *   <Provider store={store}>
+ *     <Pane />
+ *   </Provider>
+ * );
+ * const Pane = () => <span>{JSON.stringify(useTableCellIds('pets'))}</span>;
+ *
+ * const store = createStore().setCell('pets', 'fido', 'color', 'brown');
+ * const app = document.createElement('div');
+ * ReactDOMClient.createRoot(app).render(<App store={store} />); // !act
+ * console.log(app.innerHTML);
+ * // -> '<span>["color"]</span>'
+ * ```
+ * @example
+ * This example creates a Provider context into which a Store is provided, named
+ * by Id. A component within it then uses the useTableCellIds hook.
+ *
+ * ```jsx
+ * const App = ({store}) => (
+ *   <Provider storesById={{petStore: store}}>
+ *     <Pane />
+ *   </Provider>
+ * );
+ * const Pane = () => (
+ *   <span>{JSON.stringify(useTableCellIds('pets', 'petStore'))}</span>
+ * );
+ *
+ * const store = createStore().setCell('pets', 'fido', 'color', 'brown');
+ * const app = document.createElement('div');
+ * ReactDOMClient.createRoot(app).render(<App store={store} />); // !act
+ * console.log(app.innerHTML);
+ * // -> '<span>["color"]</span>'
+ * ```
+ * @category Store hooks
+ * @since v3.3.0
+ */
+export function useTableCellIds(
+  tableId: Id,
+  storeOrStoreId?: StoreOrStoreId,
+): Ids;
+
 /**
  * The useRowIds hook returns the Ids of every Row in a given Table, and
  * registers a listener so that any changes to that result will cause a
@@ -594,7 +667,6 @@ export function useTable(tableId: Id, storeOrStoreId?: StoreOrStoreId): Table;
  * When first rendered, this hook will create a listener so that changes to the
  * Row Ids will cause a re-render. When the component containing this hook is
  * unmounted, the listener will be automatically removed.
- *
  * @param tableId The Id of the Table in the Store.
  * @param storeOrStoreId The Store to be accessed: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
@@ -674,7 +746,6 @@ export function useRowIds(tableId: Id, storeOrStoreId?: StoreOrStoreId): Ids;
  * When first rendered, this hook will create a listener so that changes to the
  * sorted Row Ids will cause a re-render. When the component containing this
  * hook is unmounted, the listener will be automatically removed.
- *
  * @param tableId The Id of the Table in the Store.
  * @param cellId The Id of the Cell whose values are used for the sorting, or
  * `undefined` to by sort the Row Id itself.
@@ -767,7 +838,7 @@ export function useRowIds(tableId: Id, storeOrStoreId?: StoreOrStoreId): Ids;
  * // -> '<span>["felix","fido"]</span>'
  * ```
  * @category Store hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useSortedRowIds(
   tableId: Id,
@@ -792,7 +863,6 @@ export function useSortedRowIds(
  * When first rendered, this hook will create a listener so that changes to the
  * Row will cause a re-render. When the component containing this hook is
  * unmounted, the listener will be automatically removed.
- *
  * @param tableId The Id of the Table in the Store.
  * @param rowId The Id of the Row in the Table.
  * @param storeOrStoreId The Store to be accessed: omit for the default context
@@ -879,7 +949,6 @@ export function useRow(
  * When first rendered, this hook will create a listener so that changes to the
  * Cell Ids will cause a re-render. When the component containing this hook is
  * unmounted, the listener will be automatically removed.
- *
  * @param tableId The Id of the Table in the Store.
  * @param rowId The Id of the Row in the Table.
  * @param storeOrStoreId The Store to be accessed: omit for the default context
@@ -968,7 +1037,6 @@ export function useCellIds(
  * When first rendered, this hook will create a listener so that changes to the
  * Cell will cause a re-render. When the component containing this hook is
  * unmounted, the listener will be automatically removed.
- *
  * @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.
@@ -1055,7 +1123,6 @@ export function useCell(
  * When first rendered, this hook will create a listener so that changes to the
  * Values will cause a re-render. When the component containing this hook is
  * unmounted, the listener will be automatically removed.
- *
  * @param storeOrStoreId The Store to be accessed: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
  * reference.
@@ -1115,7 +1182,7 @@ export function useCell(
  * // -> '<span>{"open":true}</span>'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
 export function useValues(storeOrStoreId?: StoreOrStoreId): Values;
 
@@ -1132,7 +1199,6 @@ export function useValues(storeOrStoreId?: StoreOrStoreId): Values;
  * When first rendered, this hook will create a listener so that changes to the
  * Value Ids will cause a re-render. When the component containing this hook is
  * unmounted, the listener will be automatically removed.
- *
  * @param storeOrStoreId The Store to be accessed: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
  * reference.
@@ -1192,7 +1258,7 @@ export function useValues(storeOrStoreId?: StoreOrStoreId): Values;
  * // -> '<span>["open"]</span>'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
 export function useValueIds(storeOrStoreId?: StoreOrStoreId): Ids;
 
@@ -1210,7 +1276,6 @@ export function useValueIds(storeOrStoreId?: StoreOrStoreId): Ids;
  * When first rendered, this hook will create a listener so that changes to the
  * Value will cause a re-render. When the component containing this hook is
  * unmounted, the listener will be automatically removed.
- *
  * @param valueId The Id of the Value in the Store.
  * @param storeOrStoreId The Store to be accessed: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
@@ -1273,7 +1338,7 @@ export function useValueIds(storeOrStoreId?: StoreOrStoreId): Ids;
  * // -> '<span>true</span>'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
 export function useValue(
   valueId: Id,
@@ -1304,7 +1369,6 @@ export function useValue(
  * The Store to which the callback will make the mutation (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- *
  * @param getTables A function which returns the Tables object that will be used
  * to update the Store, based on the parameter the callback will receive (and
  * which is most likely a DOM event).
@@ -1387,7 +1451,6 @@ export function useSetTablesCallback<Parameter>(
  * The Store to which the callback will make the mutation (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- *
  * @param tableId The Id of the Table in the Store to set.
  * @param getTable A function which returns the Table object that will be used
  * to update the Store, based on the parameter the callback will receive (and
@@ -1473,7 +1536,6 @@ export function useSetTableCallback<Parameter>(
  * The Store to which the callback will make the mutation (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- *
  * @param tableId The Id of the Table in the Store.
  * @param rowId The Id of the Row in the Table to set.
  * @param getRow A function which returns the Row object that will be used to
@@ -1569,7 +1631,6 @@ export function useSetRowCallback<Parameter>(
  * specify `reuseRowIds` to be `false`, then the Id will be a monotonically
  * increasing string representation of an increasing integer, regardless of any
  * you may have previously deleted.
- *
  * @param tableId The Id of the Table in the Store.
  * @param getRow A function which returns the Row object that will be used to
  * update the Store, based on the parameter the callback will receive (and which
@@ -1587,7 +1648,6 @@ export function useSetRowCallback<Parameter>(
  * parameter defaults to an empty array.
  * @param reuseRowIds Whether Ids should be recycled from previously deleted Row
  * objects, defaulting to `true`.
- *
  * @returns A parameterized callback for subsequent use.
  * @example
  * This example uses the useAddRowCallback hook to create an event handler which
@@ -1660,7 +1720,6 @@ export function useAddRowCallback<Parameter>(
  * The Store to which the callback will make the mutation (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- *
  * @param tableId The Id of the Table in the Store.
  * @param rowId The Id of the Row in the Table to set.
  * @param getPartialRow A function which returns the partial Row object that
@@ -1750,7 +1809,6 @@ export function useSetPartialRowCallback<Parameter>(
  * The Store to which the callback will make the mutation (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- *
  * @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 to set.
@@ -1879,7 +1937,6 @@ export function useSetCellCallback<Parameter>(
  * The Store to which the callback will make the mutation (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- *
  * @param getValues A function which returns the Values object that will be used
  * to update the Store, based on the parameter the callback will receive (and
  * which is most likely a DOM event).
@@ -1929,7 +1986,7 @@ export function useSetCellCallback<Parameter>(
  * // -> '{"bubbles":true}'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
 export function useSetValuesCallback<Parameter>(
   getValues: (parameter: Parameter, store: Store) => Values,
@@ -1964,7 +2021,6 @@ export function useSetValuesCallback<Parameter>(
  * The Store to which the callback will make the mutation (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- *
  * @param getPartialValues A function which returns the partial Values object
  * that will be used to update the Store, based on the parameter the callback
  * will receive (and which is most likely a DOM event).
@@ -2015,7 +2071,7 @@ export function useSetValuesCallback<Parameter>(
  * // -> '{"open":true,"bubbles":true}'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
 export function useSetPartialValuesCallback<Parameter>(
   getPartialValues: (parameter: Parameter, store: Store) => Values,
@@ -2049,7 +2105,6 @@ export function useSetPartialValuesCallback<Parameter>(
  * The Store to which the callback will make the mutation (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- *
  * @param valueId The Id of the Value in the Store to set.
  * @param getValue A function which returns the Value object that will be used
  * to update the Store, based on the parameter the callback will receive (and
@@ -2101,7 +2156,7 @@ export function useSetPartialValuesCallback<Parameter>(
  * // -> '{"open":true,"bubbles":true}'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
 export function useSetValueCallback<Parameter>(
   valueId: Id,
@@ -2127,7 +2182,6 @@ export function useSetValueCallback<Parameter>(
  * The Store to which the callback will make the deletion (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- *
  * @param storeOrStoreId The Store to be updated: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
  * reference.
@@ -2190,7 +2244,6 @@ export function useDelTablesCallback(
  * The Store to which the callback will make the deletion (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- *
  * @param tableId The Id of the Table in the Store.
  * @param storeOrStoreId The Store to be updated: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
@@ -2255,7 +2308,6 @@ export function useDelTableCallback(
  * The Store to which the callback will make the deletion (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- *
  * @param tableId The Id of the Table in the Store.
  * @param rowId The Id of the Row in the Table.
  * @param storeOrStoreId The Store to be updated: omit for the default context
@@ -2322,7 +2374,6 @@ export function useDelRowCallback(
  * The Store to which the callback will make the deletion (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- *
  * @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.
@@ -2400,7 +2451,6 @@ export function useDelCellCallback(
  * The Store to which the callback will make the deletion (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- *
  * @param storeOrStoreId The Store to be updated: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
  * reference.
@@ -2441,7 +2491,7 @@ export function useDelCellCallback(
  * // -> '{}'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
 export function useDelValuesCallback(
   storeOrStoreId?: StoreOrStoreId,
@@ -2464,7 +2514,6 @@ export function useDelValuesCallback(
  * The Store to which the callback will make the deletion (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- *
  * @param valueId The Id of the Value in the Store.
  * @param storeOrStoreId The Store to be updated: omit for the default context
  * Store, provide an Id for a named context Store, or provide an explicit
@@ -2506,7 +2555,7 @@ export function useDelValuesCallback(
  * // -> '{"employees":3}'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
 export function useDelValueCallback(
   valueId: Id,
@@ -2527,7 +2576,6 @@ export function useDelValueCallback(
  * you to remove it manually, the useTablesListener hook manages this lifecycle
  * for you: when the listener changes (per its `listenerDeps` dependencies) or
  * the component unmounts, the listener on the underlying Store will be deleted.
- *
  * @param listener The function that will be called whenever tabular data in the
  * Store changes.
  * @param listenerDeps An optional array of dependencies for the `listener`
@@ -2590,7 +2638,6 @@ export function useTablesListener(
  * lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying Store
  * will be deleted.
- *
  * @param listener The function that will be called whenever the Table Ids in
  * the Store change.
  * @param listenerDeps An optional array of dependencies for the `listener`
@@ -2655,7 +2702,6 @@ export function useTableIdsListener(
  * you to remove it manually, the useTableListener hook manages this lifecycle
  * for you: when the listener changes (per its `listenerDeps` dependencies) or
  * the component unmounts, the listener on the underlying Store will be deleted.
- *
  * @param tableId The Id of the Table to listen to, or `null` as a wildcard.
  * @param listener The function that will be called whenever data in the Table
  * changes.
@@ -2707,6 +2753,74 @@ export function useTableListener(
   storeOrStoreId?: StoreOrStoreId,
 ): void;
 
+/**
+ * The useTableCellIdsListener hook registers a listener function with a Store
+ * that will be called whenever the Cell Ids that appear anywhere in a Table
+ * change.
+ *
+ * This hook is useful for situations where a component needs to register its
+ * own specific listener to do more than simply tracking the value (which is
+ * more easily done with the useTableCellIds hook).
+ *
+ * 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`).
+ *
+ * Unlike the addTableCellIdsListener method, which returns a listener Id and
+ * requires you to remove it manually, the useTableCellIdsListener hook manages
+ * this lifecycle for you: when the listener changes (per its `listenerDeps`
+ * dependencies) or the component unmounts, the listener on the underlying Store
+ * will be deleted.
+ * @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 Cell Ids that
+ * appear anywhere in a Table change.
+ * @param listenerDeps An optional array of dependencies for the `listener`
+ * function, which, if any change, result in the re-registration of the
+ * listener. This parameter defaults to an empty array.
+ * @param mutator An optional boolean that indicates that the listener mutates
+ * Store data.
+ * @param storeOrStoreId The Store to register the listener with: omit for the
+ * default context Store, provide an Id for a named context Store, or provide an
+ * explicit reference.
+ * @example
+ * This example uses the useTableCellIdsListener hook to create a listener that
+ * is scoped to a single component. When the component is unmounted, the
+ * listener is removed from the Store.
+ *
+ * ```jsx
+ * const App = ({store}) => (
+ *   <Provider store={store}>
+ *     <Pane />
+ *   </Provider>
+ * );
+ * const Pane = () => {
+ *   useTableCellIdsListener('pets', () => console.log('Cell Ids changed'));
+ *   return <span>App</span>;
+ * };
+ *
+ * const store = createStore().setTables({pets: {fido: {color: 'brown'}}});
+ * const app = document.createElement('div');
+ * const root = ReactDOMClient.createRoot(app);
+ * root.render(<App store={store} />); // !act
+ * console.log(store.getListenerStats().tableCellIds);
+ * // -> 1
+ *
+ * store.setRow('pets', 'felix', {species: 'cat'}); // !act
+ * // -> 'Cell Ids changed'
+ *
+ * root.unmount(); // !act
+ * console.log(store.getListenerStats().rowIds);
+ * // -> 0
+ * ```
+ * @category Store hooks
+ */
+export function useTableCellIdsListener(
+  tableId: IdOrNull,
+  listener: TableCellIdsListener,
+  listenerDeps?: React.DependencyList,
+  mutator?: boolean,
+  storeOrStoreId?: StoreOrStoreId,
+): void;
+
 /**
  * The useRowIdsListener hook registers a listener function with a Store that
  * will be called whenever the Row Ids in a Table change.
@@ -2722,7 +2836,6 @@ export function useTableListener(
  * you to remove it manually, the useRowIdsListener hook manages this lifecycle
  * for you: when the listener changes (per its `listenerDeps` dependencies) or
  * the component unmounts, the listener on the underlying Store will be deleted.
- *
  * @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.
@@ -2788,7 +2901,6 @@ export function useRowIdsListener(
  * this lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying Store
  * will be deleted.
- *
  * @param tableId The Id of the Table in the Store.
  * @param cellId The Id of the Cell whose values are used for the sorting, or
  * `undefined` to by sort the Row Id itself.
@@ -2843,7 +2955,7 @@ export function useRowIdsListener(
  * // -> 0
  * ```
  * @category Store hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useSortedRowIdsListener(
   tableId: Id,
@@ -2878,7 +2990,6 @@ export function useSortedRowIdsListener(
  * you to remove it manually, the useRowListener hook manages this lifecycle for
  * you: when the listener changes (per its `listenerDeps` dependencies) or the
  * component unmounts, the listener on the underlying Store will be deleted.
- *
  * @param tableId The Id of the Table to listen to, or `null` as a wildcard.
  * @param rowId The Id of the Row to listen to, or `null` as a wildcard.
  * @param listener The function that will be called whenever data in the Row
@@ -2954,7 +3065,6 @@ export function useRowListener(
  * lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying Store
  * will be deleted.
- *
  * @param tableId The Id of the Table to listen to, or `null` as a wildcard.
  * @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
@@ -3031,7 +3141,6 @@ export function useCellIdsListener(
  * you to remove it manually, the useCellListener hook manages this lifecycle
  * for you: when the listener changes (per its `listenerDeps` dependencies) or
  * the component unmounts, the listener on the underlying Store will be deleted.
- *
  * @param tableId The Id of the Table to listen to, or `null` as a wildcard.
  * @param rowId The Id of the Row to listen to, or `null` as a wildcard.
  * @param cellId The Id of the Cell to listen to, or `null` as a wildcard.
@@ -3101,7 +3210,6 @@ export function useCellListener(
  * you to remove it manually, the useValuesListener hook manages this lifecycle
  * for you: when the listener changes (per its `listenerDeps` dependencies) or
  * the component unmounts, the listener on the underlying Store will be deleted.
- *
  * @param listener The function that will be called whenever keyed value data in
  * the Store changes.
  * @param listenerDeps An optional array of dependencies for the `listener`
@@ -3143,7 +3251,7 @@ export function useCellListener(
  * // -> 0
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
 export function useValuesListener(
   listener: ValuesListener,
@@ -3165,7 +3273,6 @@ export function useValuesListener(
  * lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying Store
  * will be deleted.
- *
  * @param listener The function that will be called whenever the Value Ids in
  * the Store change.
  * @param listenerDeps An optional array of dependencies for the `listener`
@@ -3207,7 +3314,7 @@ export function useValuesListener(
  * // -> 0
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
 export function useValueIdsListener(
   listener: ValueIdsListener,
@@ -3231,7 +3338,6 @@ export function useValueIdsListener(
  * you to remove it manually, the useValueListener hook manages this lifecycle
  * for you: when the listener changes (per its `listenerDeps` dependencies) or
  * the component unmounts, the listener on the underlying Store will be deleted.
- *
  * @param valueId The Id of the Value to listen to, or `null` as a wildcard.
  * @param listener The function that will be called whenever data in the Value
  * changes.
@@ -3274,7 +3380,7 @@ export function useValueIdsListener(
  * // -> 0
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
 export function useValueListener(
   valueId: IdOrNull,
@@ -3305,7 +3411,6 @@ export function useValueListener(
  *
  * This hook ensures the Metrics object is destroyed whenever a new one is
  * created or the component is unmounted.
- *
  * @param store A reference to the Store for which to create a new Metrics
  * object.
  * @param create A function for performing the creation steps of the Metrics
@@ -3407,7 +3512,6 @@ export function useCreateMetrics(
  * The useMetrics hook lets you either get a reference to the default Metrics
  * object (when called without a parameter), or one of the Metrics objects that
  * are named by Id (when called with an Id parameter).
- *
  * @param id An optional Id for accessing a Metrics object that was named with
  * an Id in the Provider.
  * @returns A reference to the Metrics object (or `undefined` if not within a
@@ -3472,7 +3576,6 @@ export function useMetrics(id?: Id): Metrics | undefined;
  * When first rendered, this hook will create a listener so that changes to the
  * Metric will cause a re-render. When the component containing this hook is
  * unmounted, the listener will be automatically removed.
- *
  * @param metricId The Id of the Metric.
  * @param metricsOrMetricsId The Metrics object to be accessed: omit for the
  * default context Metrics object, provide an Id for a named context Metrics
@@ -3576,7 +3679,6 @@ export function useMetric(
  * for you: when the listener changes (per its `listenerDeps` dependencies) or
  * the component unmounts, the listener on the underlying Metrics object, will
  * be deleted.
- *
  * @param metricId The Id of the Metric to listen to, or `null` as a wildcard.
  * @param listener The function that will be called whenever the Metric changes.
  * @param listenerDeps An optional array of dependencies for the `listener`
@@ -3652,7 +3754,6 @@ export function useMetricListener(
  *
  * This hook ensures the Indexes object is destroyed whenever a new one is
  * created or the component is unmounted.
- *
  * @param store A reference to the Store for which to create a new Indexes
  * object.
  * @param create A function for performing the creation steps of the Indexes
@@ -3762,7 +3863,6 @@ export function useCreateIndexes(
  * The useIndexes hook lets you either get a reference to the default Indexes
  * object (when called without a parameter), or one of the Indexes objects that
  * are named by Id (when called with an Id parameter).
- *
  * @param id An optional Id for accessing an Indexes object that was named with
  * an Id in the Provider.
  * @returns A reference to the Indexes object (or `undefined` if not within a
@@ -3827,7 +3927,6 @@ export function useIndexes(id?: Id): Indexes | undefined;
  * When first rendered, this hook will create a listener so that changes to the
  * Slice Ids will cause a re-render. When the component containing this hook is
  * unmounted, the listener will be automatically removed.
- *
  * @param indexId The Id of the Index.
  * @param indexesOrIndexesId The Indexes object to be accessed: omit for the
  * default context Indexes object, provide an Id for a named context Indexes
@@ -3933,7 +4032,6 @@ export function useSliceIds(
  * When first rendered, this hook will create a listener so that changes to the
  * Row Ids in the Slice will cause a re-render. When the component containing
  * this hook is unmounted, the listener will be automatically removed.
- *
  * @param indexId The Id of the Index.
  * @param sliceId The Id of the Slice in the Index.
  * @param indexesOrIndexesId The Indexes object to be accessed: omit for the
@@ -4049,7 +4147,6 @@ export function useSliceRowIds(
  * lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying
  * Indexes object will be deleted.
- *
  * @param indexId The Id of the Index to listen to, or `null` as a wildcard.
  * @param listener The function that will be called whenever the Slice Ids in
  * the Index change.
@@ -4127,7 +4224,6 @@ export function useSliceIdsListener(
  * this lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying
  * Indexes object will be deleted.
- *
  * @param indexId The Id of the Index to listen to, or `null` as a wildcard.
  * @param sliceId The Id of the Slice to listen to, or `null` as a wildcard.
  * @param listener The function that will be called whenever the Row Ids in the
@@ -4209,7 +4305,6 @@ export function useSliceRowIdsListener(
  *
  * This hook ensures the Relationships object is destroyed whenever a new one is
  * created or the component is unmounted.
- *
  * @param store A reference to the Store for which to create a new Relationships
  * object.
  * @param create An optional callback for performing post-creation steps on the
@@ -4327,7 +4422,6 @@ export function useCreateRelationships(
  * Relationships object (when called without a parameter), or one of the
  * Relationships objects that are named by Id (when called with an Id
  * parameter).
- *
  * @param id An optional Id for accessing a Relationships object that was named
  * with an Id in the Provider.
  * @returns A reference to the Relationships object (or `undefined` if not
@@ -4401,7 +4495,6 @@ export function useRelationships(id?: Id): Relationships | undefined;
  * When first rendered, this hook will create a listener so that changes to the
  * remote Row Id will cause a re-render. When the component containing this hook
  * is unmounted, the listener will be automatically removed.
- *
  * @param relationshipId The Id of the Relationship.
  * @param localRowId The Id of the local Row in the Relationship.
  * @param relationshipsOrRelationshipsId The Relationships object to be
@@ -4510,7 +4603,6 @@ export function useRemoteRowId(
  * When first rendered, this hook will create a listener so that changes to the
  * local Row Id will cause a re-render. When the component containing this hook
  * is unmounted, the listener will be automatically removed.
- *
  * @param relationshipId The Id of the Relationship.
  * @param remoteRowId The Id of the remote Row in the Relationship.
  * @param relationshipsOrRelationshipsId The Relationships object to be
@@ -4627,7 +4719,6 @@ export function useLocalRowIds(
  * When first rendered, this hook will create a listener so that changes to the
  * linked Row Ids will cause a re-render. When the component containing this
  * hook is unmounted, the listener will be automatically removed.
- *
  * @param relationshipId The Id of the Relationship.
  * @param firstRowId The Id of the first Row in the linked list Relationship.
  * @param relationshipsOrRelationshipsId The Relationships object to be
@@ -4758,7 +4849,6 @@ export function useLinkedRowIds(
  * this lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying
  * Indexes object will be deleted.
- *
  * @param relationshipId The Id of the Relationship to listen to, or `null` as a
  * wildcard.
  * @param localRowId The Id of the local Row to listen to, or `null` as a
@@ -4847,7 +4937,6 @@ export function useRemoteRowIdListener(
  * this lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying
  * Indexes object will be deleted.
- *
  * @param relationshipId The Id of the Relationship to listen to, or `null` as a
  * wildcard.
  * @param remoteRowId The Id of the remote Row to listen to, or `null` as a
@@ -4932,7 +5021,6 @@ export function useLocalRowIdsListener(
  * this lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying
  * Indexes object will be deleted.
- *
  * @param relationshipId The Id of the Relationship to listen to.
  * @param firstRowId The Id of the first Row of the linked list to listen to.
  * @param listener The function that will be called whenever the linked Row Ids
@@ -5020,7 +5108,6 @@ export function useLinkedRowIdsListener(
  *
  * This hook ensures the Queries object is destroyed whenever a new one is
  * created or the component is unmounted.
- *
  * @param store A reference to the Store for which to create a new Queries
  * object.
  * @param create An optional callback for performing post-creation steps on the
@@ -5113,7 +5200,7 @@ export function useLinkedRowIdsListener(
  * // -> '<span>brown</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useCreateQueries(
   store: Store,
@@ -5133,7 +5220,6 @@ export function useCreateQueries(
  * The useQueries hook lets you either get a reference to the default Queries
  * object (when called without a parameter), or one of the Queries objects that
  * are named by Id (when called with an Id parameter).
- *
  * @param id An optional Id for accessing a Queries object that was named with
  * an Id in the Provider.
  * @returns A reference to the Queries object (or `undefined` if not within a
@@ -5181,7 +5267,7 @@ export function useCreateQueries(
  * // -> '<span>0</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useQueries(id?: Id): Queries | undefined;
 
@@ -5200,7 +5286,6 @@ export function useQueries(id?: Id): Queries | undefined;
  * When first rendered, this hook will create a listener so that changes to the
  * query result will cause a re-render. When the component containing this hook
  * is unmounted, the listener will be automatically removed.
- *
  * @param queryId The Id of the query.
  * @param queriesOrQueriesId The Queries object to be accessed: omit for the
  * default context Queries object, provide an Id for a named context Queries
@@ -5298,7 +5383,7 @@ export function useQueries(id?: Id): Queries | undefined;
  * // -> '<span>{"fido":{"color":"brown"},"cujo":{"color":"black"}}</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useResultTable(
   queryId: Id,
@@ -5320,7 +5405,6 @@ export function useResultTable(
  * When first rendered, this hook will create a listener so that changes to the
  * result Row Ids will cause a re-render. When the component containing this
  * hook is unmounted, the listener will be automatically removed.
- *
  * @param queryId The Id of the query.
  * @param queriesOrQueriesId The Queries object to be accessed: omit for the
  * default context Queries object, provide an Id for a named context Queries
@@ -5419,7 +5503,7 @@ export function useResultTable(
  * // -> '<span>["fido","cujo"]</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useResultRowIds(
   queryId: Id,
@@ -5441,7 +5525,6 @@ export function useResultRowIds(
  * When first rendered, this hook will create a listener so that changes to the
  * sorted result Row Ids will cause a re-render. When the component containing
  * this hook is unmounted, the listener will be automatically removed.
- *
  * @param queryId The Id of the query.
  * @param cellId The Id of the result Cell whose values are used for the
  * sorting, or `undefined` to by sort the result Row Id itself.
@@ -5568,7 +5651,7 @@ export function useResultRowIds(
  * // -> '<span>["cujo","fido"]</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useResultSortedRowIds(
   queryId: Id,
@@ -5594,7 +5677,6 @@ export function useResultSortedRowIds(
  * When first rendered, this hook will create a listener so that changes to the
  * result Row will cause a re-render. When the component containing this hook is
  * unmounted, the listener will be automatically removed.
- *
  * @param queryId The Id of the query.
  * @param rowId The Id of the Row in the result Table.
  * @param queriesOrQueriesId The Queries object to be accessed: omit for the
@@ -5696,7 +5778,7 @@ export function useResultSortedRowIds(
  * // -> '<span>{"color":"brown"}</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useResultRow(
   queryId: Id,
@@ -5719,7 +5801,6 @@ export function useResultRow(
  * When first rendered, this hook will create a listener so that changes to the
  * result Cell Ids will cause a re-render. When the component containing this
  * hook is unmounted, the listener will be automatically removed.
- *
  * @param queryId The Id of the query.
  * @param rowId The Id of the Row in the result Table.
  * @param queriesOrQueriesId The Queries object to be accessed: omit for the
@@ -5827,7 +5908,7 @@ export function useResultRow(
  * // -> '<span>["species","color"]</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useResultCellIds(
   queryId: Id,
@@ -5850,7 +5931,6 @@ export function useResultCellIds(
  * When first rendered, this hook will create a listener so that changes to the
  * result Cell will cause a re-render. When the component containing this hook
  * is unmounted, the listener will be automatically removed.
- *
  * @param queryId The Id of the query.
  * @param rowId The Id of the Row in the result Table.
  * @param cellId The Id of the Cell in the Row.
@@ -5954,7 +6034,7 @@ export function useResultCellIds(
  * // -> '<span>brown</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useResultCell(
   queryId: Id,
@@ -5980,7 +6060,6 @@ export function useResultCell(
  * this lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying
  * Queries object will be deleted.
- *
  * @param queryId The Id of the query to listen to, or `null` as a wildcard.
  * @param listener The function that will be called whenever data in the
  * matching result Table changes.
@@ -6032,7 +6111,7 @@ export function useResultCell(
  * // -> 0
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useResultTableListener(
   queryId: IdOrNull,
@@ -6058,7 +6137,6 @@ export function useResultTableListener(
  * this lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying
  * Queries object will be deleted.
- *
  * @param queryId The Id of the query to listen to, or `null` as a wildcard.
  * @param listener The function that will be called whenever the Row Ids in the
  * matching result Table change.
@@ -6110,7 +6188,7 @@ export function useResultTableListener(
  * // -> 0
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useResultRowIdsListener(
   queryId: IdOrNull,
@@ -6133,7 +6211,6 @@ export function useResultRowIdsListener(
  * hook manages this lifecycle for you: when the listener changes (per its
  * `listenerDeps` dependencies) or the component unmounts, the listener on the
  * underlying Queries object will be deleted.
- *
  * @param queryId The Id of the query to listen to.
  * @param cellId The Id of the Cell whose values are used for the sorting, or
  * `undefined` to by sort the Row Id itself.
@@ -6195,7 +6272,7 @@ export function useResultRowIdsListener(
  * // -> 0
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useResultSortedRowIdsListener(
   queryId: Id,
@@ -6230,7 +6307,6 @@ export function useResultSortedRowIdsListener(
  * this lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying
  * Queries object will be deleted.
- *
  * @param queryId The Id of the query to listen to, or `null` as a wildcard.
  * @param rowId The Id of the result Row to listen to, or `null` as a wildcard.
  * @param listener The function that will be called whenever data in the
@@ -6283,7 +6359,7 @@ export function useResultSortedRowIdsListener(
  * // -> 0
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useResultRowListener(
   queryId: IdOrNull,
@@ -6312,7 +6388,6 @@ export function useResultRowListener(
  * this lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying
  * Queries object will be deleted.
- *
  * @param queryId The Id of the query to listen to, or `null` as a wildcard.
  * @param rowId The Id of the result Row to listen to, or `null` as a wildcard.
  * @param listener The function that will be called whenever the Row Ids in the
@@ -6368,7 +6443,7 @@ export function useResultRowListener(
  * // -> 0
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useResultCellIdsListener(
   queryId: IdOrNull,
@@ -6400,7 +6475,6 @@ export function useResultCellIdsListener(
  * this lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying
  * Queries object will be deleted.
- *
  * @param queryId The Id of the query to listen to, or `null` as a wildcard.
  * @param rowId The Id of the result Row to listen to, or `null` as a wildcard.
  * @param cellId The Id of the result Cell to listen to, or `null` as a
@@ -6455,7 +6529,7 @@ export function useResultCellIdsListener(
  * // -> 0
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
 export function useResultCellListener(
   queryId: IdOrNull,
@@ -6488,7 +6562,6 @@ export function useResultCellListener(
  *
  * This hook ensures the Checkpoints object is destroyed whenever a new one is
  * created or the component is unmounted.
- *
  * @param store A reference to the Store for which to create a new Checkpoints
  * object.
  * @param create A function for performing the creation steps of the Checkpoints
@@ -6579,7 +6652,6 @@ export function useCreateCheckpoints(
  * The useCheckpoints hook lets you either get a reference to the default
  * Checkpoints object (when called without a parameter), or one of the
  * Checkpoints objects that are named by Id (when called with an Id parameter).
- *
  * @param id An optional Id for accessing a Checkpoints object that was named
  * with an Id in the Provider.
  * @returns A reference to the Checkpoints object (or `undefined` if not within
@@ -6652,7 +6724,6 @@ export function useCheckpoints(id?: Id): Checkpoints | undefined;
  * When first rendered, this hook will create a listener so that changes to the
  * checkpoint Ids will cause a re-render. When the component containing this
  * hook is unmounted, the listener will be automatically removed.
- *
  * @param checkpointsOrCheckpointsId The Checkpoints object to be accessed: omit
  * for the default context Checkpoints object, provide an Id for a named context
  * Checkpoints object, or provide an explicit reference.
@@ -6751,7 +6822,6 @@ export function useCheckpointIds(
  * When first rendered, this hook will create a listener so that changes to the
  * label will cause a re-render. When the component containing this hook is
  * unmounted, the listener will be automatically removed.
- *
  * @param checkpointId The Id of the checkpoint.
  * @param checkpointsOrCheckpointsId The Checkpoints object to be accessed: omit
  * for the default context Checkpoints object, provide an Id for a named context
@@ -6855,7 +6925,6 @@ export function useCheckpoint(
  * The Checkpoints object for which the callback will set the checkpoint
  * (indicated by the hook's `checkpointsOrCheckpointsId` parameter) is always
  * automatically used as a hook dependency for the callback.
- *
  * @param getCheckpoint An optional function which returns a string that will be
  * used to describe the actions leading up to this checkpoint, based on the
  * parameter the callback will receive (and which is most likely a DOM event).
@@ -6923,7 +6992,6 @@ export function useSetCheckpointCallback<Parameter>(
  * backward to the previous checkpoint - such as when clicking an undo button.
  *
  * If there is no previous checkpoint to return to, this callback has no effect.
- *
  * @param checkpointsOrCheckpointsId The Checkpoints object to use to go
  * backward: omit for the default context Checkpoints object, provide an Id for
  * a named context Checkpoints object, or provide an explicit reference.
@@ -6971,7 +7039,6 @@ export function useGoBackwardCallback(
  * forward to the next checkpoint - such as when clicking an redo button.
  *
  * If there is no future checkpoint to return to, this callback has no effect.
- *
  * @param checkpointsOrCheckpointsId The Checkpoints object to use to go
  * backward: omit for the default context Checkpoints object, provide an Id for
  * a named context Checkpoints object, or provide an explicit reference.
@@ -7038,7 +7105,6 @@ export function useGoForwardCallback(
  * The Checkpoints object for which the callback will set the checkpoint
  * (indicated by the hook's `checkpointsOrCheckpointsId` parameter) is always
  * automatically used as a hook dependency for the callback.
- *
  * @param getCheckpointId A function which returns an Id that will be used to
  * indicate which checkpoint to move to, based on the parameter the callback
  * will receive (and which is most likely a DOM event).
@@ -7103,7 +7169,6 @@ export function useGoToCallback<Parameter>(
  * contains whether an undo action is available (to enable the button), the
  * callback to perform the undo action, the current checkpoint Id that will be
  * undone, and its label, if available.
- *
  * @param checkpointsOrCheckpointsId The Checkpoints object to use to go
  * backward: omit for the default context Checkpoints object, provide an Id for
  * a named context Checkpoints object, or provide an explicit reference.
@@ -7149,7 +7214,6 @@ export function useUndoInformation(
  * contains whether a redo action is available (to enable the button), the
  * callback to perform the redo action, the checkpoint Id that will be redone,
  * and its label, if available.
- *
  * @param checkpointsOrCheckpointsId The Checkpoints object to use to go
  * backward: omit for the default context Checkpoints object, provide an Id for
  * a named context Checkpoints object, or provide an explicit reference.
@@ -7201,7 +7265,6 @@ export function useRedoInformation(
  * this lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying
  * Checkpoints object will be deleted.
- *
  * @param listener The function that will be called whenever the checkpoints
  * change.
  * @param listenerDeps An optional array of dependencies for the `listener`
@@ -7270,7 +7333,6 @@ export function useCheckpointIdsListener(
  * this lifecycle for you: when the listener changes (per its `listenerDeps`
  * dependencies) or the component unmounts, the listener on the underlying
  * Checkpoints object will be deleted.
- *
  * @param checkpointId The Id of the checkpoint to listen to, or `null` as a
  * wildcard.
  * @param listener The function that will be called whenever the checkpoint
@@ -7352,7 +7414,6 @@ export function useCheckpointListener(
  *
  * This hook ensures the Persister object is destroyed whenever a new one is
  * created or the component is unmounted.
- *
  * @param store A reference to the Store for which to create a new Persister
  * object.
  * @param create A function for performing the creation steps of the Persister
@@ -7471,7 +7532,6 @@ export function useCreatePersister(
 
 /**
  * The ExtraProps type represents a set of arbitrary additional props.
- *
  * @category Props
  */
 export type ExtraProps = {[propName: string]: any};
@@ -7479,7 +7539,6 @@ export type ExtraProps = {[propName: string]: any};
 /**
  * TablesProps props are used for components that refer to all the Tables in a
  * Store, such as the TablesView component.
- *
  * @category Props
  */
 export type TablesProps = {
@@ -7512,7 +7571,6 @@ export type TablesProps = {
 /**
  * TableProps props are used for components that refer to a single Table in a
  * Store, such as the TableView component.
- *
  * @category Props
  */
 export type TableProps = {
@@ -7549,9 +7607,8 @@ export type TableProps = {
 /**
  * SortedTableProps props are used for components that refer to a single sorted
  * Table in a Store, such as the SortedTableView component.
- *
  * @category Props
- * @since v2.0
+ * @since v2.0.0
  */
 export type SortedTableProps = {
   /**
@@ -7604,7 +7661,6 @@ export type SortedTableProps = {
 /**
  * RowProps props are used for components that refer to a single Row in a Table,
  * such as the RowView component.
- *
  * @category Props
  */
 export type RowProps = {
@@ -7645,7 +7701,6 @@ export type RowProps = {
 /**
  * CellProps props are used for components that refer to a single Cell in a Row,
  * such as the CellView component.
- *
  * @category Props
  */
 export type CellProps = {
@@ -7676,9 +7731,8 @@ export type CellProps = {
 /**
  * ValuesProps props are used for components that refer to all the Values in a
  * Store, such as the ValuesView component.
- *
  * @category Props
- * @since v3.0
+ * @since v3.0.0
  */
 export type ValuesProps = {
   /**
@@ -7710,9 +7764,8 @@ export type ValuesProps = {
 /**
  * ValueProps props are used for components that refer to a single Value in a
  * Row, such as the ValueView component.
- *
  * @category Props
- * @since v3.0
+ * @since v3.0.0
  */
 export type ValueProps = {
   /**
@@ -7734,7 +7787,6 @@ export type ValueProps = {
 /**
  * MetricProps props are used for components that refer to a single Metric in a
  * Metrics object, such as the MetricView component.
- *
  * @category Props
  */
 export type MetricProps = {
@@ -7758,7 +7810,6 @@ export type MetricProps = {
 /**
  * IndexProps props are used for components that refer to a single Index in an
  * Indexes object, such as the IndexView component.
- *
  * @category Props
  */
 export type IndexProps = {
@@ -7795,7 +7846,6 @@ export type IndexProps = {
 /**
  * SliceProps props are used for components that refer to a single Slice in an
  * Index object, such as the SliceView component.
- *
  * @category Props
  */
 export type SliceProps = {
@@ -7837,7 +7887,6 @@ export type SliceProps = {
  * RemoteRowProps props are used for components that refer to a single
  * Relationship in a Relationships object, and where you want to render a remote
  * Row based on a local Row, such as in the RemoteRowView component.
- *
  * @category Props
  */
 export type RemoteRowProps = {
@@ -7876,7 +7925,6 @@ export type RemoteRowProps = {
  * LocalRowsProps props are used for components that refer to a single
  * Relationship in a Relationships object, and where you want to render local
  * Rows based on a remote Row, such as the LocalRowsView component.
- *
  * @category Props
  */
 export type LocalRowsProps = {
@@ -7919,7 +7967,6 @@ export type LocalRowsProps = {
  * LinkedRowsProps props are used for components that refer to a single
  * Relationship in a Relationships object, and where you want to render a linked
  * list of Rows starting from a first Row, such as the LinkedRowsView component.
- *
  * @category Props
  */
 export type LinkedRowsProps = {
@@ -7961,9 +8008,8 @@ export type LinkedRowsProps = {
 /**
  * ResultTableProps props are used for components that refer to a single query
  * result Table, such as the ResultTableView component.
- *
  * @category Props
- * @since v2.0
+ * @since v2.0.0
  */
 export type ResultTableProps = {
   /**
@@ -8001,9 +8047,8 @@ export type ResultTableProps = {
 /**
  * ResultSortedTableProps props are used for components that refer to a single
  * sorted query result Table, such as the ResultSortedTableView component.
- *
  * @category Props
- * @since v2.0
+ * @since v2.0.0
  */
 export type ResultSortedTableProps = {
   /**
@@ -8058,9 +8103,8 @@ export type ResultSortedTableProps = {
 /**
  * ResultRowProps props are used for components that refer to a single Row in a
  * query result Table, such as the ResultRowView component.
- *
  * @category Props
- * @since v2.0
+ * @since v2.0.0
  */
 export type ResultRowProps = {
   /**
@@ -8102,9 +8146,8 @@ export type ResultRowProps = {
 /**
  * ResultRowProps props are used for components that refer to a single Cell in a
  * Row of a result Table, such as the ResultCellView component.
- *
  * @category Props
- * @since v2.0
+ * @since v2.0.0
  */
 export type ResultCellProps = {
   /**
@@ -8136,7 +8179,6 @@ export type ResultCellProps = {
 /**
  * CheckpointProps props are used for components that refer to a single
  * checkpoint in a Checkpoints object, such as the CheckpointView component.
- *
  * @category Props
  */
 export type CheckpointProps = {
@@ -8161,7 +8203,6 @@ export type CheckpointProps = {
  * BackwardCheckpointsProps props are used for components that refer to a list
  * of previous checkpoints in a Checkpoints object, such as the
  * BackwardCheckpointsView component.
- *
  * @category Props
  */
 export type BackwardCheckpointsProps = {
@@ -8195,7 +8236,6 @@ export type BackwardCheckpointsProps = {
  * CurrentCheckpointsProps props are used for components that refer to the
  * current checkpoints in a Checkpoints object, such as the
  * BackwardCheckpointsView component.
- *
  * @category Props
  */
 export type CurrentCheckpointProps = {
@@ -8225,7 +8265,6 @@ export type CurrentCheckpointProps = {
  * ForwardCheckpointsProps props are used for components that refer to a list of
  * future checkpoints in a Checkpoints object, such as the
  * ForwardCheckpointsView component.
- *
  * @category Props
  */
 export type ForwardCheckpointsProps = {
@@ -8263,7 +8302,6 @@ export type ForwardCheckpointsProps = {
  * One of each type of object can be provided as a default within the context.
  * Additionally, multiple of each type of object can be provided in an Id-keyed
  * map to the `___ById` props.
- *
  * @category Props
  */
 export type ProviderProps = {
@@ -8332,7 +8370,6 @@ export type ProviderProps = {
 /**
  * ComponentReturnType is a simple alias for what a React component can return:
  * either a ReactElement, or `null` for an empty component.
- *
  * @category Component
  */
 export type ComponentReturnType = ReactElement<any, any> | null;
@@ -8353,7 +8390,6 @@ export type ComponentReturnType = ReactElement<any, any> | null;
  * will be visible within the inner context. If the outer context contains a
  * Store named by Id and the inner context contains a Store named by a different
  * Id, both will be visible within the inner context.
- *
  * @param props The props for this component.
  * @returns A rendering of the child components.
  * @example
@@ -8453,7 +8489,6 @@ export function Provider(
  *
  * This component uses the useCell hook under the covers, which means that any
  * changes to the specified Cell will cause a re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the Cell, or nothing, if not present.
  * @example
@@ -8549,7 +8584,6 @@ export function CellView(props: CellProps): ComponentReturnType;
  *
  * This component uses the useCellIds hook under the covers, which means that
  * any changes to the structure of the Row will cause a re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the Row, or nothing, if not present.
  * @example
@@ -8664,7 +8698,6 @@ export function RowView(props: RowProps): ComponentReturnType;
  * This component uses the useSortedRowIds hook under the covers, which means
  * that any changes to the structure or sorting of the Table will cause a
  * re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the Table, or nothing, if not present.
  * @example
@@ -8768,7 +8801,7 @@ export function RowView(props: RowProps): ComponentReturnType;
  * // -> '<div><span>felix: cat</span><span><b>fido</b>: dog</span></div>'
  * ```
  * @category Store components
- * @since v2.0
+ * @since v2.0.0
  */
 export function SortedTableView(props: SortedTableProps): ComponentReturnType;
 
@@ -8792,7 +8825,6 @@ export function SortedTableView(props: SortedTableProps): ComponentReturnType;
  *
  * This component uses the useRowIds hook under the covers, which means that any
  * changes to the structure of the Table will cause a re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the Table, or nothing, if not present.
  * @example
@@ -8901,7 +8933,6 @@ export function TableView(props: TableProps): ComponentReturnType;
  *
  * This component uses the useTableIds hook under the covers, which means that
  * any changes to the structure of the Store will cause a re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the Store, or nothing, if not present.
  * @example
@@ -9007,7 +9038,6 @@ export function TablesView(props: TablesProps): ComponentReturnType;
  *
  * This component uses the useValue hook under the covers, which means that any
  * changes to the specified Value will cause a re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the Value, or nothing, if not present.
  * @example
@@ -9079,7 +9109,7 @@ export function TablesView(props: TablesProps): ComponentReturnType;
  * // -> '<span></span>'
  * ```
  * @category Store components
- * @since v3.0
+ * @since v3.0.0
  */
 export function ValueView(props: ValueProps): ComponentReturnType;
 
@@ -9103,7 +9133,6 @@ export function ValueView(props: ValueProps): ComponentReturnType;
  *
  * This component uses the useValueIds hook under the covers, which means that
  * any changes to the Store's Values will cause a re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the Values, or nothing, if not present.
  * @example
@@ -9185,7 +9214,7 @@ export function ValueView(props: ValueProps): ComponentReturnType;
  * // -> '<div><span><b>open</b>: true</span><span>employees: 3</span></div>'
  * ```
  * @category Store components
- * @since v3.0
+ * @since v3.0.0
  */
 export function ValuesView(props: ValuesProps): ComponentReturnType;
 
@@ -9199,7 +9228,6 @@ export function ValuesView(props: ValuesProps): ComponentReturnType;
  *
  * This component uses the useMetric hook under the covers, which means that any
  * changes to the Metric will cause a re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the Metric, or nothing, if not present.
  * @example
@@ -9310,7 +9338,6 @@ export function MetricView(props: MetricProps): ComponentReturnType;
  *
  * This component uses the useSliceRowIds hook under the covers, which means
  * that any changes to the structure of the Slice will cause a re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the Slice, or nothing, if not present.
  * @example
@@ -9437,7 +9464,6 @@ export function SliceView(props: SliceProps): ComponentReturnType;
  *
  * This component uses the useSliceIds hook under the covers, which means that
  * any changes to the structure of the Index will cause a re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the Index, or nothing, if not present.
  * @example
@@ -9560,7 +9586,6 @@ export function IndexView(props: IndexProps): ComponentReturnType;
  * This component uses the useRemoteRowId hook under the covers, which means
  * that any changes to the remote Row Id in the Relationship will cause a
  * re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the remote Row, or nothing, if not present.
  * @example
@@ -9694,7 +9719,6 @@ export function RemoteRowView(props: RemoteRowProps): ComponentReturnType;
  * This component uses the useLocalRowIds hook under the covers, which means
  * that any changes to the local Row Ids in the Relationship will cause a
  * re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the local Row objects, or nothing, if not present.
  * @example
@@ -9829,7 +9853,6 @@ export function LocalRowsView(props: LocalRowsProps): ComponentReturnType;
  * This component uses the useLocalRowIds hook under the covers, which means
  * that any changes to the local Row Ids in the Relationship will cause a
  * re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the local Row objects, or nothing, if not present.
  * @example
@@ -9966,7 +9989,6 @@ export function LinkedRowsView(props: LinkedRowsProps): ComponentReturnType;
  *
  * This component uses the useResultCell hook under the covers, which means that
  * any changes to the specified Cell will cause a re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the result Cell, or nothing, if not present.
  * @example
@@ -10069,7 +10091,7 @@ export function LinkedRowsView(props: LinkedRowsProps): ComponentReturnType;
  * // -> '<span></span>'
  * ```
  * @category Queries components
- * @since v2.0
+ * @since v2.0.0
  */
 export function ResultCellView(props: ResultCellProps): ComponentReturnType;
 
@@ -10095,7 +10117,6 @@ export function ResultCellView(props: ResultCellProps): ComponentReturnType;
  *
  * This component uses the useResultCellIds hook under the covers, which means
  * that any changes to the structure of the result Row will cause a re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the result Row, or nothing, if not present.
  * @example
@@ -10216,7 +10237,7 @@ export function ResultCellView(props: ResultCellProps): ComponentReturnType;
  * // -> '<div><span><b>species</b>: dog</span><span>color: brown</span></div>'
  * ```
  * @category Queries components
- * @since v2.0
+ * @since v2.0.0
  */
 export function ResultRowView(props: ResultRowProps): ComponentReturnType;
 
@@ -10243,7 +10264,6 @@ export function ResultRowView(props: ResultRowProps): ComponentReturnType;
  * This component uses the useResultSortedRowIds hook under the covers, which
  * means that any changes to the structure or sorting of the result Table will
  * cause a re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the result Table, or nothing, if not present.
  * @example
@@ -10354,7 +10374,7 @@ export function ResultRowView(props: ResultRowProps): ComponentReturnType;
  * // -> '<div><span>felix: black</span><span><b>fido</b>: brown</span></div>'
  * ```
  * @category Queries components
- * @since v2.0
+ * @since v2.0.0
  */
 export function ResultSortedTableView(
   props: ResultSortedTableProps,
@@ -10378,7 +10398,6 @@ export function ResultSortedTableView(
  *
  * This component uses the useResultRowIds hook under the covers, which means
  * that any changes to the structure of the result Table will cause a re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the result Table, or nothing, if not present.
  * @example
@@ -10479,7 +10498,7 @@ export function ResultSortedTableView(
  * // -> '<div><span><b>fido</b>: brown</span><span>felix: black</span></div>'
  * ```
  * @category Queries components
- * @since v2.0
+ * @since v2.0.0
  */
 export function ResultTableView(props: ResultTableProps): ComponentReturnType;
 
@@ -10495,7 +10514,6 @@ export function ResultTableView(props: ResultTableProps): ComponentReturnType;
  *
  * This component uses the useCheckpoint hook under the covers, which means that
  * any changes to the local Row Ids in the Relationship will cause a re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the checkpoint: its label if present, or Id.
  * @example
@@ -10552,7 +10570,6 @@ export function CheckpointView(props: CheckpointProps): ComponentReturnType;
  * This component uses the useCheckpointIds hook under the covers, which means
  * that any changes to the checkpoint Ids in the Checkpoints object will cause a
  * re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the previous checkpoints, if present.
  * @example
@@ -10688,7 +10705,6 @@ export function BackwardCheckpointsView(
  * This component uses the useCheckpointIds hook under the covers, which means
  * that any changes to the current checkpoint Id in the Checkpoints object will
  * cause a re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the current checkpoint, if present.
  * @example
@@ -10826,7 +10842,6 @@ export function CurrentCheckpointView(
  * This component uses the useCheckpointIds hook under the covers, which means
  * that any changes to the checkpoint Ids in the Checkpoints object will cause a
  * re-render.
- *
  * @param props The props for this component.
  * @returns A rendering of the future checkpoints, if present.
  * @example