tinybase 5.0.0-beta.4 → 5.0.0-beta.6

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

@@ -29,6 +29,9 @@ import {SQLiteDatabase} from 'expo-sqlite';
  *
  * 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
  */
@@ -55,7 +58,7 @@ export interface ExpoSqlitePersister<Schemas extends OptionalSchemas>
    * @category Getter
    * @since v4.3.14
    */
-  getDb: () => SQLiteDatabase;
+  getDb(): SQLiteDatabase;
 }
 
 /**

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

@@ -7,6 +7,7 @@
  */
 
 import {OptionalSchemas, Store} from '../store';
+import {MergeableStore} from '../mergeable-store';
 import {Persister} from '../persisters';
 
 /**
@@ -14,6 +15,9 @@ import {Persister} from '../persisters';
  *
  * 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
  */
@@ -39,7 +43,7 @@ export interface FilePersister<Schemas extends OptionalSchemas>
    * @category Getter
    * @since v4.3.14
    */
-  getFilePath: () => string;
+  getFilePath(): string;
 }
 
 /**
@@ -50,7 +54,7 @@ export interface FilePersister<Schemas extends OptionalSchemas>
  *
  * ```ts override
  * createFilePersister(
- *   store: Store,
+ *   store: Store | MergeableStore,
  *   filePath: string,
  *   onIgnoredError?: (error: any) => void,
  * ): FilePersister;
@@ -83,7 +87,7 @@ export interface FilePersister<Schemas extends OptionalSchemas>
  * @category Creation
  */
 export function createFilePersister<Schemas extends OptionalSchemas>(
-  store: Store<Schemas>,
+  store: Store<Schemas> | MergeableStore<Schemas>,
   filePath: string,
   onIgnoredError?: (error: any) => void,
 ): FilePersister<Schemas>;

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

@@ -15,6 +15,9 @@ import {Persister} from '../persisters';
  *
  * 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
  */
@@ -40,7 +43,7 @@ export interface IndexedDbPersister<Schemas extends OptionalSchemas>
    * @category Getter
    * @since v4.3.14
    */
-  getDbName: () => string;
+  getDbName(): string;
 }
 
 /**

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

@@ -0,0 +1,155 @@
+/**
+ * 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 {OptionalSchemas, Store} from '../store';
+import {Client} from '@libsql/client';
+
+/**
+ * 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<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * 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).
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createLibSqlPersister(
+ *   store: Store,
+ *   client: Client,
+ *   configOrStoreTableName?: DatabasePersisterConfig | string,
+ *   onSqlCommand?: (sql: string, args?: any[]) => void,
+ *   onIgnoredError?: (error: any) => void,
+ * ): LibSqlPersister;
+ * ```
+ *
+ * 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<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+  client: Client,
+  configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
+  onSqlCommand?: (sql: string, args?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): LibSqlPersister<Schemas>;

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

@@ -29,6 +29,9 @@ import {Persister} from '../persisters';
  *
  * 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
  */
@@ -58,7 +61,7 @@ export interface PartyKitPersister<Schemas extends OptionalSchemas>
    * @category Getter
    * @since v4.3.14
    */
-  getConnection: () => PartySocket;
+  getConnection(): PartySocket;
 }
 
 /**

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

@@ -0,0 +1,170 @@
+/**
+ * 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 {OptionalSchemas, Store} from '../store';
+import {AbstractPowerSyncDatabase} from '@journeyapps/powersync-sdk-common';
+
+/**
+ * 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<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * 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.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createPowerSyncPersister(
+ *   store: Store,
+ *   db: AbstractPowerSyncDatabase,
+ *   configOrStoreTableName?: DatabasePersisterConfig | string,
+ *   onSqlCommand?: (sql: string, args?: any[]) => void,
+ *   onIgnoredError?: (error: any) => void,
+ * ): PowerSyncPersister;
+ * ```
+ *
+ * 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<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+  db: AbstractPowerSyncDatabase,
+  configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
+  onSqlCommand?: (sql: string, args?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): PowerSyncPersister<Schemas>;

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

@@ -15,6 +15,9 @@ import {Persister} from '../persisters';
  *
  * 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
  */
@@ -44,7 +47,7 @@ export interface RemotePersister<Schemas extends OptionalSchemas>
    * @category Getter
    * @since v4.3.14
    */
-  getUrls: () => [string, string];
+  getUrls(): [string, string];
 }
 
 /**

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

@@ -17,6 +17,9 @@ import {OptionalSchemas, 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
  */
@@ -49,7 +52,7 @@ export interface SqliteWasmPersister<Schemas extends OptionalSchemas>
    * @category Getter
    * @since v4.3.14
    */
-  getDb: () => any;
+  getDb(): any;
 }
 
 /**

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

@@ -18,6 +18,9 @@ import {Database} from 'sqlite3';
  *
  * 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
  */
@@ -44,7 +47,7 @@ export interface Sqlite3Persister<Schemas extends OptionalSchemas>
    * @category Getter
    * @since v4.3.14
    */
-  getDb: () => Database;
+  getDb(): Database;
 }
 
 /**

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

@@ -0,0 +1,195 @@
+/**
+ * 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 {OptionalSchemas} from '../store';
+import {Persister} from '../persisters';
+
+/**
+ * The MessageType type
+ *
+ */
+export type MessageType = number;
+
+/**
+ * The Receive type
+ *
+ */
+export type Receive = (
+  fromClientId: Id,
+  requestId: Id,
+  messageType: MessageType,
+  messageBody: any,
+) => void;
+
+/**
+ * The Send type
+ *
+ */
+export type Send = (
+  toClientId: IdOrNull,
+  requestId: Id,
+  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<Schemas extends OptionalSchemas>
+  extends Persister<Schemas, 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<Schemas, true>>;
+  /**
+   * The stopSync method
+   */
+  stopSync(): Persister<Schemas, true>;
+}
+
+/**
+ * The createSyncPersister function creates a Persister object that can persist
+ * one MergeableStore to another.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createSyncPersister(
+ *   store: MergeableStore,
+ *   client: Client,
+ *   requestTimeoutSeconds?: number,
+ *   onIgnoredError?: (error: any) => void,
+ * ): SyncPersister;
+ * ```
+ *
+ * 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<Schemas extends OptionalSchemas>(
+  store: MergeableStore<Schemas>,
+  client: Client,
+  requestTimeoutSeconds?: number,
+  onIgnoredError?: (error: any) => void,
+): SyncPersister<Schemas>;
+
+/**
+ * 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;