tinybase 5.0.0-beta.19 → 5.0.0-beta.20

package/@types/persisters/persister-sqlite3/with-schemas/index.d.cts

@@ -0,0 +1,190 @@
+/**
+ * The persister-sqlite3 module of the TinyBase project lets you save and load
+ * Store data to and from a local SQLite database (in an appropriate
+ * environment).
+ * @see Persisting Data guide
+ * @packageDocumentation
+ * @module persister-sqlite3
+ * @since v4.0.0
+ */
+
+import type {
+  DatabasePersisterConfig,
+  Persister,
+} from '../../with-schemas/index.d.cts';
+import type {
+  OptionalSchemas,
+  Store,
+} from '../../../store/with-schemas/index.d.cts';
+import type {Database} from 'sqlite3';
+import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.cts';
+
+/**
+ * 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.
+ *
+ * You should use the createSqlite3Persister function to create a
+ * Sqlite3Persister object.
+ * @category Persister
+ * @since v4.3.14
+ */
+export interface Sqlite3Persister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas, 3> {
+  /**
+   * 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
+   * import {Database} from 'sqlite3';
+   * import {createSqlite3Persister} from 'tinybase/persisters/persister-sqlite3';
+   * import {createStore} from 'tinybase';
+   *
+   * const db = new 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).
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createSqlite3Persister(
+ *   store: Store | MergeableStore,
+ *   db: Database,
+ *   configOrStoreTableName?: DatabasePersisterConfig | string,
+ *   onSqlCommand?: (sql: string, args?: any[]) => void,
+ *   onIgnoredError?: (error: any) => void,
+ * ): Sqlite3Persister;
+ * ```
+ *
+ * As well as providing a reference to the Store to persist, you must provide a
+ * `db` parameter which identifies the database 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 db The database instance that was returned from `new
+ * sqlite3.Database(...)`.
+ * @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 Sqlite3Persister object.
+ * @example
+ * 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
+ * import {Database} from 'sqlite3';
+ * import {createSqlite3Persister} from 'tinybase/persisters/persister-sqlite3';
+ * import {createStore} from 'tinybase';
+ *
+ * const db = new Database(':memory:');
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createSqlite3Persister(store, db, 'my_tinybase');
+ *
+ * await persister.save();
+ * // Store will be saved to the database.
+ *
+ * console.log(
+ *   await new Promise((resolve) =>
+ *     db.all('SELECT * FROM my_tinybase;', (_, rows) => resolve(rows)),
+ *   ),
+ * );
+ * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * await new Promise((resolve) =>
+ *   db.all(
+ *     '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 Sqlite3Persister object and persists the Store to a
+ * local SQLite database with tabular mapping.
+ *
+ * ```js
+ * import {Database} from 'sqlite3';
+ * import {createSqlite3Persister} from 'tinybase/persisters/persister-sqlite3';
+ * import {createStore} from 'tinybase';
+ *
+ * const db = new Database(':memory:');
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createSqlite3Persister(store, db, {
+ *   mode: 'tabular',
+ *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
+ * });
+ *
+ * await persister.save();
+ * console.log(
+ *   await new Promise((resolve) =>
+ *     db.all('SELECT * FROM pets;', (_, rows) => resolve(rows)),
+ *   ),
+ * );
+ * // -> [{_id: 'fido', species: 'dog'}]
+ *
+ * await new Promise((resolve) =>
+ *   db.all(
+ *     `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.0.0
+ */
+export function createSqlite3Persister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas> | MergeableStore<Schemas>,
+  db: Database,
+  configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
+  onSqlCommand?: (sql: string, args?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): Sqlite3Persister<Schemas>;

package/@types/persisters/persister-yjs/index.d.cts

@@ -0,0 +1,157 @@
+/**
+ * The persister-yjs module of the TinyBase project provides a way to save and
+ * load Store data, to and from a Yjs document.
+ *
+ * A single entry point, the createYjsPersister function, is provided, which
+ * returns a new Persister object that can bind a Store to a provided Yjs
+ * document.
+ * @see Synchronizing Data guide
+ * @packageDocumentation
+ * @module persister-yjs
+ * @since v4.0.0
+ */
+
+import type {Persister} from '../index.d.cts';
+import type {Store} from '../../store/index.d.cts';
+import type {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.
+ *
+ * You should use the createYjsPersister function to create a YjsPersister
+ * object.
+ * @category Persister
+ * @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
+   * import {Doc} from 'yjs';
+   * import {createStore} from 'tinybase';
+   * import {createYjsPersister} from 'tinybase/persisters/persister-yjs';
+   *
+   * const doc = new 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.
+ *
+ * As well as providing a reference to the Store to persist, you must provide
+ * the Yjs document to persist it to.
+ * @param store The Store to persist.
+ * @param yDoc The Yjs document to persist the Store to.
+ * @param yMapName The name of the Y.Map used inside the Yjs document to sync
+ * the Store to (which otherwise will default to 'tinybase').
+ * @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 YjsPersister object.
+ * @example
+ * This example creates a YjsPersister object and persists the Store to a Yjs
+ * document.
+ *
+ * ```js
+ * import {Doc} from 'yjs';
+ * import {createStore} from 'tinybase';
+ * import {createYjsPersister} from 'tinybase/persisters/persister-yjs';
+ *
+ * const doc = new Doc();
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createYjsPersister(store, doc);
+ *
+ * await persister.save();
+ * // Store will be saved to the document.
+ *
+ * console.log(doc.toJSON());
+ * // -> {tinybase: {t: {pets: {fido: {species: 'dog'}}}, v: {}}}
+ *
+ * persister.destroy();
+ * ```
+ * @example
+ * This more complex example uses Yjs updates to keep two Store objects (each
+ * 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
+ * Yjs connection provider. Here, we synthesize that with the `syncDocs`
+ * function.
+ *
+ * ```js
+ * import {Doc, applyUpdate, encodeStateAsUpdate} from 'yjs';
+ * import {createStore} from 'tinybase';
+ * import {createYjsPersister} from 'tinybase/persisters/persister-yjs';
+ *
+ * const doc1 = new Doc();
+ * const doc2 = new Doc();
+ *
+ * // A function to manually synchronize documents with each other. Typically
+ * // this would happen over the wire, via a Yjs connection provider.
+ * const syncDocs = async () => {
+ *   applyUpdate(doc1, encodeStateAsUpdate(doc2));
+ *   applyUpdate(doc2, encodeStateAsUpdate(doc1));
+ * };
+ *
+ * // Bind a persisted Store to each document.
+ * const store1 = createStore();
+ * const persister1 = createYjsPersister(store1, doc1);
+ * await persister1.startAutoLoad();
+ * await persister1.startAutoSave();
+ *
+ * const store2 = createStore();
+ * const persister2 = createYjsPersister(store2, doc2);
+ * await persister2.startAutoLoad();
+ * await persister2.startAutoSave();
+ *
+ * // Synchronize the documents in their initial state.
+ * await syncDocs();
+ *
+ * // Make a change to each of the two Stores.
+ * store1.setTables({pets: {fido: {species: 'dog'}}});
+ * store2.setValues({open: true});
+ * // ...
+ *
+ * // Synchronize the documents with each other again.
+ * await syncDocs();
+ *
+ * // Ensure the Stores are in sync.
+ * console.log(store1.getContent());
+ * // -> [{pets: {fido: {species: 'dog'}}}, {open: true}]
+ * console.log(store2.getContent());
+ * // -> [{pets: {fido: {species: 'dog'}}}, {open: true}]
+ *
+ * persister1.destroy();
+ * persister2.destroy();
+ * ```
+ * @category Creation
+ * @since v4.0.0
+ */
+export function createYjsPersister(
+  store: Store,
+  yDoc: YDoc,
+  yMapName?: string,
+  onIgnoredError?: (error: any) => void,
+): YjsPersister;

package/@types/persisters/persister-yjs/with-schemas/index.d.cts

@@ -0,0 +1,172 @@
+/**
+ * The persister-yjs module of the TinyBase project provides a way to save and
+ * load Store data, to and from a Yjs document.
+ *
+ * A single entry point, the createYjsPersister function, is provided, which
+ * returns a new Persister object that can bind a Store to a provided Yjs
+ * document.
+ * @see Synchronizing Data guide
+ * @packageDocumentation
+ * @module persister-yjs
+ * @since v4.0.0
+ */
+
+import type {
+  OptionalSchemas,
+  Store,
+} from '../../../store/with-schemas/index.d.cts';
+import type {Persister} from '../../with-schemas/index.d.cts';
+import type {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.
+ *
+ * You should use the createYjsPersister function to create a YjsPersister
+ * object.
+ * @category Persister
+ * @since v4.3.14
+ */
+export interface YjsPersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /**
+   * 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
+   * import {Doc} from 'yjs';
+   * import {createStore} from 'tinybase';
+   * import {createYjsPersister} from 'tinybase/persisters/persister-yjs';
+   *
+   * const doc = new 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.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createYjsPersister(
+ *   store: Store,
+ *   yDoc: YDoc,
+ *   yMapName?: string,
+ *   onIgnoredError?: (error: any) => void,
+ * ): YjsPersister;
+ * ```
+ *
+ * As well as providing a reference to the Store to persist, you must provide
+ * the Yjs document to persist it to.
+ * @param store The Store to persist.
+ * @param yDoc The Yjs document to persist the Store to.
+ * @param yMapName The name of the Y.Map used inside the Yjs document to sync
+ * the Store to (which otherwise will default to 'tinybase').
+ * @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 YjsPersister object.
+ * @example
+ * This example creates a YjsPersister object and persists the Store to a Yjs
+ * document.
+ *
+ * ```js
+ * import {Doc} from 'yjs';
+ * import {createStore} from 'tinybase';
+ * import {createYjsPersister} from 'tinybase/persisters/persister-yjs';
+ *
+ * const doc = new Doc();
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createYjsPersister(store, doc);
+ *
+ * await persister.save();
+ * // Store will be saved to the document.
+ *
+ * console.log(doc.toJSON());
+ * // -> {tinybase: {t: {pets: {fido: {species: 'dog'}}}, v: {}}}
+ *
+ * persister.destroy();
+ * ```
+ * @example
+ * This more complex example uses Yjs updates to keep two Store objects (each
+ * 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
+ * Yjs connection provider. Here, we synthesize that with the `syncDocs`
+ * function.
+ *
+ * ```js
+ * import {Doc, applyUpdate, encodeStateAsUpdate} from 'yjs';
+ * import {createStore} from 'tinybase';
+ * import {createYjsPersister} from 'tinybase/persisters/persister-yjs';
+ *
+ * const doc1 = new Doc();
+ * const doc2 = new Doc();
+ *
+ * // A function to manually synchronize documents with each other. Typically
+ * // this would happen over the wire, via a Yjs connection provider.
+ * const syncDocs = async () => {
+ *   applyUpdate(doc1, encodeStateAsUpdate(doc2));
+ *   applyUpdate(doc2, encodeStateAsUpdate(doc1));
+ * };
+ *
+ * // Bind a persisted Store to each document.
+ * const store1 = createStore();
+ * const persister1 = createYjsPersister(store1, doc1);
+ * await persister1.startAutoLoad();
+ * await persister1.startAutoSave();
+ *
+ * const store2 = createStore();
+ * const persister2 = createYjsPersister(store2, doc2);
+ * await persister2.startAutoLoad();
+ * await persister2.startAutoSave();
+ *
+ * // Synchronize the documents in their initial state.
+ * await syncDocs();
+ *
+ * // Make a change to each of the two Stores.
+ * store1.setTables({pets: {fido: {species: 'dog'}}});
+ * store2.setValues({open: true});
+ * // ...
+ *
+ * // Synchronize the documents with each other again.
+ * await syncDocs();
+ *
+ * // Ensure the Stores are in sync.
+ * console.log(store1.getContent());
+ * // -> [{pets: {fido: {species: 'dog'}}}, {open: true}]
+ * console.log(store2.getContent());
+ * // -> [{pets: {fido: {species: 'dog'}}}, {open: true}]
+ *
+ * persister1.destroy();
+ * persister2.destroy();
+ * ```
+ * @category Creation
+ * @since v4.0.0
+ */
+export function createYjsPersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+  yDoc: YDoc,
+  yMapName?: string,
+  onIgnoredError?: (error: any) => void,
+): YjsPersister<Schemas>;