tinybase 5.0.0-beta.2 → 5.0.0-beta.21

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

@@ -1,146 +0,0 @@
-/**
- * The persister-automerge module of the TinyBase project provides a way to save
- * and load Store data, to and from an Automerge document.
- *
- * A single entry point, the createAutomergePersister function, is provided,
- * which returns a new Persister object that can bind a Store to a provided
- * Automerge document handle (and in turn, its document).
- * @see Synchronizing Data guide
- * @packageDocumentation
- * @module persister-automerge
- * @since v4.0.0
- */
-
-import {DocHandle} from '@automerge/automerge-repo';
-import {Persister} from '../persisters';
-import {Store} from '../store';
-
-/**
- * The AutomergePersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getDocHandle method for accessing the Automerge
- * document handler the Store is being persisted to.
- * @category Persister
- * @since v4.3.14
- */
-export interface AutomergePersister extends Persister {
-  /**
-   * The getDocHandle method returns the Automerge document handler the Store is
-   * being persisted to.
-   * @returns The Automerge document handler.
-   * @example
-   * This example creates a Persister object against a newly-created Store and
-   * then gets the Automerge document handler back out again.
-   *
-   * ```js
-   * const docHandler = new AutomergeRepo.Repo({network: []}).create();
-   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
-   * const persister = createAutomergePersister(store, docHandler);
-   *
-   * console.log(persister.getDocHandle() == docHandler);
-   * // -> true
-   *
-   * persister.destroy();
-   * ```
-   * @category Getter
-   * @since v4.3.14
-   */
-  getDocHandle(): DocHandle<any>;
-}
-
-/**
- * The createAutomergePersister function creates a Persister object that can
- * persist the Store to an Automerge document.
- *
- * As well as providing a reference to the Store to persist, you must provide
- * the Automerge document handler to persist it with.
- * @param store The Store to persist.
- * @param docHandle The Automerge document handler to persist the Store with.
- * @param docMapName The name of the map used inside the Automerge document to
- * sync the Store to (which otherwise will default to 'tinybase').
- * @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 AutomergePersister object.
- * @example
- * This example creates a AutomergePersister object and persists the Store to an
- * Automerge document.
- *
- * ```js
- * const docHandler = new AutomergeRepo.Repo({network: []}).create();
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createAutomergePersister(store, docHandler);
- *
- * await persister.save();
- * // Store will be saved to the document.
- *
- * console.log(await docHandler.doc());
- * // -> {tinybase: {t: {pets: {fido: {species: 'dog'}}}, v: {}}}
- *
- * persister.destroy();
- * ```
- * @example
- * This more complex example uses Automerge networking to keep two Store objects
- * (each with their own Persister objects and Automerge documents) in sync with
- * each other using a network.
- *
- * ```js
- * // Bind the first Store to a network-enabled automerge-repo
- * const repo1 = new AutomergeRepo.Repo({
- *   network: [new BroadcastChannelNetworkAdapter()],
- * });
- * const docHandler1 = repo1.create();
- * await docHandler1.doc();
- * const store1 = createStore();
- * const persister1 = createAutomergePersister(store1, docHandler1);
- * await persister1.startAutoLoad();
- * await persister1.startAutoSave();
- *
- * // Bind the second Store to a different network-enabled automerge-repo
- * const repo2 = new AutomergeRepo.Repo({
- *   network: [new BroadcastChannelNetworkAdapter()],
- * });
- * const docHandler2 = repo2.find(docHandler1.documentId);
- * await docHandler2.doc();
- * const store2 = createStore();
- * const persister2 = createAutomergePersister(store2, docHandler2);
- * await persister2.startAutoLoad();
- * await persister2.startAutoSave();
- *
- * // A function that waits briefly and then for the documents to synchronize
- * // with each other, merely for the purposes of sequentiality in this example.
- * const syncDocsWait = async () => {
- *   await new Promise((resolve) => setTimeout(() => resolve(0), 100));
- *   await docHandler1.doc();
- *   await docHandler2.doc();
- * };
- *
- * // Wait for the documents to synchronize in their initial state.
- * await syncDocsWait();
- *
- * // Make a change to each of the two Stores.
- * store1.setTables({pets: {fido: {species: 'dog'}}});
- * store2.setValues({open: true});
- *
- * // Wait for the documents to synchronize in their new state.
- * await syncDocsWait();
- *
- * // Ensure the Stores are in sync.
- * console.log(store1.getContent());
- * // -> [{pets: {fido: {species: 'dog'}}}, {open: true}]
- * console.log(store2.getContent());
- * // -> [{pets: {fido: {species: 'dog'}}}, {open: true}]
- *
- * persister1.destroy();
- * persister2.destroy();
- * ```
- * @category Creation
- * @since v4.0.0
- */
-export function createAutomergePersister(
-  store: Store,
-  docHandle: DocHandle<any>,
-  docMapName?: string,
-  onIgnoredError?: (error: any) => void,
-): AutomergePersister;

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

@@ -1,155 +0,0 @@
-/**
- * The persister-browser module of the TinyBase project lets you save and load
- * Store data to and from browser storage.
- *
- * Two entry points are provided, each of which returns a new Persister object
- * that can load and save a Store:
- *
- * - The createSessionPersister function returns a Persister that uses the
- *   browser's session storage.
- * - The createLocalPersister function returns a Persister that uses the
- *   browser's local storage.
- * @see Persisting Data guide
- * @packageDocumentation
- * @module persister-browser
- */
-
-import {Persister} from '../persisters';
-import {Store} from '../store';
-
-/**
- * The SessionPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
- * @category Persister
- * @since v4.3.14
- */
-export interface SessionPersister extends Persister {
-  /**
-   * The getStorageName method returns the unique key of the storage location
-   * the Store is being persisted to.
-   * @returns The unique key of the storage location.
-   * @example
-   * This example creates a Persister object against a newly-created Store and
-   * then gets the unique key of the storage location back out again.
-   *
-   * ```js
-   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
-   * const persister = createSessionPersister(store, 'pets');
-   *
-   * console.log(persister.getStorageName());
-   * // -> 'pets'
-   *
-   * persister.destroy();
-   * ```
-   * @category Getter
-   * @since v4.3.14
-   */
-  getStorageName(): string;
-}
-
-/**
- * The LocalPersister interface is a minor extension to the Persister interface.
- *
- * It simply provides an extra getStorageName method for accessing the unique
- * key of the storage location the Store is being persisted to.
- * @category Persister
- * @since v4.3.14
- */
-export interface LocalPersister extends Persister {
-  /**
-   * The getStorageName method returns the unique key of the storage location
-   * the Store is being persisted to.
-   * @returns The unique key of the storage location.
-   * @example
-   * This example creates a Persister object against a newly-created Store and
-   * then gets the unique key of the storage location back out again.
-   *
-   * ```js
-   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
-   * const persister = createLocalPersister(store, 'pets');
-   *
-   * console.log(persister.getStorageName());
-   * // -> 'pets'
-   *
-   * persister.destroy();
-   * ```
-   * @category Getter
-   * @since v4.3.14
-   */
-  getStorageName(): string;
-}
-
-/**
- * The createSessionPersister function creates a Persister object that can
- * persist the Store to the browser's session storage.
- *
- * As well as providing a reference to the Store to persist, you must provide a
- * `storageName` parameter which is unique to your application. This is the key
- * that the browser uses to identify the storage location.
- * @param store The Store to persist.
- * @param storageName The unique key to identify the storage location.
- * @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 SessionPersister object.
- * @example
- * This example creates a SessionPersister object and persists the Store to the
- * browser's session storage.
- *
- * ```js
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createSessionPersister(store, 'pets');
- *
- * await persister.save();
- * console.log(sessionStorage.getItem('pets'));
- * // -> '[{"pets":{"fido":{"species":"dog"}}},{}]'
- *
- * persister.destroy();
- * sessionStorage.clear();
- * ```
- * @category Creation
- */
-export function createSessionPersister(
-  store: Store,
-  storageName: string,
-  onIgnoredError?: (error: any) => void,
-): SessionPersister;
-
-/**
- * The createLocalPersister function creates a Persister object that can persist
- * the Store to the browser's local storage.
- *
- * As well as providing a reference to the Store to persist, you must provide a
- * `storageName` parameter which is unique to your application. This is the key
- * that the browser uses to identify the storage location.
- * @param store The Store to persist.
- * @param storageName The unique key to identify the storage location.
- * @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 LocalPersister object.
- * @example
- * This example creates a LocalPersister object and persists the Store to the
- * browser's local storage.
- *
- * ```js
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createLocalPersister(store, 'pets');
- *
- * await persister.save();
- * console.log(localStorage.getItem('pets'));
- * // -> '[{"pets":{"fido":{"species":"dog"}}},{}]'
- *
- * persister.destroy();
- * localStorage.clear();
- * ```
- * @category Creation
- */
-export function createLocalPersister(
-  store: Store,
-  storageName: string,
-  onIgnoredError?: (error: any) => void,
-): LocalPersister;

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

@@ -1,142 +0,0 @@
-/**
- * The persister-cr-sqlite-wasm module of the TinyBase project lets you save and
- * load Store data to and from a local CR-SQLite database (in an appropriate
- * environment).
- * @see Persisting Data guide
- * @packageDocumentation
- * @module persister-cr-sqlite-wasm
- * @since v4.0.0
- */
-
-import {DatabasePersisterConfig, Persister} from '../persisters';
-import {DB} from '@vlcn.io/crsqlite-wasm';
-import {Store} from '../store';
-
-/**
- * The CrSqliteWasmPersister 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.
- * @category Persister
- * @since v4.3.14
- */
-export interface CrSqliteWasmPersister 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
-   * const crSqlite3 = await initWasm();
-   * const db = await crSqlite3.open();
-   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
-   * const persister = createCrSqliteWasmPersister(store, db, 'my_tinybase');
-   *
-   * console.log(persister.getDb() == db);
-   * // -> true
-   *
-   * persister.destroy();
-   * ```
-   * @category Getter
-   * @since v4.3.14
-   */
-  getDb(): DB;
-}
-
-/**
- * The createCrSqliteWasmPersister function creates a Persister object that can
- * persist the Store to a local CR-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 `crSqlite3.open(...)`.
- * @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 CrSqliteWasmPersister object.
- * @example
- * This example creates a CrSqliteWasmPersister object and persists the Store to
- * a local CR-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 crSqlite3 = await initWasm();
- * const db = await crSqlite3.open();
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createCrSqliteWasmPersister(store, db, 'my_tinybase');
- *
- * await persister.save();
- * // Store will be saved to the database.
- *
- * console.log(await db.execO('SELECT * FROM my_tinybase;'));
- * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
- *
- * await 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 CrSqliteWasmPersister object and persists the Store to
- * a local SQLite database with tabular mapping.
- *
- * ```js
- * const crSqlite3 = await initWasm();
- * const db = await crSqlite3.open();
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createCrSqliteWasmPersister(store, db, {
- *   mode: 'tabular',
- *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
- * });
- *
- * await persister.save();
- * console.log(await db.execO('SELECT * FROM pets;'));
- * // -> [{_id: 'fido', species: 'dog'}]
- *
- * await 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 createCrSqliteWasmPersister(
-  store: Store,
-  db: DB,
-  configOrStoreTableName?: DatabasePersisterConfig | string,
-  onSqlCommand?: (sql: string, args?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): CrSqliteWasmPersister;

package/lib/types/persisters/persister-electric-sql.d.ts

@@ -1,165 +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 {DatabasePersisterConfig, Persister} from '../persisters';
-import {ElectricClient} from 'electric-sql/client/model';
-import {Store} from '../store';
-
-/**
- * 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.
- * @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
-   * const electricClient = await electrify(
-   *   await ElectricDatabase.init('electric.db', ''),
-   *   schema,
-   *   {url: ELECTRIC_URL},
-   * );
-   * 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
- * const electricClient = await electrify(
- *   await ElectricDatabase.init('electric.db', ''),
- *   schema,
- *   {url: ELECTRIC_URL},
- * );
- * 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
- * const electricClient = await electrify(
- *   await ElectricDatabase.init('electric.db', ''),
- *   schema,
- *   {url: ELECTRIC_URL},
- * );
- * 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;