tinybase 5.0.0-beta.17 → 5.0.0-beta.19

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

@@ -0,0 +1,205 @@
+/**
+ * The persister-expo-sqlite module of the TinyBase project lets you save and
+ * load Store data to and from a local Expo-SQLite database (in an appropriate
+ * React Native environment).
+ *
+ * This module provides a Persister for the legacy version of Expo's
+ * [SQLite](https://docs.expo.dev/versions/latest/sdk/sqlite) library. This API
+ * should be used if you are installing the `expo-sqlite` module.
+ *
+ * Note that TinyBase support for the modern version of Expo-SQLite
+ * (`expo-sqlite-next`) is currently available in the persister-expo-sqlite-next
+ * module.
+ *
+ * Note that this Persister is currently experimental as Expo themselves iterate
+ * on the underlying database library API.
+ * @see Persisting Data guide
+ * @packageDocumentation
+ * @module persister-expo-sqlite
+ * @since v4.0.3
+ */
+
+import type {
+  DatabasePersisterConfig,
+  Persister,
+} from '../../with-schemas/index.d.ts';
+import type {
+  OptionalSchemas,
+  Store,
+} from '../../../store/with-schemas/index.d.ts';
+import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.ts';
+import type {SQLiteDatabase} from 'expo-sqlite';
+
+/**
+ * The ExpoSqlitePersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getDb method for accessing a reference to the
+ * database instance the Store is being persisted to.
+ *
+ * You should use the createExpoSqlitePersister function to create an
+ * ExpoSqlitePersister object.
+ * @category Persister
+ * @since v4.3.14
+ */
+export interface ExpoSqlitePersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas, 3> {
+  /**
+   * 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 yolo
+   * import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite';
+   * import {createStore} from 'tinybase';
+   * import {openDatabase} from 'expo-sqlite';
+   *
+   * const db = openDatabase('my.db');
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createExpoSqlitePersister(store, db, 'my_tinybase');
+   *
+   * console.log(persister.getDb() == db);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getDb(): SQLiteDatabase;
+}
+
+/**
+ * The createExpoSqlitePersister function creates a Persister object that can
+ * persist the Store to a local Expo-SQLite database (in an appropriate React
+ * Native environment).
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createExpoSqlitePersister(
+ *   store: Store | MergeableStore,
+ *   db: SQLiteDatabase,
+ *   configOrStoreTableName?: DatabasePersisterConfig | string,
+ *   onSqlCommand?: (sql: string, args?: any[]) => void,
+ *   onIgnoredError?: (error: any) => void,
+ * ): ExpoSqlitePersister;
+ * ```
+ *
+ * Note that this Persister is currently experimental as Expo themselves iterate
+ * on the underlying database library API.
+ *
+ * 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 to persist.
+ * @param db The database instance that was returned from
+ * `SQLite.openDatabase(...)`.
+ * @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, since v4.0.4.
+ * @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.
+ * @returns A reference to the new ExpoSqlitePersister object.
+ * @example
+ * This example creates a ExpoSqlitePersister 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 yolo
+ * import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite';
+ * import {createStore} from 'tinybase';
+ * import {openDatabase} from 'expo-sqlite';
+ *
+ * const db = openDatabase('my.db');
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createExpoSqlitePersister(store, db, 'my_tinybase');
+ *
+ * await persister.save();
+ * // Store will be saved to the database.
+ *
+ * console.log(
+ *   await new Promise((resolve) =>
+ *     db.all('SELECT * FROM my_tinybase;', (_, rows) => resolve(rows)),
+ *   ),
+ * );
+ * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * await new Promise((resolve) =>
+ *   db.all(
+ *     'UPDATE my_tinybase SET store = ' +
+ *       `'[{"pets":{"felix":{"species":"cat"}}},{}]' WHERE _id = '_';`,
+ *     resolve,
+ *   ),
+ * );
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {felix: {species: 'cat'}}}
+ *
+ * persister.destroy();
+ * ```
+ * @example
+ * This example creates a ExpoSqlitePersister object and persists the Store to a
+ * local SQLite database with tabular mapping.
+ *
+ * ```js yolo
+ * import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite';
+ * import {createStore} from 'tinybase';
+ * import {openDatabase} from 'expo-sqlite';
+ *
+ * const db = openDatabase('my.db');
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createExpoSqlitePersister(store, db, {
+ *   mode: 'tabular',
+ *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
+ * });
+ *
+ * await persister.save();
+ * console.log(
+ *   await new Promise((resolve) =>
+ *     db.all('SELECT * FROM pets;', (_, rows) => resolve(rows)),
+ *   ),
+ * );
+ * // -> [{_id: 'fido', species: 'dog'}]
+ *
+ * await new Promise((resolve) =>
+ *   db.all(
+ *     `INSERT INTO pets (_id, species) VALUES ('felix', 'cat')`,
+ *     resolve,
+ *   ),
+ * );
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * persister.destroy();
+ * ```
+ * @category Creation
+ * @since v4.0.3
+ */
+export function createExpoSqlitePersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas> | MergeableStore<Schemas>,
+  db: SQLiteDatabase,
+  configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
+  onSqlCommand?: (sql: string, args?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): ExpoSqlitePersister<Schemas>;

package/es6/@types/persisters/persister-expo-sqlite-next/index.d.ts

@@ -0,0 +1,187 @@
+/**
+ * The persister-expo-sqlite-next module of the TinyBase project lets you save
+ * and load Store data to and from a local Expo-SQLite 'next' database (in an
+ * appropriate React Native environment).
+ *
+ * This module provides a Persister for the modern version of Expo's
+ * [SQLite](https://docs.expo.dev/versions/latest/sdk/sqlite)
+ * library, designated 'next' as of November 2023. This API should be used if
+ * you are installing the `expo-sqlite/next` module. In the future we expect
+ * this module to become the default.
+ *
+ * Note that TinyBase support for the legacy version of Expo-SQLite
+ * (`expo-sqlite`) is still available in the persister-expo-sqlite module.
+ *
+ * Note that this Persister is currently experimental as Expo themselves iterate
+ * on the underlying database library API.
+ * @see Persisting Data guide
+ * @packageDocumentation
+ * @module persister-expo-sqlite-next
+ * @since v4.5.0
+ */
+
+import type {DatabasePersisterConfig, Persister} from '../index.d.ts';
+import type {MergeableStore} from '../../mergeable-store/index.d.ts';
+import type {SQLiteDatabase} from 'expo-sqlite/next.d.ts';
+import type {Store} from '../../store/index.d.ts';
+
+/**
+ * The ExpoSqliteNextPersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getDb method for accessing a reference to the
+ * database instance the Store is being persisted to.
+ *
+ * You should use the createExpoSqliteNextPersister function to create an
+ * ExpoSqliteNextPersister object.
+ * @category Persister
+ * @since v4.5.0
+ */
+export interface ExpoSqliteNextPersister extends Persister<3> {
+  /**
+   * 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 yolo
+   * import {createExpoSqliteNextPersister} from 'tinybase/persisters/persister-expo-sqlite-next';
+   * import {createStore} from 'tinybase';
+   * import {openDatabaseSync} from 'expo-sqlite';
+   *
+   * const db = openDatabaseSync('my.db');
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createExpoSqliteNextPersister(store, db, 'my_tinybase');
+   *
+   * console.log(persister.getDb() == db);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.5.0
+   */
+  getDb(): SQLiteDatabase;
+}
+
+/**
+ * The createExpoSqliteNextPersister function creates a Persister object that
+ * can persist the Store to a local Expo-SQLite database (in an appropriate
+ * React Native environment).
+ *
+ * Note that this Persister is currently experimental as Expo themselves iterate
+ * on the underlying database library API.
+ *
+ * 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 to persist.
+ * @param db The database instance that was returned from
+ * `SQLite.openDatabase(...)`.
+ * @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 ExpoSqliteNextPersister object.
+ * @example
+ * This example creates a ExpoSqliteNextPersister 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 yolo
+ * import {createExpoSqliteNextPersister} from 'tinybase/persisters/persister-expo-sqlite-next';
+ * import {createStore} from 'tinybase';
+ * import {openDatabaseSync} from 'expo-sqlite';
+ *
+ * const db = openDatabaseSync('my.db');
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createExpoSqliteNextPersister(store, db, 'my_tinybase');
+ *
+ * await persister.save();
+ * // Store will be saved to the database.
+ *
+ * console.log(
+ *   await new Promise((resolve) =>
+ *     db.allAsync('SELECT * FROM my_tinybase;').then(resolve),
+ *   ),
+ * );
+ * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * await new Promise((resolve) =>
+ *   db
+ *     .allAsync(
+ *       'UPDATE my_tinybase SET store = ' +
+ *         `'[{"pets":{"felix":{"species":"cat"}}},{}]' WHERE _id = '_';`,
+ *     )
+ *     .then(resolve),
+ * );
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {felix: {species: 'cat'}}}
+ *
+ * persister.destroy();
+ * ```
+ * @example
+ * This example creates a ExpoSqliteNextPersister object and persists the Store
+ * to a local SQLite database with tabular mapping.
+ *
+ * ```js yolo
+ * import {createExpoSqliteNextPersister} from 'tinybase/persisters/persister-expo-sqlite-next';
+ * import {createStore} from 'tinybase';
+ * import {openDatabaseSync} from 'expo-sqlite';
+ *
+ * const db = openDatabaseSync('my.db');
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createExpoSqliteNextPersister(store, db, {
+ *   mode: 'tabular',
+ *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
+ * });
+ *
+ * await persister.save();
+ * console.log(
+ *   await new Promise((resolve) =>
+ *     db.allAsync('SELECT * FROM pets;').then(resolve),
+ *   ),
+ * );
+ * // -> [{_id: 'fido', species: 'dog'}]
+ *
+ * await new Promise((resolve) =>
+ *   db
+ *     .allAsync(`INSERT INTO pets (_id, species) VALUES ('felix', 'cat')`)
+ *     .then(resolve),
+ * );
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * persister.destroy();
+ * ```
+ * @category Creation
+ * @since v4.5.0
+ */
+export function createExpoSqliteNextPersister(
+  store: Store | MergeableStore,
+  db: SQLiteDatabase,
+  configOrStoreTableName?: DatabasePersisterConfig | string,
+  onSqlCommand?: (sql: string, args?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): ExpoSqliteNextPersister;

package/es6/@types/persisters/persister-expo-sqlite-next/with-schemas/index.d.ts

@@ -0,0 +1,206 @@
+/**
+ * The persister-expo-sqlite-next module of the TinyBase project lets you save
+ * and load Store data to and from a local Expo-SQLite 'next' database (in an
+ * appropriate React Native environment).
+ *
+ * This module provides a Persister for the modern version of Expo's
+ * [SQLite](https://docs.expo.dev/versions/latest/sdk/sqlite)
+ * library, designated 'next' as of November 2023. This API should be used if
+ * you are installing the `expo-sqlite/next` module. In the future we expect
+ * this module to become the default.
+ *
+ * Note that TinyBase support for the legacy version of Expo-SQLite
+ * (`expo-sqlite`) is still available in the persister-expo-sqlite module.
+ *
+ * Note that this Persister is currently experimental as Expo themselves iterate
+ * on the underlying database library API.
+ * @see Persisting Data guide
+ * @packageDocumentation
+ * @module persister-expo-sqlite-next
+ * @since v4.5.0
+ */
+
+import type {
+  DatabasePersisterConfig,
+  Persister,
+} from '../../with-schemas/index.d.ts';
+import type {
+  OptionalSchemas,
+  Store,
+} from '../../../store/with-schemas/index.d.ts';
+import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.ts';
+import type {SQLiteDatabase} from 'expo-sqlite/next.d.ts';
+
+/**
+ * The ExpoSqliteNextPersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getDb method for accessing a reference to the
+ * database instance the Store is being persisted to.
+ *
+ * You should use the createExpoSqliteNextPersister function to create an
+ * ExpoSqliteNextPersister object.
+ * @category Persister
+ * @since v4.5.0
+ */
+export interface ExpoSqliteNextPersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas, 3> {
+  /**
+   * 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 yolo
+   * import {createExpoSqliteNextPersister} from 'tinybase/persisters/persister-expo-sqlite-next';
+   * import {createStore} from 'tinybase';
+   * import {openDatabaseSync} from 'expo-sqlite';
+   *
+   * const db = openDatabaseSync('my.db');
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createExpoSqliteNextPersister(store, db, 'my_tinybase');
+   *
+   * console.log(persister.getDb() == db);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.5.0
+   */
+  getDb(): SQLiteDatabase;
+}
+
+/**
+ * The createExpoSqliteNextPersister function creates a Persister object that
+ * can persist the Store to a local Expo-SQLite database (in an appropriate
+ * React Native environment).
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createExpoSqliteNextPersister(
+ *   store: Store | MergeableStore,
+ *   db: SQLiteDatabase,
+ *   configOrStoreTableName?: DatabasePersisterConfig | string,
+ *   onSqlCommand?: (sql: string, args?: any[]) => void,
+ *   onIgnoredError?: (error: any) => void,
+ * ): ExpoSqliteNextPersister;
+ * ```
+ *
+ * Note that this Persister is currently experimental as Expo themselves iterate
+ * on the underlying database library API.
+ *
+ * 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 to persist.
+ * @param db The database instance that was returned from
+ * `SQLite.openDatabase(...)`.
+ * @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 ExpoSqliteNextPersister object.
+ * @example
+ * This example creates a ExpoSqliteNextPersister 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 yolo
+ * import {createExpoSqliteNextPersister} from 'tinybase/persisters/persister-expo-sqlite-next';
+ * import {createStore} from 'tinybase';
+ * import {openDatabaseSync} from 'expo-sqlite';
+ *
+ * const db = openDatabaseSync('my.db');
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createExpoSqliteNextPersister(store, db, 'my_tinybase');
+ *
+ * await persister.save();
+ * // Store will be saved to the database.
+ *
+ * console.log(
+ *   await new Promise((resolve) =>
+ *     db.allAsync('SELECT * FROM my_tinybase;').then(resolve),
+ *   ),
+ * );
+ * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * await new Promise((resolve) =>
+ *   db
+ *     .allAsync(
+ *       'UPDATE my_tinybase SET store = ' +
+ *         `'[{"pets":{"felix":{"species":"cat"}}},{}]' WHERE _id = '_';`,
+ *     )
+ *     .then(resolve),
+ * );
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {felix: {species: 'cat'}}}
+ *
+ * persister.destroy();
+ * ```
+ * @example
+ * This example creates a ExpoSqliteNextPersister object and persists the Store
+ * to a local SQLite database with tabular mapping.
+ *
+ * ```js yolo
+ * import {createExpoSqliteNextPersister} from 'tinybase/persisters/persister-expo-sqlite-next';
+ * import {createStore} from 'tinybase';
+ * import {openDatabaseSync} from 'expo-sqlite';
+ *
+ * const db = openDatabaseSync('my.db');
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createExpoSqliteNextPersister(store, db, {
+ *   mode: 'tabular',
+ *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
+ * });
+ *
+ * await persister.save();
+ * console.log(
+ *   await new Promise((resolve) =>
+ *     db.allAsync('SELECT * FROM pets;').then(resolve),
+ *   ),
+ * );
+ * // -> [{_id: 'fido', species: 'dog'}]
+ *
+ * await new Promise((resolve) =>
+ *   db
+ *     .allAsync(`INSERT INTO pets (_id, species) VALUES ('felix', 'cat')`)
+ *     .then(resolve),
+ * );
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * persister.destroy();
+ * ```
+ * @category Creation
+ * @since v4.5.0
+ */
+export function createExpoSqliteNextPersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas> | MergeableStore<Schemas>,
+  db: SQLiteDatabase,
+  configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
+  onSqlCommand?: (sql: string, args?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): ExpoSqliteNextPersister<Schemas>;

package/es6/@types/persisters/persister-file/index.d.ts

@@ -0,0 +1,88 @@
+/**
+ * The persister-file module of the TinyBase project lets you save and load
+ * Store data to and from a local file system (in an appropriate environment).
+ * @see Persisting Data guide
+ * @packageDocumentation
+ * @module persister-file
+ */
+
+import type {MergeableStore} from '../../mergeable-store/index.d.ts';
+import type {Persister} from '../index.d.ts';
+import type {Store} from '../../store/index.d.ts';
+
+/**
+ * The FilePersister interface is a minor extension to the Persister interface.
+ *
+ * It simply provides an extra getFilePath method for accessing the location of
+ * the local file the Store is being persisted to.
+ *
+ * You should use the createFilePersister function to create a FilePersister
+ * object.
+ * @category Persister
+ * @since v4.3.14
+ */
+export interface FilePersister extends Persister<3> {
+  /**
+   * The getFilePath method returns the location of the local file the Store is
+   * being persisted to.
+   * @returns The location of the local file.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the file location back out again.
+   *
+   * ```js
+   * import {createFilePersister} from 'tinybase/persisters/persister-file';
+   * import {createStore} from 'tinybase';
+   *
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createFilePersister(store, '/app/persisted.json');
+   *
+   * console.log(persister.getFilePath());
+   * // -> '/app/persisted.json'
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getFilePath(): string;
+}
+
+/**
+ * The createFilePersister function creates a Persister object that can persist
+ * the Store to a local file (in an appropriate environment).
+ *
+ * As well as providing a reference to the Store to persist, you must provide a
+ * `filePath` parameter which identifies the file to persist it to.
+ * @param store The Store to persist.
+ * @param filePath The location of the local file to persist the Store to.
+ * @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.
+ * @returns A reference to the new FilePersister object.
+ * @example
+ * This example creates a FilePersister object and persists the Store to a local
+ * file.
+ *
+ * ```js yolo
+ * import {createFilePersister} from 'tinybase/persisters/persister-file';
+ * import {createStore} from 'tinybase';
+ *
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createFilePersister(store, '/app/persisted.json');
+ *
+ * await persister.save();
+ * // Store JSON will be saved to the file.
+ *
+ * await persister.load();
+ * // Store JSON will be loaded from the file.
+ *
+ * persister.destroy();
+ * ```
+ * @category Creation
+ */
+export function createFilePersister(
+  store: Store | MergeableStore,
+  filePath: string,
+  onIgnoredError?: (error: any) => void,
+): FilePersister;