tinybase 5.0.1 → 5.0.3

package/@types/ui-react/index.d.cts

@@ -2684,7 +2684,7 @@ export function useSetTablesCallback<Parameter>(
  * @param getTableDeps An optional array of dependencies for the `getTable`
  * function, which, if any change, result in the regeneration of the callback.
  * This parameter defaults to an empty array. Also use this to indicate the
- * dependencies of a GetId functions if used as the tableId argument.
+ * dependencies of a GetId function if used as the tableId argument.
  * @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.
@@ -2882,7 +2882,7 @@ export function useSetRowCallback<Parameter>(
  * @param getRowDeps An optional array of dependencies for the `getRow`
  * function, which, if any change, result in the regeneration of the callback.
  * This parameter defaults to an empty array. Also use this to indicate the
- * dependencies of a GetId functions if used as the tableId argument.
+ * dependencies of a GetId function if used as the tableId argument.
  * @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.
@@ -3466,7 +3466,7 @@ export function useSetValueCallback<Parameter>(
  * all of the tabular data in a Store.
  *
  * This hook is useful, for example, when creating an event handler that will
- * delete data in a Store.
+ * delete data in the Store.
  *
  * For convenience, you can optionally provide a `then` function (with its own
  * set of dependencies) which will be called just after the Store has been
@@ -3530,11 +3530,12 @@ export function useDelTablesCallback(
 ): Callback;
 
 /**
- * The useDelTableCallback hook returns a callback that can be used to remove a
- * single Table from a Store.
+ * The useDelTableCallback hook returns a parameterized callback that can be
+ * used to remove a single Table from a Store.
  *
  * This hook is useful, for example, when creating an event handler that will
- * delete data in a Store.
+ * delete data in the Store. In this case, the parameter will likely be the
+ * event, so that you can use data from it as part of the deletion.
  *
  * For convenience, you can optionally provide a `then` function (with its own
  * set of dependencies) which will be called just after the Store has been
@@ -3544,7 +3545,8 @@ export function useDelTablesCallback(
  * The Store to which the callback will make the deletion (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- * @param tableId The Id of the Table in the Store.
+ * @param tableId The Id of the Table in the Store to delete, or a GetId
+ * function that will return it.
  * @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.
@@ -3552,8 +3554,9 @@ export function useDelTablesCallback(
  * to the Store.
  * @param thenDeps An optional array of dependencies for the `then` function,
  * which, if any change, result in the regeneration of the callback. This
- * parameter defaults to an empty array.
- * @returns A callback for subsequent use.
+ * parameter defaults to an empty array. Also use this to indicate the
+ * dependencies of an GetId function if used as the tableId argument.
+ * @returns A parameterized callback for subsequent use.
  * @example
  * This example uses the useDelTableCallback hook to create an event handler
  * which deletes from the Store when the `span` element is clicked.
@@ -3592,19 +3595,20 @@ export function useDelTablesCallback(
  * @category Store hooks
  * @since v1.0.0
  */
-export function useDelTableCallback(
-  tableId: Id,
+export function useDelTableCallback<Parameter>(
+  tableId: Id | GetId<Parameter>,
   storeOrStoreId?: StoreOrStoreId,
   then?: (store: Store) => void,
   thenDeps?: React.DependencyList,
-): Callback;
+): ParameterizedCallback<Parameter>;
 
 /**
- * The useDelRowCallback hook returns a callback that can be used to remove a
- * single Row from a Table.
+ * The useDelRowCallback hook returns a parameterized callback that can be used
+ * to remove a single Row from a Table.
  *
  * This hook is useful, for example, when creating an event handler that will
- * delete data in a Store.
+ * delete data in the Store. In this case, the parameter will likely be the
+ * event, so that you can use data from it as part of the deletion.
  *
  * For convenience, you can optionally provide a `then` function (with its own
  * set of dependencies) which will be called just after the Store has been
@@ -3614,8 +3618,10 @@ export function useDelTableCallback(
  * The Store to which the callback will make the deletion (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- * @param tableId The Id of the Table in the Store.
- * @param rowId The Id of the Row in the Table.
+ * @param tableId The Id of the Table in the Store, or a GetId function that
+ * will return it.
+ * @param rowId The Id of the Row in the Table to delete, or a GetId function
+ * that will return it.
  * @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.
@@ -3623,8 +3629,10 @@ export function useDelTableCallback(
  * to the Store.
  * @param thenDeps An optional array of dependencies for the `then` function,
  * which, if any change, result in the regeneration of the callback. This
- * parameter defaults to an empty array.
- * @returns A callback for subsequent use.
+ * parameter defaults to an empty array. Also use this to indicate the
+ * dependencies of any GetId functions if used as the tableId or rowId
+ * arguments.
+ * @returns A parameterized callback for subsequent use.
  * @example
  * This example uses the useDelRowCallback hook to create an event handler which
  * deletes from the Store when the `span` element is clicked.
@@ -3663,20 +3671,21 @@ export function useDelTableCallback(
  * @category Store hooks
  * @since v1.0.0
  */
-export function useDelRowCallback(
-  tableId: Id,
-  rowId: Id,
+export function useDelRowCallback<Parameter>(
+  tableId: Id | GetId<Parameter>,
+  rowId: Id | GetId<Parameter>,
   storeOrStoreId?: StoreOrStoreId,
   then?: (store: Store) => void,
   thenDeps?: React.DependencyList,
-): Callback;
+): ParameterizedCallback<Parameter>;
 
 /**
- * The useDelCellCallback hook returns a callback that can be used to remove a
- * single Cell from a Row.
+ * The useDelCellCallback hook returns a parameterized callback that can be used
+ * to remove a single Cell from a Row.
  *
  * This hook is useful, for example, when creating an event handler that will
- * delete data in a Store.
+ * delete data in the Store. In this case, the parameter will likely be the
+ * event, so that you can use data from it as part of the deletion.
  *
  * For convenience, you can optionally provide a `then` function (with its own
  * set of dependencies) which will be called just after the Store has been
@@ -3686,9 +3695,12 @@ export function useDelRowCallback(
  * The Store to which the callback will make the deletion (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- * @param tableId The Id of the Table in the Store.
- * @param rowId The Id of the Row in the Table.
- * @param cellId The Id of the Cell in the Row.
+ * @param tableId The Id of the Table in the Store, or a GetId function that
+ * will return it.
+ * @param rowId The Id of the Row in the Table, or a GetId function that will
+ * return it.
+ * @param cellId The Id of the Cell in the Row to delete, or a GetId function
+ * that will return it.
  * @param forceDel An optional flag to indicate that the whole Row should be
  * deleted, even if a TablesSchema provides a default value for this Cell.
  * Defaults to `false`.
@@ -3699,8 +3711,10 @@ export function useDelRowCallback(
  * to the Store.
  * @param thenDeps An optional array of dependencies for the `then` function,
  * which, if any change, result in the regeneration of the callback. This
- * parameter defaults to an empty array.
- * @returns A callback for subsequent use.
+ * parameter defaults to an empty array. Also use this to indicate the
+ * dependencies of any GetId functions if used as the tableId, rowId, or cellId
+ * arguments.
+ * @returns A parameterized callback for subsequent use.
  * @example
  * This example uses the useDelCellCallback hook to create an event handler
  * which deletes from the Store when the `span` element is clicked.
@@ -3744,15 +3758,15 @@ export function useDelRowCallback(
  * @category Store hooks
  * @since v1.0.0
  */
-export function useDelCellCallback(
-  tableId: Id,
-  rowId: Id,
-  cellId: Id,
+export function useDelCellCallback<Parameter>(
+  tableId: Id | GetId<Parameter>,
+  rowId: Id | GetId<Parameter>,
+  cellId: Id | GetId<Parameter>,
   forceDel?: boolean,
   storeOrStoreId?: StoreOrStoreId,
   then?: (store: Store) => void,
   thenDeps?: React.DependencyList,
-): Callback;
+): ParameterizedCallback<Parameter>;
 
 /**
  * The useDelValuesCallback hook returns a callback that can be used to remove
@@ -3823,11 +3837,12 @@ export function useDelValuesCallback(
 ): Callback;
 
 /**
- * The useDelValueCallback hook returns a callback that can be used to remove a
- * single Value from a Store.
+ * The useDelValueCallback hook returns a parameterized callback that can be
+ * used to remove a single Value from a Store.
  *
  * This hook is useful, for example, when creating an event handler that will
- * delete data in a Store.
+ * delete data in the Store. In this case, the parameter will likely be the
+ * event, so that you can use data from it as part of the deletion.
  *
  * For convenience, you can optionally provide a `then` function (with its own
  * set of dependencies) which will be called just after the Store has been
@@ -3837,7 +3852,8 @@ export function useDelValuesCallback(
  * The Store to which the callback will make the deletion (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- * @param valueId The Id of the Value in the Store.
+ * @param valueId The Id of the Value in the Store to delete, or a GetId
+ * function that will return it.
  * @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.
@@ -3845,8 +3861,9 @@ export function useDelValuesCallback(
  * to the Store.
  * @param thenDeps An optional array of dependencies for the `then` function,
  * which, if any change, result in the regeneration of the callback. This
- * parameter defaults to an empty array.
- * @returns A callback for subsequent use.
+ * parameter defaults to an empty array. Also use this to indicate the
+ * dependencies of a GetId function if used as the valueId argument.
+ * @returns A parameterized callback for subsequent use.
  * @example
  * This example uses the useDelValueCallback hook to create an event handler
  * which deletes from the Store when the `span` element is clicked.
@@ -3885,12 +3902,12 @@ export function useDelValuesCallback(
  * @category Store hooks
  * @since v3.0.0
  */
-export function useDelValueCallback(
-  valueId: Id,
+export function useDelValueCallback<Parameter>(
+  valueId: Id | GetId<Parameter>,
   storeOrStoreId?: StoreOrStoreId,
   then?: (store: Store) => void,
   thenDeps?: React.DependencyList,
-): Callback;
+): ParameterizedCallback<Parameter>;
 
 /**
  * The useHasTablesListener hook registers a listener function with the Store

package/@types/ui-react/index.d.ts

@@ -2684,7 +2684,7 @@ export function useSetTablesCallback<Parameter>(
  * @param getTableDeps An optional array of dependencies for the `getTable`
  * function, which, if any change, result in the regeneration of the callback.
  * This parameter defaults to an empty array. Also use this to indicate the
- * dependencies of a GetId functions if used as the tableId argument.
+ * dependencies of a GetId function if used as the tableId argument.
  * @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.
@@ -2882,7 +2882,7 @@ export function useSetRowCallback<Parameter>(
  * @param getRowDeps An optional array of dependencies for the `getRow`
  * function, which, if any change, result in the regeneration of the callback.
  * This parameter defaults to an empty array. Also use this to indicate the
- * dependencies of a GetId functions if used as the tableId argument.
+ * dependencies of a GetId function if used as the tableId argument.
  * @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.
@@ -3466,7 +3466,7 @@ export function useSetValueCallback<Parameter>(
  * all of the tabular data in a Store.
  *
  * This hook is useful, for example, when creating an event handler that will
- * delete data in a Store.
+ * delete data in the Store.
  *
  * For convenience, you can optionally provide a `then` function (with its own
  * set of dependencies) which will be called just after the Store has been
@@ -3530,11 +3530,12 @@ export function useDelTablesCallback(
 ): Callback;
 
 /**
- * The useDelTableCallback hook returns a callback that can be used to remove a
- * single Table from a Store.
+ * The useDelTableCallback hook returns a parameterized callback that can be
+ * used to remove a single Table from a Store.
  *
  * This hook is useful, for example, when creating an event handler that will
- * delete data in a Store.
+ * delete data in the Store. In this case, the parameter will likely be the
+ * event, so that you can use data from it as part of the deletion.
  *
  * For convenience, you can optionally provide a `then` function (with its own
  * set of dependencies) which will be called just after the Store has been
@@ -3544,7 +3545,8 @@ export function useDelTablesCallback(
  * The Store to which the callback will make the deletion (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- * @param tableId The Id of the Table in the Store.
+ * @param tableId The Id of the Table in the Store to delete, or a GetId
+ * function that will return it.
  * @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.
@@ -3552,8 +3554,9 @@ export function useDelTablesCallback(
  * to the Store.
  * @param thenDeps An optional array of dependencies for the `then` function,
  * which, if any change, result in the regeneration of the callback. This
- * parameter defaults to an empty array.
- * @returns A callback for subsequent use.
+ * parameter defaults to an empty array. Also use this to indicate the
+ * dependencies of an GetId function if used as the tableId argument.
+ * @returns A parameterized callback for subsequent use.
  * @example
  * This example uses the useDelTableCallback hook to create an event handler
  * which deletes from the Store when the `span` element is clicked.
@@ -3592,19 +3595,20 @@ export function useDelTablesCallback(
  * @category Store hooks
  * @since v1.0.0
  */
-export function useDelTableCallback(
-  tableId: Id,
+export function useDelTableCallback<Parameter>(
+  tableId: Id | GetId<Parameter>,
   storeOrStoreId?: StoreOrStoreId,
   then?: (store: Store) => void,
   thenDeps?: React.DependencyList,
-): Callback;
+): ParameterizedCallback<Parameter>;
 
 /**
- * The useDelRowCallback hook returns a callback that can be used to remove a
- * single Row from a Table.
+ * The useDelRowCallback hook returns a parameterized callback that can be used
+ * to remove a single Row from a Table.
  *
  * This hook is useful, for example, when creating an event handler that will
- * delete data in a Store.
+ * delete data in the Store. In this case, the parameter will likely be the
+ * event, so that you can use data from it as part of the deletion.
  *
  * For convenience, you can optionally provide a `then` function (with its own
  * set of dependencies) which will be called just after the Store has been
@@ -3614,8 +3618,10 @@ export function useDelTableCallback(
  * The Store to which the callback will make the deletion (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- * @param tableId The Id of the Table in the Store.
- * @param rowId The Id of the Row in the Table.
+ * @param tableId The Id of the Table in the Store, or a GetId function that
+ * will return it.
+ * @param rowId The Id of the Row in the Table to delete, or a GetId function
+ * that will return it.
  * @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.
@@ -3623,8 +3629,10 @@ export function useDelTableCallback(
  * to the Store.
  * @param thenDeps An optional array of dependencies for the `then` function,
  * which, if any change, result in the regeneration of the callback. This
- * parameter defaults to an empty array.
- * @returns A callback for subsequent use.
+ * parameter defaults to an empty array. Also use this to indicate the
+ * dependencies of any GetId functions if used as the tableId or rowId
+ * arguments.
+ * @returns A parameterized callback for subsequent use.
  * @example
  * This example uses the useDelRowCallback hook to create an event handler which
  * deletes from the Store when the `span` element is clicked.
@@ -3663,20 +3671,21 @@ export function useDelTableCallback(
  * @category Store hooks
  * @since v1.0.0
  */
-export function useDelRowCallback(
-  tableId: Id,
-  rowId: Id,
+export function useDelRowCallback<Parameter>(
+  tableId: Id | GetId<Parameter>,
+  rowId: Id | GetId<Parameter>,
   storeOrStoreId?: StoreOrStoreId,
   then?: (store: Store) => void,
   thenDeps?: React.DependencyList,
-): Callback;
+): ParameterizedCallback<Parameter>;
 
 /**
- * The useDelCellCallback hook returns a callback that can be used to remove a
- * single Cell from a Row.
+ * The useDelCellCallback hook returns a parameterized callback that can be used
+ * to remove a single Cell from a Row.
  *
  * This hook is useful, for example, when creating an event handler that will
- * delete data in a Store.
+ * delete data in the Store. In this case, the parameter will likely be the
+ * event, so that you can use data from it as part of the deletion.
  *
  * For convenience, you can optionally provide a `then` function (with its own
  * set of dependencies) which will be called just after the Store has been
@@ -3686,9 +3695,12 @@ export function useDelRowCallback(
  * The Store to which the callback will make the deletion (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- * @param tableId The Id of the Table in the Store.
- * @param rowId The Id of the Row in the Table.
- * @param cellId The Id of the Cell in the Row.
+ * @param tableId The Id of the Table in the Store, or a GetId function that
+ * will return it.
+ * @param rowId The Id of the Row in the Table, or a GetId function that will
+ * return it.
+ * @param cellId The Id of the Cell in the Row to delete, or a GetId function
+ * that will return it.
  * @param forceDel An optional flag to indicate that the whole Row should be
  * deleted, even if a TablesSchema provides a default value for this Cell.
  * Defaults to `false`.
@@ -3699,8 +3711,10 @@ export function useDelRowCallback(
  * to the Store.
  * @param thenDeps An optional array of dependencies for the `then` function,
  * which, if any change, result in the regeneration of the callback. This
- * parameter defaults to an empty array.
- * @returns A callback for subsequent use.
+ * parameter defaults to an empty array. Also use this to indicate the
+ * dependencies of any GetId functions if used as the tableId, rowId, or cellId
+ * arguments.
+ * @returns A parameterized callback for subsequent use.
  * @example
  * This example uses the useDelCellCallback hook to create an event handler
  * which deletes from the Store when the `span` element is clicked.
@@ -3744,15 +3758,15 @@ export function useDelRowCallback(
  * @category Store hooks
  * @since v1.0.0
  */
-export function useDelCellCallback(
-  tableId: Id,
-  rowId: Id,
-  cellId: Id,
+export function useDelCellCallback<Parameter>(
+  tableId: Id | GetId<Parameter>,
+  rowId: Id | GetId<Parameter>,
+  cellId: Id | GetId<Parameter>,
   forceDel?: boolean,
   storeOrStoreId?: StoreOrStoreId,
   then?: (store: Store) => void,
   thenDeps?: React.DependencyList,
-): Callback;
+): ParameterizedCallback<Parameter>;
 
 /**
  * The useDelValuesCallback hook returns a callback that can be used to remove
@@ -3823,11 +3837,12 @@ export function useDelValuesCallback(
 ): Callback;
 
 /**
- * The useDelValueCallback hook returns a callback that can be used to remove a
- * single Value from a Store.
+ * The useDelValueCallback hook returns a parameterized callback that can be
+ * used to remove a single Value from a Store.
  *
  * This hook is useful, for example, when creating an event handler that will
- * delete data in a Store.
+ * delete data in the Store. In this case, the parameter will likely be the
+ * event, so that you can use data from it as part of the deletion.
  *
  * For convenience, you can optionally provide a `then` function (with its own
  * set of dependencies) which will be called just after the Store has been
@@ -3837,7 +3852,8 @@ export function useDelValuesCallback(
  * The Store to which the callback will make the deletion (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- * @param valueId The Id of the Value in the Store.
+ * @param valueId The Id of the Value in the Store to delete, or a GetId
+ * function that will return it.
  * @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.
@@ -3845,8 +3861,9 @@ export function useDelValuesCallback(
  * to the Store.
  * @param thenDeps An optional array of dependencies for the `then` function,
  * which, if any change, result in the regeneration of the callback. This
- * parameter defaults to an empty array.
- * @returns A callback for subsequent use.
+ * parameter defaults to an empty array. Also use this to indicate the
+ * dependencies of a GetId function if used as the valueId argument.
+ * @returns A parameterized callback for subsequent use.
  * @example
  * This example uses the useDelValueCallback hook to create an event handler
  * which deletes from the Store when the `span` element is clicked.
@@ -3885,12 +3902,12 @@ export function useDelValuesCallback(
  * @category Store hooks
  * @since v3.0.0
  */
-export function useDelValueCallback(
-  valueId: Id,
+export function useDelValueCallback<Parameter>(
+  valueId: Id | GetId<Parameter>,
   storeOrStoreId?: StoreOrStoreId,
   then?: (store: Store) => void,
   thenDeps?: React.DependencyList,
-): Callback;
+): ParameterizedCallback<Parameter>;
 
 /**
  * The useHasTablesListener hook registers a listener function with the Store