tinybase 4.3.13 → 4.3.14

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

@@ -9,6 +9,37 @@
 import {Persister} from '../persisters';
 import {Store} from '../store';
 
+/**
+ * The FilePersister interface is a minor extension to the Persister interface.
+ *
+ * It simply provides an extra getFilePath method for accessing the location of
+ * the local file the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface FilePersister extends Persister {
+  /**
+   * The getFilePath method returns the location of the local file the Store is
+   * being persisted to.
+   * @returns The location of the local file.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the file location back out again.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createFilePersister(store, '/app/persisted.json');
+   *
+   * console.log(persister.getFilePath());
+   * // -> '/app/persisted.json'
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getFilePath: () => string;
+}
+
 /**
  * The createFilePersister function creates a Persister object that can persist
  * the Store to a local file (in an appropriate environment).
@@ -20,9 +51,9 @@ import {Store} from '../store';
  * @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 Persister object.
+ * @returns A reference to the new FilePersister object.
  * @example
- * This example creates a Persister object and persists the Store to a local
+ * This example creates a FilePersister object and persists the Store to a local
  * file.
  *
  * ```js yolo
@@ -43,4 +74,4 @@ export function createFilePersister(
   store: Store,
   filePath: string,
   onIgnoredError?: (error: any) => void,
-): Persister;
+): FilePersister;

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

@@ -9,6 +9,38 @@
 import {Persister} from '../persisters';
 import {Store} from '../store';
 
+/**
+ * The IndexedDbPersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getDbName method for accessing the unique key of
+ * the IndexedDB the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface IndexedDbPersister extends Persister {
+  /**
+   * The getDbName method returns the unique key of the IndexedDB the Store is
+   * being persisted to.
+   * @returns The unique key of the IndexedDB.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the unique key of the IndexedDB back out again.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createIndexedDbPersister(store, 'petStore');
+   *
+   * console.log(persister.getDbName());
+   * // -> 'petStore'
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getDbName: () => string;
+}
+
 /**
  * The createIndexedDbPersister function creates a Persister object that can
  * persist the Store to the browser's IndexedDB storage.
@@ -34,10 +66,10 @@ import {Store} from '../store';
  * @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 Persister object.
+ * @returns A reference to the new IndexedDbPersister object.
  * @example
- * This example creates a Persister object and persists the Store to the
- * browser's IndexedDB storage.
+ * This example creates a IndexedDbPersister object and persists the Store to
+ * the browser's IndexedDB storage.
  *
  * ```js
  * const store = createStore()
@@ -71,4 +103,4 @@ export function createIndexedDbPersister(
   dbName: string,
   autoLoadIntervalSeconds?: number,
   onIgnoredError?: (error: any) => void,
-): Persister;
+): IndexedDbPersister;

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

@@ -23,6 +23,42 @@ import PartySocket from 'partysocket';
 import {Persister} from '../persisters';
 import {Store} from '../store';
 
+/**
+ * The PartyKitPersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getConnection method for accessing the
+ * PartySocket the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface PartyKitPersister extends Persister {
+  /**
+   * The getConnection method returns the PartySocket the Store is being
+   * persisted to.
+   * @returns The PartySocket.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the PartySocket back out again.
+   *
+   * ```js yolo
+   * const partySocket = new PartySocket({
+   *   host: PARTYKIT_HOST,
+   *   room: 'my_room',
+   * });
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createPartyKitPersister(store, partySocket);
+   *
+   * console.log(persister.getConnection() == partySocket);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getConnection: () => PartySocket;
+}
+
 /**
  * The PartyKitPersisterConfig type describes the configuration of a PartyKit
  * Persister on the client side.
@@ -106,9 +142,9 @@ export type PartyKitPersisterConfig = {
  * @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 Persister object.
+ * @returns A reference to the new PartyKitPersister object.
  * @example
- * This example creates a Persister object and persists the Store to the
+ * This example creates a PartyKitPersister object and persists the Store to the
  * browser's IndexedDB storage.
  *
  * ```js yolo
@@ -135,4 +171,4 @@ export function createPartyKitPersister(
   connection: PartySocket,
   configOrStoreProtocol?: PartyKitPersisterConfig | 'http' | 'https',
   onIgnoredError?: (error: any) => void,
-): Persister;
+): PartyKitPersister;

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

@@ -9,6 +9,42 @@
 import {Persister} from '../persisters';
 import {Store} from '../store';
 
+/**
+ * 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.
+ * @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
+   * 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.
@@ -29,10 +65,10 @@ import {Store} from '../store';
  * @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 Persister object.
+ * @returns A reference to the new RemotePersister object.
  * @example
- * This example creates a Persister object and persists the Store to a remote
- * server.
+ * This example creates a RemotePersister object and persists the Store to a
+ * remote server.
  *
  * ```js yolo
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
@@ -59,4 +95,4 @@ export function createRemotePersister(
   saveUrl: string,
   autoLoadIntervalSeconds?: number,
   onIgnoredError?: (error: any) => void,
-): Persister;
+): RemotePersister;

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

@@ -11,6 +11,45 @@
 import {DatabasePersisterConfig, Persister} from '../persisters';
 import {Store} from '../store';
 
+/**
+ * The SqliteWasmPersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getDb method for accessing a reference to the
+ * database instance the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface SqliteWasmPersister extends Persister {
+  /**
+   * The getDb method returns a reference to the database instance the Store is
+   * being persisted to.
+   * @returns A reference to the database instance.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the database instance back out again.
+   *
+   * ```js
+   * const sqlite3 = await sqlite3InitModule();
+   * const db = new sqlite3.oo1.DB(':memory:', 'c');
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createSqliteWasmPersister(
+   *   store,
+   *   sqlite3,
+   *   db,
+   *   'my_tinybase',
+   * );
+   *
+   * console.log(persister.getDb() == db);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getDb: () => any;
+}
+
 /**
  * The createSqliteWasmPersister function creates a Persister object that can
  * persist the Store to a local SQLite database (in an appropriate environment).
@@ -43,11 +82,11 @@ import {Store} from '../store';
  * @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 Persister object.
+ * @returns A reference to the new SqliteWasmPersister object.
  * @example
- * This example creates a Persister 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
+ * This example creates a SqliteWasmPersister 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
@@ -78,8 +117,8 @@ import {Store} from '../store';
  * persister.destroy();
  * ```
  * @example
- * This example creates a Persister object and persists the Store to a local
- * SQLite database with tabular mapping.
+ * This example creates a SqliteWasmPersister object and persists the Store to a
+ * local SQLite database with tabular mapping.
  *
  * ```js
  * const sqlite3 = await sqlite3InitModule();
@@ -111,4 +150,4 @@ export function createSqliteWasmPersister(
   configOrStoreTableName?: DatabasePersisterConfig | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,
   onIgnoredError?: (error: any) => void,
-): Persister;
+): SqliteWasmPersister;

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

@@ -12,6 +12,39 @@ import {DatabasePersisterConfig, Persister} from '../persisters';
 import {Database} from 'sqlite3';
 import {Store} from '../store';
 
+/**
+ * The Sqlite3Persister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getDb method for accessing a reference to the
+ * database instance the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface Sqlite3Persister extends Persister {
+  /**
+   * The getDb method returns a reference to the database instance the Store is
+   * being persisted to.
+   * @returns A reference to the database instance.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the database instance back out again.
+   *
+   * ```js
+   * const db = new sqlite3.Database(':memory:');
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createSqlite3Persister(store, db, 'my_tinybase');
+   *
+   * console.log(persister.getDb() == db);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getDb: () => Database;
+}
+
 /**
  * The createSqlite3Persister function creates a Persister object that can
  * persist the Store to a local SQLite database (in an appropriate environment).
@@ -42,11 +75,11 @@ import {Store} from '../store';
  * @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 Persister object.
+ * @returns A reference to the new Sqlite3Persister object.
  * @example
- * This example creates a Persister 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
+ * This example creates a Sqlite3Persister 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
@@ -78,8 +111,8 @@ import {Store} from '../store';
  * persister.destroy();
  * ```
  * @example
- * This example creates a Persister object and persists the Store to a local
- * SQLite database with tabular mapping.
+ * This example creates a Sqlite3Persister object and persists the Store to a
+ * local SQLite database with tabular mapping.
  *
  * ```js
  * const db = new sqlite3.Database(':memory:');
@@ -118,4 +151,4 @@ export function createSqlite3Persister(
   configOrStoreTableName?: DatabasePersisterConfig | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,
   onIgnoredError?: (error: any) => void,
-): Persister;
+): Sqlite3Persister;

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

@@ -15,6 +15,38 @@ import {Persister} from '../persisters.d';
 import {Store} from '../store.d';
 import {Doc as YDoc} from 'yjs';
 
+/**
+ * The YjsPersister interface is a minor extension to the Persister interface.
+ *
+ * It simply provides an extra getYDoc method for accessing the Yjs document the
+ * Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface YjsPersister extends Persister {
+  /**
+   * The getYDoc method returns the Yjs document the Store is being persisted
+   * to.
+   * @returns The Yjs document.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the Yjs document back out again.
+   *
+   * ```js
+   * const doc = new Y.Doc();
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createYjsPersister(store, doc);
+   *
+   * console.log(persister.getYDoc() == doc);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getYDoc: () => YDoc;
+}
+
 /**
  * The createYjsPersister function creates a Persister object that can persist
  * the Store to a Yjs document.
@@ -28,9 +60,9 @@ import {Doc as YDoc} from 'yjs';
  * @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 Persister object.
+ * @returns A reference to the new YjsPersister object.
  * @example
- * This example creates a Persister object and persists the Store to a Yjs
+ * This example creates a YjsPersister object and persists the Store to a Yjs
  * document.
  *
  * ```js
@@ -48,8 +80,8 @@ import {Doc as YDoc} from 'yjs';
  * ```
  * @example
  * This more complex example uses Yjs updates to keep two Store objects (each
- * with their own Persister objects and Yjs documents) in sync with each other.
- * We use the `await` keyword extensively for the purpose of ensuring
+ * with their own YjsPersister objects and Yjs documents) in sync with each
+ * other. We use the `await` keyword extensively for the purpose of ensuring
  * sequentiality in this example.
  *
  * Typically, real-world synchronization would happen between two systems via a
@@ -106,4 +138,4 @@ export function createYjsPersister(
   yDoc: YDoc,
   yMapName?: string,
   onIgnoredError?: (error: any) => void,
-): Persister;
+): YjsPersister;

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

@@ -15,6 +15,40 @@ import {OptionalSchemas, Store} from '../store';
 import {DocHandle} from 'automerge-repo';
 import {Persister} from '../persisters';
 
+/**
+ * The AutomergePersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getDocHandle method for accessing the Automerge
+ * document handler the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface AutomergePersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * The getDocHandle method returns the Automerge document handler the Store is
+   * being persisted to.
+   * @returns The Automerge document handler.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the Automerge document handler back out again.
+   *
+   * ```js
+   * const docHandler = new AutomergeRepo.Repo({network: []}).create();
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createAutomergePersister(store, docHandler);
+   *
+   * console.log(persister.getDocHandle() == docHandler);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getDocHandle: () => DocHandle<any>;
+}
+
 /**
  * The createAutomergePersister function creates a Persister object that can
  * persist the Store to an Automerge document.
@@ -27,7 +61,7 @@ import {Persister} from '../persisters';
  *   docHandle: DocHandle<any>,
  *   docMapName?: string,
  *   onIgnoredError?: (error: any) => void,
- * ): Persister;
+ * ): AutomergePersister;
  * ```
  *
  * As well as providing a reference to the Store to persist, you must provide
@@ -39,9 +73,9 @@ import {Persister} from '../persisters';
  * @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 Persister object.
+ * @returns A reference to the new AutomergePersister object.
  * @example
- * This example creates a Persister object and persists the Store to an
+ * This example creates a AutomergePersister object and persists the Store to an
  * Automerge document.
  *
  * ```js
@@ -120,4 +154,4 @@ export function createAutomergePersister<Schemas extends OptionalSchemas>(
   docHandle: DocHandle<any>,
   docMapName?: string,
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): AutomergePersister<Schemas>;

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

@@ -17,6 +17,71 @@
 import {OptionalSchemas, Store} from '../store';
 import {Persister} from '../persisters';
 
+/**
+ * The SessionPersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getStorageName method for accessing the unique
+ * key of the storage location the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface SessionPersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * The getStorageName method returns the unique key of the storage location
+   * the Store is being persisted to.
+   * @returns The unique key of the storage location.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the unique key of the storage location back out again.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createSessionPersister(store, 'pets');
+   *
+   * console.log(persister.getStorageName());
+   * // -> 'pets'
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getStorageName: () => string;
+}
+
+/**
+ * The LocalPersister interface is a minor extension to the Persister interface.
+ *
+ * It simply provides an extra getStorageName method for accessing the unique
+ * key of the storage location the Store is being persisted to.
+ * @since v4.3.14
+ */
+export interface LocalPersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * The getStorageName method returns the unique key of the storage location
+   * the Store is being persisted to.
+   * @returns The unique key of the storage location.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the unique key of the storage location back out again.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createLocalPersister(store, 'pets');
+   *
+   * console.log(persister.getStorageName());
+   * // -> 'pets'
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  getStorageName: () => string;
+}
+
 /**
  * The createSessionPersister function creates a Persister object that can
  * persist the Store to the browser's session storage.
@@ -28,7 +93,7 @@ import {Persister} from '../persisters';
  *   store: Store,
  *   storageName: string,
  *   onIgnoredError?: (error: any) => void,
- * ): Persister;
+ * ): SessionPersister;
  * ```
  *
  * As well as providing a reference to the Store to persist, you must provide a
@@ -39,9 +104,9 @@ import {Persister} from '../persisters';
  * @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 Persister object.
+ * @returns A reference to the new SessionPersister object.
  * @example
- * This example creates a Persister object and persists the Store to the
+ * This example creates a SessionPersister object and persists the Store to the
  * browser's session storage.
  *
  * ```js
@@ -61,11 +126,11 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,
   storageName: string,
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): SessionPersister<Schemas>;
 
 /**
- * The createLocalPersister function creates a Persister object that can
- * persist the Store to the browser's local storage.
+ * The createLocalPersister function creates a Persister object that can persist
+ * the Store to the browser's local storage.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -74,7 +139,7 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
  *   store: Store,
  *   storageName: string,
  *   onIgnoredError?: (error: any) => void,
- * ): Persister;
+ * ): LocalPersister;
  * ```
  *
  * As well as providing a reference to the Store to persist, you must provide a
@@ -85,9 +150,9 @@ export function createSessionPersister<Schemas extends OptionalSchemas>(
  * @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 Persister object.
+ * @returns A reference to the new LocalPersister object.
  * @example
- * This example creates a Persister object and persists the Store to the
+ * This example creates a LocalPersister object and persists the Store to the
  * browser's local storage.
  *
  * ```js
@@ -107,4 +172,4 @@ export function createLocalPersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,
   storageName: string,
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): LocalPersister<Schemas>;