tinybase 5.0.0-beta.18 → 5.0.0-beta.19

package/cjs/@types/persisters/persister-powersync/index.d.ts

@@ -0,0 +1,169 @@
+/**
+ * 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 type {DatabasePersisterConfig, Persister} from '../index.d.ts';
+import type {AbstractPowerSyncDatabase} from '@journeyapps/powersync-sdk-common';
+import type {Store} from '../../store/index.d.ts';
+
+/**
+ * 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
+   * import {createPowerSyncPersister} from 'tinybase/persisters/persister-powersync';
+   * import {createStore} from 'tinybase';
+   * import {usePowerSync} from '@journeyapps/powersync-react';
+   *
+   * 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
+ * import {createPowerSyncPersister} from 'tinybase/persisters/persister-powersync';
+ * import {createStore} from 'tinybase';
+ * import {usePowerSync} from '@journeyapps/powersync-react';
+ *
+ * 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
+ * import {createPowerSyncPersister} from 'tinybase/persisters/persister-powersync';
+ * import {createStore} from 'tinybase';
+ * import {usePowerSync} from '@journeyapps/powersync-react';
+ *
+ * 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,
+  powerSync: AbstractPowerSyncDatabase,
+  configOrStoreTableName?: DatabasePersisterConfig | string,
+  onSqlCommand?: (sql: string, args?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): PowerSyncPersister;

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

@@ -0,0 +1,188 @@
+/**
+ * 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 type {
+  DatabasePersisterConfig,
+  Persister,
+} from '../../with-schemas/index.d.ts';
+import type {
+  OptionalSchemas,
+  Store,
+} from '../../../store/with-schemas/index.d.ts';
+import type {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
+   * import {createPowerSyncPersister} from 'tinybase/persisters/persister-powersync';
+   * import {createStore} from 'tinybase';
+   * import {usePowerSync} from '@journeyapps/powersync-react';
+   *
+   * 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,
+ *   powerSync: 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
+ * import {createPowerSyncPersister} from 'tinybase/persisters/persister-powersync';
+ * import {createStore} from 'tinybase';
+ * import {usePowerSync} from '@journeyapps/powersync-react';
+ *
+ * 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
+ * import {createPowerSyncPersister} from 'tinybase/persisters/persister-powersync';
+ * import {createStore} from 'tinybase';
+ * import {usePowerSync} from '@journeyapps/powersync-react';
+ *
+ * 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>,
+  powerSync: AbstractPowerSyncDatabase,
+  configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
+  onSqlCommand?: (sql: string, args?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): PowerSyncPersister<Schemas>;

package/cjs/@types/persisters/persister-remote/index.d.ts

@@ -0,0 +1,113 @@
+/**
+ * The persister-remote module of the TinyBase project lets you save and load
+ * Store data to and from a remote server.
+ * @see Persisting Data guide
+ * @packageDocumentation
+ * @module persister-remote
+ */
+
+import type {Persister} from '../index.d.ts';
+import type {Store} from '../../store/index.d.ts';
+
+/**
+ * The RemotePersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * 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 {
+  /**
+   * The getUrls method returns the URLs the Store is being persisted to.
+   * @returns The load and save URLs as a two-item array.
+   * @example
+   * This example creates a RemotePersister object against a newly-created Store
+   * and then gets the URLs back out again.
+   *
+   * ```js
+   * import {createRemotePersister} from 'tinybase/persisters/persister-remote';
+   * import {createStore} from 'tinybase';
+   *
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createRemotePersister(
+   *   store,
+   *   'https://example.com/load',
+   *   'https://example.com/save',
+   *   5,
+   * );
+   *
+   * console.log(persister.getUrls());
+   * // -> ['https://example.com/load', 'https://example.com/save']
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getUrls(): [string, string];
+}
+
+/**
+ * The createRemotePersister function creates a Persister object that can
+ * persist the Store to a remote server.
+ *
+ * As well as providing a reference to the Store to persist, you must provide
+ * `loadUrl` and `saveUrl` parameters. These identify the endpoints of the
+ * server that support the `GET` method (to fetch the Store JSON to load) and
+ * the `POST` method (to send the Store JSON to save) respectively.
+ *
+ * For when you choose to enable automatic loading for the Persister (with the
+ * startAutoLoad method), it will poll the loadUrl for changes, using the
+ * `ETag` HTTP header to identify if things have changed. The
+ * `autoLoadIntervalSeconds` method is used to indicate how often to do this.
+ *
+ * If you are implementing the server portion of this functionality yourself,
+ * remember to ensure that the `ETag` header changes every time the server's
+ * Store content does - otherwise changes will not be detected by the client.
+ * @param store The Store to persist.
+ * @param loadUrl The endpoint that supports a `GET` method to load JSON.
+ * @param saveUrl The endpoint that supports a `POST` method to save JSON.
+ * @param autoLoadIntervalSeconds How often to poll the `loadUrl` when
+ * automatically loading changes from the server, 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, since v4.0.4.
+ * @returns A reference to the new RemotePersister object.
+ * @example
+ * This example creates a RemotePersister object and persists the Store to a
+ * remote server.
+ *
+ * ```js yolo
+ * import {createRemotePersister} from 'tinybase/persisters/persister-remote';
+ * import {createStore} from 'tinybase';
+ *
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createRemotePersister(
+ *   store,
+ *   'https://example.com/load',
+ *   'https://example.com/save',
+ *   5,
+ * );
+ *
+ * await persister.save();
+ * // Store JSON will be sent to server in a POST request.
+ *
+ * await persister.load();
+ * // Store JSON will be fetched from server with a GET request.
+ *
+ * persister.destroy();
+ * ```
+ * @category Creation
+ */
+export function createRemotePersister(
+  store: Store,
+  loadUrl: string,
+  saveUrl: string,
+  autoLoadIntervalSeconds?: number,
+  onIgnoredError?: (error: any) => void,
+): RemotePersister;

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

@@ -0,0 +1,129 @@
+/**
+ * The persister-remote module of the TinyBase project lets you save and load
+ * Store data to and from a remote server.
+ * @see Persisting Data guide
+ * @packageDocumentation
+ * @module persister-remote
+ */
+
+import type {
+  OptionalSchemas,
+  Store,
+} from '../../../store/with-schemas/index.d.ts';
+import type {Persister} from '../../with-schemas/index.d.ts';
+
+/**
+ * The RemotePersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * 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<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * The getUrls method returns the URLs the Store is being persisted to.
+   * @returns The load and save URLs as a two-item array.
+   * @example
+   * This example creates a RemotePersister object against a newly-created Store
+   * and then gets the URLs back out again.
+   *
+   * ```js
+   * import {createRemotePersister} from 'tinybase/persisters/persister-remote';
+   * import {createStore} from 'tinybase';
+   *
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createRemotePersister(
+   *   store,
+   *   'https://example.com/load',
+   *   'https://example.com/save',
+   *   5,
+   * );
+   *
+   * console.log(persister.getUrls());
+   * // -> ['https://example.com/load', 'https://example.com/save']
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getUrls(): [string, string];
+}
+
+/**
+ * The createRemotePersister function creates a Persister object that can
+ * persist the Store to a remote server.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createRemotePersister(
+ *   store: Store,
+ *   loadUrl: string,
+ *   saveUrl: string,
+ *   autoLoadIntervalSeconds?: number,
+ *   onIgnoredError?: (error: any) => void,
+ * ): RemotePersister;
+ * ```
+ *
+ * As well as providing a reference to the Store to persist, you must provide
+ * `loadUrl` and `saveUrl` parameters. These identify the endpoints of the
+ * server that support the `GET` method (to fetch the Store JSON to load) and
+ * the `POST` method (to send the Store JSON to save) respectively.
+ *
+ * For when you choose to enable automatic loading for the Persister (with the
+ * startAutoLoad method), it will poll the loadUrl for changes, using the
+ * `ETag` HTTP header to identify if things have changed. The
+ * `autoLoadIntervalSeconds` method is used to indicate how often to do this.
+ *
+ * If you are implementing the server portion of this functionality yourself,
+ * remember to ensure that the `ETag` header changes every time the server's
+ * Store content does - otherwise changes will not be detected by the client.
+ * @param store The Store to persist.
+ * @param loadUrl The endpoint that supports a `GET` method to load JSON.
+ * @param saveUrl The endpoint that supports a `POST` method to save JSON.
+ * @param autoLoadIntervalSeconds How often to poll the `loadUrl` when
+ * automatically loading changes from the server, 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, since v4.0.4.
+ * @returns A reference to the new RemotePersister object.
+ * @example
+ * This example creates a RemotePersister object and persists the Store to a
+ * remote server.
+ *
+ * ```js yolo
+ * import {createRemotePersister} from 'tinybase/persisters/persister-remote';
+ * import {createStore} from 'tinybase';
+ *
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createRemotePersister(
+ *   store,
+ *   'https://example.com/load',
+ *   'https://example.com/save',
+ *   5,
+ * );
+ *
+ * await persister.save();
+ * // Store JSON will be sent to server in a POST request.
+ *
+ * await persister.load();
+ * // Store JSON will be fetched from server with a GET request.
+ *
+ * persister.destroy();
+ * ```
+ * @category Creation
+ */
+export function createRemotePersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+  loadUrl: string,
+  saveUrl: string,
+  autoLoadIntervalSeconds?: number,
+  onIgnoredError?: (error: any) => void,
+): RemotePersister<Schemas>;