tinybase 5.0.0-beta.18 → 5.0.0-beta.19

package/lib/types/with-schemas/persisters/persister-indexed-db.d.ts

@@ -1,128 +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 Persisting Data guide
- * @packageDocumentation
- * @module persister-indexed-db
- */
-
-import {OptionalSchemas, Store} from '../store.d.ts';
-import {Persister} from '../persisters.d.ts';
-
-/**
- * The IndexedDbPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getDbName method for accessing the unique key of
- * the IndexedDB the Store is being persisted to.
- *
- * You should use the createIndexedDbPersister function to create an
- * IndexedDbPersister object.
- * @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 {createIndexedDbPersister} from 'tinybase/persisters/persister-indexed-db';
-   * import {createStore} from 'tinybase';
-   *
-   * 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 a Persister object that can
- * persist the 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;
- * ```
- *
- * 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 {createIndexedDbPersister} from 'tinybase/persisters/persister-indexed-db';
- * import {createStore} from 'tinybase';
- *
- * 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/lib/types/with-schemas/persisters/persister-libsql.d.ts

@@ -1,167 +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 Persisting Data guide
- * @packageDocumentation
- * @module persister-libsql
- * @since v4.7.0
- */
-
-import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
-import {OptionalSchemas, Store} from '../store.d.ts';
-import {Client} from '@libsql/client';
-
-/**
- * The LibSqlPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getClient method for accessing a reference to the
- * database client the Store is being persisted to.
- *
- * You should use the createLibSqlPersister function to create a LibSqlPersister
- * object.
- * @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 {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
-   * import {createStore} from 'tinybase';
-   *
-   * 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 Persister object that can
- * persist the Store to a local LibSQL database (in an appropriate environment).
- *
- * This has schema-based typing. The following is a simplified representation:
- *
- * ```ts override
- * createLibSqlPersister(
- *   store: Store,
- *   client: Client,
- *   configOrStoreTableName?: DatabasePersisterConfig | string,
- *   onSqlCommand?: (sql: string, args?: any[]) => void,
- *   onIgnoredError?: (error: any) => void,
- * ): LibSqlPersister;
- * ```
- *
- * 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 {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
- * import {createStore} from 'tinybase';
- *
- * 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 {createLibSqlPersister} from 'tinybase/persisters/persister-libsql';
- * import {createStore} from 'tinybase';
- *
- * 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, args?: any[]) => void,
-  onIgnoredError?: (error: any) => void,
-): LibSqlPersister<Schemas>;

package/lib/types/with-schemas/persisters/persister-partykit-client.d.ts

@@ -1,197 +0,0 @@
-/**
- * The persister-partykit-client module of the TinyBase project contains the
- * client portion of the PartyKit integration.
- *
- * It contains a Persister which, when run in a PartyKit client environment,
- * lets you save and load Store data from the client to durable PartyKit cloud
- * storage of a server (that is using the complementary
- * persister-partykit-server module).
- *
- * This enables synchronization of the same Store across multiple clients in a
- * PartyKit party room.
- *
- * Note that both the client and server parts of this Persister are currently
- * experimental as PartyKit is new and still maturing.
- * @see Persisting Data guide
- * @packageDocumentation
- * @module persister-partykit-client
- * @since 4.3.0
- */
-
-import {OptionalSchemas, Store} from '../store.d.ts';
-import PartySocket from 'partysocket';
-import {Persister} from '../persisters.d.ts';
-
-/**
- * The PartyKitPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getConnection method for accessing the
- * PartySocket the Store is being persisted to.
- *
- * You should use the createPartyKitPersister function to create a
- * PartyKitPersister object.
- * @category Persister
- * @since v4.3.14
- */
-export interface PartyKitPersister<Schemas extends OptionalSchemas>
-  extends Persister<Schemas> {
-  /**
-   * The getConnection method returns the PartySocket the Store is being
-   * persisted to.
-   * @returns The PartySocket.
-   * @example
-   * This example creates a Persister object against a newly-created Store and
-   * then gets the PartySocket back out again.
-   *
-   * ```js yolo
-   * import PartySocket from 'partysocket';
-   * import {createPartyKitPersister} from 'tinybase/persisters/persister-partykit-client';
-   * import {createStore} from 'tinybase';
-   *
-   * const partySocket = new PartySocket({
-   *   host: '127.0.0.1:1999',
-   *   room: 'my_room',
-   * });
-   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
-   * const persister = createPartyKitPersister(store, partySocket);
-   *
-   * console.log(persister.getConnection() == partySocket);
-   * // -> true
-   *
-   * persister.destroy();
-   * ```
-   * @category Getter
-   * @since v4.3.14
-   */
-  getConnection(): PartySocket;
-}
-
-/**
- * The PartyKitPersisterConfig type describes the configuration of a PartyKit
- * Persister on the client side.
- *
- * The defaults (if used on both the server and client) will work fine, but if
- * you are building more complex PartyKit apps and you need to configure path
- * names, for example, then this is the thing to use.
- * @example
- * When applied to a PartyKit Persister, this PartyKitPersisterConfig will load
- * and save a JSON serialization from and to an end point in your room called
- * `/my_tinybase`, and use HTTP (rather than the default HTTPS) as the protocol.
- *
- * Note that this would require you to also add the matching storePath setting
- * to the TinyBasePartyKitServerConfig on the server side.
- *
- * ```js
- * export const partyKitPersisterConfig = {
- *   storeProtocol: 'http',
- *   storePath: '/my_tinybase',
- * };
- * ```
- * @category Configuration
- * @since v4.3.9
- */
-export type PartyKitPersisterConfig = {
-  /**
-   * The HTTP protocol to use (in addition to the websocket channel). This
-   * defaults to 'https' but you may wish to use 'http' for local PartyKit
-   * development.
-   */
-  storeProtocol?: 'http' | 'https';
-  /**
-   * The path used to set and get the whole Store over HTTP(S) on the server.
-   * This must match the storePath property of the TinyBasePartyKitServerConfig
-   * object used on the server. Both default to '/store'.
-   */
-  storePath?: string;
-  /**
-   * The prefix at the beginning of the web socket messages sent between the
-   * client and the server when synchronizing the Store. Use this to make sure
-   * they do not collide with any other message syntax that your room is using.
-   * This must match the messagePrefix property of the
-   * TinyBasePartyKitServerConfig object used on the server. Both default to an
-   * empty string.
-   */
-  messagePrefix?: string;
-};
-
-/**
- * The createPartyKitPersister function creates a Persister object that can
- * persist the Store to durable PartyKit storage, enabling synchronization of
- * the same Store across multiple clients.
- *
- * This has schema-based typing. The following is a simplified representation:
- *
- * ```ts override
- * createPartyKitPersister(
- *   store: Store,
- *   connection: PartySocket,
- *   configOrStoreProtocol?: PartyKitPersisterConfig | 'http' | 'https',
- *   onIgnoredError?: (error: any) => void,
- * ): PartyKitPersister;
- * ```
- *
- * As well as providing a reference to the Store to persist, you must provide a
- * `connection` parameter which is a PartyKit PartySocket that you have already
- * instantiated with details of the host and room.
- *
- * All suitably-equipped TinyBase clients connecting to that room will get to
- * share synchronized Store state.
- *
- * The server room's Store is considered the source of truth. If it is a
- * newly-created room, then calling the save method on this Persister will
- * initiate it. If, however, there is already a Store present on the server, the
- * save method will fail gracefully.
- *
- * In general, you are strongly recommended to use the auto-save and auto-load
- * functionality to stay in sync incrementally with the server, as per the
- * example below. This pattern will handle newly-created servers and
- * newly-created clients - and the synchronization involved in joining rooms,
- * leaving them, or temporarily going offline.
- *
- * See the [PartyKit client socket API
- * documentation](https://docs.partykit.io/reference/partysocket-api/) for more
- * details.
- * @param store The Store to persist.
- * @param connection The PartySocket to use for participating in the PartyKit
- * room.
- * @param configOrStoreProtocol The PartyKitPersisterConfig configuration for
- * the Persister, (or a string to specify a HTTP protocol to use, defaulting to
- * 'https').
- * @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 PartyKitPersister object.
- * @example
- * This example creates a PartyKitPersister object and persists the Store to the
- * browser's IndexedDB storage.
- *
- * ```js yolo
- * import PartySocket from 'partysocket';
- * import {createPartyKitPersister} from 'tinybase/persisters/persister-partykit-client';
- * import {createStore} from 'tinybase';
- *
- * const store = createStore()
- *   .setTable('pets', {fido: {species: 'dog'}})
- *   .setTable('species', {dog: {price: 5}})
- *   .setValues({open: true});
- * const partySocket = new PartySocket({
- *   host: '127.0.0.1:1999',
- *   room: 'my_room',
- * });
- * const persister = createPartyKitPersister(store, partySocket);
- * await persister.startAutoLoad();
- * await persister.startAutoSave();
- * // Store will now be synchronized with the room.
- *
- * persister.destroy();
- * ```
- * @category Creation
- * @since 4.3.0
- */
-export function createPartyKitPersister<Schemas extends OptionalSchemas>(
-  store: Store<Schemas>,
-  connection: PartySocket,
-  configOrStoreProtocol?: PartyKitPersisterConfig | 'http' | 'https',
-  onIgnoredError?: (error: any) => void,
-): PartyKitPersister<Schemas>;