@verdant-web/store 3.5.2 → 3.6.1

package/src/sync/Sync.ts

@@ -16,6 +16,7 @@ import {
 	ServerSyncEndpointProviderConfig,
 } from './ServerSyncEndpointProvider.js';
 import { WebSocketSync } from './WebSocketSync.js';
+import { Context } from '../context.js';
 
 type SyncEvents = {
 	onlineChange: (isOnline: boolean) => void;
@@ -59,6 +60,7 @@ export interface Sync<Presence = any, Profile = any>
 	ignoreIncoming(): void;
 	destroy(): void;
 	reconnect(): void;
+	syncOnce(): Promise<void>;
 	readonly isConnected: boolean;
 	readonly status: 'active' | 'paused';
 	readonly mode: SyncTransportMode;
@@ -113,6 +115,8 @@ export class NoSync<Presence = any, Profile = any>
 			retry: false,
 		};
 	};
+
+	syncOnce: () => Promise<void> = async () => {};
 }
 
 export type SyncTransportMode = 'realtime' | 'pull';
@@ -210,11 +214,11 @@ export class ServerSync<Presence = any, Profile = any>
 		}: ServerSyncOptions<Profile, Presence>,
 		{
 			meta,
-			log,
+			ctx,
 			onData,
 		}: {
 			meta: Metadata;
-			log?: (...args: any[]) => void;
+			ctx: Context;
 			onData: (data: {
 				operations: Operation[];
 				baselines?: DocumentBaseline[];
@@ -225,7 +229,7 @@ export class ServerSync<Presence = any, Profile = any>
 		super();
 		this.meta = meta;
 		this.onData = onData;
-		this.log = log || (() => {});
+		this.log = ctx.log;
 		this.presence = new PresenceManager({
 			initialPresence,
 			defaultProfile,
@@ -257,7 +261,7 @@ export class ServerSync<Presence = any, Profile = any>
 			log: this.log,
 		});
 		if (useBroadcastChannel && 'BroadcastChannel' in window) {
-			this.broadcastChannel = new BroadcastChannel('verdant');
+			this.broadcastChannel = new BroadcastChannel(`verdant-${ctx.namespace}`);
 			this.broadcastChannel.addEventListener(
 				'message',
 				this.handleBroadcastChannelMessage,
@@ -493,6 +497,15 @@ export class ServerSync<Presence = any, Profile = any>
 		return this.activeSync.reconnect();
 	};
 
+	/**
+	 * Runs one isolated sync cycle over HTTP. This is useful for
+	 * syncing via a periodic background job in a service worker,
+	 * which keeps a client up to date while the app isn't open.
+	 */
+	public syncOnce = () => {
+		return this.pushPullSync.syncOnce();
+	};
+
 	public get isConnected(): boolean {
 		return this.activeSync.isConnected;
 	}