tinybase 6.1.0-beta.1 → 6.1.0-beta.3

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

@@ -1,186 +0,0 @@
-/**
- * The persister-expo-sqlite module of the TinyBase project lets you save and
- * load Store data to and from a Expo-SQLite database (in an appropriate React
- * Native environment).
- *
- * As of TinyBase v5.0, 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 and default as v14.0 by June 2024.
- *
- * Note that TinyBase support for the legacy version of Expo-SQLite is no longer
- * available.
- * @see Database Persistence guide
- * @packageDocumentation
- * @module persister-expo-sqlite
- * @since v4.5.0
- */
-import type {SQLiteDatabase} from 'expo-sqlite';
-import type {MergeableStore} from '../../mergeable-store/index.d.cts';
-import type {Store} from '../../store/index.d.cts';
-import type {DatabasePersisterConfig, Persister, Persists} from '../index.d.cts';
-
-/**
- * The ExpoSqlitePersister interface represents a Persister that lets you save
- * and load Store data to and from a Expo-SQLite database.
- *
- * You should use the createExpoSqlitePersister function to create an
- * ExpoSqlitePersister object.
- *
- * It is a minor extension to the Persister interface and simply provides an
- * extra getDb method for accessing a reference to the database instance the
- * Store is being persisted to.
- * @category Persister
- * @since v4.5.0
- */
-export interface ExpoSqlitePersister
-  extends Persister<Persists.StoreOrMergeableStore> {
-  /**
-   * 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 {openDatabaseSync} from 'expo-sqlite';
-   * import {createStore} from 'tinybase';
-   * import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite';
-   *
-   * const db = openDatabaseSync('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.5.0
-   */
-  getDb(): SQLiteDatabase;
-}
-
-/**
- * The createExpoSqlitePersister function creates an ExpoSqlitePersister object
- * that can persist the Store to a local Expo-SQLite database.
- *
- * An ExpoSqlitePersister supports regular Store objects, and can also be used
- * to persist the metadata of a MergeableStore when using the JSON serialization
- * mode, as described below.
- *
- * 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 or MergeableStore 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 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 {openDatabaseSync} from 'expo-sqlite';
- * import {createStore} from 'tinybase';
- * import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite';
- *
- * const db = openDatabaseSync('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.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 = '_';`,
- *     )
- *     .then(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 {openDatabaseSync} from 'expo-sqlite';
- * import {createStore} from 'tinybase';
- * import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite';
- *
- * const db = openDatabaseSync('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.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 createExpoSqlitePersister(
-  store: Store | MergeableStore,
-  db: SQLiteDatabase,
-  configOrStoreTableName?: DatabasePersisterConfig | string,
-  onSqlCommand?: (sql: string, params?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): ExpoSqlitePersister;

package/@types/persisters/persister-expo-sqlite/with-schemas/index.d.cts

@@ -1,205 +0,0 @@
-/**
- * The persister-expo-sqlite module of the TinyBase project lets you save and
- * load Store data to and from a Expo-SQLite database (in an appropriate React
- * Native environment).
- *
- * As of TinyBase v5.0, 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 and default as v14.0 by June 2024.
- *
- * Note that TinyBase support for the legacy version of Expo-SQLite is no longer
- * available.
- * @see Database Persistence guide
- * @packageDocumentation
- * @module persister-expo-sqlite
- * @since v4.5.0
- */
-import type {SQLiteDatabase} from 'expo-sqlite';
-import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.cts';
-import type {
-  OptionalSchemas,
-  Store,
-} from '../../../store/with-schemas/index.d.cts';
-import type {
-  DatabasePersisterConfig,
-  Persister,
-  Persists,
-} from '../../with-schemas/index.d.cts';
-
-/**
- * The ExpoSqlitePersister interface represents a Persister that lets you save
- * and load Store data to and from a Expo-SQLite database.
- *
- * You should use the createExpoSqlitePersister function to create an
- * ExpoSqlitePersister object.
- *
- * It is a minor extension to the Persister interface and simply provides an
- * extra getDb method for accessing a reference to the database instance the
- * Store is being persisted to.
- * @category Persister
- * @since v4.5.0
- */
-export interface ExpoSqlitePersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, Persists.StoreOrMergeableStore> {
-  /**
-   * 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 {openDatabaseSync} from 'expo-sqlite';
-   * import {createStore} from 'tinybase';
-   * import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite';
-   *
-   * const db = openDatabaseSync('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.5.0
-   */
-  getDb(): SQLiteDatabase;
-}
-
-/**
- * The createExpoSqlitePersister function creates an ExpoSqlitePersister object
- * that can persist the Store to a local Expo-SQLite database.
- *
- * This has schema-based typing. The following is a simplified representation:
- *
- * ```ts override
- * createExpoSqlitePersister(
- *   store: Store | MergeableStore,
- *   db: SQLiteDatabase,
- *   configOrStoreTableName?: DatabasePersisterConfig | string,
- *   onSqlCommand?: (sql: string, params?: any[]) => void,
- *   onIgnoredError?: (error: any) => void,
- * ): ExpoSqlitePersister;
- * ```
- *
- * An ExpoSqlitePersister supports regular Store objects, and can also be used
- * to persist the metadata of a MergeableStore when using the JSON serialization
- * mode, as described below.
- *
- * 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 or MergeableStore 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 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 {openDatabaseSync} from 'expo-sqlite';
- * import {createStore} from 'tinybase';
- * import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite';
- *
- * const db = openDatabaseSync('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.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 = '_';`,
- *     )
- *     .then(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 {openDatabaseSync} from 'expo-sqlite';
- * import {createStore} from 'tinybase';
- * import {createExpoSqlitePersister} from 'tinybase/persisters/persister-expo-sqlite';
- *
- * const db = openDatabaseSync('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.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 createExpoSqlitePersister<Schemas extends OptionalSchemas>(
-  store: Store<Schemas> | MergeableStore<Schemas>,
-  db: SQLiteDatabase,
-  configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
-  onSqlCommand?: (sql: string, params?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): ExpoSqlitePersister<Schemas>;

package/@types/persisters/persister-file/index.d.cts

@@ -1,94 +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 Persistence guides
- * @packageDocumentation
- * @module persister-file
- * @since v1.0.0
- */
-import type {MergeableStore} from '../../mergeable-store/index.d.cts';
-import type {Store} from '../../store/index.d.cts';
-import type {Persister, Persists} from '../index.d.cts';
-
-/**
- * The FilePersister interface represents a Persister that lets you save and
- * load Store data to and from a local file system.
- *
- * You should use the createFilePersister function to create a FilePersister
- * object.
- *
- * It is a minor extension to the Persister interface and simply provides an
- * extra getFilePath method for accessing the location of the local file the
- * Store is being persisted to.
- * @category Persister
- * @since v4.3.14
- */
-export interface FilePersister
-  extends Persister<Persists.StoreOrMergeableStore> {
-  /**
-   * 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
-   * import {createStore} from 'tinybase';
-   * import {createFilePersister} from 'tinybase/persisters/persister-file';
-   *
-   * 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 FilePersister object that can
- * persist the Store to a local file.
- *
- * A FilePersister supports both regular Store and MergeableStore objects.
- *
- * 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 or MergeableStore 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
- * import {createStore} from 'tinybase';
- * import {createFilePersister} from 'tinybase/persisters/persister-file';
- *
- * 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
- * @since v1.0.0
- */
-export function createFilePersister(
-  store: Store | MergeableStore,
-  filePath: string,
-  onIgnoredError?: (error: any) => void,
-): FilePersister;

package/@types/persisters/persister-file/with-schemas/index.d.cts

@@ -1,107 +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 Persistence guides
- * @packageDocumentation
- * @module persister-file
- * @since v1.0.0
- */
-import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.cts';
-import type {
-  OptionalSchemas,
-  Store,
-} from '../../../store/with-schemas/index.d.cts';
-import type {Persister, Persists} from '../../with-schemas/index.d.cts';
-
-/**
- * The FilePersister interface represents a Persister that lets you save and
- * load Store data to and from a local file system.
- *
- * You should use the createFilePersister function to create a FilePersister
- * object.
- *
- * It is a minor extension to the Persister interface and simply provides an
- * extra getFilePath method for accessing the location of the local file the
- * Store is being persisted to.
- * @category Persister
- * @since v4.3.14
- */
-export interface FilePersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, Persists.StoreOrMergeableStore> {
-  /**
-   * 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
-   * import {createStore} from 'tinybase';
-   * import {createFilePersister} from 'tinybase/persisters/persister-file';
-   *
-   * 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 FilePersister object that can
- * persist the Store to a local file.
- *
- * This has schema-based typing. The following is a simplified representation:
- *
- * ```ts override
- * createFilePersister(
- *   store: Store | MergeableStore,
- *   filePath: string,
- *   onIgnoredError?: (error: any) => void,
- * ): FilePersister;
- * ```
- *
- * A FilePersister supports both regular Store and MergeableStore objects.
- *
- * 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 or MergeableStore 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
- * import {createStore} from 'tinybase';
- * import {createFilePersister} from 'tinybase/persisters/persister-file';
- *
- * 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
- * @since v1.0.0
- */
-export function createFilePersister<Schemas extends OptionalSchemas>(
-  store: Store<Schemas> | MergeableStore<Schemas>,
-  filePath: string,
-  onIgnoredError?: (error: any) => void,
-): FilePersister<Schemas>;