tinybase 5.0.0-beta.17 → 5.0.0-beta.19

package/lib/types/with-schemas/synchronizers/synchronizer-local.d.ts

@@ -1,29 +0,0 @@
-/**
- * The synchronizer-local module of the TinyBase project lets you synchronize
- * MergeableStore data to and from other MergeableStore instances on the same
- * local machine.
- * @see Synchronizing Data guide
- * @packageDocumentation
- * @module synchronizer-local
- * @since v5.0.0
- */
-
-import {MergeableStore} from '../mergeable-store.d.ts';
-import {OptionalSchemas} from '../store.d.ts';
-import {Synchronizer} from '../synchronizers.d.ts';
-
-/**
- * The LocalSynchronizer interface
- * @category Synchronizer
- */
-export interface LocalSynchronizer<Schemas extends OptionalSchemas>
-  extends Synchronizer<Schemas> {}
-
-/**
- * The createLocalSynchronizer function
- * @category Creation
- */
-export function createLocalSynchronizer<Schemas extends OptionalSchemas>(
-  store: MergeableStore<Schemas>,
-  onIgnoredError?: (error: any) => void,
-): LocalSynchronizer<Schemas>;

package/lib/types/with-schemas/synchronizers/synchronizer-ws-client.d.ts

@@ -1,42 +0,0 @@
-/**
- * The synchronizer-ws module of the TinyBase project lets you synchronize
- * MergeableStore data to and from other MergeableStore instances via WebSockets
- * facilitated by a server.
- * @see Synchronizing Data guide
- * @see Todo App v6 (collaboration) demo
- * @packageDocumentation
- * @module synchronizer-ws-client
- * @since v5.0.0
- */
-
-import {MergeableStore} from '../mergeable-store.d.ts';
-import {OptionalSchemas} from '../store.d.ts';
-import {Synchronizer} from '../synchronizers.d.ts';
-import {WebSocket as WsWebSocket} from 'ws';
-
-export type WebSocketTypes = WebSocket | WsWebSocket;
-
-/**
- * The WsSynchronizer interface
- * @category Synchronizer
- */
-export interface WsSynchronizer<
-  Schemas extends OptionalSchemas,
-  WebSocketType extends WebSocketTypes,
-> extends Synchronizer<Schemas> {
-  getWebSocket(): WebSocketType;
-}
-
-/**
- * The createWsSynchronizer function
- * @category Creation
- */
-export function createWsSynchronizer<
-  Schemas extends OptionalSchemas,
-  WebSocketType extends WebSocketTypes,
->(
-  store: MergeableStore<Schemas>,
-  webSocket: WebSocketType,
-  requestTimeoutSeconds?: number,
-  onIgnoredError?: (error: any) => void,
-): Promise<WsSynchronizer<Schemas, WebSocketType>>;

package/lib/types/with-schemas/synchronizers/synchronizer-ws-server.d.ts

@@ -1,58 +0,0 @@
-/**
- * The synchronizer-ws-server module of the TinyBase project lets you create
- * a server that facilitates synchronization between clients.
- * @see Synchronizing Data guide
- * @see Todo App v6 (collaboration) demo
- * @packageDocumentation
- * @module synchronizer-ws-server
- * @since v5.0.0
- */
-
-import {Id, IdOrNull, Ids} from '../common.d.ts';
-import {GetIdChanges} from '../store.d.ts';
-import {WebSocketServer} from 'ws';
-
-/**
- * The PathIdsListener type
- */
-export type PathIdsListener<> = (
-  wsServer: WsServer,
-  getIdChanges: GetIdChanges<Id>,
-) => void;
-
-/**
- * The ClientIdsListener type
- */
-export type ClientIdsListener<> = (
-  wsServer: WsServer,
-  pathId: Id,
-  getIdChanges: GetIdChanges<Id>,
-) => void;
-
-/**
- * The WsServerStats type
- */
-export type WsServerStats = {
-  paths?: number;
-  clients?: number;
-};
-
-/**
- * The WsServer interface
- */
-export interface WsServer {
-  getWebSocketServer: () => WebSocketServer;
-  getPathIds: () => Ids;
-  getClientIds: (pathId: Id) => Ids;
-  addPathIdsListener: (listener: PathIdsListener) => Id;
-  addClientIdsListener: (pathId: IdOrNull, listener: ClientIdsListener) => Id;
-  delListener(listenerId: Id): WsServer;
-  getStats: () => WsServerStats;
-  destroy: () => void;
-}
-
-/**
- * The createWsServer function
- * @category Creation
- */
-export function createWsServer(WebSocketServer: WebSocketServer): WsServer;

package/lib/types/with-schemas/synchronizers.d.ts

@@ -1,150 +0,0 @@
-/**
- * The persister-sync module of the TinyBase project lets you synchronize
- * MergeableStore data to and from other MergeableStore instances.
- * @see Synchronizing Data guide
- * @packageDocumentation
- * @module synchronizers
- * @since v5.0.0
- */
-
-import {Content, OptionalSchemas} from './store.d.ts';
-import {Id, IdOrNull} from './common.d.ts';
-import {MergeableStore} from './mergeable-store.d.ts';
-import {Persister} from './persisters.d.ts';
-
-/**
- * The MessageType type
- * @category Synchronization
- */
-export type MessageType = number;
-
-/**
- * The Receive type
- * @category Synchronization
- */
-export type Receive = (
-  fromClientId: Id,
-  requestId: Id,
-  messageType: MessageType,
-  messageBody: any,
-) => void;
-
-/**
- * The Send type
- * @category Synchronization
- */
-export type Send = (
-  toClientId: IdOrNull,
-  requestId: Id,
-  messageType: MessageType,
-  messageBody: any,
-) => void;
-
-/**
- * The SynchronizerStats type
- * @category Development
- */
-export type SynchronizerStats = {
-  sends?: number;
-  receives?: number;
-};
-
-/**
- * The Synchronizer interface is a minor extension to the Persister interface.
- *
- * It provides extra convenience methods for starting and stopping the
- * synchronization.
- *
- * You should use the createCustomSynchronizer function to create a Synchronizer
- * object.
- * @category Synchronizer
- * @since v5.0.0
- */
-export interface Synchronizer<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, 2> {
-  /**
-   * The startSync method
-   * @category Synchronization
-   */
-  startSync(initialContent?: Content<Schemas, true>): Promise<this>;
-  /**
-   * The stopSync method
-   * @category Synchronization
-   */
-  stopSync(): this;
-  /**
-   * The getSynchronizerStats method
-   * @category Synchronization
-   */
-  getSynchronizerStats(): SynchronizerStats;
-}
-
-/**
- * The createCustomSynchronizer function creates a Synchronizer object that can
- * persist one MergeableStore to another.
- *
- * This has schema-based typing. The following is a simplified representation:
- *
- * ```ts override
- * createCustomSynchronizer(
- *   store: MergeableStore,
- *   send: Send,
- *   onReceive: (receive: Receive) => void,
- *   destroy: () => void,
- *   requestTimeoutSeconds: number,
- *   onIgnoredError?: (error: any) => void,
- * ): Synchronizer;
- * ```
- *
- * As well as providing a reference to the MergeableStore to synchronize, you
- * must provide parameters which identify how to send and receive changes to and
- * from this MergeableStore and its peers.
- * @param store The MergeableStore to synchronize.
- * @param send A Send function for sending a message.
- * @param onReceive A callback to register a Receive function for receiving a
- * message.
- * @param destroy A function called when destroying the Persister which can be
- * used to clean up underlying resources.
- * @param requestTimeoutSeconds An number of seconds before a request sent from
- * this Persister to another peer times out.
- * @param onIgnoredError An optional handler for the errors that the
- * Synchronizer would otherwise ignore when trying to save or load data. This is
- * suitable for debugging synchronization issues in a development environment.
- * @returns A reference to the new Synchronizer object.
- * @example
- * This example creates a Synchronizer object and synchronizes one
- * MergeableStore to another.
- *
- * ```js
- * const store1 = createMergeableStore('store1').setTables({
- *   pets: {fido: {species: 'dog'}},
- * });
- * const synchronizer1 = createLocalSynchronizer(store1);
- *
- * const store2 = createMergeableStore('store2');
- * const synchronizer2 = createLocalSynchronizer(store2);
- * await synchronizer2.startSync();
- *
- * await synchronizer1.save();
- * // ...
- * // Store2 will be synced with Store1.
- *
- * console.log(store2.getTables());
- * // -> {pets: {fido: {species: 'dog'}}}
- *
- * await synchronizer1.load();
- * // Store1 will be synced with Store2.
- *
- * synchronizer1.destroy();
- * synchronizer2.destroy();
- * ```
- * @category Creation
- */
-export function createCustomSynchronizer<Schemas extends OptionalSchemas>(
-  store: MergeableStore<Schemas>,
-  send: Send,
-  onReceive: (receive: Receive) => void,
-  destroy: () => void,
-  requestTimeoutSeconds: number,
-  onIgnoredError?: (error: any) => void,
-): Synchronizer<Schemas>;

package/lib/types/with-schemas/tinybase.d.ts

@@ -1,14 +0,0 @@
-/**
- * This is everything.
- * @packageDocumentation
- */
-
-export * from './checkpoints.d.ts';
-export * from './common.d.ts';
-export * from './indexes.d.ts';
-export * from './metrics.d.ts';
-export * from './persisters.d.ts';
-export * from './queries.d.ts';
-export * from './relationships.d.ts';
-export * from './mergeable-store.d.ts';
-export * from './store.d.ts';