tinybase 5.0.0-beta.9 → 5.0.0

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

@@ -1,172 +0,0 @@
-/**
- * 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 {DatabasePersisterConfig, Persister} from '../persisters';
-import {SQLiteDatabase} from 'expo-sqlite/next';
-import {Store} from '../store';
-
-/**
- * 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 {
-  /**
-   * 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
-   * const db = SQLite.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
- * const db = SQLite.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 = '_';`,
- *   ),
- * );
- * 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
- * const db = SQLite.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,
-  db: SQLiteDatabase,
-  configOrStoreTableName?: DatabasePersisterConfig | string,
-  onSqlCommand?: (sql: string, args?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): ExpoSqliteNextPersister;

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

@@ -1,173 +0,0 @@
-/**
- * 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 {DatabasePersisterConfig, Persister} from '../persisters';
-import {SQLiteDatabase} from 'expo-sqlite';
-import {Store} from '../store';
-
-/**
- * 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 extends Persister {
-  /**
-   * 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
-   * const db = SQLite.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).
- *
- * 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
- * const db = SQLite.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
- * const db = SQLite.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(
-  store: Store,
-  db: SQLiteDatabase,
-  configOrStoreTableName?: DatabasePersisterConfig | string,
-  onSqlCommand?: (sql: string, args?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): ExpoSqlitePersister;

package/lib/types/persisters/persister-file.d.ts

@@ -1,82 +0,0 @@
-/**
- * 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 {MergeableStore} from '../mergeable-store';
-import {Persister} from '../persisters';
-import {Store} from '../store';
-
-/**
- * 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<true> {
-  /**
-   * 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
-   * 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
- * 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;

package/lib/types/persisters/persister-indexed-db.d.ts

@@ -1,110 +0,0 @@
-/**
- * The persister-indexed-db module of the TinyBase project lets you save and
- * load Store data to and from browser IndexedDB storage.
- * @see Persisting Data guide
- * @packageDocumentation
- * @module persister-indexed-db
- */
-
-import {Persister} from '../persisters';
-import {Store} from '../store';
-
-/**
- * The IndexedDbPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getDbName method for accessing the unique key of
- * the IndexedDB the Store is being persisted to.
- *
- * You should use the createIndexedDbPersister function to create an
- * IndexedDbPersister object.
- * @category Persister
- * @since v4.3.14
- */
-export interface IndexedDbPersister extends Persister {
-  /**
-   * The getDbName method returns the unique key of the IndexedDB the Store is
-   * being persisted to.
-   * @returns The unique key of the IndexedDB.
-   * @example
-   * This example creates a Persister object against a newly-created Store and
-   * then gets the unique key of the IndexedDB back out again.
-   *
-   * ```js
-   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
-   * const persister = createIndexedDbPersister(store, 'petStore');
-   *
-   * console.log(persister.getDbName());
-   * // -> 'petStore'
-   *
-   * persister.destroy();
-   * ```
-   * @category Getter
-   * @since v4.3.14
-   */
-  getDbName(): string;
-}
-
-/**
- * The createIndexedDbPersister function creates a Persister object that can
- * persist the Store to the browser's IndexedDB storage.
- *
- * As well as providing a reference to the Store to persist, you must provide a
- * `dbName` parameter which is unique to your application. This is the key used
- * to identify which IndexedDB to use.
- *
- * Within that database, this Persister will create two object stores: one
- * called 't', and one called 'v'. These will contain the Store's tabular and
- * key-value data respectively, using 'k' and 'v' to store the key and value of
- * each entry, as shown in the example.
- *
- * Note that it is not possible to reactively detect changes to a browser's
- * IndexedDB. If you do choose to enable automatic loading for the Persister
- * (with the startAutoLoad method), it needs to poll the database for changes.
- * The `autoLoadIntervalSeconds` method is used to indicate how often to do
- * this.
- * @param store The Store to persist.
- * @param dbName The unique key to identify the IndexedDB to use.
- * @param autoLoadIntervalSeconds How often to poll the database when in
- * 'autoLoad' mode, defaulting to 1.
- * @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 IndexedDbPersister object.
- * @example
- * This example creates a IndexedDbPersister object and persists the Store to
- * the browser's IndexedDB storage.
- *
- * ```js
- * const store = createStore()
- *   .setTable('pets', {fido: {species: 'dog'}})
- *   .setTable('species', {dog: {price: 5}})
- *   .setValues({open: true});
- * const persister = createIndexedDbPersister(store, 'petStore');
- *
- * await persister.save();
- * // IndexedDB ->
- * //   database petStore:
- * //     objectStore t:
- * //       object 0:
- * //         k: "pets"
- * //         v: {fido: {species: dog}}
- * //       object 1:
- * //         k: "species"
- * //         v: {dog: {price: 5}}
- * //     objectStore v:
- * //       object 0:
- * //         k: "open"
- * //         v: true
- *
- * persister.destroy();
- * ```
- * @category Creation
- * @since v4.2.0
- */
-export function createIndexedDbPersister(
-  store: Store,
-  dbName: string,
-  autoLoadIntervalSeconds?: number,
-  onIgnoredError?: (error: any) => void,
-): IndexedDbPersister;

package/lib/types/persisters/persister-libsql.d.ts

@@ -1,142 +0,0 @@
-/**
- * The persister-libsql module of the TinyBase project lets you save and load
- * Store data to and from a local LibSQL database (in an appropriate
- * environment).
- * @see Persisting Data guide
- * @packageDocumentation
- * @module persister-libsql
- * @since v4.7.0
- */
-
-import {DatabasePersisterConfig, Persister} from '../persisters';
-import {Client} from '@libsql/client';
-import {Store} from '../store';
-
-/**
- * The LibSqlPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getClient method for accessing a reference to the
- * database client the Store is being persisted to.
- *
- * You should use the createLibSqlPersister function to create a LibSqlPersister
- * object.
- * @since v4.7.0
- */
-export interface LibSqlPersister extends Persister {
-  /**
-   * The getClient method returns a reference to the database client the Store
-   * is being persisted to.
-   * @returns A reference to the database client.
-   * @example
-   * This example creates a Persister object against a newly-created Store and
-   * then gets the database client back out again.
-   *
-   * ```js yolo
-   * const client = createClient({url: 'file:my.db'});
-   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
-   * const persister = createLibSqlPersister(store, client, 'my_tinybase');
-   *
-   * console.log(persister.getClient() == client);
-   * // -> true
-   *
-   * persister.destroy();
-   * ```
-   * @category Getter
-   * @since v4.7.0
-   */
-  getClient(): Client;
-}
-
-/**
- * The createLibSqlPersister function creates a Persister object that can
- * persist the Store to a local LibSQL database (in an appropriate environment).
- *
- * As well as providing a reference to the Store to persist, you must provide a
- * `client` parameter which identifies the database 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 db The database client that was returned from `createClient(...)`.
- * @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 LibSqlPersister object.
- * @example
- * This example creates a LibSqlPersister 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
- * const client = createClient({url: 'file:my.db'});
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createLibSqlPersister(store, client, 'my_tinybase');
- *
- * await persister.save();
- * // Store will be saved to the database.
- *
- * console.log((await client.execute('SELECT * FROM my_tinybase;')).rows);
- * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
- *
- * await client.execute(
- *   '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 LibSqlPersister object and persists the Store to a
- * local SQLite database with tabular mapping.
- *
- * ```js yolo
- * const client = createClient({url: 'file:my.db'});
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createLibSqlPersister(store, client, {
- *   mode: 'tabular',
- *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
- * });
- *
- * await persister.save();
- * console.log((await client.execute('SELECT * FROM pets;')).rows);
- * // -> [{_id: 'fido', species: 'dog'}]
- *
- * await client.execute(
- *   `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.7.0
- */
-export function createLibSqlPersister(
-  store: Store,
-  client: Client,
-  configOrStoreTableName?: DatabasePersisterConfig | string,
-  onSqlCommand?: (sql: string, args?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): LibSqlPersister;