tinybase 5.0.0-beta.19 → 5.0.0-beta.20

package/umd/@types/persisters/persister-electric-sql/index.d.ts

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

package/umd/@types/persisters/persister-electric-sql/with-schemas/index.d.ts

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

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

@@ -1,186 +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 type {DatabasePersisterConfig, Persister} from '../index.d.ts';
-import type {MergeableStore} from '../../mergeable-store/index.d.ts';
-import type {SQLiteDatabase} from 'expo-sqlite';
-import type {Store} from '../../store/index.d.ts';
-
-/**
- * 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<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).
- *
- * 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(
-  store: Store | MergeableStore,
-  db: SQLiteDatabase,
-  configOrStoreTableName?: DatabasePersisterConfig | string,
-  onSqlCommand?: (sql: string, args?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): ExpoSqlitePersister;