tinybase 6.1.0-beta.2 → 6.1.0-beta.4

package/@types/mergeable-store/index.d.ts

@@ -27,6 +27,18 @@ import type {
   ValueOrUndefined,
 } from '../store/index.d.ts';
 
+/**
+ * The GetNow type is used to represent a function that returns the current time
+ * in milliseconds.
+ *
+ * This is used internally within the mergeable-store module, but is used for
+ * the createMergeableStore function's second optional argument to allow
+ * applications to override the clock used to generate timestamps.
+ * @category Stamps
+ * @since v6.1.0
+ */
+export type GetNow = () => number;
+
 /**
  * The Hash type is used within the mergeable-store module to quickly compare
  * the content of two objects.
@@ -328,7 +340,7 @@ export interface MergeableStore extends Store {
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store = createMergeableStore('store1'); // !resetHlc
+   * const store = createMergeableStore('store1'); // !reset
    *
    * store.setCell('pets', 'fido', 'color', 'brown');
    *
@@ -380,7 +392,7 @@ export interface MergeableStore extends Store {
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store = createMergeableStore('store1'); // !resetHlc
+   * const store = createMergeableStore('store1'); // !reset
    *
    * store.setCell('pets', 'fido', 'color', 'brown');
    * console.log(store.getMergeableContentHashes());
@@ -414,7 +426,7 @@ export interface MergeableStore extends Store {
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store = createMergeableStore('store1'); // !resetHlc
+   * const store = createMergeableStore('store1'); // !reset
    *
    * store.setCell('pets', 'fido', 'color', 'brown');
    * console.log(store.getMergeableTableHashes());
@@ -447,7 +459,7 @@ export interface MergeableStore extends Store {
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setTables({pets: {fido: {color: 'brown'}}});
    *
    * const store2 = createMergeableStore('store2');
@@ -500,7 +512,7 @@ export interface MergeableStore extends Store {
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setTables({pets: {fido: {color: 'brown'}, felix: {color: 'tan'}}});
    *
    * const store2 = createMergeableStore('store2');
@@ -536,7 +548,7 @@ export interface MergeableStore extends Store {
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setTables({pets: {fido: {color: 'brown'}}});
    *
    * const store2 = createMergeableStore('store2');
@@ -594,7 +606,7 @@ export interface MergeableStore extends Store {
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setTables({pets: {fido: {color: 'brown', species: 'dog'}}});
    *
    * const store2 = createMergeableStore('store2');
@@ -634,7 +646,7 @@ export interface MergeableStore extends Store {
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setTables({pets: {fido: {color: 'brown'}}});
    *
    * const store2 = createMergeableStore('store2');
@@ -710,7 +722,7 @@ export interface MergeableStore extends Store {
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store = createMergeableStore('store1'); // !resetHlc
+   * const store = createMergeableStore('store1'); // !reset
    *
    * store.setValue('employees', 3);
    * console.log(store.getMergeableValueHashes());
@@ -743,7 +755,7 @@ export interface MergeableStore extends Store {
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setValues({employees: 3});
    *
    * const store2 = createMergeableStore('store2');
@@ -788,7 +800,7 @@ export interface MergeableStore extends Store {
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setValues({employees: 3});
    * console.log(store1.getMergeableContent());
    * // ->
@@ -836,7 +848,7 @@ export interface MergeableStore extends Store {
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setValues({employees: 3});
    *
    * const store2 = createMergeableStore('store2');
@@ -870,7 +882,7 @@ export interface MergeableStore extends Store {
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store = createMergeableStore('store1'); // !resetHlc
+   * const store = createMergeableStore('store1'); // !reset
    * store.setTables({pets: {fido: {species: 'dog', color: 'brown'}}});
    * store.setValues({open: true});
    *
@@ -1034,12 +1046,22 @@ export interface MergeableStore extends Store {
  * The createMergeableStore function creates a MergeableStore, and is the main
  * entry point into the mergeable-store module.
  *
- * There is one optional parameter which is a uniqueId for the MergeableStore.
- * This is used to distinguish conflicting changes made in the same millisecond
- * by two different MergeableStore objects as its hash is added to the end of
- * the HLC timestamps. Generally this can be omitted unless you have a need for
- * deterministic HLCs, such as in a testing scenario. Otherwise, TinyBase will
- * assign a unique Id to the Store at the time of creation.
+ * There are two optional parameters which are only for testing and advanced
+ * usage.
+ *
+ * The first is a uniqueId for the MergeableStore, used to distinguish
+ * conflicting changes made in the same millisecond by two different
+ * MergeableStore objects as its hash is added to the end of the HLC timestamps.
+ * Generally this can be omitted unless you have a need for deterministic HLCs,
+ * such as in a testing scenario. Otherwise, TinyBase will assign a unique Id to
+ * the Store at the time of creation.
+ *
+ * Since v6.1.0, the second is a function that can be used to replace the way
+ * the timestamp is generated for HLCs (by default JavaScript's `Date.now()`
+ * method).
+ * @param uniqueId An optional unique Id for the MergeableStore.
+ * @param getNow An optional function that generates millisecond timestamps,
+ * since v6.1.0.
  * @returns A reference to the new MergeableStore.
  * @example
  * This example creates a MergeableStore.
@@ -1136,4 +1158,7 @@ export interface MergeableStore extends Store {
  * @category Creation
  * @since v5.0.0
  */
-export function createMergeableStore(uniqueId?: Id): MergeableStore;
+export function createMergeableStore(
+  uniqueId?: Id,
+  getNow?: GetNow,
+): MergeableStore;

package/@types/mergeable-store/with-schemas/index.d.ts

@@ -40,6 +40,18 @@ import type {
   ValuesSchema,
 } from '../../store/with-schemas/index.d.ts';
 
+/**
+ * The GetNow type is used to represent a function that returns the current time
+ * in milliseconds.
+ *
+ * This is used internally within the mergeable-store module, but is used for
+ * the createMergeableStore function's second optional argument to allow
+ * applications to override the clock used to generate timestamps.
+ * @category Stamps
+ * @since v6.1.0
+ */
+export type GetNow = () => number;
+
 /**
  * The Hash type is used within the mergeable-store module to quickly compare
  * the content of two objects.
@@ -491,7 +503,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store = createMergeableStore('store1'); // !resetHlc
+   * const store = createMergeableStore('store1'); // !reset
    *
    * store.setCell('pets', 'fido', 'color', 'brown');
    *
@@ -543,7 +555,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store = createMergeableStore('store1'); // !resetHlc
+   * const store = createMergeableStore('store1'); // !reset
    *
    * store.setCell('pets', 'fido', 'color', 'brown');
    * console.log(store.getMergeableContentHashes());
@@ -583,7 +595,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store = createMergeableStore('store1'); // !resetHlc
+   * const store = createMergeableStore('store1'); // !reset
    *
    * store.setCell('pets', 'fido', 'color', 'brown');
    * console.log(store.getMergeableTableHashes());
@@ -624,7 +636,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setTables({pets: {fido: {color: 'brown'}}});
    *
    * const store2 = createMergeableStore('store2');
@@ -686,7 +698,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setTables({pets: {fido: {color: 'brown'}, felix: {color: 'tan'}}});
    *
    * const store2 = createMergeableStore('store2');
@@ -732,7 +744,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setTables({pets: {fido: {color: 'brown'}}});
    *
    * const store2 = createMergeableStore('store2');
@@ -799,7 +811,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setTables({pets: {fido: {color: 'brown', species: 'dog'}}});
    *
    * const store2 = createMergeableStore('store2');
@@ -847,7 +859,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setTables({pets: {fido: {color: 'brown'}}});
    *
    * const store2 = createMergeableStore('store2');
@@ -931,7 +943,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store = createMergeableStore('store1'); // !resetHlc
+   * const store = createMergeableStore('store1'); // !reset
    *
    * store.setValue('employees', 3);
    * console.log(store.getMergeableValueHashes());
@@ -970,7 +982,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setValues({employees: 3});
    *
    * const store2 = createMergeableStore('store2');
@@ -1023,7 +1035,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setValues({employees: 3});
    * console.log(store1.getMergeableContent());
    * // ->
@@ -1079,7 +1091,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store1 = createMergeableStore('store1'); // !resetHlc
+   * const store1 = createMergeableStore('store1'); // !reset
    * store1.setValues({employees: 3});
    *
    * const store2 = createMergeableStore('store2');
@@ -1121,7 +1133,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * ```js
    * import {createMergeableStore} from 'tinybase';
    *
-   * const store = createMergeableStore('store1'); // !resetHlc
+   * const store = createMergeableStore('store1'); // !reset
    * store.setTables({pets: {fido: {species: 'dog', color: 'brown'}}});
    * store.setValues({open: true});
    *
@@ -1520,15 +1532,28 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
  * This has schema-based typing. The following is a simplified representation:
  *
  * ```ts override
- * createMergeableStore(uniqueId?: Id): MergeableStore;
+ * createMergeableStore(
+ *   uniqueId?: Id,
+ *   getNow?: GetNow,
+ * ): MergeableStore;
  * ```
  *
- * There is one optional parameter which is a uniqueId for the MergeableStore.
- * This is used to distinguish conflicting changes made in the same millisecond
- * by two different MergeableStore objects as its hash is added to the end of
- * the HLC timestamps. Generally this can be omitted unless you have a need for
- * deterministic HLCs, such as in a testing scenario. Otherwise, TinyBase will
- * assign a unique Id to the Store at the time of creation.
+ * There are two optional parameters which are only for testing and advanced
+ * usage.
+ *
+ * The first is a uniqueId for the MergeableStore, used to distinguish
+ * conflicting changes made in the same millisecond by two different
+ * MergeableStore objects as its hash is added to the end of the HLC timestamps.
+ * Generally this can be omitted unless you have a need for deterministic HLCs,
+ * such as in a testing scenario. Otherwise, TinyBase will assign a unique Id to
+ * the Store at the time of creation.
+ *
+ * Since v6.1.0, the second is a function that can be used to replace the way
+ * the timestamp is generated for HLCs (by default JavaScript's `Date.now()`
+ * method).
+ * @param uniqueId An optional unique Id for the MergeableStore.
+ * @param getNow An optional function that generates millisecond timestamps,
+ * since v6.1.0.
  * @returns A reference to the new MergeableStore.
  * @example
  * This example creates a MergeableStore.
@@ -1625,4 +1650,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
  * @category Creation
  * @since v5.0.0
  */
-export function createMergeableStore(uniqueId?: Id): MergeableStore<NoSchemas>;
+export function createMergeableStore(
+  uniqueId?: Id,
+  getNow?: GetNow,
+): MergeableStore<NoSchemas>;

package/@types/persisters/index.d.ts

@@ -17,6 +17,7 @@
  * |IndexedDbPersister|Browser IndexedDB|Yes|No
  * |RemotePersister|Remote server|Yes|No
  * |Sqlite3Persister|SQLite in Node, via [sqlite3](https://github.com/TryGhost/node-sqlite3)|Yes|Yes*
+ * |SqliteBunPersister| SQLite in Bun, via [bun:sqlite](https://bun.sh/docs/api/sqlite)|Yes|Yes*
  * |SqliteWasmPersister|SQLite in a browser, via [sqlite-wasm](https://github.com/tomayac/sqlite-wasm)|Yes|Yes*
  * |ExpoSqlitePersister|SQLite in React Native, via [expo-sqlite](https://github.com/expo/expo/tree/main/packages/expo-sqlite)|Yes|Yes*
  * |PostgresPersister|PostgreSQL, via [postgres](https://github.com/porsager/postgres)|Yes|Yes*
@@ -1710,7 +1711,7 @@ export type DatabaseChangeListener = (tableName: string) => void;
  * // -> '[{"pets":{"fido":{"species":"dog"}}},{}]'
  * storePersister.destroy();
  *
- * const mergeableStore = createMergeableStore('mergeableStore1'); // !resetHlc
+ * const mergeableStore = createMergeableStore('mergeableStore1'); // !reset
  * mergeableStore.setTables({pets: {fido: {species: 'dog'}}});
  * const mergeableStorePersister = createJsonPersister(mergeableStore);
  * await mergeableStorePersister.save();

package/@types/persisters/persister-sqlite-bun/index.d.ts

@@ -0,0 +1,159 @@
+/**
+ * The persister-sqlite-bun module of the TinyBase project lets you save and
+ * load Store data to and from a local Bun SQLite database (in an appropriate
+ * environment).
+ * @see Database Persistence guide
+ * @packageDocumentation
+ * @module persister-sqlite-bun
+ * @since v6.1.0
+ */
+import type {Database} from 'bun:sqlite';
+import type {MergeableStore} from '../../mergeable-store/index.d.ts';
+import type {Store} from '../../store/index.d.ts';
+import type {DatabasePersisterConfig, Persister, Persists} from '../index.d.ts';
+
+/**
+ * The SqliteBunPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local Bun SQLite database.
+ *
+ * You should use the createSqliteBunPersister function to create a
+ * SqliteBunPersister object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getDb method for accessing a reference to the database instance the
+ * Store is being persisted to.
+ * @category Persister
+ * @since v6.1.0
+ */
+export interface SqliteBunPersister
+  extends Persister<Persists.StoreOrMergeableStore> {
+  /**
+   * 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 bun
+   * import {Database} from 'bun:sqlite';
+   * import {createStore} from 'tinybase';
+   * import {createSqliteBunPersister} from 'tinybase/persisters/persister-sqlite-bun';
+   *
+   * const db = new Database(':memory:');
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createSqliteBunPersister(store, db, 'my_tinybase');
+   *
+   * console.log(persister.getDb() == db);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v6.1.0
+   */
+  getDb(): Database;
+}
+
+/**
+ * The createSqliteBunPersister function creates a SqliteBunPersister object
+ * that can persist the Store to a local Bun SQLite database.
+ *
+ * A SqliteBunPersister supports regular Store objects, and can also be used to
+ * persist the metadata of a MergeableStore when using the JSON serialization
+ * mode, as described below.
+ *
+ * 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 or MergeableStore to persist.
+ * @param db The database instance that was returned from `new 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.
+ * @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 SqliteBunPersister object.
+ * @example
+ * This example creates a SqliteBunPersister 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 bun
+ * import {Database} from 'bun:sqlite';
+ * import {createStore} from 'tinybase';
+ * import {createSqliteBunPersister} from 'tinybase/persisters/persister-sqlite-bun';
+ *
+ * const db = new Database(':memory:');
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createSqliteBunPersister(store, db, 'my_tinybase');
+ *
+ * await persister.save();
+ * // Store will be saved to the database.
+ *
+ * console.log(db.query('SELECT * FROM my_tinybase;').all());
+ * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
+ *
+ * db.query(
+ *   'UPDATE my_tinybase SET store = ' +
+ *     `'[{"pets":{"felix":{"species":"cat"}}},{}]' WHERE _id = '_';`,
+ * ).run();
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {felix: {species: 'cat'}}}
+ *
+ * persister.destroy();
+ * ```
+ * @example
+ * This example creates a SqliteBunPersister object and persists the Store to a
+ * local SQLite database with tabular mapping.
+ *
+ * ```js bun
+ * import {Database} from 'bun:sqlite';
+ * import {createStore} from 'tinybase';
+ * import {createSqliteBunPersister} from 'tinybase/persisters/persister-sqlite-bun';
+ *
+ * const db = new Database(':memory:');
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * const persister = createSqliteBunPersister(store, db, {
+ *   mode: 'tabular',
+ *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
+ * });
+ *
+ * await persister.save();
+ * console.log(db.query('SELECT * FROM pets;').all());
+ * // -> [{_id: 'fido', species: 'dog'}]
+ *
+ * db.query(`INSERT INTO pets (_id, species) VALUES ('felix', 'cat')`).run();
+ * await persister.load();
+ * console.log(store.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * persister.destroy();
+ * ```
+ * @category Creation
+ * @since v6.1.0
+ */
+export function createSqliteBunPersister(
+  store: Store | MergeableStore,
+  db: Database,
+  configOrStoreTableName?: DatabasePersisterConfig | string,
+  onSqlCommand?: (sql: string, params?: any[]) => void,
+  onIgnoredError?: (error: any) => void,
+): SqliteBunPersister;