tinybase 4.4.0-beta.0 → 4.4.0-beta.2

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/persisters.d.ts

@@ -643,11 +643,11 @@ export interface Persister {
    * The load method gets persisted data from storage, and loads it into the
    * Store with which the Persister is associated, once.
    *
-   * The optional parameter allows you to specify what the initial Tables object
-   * for the Store will be if there is nothing currently persisted. Using this
-   * instead of the `initialTables` parameter in the regular createStore
-   * function allows you to easily instantiate a Store whether it's loading from
-   * previously persisted storage or being run for the first time.
+   * The optional parameters allow 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
+   * loading from previously persisted storage or being run for the first time.
    *
    * This method is asynchronous because the persisted data may be on a remote
    * machine or a filesystem. Even for those storage types that are synchronous
@@ -705,11 +705,11 @@ export interface Persister {
    * into the Store with which the Persister is associated, once, and then
    * continuously.
    *
-   * The optional parameter allows you to specify what the initial Tables object
-   * for the Store will be if there is nothing at first persisted. Using this
-   * instead of the `initialTables` parameter in the regular createStore
-   * function allows you to easily instantiate a Store whether it's loading from
-   * previously persisted storage or being run for the first time.
+   * The optional parameters allow 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
+   * loading from previously persisted storage or being run for the first time.
    *
    * This method first runs a single call to the load method to ensure the data
    * is in sync with the persisted storage. It then continues to watch for

package/lib/types/queries.d.ts

@@ -264,6 +264,9 @@ export type QueryIdsListener = (queries: Queries) => void;
  * object, the Id of the ResultTable that changed (which is the same as the
  * query Id), and a GetResultCellChange function that can be used to query
  * ResultCell values before and after the change.
+ *
+ * You can create new query definitions within the body of this listener, though
+ * obviously be aware of the possible cascading effects of doing so.
  * @param queries A reference to the Queries object that changed.
  * @param tableId The Id of the ResultTable that changed, which is also the
  * query Id.
@@ -289,6 +292,9 @@ export type ResultTableListener = (
  * When called, a ResultTableCellIdsListener is given a reference to the Queries
  * object, and the Id of the ResultTable whose Cell Ids changed (which is the
  * same as the query Id).
+ *
+ * You can create new query definitions within the body of this listener, though
+ * obviously be aware of the possible cascading effects of doing so.
  * @param queries A reference to the Queries object that changed.
  * @param tableId The Id of the ResultTable that changed, which is also the
  * query Id.
@@ -311,6 +317,9 @@ export type ResultTableCellIdsListener = (
  * When called, a ResultRowCountListener is given a reference to the Queries
  * object, the Id of the ResultTable whose ResultRow Ids changed (which is the
  * same as the query Id), and the count of ResultRow objects in the ResultTable.
+ *
+ * You can create new query definitions within the body of this listener, though
+ * obviously be aware of the possible cascading effects of doing so.
  * @param queries A reference to the Queries object that changed.
  * @param tableId The Id of the ResultTable that changed, which is also the
  * query Id.
@@ -334,6 +343,9 @@ export type ResultRowCountListener = (
  * When called, a ResultRowIdsListener is given a reference to the Queries
  * object, and the Id of the ResultTable whose ResultRow Ids changed (which is
  * the same as the query Id).
+ *
+ * You can create new query definitions within the body of this listener, though
+ * obviously be aware of the possible cascading effects of doing so.
  * @param queries A reference to the Queries object that changed.
  * @param tableId The Id of the ResultTable that changed, which is also the
  * query Id.
@@ -360,6 +372,9 @@ export type ResultRowIdsListener = (
  * for pagination purposes. It also receives the sorted array of Ids itself, so
  * that you can use them in the listener without the additional cost of an
  * explicit call to getResultSortedRowIds.
+ *
+ * You can create new query definitions within the body of this listener, though
+ * obviously be aware of the possible cascading effects of doing so.
  * @param queries A reference to the Queries object that changed.
  * @param tableId The Id of the ResultTable that changed, which is also the
  * query Id.
@@ -393,6 +408,9 @@ export type ResultSortedRowIdsListener = (
  * the Id of the ResultTable that changed (which is the same as the query Id),
  * the Id of the ResultRow that changed, and a GetResultCellChange function that
  * can be used to query ResultCell values before and after the change.
+ *
+ * You can create new query definitions within the body of this listener, though
+ * obviously be aware of the possible cascading effects of doing so.
  * @param queries A reference to the Queries object that changed.
  * @param tableId The Id of the ResultTable that changed, which is also the
  * query Id.
@@ -419,6 +437,9 @@ export type ResultRowListener = (
  * When called, a ResultCellIdsListener is given a reference to the Queries
  * object, the Id of the ResultTable that changed (which is the same as the
  * query Id), and the Id of the ResultRow whose ResultCell Ids changed.
+ *
+ * You can create new query definitions within the body of this listener, though
+ * obviously be aware of the possible cascading effects of doing so.
  * @param queries A reference to the Queries object that changed.
  * @param tableId The Id of the ResultTable that changed, which is also the
  * query Id.
@@ -446,6 +467,9 @@ export type ResultCellIdsListener = (
  * It is also given the new value of the ResultCell, the old value of the
  * ResultCell, and a GetResultCellChange function that can be used to query
  * ResultCell values before and after the change.
+ *
+ * You can create new query definitions within the body of this listener, though
+ * obviously be aware of the possible cascading effects of doing so.
  * @param queries A reference to the Queries object that changed.
  * @param tableId The Id of the ResultTable that changed, which is also the
  * query Id.