@automerge/automerge-repo 2.5.2 → 2.5.3

package/dist/index.d.ts

@@ -30,7 +30,7 @@ export { isValidAutomergeUrl, isValidDocumentId, parseAutomergeUrl, stringifyAut
 export { Repo } from "./Repo.js";
 export { Presence } from "./presence/Presence.js";
 export { PeerStateView } from "./presence/PeerStateView.js";
-export type { PeerState, PresenceState, PresenceConfig, UserId, DeviceId, } from "./presence/types.js";
+export type { PeerState, PresenceState, PresenceConfig, } from "./presence/types.js";
 export { NetworkAdapter } from "./network/NetworkAdapter.js";
 export type { NetworkAdapterInterface } from "./network/NetworkAdapterInterface.js";
 export { isRepoMessage } from "./network/messages.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,WAAW,EACX,WAAW,GACZ,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAA;AAC3D,YAAY,EACV,SAAS,EACT,aAAa,EACb,cAAc,EACd,MAAM,EACN,QAAQ,GACT,MAAM,qBAAqB,CAAA;AAE5B,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,YAAY,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAA;AACnF,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,YAAY,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAA;AACnF,OAAO,EAAE,IAAI,IAAI,SAAS,EAAE,KAAK,KAAK,EAAE,MAAM,2BAA2B,CAAA;AAEzE,eAAe;AACf,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAA;AAIzC,YAAY,EACV,sBAAsB,EACtB,sBAAsB,EACtB,6BAA6B,EAC7B,gCAAgC,EAChC,2BAA2B,EAC3B,eAAe,EACf,gBAAgB,EAChB,wCAAwC,EACxC,WAAW,EACX,QAAQ,GACT,MAAM,gBAAgB,CAAA;AAEvB,YAAY,EACV,qBAAqB,EACrB,eAAe,EACf,UAAU,EACV,UAAU,EACV,WAAW,GACZ,MAAM,WAAW,CAAA;AAElB,YAAY,EACV,oBAAoB,EACpB,WAAW,EACX,oBAAoB,EACpB,uBAAuB,EACvB,YAAY,GACb,MAAM,sCAAsC,CAAA;AAE7C,YAAY,EACV,sBAAsB,EACtB,WAAW,GACZ,MAAM,+BAA+B,CAAA;AAEtC,YAAY,EACV,0BAA0B,EAC1B,gBAAgB,EAChB,OAAO,EACP,WAAW,EACX,cAAc,EACd,WAAW,GACZ,MAAM,uBAAuB,CAAA;AAE9B,YAAY,EACV,KAAK,EACL,SAAS,EACT,SAAS,EACT,UAAU,EACV,SAAS,GACV,MAAM,oBAAoB,CAAA;AAE3B,cAAc,YAAY,CAAA;AAG1B,YAAY,EACV,GAAG,EACH,SAAS,EACT,WAAW,EACX,YAAY,EACZ,OAAO,EACP,MAAM,EACN,QAAQ,IAAI,WAAW,GACxB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAiB5E,eAAO,MAAM,OAAO,0BAAoB,CAAA;AACxC,eAAO,MAAM,SAAS,kCAAsB,CAAA;AAE5C,eAAO,MAAM,eAAe,kCAAsB,CAAA;AAIlD,MAAM,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,SAAS,CAAC,SAAS,CAAC,CAAA;AAChE,MAAM,MAAM,eAAe,GAAG,SAAS,CAAA;AAEvC,MAAM,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAA;AACvC,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;AACrC,MAAM,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAA;AACnC,MAAM,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAA;AACnC,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;AACzD,MAAM,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAA;AACjC,MAAM,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAA;AACvC,MAAM,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAA;AACrC,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;AAC/C,MAAM,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAA;AACjC,MAAM,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAA;AACvC,MAAM,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,CAAA;AAC3C,MAAM,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,CAAA;AAC3C,MAAM,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAA;AAIrC,eAAO,MAAM,UAAU,6BAAuB,CAAA;AAC9C,eAAO,MAAM,aAAa,gCAA0B,CAAA;AACpD,eAAO,MAAM,YAAY,+BAAyB,CAAA;AAClD,eAAO,MAAM,IAAI,uBAAiB,CAAA;AAClC,eAAO,MAAM,YAAY,+BAAyB,CAAA;AAKlD,eAAO,MAAM,SAAS,4BAAsB,CAAA;AAC5C,eAAO,MAAM,iBAAiB,oCAA8B,CAAA;AAC5D,eAAO,MAAM,MAAM,yBAAmB,CAAA;AACtC,eAAO,MAAM,UAAU,6BAAuB,CAAA;AAC9C,eAAO,MAAM,QAAQ,2BAAqB,CAAA;AAC1C,eAAO,MAAM,QAAQ,2BAAqB,CAAA;AAC1C,eAAO,MAAM,IAAI,uBAAiB,CAAA;AAClC,eAAO,MAAM,MAAM,yBAAmB,CAAA;AACtC,eAAO,MAAM,WAAW,oCAAwB,CAAA;AAEhD,eAAO,MAAM,iBAAiB,oCAAwB,CAAA;AAEtD,eAAO,MAAM,WAAW,8BAAwB,CAAA;AAChD,YAAY,EAAE,KAAK,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,WAAW,EACX,WAAW,GACZ,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAA;AAC3D,YAAY,EACV,SAAS,EACT,aAAa,EACb,cAAc,GACf,MAAM,qBAAqB,CAAA;AAE5B,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,YAAY,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAA;AACnF,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,YAAY,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAA;AACnF,OAAO,EAAE,IAAI,IAAI,SAAS,EAAE,KAAK,KAAK,EAAE,MAAM,2BAA2B,CAAA;AAEzE,eAAe;AACf,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAA;AAIzC,YAAY,EACV,sBAAsB,EACtB,sBAAsB,EACtB,6BAA6B,EAC7B,gCAAgC,EAChC,2BAA2B,EAC3B,eAAe,EACf,gBAAgB,EAChB,wCAAwC,EACxC,WAAW,EACX,QAAQ,GACT,MAAM,gBAAgB,CAAA;AAEvB,YAAY,EACV,qBAAqB,EACrB,eAAe,EACf,UAAU,EACV,UAAU,EACV,WAAW,GACZ,MAAM,WAAW,CAAA;AAElB,YAAY,EACV,oBAAoB,EACpB,WAAW,EACX,oBAAoB,EACpB,uBAAuB,EACvB,YAAY,GACb,MAAM,sCAAsC,CAAA;AAE7C,YAAY,EACV,sBAAsB,EACtB,WAAW,GACZ,MAAM,+BAA+B,CAAA;AAEtC,YAAY,EACV,0BAA0B,EAC1B,gBAAgB,EAChB,OAAO,EACP,WAAW,EACX,cAAc,EACd,WAAW,GACZ,MAAM,uBAAuB,CAAA;AAE9B,YAAY,EACV,KAAK,EACL,SAAS,EACT,SAAS,EACT,UAAU,EACV,SAAS,GACV,MAAM,oBAAoB,CAAA;AAE3B,cAAc,YAAY,CAAA;AAG1B,YAAY,EACV,GAAG,EACH,SAAS,EACT,WAAW,EACX,YAAY,EACZ,OAAO,EACP,MAAM,EACN,QAAQ,IAAI,WAAW,GACxB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAiB5E,eAAO,MAAM,OAAO,0BAAoB,CAAA;AACxC,eAAO,MAAM,SAAS,kCAAsB,CAAA;AAE5C,eAAO,MAAM,eAAe,kCAAsB,CAAA;AAIlD,MAAM,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,SAAS,CAAC,SAAS,CAAC,CAAA;AAChE,MAAM,MAAM,eAAe,GAAG,SAAS,CAAA;AAEvC,MAAM,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAA;AACvC,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;AACrC,MAAM,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAA;AACnC,MAAM,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAA;AACnC,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;AACzD,MAAM,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAA;AACjC,MAAM,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAA;AACvC,MAAM,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAA;AACrC,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;AAC/C,MAAM,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAA;AACjC,MAAM,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAA;AACvC,MAAM,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,CAAA;AAC3C,MAAM,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,CAAA;AAC3C,MAAM,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAA;AAIrC,eAAO,MAAM,UAAU,6BAAuB,CAAA;AAC9C,eAAO,MAAM,aAAa,gCAA0B,CAAA;AACpD,eAAO,MAAM,YAAY,+BAAyB,CAAA;AAClD,eAAO,MAAM,IAAI,uBAAiB,CAAA;AAClC,eAAO,MAAM,YAAY,+BAAyB,CAAA;AAKlD,eAAO,MAAM,SAAS,4BAAsB,CAAA;AAC5C,eAAO,MAAM,iBAAiB,oCAA8B,CAAA;AAC5D,eAAO,MAAM,MAAM,yBAAmB,CAAA;AACtC,eAAO,MAAM,UAAU,6BAAuB,CAAA;AAC9C,eAAO,MAAM,QAAQ,2BAAqB,CAAA;AAC1C,eAAO,MAAM,QAAQ,2BAAqB,CAAA;AAC1C,eAAO,MAAM,IAAI,uBAAiB,CAAA;AAClC,eAAO,MAAM,MAAM,yBAAmB,CAAA;AACtC,eAAO,MAAM,WAAW,oCAAwB,CAAA;AAEhD,eAAO,MAAM,iBAAiB,oCAAwB,CAAA;AAEtD,eAAO,MAAM,WAAW,8BAAwB,CAAA;AAChD,YAAY,EAAE,KAAK,EAAE,CAAA"}

package/dist/presence/PeerPresenceInfo.d.ts

@@ -1,6 +1,6 @@
 import { PeerId } from "../types.js";
 import { PeerStateView } from "./PeerStateView.js";
-import { DeviceId, PresenceState, UserId } from "./types.js";
+import { PresenceState } from "./types.js";
 export declare class PeerPresenceInfo<State extends PresenceState> {
     #private;
     readonly ttl: number;
@@ -25,10 +25,8 @@ export declare class PeerPresenceInfo<State extends PresenceState> {
      * @param peerId
      * @param value
      */
-    update({ peerId, deviceId, userId, value, }: {
+    update({ peerId, value }: {
         peerId: PeerId;
-        deviceId?: DeviceId;
-        userId?: UserId;
         value: Partial<State>;
     }): void;
     /**

package/dist/presence/PeerPresenceInfo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PeerPresenceInfo.d.ts","sourceRoot":"","sources":["../../src/presence/PeerPresenceInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAE5D,qBAAa,gBAAgB,CAAC,KAAK,SAAS,aAAa;;IAS3C,QAAQ,CAAC,GAAG,EAAE,MAAM;IANhC;;;;;OAKG;gBACkB,GAAG,EAAE,MAAM;IAEhC,GAAG,CAAC,MAAM,EAAE,MAAM;IAIlB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM;IAcvB;;;;;;OAMG;IACH,MAAM,CAAC,EACL,MAAM,EACN,QAAQ,EACR,MAAM,EACN,KAAK,GACN,EAAE;QACD,MAAM,EAAE,MAAM,CAAA;QACd,QAAQ,CAAC,EAAE,QAAQ,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;KACtB;IAoBD;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM;IAUrB;;;OAGG;IACH,KAAK;IAiBL;;OAEG;IACH,IAAI,MAAM,yBAET;CACF"}
+{"version":3,"file":"PeerPresenceInfo.d.ts","sourceRoot":"","sources":["../../src/presence/PeerPresenceInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAE1C,qBAAa,gBAAgB,CAAC,KAAK,SAAS,aAAa;;IAS3C,QAAQ,CAAC,GAAG,EAAE,MAAM;IANhC;;;;;OAKG;gBACkB,GAAG,EAAE,MAAM;IAEhC,GAAG,CAAC,MAAM,EAAE,MAAM;IAIlB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM;IAcvB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;KAAE;IAkBnE;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM;IAUrB;;;OAGG;IACH,KAAK;IAiBL;;OAEG;IACH,IAAI,MAAM,yBAET;CACF"}

package/dist/presence/PeerPresenceInfo.js

@@ -39,7 +39,7 @@ export class PeerPresenceInfo {
      * @param peerId
      * @param value
      */
-    update({ peerId, deviceId, userId, value, }) {
+    update({ peerId, value }) {
         const peerState = this.#peerStates.value[peerId];
         const existingState = peerState?.value ?? {};
         const now = Date.now();
@@ -47,10 +47,8 @@ export class PeerPresenceInfo {
             ...this.#peerStates.value,
             [peerId]: {
                 peerId,
-                deviceId,
-                userId,
-                lastActiveAt: now,
                 lastSeenAt: now,
+                lastActiveAt: now,
                 value: {
                     ...existingState,
                     ...value,

package/dist/presence/PeerStateView.d.ts

@@ -1,69 +1,60 @@
-import { PeerId } from "../types.js";
-import { DeviceId, PeerStatesValue, PresenceState, UserId } from "./types.js";
-export declare class PeerStateView<State extends PresenceState> {
-    readonly value: PeerStatesValue<State>;
-    constructor(value: PeerStatesValue<State>);
-    /**
-     * Get all users.
-     *
-     * @returns Array of user presence {@link State}s
-     */
-    get users(): (import("./types.js").PeerState<State> | undefined)[];
+import { PeerState, PeerStatesValue, PresenceState } from "./types.js";
+export type GetStatesOpts<State extends PresenceState, SummaryState> = {
     /**
-     * Get all devices.
+     * Function to derive a grouping key from a peer state. This can be used to
+     * group peers and consider presence activity by an arbitrary attribute of the
+     * presence state (e.g., user or device) rather than by peer.
      *
-     * @returns Array of device presence {@link State}s
-     */
-    get devices(): (import("./types.js").PeerState<State> | undefined)[];
-    /**
-     * Get all peers.
-     *
-     * @returns Array of peer presence {@link State}s
-     */
-    get peers(): import("./types.js").PeerState<State>[];
-    /**
-     * Get all peer ids for this user.
+     * This is useful when a user has multiple devices, or multiple peers (e.g.,
+     * tabs) on a single device.
      *
-     * @param userId
-     * @returns Array of peer ids for this user
+     * @param state state of a peer
+     * @returns key that should be used to consolidate activity from that peer
      */
-    getUserPeers(userId: UserId): PeerId[];
+    groupingFn?: (state: PeerState<State>) => PropertyKey;
     /**
-     * Get all peers for this device.
+     * Function to summarize the presence activity from several different peers in
+     * a group.
      *
-     * @param deviceId
-     * @returns Array of peer ids for this device
+     * @param states states of all peers in a group, as grouped by {@param keyFn}
+     * @returns a value summarizing presence for this group
      */
-    getDevicePeers(deviceId: DeviceId): PeerId[];
-    /**
-     * Return the most-recently-seen peer from this group.
-     *
-     * @param peers
-     * @returns id of most recently seen peer
-     */
-    getLastSeenPeer(peers: PeerId[]): PeerId | 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: PeerId[]): PeerId | undefined;
-    /**
-     * Get current ephemeral state value for this user's most-recently-active
-     * peer.
-     *
-     * @param userId
-     * @returns user's {@link State}
-     */
-    getUserState(userId: UserId): import("./types.js").PeerState<State> | undefined;
+    summaryFn?: (states: PeerState<State>[]) => SummaryState;
+};
+/**
+ * A grouped view of peer states.
+ */
+export declare class PeerStateView<State extends PresenceState> {
+    readonly value: PeerStatesValue<State>;
+    constructor(value: PeerStatesValue<State>);
     /**
-     * Get current ephemeral state value for this device's most-recently-active
-     * peer.
+     * Get the presence state of all peers. By default, each peer is its own
+     * group, but presence activity can be aggregated by arbitrary criteria.
      *
-     * @param deviceId
-     * @returns device's {@link State}
+     * @param opts
+     * @returns presence state for all groups
      */
-    getDeviceState(deviceId: DeviceId): import("./types.js").PeerState<State> | undefined;
+    getStates<SummaryState = PeerState<State>>(opts?: GetStatesOpts<State, SummaryState>): Record<PropertyKey, SummaryState>;
 }
+/**
+ * Get the peerId of this peer.
+ *
+ * @param peer
+ * @returns peer id
+ */
+export declare function peerIdentity<State extends PresenceState>(peer: PeerState<State>): import("../types.js").PeerId;
+/**
+ * Find the peer that most recently sent a state update.
+ *
+ * @param peers
+ * @returns id of most recently active peer
+ */
+export declare function getLastActivePeer<State extends PresenceState>(peers: PeerState<State>[]): PeerState<State> | undefined;
+/**
+ * Find the peer that most recently sent a heartbeat.
+ *
+ * @param peers
+ * @returns id of most recently seen peer
+ */
+export declare function getLastSeenPeer<State extends PresenceState>(peers: PeerState<State>[]): PeerState<State> | undefined;
 //# sourceMappingURL=PeerStateView.d.ts.map

package/dist/presence/PeerStateView.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PeerStateView.d.ts","sourceRoot":"","sources":["../../src/presence/PeerStateView.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAE7E,qBAAa,aAAa,CAAC,KAAK,SAAS,aAAa;IACpD,QAAQ,CAAC,KAAK,yBAAA;gBAEF,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC;IAIzC;;;;OAIG;IACH,IAAI,KAAK,0DAKR;IAED;;;;OAIG;IACH,IAAI,OAAO,0DAKV;IAED;;;;OAIG;IACH,IAAI,KAAK,4CAER;IAED;;;;;OAKG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM;IAM3B;;;;;OAKG;IACH,cAAc,CAAC,QAAQ,EAAE,QAAQ;IAMjC;;;;;OAKG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE;IAiB/B;;;;;OAKG;IACH,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE;IAiBjC;;;;;;OAMG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM;IAa3B;;;;;;OAMG;IACH,cAAc,CAAC,QAAQ,EAAE,QAAQ;CAYlC"}
+{"version":3,"file":"PeerStateView.d.ts","sourceRoot":"","sources":["../../src/presence/PeerStateView.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAEtE,MAAM,MAAM,aAAa,CAAC,KAAK,SAAS,aAAa,EAAE,YAAY,IAAI;IACrE;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,KAAK,WAAW,CAAA;IACrD;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,KAAK,YAAY,CAAA;CACzD,CAAA;AAED;;GAEG;AACH,qBAAa,aAAa,CAAC,KAAK,SAAS,aAAa;IACpD,QAAQ,CAAC,KAAK,yBAAA;gBAEF,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC;IAIzC;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,GAAG,SAAS,CAAC,KAAK,CAAC,EACvC,IAAI,CAAC,EAAE,aAAa,CAAC,KAAK,EAAE,YAAY,CAAC;CAoB5C;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,SAAS,aAAa,EACtD,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,gCAGvB;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,SAAS,aAAa,EAC3D,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,gCAgB1B;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,KAAK,SAAS,aAAa,EACzD,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,gCAgB1B"}

package/dist/presence/PeerStateView.js

@@ -1,131 +1,82 @@
-import { unique } from "../helpers/array.js";
+/**
+ * A grouped view of peer states.
+ */
 export class PeerStateView {
     value;
     constructor(value) {
         this.value = value;
     }
     /**
-     * Get all users.
+     * Get the presence state of all peers. By default, each peer is its own
+     * group, but presence activity can be aggregated by arbitrary criteria.
      *
-     * @returns Array of user presence {@link State}s
+     * @param opts
+     * @returns presence state for all groups
      */
-    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]?.lastSeenAt;
-            if (!lastSeenAt) {
-                return freshest;
+    getStates(opts) {
+        const groupingFn = opts?.groupingFn ?? peerIdentity;
+        const summaryFn = opts?.summaryFn ??
+            getLastActivePeer;
+        const statesByKey = Object.values(this.value).reduce((byKey, curr) => {
+            const key = groupingFn(curr);
+            if (!(key in byKey)) {
+                byKey[key] = [];
             }
-            if (!freshest || lastSeenAt > freshestLastSeenAt) {
-                freshestLastSeenAt = lastSeenAt;
-                return curr;
-            }
-            return freshest;
-        }, undefined);
+            byKey[key].push(curr);
+            return byKey;
+        }, {});
+        return Object.entries(statesByKey).reduce((result, [key, states]) => {
+            result[key] = summaryFn(states);
+            return result;
+        }, {});
     }
-    /**
-     * 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;
-            }
+}
+/**
+ * Get the peerId of this peer.
+ *
+ * @param peer
+ * @returns peer id
+ */
+export function peerIdentity(peer) {
+    return peer.peerId;
+}
+/**
+ * Find the peer that most recently sent a state update.
+ *
+ * @param peers
+ * @returns id of most recently active peer
+ */
+export function getLastActivePeer(peers) {
+    let freshestLastActiveAt;
+    return peers.reduce((freshest, curr) => {
+        const lastActiveAt = curr.lastActiveAt;
+        if (!lastActiveAt) {
             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;
+        if (!freshest || lastActiveAt > freshestLastActiveAt) {
+            freshestLastActiveAt = lastActiveAt;
+            return curr;
         }
-        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;
+        return freshest;
+    }, undefined);
+}
+/**
+ * Find the peer that most recently sent a heartbeat.
+ *
+ * @param peers
+ * @returns id of most recently seen peer
+ */
+export function getLastSeenPeer(peers) {
+    let freshestLastSeenAt;
+    return peers.reduce((freshest, curr) => {
+        const lastSeenAt = curr.lastSeenAt;
+        if (!lastSeenAt) {
+            return freshest;
         }
-        const peer = this.getLastActivePeer(peers);
-        if (!peer) {
-            return undefined;
+        if (!freshest || lastSeenAt > freshestLastSeenAt) {
+            freshestLastSeenAt = lastSeenAt;
+            return curr;
         }
-        return this.value[peer];
-    }
+        return freshest;
+    }, undefined);
 }

package/dist/presence/Presence.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from "eventemitter3";
 import { DocHandle } from "../DocHandle.js";
-import { DeviceId, PresenceConfig, PresenceEvents, PresenceState, UserId } from "./types.js";
+import { PresenceConfig, PresenceEvents, PresenceState } from "./types.js";
 /**
  * Presence encapsulates ephemeral state communication for a specific doc
  * handle. It tracks caller-provided local state and broadcasts that state to
@@ -14,20 +14,14 @@ import { DeviceId, PresenceConfig, PresenceEvents, PresenceState, UserId } from
  */
 export declare class Presence<State extends PresenceState, DocType = any> extends EventEmitter<PresenceEvents> {
     #private;
-    readonly deviceId?: DeviceId;
-    readonly userId?: UserId;
     /**
      * Create a new Presence to share ephemeral state with peers.
      *
      * @param config see {@link PresenceConfig}
      * @returns
      */
-    constructor({ handle, deviceId, userId, }: {
+    constructor({ handle }: {
         handle: DocHandle<DocType>;
-        /** Our device id (like userId, this is unverified; peers can send anything) */
-        deviceId?: DeviceId;
-        /** Our user id (this is unverified; peers can send anything) */
-        userId?: UserId;
     });
     /**
      * Start listening to ephemeral messages on the handle, broadcast initial

package/dist/presence/Presence.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Presence.d.ts","sourceRoot":"","sources":["../../src/presence/Presence.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE5C,OAAO,EAAE,SAAS,EAAoC,MAAM,iBAAiB,CAAA;AAC7E,OAAO,EACL,QAAQ,EACR,cAAc,EACd,cAAc,EAGd,aAAa,EACb,MAAM,EACP,MAAM,YAAY,CAAA;AAQnB;;;;;;;;;;GAUG;AACH,qBAAa,QAAQ,CACnB,KAAK,SAAS,aAAa,EAC3B,OAAO,GAAG,GAAG,CACb,SAAQ,YAAY,CAAC,cAAc,CAAC;;IAEpC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAA;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAexB;;;;;OAKG;gBACS,EACV,MAAM,EACN,QAAQ,EACR,MAAM,GACP,EAAE;QACD,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QAC1B,+EAA+E;QAC/E,QAAQ,CAAC,EAAE,QAAQ,CAAA;QACnB,gEAAgE;QAChE,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB;IASD;;;OAGG;IACH,KAAK,CAAC,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE,cAAc,CAAC,KAAK,CAAC;IA8ErE;;OAEG;IACH,aAAa;IAIb;;OAEG;IACH,aAAa;IAIb;;;;;;OAMG;IACH,SAAS,CAAC,OAAO,SAAS,MAAM,KAAK,EACnC,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;IAQvB;;;OAGG;IACH,IAAI,OAAO,YAEV;IAED;;;;;;;;;;OAUG;IACH,IAAI;IAeJ,OAAO,CAAC,QAAQ;IAWhB,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,qBAAqB;IAM7B,OAAO,CAAC,eAAe;IAQvB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,IAAI;IASZ,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,gBAAgB;CAOzB"}
+{"version":3,"file":"Presence.d.ts","sourceRoot":"","sources":["../../src/presence/Presence.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE5C,OAAO,EAAE,SAAS,EAAoC,MAAM,iBAAiB,CAAA;AAC7E,OAAO,EACL,cAAc,EACd,cAAc,EAGd,aAAa,EACd,MAAM,YAAY,CAAA;AAQnB;;;;;;;;;;GAUG;AACH,qBAAa,QAAQ,CACnB,KAAK,SAAS,aAAa,EAC3B,OAAO,GAAG,GAAG,CACb,SAAQ,YAAY,CAAC,cAAc,CAAC;;IAgBpC;;;;;OAKG;gBACS,EAAE,MAAM,EAAE,EAAE;QAAE,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;KAAE;IAOtD;;;OAGG;IACH,KAAK,CAAC,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE,cAAc,CAAC,KAAK,CAAC;IAqErE;;OAEG;IACH,aAAa;IAIb;;OAEG;IACH,aAAa;IAIb;;;;;;OAMG;IACH,SAAS,CAAC,OAAO,SAAS,MAAM,KAAK,EACnC,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;IAQvB;;;OAGG;IACH,IAAI,OAAO,YAEV;IAED;;;;;;;;;;OAUG;IACH,IAAI;IAeJ,OAAO,CAAC,QAAQ;IAWhB,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,qBAAqB;IAM7B,OAAO,CAAC,eAAe;IAQvB,OAAO,CAAC,WAAW;IAUnB,OAAO,CAAC,IAAI;IASZ,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,gBAAgB;CAOzB"}

package/dist/presence/Presence.js

@@ -14,8 +14,6 @@ import { PeerPresenceInfo } from "./PeerPresenceInfo.js";
  */
 export class Presence extends EventEmitter {
     #handle;
-    deviceId;
-    userId;
     #peers;
     #localState;
     #heartbeatMs;
@@ -30,13 +28,11 @@ export class Presence extends EventEmitter {
      * @param config see {@link PresenceConfig}
      * @returns
      */
-    constructor({ handle, deviceId, userId, }) {
+    constructor({ handle }) {
         super();
         this.#handle = handle;
         this.#peers = new PeerPresenceInfo(DEFAULT_PEER_TTL_MS);
         this.#localState = {};
-        this.userId = userId;
-        this.deviceId = deviceId;
     }
     /**
      * Start listening to ephemeral messages on the handle, broadcast initial
@@ -60,7 +56,6 @@ export class Presence extends EventEmitter {
                 return;
             }
             const message = envelope[PRESENCE_MESSAGE_MARKER];
-            const { deviceId, userId } = message;
             if (!this.#peers.has(peerId)) {
                 this.announce();
             }
@@ -76,15 +71,11 @@ export class Presence extends EventEmitter {
                 case "update":
                     this.#peers.update({
                         peerId,
-                        deviceId,
-                        userId,
                         value: { [message.channel]: message.value },
                     });
                     this.emit("update", {
                         type: "update",
                         peerId,
-                        deviceId,
-                        userId,
                         channel: message.channel,
                         value: message.value,
                     });
@@ -92,15 +83,11 @@ export class Presence extends EventEmitter {
                 case "snapshot":
                     this.#peers.update({
                         peerId,
-                        deviceId,
-                        userId,
                         value: message.state,
                     });
                     this.emit("snapshot", {
                         type: "snapshot",
                         peerId,
-                        deviceId,
-                        userId,
                         state: message.state,
                     });
                     break;
@@ -195,8 +182,6 @@ export class Presence extends EventEmitter {
     }
     doBroadcast(type, extra) {
         this.send({
-            userId: this.userId,
-            deviceId: this.deviceId,
             type,
             ...extra,
         });

package/dist/presence/types.d.ts

@@ -1,34 +1,26 @@
 import { PeerId } from "../types.js";
 import { PRESENCE_MESSAGE_MARKER } from "./constants.js";
-export type UserId = unknown;
-export type DeviceId = unknown;
 export type PresenceState = Record<string, any>;
 export type PeerStatesValue<State extends PresenceState> = Record<PeerId, PeerState<State>>;
 export type PeerState<State extends PresenceState> = {
     peerId: PeerId;
     lastActiveAt: number;
     lastSeenAt: number;
-    deviceId?: DeviceId;
-    userId?: UserId;
     value: State;
 };
-type PresenceMessageBase = {
-    deviceId?: DeviceId;
-    userId?: UserId;
-};
-type PresenceMessageUpdate = PresenceMessageBase & {
+type PresenceMessageUpdate = {
     type: "update";
     channel: string;
     value: any;
 };
-type PresenceMessageSnapshot = PresenceMessageBase & {
+type PresenceMessageSnapshot = {
     type: "snapshot";
     state: any;
 };
-type PresenceMessageHeartbeat = PresenceMessageBase & {
+type PresenceMessageHeartbeat = {
     type: "heartbeat";
 };
-type PresenceMessageGoodbye = PresenceMessageBase & {
+type PresenceMessageGoodbye = {
     type: "goodbye";
 };
 export type PresenceMessage = {

package/dist/presence/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/presence/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAExD,MAAM,MAAM,MAAM,GAAG,OAAO,CAAA;AAC5B,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAA;AAE9B,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAE/C,MAAM,MAAM,eAAe,CAAC,KAAK,SAAS,aAAa,IAAI,MAAM,CAC/D,MAAM,EACN,SAAS,CAAC,KAAK,CAAC,CACjB,CAAA;AAED,MAAM,MAAM,SAAS,CAAC,KAAK,SAAS,aAAa,IAAI;IACnD,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,KAAK,CAAA;CACb,CAAA;AAED,KAAK,mBAAmB,GAAG;IACzB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,KAAK,qBAAqB,GAAG,mBAAmB,GAAG;IACjD,IAAI,EAAE,QAAQ,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,GAAG,CAAA;CACX,CAAA;AAED,KAAK,uBAAuB,GAAG,mBAAmB,GAAG;IACnD,IAAI,EAAE,UAAU,CAAA;IAChB,KAAK,EAAE,GAAG,CAAA;CACX,CAAA;AAED,KAAK,wBAAwB,GAAG,mBAAmB,GAAG;IACpD,IAAI,EAAE,WAAW,CAAA;CAClB,CAAA;AAED,KAAK,sBAAsB,GAAG,mBAAmB,GAAG;IAClD,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,CAAC,uBAAuB,CAAC,EACrB,qBAAqB,GACrB,uBAAuB,GACvB,wBAAwB,GACxB,sBAAsB,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,mBAAmB,GAC7B,eAAe,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAA;AAEzD,KAAK,UAAU,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAEpC,MAAM,MAAM,mBAAmB,GAAG,qBAAqB,GAAG,UAAU,CAAA;AACpE,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,GAAG,UAAU,CAAA;AACxE,MAAM,MAAM,sBAAsB,GAAG,wBAAwB,GAAG,UAAU,CAAA;AAC1E,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,GAAG,UAAU,CAAA;AACtE,MAAM,MAAM,oBAAoB,GAAG;IAAE,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,CAAC,CAAC,EAAE,mBAAmB,KAAK,IAAI,CAAA;IACxC;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,EAAE,qBAAqB,KAAK,IAAI,CAAA;IAC5C;;OAEG;IACH,SAAS,EAAE,CAAC,CAAC,EAAE,sBAAsB,KAAK,IAAI,CAAA;IAC9C;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAC1C;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,EAAE,oBAAoB,KAAK,IAAI,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,KAAK,SAAS,aAAa,IAAI;IACxD,mDAAmD;IACnD,YAAY,EAAE,KAAK,CAAA;IACnB,wFAAwF;IACxF,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,sGAAsG;IACtG,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/presence/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAExD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAE/C,MAAM,MAAM,eAAe,CAAC,KAAK,SAAS,aAAa,IAAI,MAAM,CAC/D,MAAM,EACN,SAAS,CAAC,KAAK,CAAC,CACjB,CAAA;AAED,MAAM,MAAM,SAAS,CAAC,KAAK,SAAS,aAAa,IAAI;IACnD,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,KAAK,CAAA;CACb,CAAA;AAED,KAAK,qBAAqB,GAAG;IAC3B,IAAI,EAAE,QAAQ,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,GAAG,CAAA;CACX,CAAA;AAED,KAAK,uBAAuB,GAAG;IAC7B,IAAI,EAAE,UAAU,CAAA;IAChB,KAAK,EAAE,GAAG,CAAA;CACX,CAAA;AAED,KAAK,wBAAwB,GAAG;IAC9B,IAAI,EAAE,WAAW,CAAA;CAClB,CAAA;AAED,KAAK,sBAAsB,GAAG;IAC5B,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,CAAC,uBAAuB,CAAC,EACrB,qBAAqB,GACrB,uBAAuB,GACvB,wBAAwB,GACxB,sBAAsB,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,mBAAmB,GAC7B,eAAe,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAA;AAEzD,KAAK,UAAU,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAEpC,MAAM,MAAM,mBAAmB,GAAG,qBAAqB,GAAG,UAAU,CAAA;AACpE,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,GAAG,UAAU,CAAA;AACxE,MAAM,MAAM,sBAAsB,GAAG,wBAAwB,GAAG,UAAU,CAAA;AAC1E,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,GAAG,UAAU,CAAA;AACtE,MAAM,MAAM,oBAAoB,GAAG;IAAE,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,CAAC,CAAC,EAAE,mBAAmB,KAAK,IAAI,CAAA;IACxC;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,EAAE,qBAAqB,KAAK,IAAI,CAAA;IAC5C;;OAEG;IACH,SAAS,EAAE,CAAC,CAAC,EAAE,sBAAsB,KAAK,IAAI,CAAA;IAC9C;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAC1C;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,EAAE,oBAAoB,KAAK,IAAI,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,KAAK,SAAS,aAAa,IAAI;IACxD,mDAAmD;IACnD,YAAY,EAAE,KAAK,CAAA;IACnB,wFAAwF;IACxF,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,sGAAsG;IACtG,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA"}

package/dist/synchronizer/CollectionSynchronizer.js

@@ -87,7 +87,7 @@ export class CollectionSynchronizer extends Synchronizer {
         // Record the request so that even if access is denied now, we know that the
         // peer requested the document so that if the share policy changes we know
         // to begin syncing with this peer
-        if (message.type === "request") {
+        if (message.type === "request" || message.type === "sync") {
             if (!this.#hasRequested.has(documentId)) {
                 this.#hasRequested.set(documentId, new Set());
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo",
-  "version": "2.5.2",
+  "version": "2.5.3",
   "description": "A repository object to manage a collection of automerge documents",
   "repository": "https://github.com/automerge/automerge-repo/tree/master/packages/automerge-repo",
   "author": "Peter van Hardenberg <pvh@pvh.ca>",
@@ -59,5 +59,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7719288215977fdc3ceee8396210feddc78c3f5b"
+  "gitHead": "082d2134aa296b7a966210bc2ec744096733e273"
 }

package/src/index.ts

@@ -45,8 +45,6 @@ export type {
   PeerState,
   PresenceState,
   PresenceConfig,
-  UserId,
-  DeviceId,
 } from "./presence/types.js"
 
 export { NetworkAdapter } from "./network/NetworkAdapter.js"

package/src/presence/PeerPresenceInfo.ts

@@ -1,6 +1,6 @@
 import { PeerId } from "../types.js"
 import { PeerStateView } from "./PeerStateView.js"
-import { DeviceId, PresenceState, UserId } from "./types.js"
+import { PresenceState } from "./types.js"
 
 export class PeerPresenceInfo<State extends PresenceState> {
   #peerStates = new PeerStateView<State>({})
@@ -43,17 +43,7 @@ export class PeerPresenceInfo<State extends PresenceState> {
    * @param peerId
    * @param value
    */
-  update({
-    peerId,
-    deviceId,
-    userId,
-    value,
-  }: {
-    peerId: PeerId
-    deviceId?: DeviceId
-    userId?: UserId
-    value: Partial<State>
-  }) {
+  update({ peerId, value }: { peerId: PeerId; value: Partial<State> }) {
     const peerState = this.#peerStates.value[peerId]
     const existingState = peerState?.value ?? ({} as State)
     const now = Date.now()
@@ -61,10 +51,8 @@ export class PeerPresenceInfo<State extends PresenceState> {
       ...this.#peerStates.value,
       [peerId]: {
         peerId,
-        deviceId,
-        userId,
-        lastActiveAt: now,
         lastSeenAt: now,
+        lastActiveAt: now,
         value: {
           ...existingState,
           ...value,

package/src/presence/PeerStateView.ts

@@ -1,154 +1,126 @@
-import { unique } from "../helpers/array.js"
-import { PeerId } from "../types.js"
-import { DeviceId, PeerStatesValue, PresenceState, UserId } from "./types.js"
-
-export class PeerStateView<State extends PresenceState> {
-  readonly value
-
-  constructor(value: PeerStatesValue<State>) {
-    this.value = value
-  }
+import { PeerState, PeerStatesValue, PresenceState } from "./types.js"
 
+export type GetStatesOpts<State extends PresenceState, SummaryState> = {
   /**
-   * Get all users.
+   * Function to derive a grouping key from a peer state. This can be used to
+   * group peers and consider presence activity by an arbitrary attribute of the
+   * presence state (e.g., user or device) rather than by peer.
    *
-   * @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.
+   * This is useful when a user has multiple devices, or multiple peers (e.g.,
+   * tabs) on a single device.
    *
-   * @returns Array of device presence {@link State}s
+   * @param state state of a peer
+   * @returns key that should be used to consolidate activity from that peer
    */
-  get devices() {
-    const deviceIds = unique(
-      Object.values(this.value).map(peerState => peerState.deviceId)
-    )
-    return deviceIds.map(d => this.getDeviceState(d))
-  }
-
+  groupingFn?: (state: PeerState<State>) => PropertyKey
   /**
-   * Get all peers.
+   * Function to summarize the presence activity from several different peers in
+   * a group.
    *
-   * @returns Array of peer presence {@link State}s
+   * @param states states of all peers in a group, as grouped by {@param keyFn}
+   * @returns a value summarizing presence for this group
    */
-  get peers() {
-    return Object.values(this.value)
-  }
+  summaryFn?: (states: PeerState<State>[]) => SummaryState
+}
 
-  /**
-   * Get all peer ids for this user.
-   *
-   * @param userId
-   * @returns Array of peer ids for this user
-   */
-  getUserPeers(userId: UserId) {
-    return Object.values(this.value)
-      .filter(peerState => peerState.userId === userId)
-      .map(peerState => peerState.peerId)
-  }
+/**
+ * A grouped view of peer states.
+ */
+export class PeerStateView<State extends PresenceState> {
+  readonly value
 
-  /**
-   * Get all peers for this device.
-   *
-   * @param deviceId
-   * @returns Array of peer ids for this device
-   */
-  getDevicePeers(deviceId: DeviceId) {
-    return Object.values(this.value)
-      .filter(peerState => peerState.deviceId === deviceId)
-      .map(peerState => peerState.peerId)
+  constructor(value: PeerStatesValue<State>) {
+    this.value = value
   }
 
   /**
-   * Return the most-recently-seen peer from this group.
+   * Get the presence state of all peers. By default, each peer is its own
+   * group, but presence activity can be aggregated by arbitrary criteria.
    *
-   * @param peers
-   * @returns id of most recently seen peer
+   * @param opts
+   * @returns presence state for all groups
    */
-  getLastSeenPeer(peers: PeerId[]) {
-    let freshestLastSeenAt: number
-    return peers.reduce((freshest: PeerId | undefined, curr) => {
-      const lastSeenAt = this.value[curr]?.lastSeenAt
-      if (!lastSeenAt) {
-        return freshest
+  getStates<SummaryState = PeerState<State>>(
+    opts?: GetStatesOpts<State, SummaryState>
+  ) {
+    const groupingFn = opts?.groupingFn ?? peerIdentity
+    const summaryFn =
+      opts?.summaryFn ??
+      (getLastActivePeer as (states: PeerState<State>[]) => SummaryState)
+    const statesByKey = Object.values(this.value).reduce((byKey, curr) => {
+      const key = groupingFn(curr)
+      if (!(key in byKey)) {
+        byKey[key] = []
       }
-
-      if (!freshest || lastSeenAt > freshestLastSeenAt) {
-        freshestLastSeenAt = lastSeenAt
-        return curr
-      }
-
-      return freshest
-    }, undefined)
+      byKey[key].push(curr)
+
+      return byKey
+    }, {} as Record<PropertyKey, PeerState<State>[]>)
+    return Object.entries(statesByKey).reduce((result, [key, states]) => {
+      result[key] = summaryFn(states)
+      return result
+    }, {} as Record<PropertyKey, SummaryState>)
   }
+}
 
-  /**
-   * Return the peer from this group that sent a state update most recently
-   *
-   * @param peers
-   * @returns id of most recently seen peer
-   */
-  getLastActivePeer(peers: PeerId[]) {
-    let freshestLastActiveAt: number
-    return peers.reduce((freshest: PeerId | undefined, curr) => {
-      const lastActiveAt = this.value[curr]?.lastActiveAt
-      if (!lastActiveAt) {
-        return freshest
-      }
-
-      if (!freshest || lastActiveAt > freshestLastActiveAt) {
-        freshestLastActiveAt = lastActiveAt
-        return curr
-      }
+/**
+ * Get the peerId of this peer.
+ *
+ * @param peer
+ * @returns peer id
+ */
+export function peerIdentity<State extends PresenceState>(
+  peer: PeerState<State>
+) {
+  return peer.peerId
+}
 
+/**
+ * Find the peer that most recently sent a state update.
+ *
+ * @param peers
+ * @returns id of most recently active peer
+ */
+export function getLastActivePeer<State extends PresenceState>(
+  peers: PeerState<State>[]
+) {
+  let freshestLastActiveAt: number
+  return peers.reduce((freshest, curr) => {
+    const lastActiveAt = curr.lastActiveAt
+    if (!lastActiveAt) {
       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: UserId) {
-    const peers = this.getUserPeers(userId)
-    if (!peers) {
-      return undefined
     }
-    const peer = this.getLastActivePeer(peers)
-    if (!peer) {
-      return undefined
+
+    if (!freshest || lastActiveAt > freshestLastActiveAt) {
+      freshestLastActiveAt = lastActiveAt
+      return curr
     }
 
-    return this.value[peer]
-  }
+    return freshest
+  }, undefined as PeerState<State> | undefined)
+}
 
-  /**
-   * Get current ephemeral state value for this device's most-recently-active
-   * peer.
-   *
-   * @param deviceId
-   * @returns device's {@link State}
-   */
-  getDeviceState(deviceId: DeviceId) {
-    const peers = this.getDevicePeers(deviceId)
-    if (!peers) {
-      return undefined
+/**
+ * Find the peer that most recently sent a heartbeat.
+ *
+ * @param peers
+ * @returns id of most recently seen peer
+ */
+export function getLastSeenPeer<State extends PresenceState>(
+  peers: PeerState<State>[]
+) {
+  let freshestLastSeenAt: number
+  return peers.reduce((freshest, curr) => {
+    const lastSeenAt = curr.lastSeenAt
+    if (!lastSeenAt) {
+      return freshest
     }
-    const peer = this.getLastActivePeer(peers)
-    if (!peer) {
-      return undefined
+
+    if (!freshest || lastSeenAt > freshestLastSeenAt) {
+      freshestLastSeenAt = lastSeenAt
+      return curr
     }
 
-    return this.value[peer]
-  }
+    return freshest
+  }, undefined as PeerState<State> | undefined)
 }

package/src/presence/Presence.ts

@@ -2,13 +2,11 @@ import { EventEmitter } from "eventemitter3"
 
 import { DocHandle, DocHandleEphemeralMessagePayload } from "../DocHandle.js"
 import {
-  DeviceId,
   PresenceConfig,
   PresenceEvents,
   PresenceMessage,
   PresenceMessageType,
   PresenceState,
-  UserId,
 } from "./types.js"
 import {
   DEFAULT_HEARTBEAT_INTERVAL_MS,
@@ -33,8 +31,6 @@ export class Presence<
   DocType = any
 > extends EventEmitter<PresenceEvents> {
   #handle: DocHandle<DocType>
-  readonly deviceId?: DeviceId
-  readonly userId?: UserId
   #peers: PeerPresenceInfo<State>
   #localState: State
   #heartbeatMs?: number
@@ -55,23 +51,11 @@ export class Presence<
    * @param config see {@link PresenceConfig}
    * @returns
    */
-  constructor({
-    handle,
-    deviceId,
-    userId,
-  }: {
-    handle: DocHandle<DocType>
-    /** Our device id (like userId, this is unverified; peers can send anything) */
-    deviceId?: DeviceId
-    /** Our user id (this is unverified; peers can send anything) */
-    userId?: UserId
-  }) {
+  constructor({ handle }: { handle: DocHandle<DocType> }) {
     super()
     this.#handle = handle
     this.#peers = new PeerPresenceInfo<State>(DEFAULT_PEER_TTL_MS)
     this.#localState = {} as State
-    this.userId = userId
-    this.deviceId = deviceId
   }
 
   /**
@@ -102,7 +86,6 @@ export class Presence<
       }
 
       const message = envelope[PRESENCE_MESSAGE_MARKER]
-      const { deviceId, userId } = message
 
       if (!this.#peers.has(peerId)) {
         this.announce()
@@ -120,15 +103,11 @@ export class Presence<
         case "update":
           this.#peers.update({
             peerId,
-            deviceId,
-            userId,
             value: { [message.channel]: message.value } as Partial<State>,
           })
           this.emit("update", {
             type: "update",
             peerId,
-            deviceId,
-            userId,
             channel: message.channel,
             value: message.value,
           })
@@ -136,15 +115,11 @@ export class Presence<
         case "snapshot":
           this.#peers.update({
             peerId,
-            deviceId,
-            userId,
             value: message.state as State,
           })
           this.emit("snapshot", {
             type: "snapshot",
             peerId,
-            deviceId,
-            userId,
             state: message.state,
           })
           break
@@ -256,8 +231,6 @@ export class Presence<
     extra?: Record<string, unknown>
   ) {
     this.send({
-      userId: this.userId,
-      deviceId: this.deviceId,
       type,
       ...extra,
     })

package/src/presence/types.ts

@@ -1,9 +1,6 @@
 import { PeerId } from "../types.js"
 import { PRESENCE_MESSAGE_MARKER } from "./constants.js"
 
-export type UserId = unknown
-export type DeviceId = unknown
-
 export type PresenceState = Record<string, any>
 
 export type PeerStatesValue<State extends PresenceState> = Record<
@@ -15,32 +12,25 @@ export type PeerState<State extends PresenceState> = {
   peerId: PeerId
   lastActiveAt: number
   lastSeenAt: number
-  deviceId?: DeviceId
-  userId?: UserId
   value: State
 }
 
-type PresenceMessageBase = {
-  deviceId?: DeviceId
-  userId?: UserId
-}
-
-type PresenceMessageUpdate = PresenceMessageBase & {
+type PresenceMessageUpdate = {
   type: "update"
   channel: string
   value: any
 }
 
-type PresenceMessageSnapshot = PresenceMessageBase & {
+type PresenceMessageSnapshot = {
   type: "snapshot"
   state: any
 }
 
-type PresenceMessageHeartbeat = PresenceMessageBase & {
+type PresenceMessageHeartbeat = {
   type: "heartbeat"
 }
 
-type PresenceMessageGoodbye = PresenceMessageBase & {
+type PresenceMessageGoodbye = {
   type: "goodbye"
 }
 

package/src/synchronizer/CollectionSynchronizer.ts

@@ -112,7 +112,7 @@ export class CollectionSynchronizer extends Synchronizer {
     // Record the request so that even if access is denied now, we know that the
     // peer requested the document so that if the share policy changes we know
     // to begin syncing with this peer
-    if (message.type === "request") {
+    if (message.type === "request" || message.type === "sync") {
       if (!this.#hasRequested.has(documentId)) {
         this.#hasRequested.set(documentId, new Set())
       }

package/test/Presence.test.ts

@@ -31,15 +31,11 @@ describe("Presence", () => {
     })
     const alicePresence = new Presence<PresenceState>({
       handle: aliceHandle,
-      userId: "alice",
-      deviceId: "phone",
     })
 
     const bobHandle = await bob.find(aliceHandle.url)
     const bobPresence = new Presence<PresenceState>({
       handle: bobHandle,
-      userId: "bob",
-      deviceId: "phone",
     })
 
     return {

package/test/Repo.test.ts

@@ -1247,6 +1247,98 @@ describe("Repo", () => {
       assert.deepStrictEqual(bobHandle.doc(), { foo: "bar" })
     })
 
+    it("sync messages (not just requests) are recorded as peer interest for later share policy changes", async () => {
+      // This test covers a scenario where two peers sync via a sync server.
+      // Initially the sync server allows peerA but denies peerB. PeerB already
+      // has the document (obtained directly from peerA), so when it connects to
+      // the server it sends a "sync" message (not a "request"). The server
+      // denies access. Later the server's share policy changes to allow peerB.
+      // The server should then start pushing updates to peerB. Before the fix
+      // in CollectionSynchronizer, only "request" messages were recorded as
+      // expressing peer interest in a document. So when the share policy
+      // changed, the server had no record that peerB wanted the document and
+      // would not begin syncing — peerB would only receive updates after it
+      // sent another sync message of its own (i.e. after making a write).
+
+      // Track whether peerB is allowed to sync with the server
+      let peerBAllowed = false
+
+      const peerA = new Repo({
+        peerId: "peerA" as PeerId,
+        shareConfig: {
+          announce: async () => true,
+          access: async () => true,
+        },
+      })
+
+      const syncServer = new Repo({
+        peerId: "syncServer" as PeerId,
+        shareConfig: {
+          // Server mode: never proactively announces docs to peers
+          announce: async () => false,
+          // Initially only peerA is allowed; peerB is denied
+          access: async peerId => peerId === "peerA" || peerBAllowed,
+        },
+      })
+
+      const peerB = new Repo({
+        peerId: "peerB" as PeerId,
+        shareConfig: {
+          announce: async () => true,
+          access: async () => true,
+        },
+      })
+
+      // Connect peerA to syncServer so the server gets the document
+      await connectRepos(peerA, syncServer)
+
+      // Create the document on peerA and sync it to the server
+      const handle = peerA.create<TestDoc>({ foo: "bar" })
+      await pause(50) // allow sync to propagate to server
+
+      // Connect peerA to peerB directly so peerB can obtain the document
+      const peerABConnection = await connectRepos(peerA, peerB)
+      const peerBHandle = await withTimeout(
+        peerB.find<TestDoc>(handle.url),
+        500
+      )
+      assert.ok(
+        peerBHandle,
+        "peerB should have obtained the document from peerA"
+      )
+      assert.deepStrictEqual(peerBHandle!.doc(), { foo: "bar" })
+
+      // Connect peerB to the server. PeerB already has the document so it sends
+      // a "sync" message (not a "request"). The server denies access and —
+      // without the fix — does NOT record peerB's interest.
+      await connectRepos(peerB, syncServer)
+
+      // Sever the direct peerA <-> peerB connection so the only path between
+      // them is through the sync server
+      peerABConnection.disconnect()
+      await pause(10)
+
+      // Now allow peerB on the server and notify it of the policy change
+      peerBAllowed = true
+      syncServer.shareConfigChanged()
+      await pause(50) // allow reevaluateDocumentShare to run
+
+      // peerA makes a new change
+      handle.change(d => {
+        d.foo = "baz"
+      })
+      await pause(150) // allow time for the change to flow peerA → server → peerB
+
+      // With the fix: the server recorded peerB's sync message as expressing
+      // interest, so reevaluateDocumentShare started syncing with peerB, and
+      // peerA's new change flows through the server to peerB.
+      assert.deepStrictEqual(
+        peerBHandle!.doc(),
+        { foo: "baz" },
+        "peerB should have received peerA's change via the sync server after the share policy changed"
+      )
+    })
+
     it("a previously unavailable document becomes available if the network adapter initially has no peers", async () => {
       // It is possible for a network adapter to be ready without any peer
       // being announced (e.g. the BroadcastChannelNetworkAdapter). In this

package/test/helpers/connectRepos.ts

@@ -1,8 +1,17 @@
 import { DummyNetworkAdapter } from "../../src/helpers/DummyNetworkAdapter.js"
 import { Repo } from "../../src/Repo.js"
+import { PeerId } from "../../src/types.js"
 import pause from "./pause.js"
 
-export default async function connectRepos(left: Repo, right: Repo) {
+export type Connection = {
+  disconnect: () => void
+  reconnect: () => Promise<void>
+}
+
+export default async function connectRepos(
+  left: Repo,
+  right: Repo
+): Promise<Connection> {
   const [leftToRight, rightToLeft] = DummyNetworkAdapter.createConnectedPair({
     latency: 0,
   })
@@ -15,4 +24,20 @@ export default async function connectRepos(left: Repo, right: Repo) {
     right.networkSubsystem.whenReady(),
   ])
   await pause(10)
+
+  return {
+    disconnect: () => {
+      leftToRight.emit("peer-disconnected", { peerId: right.peerId as PeerId })
+      rightToLeft.emit("peer-disconnected", { peerId: left.peerId as PeerId })
+    },
+    reconnect: async () => {
+      leftToRight.peerCandidate(right.peerId)
+      rightToLeft.peerCandidate(left.peerId)
+      await Promise.all([
+        left.networkSubsystem.whenReady(),
+        right.networkSubsystem.whenReady(),
+      ])
+      await pause(10)
+    },
+  }
 }

package/dist/helpers/array.d.ts

@@ -1,2 +0,0 @@
-export declare function unique<T>(items: T[]): T[];
-//# sourceMappingURL=array.d.ts.map

package/dist/helpers/array.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../src/helpers/array.ts"],"names":[],"mappings":"AAAA,wBAAgB,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,OAEnC"}

package/dist/helpers/array.js

@@ -1,3 +0,0 @@
-export function unique(items) {
-    return Array.from(new Set(items));
-}

package/src/helpers/array.ts

@@ -1,3 +0,0 @@
-export function unique<T>(items: T[]) {
-  return Array.from(new Set(items))
-}