@verdant-web/store 2.7.5 → 2.7.7-next.0

package/dist/esm/sync/Sync.d.ts

@@ -1,146 +1,146 @@
-import { ClientMessage, DocumentBaseline, EventSubscriber, FileData, Operation, ServerMessage } from '@verdant-web/common';
-import { Metadata } from '../metadata/Metadata.js';
-import { PresenceManager } from './PresenceManager.js';
-import { FilePullResult, FileUploadResult } from './FileSync.js';
-import { ServerSyncEndpointProviderConfig } from './ServerSyncEndpointProvider.js';
-type SyncEvents = {
-    onlineChange: (isOnline: boolean) => void;
-};
-export type SyncTransportEvents = SyncEvents & {
-    message: (message: ServerMessage) => void;
-};
-export interface SyncTransport {
-    subscribe(event: 'onlineChange', handler: (online: boolean) => void): () => void;
-    readonly presence: PresenceManager;
-    readonly mode: SyncTransportMode;
-    send(message: ClientMessage): void;
-    start(): void;
-    stop(): void;
-    dispose(): void;
-    reconnect(): void;
-    readonly isConnected: boolean;
-    readonly status: 'active' | 'paused';
-}
-export interface Sync<Presence = any, Profile = any> extends SyncTransport {
-    setMode(mode: SyncTransportMode): void;
-    setPullInterval(interval: number): void;
-    readonly pullInterval: number;
-    uploadFile(data: FileData): Promise<FileUploadResult>;
-    getFile(fileId: string): Promise<FilePullResult>;
-    readonly presence: PresenceManager<Profile, Presence>;
-}
-export declare class NoSync<Presence = any, Profile = any> extends EventSubscriber<SyncEvents> implements Sync<Presence, Profile> {
-    readonly mode = "pull";
-    send(): void;
-    start(): void;
-    stop(): void;
-    dispose: () => void;
-    reconnect(): void;
-    setMode(): void;
-    setPullInterval(): void;
-    readonly isConnected = false;
-    readonly status = "paused";
-    readonly pullInterval = 0;
-    readonly presence: PresenceManager<Profile, Presence>;
-    uploadFile: () => Promise<{
-        success: boolean;
-        retry: boolean;
-    }>;
-    getFile: () => Promise<FilePullResult>;
-}
-export type SyncTransportMode = 'realtime' | 'pull';
-export interface ServerSyncOptions<Profile = any, Presence = any> extends ServerSyncEndpointProviderConfig {
-    /**
-     * When a client first connects, it will use this presence value.
-     */
-    initialPresence: Presence;
-    /**
-     * Before connecting to the server, the local client will have
-     * this value for their profile data. You can either cache and store
-     * profile data from a previous connection or provide defaults like
-     * empty strings.
-     */
-    defaultProfile: Profile;
-    /**
-     * Provide `false` to disable transport selection. Transport selection
-     * automatically switches between HTTP and WebSocket based sync depending
-     * on the number of peers connected. If a user is alone, they will use
-     * HTTP push/pull to sync changes. If another user joins, both users will
-     * be upgraded to websockets.
-     *
-     * Provide `peers-only` to only automatically use websockets if other
-     * users connect, but not if another device for the current user connects.
-     * By default, automatic transport selection will upgrade to websockets if
-     * another device from the current user connects, but if realtime sync is
-     * not necessary for such cases, you can save bandwidth by disabling this.
-     *
-     * Turning off this feature allows you more control over the transport
-     * which can be useful for low-power devices or to save server traffic.
-     * To modify transport modes manually, utilize `client.sync.setMode`.
-     * The built-in behavior is essentially switching modes based on
-     * the number of peers detected by client.sync.presence.
-     */
-    automaticTransportSelection?: boolean | 'peers-only';
-    initialTransport?: SyncTransportMode;
-    autoStart?: boolean;
-    /**
-     * Optionally specify an interval, in milliseconds, to poll the server
-     * when in pull mode.
-     */
-    pullInterval?: number;
-    /**
-     * Presence updates are batched to reduce number of requests / messages
-     * sent to the server. You can specify the batching time slice, in milliseconds,
-     */
-    presenceUpdateBatchTimeout?: number;
-    /**
-     * Experimental: sync messages over a broadcast channel between tabs.
-     * Fixes tabs not reactively updating to changes when other tabs are open,
-     * but is not yet thoroughly vetted.
-     */
-    useBroadcastChannel?: boolean;
-}
-export declare class ServerSync<Presence = any, Profile = any> extends EventSubscriber<SyncEvents & {
-    syncingChange: (syncing: boolean) => void;
-}> implements Sync<Presence, Profile> {
-    private webSocketSync;
-    private pushPullSync;
-    private fileSync;
-    private activeSync;
-    private endpointProvider;
-    private onData;
-    private broadcastChannel;
-    private _activelySyncing;
-    private meta;
-    readonly presence: PresenceManager<Profile, Presence>;
-    private log;
-    constructor({ authEndpoint, fetchAuth, initialPresence, automaticTransportSelection, autoStart, initialTransport, pullInterval, presenceUpdateBatchTimeout, defaultProfile, useBroadcastChannel, }: ServerSyncOptions<Profile, Presence>, { meta, log, onData, }: {
-        meta: Metadata;
-        log?: (...args: any[]) => void;
-        onData: (data: {
-            operations: Operation[];
-            baselines: DocumentBaseline[];
-            reset?: boolean;
-        }) => Promise<void>;
-    });
-    get canDoRealtime(): boolean;
-    get syncing(): boolean;
-    private handleBroadcastChannelMessage;
-    private handleMessage;
-    private handleOnlineChange;
-    private handlePresenceUpdate;
-    setMode: (transport: SyncTransportMode) => void;
-    setPullInterval: (interval: number) => void;
-    get pullInterval(): number;
-    send: (message: ClientMessage) => void;
-    uploadFile: (info: FileData) => Promise<FileUploadResult>;
-    getFile: (id: string) => Promise<FilePullResult>;
-    start: () => void;
-    stop: () => void;
-    dispose: () => void;
-    reconnect: () => void;
-    get isConnected(): boolean;
-    get status(): "active" | "paused";
-    get mode(): SyncTransportMode;
-}
-export {};
+import { ClientMessage, DocumentBaseline, EventSubscriber, FileData, Operation, ServerMessage } from '@verdant-web/common';
+import { Metadata } from '../metadata/Metadata.js';
+import { PresenceManager } from './PresenceManager.js';
+import { FilePullResult, FileUploadResult } from './FileSync.js';
+import { ServerSyncEndpointProviderConfig } from './ServerSyncEndpointProvider.js';
+type SyncEvents = {
+    onlineChange: (isOnline: boolean) => void;
+};
+export type SyncTransportEvents = SyncEvents & {
+    message: (message: ServerMessage) => void;
+};
+export interface SyncTransport {
+    subscribe(event: 'onlineChange', handler: (online: boolean) => void): () => void;
+    readonly presence: PresenceManager;
+    readonly mode: SyncTransportMode;
+    send(message: ClientMessage): void;
+    start(): void;
+    stop(): void;
+    dispose(): void;
+    reconnect(): void;
+    readonly isConnected: boolean;
+    readonly status: 'active' | 'paused';
+}
+export interface Sync<Presence = any, Profile = any> extends SyncTransport {
+    setMode(mode: SyncTransportMode): void;
+    setPullInterval(interval: number): void;
+    readonly pullInterval: number;
+    uploadFile(data: FileData): Promise<FileUploadResult>;
+    getFile(fileId: string): Promise<FilePullResult>;
+    readonly presence: PresenceManager<Profile, Presence>;
+}
+export declare class NoSync<Presence = any, Profile = any> extends EventSubscriber<SyncEvents> implements Sync<Presence, Profile> {
+    readonly mode = "pull";
+    send(): void;
+    start(): void;
+    stop(): void;
+    dispose: () => void;
+    reconnect(): void;
+    setMode(): void;
+    setPullInterval(): void;
+    readonly isConnected = false;
+    readonly status = "paused";
+    readonly pullInterval = 0;
+    readonly presence: PresenceManager<Profile, Presence>;
+    uploadFile: () => Promise<{
+        success: boolean;
+        retry: boolean;
+    }>;
+    getFile: () => Promise<FilePullResult>;
+}
+export type SyncTransportMode = 'realtime' | 'pull';
+export interface ServerSyncOptions<Profile = any, Presence = any> extends ServerSyncEndpointProviderConfig {
+    /**
+     * When a client first connects, it will use this presence value.
+     */
+    initialPresence: Presence;
+    /**
+     * Before connecting to the server, the local client will have
+     * this value for their profile data. You can either cache and store
+     * profile data from a previous connection or provide defaults like
+     * empty strings.
+     */
+    defaultProfile: Profile;
+    /**
+     * Provide `false` to disable transport selection. Transport selection
+     * automatically switches between HTTP and WebSocket based sync depending
+     * on the number of peers connected. If a user is alone, they will use
+     * HTTP push/pull to sync changes. If another user joins, both users will
+     * be upgraded to websockets.
+     *
+     * Provide `peers-only` to only automatically use websockets if other
+     * users connect, but not if another device for the current user connects.
+     * By default, automatic transport selection will upgrade to websockets if
+     * another device from the current user connects, but if realtime sync is
+     * not necessary for such cases, you can save bandwidth by disabling this.
+     *
+     * Turning off this feature allows you more control over the transport
+     * which can be useful for low-power devices or to save server traffic.
+     * To modify transport modes manually, utilize `client.sync.setMode`.
+     * The built-in behavior is essentially switching modes based on
+     * the number of peers detected by client.sync.presence.
+     */
+    automaticTransportSelection?: boolean | 'peers-only';
+    initialTransport?: SyncTransportMode;
+    autoStart?: boolean;
+    /**
+     * Optionally specify an interval, in milliseconds, to poll the server
+     * when in pull mode.
+     */
+    pullInterval?: number;
+    /**
+     * Presence updates are batched to reduce number of requests / messages
+     * sent to the server. You can specify the batching time slice, in milliseconds,
+     */
+    presenceUpdateBatchTimeout?: number;
+    /**
+     * Experimental: sync messages over a broadcast channel between tabs.
+     * Fixes tabs not reactively updating to changes when other tabs are open,
+     * but is not yet thoroughly vetted.
+     */
+    useBroadcastChannel?: boolean;
+}
+export declare class ServerSync<Presence = any, Profile = any> extends EventSubscriber<SyncEvents & {
+    syncingChange: (syncing: boolean) => void;
+}> implements Sync<Presence, Profile> {
+    private webSocketSync;
+    private pushPullSync;
+    private fileSync;
+    private activeSync;
+    private endpointProvider;
+    private onData;
+    private broadcastChannel;
+    private _activelySyncing;
+    private meta;
+    readonly presence: PresenceManager<Profile, Presence>;
+    private log;
+    constructor({ authEndpoint, fetchAuth, initialPresence, automaticTransportSelection, autoStart, initialTransport, pullInterval, presenceUpdateBatchTimeout, defaultProfile, useBroadcastChannel, }: ServerSyncOptions<Profile, Presence>, { meta, log, onData, }: {
+        meta: Metadata;
+        log?: (...args: any[]) => void;
+        onData: (data: {
+            operations: Operation[];
+            baselines: DocumentBaseline[];
+            reset?: boolean;
+        }) => Promise<void>;
+    });
+    get canDoRealtime(): boolean;
+    get syncing(): boolean;
+    private handleBroadcastChannelMessage;
+    private handleMessage;
+    private handleOnlineChange;
+    private handlePresenceUpdate;
+    setMode: (transport: SyncTransportMode) => void;
+    setPullInterval: (interval: number) => void;
+    get pullInterval(): number;
+    send: (message: ClientMessage) => void;
+    uploadFile: (info: FileData) => Promise<FileUploadResult>;
+    getFile: (id: string) => Promise<FilePullResult>;
+    start: () => void;
+    stop: () => void;
+    dispose: () => void;
+    reconnect: () => void;
+    get isConnected(): boolean;
+    get status(): "active" | "paused";
+    get mode(): SyncTransportMode;
+}
+export {};