tinybase 6.3.1 → 6.4.0-beta.1

package/@types/omni/index.d.ts

@@ -35,6 +35,7 @@ export * from '../persisters/persister-partykit-server/index.d.ts';
 export * from '../persisters/persister-pglite/index.d.ts';
 export * from '../persisters/persister-postgres/index.d.ts';
 export * from '../persisters/persister-powersync/index.d.ts';
+export * from '../persisters/persister-react-native-sqlite/index.d.ts';
 export * from '../persisters/persister-remote/index.d.ts';
 export * from '../persisters/persister-sqlite-bun/index.d.ts';
 export * from '../persisters/persister-sqlite-wasm/index.d.ts';

package/@types/omni/with-schemas/index.d.ts

@@ -34,6 +34,7 @@ export * from '../../persisters/persister-partykit-server/with-schemas/index.d.t
 export * from '../../persisters/persister-pglite/with-schemas/index.d.ts';
 export * from '../../persisters/persister-postgres/with-schemas/index.d.ts';
 export * from '../../persisters/persister-powersync/with-schemas/index.d.ts';
+export * from '../../persisters/persister-react-native-sqlite/with-schemas/index.d.ts';
 export * from '../../persisters/persister-remote/with-schemas/index.d.ts';
 export * from '../../persisters/persister-sqlite-bun/with-schemas/index.d.ts';
 export * from '../../persisters/persister-sqlite-wasm/with-schemas/index.d.ts';

package/@types/persisters/index.d.ts

@@ -22,6 +22,7 @@
  * |SqliteBunPersister| SQLite in Bun, via [bun:sqlite](https://bun.sh/docs/api/sqlite)|Yes|Yes*
  * |SqliteWasmPersister|SQLite in a browser, via [sqlite-wasm](https://github.com/tomayac/sqlite-wasm)|Yes|Yes*
  * |ExpoSqlitePersister|SQLite in React Native, via [expo-sqlite](https://github.com/expo/expo/tree/main/packages/expo-sqlite)|Yes|Yes*
+ * |ReactNativeSqlitePersister|SQLite in React Native, via [react-native-sqlite-storage](https://github.com/andpor/react-native-sqlite-storage)|Yes|Yes*
  * |PostgresPersister|PostgreSQL, via [postgres](https://github.com/porsager/postgres)|Yes|Yes*
  * |PglitePersister|PostgreSQL, via [PGlite](https://github.com/electric-sql/pglite)|Yes|Yes*
  * |CrSqliteWasmPersister|SQLite CRDTs, via [cr-sqlite-wasm](https://github.com/vlcn-io/cr-sqlite)|Yes|No

package/@types/persisters/persister-react-native-sqlite/index.d.ts

@@ -0,0 +1,181 @@
+/**
+ * The persister-react-native-sqlite module of the TinyBase project lets you
+ * save and load Store data to and from a SQLite database using the
+ * [`react-native-sqlite-storage`](https://github.com/andpor/react-native-sqlite-storage) module (in an appropriate React Native
+ * environment).
+ * @see Database Persistence guide
+ * @packageDocumentation
+ * @module persister-react-native-sqlite
+ * @since v6.4.0
+ */
+import {type SQLiteDatabase} from 'react-native-sqlite-storage';
+import type {MergeableStore} from '../../mergeable-store/index.d.ts';
+import type {Store} from '../../store/index.d.ts';
+import type {DatabasePersisterConfig, Persister, Persists} from '../index.d.ts';
+
+/**
+ * The ReactNativeSqlitePersister interface represents a Persister that lets you
+ * save and load Store data to and from a `react-native-sqlite-storage`
+ * database.
+ *
+ * You should use the createReactNativeSqlitePersister function to create an
+ * ReactNativeSqlitePersister 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 v6.4.0
+ */
+export interface ReactNativeSqlitePersister
+  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 {enablePromise, openDatabase} from 'react-native-sqlite-storage';
+ * import {createStore} from 'tinybase';
+ * import {createReactNativeSqlitePersister} from 'tinybase/persisters/persister-react-native-sqlite';
+ *
+ * enablePromise(true);
+ * const db = await openDatabase({name: 'my.db', location: 'default'});
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createReactNativeSqlitePersister(
+ *   store,
+ *   db,
+ *   'my_tinybase',
+ * );
+ * console.log(persister.getDb() == db);
+ * // -> true
+ *
+ * await persister.destroy();
+ * ```
+ * @category Getter
+ * @since v6.4.0
+ */
+  getDb(): SQLiteDatabase;
+}
+
+/**
+ * The createReactNativeSqlitePersister function creates an
+ * ReactNativeSqlitePersister object that can persist the Store to a local
+ * `react-native-sqlite-storage` database.
+ *
+ * An ReactNativeSqlitePersister 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.
+ *
+ * As well as providing a reference to the Store to persist, you must provide a
+ * `db` parameter which identifies the database instance.
+ *
+ * **Important note:** the `react-native-sqlite-storage` module must have had
+ * promises enabled before the database instance is passed in. Use
+ * `SQLite.enablePromise(true)` before initializing the Persister.
+ *
+ * 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
+ * `await 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 ReactNativeSqlitePersister object.
+ * @example
+ * This example creates a ReactNativeSqlitePersister 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 {enablePromise, openDatabase} from 'react-native-sqlite-storage';
+ * import {createStore} from 'tinybase';
+ * import {createReactNativeSqlitePersister} from 'tinybase/persisters/persister-react-native-sqlite';
+ *
+ * enablePromise(true);
+ * const db = await openDatabase({name: 'my.db', location: 'default'});
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createReactNativeSqlitePersister(
+ *   store,
+ *   db,
+ *   'my_tinybase',
+ * );
+ *
+ * await persister.save();
+ * // Store will be saved to the database.
+ *
+ * console.log(
+ *   (await db.executeSql('SELECT * FROM my_tinybase;'))[0].rows.raw(),
+ * );
+ * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * await db.executeSql(
+ *   'UPDATE my_tinybase SET store = ' +
+ *     `'[{"pets":{"felix":{"species":"cat"}}},{}]' WHERE _id = '_';`,
+ * );
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {felix: {species: 'cat'}}}
+ *
+ * await persister.destroy();
+ * ```
+ * @example
+ * This example creates a ReactNativeSqlitePersister object and persists the
+ * Store to a local SQLite database with tabular mapping.
+ *
+ * ```js yolo
+ * import {enablePromise, openDatabase} from 'react-native-sqlite-storage';
+ * import {createStore} from 'tinybase';
+ * import {createReactNativeSqlitePersister} from 'tinybase/persisters/persister-react-native-sqlite';
+ *
+ * enablePromise(true);
+ * const db = await openDatabase({name: 'my.db', location: 'default'});
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createReactNativeSqlitePersister(store, db, {
+ *   mode: 'tabular',
+ *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
+ * });
+ *
+ * await persister.save();
+ * console.log((await db.executeSql('SELECT * FROM pets;'))[0].rows.raw());
+ * // -> [{_id: 'fido', species: 'dog'}]
+ *
+ * await db.executeSql(
+ *   `INSERT INTO pets (_id, species) VALUES ('felix', 'cat')`,
+ * );
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * await persister.destroy();
+ * ```
+ * @category Creation
+ * @since v6.4.0
+ */
+export function createReactNativeSqlitePersister(
+  store: Store | MergeableStore,
+  db: SQLiteDatabase,
+  configOrStoreTableName?: DatabasePersisterConfig | string,
+  onSqlCommand?: (sql: string, params?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): ReactNativeSqlitePersister;

package/@types/persisters/persister-react-native-sqlite/with-schemas/index.d.ts

@@ -0,0 +1,202 @@
+/**
+ * The persister-react-native-sqlite module of the TinyBase project lets you
+ * save and load Store data to and from a SQLite database using the
+ * [`react-native-sqlite-storage`](https://github.com/andpor/react-native-sqlite-storage) module (in an appropriate React Native
+ * environment).
+ * @see Database Persistence guide
+ * @packageDocumentation
+ * @module persister-react-native-sqlite
+ * @since v6.4.0
+ */
+import type {SQLiteDatabase} from 'react-native-sqlite-storage';
+import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.ts';
+import type {
+  OptionalSchemas,
+  Store,
+} from '../../../store/with-schemas/index.d.ts';
+import type {
+  DatabasePersisterConfig,
+  Persister,
+  Persists,
+} from '../../with-schemas/index.d.ts';
+
+/**
+ * The ReactNativeSqlitePersister interface represents a Persister that lets you
+ * save and load Store data to and from a `react-native-sqlite-storage`
+ * database.
+ *
+ * You should use the createReactNativeSqlitePersister function to create an
+ * ReactNativeSqlitePersister 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 v6.4.0
+ */
+export interface ReactNativeSqlitePersister<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 {enablePromise, openDatabase} from 'react-native-sqlite-storage';
+ * import {createStore} from 'tinybase';
+ * import {createReactNativeSqlitePersister} from 'tinybase/persisters/persister-react-native-sqlite';
+ *
+ * enablePromise(true);
+ * const db = await openDatabase({name: 'my.db', location: 'default'});
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createReactNativeSqlitePersister(
+ *   store,
+ *   db,
+ *   'my_tinybase',
+ * );
+ * console.log(persister.getDb() == db);
+ * // -> true
+ *
+ * await persister.destroy();
+ * ```
+ * @category Getter
+ * @since v6.4.0
+ */
+  getDb(): SQLiteDatabase;
+}
+
+/**
+ * The createReactNativeSqlitePersister function creates an
+ * ReactNativeSqlitePersister object that can persist the Store to a local
+ * `react-native-sqlite-storage` database.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createReactNativeSqlitePersister(
+ *   store: Store | MergeableStore,
+ *   db: SQLiteDatabase,
+ *   configOrStoreTableName?: DatabasePersisterConfig | string,
+ *   onSqlCommand?: (sql: string, params?: any[]) => void,
+ *   onIgnoredError?: (error: any) => void,
+ * ): ReactNativeSqlitePersister;
+ * ```
+ *
+ * An ReactNativeSqlitePersister 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.
+ *
+ * As well as providing a reference to the Store to persist, you must provide a
+ * `db` parameter which identifies the database instance.
+ *
+ * **Important note:** the `react-native-sqlite-storage` module must have had
+ * promises enabled before the database instance is passed in. Use
+ * `SQLite.enablePromise(true)` before initializing the Persister.
+ *
+ * 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
+ * `await 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 ReactNativeSqlitePersister object.
+ * @example
+ * This example creates a ReactNativeSqlitePersister 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 {enablePromise, openDatabase} from 'react-native-sqlite-storage';
+ * import {createStore} from 'tinybase';
+ * import {createReactNativeSqlitePersister} from 'tinybase/persisters/persister-react-native-sqlite';
+ *
+ * enablePromise(true);
+ * const db = await openDatabase({name: 'my.db', location: 'default'});
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createReactNativeSqlitePersister(
+ *   store,
+ *   db,
+ *   'my_tinybase',
+ * );
+ *
+ * await persister.save();
+ * // Store will be saved to the database.
+ *
+ * console.log(
+ *   (await db.executeSql('SELECT * FROM my_tinybase;'))[0].rows.raw(),
+ * );
+ * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * await db.executeSql(
+ *   'UPDATE my_tinybase SET store = ' +
+ *     `'[{"pets":{"felix":{"species":"cat"}}},{}]' WHERE _id = '_';`,
+ * );
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {felix: {species: 'cat'}}}
+ *
+ * await persister.destroy();
+ * ```
+ * @example
+ * This example creates a ReactNativeSqlitePersister object and persists the
+ * Store to a local SQLite database with tabular mapping.
+ *
+ * ```js yolo
+ * import {enablePromise, openDatabase} from 'react-native-sqlite-storage';
+ * import {createStore} from 'tinybase';
+ * import {createReactNativeSqlitePersister} from 'tinybase/persisters/persister-react-native-sqlite';
+ *
+ * enablePromise(true);
+ * const db = await openDatabase({name: 'my.db', location: 'default'});
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createReactNativeSqlitePersister(store, db, {
+ *   mode: 'tabular',
+ *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
+ * });
+ *
+ * await persister.save();
+ * console.log((await db.executeSql('SELECT * FROM pets;'))[0].rows.raw());
+ * // -> [{_id: 'fido', species: 'dog'}]
+ *
+ * await db.executeSql(
+ *   `INSERT INTO pets (_id, species) VALUES ('felix', 'cat')`,
+ * );
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * await persister.destroy();
+ * ```
+ * @category Creation
+ * @since v6.4.0
+ */
+export function createReactNativeSqlitePersister<
+  Schemas extends OptionalSchemas,
+>(
+  store: Store<Schemas> | MergeableStore<Schemas>,
+  db: SQLiteDatabase,
+  configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
+  onSqlCommand?: (sql: string, params?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): ReactNativeSqlitePersister<Schemas>;

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

@@ -22,6 +22,7 @@
  * |SqliteBunPersister| SQLite in Bun, via [bun:sqlite](https://bun.sh/docs/api/sqlite)|Yes|Yes*
  * |SqliteWasmPersister|SQLite in a browser, via [sqlite-wasm](https://github.com/tomayac/sqlite-wasm)|Yes|Yes*
  * |ExpoSqlitePersister|SQLite in React Native, via [expo-sqlite](https://github.com/expo/expo/tree/main/packages/expo-sqlite)|Yes|Yes*
+ * |ReactNativeSqlitePersister|SQLite in React Native, via [react-native-sqlite-storage](https://github.com/andpor/react-native-sqlite-storage)|Yes|Yes*
  * |PostgresPersister|PostgreSQL, via [postgres](https://github.com/porsager/postgres)|Yes|Yes*
  * |PglitePersister|PostgreSQL, via [PGlite](https://github.com/electric-sql/pglite)|Yes|Yes*
  * |CrSqliteWasmPersister|SQLite CRDTs, via [cr-sqlite-wasm](https://github.com/vlcn-io/cr-sqlite)|Yes|No