tinybase 2.0.0-beta.2 → 2.0.0-beta.3

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

@@ -427,9 +427,6 @@ export function useTables(storeOrStoreId?: StoreOrStoreId): Tables;
  * @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.
- * @param trackReorder Since v2.0.0, an optional boolean that indicates that the
- * listener should be called if the set of Ids remains the same but their order
- * changes. See the addTableIdsListener method for more details.
  * @returns An array of the Ids of every Table in the Store.
  * @example
  * This example creates a Store outside the application, which is used in the
@@ -487,10 +484,7 @@ export function useTables(storeOrStoreId?: StoreOrStoreId): Tables;
  * ```
  * @category Store hooks
  */
-export function useTableIds(
-  storeOrStoreId?: StoreOrStoreId,
-  trackReorder?: boolean,
-): Ids;
+export function useTableIds(storeOrStoreId?: StoreOrStoreId): Ids;
 
 /**
  * The useTable hook returns an object containing the entire data of a single
@@ -591,9 +585,6 @@ export function useTable(tableId: Id, storeOrStoreId?: StoreOrStoreId): Table;
  * @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.
- * @param trackReorder Since v2.0.0, an optional boolean that indicates that the
- * listener should be called if the set of Ids remains the same but their order
- * changes. See the addRowIdsListener method for more details.
  * @returns An array of the Ids of every Row in the Table.
  * @example
  * This example creates a Store outside the application, which is used in the
@@ -653,16 +644,12 @@ export function useTable(tableId: Id, storeOrStoreId?: StoreOrStoreId): Table;
  * ```
  * @category Store hooks
  */
-export function useRowIds(
-  tableId: Id,
-  storeOrStoreId?: StoreOrStoreId,
-  trackReorder?: boolean,
-): Ids;
+export function useRowIds(tableId: Id, storeOrStoreId?: StoreOrStoreId): Ids;
 
 /**
- * The useSortedRowIds hook returns the sorted Ids of every Row in a given
- * Table, and registers a listener so that any changes to that result will cause
- * a re-render.
+ * The useSortedRowIds hook returns the sorted (and optionally, paginated) Ids
+ * of every Row in a given 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
@@ -678,6 +665,8 @@ export function useRowIds(
  * @param cellId The Id of the Cell whose values are used for the sorting, or
  * `undefined` to by sort the Row Id itself.
  * @param descending Whether the sorting should be in descending order.
+ * @param offset The number of Row Ids to skip for pagination purposes, if any.
+ * @param limit The maximum number of Row Ids to return, or `undefined` for all.
  * @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.
@@ -696,7 +685,9 @@ export function useRowIds(
  * });
  * const App = () => (
  *   <span>
- *     {JSON.stringify(useSortedRowIds('pets', 'species', false, store))}
+ *     {JSON.stringify(
+ *       useSortedRowIds('pets', 'species', false, 0, undefined, store),
+ *     )}
  *   </span>
  * );
  *
@@ -744,7 +735,9 @@ export function useRowIds(
  * );
  * const Pane = () => (
  *   <span>
- *     {JSON.stringify(useSortedRowIds('pets', 'species', false, 'petStore'))}
+ *     {JSON.stringify(
+ *       useSortedRowIds('pets', 'species', false, 0, undefined, 'petStore'),
+ *     )}
  *   </span>
  * );
  *
@@ -766,6 +759,8 @@ export function useSortedRowIds(
   tableId: Id,
   cellId?: Id,
   descending?: boolean,
+  offset?: number,
+  limit?: number,
   storeOrStoreId?: StoreOrStoreId,
 ): Ids;
 
@@ -876,9 +871,6 @@ export function useRow(
  * @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.
- * @param trackReorder Since v2.0.0, an optional boolean that indicates that the
- * listener should be called if the set of Ids remains the same but their order
- * changes. See the addCellIdsListener method for more details.
  * @returns An array of the Ids of every Cell in the Row.
  * @example
  * This example creates a Store outside the application, which is used in the
@@ -946,7 +938,6 @@ export function useCellIds(
   tableId: Id,
   rowId: Id,
   storeOrStoreId?: StoreOrStoreId,
-  trackReorder?: boolean,
 ): Ids;
 
 /**
@@ -1953,9 +1944,6 @@ export function useTablesListener(
  * @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 trackReorder Since v2.0.0, an optional boolean that indicates that the
- * listener should be called if the set of Ids remains the same but their order
- * changes. See the addTableIdsListener method for more details.
  * @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
@@ -1995,7 +1983,6 @@ export function useTablesListener(
 export function useTableIdsListener(
   listener: TableIdsListener,
   listenerDeps?: React.DependencyList,
-  trackReorder?: boolean,
   mutator?: boolean,
   storeOrStoreId?: StoreOrStoreId,
 ): void;
@@ -2088,9 +2075,6 @@ export function useTableListener(
  * @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 trackReorder Since v2.0.0, an optional boolean that indicates that the
- * listener should be called if the set of Ids remains the same but their order
- * changes. See the addRowIdsListener method for more details.
  * @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
@@ -2131,14 +2115,14 @@ export function useRowIdsListener(
   tableId: IdOrNull,
   listener: RowIdsListener,
   listenerDeps?: React.DependencyList,
-  trackReorder?: boolean,
   mutator?: boolean,
   storeOrStoreId?: StoreOrStoreId,
 ): void;
 
 /**
  * The useSortedRowIdsListener hook registers a listener function with a Store
- * that will be called whenever the sorted Row Ids in a Table change.
+ * that will be called whenever sorted (and optionally, paginated) Row Ids 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
@@ -2154,6 +2138,8 @@ export function useRowIdsListener(
  * @param cellId The Id of the Cell whose values are used for the sorting, or
  * `undefined` to by sort the Row Id itself.
  * @param descending Whether the sorting should be in descending order.
+ * @param offset The number of Row Ids to skip for pagination purposes, if any.
+ * @param limit The maximum number of Row Ids to return, or `undefined` for all.
  * @param listener The function that will be called whenever the sorted Row Ids
  * in the Table change.
  * @param listenerDeps An optional array of dependencies for the `listener`
@@ -2176,7 +2162,7 @@ export function useRowIdsListener(
  *   </Provider>
  * );
  * const Pane = () => {
- *   useSortedRowIdsListener('pets', 'species', false, () =>
+ *   useSortedRowIdsListener('pets', 'species', false, 0, undefined, () =>
  *     console.log('Sorted Row Ids changed'),
  *   );
  *   return <span>App</span>;
@@ -2206,6 +2192,8 @@ export function useSortedRowIdsListener(
   tableId: Id,
   cellId: Id | undefined,
   descending: boolean,
+  offset: number,
+  limit: number | undefined,
   listener: SortedRowIdsListener,
   listenerDeps?: React.DependencyList,
   mutator?: boolean,
@@ -2316,9 +2304,6 @@ export function useRowListener(
  * @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 trackReorder Since v2.0.0, an optional boolean that indicates that the
- * listener should be called if the set of Ids remains the same but their order
- * changes. See the addCellIdsListener method for more details.
  * @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
@@ -2362,7 +2347,6 @@ export function useCellIdsListener(
   rowId: IdOrNull,
   listener: CellIdsListener,
   listenerDeps?: React.DependencyList,
-  trackReorder?: boolean,
   mutator?: boolean,
   storeOrStoreId?: StoreOrStoreId,
 ): void;
@@ -4462,8 +4446,6 @@ export function useResultTable(
  * @param queriesOrQueriesId The Queries object to be accessed: omit for the
  * default context Queries object, provide an Id for a named context Queries
  * object, or provide an explicit reference.
- * @param trackReorder An optional boolean that indicates that the listener
- * should be called if the set of Ids remains the same but their order changes.
  * See the addResultRowIdsListener method for more details.
  * @returns An array of the Ids of every Row in the result of the query.
  * @example
@@ -4562,13 +4544,12 @@ export function useResultTable(
 export function useResultRowIds(
   queryId: Id,
   queriesOrQueriesId?: QueriesOrQueriesId,
-  trackReorder?: boolean,
 ): Ids;
 
 /**
- * The useResultSortedRowIds hook returns the sorted Ids of every Row in the
- * result Table of the given query, and registers a listener so that any changes
- * to those Ids will cause a re-render.
+ * The useResultSortedRowIds hook returns the sorted (and optionally, paginated)
+ * Ids of every Row in the result Table of the given query, and registers a
+ * listener so that any changes to those Ids 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 Queries object or a set of Queries objects named by
@@ -4585,6 +4566,8 @@ export function useResultRowIds(
  * @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.
  * @param descending Whether the sorting should be in descending order.
+ * @param offset The number of Row Ids to skip for pagination purposes, if any.
+ * @param limit The maximum number of Row Ids to return, or `undefined` for all.
  * @param queriesOrQueriesId The Queries object to be accessed: omit for the
  * default context Queries object, provide an Id for a named context Queries
  * object, or provide an explicit reference.
@@ -4611,7 +4594,14 @@ export function useResultRowIds(
  * const App = () => (
  *   <span>
  *     {JSON.stringify(
- *       useResultSortedRowIds('dogColors', 'color', false, queries),
+ *       useResultSortedRowIds(
+ *         'dogColors',
+ *         'color',
+ *         false,
+ *         0,
+ *         undefined,
+ *         queries,
+ *       ),
  *     )}
  *   </span>
  * );
@@ -4637,7 +4627,7 @@ export function useResultRowIds(
  * );
  * const Pane = () => (
  *   <span>
- *     {JSON.stringify(useResultSortedRowIds('dogColors', 'color', false))}
+ *     {JSON.stringify(useResultSortedRowIds('dogColors', 'color'))}
  *   </span>
  * );
  *
@@ -4670,7 +4660,14 @@ export function useResultRowIds(
  * const Pane = () => (
  *   <span>
  *     {JSON.stringify(
- *       useResultSortedRowIds('dogColors', 'color', false, 'petQueries'),
+ *       useResultSortedRowIds(
+ *         'dogColors',
+ *         'color',
+ *         false,
+ *         0,
+ *         undefined,
+ *         'petQueries',
+ *       ),
  *     )}
  *   </span>
  * );
@@ -4696,6 +4693,8 @@ export function useResultSortedRowIds(
   queryId: Id,
   cellId?: Id,
   descending?: boolean,
+  offset?: number,
+  limit?: number,
   queriesOrQueriesId?: QueriesOrQueriesId,
 ): Ids;
 
@@ -5180,9 +5179,6 @@ export function useResultTableListener(
  * @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 trackReorder An optional boolean that indicates that the listener
- * should be called if the set of Ids remains the same but their order changes.
- * See the addResultRowIdsListener method for more details.
  * @param queriesOrQueriesId The Queries object to register the listener with:
  * omit for the default context Queries object, provide an Id for a named
  * context Queries object, or provide an explicit reference.
@@ -5232,14 +5228,13 @@ export function useResultRowIdsListener(
   queryId: IdOrNull,
   listener: ResultRowIdsListener,
   listenerDeps?: React.DependencyList,
-  trackReorder?: boolean,
   queriesOrQueriesId?: QueriesOrQueriesId,
 ): void;
 
 /**
  * The useResultSortedRowIdsListener hook registers a listener function with a
- * Queries object that will be called whenever the sorted Row Ids in a result
- * Table change.
+ * Queries object that will be called whenever the sorted (and optionally,
+ * paginated) Row Ids in a result 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
@@ -5255,6 +5250,8 @@ export function useResultRowIdsListener(
  * @param cellId The Id of the Cell whose values are used for the sorting, or
  * `undefined` to by sort the Row Id itself.
  * @param descending Whether the sorting should be in descending order.
+ * @param offset The number of Row Ids to skip for pagination purposes, if any.
+ * @param limit The maximum number of Row Ids to return, or `undefined` for all.
  * @param listener The function that will be called whenever the Row Ids in the
  * matching result Table change.
  * @param listenerDeps An optional array of dependencies for the `listener`
@@ -5275,8 +5272,13 @@ export function useResultRowIdsListener(
  *   </Provider>
  * );
  * const Pane = () => {
- *   useResultSortedRowIdsListener('petColors', 'color', false, () =>
- *     console.log('Sorted result Row Ids changed'),
+ *   useResultSortedRowIdsListener(
+ *     'petColors',
+ *     'color',
+ *     false,
+ *     0,
+ *     undefined,
+ *     () => console.log('Sorted result Row Ids changed'),
  *   );
  *   return <span>App</span>;
  * };
@@ -5309,6 +5311,8 @@ export function useResultSortedRowIdsListener(
   queryId: Id,
   cellId: Id | undefined,
   descending: boolean,
+  offset: number,
+  limit: number | undefined,
   listener: ResultRowIdsListener,
   listenerDeps?: React.DependencyList,
   queriesOrQueriesId?: QueriesOrQueriesId,
@@ -6567,12 +6571,6 @@ export type TablesProps = {
    * for a named context Store, or provide an explicit reference.
    */
   readonly store?: StoreOrStoreId;
-  /**
-   * An optional boolean that indicates that the component should re-render if
-   * the set of Table Ids in the Store remains the same but their order changes.
-   * See the addTableIdsListener method for more details.
-   */
-  readonly trackReorder?: boolean;
   /**
    * A component for rendering each Table in the Store (to override the default
    * TableView component).
@@ -6610,12 +6608,6 @@ export type TableProps = {
    * for a named context Store, or provide an explicit reference.
    */
   readonly store?: StoreOrStoreId;
-  /**
-   * An optional boolean that indicates that the component should re-render if
-   * the set of Row Ids in the Table remains the same but their order changes.
-   * See the addRowIdsListener method for more details.
-   */
-  readonly trackReorder?: boolean;
   /**
    * A custom component for rendering each Row in the Table (to override the
    * default RowView component).
@@ -6658,6 +6650,14 @@ export type SortedTableProps = {
    * Whether the sorting should be in descending order.
    */
   readonly descending?: boolean;
+  /**
+   * The number of Row Ids to skip for pagination purposes.
+   */
+  readonly offset?: number;
+  /**
+   * The maximum number of Row Ids to return.
+   */
+  readonly limit?: number;
   /**
    * The Store to be accessed: omit for the default context Store, provide an Id
    * for a named context Store, or provide an explicit reference.
@@ -6704,12 +6704,6 @@ export type RowProps = {
    * for a named context Store, or provide an explicit reference.
    */
   readonly store?: StoreOrStoreId;
-  /**
-   * An optional boolean that indicates that the component should re-render if
-   * the set of Cell Ids remains the same but their order changes. See the
-   * addCellIdsListener method for more details.
-   */
-  readonly trackReorder?: boolean;
   /**
    * A custom component for rendering each Cell in the Row (to override the
    * default CellView component).
@@ -7009,12 +7003,6 @@ export type ResultTableProps = {
    * explicit reference.
    */
   readonly queries?: QueriesOrQueriesId;
-  /**
-   * An optional boolean that indicates that the component should re-render if
-   * the set of Row Ids in the result Table remains the same but their order
-   * changes. See the addResultRowIdsListener method for more details.
-   */
-  readonly trackReorder?: boolean;
   /**
    * A custom component for rendering each Row in the Table (to override the
    * default ResultRowView component).
@@ -7058,6 +7046,14 @@ export type ResultSortedTableProps = {
    * Whether the sorting should be in descending order.
    */
   readonly descending?: boolean;
+  /**
+   * The number of Row Ids to skip for pagination purposes.
+   */
+  readonly offset?: number;
+  /**
+   * The maximum number of Row Ids to return.
+   */
+  readonly limit?: number;
   /**
    * The Queries object to be accessed: omit for the default context Queries
    * object, provide an Id for a named context Queries object, or provide an
@@ -7678,7 +7674,9 @@ export function RowView(props: RowProps): ComponentReturnType;
  * The component's props identify which Table to render based on Table Id, and
  * Store (which is either the default context Store, a named context Store, or
  * by explicit reference). It also takes a Cell Id to sort by and a boolean to
- * indicate that the sorting should be in descending order.
+ * indicate that the sorting should be in descending order. The `offset` and
+ * `limit` props are used to paginate results, but default to `0` and
+ * `undefined` to return all available Row Ids if not specified.
  *
  * This component renders a Table by iterating over its Row objects, in the
  * order dictated by the sort parameters. By default these are in turn rendered
@@ -9048,7 +9046,9 @@ export function ResultRowView(props: ResultRowProps): ComponentReturnType;
  * Queries object (which is either the default context Queries object, a named
  * context Queries object, or by explicit reference). It also takes a Cell Id to
  * sort by and a boolean to indicate that the sorting should be in descending
- * order.
+ * order. The `offset` and `limit` props are used to paginate results, but
+ * default to `0` and `undefined` to return all available Row Ids if not
+ * specified.
  *
  * This component renders a result Table by iterating over its Row objects, in
  * the order dictated by the sort parameters. By default these are in turn