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

package/lib/types/with-schemas/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
@@ -79,6 +78,7 @@ import {
   SortedRowIdsListener,
   Store,
   Table,
+  TableCellIdsListener,
   TableIdsListener,
   TableListener,
   Tables,
@@ -136,7 +136,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
  */
   StoreOrStoreId: StoreOrStoreId<Schemas>;
@@ -161,7 +160,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
  */
   MetricsOrMetricsId: MetricsOrMetricsId<Schemas>;
@@ -186,7 +184,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
  */
   IndexesOrIndexesId: IndexesOrIndexesId<Schemas>;
@@ -211,7 +208,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
  */
   RelationshipsOrRelationshipsId: RelationshipsOrRelationshipsId<Schemas>;
@@ -236,9 +232,8 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
  */
   QueriesOrQueriesId: QueriesOrQueriesId<Schemas>;
 
@@ -262,7 +257,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
  */
   CheckpointsOrCheckpointsId: CheckpointsOrCheckpointsId<Schemas>;
@@ -275,7 +269,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
  */
   UndoOrRedoInformation: UndoOrRedoInformation;
@@ -307,7 +300,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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`
@@ -393,7 +385,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -462,7 +453,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -545,7 +535,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -630,7 +619,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -699,6 +687,100 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
     storeOrStoreId?: StoreOrStoreId<Schemas>,
   ) => Table<Schemas[0], TableId>;
 
+  /**
+ * 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.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * useTableCellIds(
+ *   tableId: Id,
+ *   storeOrStoreId?: StoreOrStoreId,
+ * ): Ids;
+ * ```
+ *
+ * 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
+ */
+  useTableCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
+    tableId: TableId,
+    storeOrStoreId?: StoreOrStoreId<Schemas>,
+  ) => CellIdFromSchema<Schemas[0], TableId>[];
+
   /**
  * 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
@@ -719,7 +801,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -815,7 +896,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -908,7 +988,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>["felix","fido"]</span>'
  * ```
  * @category Store hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useSortedRowIds: <
     TableId extends TableIdFromSchema<Schemas[0]>,
@@ -946,7 +1026,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -1043,7 +1122,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -1112,14 +1190,11 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * ```
  * @category Store hooks
  */
-  useCellIds: <
-    TableId extends TableIdFromSchema<Schemas[0]>,
-    Ids extends CellIdFromSchema<Schemas[0], TableId>[],
-  >(
+  useCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
     tableId: TableId,
     rowId: Id,
     storeOrStoreId?: StoreOrStoreId<Schemas>,
-  ) => Ids;
+  ) => CellIdFromSchema<Schemas[0], TableId>[];
 
   /**
  * The useCell hook returns an object containing the value of a single Cell in a
@@ -1146,7 +1221,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -1242,7 +1316,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -1302,7 +1375,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>{"open":true}</span>'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
   useValues: (storeOrStoreId?: StoreOrStoreId<Schemas>) => Values<Schemas[1]>;
 
@@ -1325,7 +1398,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -1385,7 +1457,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>["open"]</span>'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
   useValueIds: (
     storeOrStoreId?: StoreOrStoreId<Schemas>,
@@ -1414,7 +1486,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -1477,7 +1548,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>true</span>'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
   useValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
     valueId: ValueId,
@@ -1520,7 +1591,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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).
@@ -1619,7 +1689,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -1726,7 +1795,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -1840,7 +1908,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -1858,7 +1925,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -1949,7 +2015,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -2061,7 +2126,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -2212,7 +2276,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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).
@@ -2262,7 +2325,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '{"bubbles":true}'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
   useSetValuesCallback: <Parameter, SetValues = Values<Schemas[1], true>>(
     getValues: (
@@ -2312,7 +2375,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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).
@@ -2363,7 +2425,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '{"open":true,"bubbles":true}'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
   useSetPartialValuesCallback: <
     Parameter,
@@ -2416,7 +2478,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -2468,7 +2529,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '{"open":true,"bubbles":true}'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
   useSetValueCallback: <
     Parameter,
@@ -2511,7 +2572,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -2585,7 +2645,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -2662,7 +2721,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -2743,7 +2801,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -2834,7 +2891,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -2875,7 +2931,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '{}'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
   useDelValuesCallback: (
     storeOrStoreId?: StoreOrStoreId<Schemas>,
@@ -2909,7 +2965,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -2951,7 +3006,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '{"employees":3}'
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
   useDelValueCallback: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
     valueId: ValueId,
@@ -2983,7 +3038,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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`
@@ -3057,7 +3111,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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`
@@ -3134,7 +3187,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -3188,6 +3240,88 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
     storeOrStoreId?: StoreOrStoreId<Schemas>,
   ) => 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 has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * useTableCellIdsListener(
+ *   tableId: IdOrNull,
+ *   listener: TableCellIdsListener,
+ *   listenerDeps?: React.DependencyList,
+ *   mutator?: boolean,
+ *   storeOrStoreId?: StoreOrStoreId,
+ * ): void;
+ * ```
+ *
+ * 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
+ */
+  useTableCellIdsListener: <
+    TableIdOrNull extends TableIdFromSchema<Schemas[0]> | null,
+  >(
+    tableId: TableIdOrNull,
+    listener: TableCellIdsListener<Schemas, TableIdOrNull>,
+    listenerDeps?: React.DependencyList,
+    mutator?: boolean,
+    storeOrStoreId?: StoreOrStoreId<Schemas>,
+  ) => void;
+
   /**
  * The useRowIdsListener hook registers a listener function with a Store that
  * will be called whenever the Row Ids in a Table change.
@@ -3215,7 +3349,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -3299,7 +3432,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -3354,7 +3486,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> 0
  * ```
  * @category Store hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useSortedRowIdsListener: <
     TableId extends TableIdFromSchema<Schemas[0]>,
@@ -3415,7 +3547,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -3507,7 +3638,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -3601,7 +3731,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -3690,7 +3819,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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`
@@ -3732,7 +3860,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> 0
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
   useValuesListener: (
     listener: ValuesListener<Schemas>,
@@ -3765,7 +3893,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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`
@@ -3807,7 +3934,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> 0
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
   useValueIdsListener: (
     listener: ValueIdsListener<Schemas>,
@@ -3843,7 +3970,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -3886,7 +4012,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> 0
  * ```
  * @category Store hooks
- * @since v3.0
+ * @since v3.0.0
  */
   useValueListener: <
     ValueIdOrNull extends ValueIdFromSchema<Schemas[1]> | null,
@@ -3929,7 +4055,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -4037,7 +4162,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -4111,7 +4235,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -4226,7 +4349,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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`
@@ -4312,7 +4434,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -4428,7 +4549,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -4502,7 +4622,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -4618,7 +4737,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -4745,7 +4863,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -4835,7 +4952,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -4927,7 +5043,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -5051,7 +5166,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -5135,7 +5249,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -5254,7 +5367,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -5381,7 +5493,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -5524,7 +5635,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -5625,7 +5735,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -5722,7 +5831,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -5820,7 +5928,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -5913,7 +6020,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>brown</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useCreateQueries: (
     store: Store<Schemas>,
@@ -5939,7 +6046,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -5987,7 +6093,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>0</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useQueries: (id?: Id) => Queries<Schemas> | undefined;
 
@@ -6015,7 +6121,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -6113,7 +6218,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>{"fido":{"color":"brown"},"cujo":{"color":"black"}}</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useResultTable: (
     queryId: Id,
@@ -6144,7 +6249,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -6243,7 +6347,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>["fido","cujo"]</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useResultRowIds: (
     queryId: Id,
@@ -6278,7 +6382,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -6405,7 +6508,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>["cujo","fido"]</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useResultSortedRowIds: (
     queryId: Id,
@@ -6441,7 +6544,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -6543,7 +6645,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>{"color":"brown"}</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useResultRow: (
     queryId: Id,
@@ -6576,7 +6678,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -6684,7 +6785,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>["species","color"]</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useResultCellIds: (
     queryId: Id,
@@ -6718,7 +6819,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -6822,7 +6922,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>brown</span>'
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useResultCell: (
     queryId: Id,
@@ -6859,7 +6959,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -6911,7 +7010,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> 0
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useResultTableListener: (
     queryId: IdOrNull,
@@ -6948,7 +7047,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -7000,7 +7098,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> 0
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useResultRowIdsListener: (
     queryId: IdOrNull,
@@ -7038,7 +7136,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -7100,7 +7197,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> 0
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useResultSortedRowIdsListener: (
     queryId: Id,
@@ -7147,7 +7244,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -7200,7 +7296,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> 0
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useResultRowListener: (
     queryId: IdOrNull,
@@ -7241,7 +7337,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -7297,7 +7392,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> 0
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useResultCellIdsListener: (
     queryId: IdOrNull,
@@ -7342,7 +7437,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -7397,7 +7491,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> 0
  * ```
  * @category Queries hooks
- * @since v2.0
+ * @since v2.0.0
  */
   useResultCellListener: (
     queryId: IdOrNull,
@@ -7440,7 +7534,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -7537,7 +7630,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -7618,7 +7710,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -7726,7 +7817,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -7842,7 +7932,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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).
@@ -7922,7 +8011,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -7978,7 +8066,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -8057,7 +8144,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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).
@@ -8130,7 +8216,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -8184,7 +8269,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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.
@@ -8246,7 +8330,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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`
@@ -8326,7 +8409,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -8420,7 +8502,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -8539,7 +8620,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
 
   /**
  * The ExtraProps type represents a set of arbitrary additional props.
- *
  * @category Props
  */
   ExtraProps: ExtraProps;
@@ -8547,7 +8627,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
   /**
  * TablesProps props are used for components that refer to all the Tables in a
  * Store, such as the TablesView component.
- *
  * @category Props
  */
   TablesProps: TablesProps<Schemas>;
@@ -8555,7 +8634,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
   /**
  * TableProps props are used for components that refer to a single Table in a
  * Store, such as the TableView component.
- *
  * @category Props
  */
   TableProps: TableProps<Schemas>;
@@ -8563,16 +8641,14 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
   /**
  * 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
  */
   SortedTableProps: SortedTableProps<Schemas>;
 
   /**
  * RowProps props are used for components that refer to a single Row in a Table,
  * such as the RowView component.
- *
  * @category Props
  */
   RowProps: RowProps<Schemas>;
@@ -8580,7 +8656,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
   /**
  * CellProps props are used for components that refer to a single Cell in a Row,
  * such as the CellView component.
- *
  * @category Props
  */
   CellProps: CellProps<Schemas>;
@@ -8588,25 +8663,22 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
   /**
  * 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
  */
   ValuesProps: ValuesProps<Schemas>;
 
   /**
  * 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
  */
   ValueProps: ValueProps<Schemas>;
 
   /**
  * MetricProps props are used for components that refer to a single Metric in a
  * Metrics object, such as the MetricView component.
- *
  * @category Props
  */
   MetricProps: MetricProps<Schemas>;
@@ -8614,7 +8686,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
   /**
  * IndexProps props are used for components that refer to a single Index in an
  * Indexes object, such as the IndexView component.
- *
  * @category Props
  */
   IndexProps: IndexProps<Schemas>;
@@ -8622,7 +8693,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
   /**
  * SliceProps props are used for components that refer to a single Slice in an
  * Index object, such as the SliceView component.
- *
  * @category Props
  */
   SliceProps: SliceProps<Schemas>;
@@ -8631,7 +8701,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
  */
   RemoteRowProps: RemoteRowProps<Schemas>;
@@ -8640,7 +8709,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
  */
   LocalRowsProps: LocalRowsProps<Schemas>;
@@ -8649,7 +8717,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
  */
   LinkedRowsProps: LinkedRowsProps<Schemas>;
@@ -8657,43 +8724,38 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
   /**
  * 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
  */
   ResultTableProps: ResultTableProps<Schemas>;
 
   /**
  * 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
  */
   ResultSortedTableProps: ResultSortedTableProps<Schemas>;
 
   /**
  * 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
  */
   ResultRowProps: ResultRowProps<Schemas>;
 
   /**
  * 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
  */
   ResultCellProps: ResultCellProps<Schemas>;
 
   /**
  * CheckpointProps props are used for components that refer to a single
  * checkpoint in a Checkpoints object, such as the CheckpointView component.
- *
  * @category Props
  */
   CheckpointProps: CheckpointProps<Schemas>;
@@ -8702,7 +8764,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
  */
   BackwardCheckpointsProps: BackwardCheckpointsProps<Schemas>;
@@ -8711,7 +8772,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * CurrentCheckpointsProps props are used for components that refer to the
  * current checkpoints in a Checkpoints object, such as the
  * BackwardCheckpointsView component.
- *
  * @category Props
  */
   CurrentCheckpointProps: CurrentCheckpointProps<Schemas>;
@@ -8720,7 +8780,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
  */
   ForwardCheckpointsProps: ForwardCheckpointsProps<Schemas>;
@@ -8733,7 +8792,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
  */
   ProviderProps: ProviderProps<Schemas>;
@@ -8741,7 +8799,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
   /**
  * ComponentReturnType is a simple alias for what a React component can return:
  * either a ReactElement, or `null` for an empty component.
- *
  * @category Component
  */
   ComponentReturnType: ReactElement<any, any> | null;
@@ -8770,7 +8827,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -8876,7 +8932,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -8978,7 +9033,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -9099,7 +9153,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -9203,7 +9256,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<div><span>felix: cat</span><span><b>fido</b>: dog</span></div>'
  * ```
  * @category Store components
- * @since v2.0
+ * @since v2.0.0
  */
   SortedTableView: (props: SortedTableProps<Schemas>) => ComponentReturnType;
 
@@ -9233,7 +9286,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -9348,7 +9400,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -9460,7 +9511,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -9532,7 +9582,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span></span>'
  * ```
  * @category Store components
- * @since v3.0
+ * @since v3.0.0
  */
   ValueView: (props: ValueProps<Schemas>) => ComponentReturnType;
 
@@ -9562,7 +9612,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -9644,7 +9693,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<div><span><b>open</b>: true</span><span>employees: 3</span></div>'
  * ```
  * @category Store components
- * @since v3.0
+ * @since v3.0.0
  */
   ValuesView: (props: ValuesProps<Schemas>) => ComponentReturnType;
 
@@ -9664,7 +9713,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -9781,7 +9829,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -9914,7 +9961,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -10043,7 +10089,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -10183,7 +10228,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -10324,7 +10368,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -10467,7 +10510,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -10570,7 +10612,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span></span>'
  * ```
  * @category Queries components
- * @since v2.0
+ * @since v2.0.0
  */
   ResultCellView: (props: ResultCellProps<Schemas>) => ComponentReturnType;
 
@@ -10602,7 +10644,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -10723,7 +10764,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<div><span><b>species</b>: dog</span><span>color: brown</span></div>'
  * ```
  * @category Queries components
- * @since v2.0
+ * @since v2.0.0
  */
   ResultRowView: (props: ResultRowProps<Schemas>) => ComponentReturnType;
 
@@ -10758,7 +10799,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -10869,7 +10909,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<div><span>felix: black</span><span><b>fido</b>: brown</span></div>'
  * ```
  * @category Queries components
- * @since v2.0
+ * @since v2.0.0
  */
   ResultSortedTableView: (
     props: ResultSortedTableProps<Schemas>,
@@ -10899,7 +10939,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -11000,7 +11039,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<div><span><b>fido</b>: brown</span><span>felix: black</span></div>'
  * ```
  * @category Queries components
- * @since v2.0
+ * @since v2.0.0
  */
   ResultTableView: (props: ResultTableProps<Schemas>) => ComponentReturnType;
 
@@ -11022,7 +11061,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * 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
@@ -11087,7 +11125,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -11231,7 +11268,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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
@@ -11377,7 +11413,6 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * 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