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

package/@types/persisters/persister-durable-object-storage/with-schemas/index.d.cts

@@ -1,136 +0,0 @@
-/**
- * The persister-durable-object-storage module of the TinyBase project lets you
- * save and load Store data to and from Cloudflare Durable Object storage (in an
- * appropriate environment).
- * @see Cloudflare Durable Objects guide
- * @see Persistence guides
- * @packageDocumentation
- * @module persister-durable-object-storage
- * @since v5.4.0
- */
-import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.cts';
-import type {OptionalSchemas} from '../../../store/with-schemas/index.d.cts';
-import type {Persister, Persists} from '../../with-schemas/index.d.cts';
-
-/**
- * The DurableObjectStoragePersister interface represents a Persister that lets
- * you save and load Store data to and from Cloudflare Durable Object storage.
- *
- * You should use the createDurableObjectStoragePersister function to create a
- * DurableObjectStoragePersister object, most likely within the createPersister
- * method of a WsServerDurableObject.
- *
- * It is a minor extension to the Persister interface and simply provides an
- * extra getStorage method for accessing a reference to the storage that the
- * Store is being persisted to.
- * @category Persister
- * @since v5.4.0
- */
-export interface DurableObjectStoragePersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, Persists.MergeableStoreOnly> {
-  /**
-   * The getStorage method returns a reference to the storage that the Store is
-   * being persisted to.
-   * @returns The reference to the storage.
-   * @example
-   * This example creates a Persister object against a newly-created Store
-   * (within the createPersister method of a WsServerDurableObject instance) and
-   * then gets the storage reference back out again.
-   *
-   * ```js yolo
-   * import {createMergeableStore} from 'tinybase';
-   * import {createDurableObjectStoragePersister} from 'tinybase/persisters/persister-durable-object-storage';
-   * import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
-   *
-   * export class MyDurableObject extends WsServerDurableObject {
-   *   createPersister() {
-   *     const store = createMergeableStore();
-   *     const persister = createDurableObjectStoragePersister(
-   *       store,
-   *       this.ctx.storage,
-   *     );
-   *     console.log(persister.getStorage() == this.ctx.storage);
-   *     // -> true
-   *
-   *     return persister;
-   *   }
-   * }
-   * ```
-   * @category Getter
-   * @since v5.4.0
-   */
-  getStorage(): DurableObjectStorage;
-}
-
-/**
- * The createDurableObjectStoragePersister function creates a
- * DurableObjectStoragePersister object that can persist the Store to and from
- * Cloudflare Durable Object storage.
- *
- * This has schema-based typing. The following is a simplified representation:
- *
- * ```ts override
- * createDurableObjectStoragePersister(
- *   store: MergeableStore,
- *   storage: DurableObjectStorage,
- *   storagePrefix?: string,
- *   onIgnoredError?: (error: any) => void,
- * ): DurableObjectStoragePersister;
- * ```
- *
- * You will mostly use this within the createPersister method of a
- * WsServerDurableObject.
- *
- * A DurableObjectStoragePersister only supports MergeableStore objects, and
- * cannot be used to persist a regular Store.
- *
- * Durable Objects have limitations on the data that can be stored in each key
- * of their key-value structure. The DurableObjectStoragePersister uses one key
- * per TinyBase Value, one key per Cell, one key per Row, and one key per Table.
- * Mostly this is CRDT metadata, but the main caution is to ensure that each
- * individual TinyBase Cell and Value data does not exceed the (128 KiB) limit.
- *
- * As well as providing a reference to the MergeableStore to persist, you must
- * provide a `storage` parameter which identifies the Durable Object storage to
- * persist it to.
- * @param store The MergeableStore to persist.
- * @param storage The Durable Object storage to persist the Store to.
- * @param storagePrefix An optional prefix to use on the keys in storage, which
- * is useful if you want to ensure the Persister will not affect unrelated
- * Durable Object storage. Defaults to an empty string.
- * @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 DurableObjectStoragePersister object.
- * @example
- * This example creates a Persister object against a newly-created
- * MergeableStore (within the createPersister method of a WsServerDurableObject
- * instance) and then gets the storage reference back out again.
- *
- * ```js yolo
- * import {createMergeableStore} from 'tinybase';
- * import {createDurableObjectStoragePersister} from 'tinybase/persisters/persister-durable-object-storage';
- * import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
- *
- * export class MyDurableObject extends WsServerDurableObject {
- *   createPersister() {
- *     const store = createMergeableStore();
- *     const persister = createDurableObjectStoragePersister(
- *       store,
- *       this.ctx.storage,
- *     );
- *     return persister;
- *   }
- * }
- * ```
- * @category Creation
- * @since v5.4.0
- */
-export function createDurableObjectStoragePersister<
-  Schemas extends OptionalSchemas,
->(
-  store: MergeableStore<Schemas>,
-  storage: DurableObjectStorage,
-  storagePrefix?: string,
-  onIgnoredError?: (error: any) => void,
-): DurableObjectStoragePersister<Schemas>;

package/@types/persisters/persister-electric-sql/index.d.cts

@@ -1,185 +0,0 @@
-/**
- * The persister-electric-sql module of the TinyBase project lets you save and
- * load Store data to and from a local ElectricSQL database (in an appropriate
- * environment).
- * @see Database Persistence guide
- * @packageDocumentation
- * @module persister-electric-sql
- * @since v4.6.0
- */
-import type {ElectricClient} from 'electric-sql/client/model';
-import type {Store} from '../../store/index.d.cts';
-import type {DatabasePersisterConfig, Persister} from '../index.d.cts';
-
-/**
- * The ElectricSqlPersister interface represents a Persister that lets you save
- * and load Store data to and from a local ElectricSQL database.
- *
- * You should use the createElectricSqlPersister function to create an
- * ElectricSqlPersister object.
- *
- * It is a minor extension to the Persister interface and simply provides an
- * extra getElectricClient method for accessing a reference to the Electric
- * client the Store is being persisted to.
- * @category Persister
- * @since v4.6.0
- */
-export interface ElectricSqlPersister extends Persister {
-  /**
-   * The getElectricClient method returns a reference to the Electric client the
-   * Store is being persisted to.
-   * @returns A reference to the Electric client.
-   * @example
-   * This example creates a Persister object against a newly-created Store and
-   * then gets the Electric client back out again.
-   *
-   * ```js yolo
-   * import {ElectricDatabase, electrify} from 'electric-sql/wa-sqlite';
-   * import {createStore} from 'tinybase';
-   * import {createElectricSqlPersister} from 'tinybase/persisters/persister-electric-sql';
-   * import {schema} from './generated/client';
-   *
-   * const electricClient = await electrify(
-   *   await ElectricDatabase.init('electric.db', ''),
-   *   schema,
-   *   {url: import.meta.env.ELECTRIC_SERVICE},
-   * );
-   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
-   * const persister = createElectricSqlPersister(
-   *   store,
-   *   electricClient,
-   *   'my_tinybase',
-   * );
-   *
-   * console.log(persister.getElectricClient() == electricClient);
-   * // -> true
-   *
-   * persister.destroy();
-   * ```
-   * @category Getter
-   * @since v4.6.0
-   */
-  getElectricClient(): ElectricClient<any>;
-}
-
-/**
- * The createElectricSqlPersister function creates an ElectricSqlPersister
- * object that can persist a Store to a local ElectricSQL database.
- *
- * An ElectricSqlPersister 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
- * `electricClient` parameter which identifies the Electric 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 electricClient The Electric client that was returned from `await
- * electrify(...)`.
- * @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 ElectricSqlPersister object.
- * @example
- * This example creates a ElectricSqlPersister object and persists the Store to
- * a local ElectricSql 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 {ElectricDatabase, electrify} from 'electric-sql/wa-sqlite';
- * import {createStore} from 'tinybase';
- * import {createElectricSqlPersister} from 'tinybase/persisters/persister-electric-sql';
- * import {schema} from './generated/client';
- *
- * const electricClient = await electrify(
- *   await ElectricDatabase.init('electric.db', ''),
- *   schema,
- *   {url: import.meta.env.ELECTRIC_SERVICE},
- * );
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createElectricSqlPersister(
- *   store,
- *   electricClient,
- *   'my_tinybase',
- * );
- *
- * await persister.save();
- * // Store will be saved to the database.
- *
- * console.log(
- *   await electricClient.db.raw({sql: 'SELECT * FROM my_tinybase;'}),
- * );
- * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
- *
- * await electricClient.db.raw({
- *   sql:
- *     '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 ElectricSqlPersister object and persists the Store to
- * a local ElectricSql database with tabular mapping.
- *
- * ```js yolo
- * import {ElectricDatabase, electrify} from 'electric-sql/wa-sqlite';
- * import {createStore} from 'tinybase';
- * import {createElectricSqlPersister} from 'tinybase/persisters/persister-electric-sql';
- * import {schema} from './generated/client';
- *
- * const electricClient = await electrify(
- *   await ElectricDatabase.init('electric.db', ''),
- *   schema,
- *   {url: import.meta.env.ELECTRIC_SERVICE},
- * );
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createElectricSqlPersister(store, electricClient, {
- *   mode: 'tabular',
- *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
- * });
- *
- * await persister.save();
- * console.log(await electricClient.db.raw({sql: 'SELECT * FROM pets;'}));
- * // -> [{_id: 'fido', species: 'dog'}]
- *
- * await electricClient.db.raw({
- *   sql: `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.6.0
- */
-export function createElectricSqlPersister(
-  store: Store,
-  electricClient: ElectricClient<any>,
-  configOrStoreTableName?: DatabasePersisterConfig | string,
-  onSqlCommand?: (sql: string, params?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): ElectricSqlPersister;

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

@@ -1,204 +0,0 @@
-/**
- * The persister-electric-sql module of the TinyBase project lets you save and
- * load Store data to and from a local ElectricSQL database (in an appropriate
- * environment).
- * @see Database Persistence guide
- * @packageDocumentation
- * @module persister-electric-sql
- * @since v4.6.0
- */
-import type {ElectricClient} from 'electric-sql/client/model';
-import type {
-  OptionalSchemas,
-  Store,
-} from '../../../store/with-schemas/index.d.cts';
-import type {
-  DatabasePersisterConfig,
-  Persister,
-} from '../../with-schemas/index.d.cts';
-
-/**
- * The ElectricSqlPersister interface represents a Persister that lets you save
- * and load Store data to and from a local ElectricSQL database.
- *
- * You should use the createElectricSqlPersister function to create an
- * ElectricSqlPersister object.
- *
- * It is a minor extension to the Persister interface and simply provides an
- * extra getElectricClient method for accessing a reference to the Electric
- * client the Store is being persisted to.
- * @category Persister
- * @since v4.6.0
- */
-export interface ElectricSqlPersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas> {
-  /**
-   * The getElectricClient method returns a reference to the Electric client the
-   * Store is being persisted to.
-   * @returns A reference to the Electric client.
-   * @example
-   * This example creates a Persister object against a newly-created Store and
-   * then gets the Electric client back out again.
-   *
-   * ```js yolo
-   * import {ElectricDatabase, electrify} from 'electric-sql/wa-sqlite';
-   * import {createStore} from 'tinybase';
-   * import {createElectricSqlPersister} from 'tinybase/persisters/persister-electric-sql';
-   * import {schema} from './generated/client';
-   *
-   * const electricClient = await electrify(
-   *   await ElectricDatabase.init('electric.db', ''),
-   *   schema,
-   *   {url: import.meta.env.ELECTRIC_SERVICE},
-   * );
-   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
-   * const persister = createElectricSqlPersister(
-   *   store,
-   *   electricClient,
-   *   'my_tinybase',
-   * );
-   *
-   * console.log(persister.getElectricClient() == electricClient);
-   * // -> true
-   *
-   * persister.destroy();
-   * ```
-   * @category Getter
-   * @since v4.6.0
-   */
-  getElectricClient(): ElectricClient<any>;
-}
-
-/**
- * The createElectricSqlPersister function creates an ElectricSqlPersister
- * object that can persist a Store to a local ElectricSQL database.
- *
- * This has schema-based typing. The following is a simplified representation:
- *
- * ```ts override
- * createElectricSqlPersister(
- *   store: Store,
- *   electricClient: ElectricClient<any>,
- *   configOrStoreTableName?: DatabasePersisterConfig | string,
- *   onSqlCommand?: (sql: string, params?: any[]) => void,
- *   onIgnoredError?: (error: any) => void,
- * ): ElectricSqlPersister;
- * ```
- *
- * An ElectricSqlPersister 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
- * `electricClient` parameter which identifies the Electric 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 electricClient The Electric client that was returned from `await
- * electrify(...)`.
- * @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 ElectricSqlPersister object.
- * @example
- * This example creates a ElectricSqlPersister object and persists the Store to
- * a local ElectricSql 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 {ElectricDatabase, electrify} from 'electric-sql/wa-sqlite';
- * import {createStore} from 'tinybase';
- * import {createElectricSqlPersister} from 'tinybase/persisters/persister-electric-sql';
- * import {schema} from './generated/client';
- *
- * const electricClient = await electrify(
- *   await ElectricDatabase.init('electric.db', ''),
- *   schema,
- *   {url: import.meta.env.ELECTRIC_SERVICE},
- * );
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createElectricSqlPersister(
- *   store,
- *   electricClient,
- *   'my_tinybase',
- * );
- *
- * await persister.save();
- * // Store will be saved to the database.
- *
- * console.log(
- *   await electricClient.db.raw({sql: 'SELECT * FROM my_tinybase;'}),
- * );
- * // -> [{_id: '_', store: '[{"pets":{"fido":{"species":"dog"}}},{}]'}]
- *
- * await electricClient.db.raw({
- *   sql:
- *     '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 ElectricSqlPersister object and persists the Store to
- * a local ElectricSql database with tabular mapping.
- *
- * ```js yolo
- * import {ElectricDatabase, electrify} from 'electric-sql/wa-sqlite';
- * import {createStore} from 'tinybase';
- * import {createElectricSqlPersister} from 'tinybase/persisters/persister-electric-sql';
- * import {schema} from './generated/client';
- *
- * const electricClient = await electrify(
- *   await ElectricDatabase.init('electric.db', ''),
- *   schema,
- *   {url: import.meta.env.ELECTRIC_SERVICE},
- * );
- * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
- * const persister = createElectricSqlPersister(store, electricClient, {
- *   mode: 'tabular',
- *   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
- * });
- *
- * await persister.save();
- * console.log(await electricClient.db.raw({sql: 'SELECT * FROM pets;'}));
- * // -> [{_id: 'fido', species: 'dog'}]
- *
- * await electricClient.db.raw({
- *   sql: `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.6.0
- */
-export function createElectricSqlPersister<Schemas extends OptionalSchemas>(
-  store: Store<Schemas>,
-  electricClient: ElectricClient<any>,
-  configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
-  onSqlCommand?: (sql: string, params?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): ElectricSqlPersister<Schemas>;