tinybase 4.6.0-beta.0 → 4.6.0-beta.2

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

@@ -204,6 +204,17 @@ export type CheckpointsOrCheckpointsId = Checkpoints | Id;
  */
 export type UndoOrRedoInformation = [boolean, Callback, Id | undefined, string];
 
+/**
+ * The GetId type describes a function which, when passed a parameter, will
+ * return an Id.
+ *
+ * This type is used in hooks that create callbacks - like the
+ * useSetTableCallback hook or useSetRowCallback hook - so that the Id arguments
+ * of the object to set can also be dependent on the event or parameter
+ * provided (as well as the object itself being set).
+ */
+export type GetId<Parameter> = (parameter: Parameter, store: Store) => Id;
+
 /**
  * The useCreateStore hook is used to create a Store within a React application
  * with convenient memoization.
@@ -2279,13 +2290,15 @@ export function useSetTablesCallback<Parameter>(
  * The Store to which the callback will make the mutation (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- * @param tableId The Id of the Table in the Store to set.
+ * @param tableId The Id of the Table in the Store to set, or a GetId function
+ * that will return it.
  * @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
  * which is most likely a DOM event).
  * @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.
+ * This parameter defaults to an empty array. Also use this to indicate the
+ * dependencies of a GetId functions 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.
@@ -2332,7 +2345,7 @@ export function useSetTablesCallback<Parameter>(
  * @category Store hooks
  */
 export function useSetTableCallback<Parameter>(
-  tableId: Id,
+  tableId: Id | GetId<Parameter>,
   getTable: (parameter: Parameter, store: Store) => Table,
   getTableDeps?: React.DependencyList,
   storeOrStoreId?: StoreOrStoreId,
@@ -2364,14 +2377,18 @@ export function useSetTableCallback<Parameter>(
  * The Store to which the callback will make the mutation (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- * @param tableId The Id of the Table in the Store.
- * @param rowId The Id of the Row in the Table to set.
+ * @param 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 set, or a GetId function that
+ * will return it.
  * @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
  * is most likely a DOM event).
  * @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.
+ * This 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.
  * @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.
@@ -2419,8 +2436,8 @@ export function useSetTableCallback<Parameter>(
  * @category Store hooks
  */
 export function useSetRowCallback<Parameter>(
-  tableId: Id,
-  rowId: Id,
+  tableId: Id | GetId<Parameter>,
+  rowId: Id | GetId<Parameter>,
   getRow: (parameter: Parameter, store: Store) => Row,
   getRowDeps?: React.DependencyList,
   storeOrStoreId?: StoreOrStoreId,
@@ -2459,13 +2476,15 @@ export function useSetRowCallback<Parameter>(
  * specify `reuseRowIds` to be `false`, then the Id will be a monotonically
  * increasing string representation of an increasing integer, regardless of any
  * you may have previously deleted.
- * @param tableId The Id of the Table in the Store.
+ * @param tableId The Id of the Table in the Store, or a GetId function
+ * that will return it.
  * @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
  * is most likely a DOM event).
  * @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.
+ * This parameter defaults to an empty array. Also use this to indicate the
+ * dependencies of a GetId functions 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.
@@ -2514,7 +2533,7 @@ export function useSetRowCallback<Parameter>(
  * @category Store hooks
  */
 export function useAddRowCallback<Parameter>(
-  tableId: Id,
+  tableId: Id | GetId<Parameter>,
   getRow: (parameter: Parameter, store: Store) => Row,
   getRowDeps?: React.DependencyList,
   storeOrStoreId?: StoreOrStoreId,
@@ -2548,14 +2567,18 @@ export function useAddRowCallback<Parameter>(
  * The Store to which the callback will make the mutation (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- * @param tableId The Id of the Table in the Store.
- * @param rowId The Id of the Row in the Table to set.
+ * @param 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 set, or a GetId function that
+ * will return it.
  * @param getPartialRow A function which returns the partial Row 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).
  * @param getPartialRowDeps 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.
+ * This 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.
  * @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.
@@ -2604,8 +2627,8 @@ export function useAddRowCallback<Parameter>(
  * @category Store hooks
  */
 export function useSetPartialRowCallback<Parameter>(
-  tableId: Id,
-  rowId: Id,
+  tableId: Id | GetId<Parameter>,
+  rowId: Id | GetId<Parameter>,
   getPartialRow: (parameter: Parameter, store: Store) => Row,
   getPartialRowDeps?: React.DependencyList,
   storeOrStoreId?: StoreOrStoreId,
@@ -2637,15 +2660,20 @@ export function useSetPartialRowCallback<Parameter>(
  * The Store to which the callback will make the mutation (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- * @param tableId The Id of the Table in the Store.
- * @param rowId The Id of the Row in the Table.
- * @param cellId The Id of the Cell in the Row to set.
+ * @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 set, or a GetId function that
+ * will return it.
  * @param getCell A function which returns the Cell value that will be used to
  * update the Store, or a MapCell function to update it, based on the parameter
  * the callback will receive (and which is most likely a DOM event).
  * @param getCellDeps An optional array of dependencies for the `getCell`
  * function, which, if any change, result in the regeneration of the callback.
- * This parameter defaults to an empty array.
+ * This 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.
  * @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.
@@ -2731,9 +2759,9 @@ export function useSetPartialRowCallback<Parameter>(
  * @category Store hooks
  */
 export function useSetCellCallback<Parameter>(
-  tableId: Id,
-  rowId: Id,
-  cellId: Id,
+  tableId: Id | GetId<Parameter>,
+  rowId: Id | GetId<Parameter>,
+  cellId: Id | GetId<Parameter>,
   getCell: (parameter: Parameter, store: Store) => Cell | MapCell,
   getCellDeps?: React.DependencyList,
   storeOrStoreId?: StoreOrStoreId,
@@ -2933,13 +2961,15 @@ export function useSetPartialValuesCallback<Parameter>(
  * The Store to which the callback will make the mutation (indicated by the
  * hook's `storeOrStoreId` parameter) is always automatically used as a hook
  * dependency for the callback.
- * @param valueId The Id of the Value in the Store to set.
+ * @param valueId The Id of the Value in the Store to set, or a GetId function
+ * that will return it.
  * @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
  * which is most likely a DOM event).
  * @param getValueDeps An optional array of dependencies for the `getValue`
  * function, which, if any change, result in the regeneration of the callback.
- * This parameter defaults to an empty array.
+ * This parameter defaults to an empty array. Also use this to indicate the
+ * dependencies of a GetId function if used as the valueId 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.
@@ -2987,7 +3017,7 @@ export function useSetPartialValuesCallback<Parameter>(
  * @since v3.0.0
  */
 export function useSetValueCallback<Parameter>(
-  valueId: Id,
+  valueId: Id | GetId<Parameter>,
   getValue: (parameter: Parameter, store: Store) => Value | MapValue,
   getValueDeps?: React.DependencyList,
   storeOrStoreId?: StoreOrStoreId,

package/lib/types/with-schemas/checkpoints.d.ts

@@ -864,16 +864,14 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * ```
    *
    * Obviously this method should be used with caution as it destroys the
-   * ability to undo recent changes to the Store (though of course the Store
-   * itself is not reset by this method).
+   * ability to undo or redo recent changes to the Store (though of course the
+   * Store itself is not reset by this method).
    *
    * This method can be useful when a Store is being loaded via a Persister
    * asynchronously after the Checkpoints object has been attached, and you
    * don't want users to be able to undo the initial load of the data. In this
-   * you could call the clear method immediately after the initial load so that
-   * that is the baseline from which all subsequent changes are tracked.
-   *
-   * If you are listening to
+   * case you could call the clear method immediately after the initial load so
+   * that that is the baseline from which all subsequent changes are tracked.
    * @returns A reference to the Checkpoints object.
    * @example
    * This example creates a Store, a Checkpoints object, adds a listener, makes
@@ -916,6 +914,66 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    */
   clear(): Checkpoints<Schemas>;
 
+  /**
+   * The clearForward method resets just the 'redo' checkpoints it has been
+   * managing.
+   *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * clearForward(): Checkpoints;
+   * ```
+   *
+   * Obviously this method should be used with caution as it destroys the
+   * ability to redo recent changes to the Store (though of course the Store
+   * itself is not reset by this method).
+   *
+   * This method can be useful when you want to prohibit a user from redoing
+   * changes they have undone. The 'backward' redo stack, and current checkpoint
+   * are not affected.
+   * @returns A reference to the Checkpoints object.
+   * @example
+   * This example creates a Store, a Checkpoints object, adds a listener, makes
+   * a change and then clears the forward checkpoints.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {sold: false}}});
+   *
+   * const checkpoints = createCheckpoints(store);
+   * console.log(checkpoints.getCheckpointIds());
+   * // -> [[], '0', []]
+   *
+   * const listenerId = checkpoints.addCheckpointIdsListener(() => {
+   *   console.log('checkpoints changed');
+   * });
+   *
+   * store.setCell('pets', 'fido', 'color', 'brown');
+   * // -> 'checkpoints changed'
+   * checkpoints.addCheckpoint();
+   * // -> 'checkpoints changed'
+   * store.setCell('pets', 'fido', 'sold', true);
+   * // -> 'checkpoints changed'
+   * checkpoints.addCheckpoint();
+   * // -> 'checkpoints changed'
+   * checkpoints.goBackward();
+   * // -> 'checkpoints changed'
+   *
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {color: 'brown', sold: false}}}
+   * console.log(checkpoints.getCheckpointIds());
+   * // -> [['0'], '1', ['2']]
+   *
+   * checkpoints.clearForward();
+   * // -> 'checkpoints changed'
+   *
+   * console.log(checkpoints.getCheckpointIds());
+   * // -> [['0'], '1', []]
+   * ```
+   * @category Lifecycle
+   * @since v4.5.3
+   */
+  clearForward(): Checkpoints<Schemas>;
+
   /**
    * The destroy method should be called when this Checkpoints object is no
    * longer used.

package/lib/types/with-schemas/internal/ui-react.d.ts

@@ -32,6 +32,11 @@ type CheckpointsOrCheckpointsId<Schemas extends OptionalSchemas> =
 
 type UndoOrRedoInformation = [boolean, Callback, Id | undefined, string];
 
+type GetId<Schemas extends OptionalSchemas, Parameter, Id> = (
+  parameter: Parameter,
+  store: Store<Schemas>,
+) => Id;
+
 type ExtraProps = {[propName: string]: any};
 
 type TablesProps<Schemas extends OptionalSchemas> = {

package/lib/types/with-schemas/persisters/persister-electric-sql.d.ts

@@ -0,0 +1,177 @@
+/**
+ * The persister-electric-sql module of the TinyBase project lets you save and
+ * load Store data to and from a local ElectricSQL database (in an appropriate
+ * environment).
+ * @see Persisting Data guide
+ * @packageDocumentation
+ * @module persister-electric-sql
+ * @since v4.6.0
+ */
+
+import {DatabasePersisterConfig, Persister} from '../persisters';
+import {OptionalSchemas, Store} from '../store';
+import {ElectricClient} from 'electric-sql/client/model';
+
+/**
+ * The ElectricSqlPersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getElectricClient method for accessing a
+ * reference to the Electric client the Store is being persisted to.
+ * @since v4.6.0
+ */
+export interface ElectricSqlPersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * The getElectricClient method returns a reference to the Electric client the
+   * Store is being persisted to.
+   * @returns A reference to the Electric client.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the Electric client back out again.
+   *
+   * ```js yolo
+   * const electricClient = await electrify(
+   *   await ElectricDatabase.init('electric.db', ''),
+   *   schema,
+   *   {url: ELECTRIC_URL},
+   * );
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createElectricSqlPersister(
+   *   store,
+   *   electricClient,
+   *   'my_tinybase',
+   * );
+   *
+   * console.log(persister.getElectricClient() == electricClient);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.6.0
+   */
+  getElectricClient: () => ElectricClient<any>;
+}
+
+/**
+ * The createElectricSqlPersister function creates a Persister object that can
+ * persist the Store to a local ElectricSQL database (in an appropriate
+ * environment).
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createElectricSqlPersister(
+ *   store: Store,
+ *   electricClient: ElectricClient<any>,
+ *   configOrStoreTableName?: DatabasePersisterConfig | string,
+ *   onSqlCommand?: (sql: string, args?: any[]) => void,
+ *   onIgnoredError?: (error: any) => void,
+ * ): ElectricSqlPersister;
+ * ```
+ *
+ * As well as providing a reference to the Store to persist, you must provide a
+ * `electricClient` parameter which identifies the Electric client.
+ *
+ * A database Persister uses one of two modes: either a JSON serialization of
+ * the whole Store stored in a single row of a table (the default), or a tabular
+ * mapping of Table Ids to database table names and vice-versa).
+ *
+ * The third argument is a DatabasePersisterConfig object that configures which
+ * of those modes to use, and settings for each. If the third argument is simply
+ * a string, it is used as the `storeTableName` property of the JSON
+ * serialization.
+ *
+ * See the documentation for the DpcJson and DpcTabular types for more
+ * information on how both of those modes can be configured.
+ * @param store The Store to persist.
+ * @param electricClient The Electric client that was returned from `await
+ * electrify(...)`.
+ * @param configOrStoreTableName A DatabasePersisterConfig to configure the
+ * persistence mode (or a string to set the `storeTableName` property of the
+ * JSON serialization).
+ * @param onSqlCommand An optional handler called every time the Persister
+ * executes a SQL command or query. This is suitable for logging persistence
+ * behavior in a development environment.
+ * @param onIgnoredError An optional handler for the errors that the Persister
+ * would otherwise ignore when trying to save or load data. This is suitable for
+ * debugging persistence issues in a development environment.
+ * @returns A reference to the new ElectricSqlPersister object.
+ * @example
+ * This example creates a ElectricSqlPersister object and persists the Store to
+ * a local ElectricSql database as a JSON serialization into the `my_tinybase`
+ * table. It makes a change to the database directly and then reloads it back
+ * into the Store.
+ *
+ * ```js yolo
+ * const electricClient = await electrify(
+ *   await ElectricDatabase.init('electric.db', ''),
+ *   schema,
+ *   {url: ELECTRIC_URL},
+ * );
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createElectricSqlPersister(
+ *   store,
+ *   electricClient,
+ *   'my_tinybase',
+ * );
+ *
+ * await persister.save();
+ * // Store will be saved to the database.
+ *
+ * console.log(
+ *   await electricClient.db.raw({sql: 'SELECT * FROM my_tinybase;'}),
+ * );
+ * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * await electricClient.db.raw({
+ *   sql:
+ *     'UPDATE my_tinybase SET store = ' +
+ *     `'[{"pets":{"felix":{"species":"cat"}}},{}]' WHERE _id = '_';`,
+ * });
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {felix: {species: 'cat'}}}
+ *
+ * persister.destroy();
+ * ```
+ * @example
+ * This example creates a ElectricSqlPersister object and persists the Store to
+ * a local ElectricSql database with tabular mapping.
+ *
+ * ```js yolo
+ * const electricClient = await electrify(
+ *   await ElectricDatabase.init('electric.db', ''),
+ *   schema,
+ *   {url: ELECTRIC_URL},
+ * );
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createElectricSqlPersister(store, electricClient, {
+ *   mode: 'tabular',
+ *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
+ * });
+ *
+ * await persister.save();
+ * console.log(await electricClient.db.raw({sql: 'SELECT * FROM pets;'}));
+ * // -> [{_id: 'fido', species: 'dog'}]
+ *
+ * await electricClient.db.raw({
+ *   sql: `INSERT INTO pets (_id, species) VALUES ('felix', 'cat')`,
+ * });
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * persister.destroy();
+ * ```
+ * @category Creation
+ * @since v4.6.0
+ */
+export function createElectricSqlPersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+  electricClient: ElectricClient<any>,
+  configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
+  onSqlCommand?: (sql: string, args?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): ElectricSqlPersister<Schemas>;

package/lib/types/with-schemas/persisters/persister-expo-sqlite-next.d.ts

@@ -100,10 +100,10 @@ export interface ExpoSqliteNextPersister<Schemas extends OptionalSchemas>
  * JSON serialization).
  * @param onSqlCommand An optional handler called every time the Persister
  * executes a SQL command or query. This is suitable for logging persistence
- * behavior in a development environment, since v4.0.4.
+ * behavior in a development environment.
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
- * debugging persistence issues in a development environment, since v4.0.4.
+ * debugging persistence issues in a development environment.
  * @returns A reference to the new ExpoSqliteNextPersister object.
  * @example
  * This example creates a ExpoSqliteNextPersister object and persists the Store

package/lib/types/with-schemas/persisters/persister-partykit-server.d.ts

@@ -25,6 +25,7 @@ import {
   NoValuesSchema,
   OptionalSchemas,
   Tables,
+  TransactionChanges,
   Value,
   ValueOrUndefined,
   Values,
@@ -251,7 +252,7 @@ export class TinyBasePartyKitServer implements Server {
     tableId: Id,
     initialSave: boolean,
     requestOrConnection: Request | Connection,
-  ): boolean;
+  ): Promise<boolean>;
   /**
    * The canDelTable method lets you allow or disallow deletions of a Table
    * stored on the server, as sent from a client.
@@ -283,7 +284,7 @@ export class TinyBasePartyKitServer implements Server {
    * @category Sanitization
    * @since v4.3.12
    */
-  canDelTable(tableId: Id, connection: Connection): boolean;
+  canDelTable(tableId: Id, connection: Connection): Promise<boolean>;
   /**
    * The canSetRow method lets you allow or disallow any changes to a Row stored
    * on the server, as sent from a client.
@@ -326,7 +327,7 @@ export class TinyBasePartyKitServer implements Server {
     rowId: Id,
     initialSave: boolean,
     requestOrConnection: Request | Connection,
-  ): boolean;
+  ): Promise<boolean>;
   /**
    * The canDelRow method lets you allow or disallow deletions of a Row stored
    * on the server, as sent from a client.
@@ -359,7 +360,7 @@ export class TinyBasePartyKitServer implements Server {
    * @category Sanitization
    * @since v4.3.12
    */
-  canDelRow(tableId: Id, rowId: Id, connection: Connection): boolean;
+  canDelRow(tableId: Id, rowId: Id, connection: Connection): Promise<boolean>;
   /**
    * The canSetCell method lets you allow or disallow any changes to a Cell
    * stored on the server, as sent from a client.
@@ -375,7 +376,7 @@ export class TinyBasePartyKitServer implements Server {
    *   initialSave: boolean,
    *   requestOrConnection: Request | Connection,
    *   oldCell: CellOrUndefined,
-   * ): boolean;
+   * ): Promise<boolean>;
    * ```
    *
    * This is one of the functions use to sanitize the data that is being sent
@@ -422,7 +423,7 @@ export class TinyBasePartyKitServer implements Server {
     initialSave: boolean,
     requestOrConnection: Request | Connection,
     oldCell: CellOrUndefined<NoTablesSchema, Id, Id>,
-  ): boolean;
+  ): Promise<boolean>;
   /**
    * The canDelCell method lets you allow or disallow deletions of a Cell stored
    * on the server, as sent from a client.
@@ -460,7 +461,7 @@ export class TinyBasePartyKitServer implements Server {
     rowId: Id,
     cellId: Id,
     connection: Connection,
-  ): boolean;
+  ): Promise<boolean>;
   /**
    * The canSetValue method lets you allow or disallow any changes to a Value
    * stored on the server, as sent from a client.
@@ -474,7 +475,7 @@ export class TinyBasePartyKitServer implements Server {
    *   initialSave: boolean,
    *   requestOrConnection: Request | Connection,
    *   oldValue: ValueOrUndefined,
-   * ): boolean;
+   * ): Promise<boolean>;
    * ```
    *
    * This is one of the functions use to sanitize the data that is being sent
@@ -519,7 +520,7 @@ export class TinyBasePartyKitServer implements Server {
     initialSave: boolean,
     requestOrConnection: Request | Connection,
     oldValue: ValueOrUndefined<NoValuesSchema, Id>,
-  ): boolean;
+  ): Promise<boolean>;
   /**
    * The canDelValue method lets you allow or disallow deletions of a Value
    * stored on the server, as sent from a client.
@@ -551,7 +552,7 @@ export class TinyBasePartyKitServer implements Server {
    * @category Sanitization
    * @since v4.3.12
    */
-  canDelValue(valueId: Id, connection: Connection): boolean;
+  canDelValue(valueId: Id, connection: Connection): Promise<boolean>;
 }
 
 /**
@@ -611,3 +612,36 @@ export function loadStoreFromStorage<Schemas extends OptionalSchemas>(
   storage: Storage,
   storagePrefix?: string,
 ): Promise<[Tables<Schemas[0]>, Values<Schemas[1]>]>;
+
+/**
+ * The broadcastTransactionChanges function allows you to broadcast Store
+ * changes to all the client connections of a TinyBasePartyKitServer.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * broadcastTransactionChanges(
+ *   server: TinyBasePartyKitServer,
+ *   transactionChanges: TransactionChanges,
+ *   without?: string[],
+ * ): Promise<void>;
+ * ```
+ *
+ * This is intended for specialist applications that require the ability to
+ * update clients of a TinyBasePartyKitServer in their own custom ways.
+ *
+ * The function is asynchronous, so you should use the `await` keyword or handle
+ * its completion as a promise.
+ * @param server A reference to the TinyBasePartyKitServer object.
+ * @param transactionChanges The Store changes to broadcast to the server's
+ * clients.
+ * @param without An optional array of client connection Ids to exclude from the
+ * broadcast.
+ * @category Connection
+ * @since v4.5.1
+ */
+export function broadcastTransactionChanges<Schemas extends OptionalSchemas>(
+  server: TinyBasePartyKitServer,
+  transactionChanges: TransactionChanges<Schemas>,
+  without?: string[],
+): Promise<void>;

package/lib/types/with-schemas/persisters/persister-sqlite3.d.ts

@@ -164,4 +164,4 @@ export function createSqlite3Persister<Schemas extends OptionalSchemas>(
   configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): Sqlite3Persister<Schemas>;

package/lib/types/with-schemas/persisters.d.ts

@@ -15,11 +15,13 @@
  * |persister-indexed-db|createIndexedDbPersister|Browser IndexedDB|
  * |persister-remote|createRemotePersister|Remote server|
  * |persister-file|createFilePersister|Local file (where possible)|
+ * |persister-partykit-client|createPartyKitPersister|PartyKit with the persister-partykit-server module|
  * |persister-sqlite3|createSqlite3Persister|SQLite in Node, via [sqlite3](https://github.com/TryGhost/node-sqlite3)|
  * |persister-sqlite-wasm|createSqliteWasmPersister|SQLite in a browser, via [sqlite-wasm](https://github.com/tomayac/sqlite-wasm)|
  * |persister-cr-sqlite-wasm|createCrSqliteWasmPersister|SQLite CRDTs, via [cr-sqlite-wasm](https://github.com/vlcn-io/cr-sqlite)|
  * |persister-expo-sqlite|createExpoSqlitePersister|SQLite in React Native, via [expo-sqlite](https://github.com/expo/expo/tree/main/packages/expo-sqlite)|
  * |persister-expo-sqlite-next|createExpoSqliteNextPersister|SQLite in React Native, via [expo-sqlite/next](https://github.com/expo/expo/tree/main/packages/expo-sqlite/next)|
+ * |persister-electric-sql|createElectricSqlPersister|Electric SQL, via [electric-sql](https://github.com/electric-sql/electric)|
  * |persister-yjs|createYjsPersister|Yjs CRDTs, via [yjs](https://github.com/yjs/yjs)|
  * |persister-automerge|createSqliteWasmPersister|Automerge CRDTs, via [automerge-repo](https://github.com/automerge/automerge-repo)|
  *