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

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

@@ -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,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
@@ -817,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.
@@ -919,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.
@@ -1157,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

package/lib/types/store.d.ts

@@ -10,8 +10,8 @@
  * @module store
  */
 
-import {Id, IdOrNull, Ids, Json} from './common.d';
-import {StoreAlias} from './internal/store.d';
+import {Id, IdOrNull, Ids, Json} from './common.d.ts';
+import {StoreAlias} from './internal/store.d.ts';
 
 /**
  * The TablesSchema type describes the tabular structure of a Store in terms of
@@ -156,7 +156,35 @@ export type OptionalSchemas = [OptionalTablesSchema, OptionalValuesSchema];
  */
 export type NoSchemas = [NoTablesSchema, NoValuesSchema];
 
-// Content
+/**
+ * The Content type describes both the Tables and Values in a Store.
+ *
+ * It is an array of two objects, representing tabular and keyed value content.
+ * @example
+ * The following is a valid Content array:
+ * ```json
+ * [
+ *   {
+ *     "pets": {
+ *       "fido": {
+ *         "sold": false,
+ *         "price": 4,
+ *       },
+ *       "felix": {
+ *         "sold": true,
+ *         "price": 5,
+ *       },
+ *     },
+ *   },
+ *   {
+ *     open: true,
+ *     employees: 3,
+ *   },
+ * ]
+ * ```
+ * @category Store
+ * @since v5.0.0
+ */
 export type Content = [Tables, Values];
 
 /**
@@ -1317,6 +1345,9 @@ export type InvalidValues = {[valueId: Id]: any[]};
  * If not empty, the second object has an entry for each Value in a Store that
  * has had a change. If the entry is null, the Value was deleted, otherwise it
  * will contain the new Value it was changed to during the transaction.
+ *
+ * A third, required, item in the array is the digit `1`, so that instances of
+ * Content and Changes types can be disambiguated.
  * @example
  * The following is a valid Changes array that conveys the following:
  * ```json
@@ -1332,6 +1363,7 @@ export type InvalidValues = {[valueId: Id]: any[]};
  *     "pendingSales": null, // this Table was deleted
  *   },
  *   {},                   // no changes to keyed value data in the Store
+ *   1,                    // indicates that this is a Changes array
  * ]
  * ```
  * @category Transaction
@@ -1344,6 +1376,7 @@ export type Changes = [
       | undefined;
   },
   changedValues: {[valueId: Id]: ValueOrUndefined},
+  isChanges: 1,
 ];
 
 /**

package/lib/types/tinybase.d.ts

@@ -3,12 +3,12 @@
  * @packageDocumentation
  */
 
-export * from './checkpoints.d';
-export * from './common.d';
-export * from './indexes.d';
-export * from './metrics.d';
-export * from './persisters.d';
-export * from './queries.d';
-export * from './relationships.d';
-export * from './mergeable-store.d';
-export * from './store.d';
+export * from './checkpoints.d.ts';
+export * from './common.d.ts';
+export * from './indexes.d.ts';
+export * from './metrics.d.ts';
+export * from './persisters.d.ts';
+export * from './queries.d.ts';
+export * from './relationships.d.ts';
+export * from './mergeable-store.d.ts';
+export * from './store.d.ts';

package/lib/types/tools.d.ts

@@ -9,8 +9,8 @@
  * @since v2.2.0
  */
 
-import {Store, TablesSchema, ValuesSchema} from './store.d';
-import {Id} from './common.d';
+import {Store, TablesSchema, ValuesSchema} from './store.d.ts';
+import {Id} from './common.d.ts';
 
 /**
  * The StoreStats type describes a set of statistics about the Store, and

package/lib/types/ui-react.d.ts

@@ -22,7 +22,7 @@
  * @module ui-react
  */
 
-import {Callback, Id, IdOrNull, Ids, ParameterizedCallback} from './common.d';
+import {Callback, Id, IdOrNull, Ids, ParameterizedCallback} from './common.d.ts';
 import {
   Cell,
   CellIdsListener,
@@ -56,22 +56,22 @@ import {
   ValueOrUndefined,
   Values,
   ValuesListener,
-} from './store.d';
+} from './store.d.ts';
 import {
   CheckpointIds,
   CheckpointIdsListener,
   CheckpointListener,
   Checkpoints,
-} from './checkpoints.d';
+} from './checkpoints.d.ts';
 import {ComponentType, ReactElement} from 'react';
-import {Indexes, SliceIdsListener, SliceRowIdsListener} from './indexes.d';
+import {Indexes, SliceIdsListener, SliceRowIdsListener} from './indexes.d.ts';
 import {
   LinkedRowIdsListener,
   LocalRowIdsListener,
   Relationships,
   RemoteRowIdListener,
-} from './relationships.d';
-import {MetricListener, Metrics} from './metrics.d';
+} from './relationships.d.ts';
+import {MetricListener, Metrics} from './metrics.d.ts';
 import {
   Queries,
   ResultCellIdsListener,
@@ -82,8 +82,8 @@ import {
   ResultSortedRowIdsListener,
   ResultTableCellIdsListener,
   ResultTableListener,
-} from './queries.d';
-import {Persister} from './persisters.d';
+} from './queries.d.ts';
+import {Persister} from './persisters.d.ts';
 
 /**
  * The StoreOrStoreId type is used when you need to refer to a Store in a React

package/lib/types/with-schemas/checkpoints.d.ts

@@ -10,8 +10,8 @@
  * @module checkpoints
  */
 
-import {Id, IdOrNull, Ids} from './common.d';
-import {OptionalSchemas, Store} from './store.d';
+import {Id, IdOrNull, Ids} from './common.d.ts';
+import {OptionalSchemas, Store} from './store.d.ts';
 
 /**
  * The CheckpointIds type is a representation of the list of checkpoint Ids

package/lib/types/with-schemas/indexes.d.ts

@@ -17,8 +17,8 @@ import {
   OptionalTablesSchema,
   RowCallback,
   Store,
-} from './store.d';
-import {Id, IdOrNull, Ids, SortKey} from './common.d';
+} from './store.d.ts';
+import {Id, IdOrNull, Ids, SortKey} from './common.d.ts';
 
 /**
  * The Index type represents the concept of a map of Slice objects, keyed by Id.