@verdant-web/store 3.10.0 → 3.11.1

package/src/sync/PresenceManager.ts

@@ -172,7 +172,9 @@ export class PresenceManager<
 			this.emit('peerLeft', message.userId, lastPresence);
 		}
 		if (peersChanged) {
-			this._peerIds = Array.from(peerIdsSet);
+			// important that this stays sorted to keep stable order, don't want
+			// peers swapping around.
+			this._peerIds = Array.from(peerIdsSet).sort();
 			this.emit('peersChanged', this._peers);
 		}
 		if (peersChanged || selfChanged) {
@@ -220,6 +222,17 @@ export class PresenceManager<
 		this.emit('change');
 	};
 
+	setFieldId = (fieldId: string | undefined, timestamp = Date.now()) => {
+		this._updateBatch.update({
+			items: [
+				{ internal: { lastFieldId: fieldId, lastFieldTimestamp: timestamp } },
+			],
+		});
+		this.self.internal.lastFieldId = fieldId;
+		this.emit('selfChanged', this.self);
+		this.emit('change');
+	};
+
 	/**
 	 * Get all peers that are in the same view as the local user.
 	 */
@@ -236,4 +249,18 @@ export class PresenceManager<
 				)
 		);
 	};
+
+	/**
+	 * Get all peers that have interacted with the specified
+	 * field most recently.
+	 */
+	getFieldPeers = (fieldId: string, expirationPeriod = 60 * 1000) => {
+		return this._peerIds
+			.map((id) => this._peers[id])
+			.filter(
+				(peer) =>
+					peer.internal.lastFieldId === fieldId &&
+					Date.now() - peer.internal.lastFieldTimestamp! < expirationPeriod,
+			);
+	};
 }

package/src/sync/Sync.ts

@@ -20,6 +20,7 @@ import {
 } from './ServerSyncEndpointProvider.js';
 import { WebSocketSync } from './WebSocketSync.js';
 import { Context } from '../context.js';
+import { attemptToRegisterBackgroundSync } from './background.js';
 
 type SyncEvents = {
 	onlineChange: (isOnline: boolean) => void;
@@ -184,6 +185,8 @@ export interface ServerSyncOptions<Profile = any, Presence = any>
 	 * Not sure why you want to do this, but be careful.
 	 */
 	onOutgoingMessage?: (message: ClientMessage) => void;
+
+	EXPERIMENTAL_backgroundSync?: boolean;
 }
 
 export class ServerSync<Presence = any, Profile = any>
@@ -225,6 +228,7 @@ export class ServerSync<Presence = any, Profile = any>
 			defaultProfile,
 			useBroadcastChannel,
 			onOutgoingMessage,
+			EXPERIMENTAL_backgroundSync,
 		}: ServerSyncOptions<Profile, Presence>,
 		{
 			meta,
@@ -332,6 +336,10 @@ export class ServerSync<Presence = any, Profile = any>
 		if (autoStart) {
 			this.start();
 		}
+
+		if (EXPERIMENTAL_backgroundSync) {
+			attemptToRegisterBackgroundSync();
+		}
 	}
 
 	get canDoRealtime() {

package/src/sync/background.ts

@@ -0,0 +1,27 @@
+export async function attemptToRegisterBackgroundSync() {
+	try {
+		const status = await navigator.permissions.query({
+			name: 'periodic-background-sync' as any,
+		});
+		if (status.state === 'granted') {
+			// Periodic background sync can be used.
+			const registration = await navigator.serviceWorker.ready;
+			if ('periodicSync' in registration) {
+				try {
+					await (registration.periodicSync as any).register('verdant-sync', {
+						// An interval of one day.
+						minInterval: 24 * 60 * 60 * 1000,
+					});
+				} catch (error) {
+					// Periodic background sync cannot be used.
+					console.warn('Failed to register background sync:', error);
+				}
+			}
+		} else {
+			// Periodic background sync cannot be used.
+			console.debug('Background sync permission is not granted:', status);
+		}
+	} catch (error) {
+		console.error('Failed to initiate background sync:', error);
+	}
+}

package/src/sync/cliSync.ts

@@ -0,0 +1,18 @@
+export function cliSync<Presence extends any = any>(
+	libraryId: string,
+	{
+		port = 3242,
+		initialPresence = {} as any,
+	}: { port?: number; initialPresence?: Presence } = {},
+) {
+	let userId = localStorage.getItem('verdant-userId');
+	if (!userId) {
+		userId = `user-${Math.random().toString(36).slice(2)}`;
+		localStorage.setItem('verdant-userId', userId);
+	}
+	return {
+		defaultProfile: { id: userId },
+		initialPresence,
+		authEndpoint: `http://localhost:${port}/auth/${libraryId}?userId=${userId}`,
+	};
+}

package/src/sync/serviceWorker.ts

@@ -0,0 +1,27 @@
+import type { ClientDescriptor } from '../client/ClientDescriptor.js';
+
+export async function registerBackgroundSync(clientDesc: ClientDescriptor) {
+	self.addEventListener('periodicsync', (event: any) => {
+		if (event.tag === 'verdant-sync') {
+			// See the "Think before you sync" section for
+			// checks you could perform before syncing.
+			event.waitUntil(sync(clientDesc));
+		}
+	});
+}
+
+async function sync(clientDesc: ClientDescriptor) {
+	try {
+		const client = await clientDesc.open();
+
+		await client.sync.syncOnce();
+	} catch (err) {
+		console.error('Failed to sync:', err);
+		if (err instanceof Error) {
+			localStorage.setItem(
+				'backgroundSyncError',
+				`${err.name}: ${err.message}`,
+			);
+		}
+	}
+}