tinybase 5.0.0-beta.1 → 5.0.0-beta.11

package/lib/types/persisters.d.ts

@@ -22,6 +22,8 @@
  * |persister-expo-sqlite|createExpoSqlitePersister|SQLite in React Native, via [expo-sqlite](https://github.com/expo/expo/tree/main/packages/expo-sqlite)|
  * |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)|
  *
@@ -38,8 +40,73 @@
  * @module persisters
  */
 
-import {GetTransactionChanges, Store, Tables, Values} from './store.d';
-import {Id} from './common.d';
+import {Changes, Content, Store} from './store.d.ts';
+import {
+  MergeableChanges,
+  MergeableContent,
+  MergeableStore,
+} from './mergeable-store';
+import {Id} from './common.d.ts';
+
+/**
+ * The StoreTypes type
+ */
+export type StoreTypes =
+  | 1 // Store only
+  | 2 // MergeableStore only
+  | 3; // Store and MergeableStore
+
+/**
+ * The PersistedStore type
+ */
+export type PersistedStore<StoreType extends StoreTypes = 1> =
+  StoreType extends 3
+    ? Store | MergeableStore
+    : StoreType extends 2
+      ? MergeableStore
+      : Store;
+
+/**
+ * The PersistedContent type
+ */
+export type PersistedContent<StoreType extends StoreTypes = 1> =
+  StoreType extends 3
+    ? Content | MergeableContent
+    : StoreType extends 2
+      ? MergeableContent
+      : Content;
+
+/**
+ * The PersistedChanges type
+ */
+export type PersistedChanges<StoreType extends StoreTypes = 1> =
+  StoreType extends 3
+    ? Changes | MergeableChanges
+    : StoreType extends 2
+      ? MergeableChanges
+      : Changes;
+
+/**
+ * A PersisterListener is a callback that lets a Persister inform the Store that
+ * a change has happened to the underlying data.
+ *
+ * If the listener is called with the `changes` parameter, it will be used to
+ * make an incremental change to the Store. If not, but the `content` parameter
+ * is available, that will be used to make a wholesale change to the Store. If
+ * neither are present, the content will be loaded using the Persister's load
+ * method. Prior to v5.0, these parameters were callbacks.
+ * @param content If provided, this is a Content object from the the Persister
+ * that will be used to immediately wholesale update the Store.
+ * @param changes If provided, this is a Changes object from the the Persister
+ * that will be used to immediately incrementally update the Store. This takes
+ * priority over the content argument above if present.
+ * @category Creation
+ * @since v4.0.0
+ */
+export type PersisterListener<StoreType extends StoreTypes = 1> = (
+  content?: PersistedContent<StoreType>,
+  changes?: PersistedChanges<StoreType>,
+) => void;
 
 /**
  * The PersisterStats type describes the number of times a Persister object has
@@ -60,28 +127,6 @@ export type PersisterStats = {
   saves?: number;
 };
 
-/**
- * A PersisterListener is a callback that lets a Persister inform the Store that
- * a change has happened to the underlying data.
- *
- * If the listener has the `getTransactionChanges` parameter, it will be used to
- * make an incremental change to the Store. If not, but the `getContent`
- * function _is_ available, that will be used to make a wholesale change to the
- * Store. If neither are present, the content will be loaded from the
- * Persister's load method.
- * @param getContent An optional function that, if provided, returns an array of
- * Store content and can be used to immediately wholesale update the Store.
- * @param getTransactionChanges An optional function that, if provided, returns
- * a TransactionChanges object and can be used to immediately incrementally
- * update the Store.
- * @category Creation
- * @since v4.0.0
- */
-export type PersisterListener = (
-  getContent?: () => [Tables, Values],
-  getTransactionChanges?: GetTransactionChanges,
-) => void;
-
 /**
  * The DatabasePersisterConfig type describes the configuration of a
  * database-oriented Persister, such as those for SQLite.
@@ -548,9 +593,9 @@ export type DpcTabularValues = {
  *
  * Creating a Persister depends on the choice of underlying storage where the
  * data is to be stored. Options include the createSessionPersister function,
- * the createLocalPersister, the createRemotePersister function, and the
- * createFilePersister function. The createCustomPersister function can also be
- * used to easily create a fully customized way to save and load Store data.
+ * the createLocalPersister function, the createRemotePersister function, and
+ * the createFilePersister function. The createCustomPersister function can also
+ * be used to easily create a fully customized way to save and load Store data.
  *
  * A Persister lets you explicit save or load data, with the save method and the
  * load method respectively. These methods are both asynchronous (since the
@@ -619,7 +664,7 @@ export type DpcTabularValues = {
  * const store = createStore();
  * const persister = createSessionPersister(store, 'pets');
  *
- * await persister.startAutoLoad({pets: {fido: {species: 'dog'}}});
+ * await persister.startAutoLoad([{pets: {fido: {species: 'dog'}}}, {}]);
  * await persister.startAutoSave();
  *
  * store.setTables({pets: {felix: {species: 'cat'}}});
@@ -640,13 +685,13 @@ export type DpcTabularValues = {
  * ```
  * @category Persister
  */
-export interface Persister {
+export interface Persister<StoreType extends StoreTypes = 1> {
   //
   /**
    * The load method gets persisted data from storage, and loads it into the
    * Store with which the Persister is associated, once.
    *
-   * The optional parameters allow you to specify what the initial content for
+   * The optional parameter allows you to specify what the initial content for
    * the Store will be if there is nothing currently persisted or if the load
    * fails (for example when the Persister is remote and the environment is
    * offline). This allows you to fallback or instantiate a Store whether it's
@@ -656,10 +701,8 @@ export interface Persister {
    * machine or a filesystem. Even for those storage types that are synchronous
    * (like browser storage) it is still recommended that you `await` calls to
    * this method or handle the return type natively as a Promise.
-   * @param initialTables An optional Tables object used when the underlying
+   * @param initialContent An optional Content object used when the underlying
    * storage has not previously been populated.
-   * @param initialValues An optional Values object used when the underlying
-   * storage has not previously been populated, since v3.0.
    * @returns A Promise containing a reference to the Persister object.
    * @example
    * This example creates an empty Store, and loads data into it from the
@@ -688,7 +731,7 @@ export interface Persister {
    * const store = createStore();
    * const persister = createSessionPersister(store, 'pets');
    *
-   * await persister.load({pets: {fido: {species: 'dog'}}});
+   * await persister.load([{pets: {fido: {species: 'dog'}}}, {}]);
    * console.log(store.getTables());
    * // -> {pets: {fido: {species: 'dog'}}}
    *
@@ -701,14 +744,14 @@ export interface Persister {
    * ```
    * @category Load
    */
-  load(initialTables?: Tables, initialValues?: Values): Promise<Persister>;
+  load(initialContent?: Content): Promise<this>;
 
   /**
    * The startAutoLoad method gets persisted data from storage, and loads it
    * into the Store with which the Persister is associated, once, and then
    * continuously.
    *
-   * The optional parameters allow you to specify what the initial content for
+   * The optional parameter allows you to specify what the initial content for
    * the Store will be if there is nothing currently persisted or if the load
    * fails (for example when the Persister is remote and the environment is
    * offline). This allows you to fallback or instantiate a Store whether it's
@@ -723,10 +766,8 @@ export interface Persister {
    * the asynchronous load method. Even for those storage types that are
    * synchronous (like browser storage) it is still recommended that you `await`
    * calls to this method or handle the return type natively as a Promise.
-   * @param initialTables An optional Tables object used when the underlying
+   * @param initialContent An optional Content object used when the underlying
    * storage has not previously been populated.
-   * @param initialValues An optional Values object used when the underlying
-   * storage has not previously been populated, since v3.0.
    * @returns A Promise containing a reference to the Persister object.
    * @example
    * This example creates an empty Store, and loads data into it from the
@@ -739,7 +780,7 @@ export interface Persister {
    * const store = createStore();
    * const persister = createSessionPersister(store, 'pets');
    *
-   * await persister.startAutoLoad({pets: {fido: {species: 'dog'}}});
+   * await persister.startAutoLoad([{pets: {fido: {species: 'dog'}}}, {}]);
    * console.log(store.getTables());
    * // -> {pets: {fido: {species: 'dog'}}}
    *
@@ -756,10 +797,7 @@ export interface Persister {
    * ```
    * @category Load
    */
-  startAutoLoad(
-    initialTables?: Tables,
-    initialValues?: Values,
-  ): Promise<Persister>;
+  startAutoLoad(initialContent?: Content): Promise<this>;
 
   /**
    * The stopAutoLoad method stops the automatic loading of data from storage
@@ -803,7 +841,34 @@ export interface Persister {
    * ```
    * @category Load
    */
-  stopAutoLoad(): Persister;
+  stopAutoLoad(): this;
+
+  /**
+   * 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
@@ -831,7 +896,7 @@ export interface Persister {
    * ```
    * @category Save
    */
-  save(): Promise<Persister>;
+  save(): Promise<this>;
 
   /**
    * The save method takes data from the Store with which the Persister is
@@ -868,7 +933,7 @@ export interface Persister {
    * ```
    * @category Save
    */
-  startAutoSave(): Promise<Persister>;
+  startAutoSave(): Promise<this>;
 
   /**
    * The stopAutoSave method stops the automatic save of data to storage
@@ -905,7 +970,34 @@ export interface Persister {
    * ```
    * @category Save
    */
-  stopAutoSave(): Persister;
+  stopAutoSave(): this;
+
+  /**
+   * 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
@@ -948,7 +1040,7 @@ export interface Persister {
    * @category Lifecycle
    * @since v4.0.0
    */
-  schedule(...actions: Promise<any>[]): Promise<Persister>;
+  schedule(...actions: Promise<any>[]): Promise<this>;
 
   /**
    * The getStore method returns a reference to the underlying Store that is
@@ -971,7 +1063,7 @@ export interface Persister {
    * ```
    * @category Getter
    */
-  getStore(): Store;
+  getStore(): PersistedStore<StoreType>;
 
   /**
    * The destroy method should be called when this Persister object is no longer
@@ -1001,7 +1093,7 @@ export interface Persister {
    * ```
    * @category Lifecycle
    */
-  destroy(): Persister;
+  destroy(): this;
 
   /**
    * The getStats method provides a set of statistics about the Persister, and
@@ -1075,7 +1167,9 @@ export interface Persister {
  * the persistence layer (or `undefined` if not present).
  * @param setPersisted An asynchronous function which will send content to the
  * persistence layer. Since v4.0, it receives functions for getting the Store
- * content and information about the changes made during a transaction.
+ * content and information about the changes made during a transaction. Since
+ * v5.0, the changes are received directly by reference, rather than an
+ * accessor.
  * @param addPersisterListener A function that will register a `listener`
  * listener on underlying changes to the persistence layer. You can return a
  * listening handle that will be provided again when `delPersisterListener` is
@@ -1086,6 +1180,9 @@ export interface Persister {
  * @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.
+ * @param supportsMergeableStore An optional boolean to indicate that this
+ * Persister will be able to handle MergeableStore persistence as well as
+ * regular Store persistence, since v5.0.
  * @returns A reference to the new Persister object.
  * @example
  * This example creates a custom Persister object and persists the Store to a
@@ -1124,14 +1221,20 @@ export interface Persister {
  * ```
  * @category Creation
  */
-export function createCustomPersister<ListeningHandle>(
-  store: Store,
-  getPersisted: () => Promise<[Tables, Values] | undefined>,
+export function createCustomPersister<
+  ListeningHandle,
+  StoreType extends StoreTypes = 1,
+>(
+  store: PersistedStore<StoreType>,
+  getPersisted: () => Promise<PersistedContent<StoreType> | undefined>,
   setPersisted: (
-    getContent: () => [Tables, Values],
-    getTransactionChanges?: GetTransactionChanges,
+    getContent: () => PersistedContent<StoreType>,
+    changes?: PersistedChanges<StoreType>,
   ) => Promise<void>,
-  addPersisterListener: (listener: PersisterListener) => ListeningHandle,
+  addPersisterListener: (
+    listener: PersisterListener<StoreType>,
+  ) => ListeningHandle,
   delPersisterListener: (listeningHandle: ListeningHandle) => void,
   onIgnoredError?: (error: any) => void,
-): Persister;
+  supportedStoreType?: StoreType,
+): Persister<StoreType>;

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