tinybase 5.0.0-beta.5 → 5.0.0-beta.6

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,6 +24,9 @@ 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
  */
@@ -55,6 +59,9 @@ export interface SessionPersister extends Persister<true> {
  *
  * 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
  */
@@ -113,7 +120,7 @@ export interface LocalPersister extends Persister<true> {
  * @category Creation
  */
 export function createSessionPersister(
-  store: Store,
+  store: Store | MergeableStore,
   storageName: string,
   onIgnoredError?: (error: any) => void,
 ): SessionPersister;
@@ -149,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,9 @@ 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
  */

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

@@ -18,6 +18,9 @@ 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
  */

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

@@ -30,6 +30,9 @@ 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
  */

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

@@ -29,6 +29,9 @@ 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
  */

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,6 +15,9 @@ 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
  */
@@ -72,7 +76,7 @@ export interface FilePersister extends Persister<true> {
  * @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,9 @@ 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
  */

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

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

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

@@ -29,6 +29,9 @@ 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
  */

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,9 @@ 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
  */

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

@@ -17,6 +17,9 @@ 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
  */

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

@@ -18,6 +18,9 @@ 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
  */

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

@@ -0,0 +1,182 @@
+/**
+ * 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 Persisting Data guide
+ * @packageDocumentation
+ * @module persister-file
+ */
+
+import {Id, IdOrNull} from '../common';
+import {WebSocket, WebSocketServer} from 'ws';
+import {MergeableStore} from '../mergeable-store';
+import {Persister} from '../persisters';
+
+/**
+ * The MessageType type
+ *
+ */
+export type MessageType = number;
+
+/**
+ * The Receive type
+ *
+ */
+export type Receive = (
+  fromClientId: Id,
+  requestId: IdOrNull,
+  messageType: MessageType,
+  messageBody: any,
+) => void;
+
+/**
+ * The Send type
+ *
+ */
+export type Send = (
+  toClientId: IdOrNull,
+  requestId: IdOrNull,
+  messageType: MessageType,
+  messageBody: any,
+) => void;
+
+/**
+ * The ClientStats type
+ *
+ */
+export type ClientStats = {sends?: number; receives?: number};
+
+/**
+ * The Client interface
+ *
+ */
+export interface Client {
+  send: Send;
+  onReceive: (receive: Receive) => void;
+  destroy: () => void;
+  getStats: () => ClientStats;
+}
+
+/**
+ * The WsServer interface
+ */
+export interface WsServer {
+  getWebSocketServer: () => WebSocketServer;
+  destroy: () => void;
+}
+
+/**
+ * The SyncPersister interface is a minor extension to the Persister interface.
+ *
+ * It simply provides an extra getClient method for accessing the reference the
+ * Client that the MergeableStore is being persisted via.
+ *
+ * You should use the createSyncPersister function to create a SyncPersister
+ * object.
+ * @category Persister
+ * @since v5.0.0
+ */
+export interface SyncPersister extends Persister<true> {
+  /**
+   * The getClient method returns the reference of the Client that the
+   * MergeableStore is being persisted via.
+   * @returns The reference of the other MergeableStore.
+   * @example
+   * This example creates a Persister object against a newly-created
+   * MergeableStore and then gets the reference to the Client back out
+   * again.
+   *
+   * ```js
+   * const client = createLocalClient();
+   *
+   * const store1 = createMergeableStore('store1').setTables({
+   *   pets: {fido: {species: 'dog'}},
+   * });
+   * const persister = createSyncPersister(store1, client);
+   *
+   * console.log(persister.getClient() == client);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v5.0.0
+   */
+  getClient(): Client;
+  /**
+   * The startSync method
+   */
+  startSync(): Promise<Persister<true>>;
+  /**
+   * The stopSync method
+   */
+  stopSync(): Persister<true>;
+}
+
+/**
+ * The createSyncPersister function creates a Persister object that can persist
+ * one MergeableStore to another.
+ *
+ * As well as providing a reference to the MergeableStore to persist, you must
+ * provide a `client` parameter which identifies the Client that is used to
+ * transmit changes to and from this MergeableStore and its peers. persist it
+ * to.
+ * @param store The MergeableStore to persist.
+ * @param client The reference of the Client.
+ * @param requestTimeoutSeconds An optional number of seconds before a request
+ * to the Client times out, defaulting to 5.
+ * @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 SyncPersister object.
+ * @example
+ * This example creates a SyncPersister object and persists one MergeableStore
+ * to another.
+ *
+ * ```js
+ * const store1 = createMergeableStore('store1').setTables({
+ *   pets: {fido: {species: 'dog'}},
+ * });
+ * const persister1 = createSyncPersister(store1, createLocalClient());
+ *
+ * const store2 = createMergeableStore('store2');
+ * const persister2 = createSyncPersister(store2, createLocalClient());
+ * await persister2.startSync();
+ *
+ * await persister1.save();
+ * // ...
+ * // Store2 will be synced with Store1.
+ *
+ * console.log(store2.getTables());
+ * // -> {pets: {fido: {species: 'dog'}}}
+ *
+ * await persister1.load();
+ * // Store1 will be synced with Store2.
+ *
+ * persister1.destroy();
+ * persister2.destroy();
+ * ```
+ * @category Creation
+ */
+export function createSyncPersister(
+  store: MergeableStore,
+  client: Client,
+  requestTimeoutSeconds?: number,
+  onIgnoredError?: (error: any) => void,
+): SyncPersister;
+
+/**
+ * The createLocalClient function
+ */
+export function createLocalClient(): Client;
+
+/**
+ * The createWsClient function
+ */
+export function createWsClient(webSocket: WebSocket): Promise<Client>;
+
+/**
+ * The createWsSimpleServer function
+ */
+export function createWsSimpleServer(
+  WebSocketServer: WebSocketServer,
+): WsServer;

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,9 @@ 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
  */

package/lib/types/persisters.d.ts

@@ -23,6 +23,7 @@
  * |persister-expo-sqlite-next|createExpoSqliteNextPersister|SQLite in React Native, via [expo-sqlite/next](https://github.com/expo/expo/tree/main/packages/expo-sqlite/next)|
  * |persister-electric-sql|createElectricSqlPersister|Electric SQL, via [electric-sql](https://github.com/electric-sql/electric)|
  * |persister-libsql|createLibSqlPersister|LibSQL for Turso, via [libsql-client](https://github.com/tursodatabase/libsql-client-ts)|
+ * |persister-powersync|createPowerSyncPersister|PowerSync, via [powersync-sdk](https://github.com/powersync-ja/powersync-js)|
  * |persister-yjs|createYjsPersister|Yjs CRDTs, via [yjs](https://github.com/yjs/yjs)|
  * |persister-automerge|createSqliteWasmPersister|Automerge CRDTs, via [automerge-repo](https://github.com/automerge/automerge-repo)|
  *
@@ -39,13 +40,13 @@
  * @module persisters
  */
 
-import {Changes, Content, Store, Tables, Values} from './store.d';
+import {Changes, Content, Store, Tables, Values} from './store.d.ts';
 import {
   MergeableChanges,
   MergeableContent,
   MergeableStore,
 } from './mergeable-store';
-import {Id} from './common.d';
+import {Id} from './common.d.ts';
 
 /**
  * The PersisterStats type describes the number of times a Persister object has
@@ -818,6 +819,33 @@ export interface Persister<SupportsMergeableStore extends boolean = false> {
    */
   stopAutoLoad(): Persister<SupportsMergeableStore>;
 
+  /**
+   * The isAutoLoading method lets you find out if the Persister is currently
+   * automatically loading its content.
+   * @returns A boolean indicating whether the Persister is currently
+   * autoLoading.
+   * @example
+   * This example creates a Persister and queries whether it is autoLoading.
+   *
+   * ```js
+   * const persister = createSessionPersister(createStore(), 'pets');
+   *
+   * console.log(persister.isAutoLoading());
+   * // -> false
+   *
+   * await persister.startAutoLoad();
+   * console.log(persister.isAutoLoading());
+   * // -> true
+   *
+   * await persister.stopAutoLoad();
+   * console.log(persister.isAutoLoading());
+   * // -> false
+   * ```
+   * @category Load
+   * @since v5.0.0
+   */
+  isAutoLoading(): boolean;
+
   /**
    * The save method takes data from the Store with which the Persister is
    * associated and persists it into storage, once.
@@ -920,6 +948,33 @@ export interface Persister<SupportsMergeableStore extends boolean = false> {
    */
   stopAutoSave(): Persister<SupportsMergeableStore>;
 
+  /**
+   * The isAutoSaving method lets you find out if the Persister is currently
+   * automatically saving its content.
+   * @returns A boolean indicating whether the Persister is currently
+   * autoSaving.
+   * @example
+   * This example creates a Persister and queries whether it is autoSaving.
+   *
+   * ```js
+   * const persister = createSessionPersister(createStore(), 'pets');
+   *
+   * console.log(persister.isAutoSaving());
+   * // -> false
+   *
+   * await persister.startAutoSave();
+   * console.log(persister.isAutoSaving());
+   * // -> true
+   *
+   * await persister.stopAutoSave();
+   * console.log(persister.isAutoSaving());
+   * // -> false
+   * ```
+   * @category Save
+   * @since v5.0.0
+   */
+  isAutoSaving(): boolean;
+
   /**
    * The schedule method allows you to queue up a series of asynchronous actions
    * that must run in sequence during persistence.
@@ -1158,7 +1213,9 @@ export function createCustomPersister<
     getContent: () =>
       | Content
       | (SupportsMergeableStore extends true ? MergeableContent : never),
-    getChanges?: () => Changes,
+    getChanges?: () =>
+      | Changes
+      | (SupportsMergeableStore extends true ? MergeableChanges : never),
   ) => Promise<void>,
   addPersisterListener: (
     listener: PersisterListener<SupportsMergeableStore>,

package/lib/types/queries.d.ts

@@ -11,8 +11,8 @@
  * @since v2.0.0
  */
 
-import {Cell, CellOrUndefined, GetCell, GetIdChanges, Store} from './store.d';
-import {Id, IdOrNull, Ids} from './common.d';
+import {Cell, CellOrUndefined, GetCell, GetIdChanges, Store} from './store.d.ts';
+import {Id, IdOrNull, Ids} from './common.d.ts';
 
 /**
  * The ResultTable type is the data structure representing the results of a

package/lib/types/relationships.d.ts

@@ -10,8 +10,8 @@
  * @module relationships
  */
 
-import {GetCell, RowCallback, Store} from './store.d';
-import {Id, IdOrNull, Ids} from './common.d';
+import {GetCell, RowCallback, Store} from './store.d.ts';
+import {Id, IdOrNull, Ids} from './common.d.ts';
 
 /**
  * The Relationship type represents the concept of a map that connects one Row