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

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

@@ -1,157 +0,0 @@
-/**
- * The persister-powersync module of the TinyBase project lets you save and load
- * Store data to and from a local SQLite database that is automatically synced
- * using the PowerSync service.
- * @see Persisting Data guide
- * @packageDocumentation
- * @module persister-powersync
- * @since v4.8.0
- */
-
-import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
-import type {AbstractPowerSyncDatabase} from '@journeyapps/powersync-sdk-common';
-import {Store} from '../store.d.ts';
-
-/**
- * The PowerSyncPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getPowerSync method for accessing a reference to
- * the PowerSync instance the Store is being persisted to.
- *
- * You should use the createPowerSyncPersister function to create a
- * PowerSyncPersister object.
- * @since v4.8.0
- */
-export interface PowerSyncPersister extends Persister {
-  /**
-   * The getPowerSync method returns a reference to the PowerSync instance the
-   * Store is being persisted to.
-   * @returns A reference to the PowerSync instance.
-   * @example
-   * This example creates a Persister object against a newly-created Store and
-   * then gets the PowerSync instance back out again.
-   *
-   * ```js yolo
-   * const ps = `usePowerSync`();
-   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
-   * const persister = createPowerSyncPersister(store, ps, 'my_tinybase');
-   *
-   * console.log(persister.getPowerSync() == ps);
-   * // -> true
-   *
-   * persister.destroy();
-   * ```
-   * @category Getter
-   * @since v4.8.0
-   */
-  getPowerSync(): AbstractPowerSyncDatabase;
-}
-
-/**
- * The createPowerSyncPersister function creates a Persister object that can
- * persist the Store to a local SQLite database that is automatically synced
- * using the PowerSync service.
- *
- * As well as providing a reference to the Store to persist, you must provide a
- * `powerSync` parameter which identifies the PowerSync 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 powerSync The PowerSync instance.
- * @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 PowerSyncPersister object.
- * @example
- * This example creates a PowerSyncPersister object and persists the Store to a
- * local PowerSync instance.
- * It makes a change to the database directly and then reloads it back into the
- * Store.
- *
- * ```js yolo
- * const ps = usePowerSync();
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createPowerSyncPersister(store, ps, 'my_tinybase');
- *
- * await persister.save();
- * // Store will be saved to the database.
- *
- * console.log(
- *   await new Promise((resolve) =>
- *     ps.execute('SELECT * FROM my_tinybase;', (_, rows) => resolve(rows)),
- *   ),
- * );
- * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
- *
- * await new Promise((resolve) =>
- *   ps.execute(
- *     '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 PowerSyncPersister object and persists the Store to a
- * local PowerSync instance with tabular mapping.
- *
- * ```js yolo
- * const ps = usePowerSync();
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createPowerSyncPersister(store, ps, {
- *   mode: 'tabular',
- *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
- * });
- *
- * await persister.save();
- * console.log(
- *   await new Promise((resolve) =>
- *     ps.execute('SELECT * FROM pets;', (_, rows) => resolve(rows)),
- *   ),
- * );
- * // -> [{_id: 'fido', species: 'dog'}]
- *
- * await new Promise((resolve) =>
- *   ps.execute(
- *     `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.8.0
- */
-export function createPowerSyncPersister(
-  store: Store,
-  powerSync: AbstractPowerSyncDatabase,
-  configOrStoreTableName?: DatabasePersisterConfig | string,
-  onSqlCommand?: (sql: string, args?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): PowerSyncPersister;

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

@@ -1,107 +0,0 @@
-/**
- * The persister-remote module of the TinyBase project lets you save and load
- * Store data to and from a remote server.
- * @see Persisting Data guide
- * @packageDocumentation
- * @module persister-remote
- */
-
-import {Persister} from '../persisters.d.ts';
-import {Store} from '../store.d.ts';
-
-/**
- * The RemotePersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getUrls method for accessing the URLs the Store
- * is being persisted to.
- *
- * You should use the createRemotePersister function to create a RemotePersister
- * object.
- * @category Persister
- * @since v4.3.14
- */
-export interface RemotePersister extends Persister {
-  /**
-   * The getUrls method returns the URLs the Store is being persisted to.
-   * @returns The load and save URLs as a two-item array.
-   * @example
-   * This example creates a RemotePersister object against a newly-created Store
-   * and then gets the URLs back out again.
-   *
-   * ```js
-   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
-   * const persister = createRemotePersister(
-   *   store,
-   *   'https://example.com/load',
-   *   'https://example.com/save',
-   *   5,
-   * );
-   *
-   * console.log(persister.getUrls());
-   * // -> ['https://example.com/load', 'https://example.com/save']
-   *
-   * persister.destroy();
-   * ```
-   * @category Getter
-   * @since v4.3.14
-   */
-  getUrls(): [string, string];
-}
-
-/**
- * The createRemotePersister function creates a Persister object that can
- * persist the Store to a remote server.
- *
- * As well as providing a reference to the Store to persist, you must provide
- * `loadUrl` and `saveUrl` parameters. These identify the endpoints of the
- * server that support the `GET` method (to fetch the Store JSON to load) and
- * the `POST` method (to send the Store JSON to save) respectively.
- *
- * For when you choose to enable automatic loading for the Persister (with the
- * startAutoLoad method), it will poll the loadUrl for changes, using the
- * `ETag` HTTP header to identify if things have changed. The
- * `autoLoadIntervalSeconds` method is used to indicate how often to do this.
- *
- * If you are implementing the server portion of this functionality yourself,
- * remember to ensure that the `ETag` header changes every time the server's
- * Store content does - otherwise changes will not be detected by the client.
- * @param store The Store to persist.
- * @param loadUrl The endpoint that supports a `GET` method to load JSON.
- * @param saveUrl The endpoint that supports a `POST` method to save JSON.
- * @param autoLoadIntervalSeconds How often to poll the `loadUrl` when
- * automatically loading changes from the server, defaulting to 5.
- * @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 RemotePersister object.
- * @example
- * This example creates a RemotePersister object and persists the Store to a
- * remote server.
- *
- * ```js yolo
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createRemotePersister(
- *   store,
- *   'https://example.com/load',
- *   'https://example.com/save',
- *   5,
- * );
- *
- * await persister.save();
- * // Store JSON will be sent to server in a POST request.
- *
- * await persister.load();
- * // Store JSON will be fetched from server with a GET request.
- *
- * persister.destroy();
- * ```
- * @category Creation
- */
-export function createRemotePersister(
-  store: Store,
-  loadUrl: string,
-  saveUrl: string,
-  autoLoadIntervalSeconds?: number,
-  onIgnoredError?: (error: any) => void,
-): RemotePersister;

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

@@ -1,157 +0,0 @@
-/**
- * The persister-sqlite-wasm module of the TinyBase project lets you save and
- * load Store data to and from a local SQLite database (in an appropriate
- * environment).
- * @see Persisting Data guide
- * @packageDocumentation
- * @module persister-sqlite-wasm
- * @since v4.0.0
- */
-
-import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
-import {Store} from '../store.d.ts';
-
-/**
- * The SqliteWasmPersister 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 createSqliteWasmPersister function to create a
- * SqliteWasmPersister object.
- * @category Persister
- * @since v4.3.14
- */
-export interface SqliteWasmPersister 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
-   * const sqlite3 = await sqlite3InitModule();
-   * const db = new sqlite3.oo1.DB(':memory:', 'c');
-   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
-   * const persister = createSqliteWasmPersister(
-   *   store,
-   *   sqlite3,
-   *   db,
-   *   'my_tinybase',
-   * );
-   *
-   * console.log(persister.getDb() == db);
-   * // -> true
-   *
-   * persister.destroy();
-   * ```
-   * @category Getter
-   * @since v4.3.14
-   */
-  getDb(): any;
-}
-
-/**
- * The createSqliteWasmPersister function creates a Persister object that can
- * persist the Store to a local SQLite database (in an appropriate environment).
- *
- * As well as providing a reference to the Store to persist, you must provide
- * `sqlite3` and `db` parameters which identify the WASM module and database
- * instance respectively.
- *
- * 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 fourth argument is a DatabasePersisterConfig object that configures which
- * of those modes to use, and settings for each. If the fourth 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 sqlite3 The WASM module that was returned from `sqlite3InitModule`.
- * @param db The database instance that was returned from `new
- * sqlite3.oo1.DB(...)`.
- * @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 SqliteWasmPersister object.
- * @example
- * This example creates a SqliteWasmPersister 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
- * const sqlite3 = await sqlite3InitModule();
- * const db = new sqlite3.oo1.DB(':memory:', 'c');
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createSqliteWasmPersister(
- *   store,
- *   sqlite3,
- *   db,
- *   'my_tinybase',
- * );
- *
- * await persister.save();
- * // Store will be saved to the database.
- *
- * console.log(db.exec('SELECT * FROM my_tinybase;', {rowMode: 'object'}));
- * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
- *
- * db.exec(
- *   '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 SqliteWasmPersister object and persists the Store to a
- * local SQLite database with tabular mapping.
- *
- * ```js
- * const sqlite3 = await sqlite3InitModule();
- * const db = new sqlite3.oo1.DB(':memory:', 'c');
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createSqliteWasmPersister(store, sqlite3, db, {
- *   mode: 'tabular',
- *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
- * });
- *
- * await persister.save();
- * console.log(db.exec('SELECT * FROM pets;', {rowMode: 'object'}));
- * // -> [{_id: 'fido', species: 'dog'}]
- *
- * db.exec(`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.0.0
- */
-export function createSqliteWasmPersister(
-  store: Store,
-  sqlite3: any,
-  db: any,
-  configOrStoreTableName?: DatabasePersisterConfig | string,
-  onSqlCommand?: (sql: string, args?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): SqliteWasmPersister;

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

@@ -1,158 +0,0 @@
-/**
- * The persister-sqlite3 module of the TinyBase project lets you save and load
- * Store data to and from a local SQLite database (in an appropriate
- * environment).
- * @see Persisting Data guide
- * @packageDocumentation
- * @module persister-sqlite3
- * @since v4.0.0
- */
-
-import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
-import {Database} from 'sqlite3';
-import {Store} from '../store.d.ts';
-
-/**
- * The Sqlite3Persister 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 createSqlite3Persister function to create a
- * Sqlite3Persister object.
- * @category Persister
- * @since v4.3.14
- */
-export interface Sqlite3Persister 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
-   * const db = new sqlite3.Database(':memory:');
-   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
-   * const persister = createSqlite3Persister(store, db, 'my_tinybase');
-   *
-   * console.log(persister.getDb() == db);
-   * // -> true
-   *
-   * persister.destroy();
-   * ```
-   * @category Getter
-   * @since v4.3.14
-   */
-  getDb(): Database;
-}
-
-/**
- * The createSqlite3Persister function creates a Persister object that can
- * persist the Store to a local SQLite database (in an appropriate environment).
- *
- * 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 `new
- * sqlite3.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, 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 Sqlite3Persister object.
- * @example
- * This example creates a Sqlite3Persister 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
- * const db = new sqlite3.Database(':memory:');
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createSqlite3Persister(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 Sqlite3Persister object and persists the Store to a
- * local SQLite database with tabular mapping.
- *
- * ```js
- * const db = new sqlite3.Database(':memory:');
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createSqlite3Persister(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.0
- */
-export function createSqlite3Persister(
-  store: Store,
-  db: Database,
-  configOrStoreTableName?: DatabasePersisterConfig | string,
-  onSqlCommand?: (sql: string, args?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): Sqlite3Persister;