tinybase 6.1.0-beta.1 → 6.1.0-beta.3

package/@types/persisters/persister-indexed-db/index.d.cts

@@ -1,120 +0,0 @@
-/**
- * The persister-indexed-db module of the TinyBase project lets you save and
- * load Store data to and from browser IndexedDB storage.
- * @see Persistence guides
- * @packageDocumentation
- * @module persister-indexed-db
- * @since v4.2.0
- */
-import type {Store} from '../../store/index.d.cts';
-import type {Persister} from '../index.d.cts';
-
-/**
- * The IndexedDbPersister interface represents a Persister that lets you save
- * and load Store data to and from browser IndexedDB storage.
- *
- * You should use the createIndexedDbPersister function to create an
- * IndexedDbPersister object.
- *
- * It is a minor extension to the Persister interface and simply provides an
- * extra getDbName method for accessing the unique key of the IndexedDB the
- * Store is being persisted to.
- * @category Persister
- * @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
-   * import {createStore} from 'tinybase';
-   * import {createIndexedDbPersister} from 'tinybase/persisters/persister-indexed-db';
-   *
-   * 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 an IndexedDbPersister object
- * that can persist a Store to the browser's IndexedDB storage.
- *
- * An IndexedDbPersister only supports regular Store objects, and cannot be used
- * to persist the metadata of a MergeableStore.
- *
- * As well as providing a reference to the Store to persist, you must provide a
- * `dbName` parameter which is unique to your application. This is the key used
- * to identify which IndexedDB to use.
- *
- * Within that database, this Persister will create two object stores: one
- * called 't', and one called 'v'. These will contain the Store's tabular and
- * key-value data respectively, using 'k' and 'v' to store the key and value of
- * each entry, as shown in the example.
- *
- * Note that it is not possible to reactively detect changes to a browser's
- * IndexedDB. If you do choose to enable automatic loading for the Persister
- * (with the startAutoLoad method), it needs to poll the database for changes.
- * The `autoLoadIntervalSeconds` method is used to indicate how often to do
- * this.
- * @param store The Store to persist.
- * @param dbName The unique key to identify the IndexedDB to use.
- * @param autoLoadIntervalSeconds How often to poll the database when in
- * 'autoLoad' mode, defaulting to 1.
- * @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 IndexedDbPersister object.
- * @example
- * This example creates a IndexedDbPersister object and persists the Store to
- * the browser's IndexedDB storage.
- *
- * ```js
- * import {createStore} from 'tinybase';
- * import {createIndexedDbPersister} from 'tinybase/persisters/persister-indexed-db';
- *
- * const store = createStore()
- *   .setTable('pets', {fido: {species: 'dog'}})
- *   .setTable('species', {dog: {price: 5}})
- *   .setValues({open: true});
- * const persister = createIndexedDbPersister(store, 'petStore');
- *
- * await persister.save();
- * // IndexedDB ->
- * //   database petStore:
- * //     objectStore t:
- * //       object 0:
- * //         k: "pets"
- * //         v: {fido: {species: dog}}
- * //       object 1:
- * //         k: "species"
- * //         v: {dog: {price: 5}}
- * //     objectStore v:
- * //       object 0:
- * //         k: "open"
- * //         v: true
- *
- * persister.destroy();
- * ```
- * @category Creation
- * @since v4.2.0
- */
-export function createIndexedDbPersister(
-  store: Store,
-  dbName: string,
-  autoLoadIntervalSeconds?: number,
-  onIgnoredError?: (error: any) => void,
-): IndexedDbPersister;

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

@@ -1,135 +0,0 @@
-/**
- * The persister-indexed-db module of the TinyBase project lets you save and
- * load Store data to and from browser IndexedDB storage.
- * @see Persistence guides
- * @packageDocumentation
- * @module persister-indexed-db
- * @since v4.2.0
- */
-import type {
-  OptionalSchemas,
-  Store,
-} from '../../../store/with-schemas/index.d.cts';
-import type {Persister} from '../../with-schemas/index.d.cts';
-
-/**
- * The IndexedDbPersister interface represents a Persister that lets you save
- * and load Store data to and from browser IndexedDB storage.
- *
- * You should use the createIndexedDbPersister function to create an
- * IndexedDbPersister object.
- *
- * It is a minor extension to the Persister interface and simply provides an
- * extra getDbName method for accessing the unique key of the IndexedDB the
- * Store is being persisted to.
- * @category Persister
- * @since v4.3.14
- */
-export interface IndexedDbPersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas> {
-  /**
-   * 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
-   * import {createStore} from 'tinybase';
-   * import {createIndexedDbPersister} from 'tinybase/persisters/persister-indexed-db';
-   *
-   * 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 an IndexedDbPersister object
- * that can persist a Store to the browser's IndexedDB storage.
- *
- * This has schema-based typing. The following is a simplified representation:
- *
- * ```ts override
- * createIndexedDbPersister(
- *   store: Store,
- *   dbName: string,
- *   autoLoadIntervalSeconds?: number,
- *   onIgnoredError?: (error: any) => void,
- * ): IndexedDbPersister;
- * ```
- *
- * An IndexedDbPersister only supports regular Store objects, and cannot be used
- * to persist the metadata of a MergeableStore.
- *
- * As well as providing a reference to the Store to persist, you must provide a
- * `dbName` parameter which is unique to your application. This is the key used
- * to identify which IndexedDB to use.
- *
- * Within that database, this Persister will create two object stores: one
- * called 't', and one called 'v'. These will contain the Store's tabular and
- * key-value data respectively, using 'k' and 'v' to store the key and value of
- * each entry, as shown in the example.
- *
- * Note that it is not possible to reactively detect changes to a browser's
- * IndexedDB. If you do choose to enable automatic loading for the Persister
- * (with the startAutoLoad method), it needs to poll the database for changes.
- * The `autoLoadIntervalSeconds` method is used to indicate how often to do
- * this.
- * @param store The Store to persist.
- * @param dbName The unique key to identify the IndexedDB to use.
- * @param autoLoadIntervalSeconds How often to poll the database when in
- * 'autoLoad' mode, defaulting to 1.
- * @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 IndexedDbPersister object.
- * @example
- * This example creates a IndexedDbPersister object and persists the Store to
- * the browser's IndexedDB storage.
- *
- * ```js
- * import {createStore} from 'tinybase';
- * import {createIndexedDbPersister} from 'tinybase/persisters/persister-indexed-db';
- *
- * const store = createStore()
- *   .setTable('pets', {fido: {species: 'dog'}})
- *   .setTable('species', {dog: {price: 5}})
- *   .setValues({open: true});
- * const persister = createIndexedDbPersister(store, 'petStore');
- *
- * await persister.save();
- * // IndexedDB ->
- * //   database petStore:
- * //     objectStore t:
- * //       object 0:
- * //         k: "pets"
- * //         v: {fido: {species: dog}}
- * //       object 1:
- * //         k: "species"
- * //         v: {dog: {price: 5}}
- * //     objectStore v:
- * //       object 0:
- * //         k: "open"
- * //         v: true
- *
- * persister.destroy();
- * ```
- * @category Creation
- * @since v4.2.0
- */
-export function createIndexedDbPersister<Schemas extends OptionalSchemas>(
-  store: Store<Schemas>,
-  dbName: string,
-  autoLoadIntervalSeconds?: number,
-  onIgnoredError?: (error: any) => void,
-): IndexedDbPersister<Schemas>;

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

@@ -1,158 +0,0 @@
-/**
- * The persister-libsql module of the TinyBase project lets you save and load
- * Store data to and from a local LibSQL database (in an appropriate
- * environment).
- * @see Database Persistence guide
- * @packageDocumentation
- * @module persister-libsql
- * @since v4.7.0
- */
-import type {Client} from '@libsql/client';
-import type {Store} from '../../store/index.d.cts';
-import type {DatabasePersisterConfig, Persister} from '../index.d.cts';
-
-/**
- * The LibSqlPersister interface represents a Persister that lets you save and
- * load Store data to and from a local LibSQL database.
- *
- * You should use the createLibSqlPersister function to create a LibSqlPersister
- * object.
- *
- * It is a minor extension to the Persister interface and simply provides an
- * extra getClient method for accessing a reference to the database client the
- * Store is being persisted to.
- * @category Persister
- * @since v4.7.0
- */
-export interface LibSqlPersister extends Persister {
-  /**
-   * The getClient method returns a reference to the database client the Store
-   * is being persisted to.
-   * @returns A reference to the database client.
-   * @example
-   * This example creates a Persister object against a newly-created Store and
-   * then gets the database client back out again.
-   *
-   * ```js yolo
-   * import {createClient} from '@libsql/client';
-   * import {createStore} from 'tinybase';
-   * import {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
-   *
-   * const client = createClient({url: 'file:my.db'});
-   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
-   * const persister = createLibSqlPersister(store, client, 'my_tinybase');
-   *
-   * console.log(persister.getClient() == client);
-   * // -> true
-   *
-   * persister.destroy();
-   * ```
-   * @category Getter
-   * @since v4.7.0
-   */
-  getClient(): Client;
-}
-
-/**
- * The createLibSqlPersister function creates a LibSqlPersister object that can
- * persist a Store to a local LibSQL database.
- *
- * A LibSqlPersister only supports regular Store objects, and cannot be used to
- * persist the metadata of a MergeableStore.
- *
- * As well as providing a reference to the Store to persist, you must provide a
- * `client` parameter which identifies the database client.
- *
- * 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 client The database client that was returned from `createClient(...)`.
- * @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 LibSqlPersister object.
- * @example
- * This example creates a LibSqlPersister 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 yolo
- * import {createClient} from '@libsql/client';
- * import {createStore} from 'tinybase';
- * import {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
- *
- * const client = createClient({url: 'file:my.db'});
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createLibSqlPersister(store, client, 'my_tinybase');
- *
- * await persister.save();
- * // Store will be saved to the database.
- *
- * console.log((await client.execute('SELECT * FROM my_tinybase;')).rows);
- * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
- *
- * await client.execute(
- *   'UPDATE my_tinybase SET store = ' +
- *     `'[{"pets":{"felix":{"species":"cat"}}},{}]' WHERE _id = '_';`,
- * );
- * await persister.load();
- * console.log(store.getTables());
- * // -> {pets: {felix: {species: 'cat'}}}
- *
- * persister.destroy();
- * ```
- * @example
- * This example creates a LibSqlPersister object and persists the Store to a
- * local SQLite database with tabular mapping.
- *
- * ```js yolo
- * import {createClient} from '@libsql/client';
- * import {createStore} from 'tinybase';
- * import {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
- *
- * const client = createClient({url: 'file:my.db'});
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createLibSqlPersister(store, client, {
- *   mode: 'tabular',
- *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
- * });
- *
- * await persister.save();
- * console.log((await client.execute('SELECT * FROM pets;')).rows);
- * // -> [{_id: 'fido', species: 'dog'}]
- *
- * await client.execute(
- *   `INSERT INTO pets (_id, species) VALUES ('felix', 'cat')`,
- * );
- * await persister.load();
- * console.log(store.getTables());
- * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
- *
- * persister.destroy();
- * ```
- * @category Creation
- * @since v4.7.0
- */
-export function createLibSqlPersister(
-  store: Store,
-  client: Client,
-  configOrStoreTableName?: DatabasePersisterConfig | string,
-  onSqlCommand?: (sql: string, params?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): LibSqlPersister;

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

@@ -1,177 +0,0 @@
-/**
- * The persister-libsql module of the TinyBase project lets you save and load
- * Store data to and from a local LibSQL database (in an appropriate
- * environment).
- * @see Database Persistence guide
- * @packageDocumentation
- * @module persister-libsql
- * @since v4.7.0
- */
-import type {Client} from '@libsql/client';
-import type {
-  OptionalSchemas,
-  Store,
-} from '../../../store/with-schemas/index.d.cts';
-import type {
-  DatabasePersisterConfig,
-  Persister,
-} from '../../with-schemas/index.d.cts';
-
-/**
- * The LibSqlPersister interface represents a Persister that lets you save and
- * load Store data to and from a local LibSQL database.
- *
- * You should use the createLibSqlPersister function to create a LibSqlPersister
- * object.
- *
- * It is a minor extension to the Persister interface and simply provides an
- * extra getClient method for accessing a reference to the database client the
- * Store is being persisted to.
- * @category Persister
- * @since v4.7.0
- */
-export interface LibSqlPersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas> {
-  /**
-   * The getClient method returns a reference to the database client the Store
-   * is being persisted to.
-   * @returns A reference to the database client.
-   * @example
-   * This example creates a Persister object against a newly-created Store and
-   * then gets the database client back out again.
-   *
-   * ```js yolo
-   * import {createClient} from '@libsql/client';
-   * import {createStore} from 'tinybase';
-   * import {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
-   *
-   * const client = createClient({url: 'file:my.db'});
-   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
-   * const persister = createLibSqlPersister(store, client, 'my_tinybase');
-   *
-   * console.log(persister.getClient() == client);
-   * // -> true
-   *
-   * persister.destroy();
-   * ```
-   * @category Getter
-   * @since v4.7.0
-   */
-  getClient(): Client;
-}
-
-/**
- * The createLibSqlPersister function creates a LibSqlPersister object that can
- * persist a Store to a local LibSQL database.
- *
- * This has schema-based typing. The following is a simplified representation:
- *
- * ```ts override
- * createLibSqlPersister(
- *   store: Store,
- *   client: Client,
- *   configOrStoreTableName?: DatabasePersisterConfig | string,
- *   onSqlCommand?: (sql: string, params?: any[]) => void,
- *   onIgnoredError?: (error: any) => void,
- * ): LibSqlPersister;
- * ```
- *
- * A LibSqlPersister only supports regular Store objects, and cannot be used to
- * persist the metadata of a MergeableStore.
- *
- * As well as providing a reference to the Store to persist, you must provide a
- * `client` parameter which identifies the database client.
- *
- * 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 client The database client that was returned from `createClient(...)`.
- * @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 LibSqlPersister object.
- * @example
- * This example creates a LibSqlPersister 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 yolo
- * import {createClient} from '@libsql/client';
- * import {createStore} from 'tinybase';
- * import {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
- *
- * const client = createClient({url: 'file:my.db'});
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createLibSqlPersister(store, client, 'my_tinybase');
- *
- * await persister.save();
- * // Store will be saved to the database.
- *
- * console.log((await client.execute('SELECT * FROM my_tinybase;')).rows);
- * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
- *
- * await client.execute(
- *   'UPDATE my_tinybase SET store = ' +
- *     `'[{"pets":{"felix":{"species":"cat"}}},{}]' WHERE _id = '_';`,
- * );
- * await persister.load();
- * console.log(store.getTables());
- * // -> {pets: {felix: {species: 'cat'}}}
- *
- * persister.destroy();
- * ```
- * @example
- * This example creates a LibSqlPersister object and persists the Store to a
- * local SQLite database with tabular mapping.
- *
- * ```js yolo
- * import {createClient} from '@libsql/client';
- * import {createStore} from 'tinybase';
- * import {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
- *
- * const client = createClient({url: 'file:my.db'});
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createLibSqlPersister(store, client, {
- *   mode: 'tabular',
- *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
- * });
- *
- * await persister.save();
- * console.log((await client.execute('SELECT * FROM pets;')).rows);
- * // -> [{_id: 'fido', species: 'dog'}]
- *
- * await client.execute(
- *   `INSERT INTO pets (_id, species) VALUES ('felix', 'cat')`,
- * );
- * await persister.load();
- * console.log(store.getTables());
- * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
- *
- * persister.destroy();
- * ```
- * @category Creation
- * @since v4.7.0
- */
-export function createLibSqlPersister<Schemas extends OptionalSchemas>(
-  store: Store<Schemas>,
-  client: Client,
-  configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
-  onSqlCommand?: (sql: string, params?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): LibSqlPersister<Schemas>;