tinybase 6.1.0-beta.3 → 6.1.0-beta.5

package/@types/persisters/persister-indexed-db/index.d.ts

@@ -41,7 +41,7 @@ export interface IndexedDbPersister extends Persister {
    * console.log(persister.getDbName());
    * // -> 'petStore'
    *
-   * persister.destroy();
+   * await persister.destroy();
    * ```
    * @category Getter
    * @since v4.3.14
@@ -107,7 +107,7 @@ export interface IndexedDbPersister extends Persister {
  * //         k: "open"
  * //         v: true
  *
- * persister.destroy();
+ * await persister.destroy();
  * ```
  * @category Creation
  * @since v4.2.0

package/@types/persisters/persister-indexed-db/with-schemas/index.d.ts

@@ -45,7 +45,7 @@ export interface IndexedDbPersister<Schemas extends OptionalSchemas>
    * console.log(persister.getDbName());
    * // -> 'petStore'
    *
-   * persister.destroy();
+   * await persister.destroy();
    * ```
    * @category Getter
    * @since v4.3.14
@@ -122,7 +122,7 @@ export interface IndexedDbPersister<Schemas extends OptionalSchemas>
  * //         k: "open"
  * //         v: true
  *
- * persister.destroy();
+ * await persister.destroy();
  * ```
  * @category Creation
  * @since v4.2.0

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

@@ -45,7 +45,7 @@ export interface LibSqlPersister extends Persister {
    * console.log(persister.getClient() == client);
    * // -> true
    *
-   * persister.destroy();
+   * await persister.destroy();
    * ```
    * @category Getter
    * @since v4.7.0
@@ -115,7 +115,7 @@ export interface LibSqlPersister extends Persister {
  * console.log(store.getTables());
  * // -> {pets: {felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * ```
  * @example
  * This example creates a LibSqlPersister object and persists the Store to a
@@ -144,7 +144,7 @@ export interface LibSqlPersister extends Persister {
  * console.log(store.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * ```
  * @category Creation
  * @since v4.7.0

package/@types/persisters/persister-libsql/with-schemas/index.d.ts

@@ -52,7 +52,7 @@ export interface LibSqlPersister<Schemas extends OptionalSchemas>
    * console.log(persister.getClient() == client);
    * // -> true
    *
-   * persister.destroy();
+   * await persister.destroy();
    * ```
    * @category Getter
    * @since v4.7.0
@@ -134,7 +134,7 @@ export interface LibSqlPersister<Schemas extends OptionalSchemas>
  * console.log(store.getTables());
  * // -> {pets: {felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * ```
  * @example
  * This example creates a LibSqlPersister object and persists the Store to a
@@ -163,7 +163,7 @@ export interface LibSqlPersister<Schemas extends OptionalSchemas>
  * console.log(store.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * ```
  * @category Creation
  * @since v4.7.0

package/@types/persisters/persister-partykit-client/index.d.ts

@@ -59,7 +59,7 @@ export interface PartyKitPersister extends Persister {
    * console.log(persister.getConnection() == partySocket);
    * // -> true
    *
-   * persister.destroy();
+   * await persister.destroy();
    * ```
    * @category Getter
    * @since v4.3.14
@@ -182,7 +182,7 @@ export type PartyKitPersisterConfig = {
  * await persister.startAutoSave();
  * // Store will now be synchronized with the room.
  *
- * persister.destroy();
+ * await persister.destroy();
  * ```
  * @category Creation
  * @since v4.3.0

package/@types/persisters/persister-partykit-client/with-schemas/index.d.ts

@@ -63,7 +63,7 @@ export interface PartyKitPersister<Schemas extends OptionalSchemas>
    * console.log(persister.getConnection() == partySocket);
    * // -> true
    *
-   * persister.destroy();
+   * await persister.destroy();
    * ```
    * @category Getter
    * @since v4.3.14
@@ -197,7 +197,7 @@ export type PartyKitPersisterConfig = {
  * await persister.startAutoSave();
  * // Store will now be synchronized with the room.
  *
- * persister.destroy();
+ * await persister.destroy();
  * ```
  * @category Creation
  * @since v4.3.0

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

@@ -50,7 +50,7 @@ export interface PglitePersister
    * console.log(persister.getPglite() == pglite);
    * // -> true
    *
-   * persister.destroy();
+   * await persister.destroy();
    * await pglite.close();
    * ```
    * @category Getter
@@ -130,7 +130,7 @@ export interface PglitePersister
  * console.log(store.getTables());
  * // -> {pets: {felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * await pglite.close();
  * ```
  * @example
@@ -161,7 +161,7 @@ export interface PglitePersister
  * console.log(store.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * await pglite.query('DROP TABLE IF EXISTS pets');
  * await pglite.close();
  * ```

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

@@ -57,7 +57,7 @@ export interface PglitePersister<Schemas extends OptionalSchemas>
    * console.log(persister.getPglite() == pglite);
    * // -> true
    *
-   * persister.destroy();
+   * await persister.destroy();
    * await pglite.close();
    * ```
    * @category Getter
@@ -149,7 +149,7 @@ export interface PglitePersister<Schemas extends OptionalSchemas>
  * console.log(store.getTables());
  * // -> {pets: {felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * await pglite.close();
  * ```
  * @example
@@ -180,7 +180,7 @@ export interface PglitePersister<Schemas extends OptionalSchemas>
  * console.log(store.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * await pglite.query('DROP TABLE IF EXISTS pets');
  * await pglite.close();
  * ```

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

@@ -46,7 +46,7 @@ export interface PostgresPersister
    * console.log(persister.getSql() == sql);
    * // -> true
    *
-   * persister.destroy();
+   * await persister.destroy();
    * await sql.end();
    * ```
    * @category Getter
@@ -121,7 +121,7 @@ export interface PostgresPersister
  * console.log(store.getTables());
  * // -> {pets: {felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * await sql.end();
  * ```
  * @example
@@ -150,7 +150,7 @@ export interface PostgresPersister
  * console.log(store.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * await sql`DROP TABLE IF EXISTS pets`;
  * await sql.end();
  * ```

package/@types/persisters/persister-postgres/with-schemas/index.d.ts

@@ -53,7 +53,7 @@ export interface PostgresPersister<Schemas extends OptionalSchemas>
    * console.log(persister.getSql() == sql);
    * // -> true
    *
-   * persister.destroy();
+   * await persister.destroy();
    * await sql.end();
    * ```
    * @category Getter
@@ -140,7 +140,7 @@ export interface PostgresPersister<Schemas extends OptionalSchemas>
  * console.log(store.getTables());
  * // -> {pets: {felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * await sql.end();
  * ```
  * @example
@@ -169,7 +169,7 @@ export interface PostgresPersister<Schemas extends OptionalSchemas>
  * console.log(store.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * await sql`DROP TABLE IF EXISTS pets`;
  * await sql.end();
  * ```

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

@@ -46,7 +46,7 @@ export interface PowerSyncPersister extends Persister {
    * console.log(persister.getPowerSync() == ps);
    * // -> true
    *
-   * persister.destroy();
+   * await persister.destroy();
    * ```
    * @category Getter
    * @since v4.8.0
@@ -124,7 +124,7 @@ export interface PowerSyncPersister extends Persister {
  * console.log(store.getTables());
  * // -> {pets: {felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * ```
  * @example
  * This example creates a PowerSyncPersister object and persists the Store to a
@@ -160,7 +160,7 @@ export interface PowerSyncPersister extends Persister {
  * console.log(store.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * ```
  * @category Creation
  * @since v4.8.0

package/@types/persisters/persister-powersync/with-schemas/index.d.ts

@@ -53,7 +53,7 @@ export interface PowerSyncPersister<Schemas extends OptionalSchemas>
    * console.log(persister.getPowerSync() == ps);
    * // -> true
    *
-   * persister.destroy();
+   * await persister.destroy();
    * ```
    * @category Getter
    * @since v4.8.0
@@ -143,7 +143,7 @@ export interface PowerSyncPersister<Schemas extends OptionalSchemas>
  * console.log(store.getTables());
  * // -> {pets: {felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * ```
  * @example
  * This example creates a PowerSyncPersister object and persists the Store to a
@@ -179,7 +179,7 @@ export interface PowerSyncPersister<Schemas extends OptionalSchemas>
  * console.log(store.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * persister.destroy();
+ * await persister.destroy();
  * ```
  * @category Creation
  * @since v4.8.0

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

@@ -44,7 +44,7 @@ export interface RemotePersister extends Persister {
    * console.log(persister.getUrls());
    * // -> ['https://example.com/load', 'https://example.com/save']
    *
-   * persister.destroy();
+   * await persister.destroy();
    * ```
    * @category Getter
    * @since v4.3.14
@@ -103,7 +103,7 @@ export interface RemotePersister extends Persister {
  * await persister.load();
  * // Store JSON will be fetched from server with a GET request.
  *
- * persister.destroy();
+ * await persister.destroy();
  * ```
  * @category Creation
  * @since v1.0.0

package/@types/persisters/persister-remote/with-schemas/index.d.ts

@@ -48,7 +48,7 @@ export interface RemotePersister<Schemas extends OptionalSchemas>
    * console.log(persister.getUrls());
    * // -> ['https://example.com/load', 'https://example.com/save']
    *
-   * persister.destroy();
+   * await persister.destroy();
    * ```
    * @category Getter
    * @since v4.3.14
@@ -119,7 +119,7 @@ export interface RemotePersister<Schemas extends OptionalSchemas>
  * await persister.load();
  * // Store JSON will be fetched from server with a GET request.
  *
- * persister.destroy();
+ * await persister.destroy();
  * ```
  * @category Creation
  * @since v1.0.0

package/@types/persisters/persister-sqlite-bun/index.d.ts

@@ -0,0 +1,159 @@
+/**
+ * The persister-sqlite-bun module of the TinyBase project lets you save and
+ * load Store data to and from a local Bun SQLite database (in an appropriate
+ * environment).
+ * @see Database Persistence guide
+ * @packageDocumentation
+ * @module persister-sqlite-bun
+ * @since v6.1.0
+ */
+import type {Database} from 'bun:sqlite';
+import type {MergeableStore} from '../../mergeable-store/index.d.ts';
+import type {Store} from '../../store/index.d.ts';
+import type {DatabasePersisterConfig, Persister, Persists} from '../index.d.ts';
+
+/**
+ * The SqliteBunPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local Bun SQLite database.
+ *
+ * You should use the createSqliteBunPersister function to create a
+ * SqliteBunPersister object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getDb method for accessing a reference to the database instance the
+ * Store is being persisted to.
+ * @category Persister
+ * @since v6.1.0
+ */
+export interface SqliteBunPersister
+  extends Persister<Persists.StoreOrMergeableStore> {
+  /**
+   * The getDb method returns a reference to the database instance the Store is
+   * being persisted to.
+   * @returns A reference to the database instance.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the database instance back out again.
+   *
+   * ```js bun
+   * import {Database} from 'bun:sqlite';
+   * import {createStore} from 'tinybase';
+   * import {createSqliteBunPersister} from 'tinybase/persisters/persister-sqlite-bun';
+   *
+   * const db = new Database(':memory:');
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createSqliteBunPersister(store, db, 'my_tinybase');
+   *
+   * console.log(persister.getDb() == db);
+   * // -> true
+   *
+   * await persister.destroy();
+   * ```
+   * @category Getter
+   * @since v6.1.0
+   */
+  getDb(): Database;
+}
+
+/**
+ * The createSqliteBunPersister function creates a SqliteBunPersister object
+ * that can persist the Store to a local Bun SQLite database.
+ *
+ * A SqliteBunPersister 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
+ * `db` parameter which identifies the database instance.
+ *
+ * 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 or MergeableStore to persist.
+ * @param db The database instance that was returned from `new Database(...)`.
+ * @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 SqliteBunPersister object.
+ * @example
+ * This example creates a SqliteBunPersister object and persists the Store to a
+ * local SQLite 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 bun
+ * import {Database} from 'bun:sqlite';
+ * import {createStore} from 'tinybase';
+ * import {createSqliteBunPersister} from 'tinybase/persisters/persister-sqlite-bun';
+ *
+ * const db = new Database(':memory:');
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createSqliteBunPersister(store, db, 'my_tinybase');
+ *
+ * await persister.save();
+ * // Store will be saved to the database.
+ *
+ * console.log(db.query('SELECT * FROM my_tinybase;').all());
+ * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * db.query(
+ *   'UPDATE my_tinybase SET store = ' +
+ *     `'[{"pets":{"felix":{"species":"cat"}}},{}]' WHERE _id = '_';`,
+ * ).run();
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {felix: {species: 'cat'}}}
+ *
+ * await persister.destroy();
+ * ```
+ * @example
+ * This example creates a SqliteBunPersister object and persists the Store to a
+ * local SQLite database with tabular mapping.
+ *
+ * ```js bun
+ * import {Database} from 'bun:sqlite';
+ * import {createStore} from 'tinybase';
+ * import {createSqliteBunPersister} from 'tinybase/persisters/persister-sqlite-bun';
+ *
+ * const db = new Database(':memory:');
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createSqliteBunPersister(store, db, {
+ *   mode: 'tabular',
+ *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
+ * });
+ *
+ * await persister.save();
+ * console.log(db.query('SELECT * FROM pets;').all());
+ * // -> [{_id: 'fido', species: 'dog'}]
+ *
+ * db.query(`INSERT INTO pets (_id, species) VALUES ('felix', 'cat')`).run();
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * await persister.destroy();
+ * ```
+ * @category Creation
+ * @since v6.1.0
+ */
+export function createSqliteBunPersister(
+  store: Store | MergeableStore,
+  db: Database,
+  configOrStoreTableName?: DatabasePersisterConfig | string,
+  onSqlCommand?: (sql: string, params?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): SqliteBunPersister;

package/@types/persisters/persister-sqlite-bun/with-schemas/index.d.ts

@@ -0,0 +1,178 @@
+/**
+ * The persister-sqlite-bun module of the TinyBase project lets you save and
+ * load Store data to and from a local Bun SQLite database (in an appropriate
+ * environment).
+ * @see Database Persistence guide
+ * @packageDocumentation
+ * @module persister-sqlite-bun
+ * @since v6.1.0
+ */
+import type {Database} from 'bun:sqlite';
+import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.ts';
+import type {
+  OptionalSchemas,
+  Store,
+} from '../../../store/with-schemas/index.d.ts';
+import type {
+  DatabasePersisterConfig,
+  Persister,
+  Persists,
+} from '../../with-schemas/index.d.ts';
+
+/**
+ * The SqliteBunPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local Bun SQLite database.
+ *
+ * You should use the createSqliteBunPersister function to create a
+ * SqliteBunPersister object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getDb method for accessing a reference to the database instance the
+ * Store is being persisted to.
+ * @category Persister
+ * @since v6.1.0
+ */
+export interface SqliteBunPersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas, Persists.StoreOrMergeableStore> {
+  /**
+   * The getDb method returns a reference to the database instance the Store is
+   * being persisted to.
+   * @returns A reference to the database instance.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the database instance back out again.
+   *
+   * ```js bun
+   * import {Database} from 'bun:sqlite';
+   * import {createStore} from 'tinybase';
+   * import {createSqliteBunPersister} from 'tinybase/persisters/persister-sqlite-bun';
+   *
+   * const db = new Database(':memory:');
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createSqliteBunPersister(store, db, 'my_tinybase');
+   *
+   * console.log(persister.getDb() == db);
+   * // -> true
+   *
+   * await persister.destroy();
+   * ```
+   * @category Getter
+   * @since v6.1.0
+   */
+  getDb(): Database;
+}
+
+/**
+ * The createSqliteBunPersister function creates a SqliteBunPersister object
+ * that can persist the Store to a local Bun SQLite database.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createSqliteBunPersister(
+ *   store: Store | MergeableStore,
+ *   db: Database,
+ *   configOrStoreTableName?: DatabasePersisterConfig | string,
+ *   onSqlCommand?: (sql: string, params?: any[]) => void,
+ *   onIgnoredError?: (error: any) => void,
+ * ): SqliteBunPersister;
+ * ```
+ *
+ * A SqliteBunPersister 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
+ * `db` parameter which identifies the database instance.
+ *
+ * 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 or MergeableStore to persist.
+ * @param db The database instance that was returned from `new Database(...)`.
+ * @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 SqliteBunPersister object.
+ * @example
+ * This example creates a SqliteBunPersister object and persists the Store to a
+ * local SQLite 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 bun
+ * import {Database} from 'bun:sqlite';
+ * import {createStore} from 'tinybase';
+ * import {createSqliteBunPersister} from 'tinybase/persisters/persister-sqlite-bun';
+ *
+ * const db = new Database(':memory:');
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createSqliteBunPersister(store, db, 'my_tinybase');
+ *
+ * await persister.save();
+ * // Store will be saved to the database.
+ *
+ * console.log(db.query('SELECT * FROM my_tinybase;').all());
+ * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * db.query(
+ *   'UPDATE my_tinybase SET store = ' +
+ *     `'[{"pets":{"felix":{"species":"cat"}}},{}]' WHERE _id = '_';`,
+ * ).run();
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {felix: {species: 'cat'}}}
+ *
+ * await persister.destroy();
+ * ```
+ * @example
+ * This example creates a SqliteBunPersister object and persists the Store to a
+ * local SQLite database with tabular mapping.
+ *
+ * ```js bun
+ * import {Database} from 'bun:sqlite';
+ * import {createStore} from 'tinybase';
+ * import {createSqliteBunPersister} from 'tinybase/persisters/persister-sqlite-bun';
+ *
+ * const db = new Database(':memory:');
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createSqliteBunPersister(store, db, {
+ *   mode: 'tabular',
+ *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
+ * });
+ *
+ * await persister.save();
+ * console.log(db.query('SELECT * FROM pets;').all());
+ * // -> [{_id: 'fido', species: 'dog'}]
+ *
+ * db.query(`INSERT INTO pets (_id, species) VALUES ('felix', 'cat')`).run();
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * await persister.destroy();
+ * ```
+ * @category Creation
+ * @since v6.1.0
+ */
+export function createSqliteBunPersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas> | MergeableStore<Schemas>,
+  db: Database,
+  configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
+  onSqlCommand?: (sql: string, params?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): SqliteBunPersister<Schemas>;