tinybase 5.2.0-beta.2 → 5.2.0-beta.4

package/@types/common/index.d.cts

@@ -119,8 +119,40 @@ export type SortKey = string | number | boolean;
 export function defaultSorter(sortKey1: SortKey, sortKey2: SortKey): number;
 
 /**
- * The getUniqueId function.
+ * The getUniqueId function returns a unique string of a given length.
+ *
+ * This is used internally by TinyBase for the synchronizer protocol and for
+ * unique MergeableStore identifiers. But it is useful enough for it to be
+ * publicly exposed for purposes such as identifying shared collaboration rooms,
+ * or creating other Ids that need to be unique.
+ *
+ * The string may contain numbers, lower or upper case letters, or the '-' or
+ * '_' characters. This makes them URL-safe, and means they can be identified
+ * with a regex like `/[-_0-9A-Za-z]+/`.
+ *
+ * This function prefers to use the `crypto` module to generate random numbers,
+ * but where that is not available (such as in React Native), a `Math.random`
+ * implementation is used. Whilst that may not be cryptographically sound, it
+ * should suffice for most TinyBase-related purposes.
+ * @param length The desired length of the unique Id, defaulting to 16.
+ * @returns A unique Id of the required length.
+ * @example
+ * This example creates two 8 character long Ids and compares them.
+ *
+ * ```js
+ * import {getUniqueId} from 'tinybase';
+ *
+ * const id1 = getUniqueId(8);
+ * const id2 = getUniqueId(8);
+ *
+ * console.log(id1.length);
+ * // -> 8
+ * console.log(id2.length);
+ * // -> 8
+ * console.log(id1 == id2);
+ * // -> false
+ * ```
  * @category Convenience
  * @since v5.0.0
  */
-export function getUniqueId(): Id;
+export function getUniqueId(length?: number): Id;

package/@types/common/index.d.ts

@@ -119,8 +119,40 @@ export type SortKey = string | number | boolean;
 export function defaultSorter(sortKey1: SortKey, sortKey2: SortKey): number;
 
 /**
- * The getUniqueId function.
+ * The getUniqueId function returns a unique string of a given length.
+ *
+ * This is used internally by TinyBase for the synchronizer protocol and for
+ * unique MergeableStore identifiers. But it is useful enough for it to be
+ * publicly exposed for purposes such as identifying shared collaboration rooms,
+ * or creating other Ids that need to be unique.
+ *
+ * The string may contain numbers, lower or upper case letters, or the '-' or
+ * '_' characters. This makes them URL-safe, and means they can be identified
+ * with a regex like `/[-_0-9A-Za-z]+/`.
+ *
+ * This function prefers to use the `crypto` module to generate random numbers,
+ * but where that is not available (such as in React Native), a `Math.random`
+ * implementation is used. Whilst that may not be cryptographically sound, it
+ * should suffice for most TinyBase-related purposes.
+ * @param length The desired length of the unique Id, defaulting to 16.
+ * @returns A unique Id of the required length.
+ * @example
+ * This example creates two 8 character long Ids and compares them.
+ *
+ * ```js
+ * import {getUniqueId} from 'tinybase';
+ *
+ * const id1 = getUniqueId(8);
+ * const id2 = getUniqueId(8);
+ *
+ * console.log(id1.length);
+ * // -> 8
+ * console.log(id2.length);
+ * // -> 8
+ * console.log(id1 == id2);
+ * // -> false
+ * ```
  * @category Convenience
  * @since v5.0.0
  */
-export function getUniqueId(): Id;
+export function getUniqueId(length?: number): Id;

package/@types/common/with-schemas/index.d.cts

@@ -119,8 +119,40 @@ export type SortKey = string | number | boolean;
 export function defaultSorter(sortKey1: SortKey, sortKey2: SortKey): number;
 
 /**
- * The getUniqueId function.
+ * The getUniqueId function returns a unique string of a given length.
+ *
+ * This is used internally by TinyBase for the synchronizer protocol and for
+ * unique MergeableStore identifiers. But it is useful enough for it to be
+ * publicly exposed for purposes such as identifying shared collaboration rooms,
+ * or creating other Ids that need to be unique.
+ *
+ * The string may contain numbers, lower or upper case letters, or the '-' or
+ * '_' characters. This makes them URL-safe, and means they can be identified
+ * with a regex like `/[-_0-9A-Za-z]+/`.
+ *
+ * This function prefers to use the `crypto` module to generate random numbers,
+ * but where that is not available (such as in React Native), a `Math.random`
+ * implementation is used. Whilst that may not be cryptographically sound, it
+ * should suffice for most TinyBase-related purposes.
+ * @param length The desired length of the unique Id, defaulting to 16.
+ * @returns A unique Id of the required length.
+ * @example
+ * This example creates two 8 character long Ids and compares them.
+ *
+ * ```js
+ * import {getUniqueId} from 'tinybase';
+ *
+ * const id1 = getUniqueId(8);
+ * const id2 = getUniqueId(8);
+ *
+ * console.log(id1.length);
+ * // -> 8
+ * console.log(id2.length);
+ * // -> 8
+ * console.log(id1 == id2);
+ * // -> false
+ * ```
  * @category Convenience
  * @since v5.0.0
  */
-export function getUniqueId(): Id;
+export function getUniqueId(length?: number): Id;

package/@types/common/with-schemas/index.d.ts

@@ -119,8 +119,40 @@ export type SortKey = string | number | boolean;
 export function defaultSorter(sortKey1: SortKey, sortKey2: SortKey): number;
 
 /**
- * The getUniqueId function.
+ * The getUniqueId function returns a unique string of a given length.
+ *
+ * This is used internally by TinyBase for the synchronizer protocol and for
+ * unique MergeableStore identifiers. But it is useful enough for it to be
+ * publicly exposed for purposes such as identifying shared collaboration rooms,
+ * or creating other Ids that need to be unique.
+ *
+ * The string may contain numbers, lower or upper case letters, or the '-' or
+ * '_' characters. This makes them URL-safe, and means they can be identified
+ * with a regex like `/[-_0-9A-Za-z]+/`.
+ *
+ * This function prefers to use the `crypto` module to generate random numbers,
+ * but where that is not available (such as in React Native), a `Math.random`
+ * implementation is used. Whilst that may not be cryptographically sound, it
+ * should suffice for most TinyBase-related purposes.
+ * @param length The desired length of the unique Id, defaulting to 16.
+ * @returns A unique Id of the required length.
+ * @example
+ * This example creates two 8 character long Ids and compares them.
+ *
+ * ```js
+ * import {getUniqueId} from 'tinybase';
+ *
+ * const id1 = getUniqueId(8);
+ * const id2 = getUniqueId(8);
+ *
+ * console.log(id1.length);
+ * // -> 8
+ * console.log(id2.length);
+ * // -> 8
+ * console.log(id1 == id2);
+ * // -> false
+ * ```
  * @category Convenience
  * @since v5.0.0
  */
-export function getUniqueId(): Id;
+export function getUniqueId(length?: number): Id;

package/@types/persisters/index.d.cts

@@ -24,6 +24,7 @@
  * |LibSqlPersister|LibSQL for Turso, via [libsql-client](https://github.com/tursodatabase/libsql-client-ts)|Yes|No
  * |PowerSyncPersister|PowerSync, via [powersync-sdk](https://github.com/powersync-ja/powersync-js)|Yes|No
  * |PostgresPersister|PostgreSQL, via [postgres](https://github.com/porsager/postgres)|Yes|No
+ * |PglitePersister|PostgreSQL, via [PGlite](https://github.com/electric-sql/pglite)|Yes|No
  * |YjsPersister|Yjs CRDTs, via [yjs](https://github.com/yjs/yjs)|Yes|No
  * |AutomergePersister|Automerge CRDTs, via [automerge-repo](https://github.com/automerge/automerge-repo)|Yes|No
  * |PartyKitPersister|[PartyKit](https://www.partykit.io/), via the persister-partykit-server module|Yes|No|
@@ -344,8 +345,8 @@ export type DpcJson = {
  *
  * This configuration can only be used when the Persister is persisting a
  * regular Store. For those database-oriented Persister types that support
- * MergeableStore data, you will need to use JSON-serialization, es described
- * in the DpcJson section.
+ * MergeableStore data, you will need to use JSON-serialization, es described in
+ * the DpcJson section.
  *
  * It is important to note that both the tabular mapping in ('save') and out
  * ('load') of an underlying database are disabled by default. This is to ensure
@@ -378,6 +379,15 @@ export type DpcJson = {
  * DpcTabularValues types for more details on how to configure the tabular
  * mapping mode.
  *
+ * Columns in SQLite database have no type, and so in this mode, the table can
+ * contain strings and numbers for Cells and Values, just as TinyBase does.
+ * Booleans, unfortunately, are stored as 0 or 1 in SQLite, and cannot be
+ * distinguished from numbers.
+ *
+ * In PostgreSQL databases, all Cell and Value columns are expected to be typed
+ * as `text`, and the strings, booleans, and numbers are all JSON-encoded by the
+ * Persister.
+ *
  * The 'Dpc' prefix indicates that this type is used within the
  * DatabasePersisterConfig type.
  * @example
@@ -522,6 +532,11 @@ export type DpcTabular = {
  *   },
  * }
  * ```
+ *
+ * The example above represents what happens with a SQLite Persister. In
+ * PostgreSQL databases, all Cell and Value columns are expected to be
+ * typed as `text`, and the strings, booleans, and numbers would be JSON-encoded
+ * if you queried them.
  * @category Configuration
  * @since v4.0.0
  */
@@ -635,6 +650,10 @@ export type DpcTabularLoad = {
  * | cat  | 4     |
  * +------+-------+
  * ```
+ * The example above represents what happens with a SQLite Persister. In
+ * PostgreSQL databases, all Cell and Value columns are expected to be
+ * typed as `text`, and the strings, booleans, and numbers would be JSON-encoded
+ * if you queried them.
  * @category Configuration
  * @since v4.0.0
  */

package/@types/persisters/index.d.ts

@@ -24,6 +24,7 @@
  * |LibSqlPersister|LibSQL for Turso, via [libsql-client](https://github.com/tursodatabase/libsql-client-ts)|Yes|No
  * |PowerSyncPersister|PowerSync, via [powersync-sdk](https://github.com/powersync-ja/powersync-js)|Yes|No
  * |PostgresPersister|PostgreSQL, via [postgres](https://github.com/porsager/postgres)|Yes|No
+ * |PglitePersister|PostgreSQL, via [PGlite](https://github.com/electric-sql/pglite)|Yes|No
  * |YjsPersister|Yjs CRDTs, via [yjs](https://github.com/yjs/yjs)|Yes|No
  * |AutomergePersister|Automerge CRDTs, via [automerge-repo](https://github.com/automerge/automerge-repo)|Yes|No
  * |PartyKitPersister|[PartyKit](https://www.partykit.io/), via the persister-partykit-server module|Yes|No|
@@ -344,8 +345,8 @@ export type DpcJson = {
  *
  * This configuration can only be used when the Persister is persisting a
  * regular Store. For those database-oriented Persister types that support
- * MergeableStore data, you will need to use JSON-serialization, es described
- * in the DpcJson section.
+ * MergeableStore data, you will need to use JSON-serialization, es described in
+ * the DpcJson section.
  *
  * It is important to note that both the tabular mapping in ('save') and out
  * ('load') of an underlying database are disabled by default. This is to ensure
@@ -378,6 +379,15 @@ export type DpcJson = {
  * DpcTabularValues types for more details on how to configure the tabular
  * mapping mode.
  *
+ * Columns in SQLite database have no type, and so in this mode, the table can
+ * contain strings and numbers for Cells and Values, just as TinyBase does.
+ * Booleans, unfortunately, are stored as 0 or 1 in SQLite, and cannot be
+ * distinguished from numbers.
+ *
+ * In PostgreSQL databases, all Cell and Value columns are expected to be typed
+ * as `text`, and the strings, booleans, and numbers are all JSON-encoded by the
+ * Persister.
+ *
  * The 'Dpc' prefix indicates that this type is used within the
  * DatabasePersisterConfig type.
  * @example
@@ -522,6 +532,11 @@ export type DpcTabular = {
  *   },
  * }
  * ```
+ *
+ * The example above represents what happens with a SQLite Persister. In
+ * PostgreSQL databases, all Cell and Value columns are expected to be
+ * typed as `text`, and the strings, booleans, and numbers would be JSON-encoded
+ * if you queried them.
  * @category Configuration
  * @since v4.0.0
  */
@@ -635,6 +650,10 @@ export type DpcTabularLoad = {
  * | cat  | 4     |
  * +------+-------+
  * ```
+ * The example above represents what happens with a SQLite Persister. In
+ * PostgreSQL databases, all Cell and Value columns are expected to be
+ * typed as `text`, and the strings, booleans, and numbers would be JSON-encoded
+ * if you queried them.
  * @category Configuration
  * @since v4.0.0
  */

package/@types/persisters/persister-pglite/index.d.cts

@@ -0,0 +1,178 @@
+/**
+ * The persister-pglite module of the TinyBase project lets you save and load
+ * Store data to and from a PGlite database (in an appropriate environment).
+ * @see Database Persistence guide
+ * @packageDocumentation
+ * @module persister-pglite
+ * @since 5.2.0
+ */
+
+import type {DatabasePersisterConfig, Persister, Persists} from '../index.d.cts';
+import type {MergeableStore} from '../../mergeable-store/index.d.cts';
+import type {PGlite} from '@electric-sql/pglite';
+import type {Store} from '../../store/index.d.cts';
+
+/**
+ * The PglitePersister interface represents a Persister that lets you save and
+ * load Store data to and from a local PGlite database.
+ *
+ * You should use the createPglitePersister function to create a PglitePersister
+ * object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getPglite method for accessing a reference to the database connection
+ * the Store is being persisted to.
+ * @category Persister
+ * @since 5.2.0
+ */
+export interface PglitePersister
+  extends Persister<Persists.StoreOrMergeableStore> {
+  /**
+   * The getPglite method returns a reference to the database connection the
+   * Store is being persisted to.
+   * @returns A reference to the database connection.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the database connection back out again.
+   *
+   * ```js
+   * import {PGlite} from '@electric-sql/pglite';
+   * import {createPglitePersister} from 'tinybase/persisters/persister-pglite';
+   * import {createStore} from 'tinybase';
+   *
+   * const pglite = await PGlite.create();
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = await createPglitePersister(
+   *   store,
+   *   pglite,
+   *   'my_tinybase',
+   * );
+   *
+   * console.log(persister.getPglite() == pglite);
+   * // -> true
+   *
+   * persister.destroy();
+   * await pglite.close();
+   * ```
+   * @category Getter
+   * @since 5.2.0
+   */
+  getPglite(): PGlite;
+}
+
+/**
+ * The createPglitePersister function creates a PglitePersister object that can
+ * persist the Store to a local PGlite database.
+ *
+ * A PglitePersister supports regular Store objects, and can also be used to
+ * persist the metadata of a MergeableStore when using the JSON serialization
+ * mode, as described below.
+ *
+ * As well as providing a reference to the Store to persist, you must provide a
+ * `pglite` parameter which identifies the database connection.
+ *
+ * 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.
+ *
+ * This method is asynchronous because it will await the creation of dedicated
+ * new connections to the database. You will need to `await` a call to this
+ * function or handle the return type natively as a Promise.
+ * @param store The Store or MergeableStore to persist.
+ * @param pglite The database connection that was returned from
+ * `PGlite.create(...)`.
+ * @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 PglitePersister object.
+ * @example
+ * This example creates a PglitePersister object and persists the Store to a
+ * local PGlite 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
+ * import {PGlite} from '@electric-sql/pglite';
+ * import {createPglitePersister} from 'tinybase/persisters/persister-pglite';
+ * import {createStore} from 'tinybase';
+ *
+ * const pglite = await PGlite.create();
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = await createPglitePersister(
+ *   store,
+ *   pglite,
+ *   'my_tinybase',
+ * );
+ * await persister.save();
+ * // Store will be saved to the database.
+ *
+ * console.log((await pglite.query('SELECT * FROM my_tinybase;')).rows);
+ * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * await pglite.query(`UPDATE my_tinybase SET store = $1 WHERE _id = '_';`, [
+ *   '[{"pets":{"felix":{"species":"cat"}}},{}]',
+ * ]);
+ *
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {felix: {species: 'cat'}}}
+ *
+ * persister.destroy();
+ * await pglite.close();
+ * ```
+ * @example
+ * This example creates a PglitePersister object and persists the Store to a
+ * local PGlite database with tabular mapping.
+ *
+ * ```js
+ * import {PGlite} from '@electric-sql/pglite';
+ * import {createPglitePersister} from 'tinybase/persisters/persister-pglite';
+ * import {createStore} from 'tinybase';
+ *
+ * const pglite = await PGlite.create();
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = await createPglitePersister(store, pglite, {
+ *   mode: 'tabular',
+ *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
+ * });
+ *
+ * await persister.save();
+ * console.log((await pglite.query('SELECT * FROM pets;')).rows);
+ * // -> [{_id: 'fido', species: '"dog"'}]
+ * // Note that Cells and Values are JSON-encoded in PostgreSQL databases.
+ *
+ * await pglite.query(
+ *   `INSERT INTO pets (_id, species) VALUES ('felix', '"cat"')`,
+ * );
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * persister.destroy();
+ * await pglite.query('DROP TABLE IF EXISTS pets');
+ * await pglite.close();
+ * ```
+ * @category Creation
+ * @since 5.2.0
+ */
+export function createPglitePersister(
+  store: Store | MergeableStore,
+  pglite: PGlite,
+  configOrStoreTableName?: DatabasePersisterConfig | string,
+  onSqlCommand?: (sql: string, args?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): Promise<PglitePersister>;

package/@types/persisters/persister-pglite/index.d.ts

@@ -0,0 +1,178 @@
+/**
+ * The persister-pglite module of the TinyBase project lets you save and load
+ * Store data to and from a PGlite database (in an appropriate environment).
+ * @see Database Persistence guide
+ * @packageDocumentation
+ * @module persister-pglite
+ * @since 5.2.0
+ */
+
+import type {DatabasePersisterConfig, Persister, Persists} from '../index.d.ts';
+import type {MergeableStore} from '../../mergeable-store/index.d.ts';
+import type {PGlite} from '@electric-sql/pglite';
+import type {Store} from '../../store/index.d.ts';
+
+/**
+ * The PglitePersister interface represents a Persister that lets you save and
+ * load Store data to and from a local PGlite database.
+ *
+ * You should use the createPglitePersister function to create a PglitePersister
+ * object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getPglite method for accessing a reference to the database connection
+ * the Store is being persisted to.
+ * @category Persister
+ * @since 5.2.0
+ */
+export interface PglitePersister
+  extends Persister<Persists.StoreOrMergeableStore> {
+  /**
+   * The getPglite method returns a reference to the database connection the
+   * Store is being persisted to.
+   * @returns A reference to the database connection.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the database connection back out again.
+   *
+   * ```js
+   * import {PGlite} from '@electric-sql/pglite';
+   * import {createPglitePersister} from 'tinybase/persisters/persister-pglite';
+   * import {createStore} from 'tinybase';
+   *
+   * const pglite = await PGlite.create();
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = await createPglitePersister(
+   *   store,
+   *   pglite,
+   *   'my_tinybase',
+   * );
+   *
+   * console.log(persister.getPglite() == pglite);
+   * // -> true
+   *
+   * persister.destroy();
+   * await pglite.close();
+   * ```
+   * @category Getter
+   * @since 5.2.0
+   */
+  getPglite(): PGlite;
+}
+
+/**
+ * The createPglitePersister function creates a PglitePersister object that can
+ * persist the Store to a local PGlite database.
+ *
+ * A PglitePersister supports regular Store objects, and can also be used to
+ * persist the metadata of a MergeableStore when using the JSON serialization
+ * mode, as described below.
+ *
+ * As well as providing a reference to the Store to persist, you must provide a
+ * `pglite` parameter which identifies the database connection.
+ *
+ * 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.
+ *
+ * This method is asynchronous because it will await the creation of dedicated
+ * new connections to the database. You will need to `await` a call to this
+ * function or handle the return type natively as a Promise.
+ * @param store The Store or MergeableStore to persist.
+ * @param pglite The database connection that was returned from
+ * `PGlite.create(...)`.
+ * @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 PglitePersister object.
+ * @example
+ * This example creates a PglitePersister object and persists the Store to a
+ * local PGlite 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
+ * import {PGlite} from '@electric-sql/pglite';
+ * import {createPglitePersister} from 'tinybase/persisters/persister-pglite';
+ * import {createStore} from 'tinybase';
+ *
+ * const pglite = await PGlite.create();
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = await createPglitePersister(
+ *   store,
+ *   pglite,
+ *   'my_tinybase',
+ * );
+ * await persister.save();
+ * // Store will be saved to the database.
+ *
+ * console.log((await pglite.query('SELECT * FROM my_tinybase;')).rows);
+ * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * await pglite.query(`UPDATE my_tinybase SET store = $1 WHERE _id = '_';`, [
+ *   '[{"pets":{"felix":{"species":"cat"}}},{}]',
+ * ]);
+ *
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {felix: {species: 'cat'}}}
+ *
+ * persister.destroy();
+ * await pglite.close();
+ * ```
+ * @example
+ * This example creates a PglitePersister object and persists the Store to a
+ * local PGlite database with tabular mapping.
+ *
+ * ```js
+ * import {PGlite} from '@electric-sql/pglite';
+ * import {createPglitePersister} from 'tinybase/persisters/persister-pglite';
+ * import {createStore} from 'tinybase';
+ *
+ * const pglite = await PGlite.create();
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = await createPglitePersister(store, pglite, {
+ *   mode: 'tabular',
+ *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
+ * });
+ *
+ * await persister.save();
+ * console.log((await pglite.query('SELECT * FROM pets;')).rows);
+ * // -> [{_id: 'fido', species: '"dog"'}]
+ * // Note that Cells and Values are JSON-encoded in PostgreSQL databases.
+ *
+ * await pglite.query(
+ *   `INSERT INTO pets (_id, species) VALUES ('felix', '"cat"')`,
+ * );
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * persister.destroy();
+ * await pglite.query('DROP TABLE IF EXISTS pets');
+ * await pglite.close();
+ * ```
+ * @category Creation
+ * @since 5.2.0
+ */
+export function createPglitePersister(
+  store: Store | MergeableStore,
+  pglite: PGlite,
+  configOrStoreTableName?: DatabasePersisterConfig | string,
+  onSqlCommand?: (sql: string, args?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): Promise<PglitePersister>;