tinybase 5.0.0-beta.1 → 5.0.0-beta.10

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

@@ -14,6 +14,7 @@
  * @module persister-browser
  */
 
+import {MergeableStore} from '../mergeable-store';
 import {Persister} from '../persisters';
 import {Store} from '../store';
 
@@ -23,9 +24,13 @@ import {Store} from '../store';
  *
  * 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 extends Persister {
+export interface SessionPersister extends Persister<true> {
   /**
    * The getStorageName method returns the unique key of the storage location
    * the Store is being persisted to.
@@ -54,9 +59,13 @@ export interface SessionPersister extends Persister {
  *
  * 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 extends Persister {
+export interface LocalPersister extends Persister<true> {
   /**
    * The getStorageName method returns the unique key of the storage location
    * the Store is being persisted to.
@@ -111,7 +120,7 @@ export interface LocalPersister extends Persister {
  * @category Creation
  */
 export function createSessionPersister(
-  store: Store,
+  store: Store | MergeableStore,
   storageName: string,
   onIgnoredError?: (error: any) => void,
 ): SessionPersister;
@@ -147,7 +156,7 @@ export function createSessionPersister(
  * @category Creation
  */
 export function createLocalPersister(
-  store: Store,
+  store: Store | MergeableStore,
   storageName: string,
   onIgnoredError?: (error: any) => void,
 ): LocalPersister;

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

@@ -18,6 +18,10 @@ import {Store} from '../store';
  *
  * 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 {

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

@@ -18,6 +18,10 @@ import {Store} from '../store';
  *
  * It simply provides an extra getElectricClient method for accessing a
  * reference to the Electric client the Store is being persisted to.
+ *
+ * You should use the createElectricSqlPersister function to create an
+ * ElectricSqlPersister object.
+ * @category Persister
  * @since v4.6.0
  */
 export interface ElectricSqlPersister extends Persister {

package/lib/types/persisters/persister-expo-sqlite-next.d.ts

@@ -30,6 +30,10 @@ import {Store} from '../store';
  *
  * 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 createExpoSqliteNextPersister function to create an
+ * ExpoSqliteNextPersister object.
+ * @category Persister
  * @since v4.5.0
  */
 export interface ExpoSqliteNextPersister extends Persister {

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

@@ -29,6 +29,10 @@ import {Store} from '../store';
  *
  * 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 createExpoSqlitePersister function to create an
+ * ExpoSqlitePersister object.
+ * @category Persister
  * @since v4.3.14
  */
 export interface ExpoSqlitePersister extends Persister {

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

@@ -6,6 +6,7 @@
  * @module persister-file
  */
 
+import {MergeableStore} from '../mergeable-store';
 import {Persister} from '../persisters';
 import {Store} from '../store';
 
@@ -14,9 +15,13 @@ import {Store} from '../store';
  *
  * It simply provides an extra getFilePath method for accessing the location of
  * the local file the Store is being persisted to.
+ *
+ * You should use the createFilePersister function to create a FilePersister
+ * object.
+ * @category Persister
  * @since v4.3.14
  */
-export interface FilePersister extends Persister {
+export interface FilePersister extends Persister<true> {
   /**
    * The getFilePath method returns the location of the local file the Store is
    * being persisted to.
@@ -71,7 +76,7 @@ export interface FilePersister extends Persister {
  * @category Creation
  */
 export function createFilePersister(
-  store: Store,
+  store: Store | MergeableStore,
   filePath: string,
   onIgnoredError?: (error: any) => void,
 ): FilePersister;

package/lib/types/persisters/persister-indexed-db.d.ts

@@ -15,6 +15,10 @@ import {Store} from '../store';
  *
  * It simply provides an extra getDbName method for accessing the unique key of
  * the IndexedDB the Store is being persisted to.
+ *
+ * You should use the createIndexedDbPersister function to create an
+ * IndexedDbPersister object.
+ * @category Persister
  * @since v4.3.14
  */
 export interface IndexedDbPersister extends Persister {

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

@@ -0,0 +1,142 @@
+/**
+ * The persister-libsql module of the TinyBase project lets you save and load
+ * Store data to and from a local LibSQL database (in an appropriate
+ * environment).
+ * @see Persisting Data guide
+ * @packageDocumentation
+ * @module persister-libsql
+ * @since v4.7.0
+ */
+
+import {DatabasePersisterConfig, Persister} from '../persisters';
+import {Client} from '@libsql/client';
+import {Store} from '../store';
+
+/**
+ * The LibSqlPersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getClient method for accessing a reference to the
+ * database client the Store is being persisted to.
+ *
+ * You should use the createLibSqlPersister function to create a LibSqlPersister
+ * object.
+ * @since v4.7.0
+ */
+export interface LibSqlPersister extends Persister {
+  /**
+   * The getClient method returns a reference to the database client the Store
+   * is being persisted to.
+   * @returns A reference to the database client.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the database client back out again.
+   *
+   * ```js yolo
+   * const client = createClient({url: 'file:my.db'});
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createLibSqlPersister(store, client, 'my_tinybase');
+   *
+   * console.log(persister.getClient() == client);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.7.0
+   */
+  getClient(): Client;
+}
+
+/**
+ * The createLibSqlPersister function creates a Persister object that can
+ * persist the Store to a local LibSQL database (in an appropriate environment).
+ *
+ * As well as providing a reference to the Store to persist, you must provide a
+ * `client` parameter which identifies the database 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 db The database client that was returned from `createClient(...)`.
+ * @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 LibSqlPersister object.
+ * @example
+ * This example creates a LibSqlPersister 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
+ * const client = createClient({url: 'file:my.db'});
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createLibSqlPersister(store, client, 'my_tinybase');
+ *
+ * await persister.save();
+ * // Store will be saved to the database.
+ *
+ * console.log((await client.execute('SELECT * FROM my_tinybase;')).rows);
+ * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * await client.execute(
+ *   '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 LibSqlPersister object and persists the Store to a
+ * local SQLite database with tabular mapping.
+ *
+ * ```js yolo
+ * const client = createClient({url: 'file:my.db'});
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createLibSqlPersister(store, client, {
+ *   mode: 'tabular',
+ *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
+ * });
+ *
+ * await persister.save();
+ * console.log((await client.execute('SELECT * FROM pets;')).rows);
+ * // -> [{_id: 'fido', species: 'dog'}]
+ *
+ * await client.execute(
+ *   `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.7.0
+ */
+export function createLibSqlPersister(
+  store: Store,
+  client: Client,
+  configOrStoreTableName?: DatabasePersisterConfig | string,
+  onSqlCommand?: (sql: string, args?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): LibSqlPersister;

package/lib/types/persisters/persister-partykit-client.d.ts

@@ -29,6 +29,10 @@ import {Store} from '../store';
  *
  * It simply provides an extra getConnection method for accessing the
  * PartySocket the Store is being persisted to.
+ *
+ * You should use the createPartyKitPersister function to create a
+ * PartyKitPersister object.
+ * @category Persister
  * @since v4.3.14
  */
 export interface PartyKitPersister extends Persister {

package/lib/types/persisters/persister-partykit-server.d.ts

@@ -21,11 +21,10 @@
 import {
   Cell,
   CellOrUndefined,
-  Tables,
-  TransactionChanges,
+  Changes,
+  Content,
   Value,
   ValueOrUndefined,
-  Values,
 } from '../store';
 import {Connection, Party, Request, Server, Storage} from 'partykit/server';
 import {Id} from '../common';
@@ -146,6 +145,11 @@ export type TinyBasePartyKitServerConfig = {
  * @since v4.3.0
  */
 export class TinyBasePartyKitServer implements Server {
+  /**
+   * The constructor is used to create the server.
+   * @category Creation
+   * @since v4.3.9
+   */
   constructor(party: Party);
   /**
    * The config property is used to optionally configure the server, using an
@@ -573,10 +577,10 @@ export function hasStoreInStorage(
 export function loadStoreFromStorage(
   storage: Storage,
   storagePrefix?: string,
-): Promise<[Tables, Values]>;
+): Promise<Content>;
 
 /**
- * The broadcastTransactionChanges function allows you to broadcast Store
+ * The broadcastChanges function allows you to broadcast Store
  * changes to all the client connections of a TinyBasePartyKitServer.
  *
  * This is intended for specialist applications that require the ability to
@@ -585,15 +589,15 @@ export function loadStoreFromStorage(
  * The function is asynchronous, so you should use the `await` keyword or handle
  * its completion as a promise.
  * @param server A reference to the TinyBasePartyKitServer object.
- * @param transactionChanges The Store changes to broadcast to the server's
+ * @param changes The Store changes to broadcast to the server's
  * clients.
  * @param without An optional array of client connection Ids to exclude from the
  * broadcast.
  * @category Connection
  * @since v4.5.1
  */
-export function broadcastTransactionChanges(
+export function broadcastChanges(
   server: TinyBasePartyKitServer,
-  transactionChanges: TransactionChanges,
+  changes: Changes,
   without?: string[],
 ): Promise<void>;

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

@@ -0,0 +1,157 @@
+/**
+ * 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';
+import type {AbstractPowerSyncDatabase} from '@journeyapps/powersync-sdk-common';
+import {Store} from '../store';
+
+/**
+ * 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,
+  db: AbstractPowerSyncDatabase,
+  configOrStoreTableName?: DatabasePersisterConfig | string,
+  onSqlCommand?: (sql: string, args?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): PowerSyncPersister;

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

@@ -15,6 +15,10 @@ import {Store} from '../store';
  *
  * 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 {

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

@@ -17,6 +17,10 @@ import {Store} from '../store';
  *
  * 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 {

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

@@ -18,6 +18,10 @@ import {Store} from '../store';
  *
  * 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 {

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

@@ -11,8 +11,8 @@
  * @since v4.0.0
  */
 
-import {Persister} from '../persisters.d';
-import {Store} from '../store.d';
+import {Persister} from '../persisters.d.ts';
+import {Store} from '../store.d.ts';
 import {Doc as YDoc} from 'yjs';
 
 /**
@@ -20,6 +20,10 @@ import {Doc as YDoc} from 'yjs';
  *
  * It simply provides an extra getYDoc method for accessing the Yjs document the
  * Store is being persisted to.
+ *
+ * You should use the createYjsPersister function to create a YjsPersister
+ * object.
+ * @category Persister
  * @since v4.3.14
  */
 export interface YjsPersister extends Persister {