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

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

@@ -1,199 +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 type {
-  OptionalSchemas,
-  Store,
-} from '../../../store/with-schemas/index.d.ts';
-import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.ts';
-import type {Persister} from '../../with-schemas/index.d.ts';
-
-/**
- * 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.
- *
- * You should use the createSessionPersister function to create a
- * SessionPersister object.
- * @category Persister
- * @since v4.3.14
- */
-export interface SessionPersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, 3> {
-  /**
-   * 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
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
-   * import {createStore} from 'tinybase';
-   *
-   * 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.
- *
- * You should use the createLocalPersister function to create a LocalPersister
- * object.
- * @category Persister
- * @since v4.3.14
- */
-export interface LocalPersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, 3> {
-  /**
-   * 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
-   * import {createLocalPersister} from 'tinybase/persisters/persister-browser';
-   * import {createStore} from 'tinybase';
-   *
-   * 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.
- *
- * This has schema-based typing. The following is a simplified representation:
- *
- * ```ts override
- * createSessionPersister(
- *   store: Store | MergeableStore,
- *   storageName: string,
- *   onIgnoredError?: (error: any) => void,
- * ): SessionPersister;
- * ```
- *
- * 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
- * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
- * import {createStore} from 'tinybase';
- *
- * 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<Schemas extends OptionalSchemas>(
-  store: Store<Schemas> | MergeableStore<Schemas>,
-  storageName: string,
-  onIgnoredError?: (error: any) => void,
-): SessionPersister<Schemas>;
-
-/**
- * The createLocalPersister function creates a Persister object that can persist
- * the Store to the browser's local storage.
- *
- * This has schema-based typing. The following is a simplified representation:
- *
- * ```ts override
- * createLocalPersister(
- *   store: Store | MergeableStore,
- *   storageName: string,
- *   onIgnoredError?: (error: any) => void,
- * ): LocalPersister;
- * ```
- *
- * 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
- * import {createLocalPersister} from 'tinybase/persisters/persister-browser';
- * import {createStore} from 'tinybase';
- *
- * 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<Schemas extends OptionalSchemas>(
-  store: Store<Schemas> | MergeableStore<Schemas>,
-  storageName: string,
-  onIgnoredError?: (error: any) => void,
-): LocalPersister<Schemas>;

package/es6/@types/persisters/persister-cr-sqlite-wasm/index.d.ts

@@ -1,157 +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 type {DatabasePersisterConfig, Persister} from '../index.d.ts';
-import type {DB} from '@vlcn.io/crsqlite-wasm';
-import type {Store} from '../../store/index.d.ts';
-
-/**
- * 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.
- *
- * You should use the createCrSqliteWasmPersister function to create a
- * CrSqliteWasmPersister object.
- * @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
-   * import {createCrSqliteWasmPersister} from 'tinybase/persisters/persister-cr-sqlite-wasm';
-   * import {createStore} from 'tinybase';
-   * import initWasm from '@vlcn.io/crsqlite-wasm';
-   *
-   * 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
- * import {createCrSqliteWasmPersister} from 'tinybase/persisters/persister-cr-sqlite-wasm';
- * import {createStore} from 'tinybase';
- * import initWasm from '@vlcn.io/crsqlite-wasm';
- *
- * 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
- * import {createCrSqliteWasmPersister} from 'tinybase/persisters/persister-cr-sqlite-wasm';
- * import {createStore} from 'tinybase';
- * import initWasm from '@vlcn.io/crsqlite-wasm';
- *
- * 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/es6/@types/persisters/persister-cr-sqlite-wasm/with-schemas/index.d.ts

@@ -1,176 +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 type {
-  DatabasePersisterConfig,
-  Persister,
-} from '../../with-schemas/index.d.ts';
-import type {
-  OptionalSchemas,
-  Store,
-} from '../../../store/with-schemas/index.d.ts';
-import type {DB} from '@vlcn.io/crsqlite-wasm';
-
-/**
- * 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.
- *
- * You should use the createCrSqliteWasmPersister function to create a
- * CrSqliteWasmPersister object.
- * @category Persister
- * @since v4.3.14
- */
-export interface CrSqliteWasmPersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas> {
-  /**
-   * 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
-   * import {createCrSqliteWasmPersister} from 'tinybase/persisters/persister-cr-sqlite-wasm';
-   * import {createStore} from 'tinybase';
-   * import initWasm from '@vlcn.io/crsqlite-wasm';
-   *
-   * 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).
- *
- * This has schema-based typing. The following is a simplified representation:
- *
- * ```ts override
- * createCrSqliteWasmPersister(
- *   store: Store,
- *   db: DB,
- *   configOrStoreTableName?: DatabasePersisterConfig | string,
- *   onSqlCommand?: (sql: string, args?: any[]) => void,
- *   onIgnoredError?: (error: any) => void,
- * ): CrSqliteWasmPersister;
- * ```
- *
- * 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
- * import {createCrSqliteWasmPersister} from 'tinybase/persisters/persister-cr-sqlite-wasm';
- * import {createStore} from 'tinybase';
- * import initWasm from '@vlcn.io/crsqlite-wasm';
- *
- * 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
- * import {createCrSqliteWasmPersister} from 'tinybase/persisters/persister-cr-sqlite-wasm';
- * import {createStore} from 'tinybase';
- * import initWasm from '@vlcn.io/crsqlite-wasm';
- *
- * 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<Schemas extends OptionalSchemas>(
-  store: Store<Schemas>,
-  db: DB,
-  configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
-  onSqlCommand?: (sql: string, args?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): CrSqliteWasmPersister<Schemas>;