@automerge/automerge-repo-react-hooks 2.5.2-alpha.0 → 2.5.2-alpha.2

package/dist/index.js

@@ -6681,9 +6681,228 @@ requireSha256();
 
 debug("automerge-repo:collectionsync");
 
-const PRESENCE_MESSAGE_MARKER = "__presence";
 const DEFAULT_HEARTBEAT_INTERVAL_MS = 15_000;
 const DEFAULT_PEER_TTL_MS = 3 * DEFAULT_HEARTBEAT_INTERVAL_MS;
+const PRESENCE_MESSAGE_MARKER = "__presence";
+
+function unique(items) {
+    return Array.from(new Set(items));
+}
+
+class PeerStateView {
+    value;
+    constructor(value) {
+        this.value = value;
+    }
+    /**
+     * Get all users.
+     *
+     * @returns Array of user presence {@link State}s
+     */
+    get users() {
+        const userIds = unique(Object.values(this.value).map(peerState => peerState.userId));
+        return userIds.map(u => this.getUserState(u));
+    }
+    /**
+     * Get all devices.
+     *
+     * @returns Array of device presence {@link State}s
+     */
+    get devices() {
+        const deviceIds = unique(Object.values(this.value).map(peerState => peerState.deviceId));
+        return deviceIds.map(d => this.getDeviceState(d));
+    }
+    /**
+     * Get all peers.
+     *
+     * @returns Array of peer presence {@link State}s
+     */
+    get peers() {
+        return Object.values(this.value);
+    }
+    /**
+     * Get all peer ids for this user.
+     *
+     * @param userId
+     * @returns Array of peer ids for this user
+     */
+    getUserPeers(userId) {
+        return Object.values(this.value)
+            .filter(peerState => peerState.userId === userId)
+            .map(peerState => peerState.peerId);
+    }
+    /**
+     * Get all peers for this device.
+     *
+     * @param deviceId
+     * @returns Array of peer ids for this device
+     */
+    getDevicePeers(deviceId) {
+        return Object.values(this.value)
+            .filter(peerState => peerState.deviceId === deviceId)
+            .map(peerState => peerState.peerId);
+    }
+    /**
+     * Return the most-recently-seen peer from this group.
+     *
+     * @param peers
+     * @returns id of most recently seen peer
+     */
+    getLastSeenPeer(peers) {
+        let freshestLastSeenAt;
+        return peers.reduce((freshest, curr) => {
+            const lastSeenAt = this.value[curr]?.lastActiveAt;
+            if (!lastSeenAt) {
+                return freshest;
+            }
+            if (!freshest || lastSeenAt > freshestLastSeenAt) {
+                freshestLastSeenAt = lastSeenAt;
+                return curr;
+            }
+            return freshest;
+        }, undefined);
+    }
+    /**
+     * Return the peer from this group that sent a state update most recently
+     *
+     * @param peers
+     * @returns id of most recently seen peer
+     */
+    getLastActivePeer(peers) {
+        let freshestLastActiveAt;
+        return peers.reduce((freshest, curr) => {
+            const lastActiveAt = this.value[curr]?.lastActiveAt;
+            if (!lastActiveAt) {
+                return freshest;
+            }
+            if (!freshest || lastActiveAt > freshestLastActiveAt) {
+                freshestLastActiveAt = lastActiveAt;
+                return curr;
+            }
+            return freshest;
+        }, undefined);
+    }
+    /**
+     * Get current ephemeral state value for this user's most-recently-active
+     * peer.
+     *
+     * @param userId
+     * @returns user's {@link State}
+     */
+    getUserState(userId) {
+        const peers = this.getUserPeers(userId);
+        if (!peers) {
+            return undefined;
+        }
+        const peer = this.getLastActivePeer(peers);
+        if (!peer) {
+            return undefined;
+        }
+        return this.value[peer];
+    }
+    /**
+     * Get current ephemeral state value for this device's most-recently-active
+     * peer.
+     *
+     * @param deviceId
+     * @returns device's {@link State}
+     */
+    getDeviceState(deviceId) {
+        const peers = this.getDevicePeers(deviceId);
+        if (!peers) {
+            return undefined;
+        }
+        const peer = this.getLastActivePeer(peers);
+        if (!peer) {
+            return undefined;
+        }
+        return this.value[peer];
+    }
+}
+
+class PeerPresenceInfo {
+    ttl;
+    #peerStates = new PeerStateView({});
+    /**
+     * Build a new peer presence state.
+     *
+     * @param ttl in milliseconds - peers with no activity within this timeframe
+     * are forgotten when {@link prune} is called.
+     */
+    constructor(ttl) {
+        this.ttl = ttl;
+    }
+    has(peerId) {
+        return peerId in this.#peerStates.value;
+    }
+    /**
+     * Record that we've seen the given peer recently.
+     *
+     * @param peerId
+     */
+    markSeen(peerId) {
+        this.#peerStates = new PeerStateView({
+            ...this.#peerStates.value,
+            [peerId]: {
+                ...this.#peerStates.value[peerId],
+                lastSeen: Date.now(),
+            },
+        });
+    }
+    /**
+     * Record a state update for the given peer. Note that existing state is not
+     * overwritten.
+     *
+     * @param peerId
+     * @param value
+     */
+    update({ peerId, deviceId, userId, value, }) {
+        const peerState = this.#peerStates.value[peerId];
+        const existingState = peerState?.value ?? {};
+        const now = Date.now();
+        this.#peerStates = new PeerStateView({
+            ...this.#peerStates.value,
+            [peerId]: {
+                peerId,
+                deviceId,
+                userId,
+                lastActiveAt: now,
+                lastUpdateAt: now,
+                value: {
+                    ...existingState,
+                    ...value,
+                },
+            },
+        });
+    }
+    /**
+     * Forget the given peer.
+     *
+     * @param peerId
+     */
+    delete(peerId) {
+        this.#peerStates = new PeerStateView(Object.fromEntries(Object.entries(this.#peerStates.value).filter(([existingId]) => {
+            return existingId != peerId;
+        })));
+    }
+    /**
+     * Prune all peers that have not been seen since the configured ttl has
+     * elapsed.
+     */
+    prune() {
+        const threshold = Date.now() - this.ttl;
+        this.#peerStates = new PeerStateView(Object.fromEntries(Object.entries(this.#peerStates).filter(([, state]) => {
+            return state.lastActiveAt >= threshold;
+        })));
+    }
+    /**
+     * Get a snapshot of the current peer states
+     */
+    get states() {
+        return this.#peerStates;
+    }
+}
+
 /**
  * Presence encapsulates ephemeral state communication for a specific doc
  * handle. It tracks caller-provided local state and broadcasts that state to
@@ -6717,6 +6936,7 @@ class Presence extends EventEmitter {
         super();
         this.#handle = handle;
         this.#peers = new PeerPresenceInfo(DEFAULT_PEER_TTL_MS);
+        this.#localState = {};
         this.userId = userId;
         this.deviceId = deviceId;
     }
@@ -6743,35 +6963,24 @@ class Presence extends EventEmitter {
             }
             const message = envelope[PRESENCE_MESSAGE_MARKER];
             const { deviceId, userId } = message;
-            if (!this.#peers.view.has(peerId)) {
+            if (!this.#peers.has(peerId)) {
                 this.announce();
             }
             switch (message.type) {
                 case "heartbeat":
-                    this.#peers.markSeen(peerId, deviceId, userId);
-                    this.emit("heartbeat", {
-                        type: "heartbeat",
-                        peerId,
-                        deviceId,
-                        userId,
-                    });
+                    this.#peers.markSeen(peerId);
+                    this.emit("heartbeat", { type: "heartbeat", peerId });
                     break;
                 case "goodbye":
                     this.#peers.delete(peerId);
-                    this.emit("goodbye", {
-                        type: "goodbye",
-                        peerId,
-                        deviceId,
-                        userId,
-                    });
+                    this.emit("goodbye", { type: "goodbye", peerId });
                     break;
                 case "update":
                     this.#peers.update({
                         peerId,
                         deviceId,
                         userId,
-                        channel: message.channel,
-                        value: message.value,
+                        value: { [message.channel]: message.value },
                     });
                     this.emit("update", {
                         type: "update",
@@ -6783,14 +6992,11 @@ class Presence extends EventEmitter {
                     });
                     break;
                 case "snapshot":
-                    Object.entries(message.state).forEach(([channel, value]) => {
-                        this.#peers.update({
-                            peerId,
-                            deviceId,
-                            userId,
-                            channel: channel,
-                            value,
-                        });
+                    this.#peers.update({
+                        peerId,
+                        deviceId,
+                        userId,
+                        value: message.state,
                     });
                     this.emit("snapshot", {
                         type: "snapshot",
@@ -6810,7 +7016,7 @@ class Presence extends EventEmitter {
      * Return a view of current peer states.
      */
     getPeerStates() {
-        return this.#peers.view;
+        return this.#peers.states;
     }
     /**
      * Return a view of current local state.
@@ -6829,7 +7035,7 @@ class Presence extends EventEmitter {
         this.#localState = Object.assign({}, this.#localState, {
             [channel]: value,
         });
-        this.broadcastChannelState(channel, value);
+        this.broadcastChannelState(channel);
     }
     /**
      * Whether this Presence is currently active. See
@@ -6860,7 +7066,7 @@ class Presence extends EventEmitter {
         this.#handle.off("ephemeral-message", this.#handleEphemeralMessage);
         this.stopHeartbeats();
         this.stopPruningPeers();
-        this.doBroadcast("goodbye");
+        this.send({ type: "goodbye" });
         this.#running = false;
     }
     announce() {
@@ -6877,7 +7083,8 @@ class Presence extends EventEmitter {
         this.doBroadcast("snapshot", { state: this.#localState });
         this.resetHeartbeats();
     }
-    broadcastChannelState(channel, value) {
+    broadcastChannelState(channel) {
+        const value = this.#localState[channel];
         this.doBroadcast("update", { channel, value });
         this.resetHeartbeats();
     }
@@ -6888,20 +7095,20 @@ class Presence extends EventEmitter {
         this.stopHeartbeats();
         this.startHeartbeats();
     }
-    sendHeartbeat() {
-        this.doBroadcast("heartbeat");
-    }
     doBroadcast(type, extra) {
+        this.send({
+            userId: this.userId,
+            deviceId: this.deviceId,
+            type,
+            ...extra,
+        });
+    }
+    send(message) {
         if (!this.#running) {
             return;
         }
         this.#handle.broadcast({
-            [PRESENCE_MESSAGE_MARKER]: {
-                userId: this.userId,
-                deviceId: this.deviceId,
-                type,
-                ...extra,
-            },
+            [PRESENCE_MESSAGE_MARKER]: message,
         });
     }
     startHeartbeats() {
@@ -6909,7 +7116,7 @@ class Presence extends EventEmitter {
             return;
         }
         this.#heartbeatInterval = setInterval(() => {
-            this.sendHeartbeat();
+            this.send({ type: "heartbeat" });
         }, this.#heartbeatMs);
     }
     stopHeartbeats() {
@@ -6938,280 +7145,6 @@ class Presence extends EventEmitter {
         this.#pruningInterval = undefined;
     }
 }
-/**
- * A summary of the latest Presence information for the set of peers who have
- * reported a Presence status to us.
- */
-class PeerPresenceView {
-    #peersLastSeen = new Map();
-    #peerStates = new Map();
-    #userPeers = new Map();
-    #devicePeers = new Map();
-    /** @hidden */
-    constructor(peersLastSeen, peerStates, userPeers, devicePeers) {
-        this.#peersLastSeen = peersLastSeen;
-        this.#peerStates = peerStates;
-        this.#userPeers = userPeers;
-        this.#devicePeers = devicePeers;
-    }
-    /**
-     * Check if peer is currently present.
-     *
-     * @param peerId
-     * @returns true if the peer has been seen recently
-     */
-    has(peerId) {
-        return this.#peerStates.has(peerId);
-    }
-    /**
-     * Check when the peer was last seen.
-     *
-     * @param peerId
-     * @returns last seen UNIX timestamp, or undefined for unknown peers
-     */
-    getLastSeen(peerId) {
-        return this.#peersLastSeen.get(peerId);
-    }
-    /**
-     * Get all recently-seen peers.
-     *
-     * @returns Array of peer ids
-     */
-    getPeers() {
-        return Array.from(this.#peerStates.keys());
-    }
-    /**
-     * Get all recently-seen users.
-     *
-     * @returns Array of user ids
-     */
-    getUsers() {
-        return Array.from(this.#userPeers.keys());
-    }
-    /**
-     * Get all recently-seen devices.
-     *
-     * @returns Array of device ids
-     */
-    getDevices() {
-        return Array.from(this.#devicePeers.keys());
-    }
-    /**
-     * Get all recently-seen peers for this user.
-     *
-     * @param userId
-     * @returns Array of peer ids for this user
-     */
-    getUserPeers(userId) {
-        const peers = this.#userPeers.get(userId);
-        if (!peers) {
-            return;
-        }
-        return Array.from(peers);
-    }
-    /**
-     * Get all recently-seen peers for this device.
-     *
-     * @param deviceId
-     * @returns Array of peer ids for this device
-     */
-    getDevicePeers(deviceId) {
-        const peers = this.#devicePeers.get(deviceId);
-        if (!peers) {
-            return;
-        }
-        return Array.from(peers);
-    }
-    /**
-     * Get most-recently-seen peer from this group.
-     *
-     * @param peers
-     * @returns id of most recently seen peer
-     */
-    getFreshestPeer(peers) {
-        let freshestLastSeen;
-        return Array.from(peers).reduce((freshest, curr) => {
-            const lastSeen = this.#peersLastSeen.get(curr);
-            if (!lastSeen) {
-                return freshest;
-            }
-            if (!freshest || lastSeen > freshestLastSeen) {
-                freshestLastSeen = lastSeen;
-                return curr;
-            }
-            return freshest;
-        }, undefined);
-    }
-    /**
-     * Get current @type PeerState for given peer.
-     *
-     * @param peerId
-     * @returns details for the peer
-     */
-    getPeerInfo(peerId) {
-        return this.#peerStates.get(peerId);
-    }
-    /**
-     * Get current ephemeral state value for this peer. If a channel is specified,
-     * only returns the ephemeral state for that specific channel. Otherwise,
-     * returns the full ephemeral state.
-     *
-     * @param peerId
-     * @param channel
-     * @returns latest ephemeral state received
-     */
-    getPeerState(peerId, channel) {
-        const fullState = this.#peerStates.get(peerId)?.value;
-        if (!channel) {
-            return fullState;
-        }
-        return fullState?.[channel];
-    }
-    /**
-     * Get current ephemeral state value for this user's most-recently-active
-     * peer. See {@link getPeerState}.
-     *
-     * @param userId
-     * @param channel
-     * @returns
-     */
-    getUserState(userId, channel) {
-        const peers = this.#userPeers.get(userId);
-        if (!peers) {
-            return undefined;
-        }
-        const peer = this.getFreshestPeer(peers);
-        if (!peer) {
-            return undefined;
-        }
-        return this.getPeerState(peer, channel);
-    }
-    /**
-     * Get current ephemeral state value for this device's most-recently-active
-     * peer. See {@link getPeerState}.
-     *
-     * @param userId
-     * @param channel
-     * @returns
-     */
-    getDeviceState(deviceId, channel) {
-        const peers = this.#devicePeers.get(deviceId);
-        if (!peers) {
-            return undefined;
-        }
-        const peer = this.getFreshestPeer(peers);
-        if (!peer) {
-            return undefined;
-        }
-        return this.getPeerState(peer, channel);
-    }
-}
-class PeerPresenceInfo extends EventEmitter {
-    ttl;
-    #peersLastSeen = new Map();
-    #peerStates = new Map();
-    #userPeers = new Map();
-    #devicePeers = new Map();
-    view;
-    /**
-     * Build a new peer presence state.
-     *
-     * @param ttl in milliseconds - peers with no activity within this timeframe
-     * are forgotten when {@link prune} is called.
-     */
-    constructor(ttl) {
-        super();
-        this.ttl = ttl;
-        this.view = new PeerPresenceView(this.#peersLastSeen, this.#peerStates, this.#userPeers, this.#devicePeers);
-    }
-    /**
-     * Record that we've seen the given peer recently.
-     *
-     * @param peerId
-     * @param deviceId
-     * @param userId
-     */
-    markSeen(peerId, deviceId, userId) {
-        const devicePeers = this.#devicePeers.get(deviceId) ?? new Set();
-        devicePeers.add(peerId);
-        this.#devicePeers.set(deviceId, devicePeers);
-        const userPeers = this.#userPeers.get(userId) ?? new Set();
-        userPeers.add(peerId);
-        this.#userPeers.set(userId, userPeers);
-        this.#peersLastSeen.set(peerId, Date.now());
-    }
-    /**
-     * Record a state update for the given peer. It is also automatically updated with {@link markSeen}.
-     *
-     * @param peerId
-     * @param deviceId
-     * @param userId
-     * @param value
-     */
-    update({ peerId, deviceId, userId, channel, value, }) {
-        this.markSeen(peerId, deviceId, userId);
-        const peerState = this.#peerStates.get(peerId);
-        const existingState = peerState?.value ?? {};
-        this.#peerStates.set(peerId, {
-            peerId,
-            deviceId,
-            userId,
-            value: {
-                ...existingState,
-                [channel]: value,
-            },
-        });
-    }
-    /**
-     * Forget the given peer.
-     *
-     * @param peerId
-     */
-    delete(peerId) {
-        this.#peersLastSeen.delete(peerId);
-        this.#peerStates.delete(peerId);
-        Array.from(this.#devicePeers.entries()).forEach(([deviceId, peerIds]) => {
-            if (peerIds.has(peerId)) {
-                peerIds.delete(peerId);
-            }
-            if (peerIds.size === 0) {
-                this.#devicePeers.delete(deviceId);
-            }
-        });
-        Array.from(this.#userPeers.entries()).forEach(([userId, peerIds]) => {
-            if (peerIds.has(peerId)) {
-                peerIds.delete(peerId);
-            }
-            if (peerIds.size === 0) {
-                this.#userPeers.delete(userId);
-            }
-        });
-    }
-    /**
-     * Prune all peers that have not been seen since the configured ttl has
-     * elapsed.
-     */
-    prune() {
-        const threshold = Date.now() - this.ttl;
-        const stalePeers = new Set(Array.from(this.#peersLastSeen.entries())
-            .filter(([, lastSeen]) => {
-            return lastSeen < threshold;
-        })
-            .map(([peerId]) => peerId));
-        if (stalePeers.size === 0) {
-            return;
-        }
-        stalePeers.forEach(stalePeer => {
-            this.delete(stalePeer);
-        });
-    }
-}
-
-function useInvalidate() {
-  const [, setState] = useState(0);
-  const increment = useCallback(() => setState((value) => value + 1), [setState]);
-  return increment;
-}
 
 function usePresence({
   handle,
@@ -7221,7 +7154,8 @@ function usePresence({
   heartbeatMs,
   peerTtlMs
 }) {
-  const invalidate = useInvalidate();
+  const [localState, setLocalState] = useState(initialState);
+  const [peerStates, setPeerStates] = useState(new PeerStateView({}));
   const firstOpts = useRef({
     heartbeatMs,
     peerTtlMs
@@ -7235,25 +7169,37 @@ function usePresence({
       initialState: firstInitialState.current,
       ...firstOpts.current
     });
-    presence.on("heartbeat", invalidate);
-    presence.on("snapshot", invalidate);
-    presence.on("update", invalidate);
-    presence.on("goodbye", invalidate);
+    presence.on("heartbeat", () => setPeerStates(presence.getPeerStates()));
+    presence.on("snapshot", () => setPeerStates(presence.getPeerStates()));
+    presence.on("update", () => setPeerStates(presence.getPeerStates()));
+    presence.on("goodbye", () => setPeerStates(presence.getPeerStates()));
     return () => {
       presence.stop();
     };
   }, [presence, userId, deviceId, firstInitialState, firstOpts]);
-  const updateLocalState = useCallback(
+  const start = useCallback(() => {
+    presence.start({
+      initialState: presence.getLocalState(),
+      ...firstOpts.current
+    });
+  }, [presence, firstOpts]);
+  const stop = useCallback(() => {
+    presence.stop();
+  }, [presence]);
+  const update = useCallback(
     (channel, msg) => {
-      invalidate();
       presence.broadcast(channel, msg);
+      const updated = presence.getLocalState();
+      setLocalState(updated);
     },
     [presence]
   );
   return {
-    peerStates: presence.getPeerStates(),
-    localState: presence.getLocalState(),
-    update: updateLocalState
+    peerStates,
+    localState,
+    update,
+    start,
+    stop
   };
 }